bus.h

 
#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include <joybus/target.h>
 
struct joybus;

#define JOYBUS_FREQ_N64_CONSOLE         244141 // PIF-NUS @ 15.625MHz / 64

#define JOYBUS_FREQ_N64_EXTJOY          JOYBUS_FREQ_N64_CONSOLE // SECCLK @ 1.953125MHz / 8

#define JOYBUS_FREQ_N64_CONTROLLER      250000 // CNT-NUS @ 2MHz / 8

#define JOYBUS_FREQ_N64_VRU             250000 // VCI-NUS @ 4MHz / 16

#define JOYBUS_FREQ_GCN_CONSOLE         202500 // Flipper @ 162MHz / 800

#define JOYBUS_FREQ_GCN_CONTROLLER      250000 // CNT-DOL @ 4MHz / 16

#define JOYBUS_FREQ_WAVEBIRD_RECEIVER   225000 // WCRX-DOL @ 28.8MHz / 128

#define JOYBUS_FREQ_WII_CONSOLE         202500 // Hollywood @ 243MHz / 1200

#define JOYBUS_FREQ_GCN_GBA_CABLE       262144 // CPU-AGB @ 16.777216MHz / 64

#define JOYBUS_INTER_TRANSFER_DELAY_US  80

#define JOYBUS_REPLY_TIMEOUT_US         100

#define JOYBUS_BUS_IDLE_US              100

#define JOYBUS_BLOCK_SIZE               64

#define JOYBUS_PAK_BLOCK_SIZE           32

#define JOYBUS(bus) ((struct joybus *)(bus))

typedef void (*joybus_transfer_cb)(struct joybus *bus, int status, void *user_data);
 
// API for a Joybus backend - internal use only
struct joybus_api {
  int (*enable)(struct joybus *bus);
  int (*disable)(struct joybus *bus);
  int (*transfer)(struct joybus *bus, const uint8_t *write_buf, uint8_t write_len, uint8_t *read_buf, uint8_t read_len,
                  joybus_transfer_cb callback, void *user_data);
  int (*target_register)(struct joybus *bus, struct joybus_target *target);
  int (*target_unregister)(struct joybus *bus, struct joybus_target *target);
};
 
struct joybus_host_op {
  joybus_transfer_cb callback;
  void *user_data;
  uint8_t *response;
  uint8_t arg;
};

struct joybus {
  const struct joybus_api *api;
 
  struct joybus_target *target;
  uint8_t command_buffer[JOYBUS_BLOCK_SIZE];
  uint8_t response_buffer[JOYBUS_BLOCK_SIZE];
  struct joybus_host_op host_op;
};

static inline int joybus_enable(struct joybus *bus)
{
  return bus->api->enable(bus);
}

static inline int joybus_disable(struct joybus *bus)
{
  return bus->api->disable(bus);
}

static inline int joybus_transfer(struct joybus *bus, const uint8_t *write_buf, uint8_t write_len, uint8_t *read_buf,
                                  uint8_t read_len, joybus_transfer_cb callback, void *user_data)
{
  return bus->api->transfer(bus, write_buf, write_len, read_buf, read_len, callback, user_data);
}

int joybus_transfer_sync(struct joybus *bus, const uint8_t *write_buf, uint8_t write_len, uint8_t *read_buf,
                         uint8_t read_len);

static inline int joybus_target_register(struct joybus *bus, struct joybus_target *target)
{
  // Common setup
  bus->target        = target;
  target->registered = true;
 
  // Backend-specific registration
  return bus->api->target_register(bus, target);
}

static inline int joybus_target_unregister(struct joybus *bus, struct joybus_target *target)
{
  // Backend-specific unregistration
  int status = bus->api->target_unregister(bus, target);
 
  // Common teardown
  bus->target        = NULL;
  target->registered = false;
 
  return status;
}
 
// Context for a blocking Joybus operation
struct joybus_sync_ctx {
  volatile bool done;
  volatile int status;
};
 
// Transfer completion callback that records the status into a joybus_sync_ctx.
void joybus_sync_cb(struct joybus *bus, int status, void *user_data);
 
// Busy-wait on a joybus_sync_ctx until the operation completes
int joybus_sync(int start_status, struct joybus_sync_ctx *ctx);