rom_info.h

Go to the documentation of this file.

 
#ifndef ROM_INFO_H__
#define ROM_INFO_H__
 
 
#include <stdbool.h>
#include <stdint.h>
 
#include "boot/cic.h"
 
 
typedef enum {
    ROM_OK,
    ROM_ERR_IO,
    ROM_ERR_NO_FILE,
} rom_err_t;
 
typedef enum {
    ENDIANNESS_BIG,
    ENDIANNESS_LITTLE,
    ENDIANNESS_BYTE_SWAP,
} endianness_t;
 
typedef enum {
    N64_CART = 'N',
    N64_DISK  = 'D',
    N64_CART_EXPANDABLE = 'C',
    N64_DISK_EXPANDABLE = 'E',
    N64_ALECK64  = 'Z'
} category_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.
} destination_type_t;
 
typedef enum {
    SAVE_TYPE_NONE,
    SAVE_TYPE_EEPROM_4K,
    SAVE_TYPE_EEPROM_16K,
    SAVE_TYPE_SRAM,
    SAVE_TYPE_SRAM_BANKED,
    SAVE_TYPE_SRAM_128K,
    SAVE_TYPE_FLASHRAM,
    SAVE_TYPE_FLASHRAM_PKST2,
} save_type_t;
 
typedef enum {
    EXPANSION_PAK_NONE,
 
    EXPANSION_PAK_REQUIRED,
 
    EXPANSION_PAK_RECOMMENDED,
 
    EXPANSION_PAK_SUGGESTED,
 
    EXPANSION_PAK_FAULTY,
} expansion_pak_t;
 
typedef struct {
    endianness_t endianness;
    float clock_rate;
    uint32_t boot_address;
    struct {
        uint8_t version;
        char revision;
    } libultra;
    uint64_t check_code;
    char title[20];
    union {
        char game_code[4];
        struct {
            category_type_t category_code : 8;
            char unique_code[2];
            destination_type_t destination_code : 8;
        };
    };
    uint8_t version;
 
    cic_type_t cic_type;
 
    save_type_t save_type;
 
    struct {
        bool controller_pak;
        bool rumble_pak;
        bool transfer_pak;
        bool voice_recognition_unit;
        bool real_time_clock;
        bool disk_conversion;
        bool combo_rom_disk_game;
        expansion_pak_t expansion_pak;
    } features;
} rom_info_t;
 
 
rom_err_t rom_info_load (char *path, rom_info_t *rom_info);
 
 
#endif