Joybus command helpers and data structures. More...

Files
file	joybus_commands.h
	Joybus command helpers.

Data Structures
struct	joybus_cmd_n64_accessory_read_port_t
	"N64 Accessory Read" Joybus command structure. More...

struct	joybus_cmd_n64_accessory_write_port_t
	"N64 Accessory Write" Joybus command structure. More...

struct	joybus_cmd_identify_port_t
	"Identify" Joybus command structure. More...

struct	joybus_cmd_eeprom_read_block_t
	"EEPROM Read Block" Joybus command structure. More...

struct	joybus_cmd_eeprom_write_block_t
	"EEPROM Write Block" Joybus command structure. More...

struct	joybus_cmd_pixelfx_n64_game_id_t
	"PixelFX N64 Game ID" Joybus command structure. More...

struct	joybus_cmd_n64_controller_read_port_t
	"N64 Controller Read" Joybus command structure. More...

struct	joybus_cmd_gcn_controller_read_port_t
	"GameCube Controller Read" Joybus command structure. More...

struct	joybus_cmd_gcn_controller_read_long_port_t
	"GameCube Controller Long Read" Joybus command structure. More...

struct	joybus_cmd_n64_accessory_read_port_t.send
	"N64 Accessory Read" command send data More...

struct	joybus_cmd_n64_accessory_read_port_t.recv
	"N64 Accessory Read" command receive data More...

struct	joybus_cmd_n64_accessory_write_port_t.send
	"N64 Accessory Write" command send data More...

struct	joybus_cmd_n64_accessory_write_port_t.recv
	"N64 Accessory Write" command receive data More...

struct	joybus_cmd_identify_port_t.send
	"Identify" command send data More...

struct	joybus_cmd_identify_port_t.recv
	"Identify" command receive data More...

struct	joybus_cmd_eeprom_read_block_t.send
	"EEPROM Read Block" command send data More...

struct	joybus_cmd_eeprom_read_block_t.recv
	"EEPROM Read Block" command receive data More...

union	joybus_cmd_eeprom_read_block_t.recv.__unnamed15__

struct	joybus_cmd_eeprom_write_block_t.send
	"EEPROM Write Block" command send data More...

union	joybus_cmd_eeprom_write_block_t.send.__unnamed19__

struct	joybus_cmd_eeprom_write_block_t.recv
	"EEPROM Write Block" command receive data More...

struct	joybus_cmd_pixelfx_n64_game_id_t.send
	"PixelFX N64 Game ID" command send data More...

struct	joybus_cmd_n64_controller_read_port_t.send
	"N64 Controller Read" command send data More...

struct	joybus_cmd_n64_controller_read_port_t.recv
	"N64 Controller Read" command receive data More...

struct	joybus_cmd_gcn_controller_read_port_t.send
	"GameCube Controller Read" command send data More...

struct	joybus_cmd_gcn_controller_read_port_t.recv
	"GameCube Controller Read" command receive data More...

struct	joybus_cmd_gcn_controller_read_long_port_t.send
	"GameCube Controller Long Read" command send data More...

struct	joybus_cmd_gcn_controller_read_long_port_t.recv
	"GameCube Controller Long Read" command receive data More...

Typedefs
typedef joybus_cmd_n64_accessory_read_port_t	joybus_cmd_64gb_link_cable_read_port_t
	"64GB Link Cable Read" Joybus command structure.

typedef joybus_cmd_n64_accessory_read_port_t	joybus_cmd_gba_link_cable_read_port_t
	"GBA Link Cable Read" Joybus command structure.

typedef joybus_cmd_n64_accessory_write_port_t	joybus_cmd_64gb_link_cable_write_port_t
	"64GB Link Cable Write" Joybus command structure.

typedef joybus_cmd_n64_accessory_write_port_t	joybus_cmd_gba_link_cable_write_port_t
	"GBA Link Cable Write" Joybus command structure.

typedef joybus_cmd_identify_port_t	joybus_cmd_reset_port_t
	"Reset" Joybus command structure.

typedef joybus_cmd_eeprom_read_block_t	joybus_cmd_rtc_read_block_t
	"RTC Read Block" Joybus command structure.

typedef joybus_cmd_eeprom_write_block_t	joybus_cmd_rtc_write_block_t
	"RTC Write Block" Joybus command structure.

typedef joybus_cmd_gcn_controller_read_long_port_t	joybus_cmd_gcn_controller_recalibrate_port_t
	"GameCube Controller Recalibrate" Joybus command structure.

typedef joybus_cmd_gcn_controller_read_long_port_t	joybus_cmd_gcn_controller_origin_port_t
	"GameCube Controller Read Origins" Joybus command structure.

Joybus command metadata values

#define	JOYBUS_COMMAND_SKIP_SIZE 1
	Size of a Joybus command to "skip this port" in bytes.

#define	JOYBUS_COMMAND_METADATA_SIZE 2
	Size of the Joybus command metadata fields in bytes.

#define	JOYBUS_COMMAND_OFFSET_SEND_LEN 0
	Offset of the Joybus command "send length" field in bytes.

#define	JOYBUS_COMMAND_OFFSET_RECV_LEN 1
	Offset of the Joybus command "receive length" field in bytes.

#define	JOYBUS_COMMAND_OFFSET_COMMAND_ID 2
	Offset of the Joybus command "command ID" field in bytes.

Joybus command identifiers

#define	JOYBUS_COMMAND_ID_RESET 0xFF
	"Reset" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_IDENTIFY 0x00
	"Identify" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_N64_CONTROLLER_READ 0x01
	"N64 Controller Read" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_N64_ACCESSORY_READ 0x02
	"N64 Accessory Read" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_N64_ACCESSORY_WRITE 0x03
	"N64 Accessory Write" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_EEPROM_READ_BLOCK 0x04
	"EEPROM Read Block" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_EEPROM_WRITE_BLOCK 0x05
	"EEPROM Write Block" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_RTC_IDENTIFY 0x06
	"Real-Time Clock Identify" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_RTC_READ_BLOCK 0x07
	"Real-Time Clock Read Block" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_RTC_WRITE_BLOCK 0x08
	"Real-Time Clock Write Block" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_N64_RANDNET_KEYBOARD_READ 0x13
	"N64 Randnet Keyboard Read" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_64GB_LINK_CABLE_READ 0x13
	"64GB Link Cable Read" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_GBA_LINK_CABLE_READ 0x14
	"GBA Link Cable Read" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_64GB_LINK_CABLE_WRITE 0x14
	"64GB Link Cable Write" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_GBA_LINK_CABLE_WRITE 0x15
	"GBA Link Cable Write" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_PIXELFX_N64_GAME_ID 0x1D
	"PixelFX N64 Game ID" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_GCN_CONTROLLER_READ 0x40
	"GameCube Controller Read" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_GCN_CONTROLLER_ORIGIN 0x41
	"GameCube Controller Read Origins" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_GCN_CONTROLLER_RECALIBRATE 0x42
	"GameCube Controller Recalibrate" Joybus command identifier.

#define	JOYBUS_COMMAND_ID_GCN_CONTROLLER_READ_LONG 0x43
	"GameCube Controller 'Long Read'" Joybus command identifier.

Detailed Description

Joybus command helpers and data structures.

Joybus commands are used to communicate with peripherals via the N64's serial interface (SI). There are 4 ports on the front of the N64 for connecting joypads and other devices, and one additional port on the cartridge connector for EEPROM and real-time clock.

A Joybus command consists of metadata, send data, and receive data.

Metadata is used to specify the length of the send and receive data. It is always 2 bytes long, and does not include the command identifier.

The send data is the request-side of the command. Its shape and size depends on the specific command that is being issued, but the send data will always include a 1-byte command identifier at the beginning.

The receive data is the response-side of the command. Its shape and size depends on the specific command that is being issued.

Joybus commands are composed into an "operation block" that issues a command to each Joybus port on the system in order. A port can be skipped by providing a single-byte command with a value of 0x00 (zero send length).

Data Structure Documentation

◆ joybus_cmd_n64_accessory_read_port_t

struct joybus_cmd_n64_accessory_read_port_t

"N64 Accessory Read" Joybus command structure.

See also: JOYBUS_COMMAND_ID_N64_ACCESSORY_READ

Data Fields
struct joybus_cmd_n64_accessory_read_port_t.send	send	"N64 Accessory Read" command send data
struct joybus_cmd_n64_accessory_read_port_t.recv	recv	"N64 Accessory Read" command receive data

◆ joybus_cmd_n64_accessory_write_port_t

struct joybus_cmd_n64_accessory_write_port_t

"N64 Accessory Write" Joybus command structure.

See also: JOYBUS_COMMAND_ID_N64_ACCESSORY_WRITE

Data Fields
struct joybus_cmd_n64_accessory_write_port_t.send	send	"N64 Accessory Write" command send data
struct joybus_cmd_n64_accessory_write_port_t.recv	recv	"N64 Accessory Write" command receive data

◆ joybus_cmd_identify_port_t

struct joybus_cmd_identify_port_t

"Identify" Joybus command structure.

See also: JOYBUS_COMMAND_ID_IDENTIFY

Data Fields
struct joybus_cmd_identify_port_t.send	send	"Identify" command send data
struct joybus_cmd_identify_port_t.recv	recv	"Identify" command receive data

◆ joybus_cmd_eeprom_read_block_t

struct joybus_cmd_eeprom_read_block_t

"EEPROM Read Block" Joybus command structure.

See also: JOYBUS_COMMAND_ID_EEPROM_READ_BLOCK

Data Fields
struct joybus_cmd_eeprom_read_block_t.send	send	"EEPROM Read Block" command send data
struct joybus_cmd_eeprom_read_block_t.recv	recv	"EEPROM Read Block" command receive data

◆ joybus_cmd_eeprom_write_block_t

struct joybus_cmd_eeprom_write_block_t

"EEPROM Write Block" Joybus command structure.

See also: JOYBUS_COMMAND_ID_EEPROM_WRITE_BLOCK

Data Fields
struct joybus_cmd_eeprom_write_block_t.send	send	"EEPROM Write Block" command send data
struct joybus_cmd_eeprom_write_block_t.recv	recv	"EEPROM Write Block" command receive data

◆ joybus_cmd_pixelfx_n64_game_id_t

struct joybus_cmd_pixelfx_n64_game_id_t

"PixelFX N64 Game ID" Joybus command structure.

See also: JOYBUS_COMMAND_ID_PIXELFX_N64_GAME_ID

Data Fields
struct joybus_cmd_pixelfx_n64_game_id_t.send	send	"PixelFX N64 Game ID" command send data
uint8_t	recv	(unused) As per PixelFX's documentation, N64Digital does not respond to this command. N64Digital only acts as a bus sniffer.

◆ joybus_cmd_n64_controller_read_port_t

struct joybus_cmd_n64_controller_read_port_t

"N64 Controller Read" Joybus command structure.

See also: JOYBUS_COMMAND_ID_N64_CONTROLLER_READ

Data Fields
struct joybus_cmd_n64_controller_read_port_t.send	send	"N64 Controller Read" command send data
struct joybus_cmd_n64_controller_read_port_t.recv	recv	"N64 Controller Read" command receive data

◆ joybus_cmd_gcn_controller_read_port_t

struct joybus_cmd_gcn_controller_read_port_t

"GameCube Controller Read" Joybus command structure.

See also: JOYBUS_COMMAND_ID_GCN_CONTROLLER_READ

Data Fields
struct joybus_cmd_gcn_controller_read_port_t.send	send	"GameCube Controller Read" command send data
struct joybus_cmd_gcn_controller_read_port_t.recv	recv	"GameCube Controller Read" command receive data

◆ joybus_cmd_gcn_controller_read_long_port_t

struct joybus_cmd_gcn_controller_read_long_port_t

"GameCube Controller Long Read" Joybus command structure.

See also: JOYBUS_COMMAND_ID_GCN_CONTROLLER_READ_LONG

Data Fields
struct joybus_cmd_gcn_controller_read_long_port_t.send	send	"GameCube Controller Long Read" command send data
struct joybus_cmd_gcn_controller_read_long_port_t.recv	recv	"GameCube Controller Long Read" command receive data

◆ joybus_cmd_n64_accessory_read_port_t.send

struct joybus_cmd_n64_accessory_read_port_t.send

"N64 Accessory Read" command send data

Data Fields
uint8_t	command	Joybus command ID (JOYBUS_COMMAND_ID_N64_ACCESSORY_READ)
uint16_t	addr_checksum	Accessory address with 5-bit checksum.

◆ joybus_cmd_n64_accessory_read_port_t.recv

struct joybus_cmd_n64_accessory_read_port_t.recv

"N64 Accessory Read" command receive data

Data Fields
uint8_t	data[JOYBUS_ACCESSORY_DATA_SIZE]	32-byte payload of data read from the accessory.
uint8_t	data_crc	CRC8 checksum of the data for verification.

◆ joybus_cmd_n64_accessory_write_port_t.send

struct joybus_cmd_n64_accessory_write_port_t.send

"N64 Accessory Write" command send data

Data Fields
uint8_t	command	Joybus command ID (JOYBUS_COMMAND_ID_N64_ACCESSORY_WRITE)
uint16_t	addr_checksum	Accessory address with 5-bit checksum.
uint8_t	data[JOYBUS_ACCESSORY_DATA_SIZE]	32-byte payload of data to write to the accessory.

◆ joybus_cmd_n64_accessory_write_port_t.recv

struct joybus_cmd_n64_accessory_write_port_t.recv

"N64 Accessory Write" command receive data

Data Fields
uint8_t	data_crc	CRC8 checksum of the written data for verification.

◆ joybus_cmd_identify_port_t.send

struct joybus_cmd_identify_port_t.send

"Identify" command send data

Data Fields
uint8_t	command	Joybus command ID (JOYBUS_COMMAND_ID_IDENTIFY)

◆ joybus_cmd_identify_port_t.recv

struct joybus_cmd_identify_port_t.recv

"Identify" command receive data

Data Fields
uint16_t	identifier	Joybus device identifier.
uint8_t	status	Joybus device status byte.

◆ joybus_cmd_eeprom_read_block_t.send

struct joybus_cmd_eeprom_read_block_t.send

"EEPROM Read Block" command send data

Data Fields
uint8_t	command	Joybus command ID (JOYBUS_COMMAND_ID_EEPROM_READ_BLOCK)
uint8_t	block	EEPROM block to read.

◆ joybus_cmd_eeprom_read_block_t.recv

struct joybus_cmd_eeprom_read_block_t.recv

"EEPROM Read Block" command receive data

Data Fields
union joybus_cmd_eeprom_read_block_t.recv.__unnamed15__	__unnamed__
uint8_t	status	Status byte.

◆ joybus_cmd_eeprom_read_block_t.recv.unnamed15

union joybus_cmd_eeprom_read_block_t.recv.__unnamed15__

Data Fields
uint8_t	data[8]	8-byte payload from the EEPROM block
uint64_t	dword	64-bit payload from the EEPROM block

◆ joybus_cmd_eeprom_write_block_t.send

struct joybus_cmd_eeprom_write_block_t.send

"EEPROM Write Block" command send data

Data Fields
uint8_t	command	Joybus command ID (JOYBUS_COMMAND_ID_EEPROM_WRITE_BLOCK)
uint8_t	block	EEPROM block to read.
union joybus_cmd_eeprom_write_block_t.send.__unnamed19__	__unnamed__

◆ joybus_cmd_eeprom_write_block_t.send.unnamed19

union joybus_cmd_eeprom_write_block_t.send.__unnamed19__

Data Fields
uint8_t	data[8]	8-byte payload for the EEPROM block
uint64_t	dword	64-bit payload for the EEPROM block

◆ joybus_cmd_eeprom_write_block_t.recv

struct joybus_cmd_eeprom_write_block_t.recv

"EEPROM Write Block" command receive data

Data Fields
uint8_t	status	Status byte.

◆ joybus_cmd_pixelfx_n64_game_id_t.send

struct joybus_cmd_pixelfx_n64_game_id_t.send

"PixelFX N64 Game ID" command send data

Data Fields
uint8_t	command	Joybus command ID (JOYBUS_COMMAND_ID_PIXELFX_N64_GAME_ID)
uint64_t	rom_check_code	ROM check code (ROM header bytes 0x10-0x17). 64-bit check code calculated on 1 Mbyte of ROM contents starting from offset 0x1000. Sometimes these 8 bytes are incorrectly referred to as "CRC HI/LO" or "CRC1/2".
uint8_t	media_format	Media category code (ROM header byte 0x3B)
uint8_t	region_code	Region code (ROM header byte 0x3E)

◆ joybus_cmd_n64_controller_read_port_t.send

struct joybus_cmd_n64_controller_read_port_t.send

"N64 Controller Read" command send data

Data Fields
uint8_t	command	Joybus command ID (JOYBUS_COMMAND_ID_N64_CONTROLLER_READ)

◆ joybus_cmd_n64_controller_read_port_t.recv

struct joybus_cmd_n64_controller_read_port_t.recv

"N64 Controller Read" command receive data

Data Fields
unsigned	a: 1	A button.
unsigned	b: 1	B button.
unsigned	z: 1	Z button.
unsigned	start: 1	Start button.
unsigned	d_up: 1	D-Pad up.
unsigned	d_down: 1	D-Pad down.
unsigned	d_left: 1	D-Pad left.
unsigned	d_right: 1	D-Pad right.
unsigned	reset: 1	Reset flag.
unsigned	__pad0__: 1	Unused padding.
unsigned	l: 1	L shoulder button.
unsigned	r: 1	R shoulder button.
unsigned	c_up: 1	C-Pad up.
unsigned	c_down: 1	C-Pad down.
unsigned	c_left: 1	C-Pad left.
unsigned	c_right: 1	C-Pad right.
signed	stick_x: 8	Analog stick X-axis.
signed	stick_y: 8	Analog stick Y-axis.

◆ joybus_cmd_gcn_controller_read_port_t.send

struct joybus_cmd_gcn_controller_read_port_t.send

"GameCube Controller Read" command send data

Data Fields
uint8_t	command	Joybus command ID (JOYBUS_COMMAND_ID_GCN_CONTROLLER_READ)
uint8_t	mode	GameCube controller mode (0-3)
uint8_t	rumble	Rumble motor control.

◆ joybus_cmd_gcn_controller_read_port_t.recv

struct joybus_cmd_gcn_controller_read_port_t.recv

"GameCube Controller Read" command receive data

Data Fields
unsigned	__pad0__: 2	Unused padding.
unsigned	check_origin: 1	Origin check flag.
unsigned	start: 1	Start button.
unsigned	y: 1	Y button.
unsigned	x: 1	X button.
unsigned	b: 1	B button.
unsigned	a: 1	A button.
unsigned	use_origin: 1	Origin use flag.
unsigned	l: 1	L button.
unsigned	r: 1	R button.
unsigned	z: 1	Z button.
unsigned	d_up: 1	D-Pad up.
unsigned	d_down: 1	D-Pad down.
unsigned	d_right: 1	D-Pad right.
unsigned	d_left: 1	D-Pad left.
unsigned	stick_x: 8	Analog stick X-axis.
unsigned	stick_y: 8	Analog stick Y-axis.
unsigned	cstick_x: 8	Analog C-Stick X-axis.
unsigned	cstick_y: 8	Analog C-Stick Y-axis.
unsigned	analog_l: 8	Analog L trigger.
unsigned	analog_r: 8	Analog R trigger.

◆ joybus_cmd_gcn_controller_read_long_port_t.send

struct joybus_cmd_gcn_controller_read_long_port_t.send

"GameCube Controller Long Read" command send data

Data Fields
uint8_t	command	Joybus command ID (JOYBUS_COMMAND_ID_GCN_CONTROLLER_READ_LONG)

◆ joybus_cmd_gcn_controller_read_long_port_t.recv

struct joybus_cmd_gcn_controller_read_long_port_t.recv

"GameCube Controller Long Read" command receive data

Data Fields
unsigned	__pad0__: 2	Unused padding.
unsigned	check_origin: 1	Check origin flag.
unsigned	start: 1	Start button.
unsigned	y: 1	Y button.
unsigned	x: 1	X button.
unsigned	b: 1	B button.
unsigned	a: 1	A button.
unsigned	use_origin: 1	Use origin flag.
unsigned	l: 1	L button.
unsigned	r: 1	R button.
unsigned	z: 1	Z button.
unsigned	d_up: 1	D-Pad up.
unsigned	d_down: 1	D-Pad down.
unsigned	d_right: 1	D-Pad right.
unsigned	d_left: 1	D-Pad left.
unsigned	stick_x: 8	Analog stick X-axis.
unsigned	stick_y: 8	Analog stick Y-axis.
unsigned	cstick_x: 8	Analog C-Stick X-axis.
unsigned	cstick_y: 8	Analog C-Stick Y-axis.
unsigned	analog_l: 8	Analog L trigger.
unsigned	analog_r: 8	Analog R trigger.
unsigned	analog_a: 8	Analog A button.
unsigned	analog_b: 8	Analog B button.