joypad_accessory.h

Go to the documentation of this file.

 
#ifndef __LIBDRAGON_JOYPAD_ACCESSORY_H
#define __LIBDRAGON_JOYPAD_ACCESSORY_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "joybus_accessory_internal.h"
#include "joypad.h"
#include "timer.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define JOYPAD_ACCESSORY_RETRY_LIMIT 2
 
typedef enum
{
    JOYPAD_ACCESSORY_STATE_IDLE = 0,
    // Accessory detection routine states
    JOYPAD_ACCESSORY_STATE_DETECT_INIT,
    JOYPAD_ACCESSORY_STATE_DETECT_CPAK_BANK_WRITE,
    JOYPAD_ACCESSORY_STATE_DETECT_CPAK_LABEL_BACKUP,
    JOYPAD_ACCESSORY_STATE_DETECT_CPAK_LABEL_WRITE,
    JOYPAD_ACCESSORY_STATE_DETECT_CPAK_LABEL_READ,
    JOYPAD_ACCESSORY_STATE_DETECT_CPAK_LABEL_RESTORE,
    JOYPAD_ACCESSORY_STATE_DETECT_RUMBLE_PROBE_WRITE,
    JOYPAD_ACCESSORY_STATE_DETECT_RUMBLE_PROBE_READ,
    JOYPAD_ACCESSORY_STATE_DETECT_TRANSFER_PROBE_ON,
    JOYPAD_ACCESSORY_STATE_DETECT_TRANSFER_PROBE_READ,
    JOYPAD_ACCESSORY_STATE_DETECT_TRANSFER_PROBE_OFF,
    JOYPAD_ACCESSORY_STATE_DETECT_SNAP_PROBE_WRITE,
    JOYPAD_ACCESSORY_STATE_DETECT_SNAP_PROBE_READ,
    // Accessory read states
    JOYPAD_ACCESSORY_STATE_READ,
    // Accessory write states
    JOYPAD_ACCESSORY_STATE_WRITE,
    // Rumble Pak motor control states
    JOYPAD_ACCESSORY_STATE_RUMBLE_WRITE,
    // Transfer Pak power control states
    JOYPAD_ACCESSORY_STATE_TRANSFER_ENABLE_PROBE_WRITE,
    JOYPAD_ACCESSORY_STATE_TRANSFER_ENABLE_PROBE_WAIT,
    JOYPAD_ACCESSORY_STATE_TRANSFER_ENABLE_STATUS_WRITE,
    JOYPAD_ACCESSORY_STATE_TRANSFER_ENABLE_STATUS_WAIT,
    JOYPAD_ACCESSORY_STATE_TRANSFER_ENABLE_STATUS_READ,
    // Transfer Pak cartridge read states
    JOYPAD_ACCESSORY_STATE_TRANSFER_LOAD_STATUS_READ,
    JOYPAD_ACCESSORY_STATE_TRANSFER_LOAD_BANK_WRITE,
    JOYPAD_ACCESSORY_STATE_TRANSFER_LOAD_DATA_READ,
    // Transfer Pak cartridge write states
    JOYPAD_ACCESSORY_STATE_TRANSFER_STORE_STATUS_READ,
    JOYPAD_ACCESSORY_STATE_TRANSFER_STORE_BANK_WRITE,
    JOYPAD_ACCESSORY_STATE_TRANSFER_STORE_DATA_WRITE,
} joypad_accessory_state_t;
 
#define joypad_accessory_state_is_detecting(state) \
    ((state) >= JOYPAD_ACCESSORY_STATE_DETECT_INIT && \
     (state) <= JOYPAD_ACCESSORY_STATE_DETECT_SNAP_PROBE_READ)
 
#define joypad_accessory_state_is_transfer_enabling(state) \
    ((state) >= JOYPAD_ACCESSORY_STATE_TRANSFER_ENABLE_PROBE_WRITE && \
     (state) <= JOYPAD_ACCESSORY_STATE_TRANSFER_ENABLE_STATUS_READ)
 
#define joypad_accessory_state_is_transfer_loading(state) \
    ((state) >= JOYPAD_ACCESSORY_STATE_TRANSFER_LOAD_STATUS_READ && \
     (state) <= JOYPAD_ACCESSORY_STATE_TRANSFER_LOAD_DATA_READ)
 
#define joypad_accessory_state_is_transfer_storing(state) \
    ((state) >= JOYPAD_ACCESSORY_STATE_TRANSFER_STORE_STATUS_READ && \
     (state) <= JOYPAD_ACCESSORY_STATE_TRANSFER_STORE_DATA_WRITE)
 
typedef enum
{
    JOYPAD_ACCESSORY_ERROR_PENDING = -1,                    
    JOYPAD_ACCESSORY_ERROR_NONE = 0,                        
    JOYPAD_ACCESSORY_ERROR_ABSENT,                          
    JOYPAD_ACCESSORY_ERROR_CHECKSUM,                        
    JOYPAD_ACCESSORY_ERROR_TRANSFER_PAK_STATUS_CHANGE,      
    JOYPAD_ACCESSORY_ERROR_UNKNOWN,                         
} joypad_accessory_error_t;
 
typedef enum
{
    JOYPAD_ACCESSORY_XFER_READ,         
    JOYPAD_ACCESSORY_XFER_WRITE,        
} joypad_accessory_xfer_t;
 
#define JOYPAD_CONTROLLER_PAK_BANK_SWITCH_ADDRESS       0x8000
 
typedef void (*joypad_accessory_io_callback_t)(joypad_accessory_error_t error, void *ctx);
 
typedef struct
{
    uint8_t *start;
    uint8_t *end;
    uint8_t *cursor;
    uint16_t cart_addr;
    joypad_accessory_io_callback_t callback;
    void *ctx;
} joypad_accessory_io_t;
 
typedef struct
{
    uint8_t *start;
    uint8_t *end;
    uint8_t *cursor;
    uint8_t bank;
    uint16_t cart_addr;
    uint16_t tpak_addr;
} joypad_transfer_pak_io_t;
 
typedef struct joypad_accessory_s
{
    uint8_t status;
    joypad_accessory_type_t type;
    joypad_accessory_state_t state;
    joypad_accessory_error_t error;
    unsigned retries;
    uint8_t cpak_label_backup[JOYBUS_ACCESSORY_DATA_SIZE];
    joypad_accessory_io_t io;
    timer_link_t *transfer_pak_wait_timer;
    joybus_transfer_pak_status_t transfer_pak_status;
    joypad_transfer_pak_io_t transfer_pak_io;
} joypad_accessory_t;
 
void joypad_accessory_reset(joypad_port_t port);
 
void joypad_accessory_detect_async(joypad_port_t port);
 
void joypad_accessory_xfer_async(
    joypad_port_t port,
    joypad_accessory_xfer_t xfer,
    uint16_t start_addr,
    void *dst,
    size_t len,
    joypad_accessory_io_callback_t callback,
    void *ctx
);
 
joypad_accessory_error_t joypad_accessory_xfer(
    joypad_port_t port,
    joypad_accessory_xfer_t xfer,
    uint16_t start_addr,
    void *dst,
    size_t len
);
 
joypad_accessory_error_t joypad_controller_pak_set_bank(joypad_port_t port, uint8_t bank);
 
 
void joypad_rumble_pak_toggle_async(joypad_port_t port, bool active);
 
uint8_t joypad_get_transfer_pak_status(joypad_port_t port);
 
void joypad_transfer_pak_enable_async(joypad_port_t port, bool enabled);
 
void joypad_transfer_pak_load_async(joypad_port_t port, uint16_t cart_addr, void *dst, size_t len);
 
void joypad_transfer_pak_store_async(joypad_port_t port, uint16_t cart_addr, void *src, size_t len);
 
#ifdef __cplusplus
}
#endif
 
 
#endif