mirror of
https://github.com/zeldaret/oot.git
synced 2024-11-25 17:54:15 +00:00
97e795fc0e
* Cleanup libultra controller routines * Correct structure name * Fixes + Suggestions * Move READFORMAT macro to controller.h
207 lines
5.7 KiB
C
207 lines
5.7 KiB
C
#ifndef ULTRA64_CONTROLLER_H
|
|
#define ULTRA64_CONTROLLER_H
|
|
|
|
#include "message.h"
|
|
|
|
/**
|
|
* Controller channel
|
|
* Each game controller channel has 4 error bits that are defined in bit 6-7 of
|
|
* the Rx and Tx data size area bytes. Programmers need to clear these bits
|
|
* when setting the Tx/Rx size area values for a channel
|
|
*/
|
|
#define CHNL_ERR_NORESP 0x80 /* Bit 7 (Rx): No response error */
|
|
#define CHNL_ERR_OVERRUN 0x40 /* Bit 6 (Rx): Overrun error */
|
|
#define CHNL_ERR_FRAME 0x80 /* Bit 7 (Tx): Frame error */
|
|
#define CHNL_ERR_COLLISION 0x40 /* Bit 6 (Tx): Collision error */
|
|
|
|
#define CHNL_ERR_MASK 0xC0 /* Bit 6-7: channel errors */
|
|
|
|
#define CHNL_ERR(readFormat) (((readFormat).rxsize & CHNL_ERR_MASK) >> 4)
|
|
|
|
#define BLOCKSIZE 32
|
|
#define MAXCONTROLLERS 4
|
|
#define PFS_ONE_PAGE 8
|
|
|
|
#define PFS_PAGE_SIZE (BLOCKSIZE*PFS_ONE_PAGE)
|
|
|
|
#define CONT_CMD_REQUEST_STATUS 0
|
|
#define CONT_CMD_READ_BUTTON 1
|
|
#define CONT_CMD_READ_MEMPACK 2
|
|
#define CONT_CMD_WRITE_MEMPACK 3
|
|
#define CONT_CMD_READ_EEPROM 4
|
|
#define CONT_CMD_WRITE_EEPROM 5
|
|
#define CONT_CMD_RESET 0xFF
|
|
|
|
#define CONT_CMD_REQUEST_STATUS_TX 1
|
|
#define CONT_CMD_READ_BUTTON_TX 1
|
|
#define CONT_CMD_READ_MEMPACK_TX 3
|
|
#define CONT_CMD_WRITE_MEMPACK_TX 35
|
|
#define CONT_CMD_READ_EEPROM_TX 2
|
|
#define CONT_CMD_WRITE_EEPROM_TX 10
|
|
#define CONT_CMD_RESET_TX 1
|
|
|
|
#define CONT_CMD_REQUEST_STATUS_RX 3
|
|
#define CONT_CMD_READ_BUTTON_RX 4
|
|
#define CONT_CMD_READ_MEMPACK_RX 33
|
|
#define CONT_CMD_WRITE_MEMPACK_RX 1
|
|
#define CONT_CMD_READ_EEPROM_RX 8
|
|
#define CONT_CMD_WRITE_EEPROM_RX 1
|
|
#define CONT_CMD_RESET_RX 3
|
|
|
|
#define CONT_CMD_NOP 0xFF
|
|
#define CONT_CMD_END 0xFE // Indicates end of a command
|
|
#define CONT_CMD_EXE 1 // Set pif ram status byte to this to do a command
|
|
#define CONT_CMD_SKIP_CHNL 0 // Skip channel
|
|
|
|
#define CONT_ERR_NO_CONTROLLER PFS_ERR_NOPACK /* 1 */
|
|
#define CONT_ERR_CONTRFAIL CONT_OVERRUN_ERROR /* 4 */
|
|
#define CONT_ERR_INVALID PFS_ERR_INVALID /* 5 */
|
|
#define CONT_ERR_DEVICE PFS_ERR_DEVICE /* 11 */
|
|
#define CONT_ERR_NOT_READY 12
|
|
#define CONT_ERR_VOICE_MEMORY 13
|
|
#define CONT_ERR_VOICE_WORD 14
|
|
#define CONT_ERR_VOICE_NO_RESPONSE 15
|
|
|
|
|
|
#define DIR_STATUS_EMPTY 0
|
|
#define DIR_STATUS_UNKNOWN 1
|
|
#define DIR_STATUS_OCCUPIED 2
|
|
|
|
#define PFS_FORCE 1
|
|
#define PFS_DELETE 1
|
|
|
|
#define PFS_LABEL_AREA 7
|
|
|
|
#define PFS_ERR_NOPACK 1
|
|
|
|
/* controller errors */
|
|
#define CONT_NO_RESPONSE_ERROR 0x8
|
|
#define CONT_OVERRUN_ERROR 0x4
|
|
|
|
/* Controller type */
|
|
#define CONT_ABSOLUTE 0x0001
|
|
#define CONT_RELATIVE 0x0002
|
|
#define CONT_JOYPORT 0x0004
|
|
#define CONT_EEPROM 0x8000
|
|
#define CONT_EEP16K 0x4000
|
|
#define CONT_TYPE_MASK 0x1F07
|
|
#define CONT_TYPE_NORMAL 0x0005
|
|
#define CONT_TYPE_MOUSE 0x0002
|
|
#define CONT_TYPE_VOICE 0x0100
|
|
|
|
/* Controller status */
|
|
#define CONT_CARD_ON 0x01
|
|
#define CONT_CARD_PULL 0x02
|
|
#define CONT_ADDR_CRC_ER 0x04
|
|
#define CONT_EEPROM_BUSY 0x80
|
|
|
|
/* Accessory detection */
|
|
#define CONT_ADDR_DETECT 0x8000
|
|
|
|
// Rumble
|
|
#define CONT_ADDR_RUMBLE 0xC000
|
|
|
|
// Controller Pak / Transfer Pak
|
|
#define CONT_ADDR_GB_POWER 0x8000 // Same as the detection address, but semantically different
|
|
#define CONT_ADDR_GB_BANK 0xA000
|
|
#define CONT_ADDR_GB_STATUS 0xB000
|
|
|
|
// Addresses sent to controller accessories are in blocks, not bytes
|
|
#define CONT_BLOCKS(x) ((x) / BLOCKSIZE)
|
|
|
|
// Block addresses of the above
|
|
#define CONT_BLOCK_DETECT CONT_BLOCKS(CONT_ADDR_DETECT)
|
|
#define CONT_BLOCK_RUMBLE CONT_BLOCKS(CONT_ADDR_RUMBLE)
|
|
#define CONT_BLOCK_GB_POWER CONT_BLOCKS(CONT_ADDR_GB_POWER)
|
|
#define CONT_BLOCK_GB_BANK CONT_BLOCKS(CONT_ADDR_GB_BANK)
|
|
#define CONT_BLOCK_GB_STATUS CONT_BLOCKS(CONT_ADDR_GB_STATUS)
|
|
|
|
/* Buttons */
|
|
#define BTN_CRIGHT 0x0001
|
|
#define BTN_CLEFT 0x0002
|
|
#define BTN_CDOWN 0x0004
|
|
#define BTN_CUP 0x0008
|
|
#define BTN_R 0x0010
|
|
#define BTN_L 0x0020
|
|
#define BTN_DRIGHT 0x0100
|
|
#define BTN_DLEFT 0x0200
|
|
#define BTN_DDOWN 0x0400
|
|
#define BTN_DUP 0x0800
|
|
#define BTN_START 0x1000
|
|
#define BTN_Z 0x2000
|
|
#define BTN_B 0x4000
|
|
#define BTN_A 0x8000
|
|
|
|
typedef union {
|
|
struct {
|
|
/* 0x00 */ u32 ram[15];
|
|
/* 0x3C */ u32 status;
|
|
};
|
|
u64 force_structure_alignment;
|
|
} OSPifRam; // size = 0x40
|
|
|
|
typedef struct {
|
|
/* 0x00 */ u16 type;
|
|
/* 0x02 */ u8 status;
|
|
/* 0x03 */ u8 errno;
|
|
} OSContStatus; // size = 0x04
|
|
|
|
typedef struct {
|
|
/* 0x00 */ u16 button;
|
|
/* 0x02 */ s8 stick_x;
|
|
/* 0x03 */ s8 stick_y;
|
|
/* 0x04 */ u8 errno;
|
|
} OSContPad; // size = 0x06
|
|
|
|
typedef struct {
|
|
/* 0x00 */ void* address;
|
|
/* 0x04 */ u8 databuffer[32];
|
|
/* 0x24 */ u8 addressCrc;
|
|
/* 0x25 */ u8 dataCrc;
|
|
/* 0x26 */ u8 errno;
|
|
} OSContRamIo; // size = 0x28
|
|
|
|
typedef struct {
|
|
/* 0x00 */ u8 align;
|
|
/* 0x01 */ u8 txsize;
|
|
/* 0x02 */ u8 rxsize;
|
|
/* 0x03 */ u8 cmd;
|
|
/* 0x04 */ u8 typeh;
|
|
/* 0x05 */ u8 typel;
|
|
/* 0x06 */ u8 status;
|
|
/* 0x07 */ u8 align1;
|
|
} __OSContRequesFormat; // size = 0x8
|
|
|
|
typedef struct {
|
|
/* 0x00 */ u8 txsize;
|
|
/* 0x01 */ u8 rxsize;
|
|
/* 0x02 */ u8 cmd;
|
|
/* 0x03 */ u8 typeh;
|
|
/* 0x04 */ u8 typel;
|
|
/* 0x05 */ u8 status;
|
|
} __OSContRequesFormatShort; // size = 0x6
|
|
|
|
typedef struct {
|
|
/* 0x00 */ u8 unk_00;
|
|
/* 0x01 */ u8 txsize;
|
|
/* 0x02 */ u8 rxsize;
|
|
/* 0x03 */ u8 cmd;
|
|
/* 0x04 */ u8 hi;
|
|
/* 0x05 */ u8 lo;
|
|
/* 0x06 */ u8 data[BLOCKSIZE];
|
|
/* 0x26 */ u8 datacrc;
|
|
} __OSContRamReadFormat; // size = 0x27
|
|
|
|
#define READFORMAT(ptr) ((__OSContRamReadFormat*)(ptr))
|
|
|
|
typedef struct {
|
|
/* 0x00 */ u8 align;
|
|
/* 0x01 */ u8 txsize;
|
|
/* 0x02 */ u8 rxsize;
|
|
/* 0x03 */ u8 cmd;
|
|
/* 0x04 */ u16 button;
|
|
/* 0x06 */ s8 joyX;
|
|
/* 0x07 */ s8 joyY;
|
|
} __OSContReadFormat; // size = 0x8
|
|
|
|
#endif
|