flashcart.h

Go to the documentation of this file.

 
#ifndef FLASHCART_H__
#define FLASHCART_H__
 
 
#include <stdbool.h>
#include <stdint.h>
 
 
typedef enum {
    FLASHCART_OK,
    FLASHCART_ERR_OUTDATED,
    FLASHCART_ERR_SD_CARD,
    FLASHCART_ERR_BBFS,
    FLASHCART_ERR_ARGS,
    FLASHCART_ERR_LOAD,
    FLASHCART_ERR_INT,
    FLASHCART_ERR_FUNCTION_NOT_SUPPORTED,
} flashcart_err_t;
 
typedef enum {
    FLASHCART_FEATURE_64DD,
    FLASHCART_FEATURE_RTC,
    FLASHCART_FEATURE_USB,
    FLASHCART_FEATURE_AUTO_CIC,
    FLASHCART_FEATURE_AUTO_REGION,
    FLASHCART_FEATURE_DIAGNOSTIC_DATA,
    FLASHCART_FEATURE_BIOS_UPDATE_FROM_MENU,
    FLASHCART_FEATURE_SAVE_WRITEBACK
} flashcart_features_t;
 
typedef enum {
    FLASHCART_SAVE_TYPE_NONE,
    FLASHCART_SAVE_TYPE_EEPROM_4KBIT,
    FLASHCART_SAVE_TYPE_EEPROM_16KBIT,
    FLASHCART_SAVE_TYPE_SRAM_256KBIT,
    FLASHCART_SAVE_TYPE_SRAM_BANKED,
    FLASHCART_SAVE_TYPE_SRAM_1MBIT,
    FLASHCART_SAVE_TYPE_FLASHRAM_1MBIT,
    FLASHCART_SAVE_TYPE_FLASHRAM_PKST2,
    __FLASHCART_SAVE_TYPE_END
} flashcart_save_type_t;
 
typedef struct {
    bool development_drive;
    uint8_t disk_type;
    bool bad_system_area_lbas[24];
    uint8_t defect_tracks[16][12];
} flashcart_disk_parameters_t;
 
typedef struct {
    uint16_t major;
    uint16_t minor;
    uint32_t revision;
} flashcart_firmware_version_t;
 
typedef void flashcart_progress_callback_t (float progress);
 
typedef struct {
    flashcart_err_t (*init) (void);
    flashcart_err_t (*deinit) (void);
    bool (*has_feature) (flashcart_features_t feature);
    flashcart_firmware_version_t (*get_firmware_version) (void);
    flashcart_err_t (*load_rom) (char *rom_path, flashcart_progress_callback_t *progress);
    flashcart_err_t (*load_file) (char *file_path, uint32_t rom_offset, uint32_t file_offset);
    flashcart_err_t (*load_save) (char *save_path);
    flashcart_err_t (*load_64dd_ipl) (char *ipl_path, flashcart_progress_callback_t *progress);
    flashcart_err_t (*load_64dd_disk) (char *disk_path, flashcart_disk_parameters_t *disk_parameters);
    flashcart_err_t (*set_save_type) (flashcart_save_type_t save_type);
    flashcart_err_t (*set_save_writeback) (char *save_path);
} flashcart_t;
 
 
char *flashcart_convert_error_message (flashcart_err_t err);
flashcart_err_t flashcart_init (const char **storage_prefix);
flashcart_err_t flashcart_deinit (void);
bool flashcart_has_feature (flashcart_features_t feature);
flashcart_firmware_version_t flashcart_get_firmware_version (void);
flashcart_err_t flashcart_load_rom (char *rom_path, bool byte_swap, flashcart_progress_callback_t *progress);
flashcart_err_t flashcart_load_file (char *file_path, uint32_t rom_offset, uint32_t file_offset);
flashcart_err_t flashcart_load_save (char *save_path, flashcart_save_type_t save_type);
flashcart_err_t flashcart_load_64dd_ipl (char *ipl_path, flashcart_progress_callback_t *progress);
flashcart_err_t flashcart_load_64dd_disk (char *disk_path, flashcart_disk_parameters_t *disk_parameters);
 
 
#endif