rom_database.h

Go to the documentation of this file.

 
#ifndef ROM_DATABASE_H__
#define ROM_DATABASE_H__
 
#include <stdint.h>
 
 
typedef enum {
    DB_SAVE_TYPE_NONE =          0x00,
    DB_SAVE_TYPE_EEPROM_4K =     0x01,
    DB_SAVE_TYPE_EEPROM_16K =    0x02,
    DB_SAVE_TYPE_SRAM =          0x03,
    DB_SAVE_TYPE_SRAM_BANKED =   0x04,
    DB_SAVE_TYPE_SRAM_128K =     0x05,
    DB_SAVE_TYPE_FLASHRAM =      0x06,
    DB_SAVE_TYPE_CPAK =          0x10,
    DB_SAVE_TYPE_DD =            0x20,
    DB_SAVE_TYPE_DD_CONVERSION = 0x30,
    DB_SAVE_TYPE_INVALID =       0xFF,
 } db_savetype_t;
 
 
typedef enum {
    DB_MEMORY_EXPANSION_NONE =        0x00,
    DB_MEMORY_EXPANSION_REQUIRED =    0x01,
    DB_MEMORY_EXPANSION_RECOMMENDED = 0x02,
    DB_MEMORY_EXPANSION_SUGGESTED =   0x03,
    DB_MEMORY_EXPANSION_FAULTY =      0x04,
} rom_memorytype_t;
 
 
typedef enum {
    HB_SAVE_TYPE_NONE =         0x00,
    HB_SAVE_TYPE_EEPROM_4K =    0x01,
    HB_SAVE_TYPE_EEPROM_16K =   0x02,
    HB_SAVE_TYPE_SRAM =         0x03,
    HB_SAVE_TYPE_SRAM_BANKED =  0x04,
    HB_SAVE_TYPE_FLASHRAM =     0x05,
    HB_SAVE_TYPE_SRAM_128K =    0x06,
} homebrew_savetype_t;
 
typedef enum {
    ROM_BIG_ENDIAN =        0x80371240,
    ROM_LITTLE_ENDIAN =     0x40123780,
    ROM_MID_BIG_ENDIAN =    0x37804012,
    ROM_MID_LITTLE_ENDIAN = 0x12408037,
    IPL_BIG_ENDIAN =        0x80270740,
} rom_endian_type_t;
 
 
typedef enum {
    N64_CART = 'N',
    N64_DISK  = 'D',
    N64_CART_EXPANDABLE = 'C',
    N64_DISK_EXPANDABLE = 'E',
    N64_ALECK64  = 'Z'
} rom_media_type_t;
 
typedef enum {
    MARKET_JAPANESE_MULTI = 'A', // 1080 Snowboarding JPN is the only ROM that uses this? possibily a mistake, or the fact it also includes American English!.
    MARKET_BRAZILIAN  = 'B',
    MARKET_CHINESE = 'C',
    MARKET_GERMAN = 'D',
    MARKET_NORTH_AMERICA  = 'E',
    MARKET_FRENCH = 'F',
    MARKET_GATEWAY64_NTSC = 'G',
    MARKET_DUTCH = 'H',
    MARKET_ITALIAN = 'I',
    MARKET_JAPANESE = 'J',
    MARKET_KOREAN = 'K',
    MARKET_GATEWAY64_PAL = 'L',
    MARKET_CANADIAN = 'N',
    MARKET_EUROPEAN_BASIC = 'P', // Sometimes used for Australian region ROMs as well.
    MARKET_SPANISH = 'S',
    MARKET_AUSTRALIAN = 'U',
    MARKET_SCANDINAVIAN = 'W',
    MARKET_OTHER_X = 'X', // many EU ROM's, Top Gear Rally (Asia) and HSV Racing (AUS) ROM uses this.
    MARKET_OTHER_Y = 'Y', // many EU ROM's uses this.
    MARKET_OTHER_Z = 'Z' // no known ROM's use this.
} rom_destination_market_t;
 
 
typedef struct {
    /* PI BSD Domain 1 Release register value */
    uint8_t domain1_release;
    /* PI BSD Domain 1 Page Size register value */
    uint8_t domain1_page_size;
    /* PI BSD Domain 1 Pulse Width register value */
    uint8_t domain1_latency;
    /* PI BSD Domain 1 Latch register value */
    uint8_t domain1_pulse_width;
} rom_config_flags_t;
 
typedef struct {
    uint8_t media_type; // rom_media_type_t
    uint16_t unique_identifier;
    uint8_t destination_market; // rom_destination_market_t
    uint8_t version;
} rom_metadata_t;
 
typedef struct {
    uint32_t config_flags; // TODO: use rom_config_flags_t
 
    uint32_t clock_rate;
    uint32_t boot_address;
    uint32_t sdk_version;
 
    uint64_t checksum;
 
    uint64_t unknown_reserved_1;
 
    char title[21]; // 20 chars + null char
 
    char unknown_reserved_2[7];
 
    rom_metadata_t metadata;
    char ipl_boot_code[0x0FC0];
 
} rom_header_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
rom_header_t file_read_rom_header(char *path);
uint8_t rom_db_match_save_type(rom_header_t rom_header);
uint8_t rom_db_match_expansion_pak(rom_header_t rom_header);
 
#ifdef __cplusplus
}
#endif
 
#endif