tpak.h

Go to the documentation of this file.

 
#ifndef __LIBDRAGON_TPAK_H
#define __LIBDRAGON_TPAK_H
 
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define TPAK_ERROR_INVALID_ARGUMENT     -1
#define TPAK_ERROR_NO_TPAK              -2
#define TPAK_ERROR_NO_CONTROLLER        -3
#define TPAK_ERROR_UNKNOWN_BEHAVIOUR    -4
#define TPAK_ERROR_NO_CARTRIDGE         -5
#define TPAK_ERROR_ADDRESS_OVERFLOW     -6
#define TPAK_STATUS_READY           0x01
#define TPAK_STATUS_WAS_RESET       0x04
#define TPAK_STATUS_IS_RESETTING    0x08
#define TPAK_STATUS_REMOVED         0x40
#define TPAK_STATUS_POWERED         0x80
typedef enum __attribute__ ((packed))
{
    GB_ROM_ONLY = 0x00,
    GB_MBC1 = 0x01,
    GB_MBC1_RAM = 0x02,
    GB_MBC1_RAM_BATTERY = 0x03,
    GB_MBC2 = 0x05,
    GB_MBC2_BATTERY = 0x06,
    GB_ROM_RAM = 0x08,
    GB_ROM_RAM_BATTERY = 0x09,
    GB_MMM01 = 0x0B,
    GB_MMM01_RAM = 0x0C,
    GB_MMM01_RAM_BATTERY = 0x0D,
    GB_MBC3 = 0x11,
    GB_MBC3_RAM = 0x12,
    GB_MBC3_RAM_BATTERY = 0x13,
    GB_MBC3_TIMER_BATTERY = 0x0F,
    GB_MBC3_TIMER_RAM_BATTERY = 0x10,
    GB_MBC5 = 0x19,
    GB_MBC5_RAM = 0x1A,
    GB_MBC5_RAM_BATTERY = 0x1B,
    GB_MBC5_RUMBLE = 0x1C,
    GB_MBC5_RUMBLE_RAM = 0x1D,
    GB_MBC5_RUMBLE_RAM_BATTERY = 0x1E,
    GB_MBC6 = 0x20,
    GB_MBC7_SENSOR_RUMBLE_RAM_BATTERY = 0x22,
    GB_POCKET_CAMERA = 0xFC,
    GB_BANDAI_TAMA5 = 0xFD,
    GB_HUC3 = 0xFE,
    GB_HUC1_RAM_BATTERY = 0xFF,
} gb_cart_type_t;
 
typedef enum __attribute__ ((packed))
{
    GB_ROM_32KB = 0x00,
    GB_ROM_64KB = 0x01,
    GB_ROM_128KB = 0x02,
    GB_ROM_256KB = 0x03,
    GB_ROM_512KB = 0x04,
    GB_ROM_1MB = 0x05,
    GB_ROM_2MB = 0x06,
    GB_ROM_4MB = 0x07,
    GB_ROM_8MB = 0x08,
    GB_ROM_1152KB = 0x52,
    GB_ROM_1280KB = 0x53,
    GB_ROM_1536KB = 0x54,
} gb_cart_rom_size_t;
 
typedef enum __attribute__ ((packed))
{
    GB_RAM_NONE = 0x00,
    GB_RAM_2KB = 0x01,
    GB_RAM_8KB = 0x02,
    GB_RAM_32KB = 0x03,
    GB_RAM_64KB = 0x05,
    GB_RAM_128KB = 0x04,
} gb_cart_ram_size_t;
 
typedef enum __attribute__ ((packed))
{
    GBC_NOT_SUPPORTED = 0x00,
    GBC_DMG_SUPPORTED = 0x80,
    GBC_ONLY_SUPPORTED = 0xC0
} gbc_support_type;
 
typedef enum __attribute__ ((packed))
{
    SGB_NOT_ENHANCED = 0x00,
    SGB_ENHANCED     = 0x03
} sgb_support_type;
 
struct old_gbc_title
{
    uint8_t title[15];
    gbc_support_type gbc_support;
};
 
struct new_gbc_title
{
    uint8_t title[11];
    uint8_t manufacturer_code[4];
    gbc_support_type gbc_support;
};
 
struct gameboy_cartridge_header
{
    uint8_t entry_point[4];
    uint8_t logo[48];
    union {
        uint8_t title[16];
        struct old_gbc_title old_title;
        struct new_gbc_title new_title;
    };
    uint16_t new_licensee_code;
    sgb_support_type is_sgb_supported;
    gb_cart_type_t cartridge_type;
    gb_cart_rom_size_t rom_size_code;
    gb_cart_ram_size_t ram_size_code;
    uint8_t destination_code;
    uint8_t old_licensee_code;
    uint8_t version_number;
    uint8_t header_checksum;
    uint16_t global_checksum;
    uint8_t overflow[16];
};
 
int tpak_init(int controller);
 
int tpak_set_value(int controller, uint16_t address, uint8_t value);
 
int tpak_set_bank(int controller, int bank);
 
int tpak_set_power(int controller, bool power_state);
 
int tpak_set_access(int controller, bool access_state);
 
uint8_t tpak_get_status(int controller);
 
int tpak_get_cartridge_header(int controller, struct gameboy_cartridge_header* header);
 
bool tpak_check_header(struct gameboy_cartridge_header* header);
 
int tpak_write(int controller, uint16_t address, uint8_t* data, uint16_t size);
 
int tpak_read(int controller, uint16_t address, uint8_t* buffer, uint16_t size);
 
#ifdef __cplusplus
}
#endif
 
#endif