The-Homebrew-Cloud/N64FlashcartMenu
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2025-04-04 23:56:35 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation

Browse Source
This commit is contained in:
Robin Jones 2025-02-21 22:46:27 +00:00
parent 244a5a265d
commit 63747e148f
9 changed files with 898 additions and 441 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
src/boot/boot.h
View File

@ -7,42 +7,43 @@
#ifndef BOOT_H__
#define BOOT_H__
#include <stdbool.h>
#include <stdint.h>
/** @brief Boot device type enumeration */
typedef enum {
BOOT_DEVICE_TYPE_ROM = 0,
BOOT_DEVICE_TYPE_64DD = 1,
BOOT_DEVICE_TYPE_ROM = 0, /**< Boot from ROM */
BOOT_DEVICE_TYPE_64DD = 1, /**< Boot from 64DD */
} boot_device_type_t;
/** @brief Reset type enumeration */
typedef enum {
BOOT_RESET_TYPE_COLD = 0,
BOOT_RESET_TYPE_NMI = 1,
BOOT_RESET_TYPE_COLD = 0, /**< Cold reset */
BOOT_RESET_TYPE_NMI = 1, /**< Non-maskable interrupt reset */
} boot_reset_type_t;
/** @brief TV type enumeration */
typedef enum {
BOOT_TV_TYPE_PAL = 0,
BOOT_TV_TYPE_NTSC = 1,
BOOT_TV_TYPE_MPAL = 2,
BOOT_TV_TYPE_PASSTHROUGH = 3,
BOOT_TV_TYPE_PAL = 0, /**< PAL TV type */
BOOT_TV_TYPE_NTSC = 1, /**< NTSC TV type */
BOOT_TV_TYPE_MPAL = 2, /**< MPAL TV type */
BOOT_TV_TYPE_PASSTHROUGH = 3, /**< Passthrough TV type */
} boot_tv_type_t;
/** @brief Boot Parameters Structure */
typedef struct {
boot_device_type_t device_type;
boot_tv_type_t tv_type;
uint8_t cic_seed;
bool detect_cic_seed;
uint32_t *cheat_list;
boot_device_type_t device_type; /**< Type of boot device */
boot_tv_type_t tv_type; /**< TV type */
uint8_t cic_seed; /**< CIC seed */
bool detect_cic_seed; /**< Flag to detect CIC seed */
uint32_t *cheat_list; /**< Pointer to the cheat list */
} boot_params_t;
/**
* @brief Boot the system with the specified parameters.
*
* @param params Pointer to the boot parameters structure.
*/
void boot (boot_params_t *params);
#endif
#endif /* BOOT_H__ */

159
src/flashcart/64drive/64drive_ll.h
View File

@ -7,11 +7,9 @@
#ifndef FLASHCART_64DRIVE_LL_H__
#define FLASHCART_64DRIVE_LL_H__
#include <stdbool.h>
#include <stdint.h>
/**
* @addtogroup 64drive
* @{
@ -19,40 +17,40 @@
/** @brief Registers Structure. */
typedef struct {
uint8_t BUFFER[512];
uint32_t STATUS;
uint32_t __unused_1;
uint32_t COMMAND;
uint32_t __unused_2;
uint32_t LBA;
uint32_t __unused_3;
uint32_t LENGTH;
uint32_t __unused_4;
uint32_t RESULT;
uint8_t BUFFER[512]; /**< General buffer */
uint32_t STATUS; /**< Status register */
uint32_t __unused_1; /**< Unused */
uint32_t COMMAND; /**< Command register */
uint32_t __unused_2; /**< Unused */
uint32_t LBA; /**< Logical Block Address register */
uint32_t __unused_3; /**< Unused */
uint32_t LENGTH; /**< Length register */
uint32_t __unused_4; /**< Unused */
uint32_t RESULT; /**< Result register */
uint32_t __unused_5[49];
uint32_t __unused_5[49]; /**< Unused */
uint32_t SDRAM_SIZE;
uint32_t MAGIC;
uint32_t VARIANT;
uint32_t PERSISTENT;
uint32_t BUTTON_UPGRADE;
uint32_t REVISION;
uint32_t SDRAM_SIZE; /**< SDRAM size register */
uint32_t MAGIC; /**< Magic register */
uint32_t VARIANT; /**< Variant register */
uint32_t PERSISTENT; /**< Persistent register */
uint32_t BUTTON_UPGRADE; /**< Button upgrade register */
uint32_t REVISION; /**< Revision register */
uint32_t __unused_6[64];
uint32_t __unused_6[64]; /**< Unused */
uint32_t USB_COMMAND_STATUS;
uint32_t USB_PARAM_RESULT[2];
uint32_t USB_COMMAND_STATUS; /**< USB command status register */
uint32_t USB_PARAM_RESULT[2]; /**< USB parameter result registers */
uint32_t __unused_7[5];
uint32_t __unused_7[5]; /**< Unused */
uint32_t WIFI_COMMAND_STATUS;
uint32_t WIFI_PARAM_RESULT[2];
uint32_t WIFI_COMMAND_STATUS; /**< WiFi command status register */
uint32_t WIFI_PARAM_RESULT[2]; /**< WiFi parameter result registers */
uint32_t __unused_8[757];
uint32_t __unused_8[757]; /**< Unused */
uint8_t EEPROM[2048];
uint32_t WRITEBACK[256];
uint8_t EEPROM[2048]; /**< EEPROM buffer */
uint32_t WRITEBACK[256]; /**< Writeback buffer */
} d64_regs_t;
/** @brief Registers Base Address. */
@ -63,41 +61,98 @@ typedef struct {
/** @brief Device Variant Enumeration. */
typedef enum {
DEVICE_VARIANT_UNKNOWN = 0x0000,
DEVICE_VARIANT_A = 0x4100,
DEVICE_VARIANT_B = 0x4200,
DEVICE_VARIANT_UNKNOWN = 0x0000, /**< Unknown device variant */
DEVICE_VARIANT_A = 0x4100, /**< Device variant A */
DEVICE_VARIANT_B = 0x4200, /**< Device variant B */
} d64_device_variant_t;
/** @brief TV Type Enumeration. */
typedef enum {
TV_TYPE_PAL = 0,
TV_TYPE_NTSC = 1,
TV_TYPE_MPAL = 2,
TV_TYPE_UNKNOWN = 3,
TV_TYPE_PAL = 0, /**< PAL TV type */
TV_TYPE_NTSC = 1, /**< NTSC TV type */
TV_TYPE_MPAL = 2, /**< MPAL TV type */
TV_TYPE_UNKNOWN = 3, /**< Unknown TV type */
} d64_tv_type_t;
/** @brief Save Type Enumeration. */
typedef enum {
SAVE_TYPE_NONE,
SAVE_TYPE_EEPROM_4KBIT,
SAVE_TYPE_EEPROM_16KBIT,
SAVE_TYPE_SRAM_256KBIT,
SAVE_TYPE_FLASHRAM_1MBIT,
SAVE_TYPE_SRAM_BANKED,
SAVE_TYPE_FLASHRAM_PKST2,
SAVE_TYPE_NONE, /**< No save type */
SAVE_TYPE_EEPROM_4KBIT, /**< EEPROM 4Kbit */
SAVE_TYPE_EEPROM_16KBIT, /**< EEPROM 16Kbit */
SAVE_TYPE_SRAM_256KBIT, /**< SRAM 256Kbit */
SAVE_TYPE_FLASHRAM_1MBIT, /**< FlashRAM 1Mbit */
SAVE_TYPE_SRAM_BANKED, /**< SRAM Banked */
SAVE_TYPE_FLASHRAM_PKST2, /**< FlashRAM PKST2 */
} d64_save_type_t;
/**
* @brief Get the 64drive version.
*
* @param device_variant Pointer to store the device variant.
* @param fpga_revision Pointer to store the FPGA revision.
* @param bootloader_version Pointer to store the bootloader version.
* @return true if successful, false otherwise.
*/
bool d64_ll_get_version(d64_device_variant_t *device_variant, uint16_t *fpga_revision, uint32_t *bootloader_version);
bool d64_ll_get_version (d64_device_variant_t *device_variant, uint16_t *fpga_revision, uint32_t *bootloader_version);
bool d64_ll_set_persistent_variable_storage (bool quick_reboot, d64_tv_type_t force_tv_type, uint8_t cic_seed);
bool d64_ll_set_save_type (d64_save_type_t save_type);
bool d64_ll_enable_save_writeback (bool enabled);
bool d64_ll_enable_cartrom_writes (bool enabled);
bool d64_ll_enable_extended_mode (bool enabled);
bool d64_ll_write_eeprom_contents (void *contents);
bool d64_ll_write_save_writeback_lba_list (void *list);
/**
* @brief Set the persistent variable storage.
*
* @param quick_reboot Enable or disable quick reboot.
* @param force_tv_type TV type to force.
* @param cic_seed CIC seed value.
* @return true if successful, false otherwise.
*/
bool d64_ll_set_persistent_variable_storage(bool quick_reboot, d64_tv_type_t force_tv_type, uint8_t cic_seed);
/**
* @brief Set the save type.
*
* @param save_type The save type to set.
* @return true if successful, false otherwise.
*/
bool d64_ll_set_save_type(d64_save_type_t save_type);
/**
* @brief Enable or disable save writeback.
*
* @param enabled True to enable, false to disable.
* @return true if successful, false otherwise.
*/
bool d64_ll_enable_save_writeback(bool enabled);
/**
* @brief Enable or disable cart ROM writes.
*
* @param enabled True to enable, false to disable.
* @return true if successful, false otherwise.
*/
bool d64_ll_enable_cartrom_writes(bool enabled);
/**
* @brief Enable or disable extended mode.
*
* @param enabled True to enable, false to disable.
* @return true if successful, false otherwise.
*/
bool d64_ll_enable_extended_mode(bool enabled);
/**
* @brief Write EEPROM contents.
*
* @param contents Pointer to the EEPROM contents.
* @return true if successful, false otherwise.
*/
bool d64_ll_write_eeprom_contents(void *contents);
/**
* @brief Write save writeback LBA list.
*
* @param list Pointer to the LBA list.
* @return true if successful, false otherwise.
*/
bool d64_ll_write_save_writeback_lba_list(void *list);
/** @} */ /* 64drive */
#endif
#endif /* FLASHCART_64DRIVE_LL_H__ */

147
src/flashcart/flashcart.h
View File

@ -7,64 +7,63 @@
#ifndef FLASHCART_H__
#define FLASHCART_H__
#include <stdbool.h>
#include <stdint.h>
/** @brief Flashcart error enumeration */
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_OK, /**< No error */
FLASHCART_ERR_OUTDATED, /**< Outdated firmware error */
FLASHCART_ERR_SD_CARD, /**< SD card error */
FLASHCART_ERR_BBFS, /**< BBFS error */
FLASHCART_ERR_ARGS, /**< Argument error */
FLASHCART_ERR_LOAD, /**< Load error */
FLASHCART_ERR_INT, /**< Internal error */
FLASHCART_ERR_FUNCTION_NOT_SUPPORTED, /**< Function not supported error */
} flashcart_err_t;
/** @brief List of optional supported flashcart features */
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_FEATURE_ROM_REBOOT_FAST
FLASHCART_FEATURE_64DD, /**< 64DD support */
FLASHCART_FEATURE_RTC, /**< Real-time clock support */
FLASHCART_FEATURE_USB, /**< USB support */
FLASHCART_FEATURE_AUTO_CIC, /**< Automatic CIC detection */
FLASHCART_FEATURE_AUTO_REGION, /**< Automatic region detection */
FLASHCART_FEATURE_DIAGNOSTIC_DATA, /**< Diagnostic data support */
FLASHCART_FEATURE_BIOS_UPDATE_FROM_MENU, /**< BIOS update from menu support */
FLASHCART_FEATURE_SAVE_WRITEBACK, /**< Save writeback support */
FLASHCART_FEATURE_ROM_REBOOT_FAST /**< Fast ROM reboot support */
} flashcart_features_t;
/** @brief Flashcart save type enumeration */
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_NONE, /**< No save type */
FLASHCART_SAVE_TYPE_EEPROM_4KBIT, /**< EEPROM 4Kbit */
FLASHCART_SAVE_TYPE_EEPROM_16KBIT, /**< EEPROM 16Kbit */
FLASHCART_SAVE_TYPE_SRAM_256KBIT, /**< SRAM 256Kbit */
FLASHCART_SAVE_TYPE_SRAM_BANKED, /**< SRAM Banked */
FLASHCART_SAVE_TYPE_SRAM_1MBIT, /**< SRAM 1Mbit */
FLASHCART_SAVE_TYPE_FLASHRAM_1MBIT, /**< FlashRAM 1Mbit */
FLASHCART_SAVE_TYPE_FLASHRAM_PKST2, /**< FlashRAM PKST2 */
__FLASHCART_SAVE_TYPE_END /**< End of save types */
} flashcart_save_type_t;
/** @brief Flashcart Disk Parameter Structure. */
typedef struct {
bool development_drive;
uint8_t disk_type;
bool bad_system_area_lbas[24];
uint8_t defect_tracks[16][12];
bool development_drive; /**< Development drive flag */
uint8_t disk_type; /**< Disk type */
bool bad_system_area_lbas[24]; /**< Bad system area LBAs */
uint8_t defect_tracks[16][12]; /**< Defect tracks */
} flashcart_disk_parameters_t;
/** @brief Flashcart Firmware version Structure. */
typedef struct {
uint16_t major;
uint16_t minor;
uint32_t revision;
uint16_t major; /**< Major version */
uint16_t minor; /**< Minor version */
uint32_t revision; /**< Revision */
} flashcart_firmware_version_t;
/** @brief Flashcart progress callback type */
typedef void flashcart_progress_callback_t (float progress);
/** @brief Flashcart Structure */
@ -93,17 +92,89 @@ typedef struct {
flashcart_err_t (*set_save_writeback) (char *save_path);
} flashcart_t;
/**
* @brief Convert a flashcart error code to a human-readable error message.
*
* @param err The flashcart error code.
* @return char* The human-readable error message.
*/
char *flashcart_convert_error_message (flashcart_err_t err);
/**
* @brief Initialize the flashcart.
*
* @param storage_prefix Pointer to the storage prefix.
* @return flashcart_err_t Error code.
*/
flashcart_err_t flashcart_init (const char **storage_prefix);
/**
* @brief Deinitialize the flashcart.
*
* @return flashcart_err_t Error code.
*/
flashcart_err_t flashcart_deinit (void);
/**
* @brief Check if the flashcart has a specific feature.
*
* @param feature The flashcart feature to check.
* @return bool True if the feature is supported, false otherwise.
*/
bool flashcart_has_feature (flashcart_features_t feature);
/**
* @brief Get the flashcart firmware version.
*
* @return flashcart_firmware_version_t The firmware version.
*/
flashcart_firmware_version_t flashcart_get_firmware_version (void);
/**
* @brief Load a ROM onto the flashcart.
*
* @param rom_path The path to the ROM file.
* @param byte_swap Whether to byte swap the ROM.
* @param progress Callback function for progress updates.
* @return flashcart_err_t Error code.
*/
flashcart_err_t flashcart_load_rom (char *rom_path, bool byte_swap, flashcart_progress_callback_t *progress);
/**
* @brief Load a file onto the flashcart.
*
* @param file_path The path to the file.
* @param rom_offset The ROM offset.
* @param file_offset The file offset.
* @return flashcart_err_t Error code.
*/
flashcart_err_t flashcart_load_file (char *file_path, uint32_t rom_offset, uint32_t file_offset);
/**
* @brief Load a save file onto the flashcart.
*
* @param save_path The path to the save file.
* @param save_type The type of save.
* @return flashcart_err_t Error code.
*/
flashcart_err_t flashcart_load_save (char *save_path, flashcart_save_type_t save_type);
/**
* @brief Load the 64DD IPL (BIOS) onto the flashcart.
*
* @param ipl_path The path to the IPL file.
* @param progress Callback function for progress updates.
* @return flashcart_err_t Error code.
*/
flashcart_err_t flashcart_load_64dd_ipl (char *ipl_path, flashcart_progress_callback_t *progress);
/**
* @brief Load a 64DD disk onto the flashcart.
*
* @param disk_path The path to the disk file.
* @param disk_parameters Pointer to the disk parameters structure.
* @return flashcart_err_t Error code.
*/
flashcart_err_t flashcart_load_64dd_disk (char *disk_path, flashcart_disk_parameters_t *disk_parameters);
#endif
#endif /* FLASHCART_H__ */

221
src/flashcart/sc64/sc64_ll.h
View File

@ -7,11 +7,9 @@
#ifndef FLASHCART_SC64_LL_H__
#define FLASHCART_SC64_LL_H__
#include <stddef.h>
#include <stdint.h>
/**
* @addtogroup sc64
* @{
@ -19,10 +17,10 @@
/** @brief The SC64 buffers structure. */
typedef struct {
uint8_t BUFFER[8192];
uint8_t EEPROM[2048];
uint8_t DD_SECTOR[256];
uint8_t FLASHRAM[128];
uint8_t BUFFER[8192]; /**< General buffer */
uint8_t EEPROM[2048]; /**< EEPROM buffer */
uint8_t DD_SECTOR[256]; /**< Disk Drive sector buffer */
uint8_t FLASHRAM[128]; /**< FlashRAM buffer */
} sc64_buffers_t;
#define SC64_BUFFERS_BASE (0x1FFE0000UL)
@ -30,110 +28,185 @@ typedef struct {
/** @brief The SC64 State Enumeration. */
typedef enum {
SC64_OK,
SC64_ERROR_BAD_ARGUMENT,
SC64_ERROR_BAD_ADDRESS,
SC64_ERROR_BAD_CONFIG_ID,
SC64_ERROR_TIMEOUT,
SC64_ERROR_SD_CARD,
SC64_ERROR_UNKNOWN_CMD = -1
SC64_OK, /**< No error */
SC64_ERROR_BAD_ARGUMENT, /**< Bad argument error */
SC64_ERROR_BAD_ADDRESS, /**< Bad address error */
SC64_ERROR_BAD_CONFIG_ID, /**< Bad config ID error */
SC64_ERROR_TIMEOUT, /**< Timeout error */
SC64_ERROR_SD_CARD, /**< SD card error */
SC64_ERROR_UNKNOWN_CMD = -1 /**< Unknown command error */
} sc64_error_t;
/** @brief The SC64 Configuration ID Enumeration. */
typedef enum {
CFG_ID_BOOTLOADER_SWITCH,
CFG_ID_ROM_WRITE_ENABLE,
CFG_ID_ROM_SHADOW_ENABLE,
CFG_ID_DD_MODE,
CFG_ID_ISV_ADDRESS,
CFG_ID_BOOT_MODE,
CFG_ID_SAVE_TYPE,
CFG_ID_CIC_SEED,
CFG_ID_TV_TYPE,
CFG_ID_DD_SD_ENABLE,
CFG_ID_DD_DRIVE_TYPE,
CFG_ID_DD_DISK_STATE,
CFG_ID_BUTTON_STATE,
CFG_ID_BUTTON_MODE,
CFG_ID_ROM_EXTENDED_ENABLE,
CFG_ID_BOOTLOADER_SWITCH, /**< Bootloader switch config */
CFG_ID_ROM_WRITE_ENABLE, /**< ROM write enable config */
CFG_ID_ROM_SHADOW_ENABLE, /**< ROM shadow enable config */
CFG_ID_DD_MODE, /**< Disk Drive mode config */
CFG_ID_ISV_ADDRESS, /**< ISV address config */
CFG_ID_BOOT_MODE, /**< Boot mode config */
CFG_ID_SAVE_TYPE, /**< Save type config */
CFG_ID_CIC_SEED, /**< CIC seed config */
CFG_ID_TV_TYPE, /**< TV type config */
CFG_ID_DD_SD_ENABLE, /**< Disk Drive SD enable config */
CFG_ID_DD_DRIVE_TYPE, /**< Disk Drive type config */
CFG_ID_DD_DISK_STATE, /**< Disk Drive disk state config */
CFG_ID_BUTTON_STATE, /**< Button state config */
CFG_ID_BUTTON_MODE, /**< Button mode config */
CFG_ID_ROM_EXTENDED_ENABLE /**< ROM extended enable config */
} sc64_cfg_id_t;
/** @brief The SC64 Disk Drive Mode Enumeration. */
typedef enum {
DD_MODE_DISABLED = 0,
DD_MODE_REGS = 1,
DD_MODE_IPL = 2,
DD_MODE_FULL = 3
DD_MODE_DISABLED = 0, /**< Disk Drive disabled */
DD_MODE_REGS = 1, /**< Disk Drive registers mode */
DD_MODE_IPL = 2, /**< Disk Drive IPL mode */
DD_MODE_FULL = 3 /**< Disk Drive full mode */
} sc64_dd_mode_t;
/** @brief The SC64 Boot Mode Enumeration. */
typedef enum {
BOOT_MODE_MENU = 0,
BOOT_MODE_ROM = 1,
BOOT_MODE_DDIPL = 2,
BOOT_MODE_DIRECT_ROM = 3,
BOOT_MODE_DIRECT_DDIPL = 4,
BOOT_MODE_MENU = 0, /**< Boot to menu */
BOOT_MODE_ROM = 1, /**< Boot to ROM */
BOOT_MODE_DDIPL = 2, /**< Boot to Disk Drive IPL */
BOOT_MODE_DIRECT_ROM = 3, /**< Direct boot to ROM */
BOOT_MODE_DIRECT_DDIPL = 4 /**< Direct boot to Disk Drive IPL */
} sc64_boot_mode_t;
/** @brief The SC64 Save Type Enumeration. */
typedef enum {
SAVE_TYPE_NONE,
SAVE_TYPE_EEPROM_4KBIT,
SAVE_TYPE_EEPROM_16KBIT,
SAVE_TYPE_SRAM_256KBIT,
SAVE_TYPE_FLASHRAM_1MBIT,
SAVE_TYPE_SRAM_BANKED,
SAVE_TYPE_SRAM_1MBIT,
SAVE_TYPE_NONE, /**< No save type */
SAVE_TYPE_EEPROM_4KBIT, /**< EEPROM 4Kbit */
SAVE_TYPE_EEPROM_16KBIT, /**< EEPROM 16Kbit */
SAVE_TYPE_SRAM_256KBIT, /**< SRAM 256Kbit */
SAVE_TYPE_FLASHRAM_1MBIT, /**< FlashRAM 1Mbit */
SAVE_TYPE_SRAM_BANKED, /**< SRAM Banked */
SAVE_TYPE_SRAM_1MBIT /**< SRAM 1Mbit */
} sc64_save_type_t;
/** @brief The SC64 CIC Seed Enumeration. */
typedef enum {
CIC_SEED_AUTO = 0xFFFF
CIC_SEED_AUTO = 0xFFFF /**< Automatic CIC seed */
} sc64_cic_seed_t;
/** @brief The SC64 TV Type Enumeration. */
typedef enum {
TV_TYPE_PAL = 0,
TV_TYPE_NTSC = 1,
TV_TYPE_MPAL = 2,
TV_TYPE_PASSTHROUGH = 3
TV_TYPE_PAL = 0, /**< PAL TV type */
TV_TYPE_NTSC = 1, /**< NTSC TV type */
TV_TYPE_MPAL = 2, /**< MPAL TV type */
TV_TYPE_PASSTHROUGH = 3 /**< Passthrough TV type */
} sc64_tv_type_t;
/** @brief The SC64 Drive Type Enumeration. */
typedef enum {
DRIVE_TYPE_RETAIL,
DRIVE_TYPE_DEVELOPMENT,
DRIVE_TYPE_RETAIL, /**< Retail drive type */
DRIVE_TYPE_DEVELOPMENT /**< Development drive type */
} sc64_drive_type_t;
/** @brief The SC64 Disk State Enumeration. */
typedef enum {
DISK_STATE_EJECTED,
DISK_STATE_INSERTED,
DISK_STATE_CHANGED,
DISK_STATE_EJECTED, /**< Disk ejected */
DISK_STATE_INSERTED, /**< Disk inserted */
DISK_STATE_CHANGED /**< Disk state changed */
} sc64_disk_state_t;
/** @brief The SC64 Button Mode Enumeration. */
typedef enum {
BUTTON_MODE_NONE,
BUTTON_MODE_N64_IRQ,
BUTTON_MODE_USB_PACKET,
BUTTON_MODE_DD_DISK_SWAP,
BUTTON_MODE_NONE, /**< No button mode */
BUTTON_MODE_N64_IRQ, /**< N64 IRQ button mode */
BUTTON_MODE_USB_PACKET, /**< USB packet button mode */
BUTTON_MODE_DD_DISK_SWAP /**< Disk Drive disk swap button mode */
} sc64_button_mode_t;
/** @brief The SC64 Disk Mapping Structure. */
typedef struct {
int count;
int count; /**< Number of disks */
struct {
uint32_t thb_table;
uint32_t sector_table;
} disks[4];
uint32_t thb_table; /**< THB table */
uint32_t sector_table; /**< Sector table */
} disks[4]; /**< Array of disks */
} sc64_disk_mapping_t;
/**
* @brief Lock the SC64.
*/
void sc64_ll_lock(void);
void sc64_ll_lock (void);
sc64_error_t sc64_ll_get_version (uint16_t *major, uint16_t *minor, uint32_t *revision);
sc64_error_t sc64_ll_get_config (sc64_cfg_id_t cfg, uint32_t *value);
sc64_error_t sc64_ll_set_config (sc64_cfg_id_t cfg, uint32_t value);
sc64_error_t sc64_ll_set_disk_mapping (sc64_disk_mapping_t *disk_mapping);
sc64_error_t sc64_ll_writeback_pending (bool *pending);
sc64_error_t sc64_ll_writeback_enable (void *address);
sc64_error_t sc64_ll_flash_wait_busy (void);
sc64_error_t sc64_ll_flash_get_erase_block_size (size_t *erase_block_size);
sc64_error_t sc64_ll_flash_erase_block (void *address);
/**
* @brief Get the SC64 version.
*
* @param major Pointer to store the major version.
* @param minor Pointer to store the minor version.
* @param revision Pointer to store the revision.
* @return sc64_error_t Error code.
*/
sc64_error_t sc64_ll_get_version(uint16_t *major, uint16_t *minor, uint32_t *revision);
/**
* @brief Get the SC64 configuration.
*
* @param cfg Configuration ID.
* @param value Pointer to store the configuration value.
* @return sc64_error_t Error code.
*/
sc64_error_t sc64_ll_get_config(sc64_cfg_id_t cfg, uint32_t *value);
/**
* @brief Set the SC64 configuration.
*
* @param cfg Configuration ID.
* @param value Configuration value.
* @return sc64_error_t Error code.
*/
sc64_error_t sc64_ll_set_config(sc64_cfg_id_t cfg, uint32_t value);
/**
* @brief Set the SC64 disk mapping.
*
* @param disk_mapping Pointer to the disk mapping structure.
* @return sc64_error_t Error code.
*/
sc64_error_t sc64_ll_set_disk_mapping(sc64_disk_mapping_t *disk_mapping);
/**
* @brief Check if writeback is pending.
*
* @param pending Pointer to store the pending status.
* @return sc64_error_t Error code.
*/
sc64_error_t sc64_ll_writeback_pending(bool *pending);
/**
* @brief Enable writeback.
*
* @param address Address to enable writeback.
* @return sc64_error_t Error code.
*/
sc64_error_t sc64_ll_writeback_enable(void *address);
/**
* @brief Wait for flash to be not busy.
*
* @return sc64_error_t Error code.
*/
sc64_error_t sc64_ll_flash_wait_busy(void);
/**
* @brief Get the flash erase block size.
*
* @param erase_block_size Pointer to store the erase block size.
* @return sc64_error_t Error code.
*/
sc64_error_t sc64_ll_flash_get_erase_block_size(size_t *erase_block_size);
/**
* @brief Erase a flash block.
*
* @param address Address of the block to erase.
* @return sc64_error_t Error code.
*/
sc64_error_t sc64_ll_flash_erase_block(void *address);
/** @} */ /* sc64 */
#endif
#endif // FLASHCART_SC64_LL_H__

61
src/menu/bookkeeping.h
View File

@ -1,6 +1,6 @@
/**
* @file bookkeeping.h
* @brief Bookkeeping of loadded ROM's.
* @brief Bookkeeping of loaded ROMs.
* @ingroup menu
*/
@ -9,40 +9,49 @@
#include "path.h"
#define FAVORITES_COUNT 8 /**< Maximum number of favorite items */
#define HISTORY_COUNT 8 /**< Maximum number of history items */
#define FAVORITES_COUNT 8
#define HISTORY_COUNT 8
/** @brief Bookkeeping item types enumeration */
typedef enum {
BOOKKEEPING_TYPE_EMPTY,
BOOKKEEPING_TYPE_ROM,
BOOKKEEPING_TYPE_DISK,
BOOKKEEPING_TYPE_EMPTY, /**< Empty item */
BOOKKEEPING_TYPE_ROM, /**< ROM item */
BOOKKEEPING_TYPE_DISK, /**< Disk item */
} bookkeeping_item_types_t;
/** @brief Bookkeeping item structure */
typedef struct {
path_t *primary_path;
path_t *secondary_path;
bookkeeping_item_types_t bookkeeping_type;
path_t *primary_path; /**< Primary path */
path_t *secondary_path; /**< Secondary path */
bookkeeping_item_types_t bookkeeping_type; /**< Bookkeeping item type */
} bookkeeping_item_t;
/** @brief ROM bookkeeping Structure */
/** @brief ROM bookkeeping structure */
typedef struct {
bookkeeping_item_t history_items[HISTORY_COUNT];
bookkeeping_item_t favorite_items[HISTORY_COUNT];
bookkeeping_item_t history_items[HISTORY_COUNT]; /**< History items */
bookkeeping_item_t favorite_items[FAVORITES_COUNT]; /**< Favorite items */
} bookkeeping_t;
/**
* @brief Initialize ROM bookkeeping path.
*
* @param path The path to initialize.
*/
void bookkeeping_init(char *path);
/** @brief Init ROM bookkeeping path */
void bookkeeping_init (char *path);
/**
* @brief Load ROM bookkeeping.
*
* @param history Pointer to the bookkeeping structure to load.
*/
void bookkeeping_load(bookkeeping_t *history);
/** @brief The ROM bookkeeping to load */
void bookkeeping_load (bookkeeping_t *history);
/** @brief The ROM bookkeeping to save */
void bookkeeping_save (bookkeeping_t *history);
/**
* @brief Save ROM bookkeeping.
*
* @param history Pointer to the bookkeeping structure to save.
*/
void bookkeeping_save(bookkeeping_t *history);
/**
* @brief Add a ROM to the history.
@ -52,7 +61,7 @@ void bookkeeping_save (bookkeeping_t *history);
* @param secondary_path The secondary path of the ROM.
* @param type The type of the bookkeeping item.
*/
void bookkeeping_history_add(bookkeeping_t *bookkeeping, path_t *primary_path, path_t *secondary_path, bookkeeping_item_types_t type );
void bookkeeping_history_add(bookkeeping_t *bookkeeping, path_t *primary_path, path_t *secondary_path, bookkeeping_item_types_t type);
/**
* @brief Add a ROM to the favorites.
@ -62,7 +71,7 @@ void bookkeeping_history_add(bookkeeping_t *bookkeeping, path_t *primary_path, p
* @param secondary_path The secondary path of the ROM.
* @param type The type of the bookkeeping item.
*/
void bookkeeping_favorite_add(bookkeeping_t *bookkeeping, path_t *primary_path, path_t *secondary_path, bookkeeping_item_types_t type );
void bookkeeping_favorite_add(bookkeeping_t *bookkeeping, path_t *primary_path, path_t *secondary_path, bookkeeping_item_types_t type);
/**
* @brief Remove a ROM from the favorites.
@ -72,4 +81,4 @@ void bookkeeping_favorite_add(bookkeeping_t *bookkeeping, path_t *primary_path,
*/
void bookkeeping_favorite_remove(bookkeeping_t *bookkeeping, int selection);
#endif
#endif /* BOOKKEEPING_H__ */

41
src/menu/cart_load.h
View File

@ -7,7 +7,6 @@
#ifndef CART_LOAD_H__
#define CART_LOAD_H__
#include "disk_info.h"
#include "flashcart/flashcart.h"
#include "menu_state.h"
@ -33,6 +32,7 @@ typedef enum {
CART_LOAD_ERR_EMU_NOT_FOUND,
/** @brief Failed to load the emulator required. */
CART_LOAD_ERR_EMU_LOAD_FAIL,
/** @brief Failed to load the emulator ROM. */
CART_LOAD_ERR_EMU_ROM_LOAD_FAIL,
/** @brief Failed to create the save sub-directory. */
CART_LOAD_ERR_CREATE_SAVES_SUBDIR_FAIL,
@ -58,11 +58,40 @@ typedef enum {
CART_LOAD_EMU_TYPE_FAIRCHILD_CHANNELF,
} cart_load_emu_type_t;
/**
* @brief Convert a cart load error code to a human-readable error message.
*
* @param err The cart load error code.
* @return char* The human-readable error message.
*/
char *cart_load_convert_error_message(cart_load_err_t err);
char *cart_load_convert_error_message (cart_load_err_t err);
cart_load_err_t cart_load_n64_rom_and_save (menu_t *menu, flashcart_progress_callback_t progress);
cart_load_err_t cart_load_64dd_ipl_and_disk (menu_t *menu, flashcart_progress_callback_t progress);
cart_load_err_t cart_load_emulator (menu_t *menu, cart_load_emu_type_t emu_type, flashcart_progress_callback_t progress);
/**
* @brief Load an N64 ROM and its save data.
*
* @param menu Pointer to the menu structure.
* @param progress Callback function for progress updates.
* @return cart_load_err_t Error code.
*/
cart_load_err_t cart_load_n64_rom_and_save(menu_t *menu, flashcart_progress_callback_t progress);
/**
* @brief Load the 64DD IPL (BIOS) and disk.
*
* @param menu Pointer to the menu structure.
* @param progress Callback function for progress updates.
* @return cart_load_err_t Error code.
*/
cart_load_err_t cart_load_64dd_ipl_and_disk(menu_t *menu, flashcart_progress_callback_t progress);
#endif
/**
* @brief Load an emulator and its ROM.
*
* @param menu Pointer to the menu structure.
* @param emu_type The type of emulator to load.
* @param progress Callback function for progress updates.
* @return cart_load_err_t Error code.
*/
cart_load_err_t cart_load_emulator(menu_t *menu, cart_load_emu_type_t emu_type, flashcart_progress_callback_t progress);
#endif /* CART_LOAD_H__ */

350
src/menu/rom_info.h
View File

@ -8,243 +8,237 @@
#ifndef ROM_INFO_H__
#define ROM_INFO_H__
#include <stdbool.h>
#include <stdint.h>
#include "path.h"
/** @brief ROM error enumeration. */
typedef enum {
ROM_OK,
ROM_ERR_LOAD_IO,
ROM_ERR_SAVE_IO,
ROM_ERR_NO_FILE,
ROM_OK, /**< No error */
ROM_ERR_LOAD_IO, /**< Load I/O error */
ROM_ERR_SAVE_IO, /**< Save I/O error */
ROM_ERR_NO_FILE, /**< No file error */
} rom_err_t;
/** @brief ROM endian enumeration. */
typedef enum {
/** @brief Is Big Endian. */
ENDIANNESS_BIG,
/** @brief Is Little Endian. */
ENDIANNESS_LITTLE,
/** @brief Is Byte Swapped Endian. */
ENDIANNESS_BYTE_SWAP,
ENDIANNESS_BIG, /**< Big Endian */
ENDIANNESS_LITTLE, /**< Little Endian */
ENDIANNESS_BYTE_SWAP, /**< Byte Swapped Endian */
} rom_endianness_t;
/** @brief ROM media type enumeration. */
typedef enum {
/** @brief Is a stand alone Cartridge program. */
N64_CART = 'N',
/** @brief Is a stand alone Disk Drive program. */
N64_DISK = 'D',
/** @brief Is a Cartridge program that could use an extra Disk Drive program to expand its capabilities. */
N64_CART_EXPANDABLE = 'C',
/** @brief Is a Disk Drive program that could use an extra Cartridge program to expand its capabilities. */
N64_DISK_EXPANDABLE = 'E',
/** @brief Is an Aleck64 program. */
N64_ALECK64 = 'Z'
N64_CART = 'N', /**< Stand alone Cartridge program */
N64_DISK = 'D', /**< Stand alone Disk Drive program */
N64_CART_EXPANDABLE = 'C', /**< Cartridge program that could use an extra Disk Drive program */
N64_DISK_EXPANDABLE = 'E', /**< Disk Drive program that could use an extra Cartridge program */
N64_ALECK64 = 'Z' /**< Aleck64 program */
} rom_category_type_t;
/** @brief ROM market region & language type enumeration. */
typedef enum {
/** @brief The ROM is designed for Japanese and "English" languages. */
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!.
/** @brief The ROM is designed for Brazil (Portuguese) language. */
MARKET_BRAZILIAN = 'B',
/** @brief The ROM is designed for Chinese language. */
MARKET_CHINESE = 'C',
/** @brief The ROM is designed for German language. */
MARKET_GERMAN = 'D',
/** @brief The ROM is designed for North American "English" language. */
MARKET_NORTH_AMERICA = 'E',
/** @brief The ROM is designed for French language. */
MARKET_FRENCH = 'F',
/** @brief The ROM is designed for a NTSC Gateway 64. */
MARKET_GATEWAY64_NTSC = 'G',
/** @brief The ROM is designed for Dutch language. */
MARKET_DUTCH = 'H',
/** @brief The ROM is designed for Italian language. */
MARKET_ITALIAN = 'I',
/** @brief The ROM is designed for Japanese language. */
MARKET_JAPANESE = 'J',
/** @brief The ROM is designed for Korean language. */
MARKET_KOREAN = 'K',
/** @brief The ROM is designed for a PAL Gateway 64. */
MARKET_GATEWAY64_PAL = 'L',
/** @brief The ROM is designed for Canada region (English and French) language. */
MARKET_CANADIAN = 'N',
/** @brief The ROM is designed for European market and languages (must at minimum include English). */
MARKET_EUROPEAN_BASIC = 'P', // Sometimes used for Australian region ROMs as well.
/** @brief The ROM is designed for Spanish language */
MARKET_SPANISH = 'S',
/** @brief The ROM is designed for Australia (English) language. */
MARKET_AUSTRALIAN = 'U',
/** @brief The ROM is designed for Scandinavian (Swedish, Norwegian, Finnish, etc.) languages. */
MARKET_SCANDINAVIAN = 'W',
/** @brief The ROM is designed for an undefined region and TBD language(s). */
MARKET_OTHER_X = 'X', // many EU ROM's, Top Gear Rally (Asia) and HSV Racing (AUS) ROM uses this.
/** @brief The ROM is designed for a European region and language(s). */
MARKET_OTHER_Y = 'Y', // many EU ROM's uses this.
/** @brief The ROM is designed for an undefined region and TBD language(s). */
MARKET_OTHER_Z = 'Z' // no known ROM's use this.
MARKET_JAPANESE_MULTI = 'A', /**< Japanese and "English" languages */
MARKET_BRAZILIAN = 'B', /**< Brazilian (Portuguese) language */
MARKET_CHINESE = 'C', /**< Chinese language */
MARKET_GERMAN = 'D', /**< German language */
MARKET_NORTH_AMERICA = 'E', /**< North American "English" language */
MARKET_FRENCH = 'F', /**< French language */
MARKET_GATEWAY64_NTSC = 'G', /**< NTSC Gateway 64 */
MARKET_DUTCH = 'H', /**< Dutch language */
MARKET_ITALIAN = 'I', /**< Italian language */
MARKET_JAPANESE = 'J', /**< Japanese language */
MARKET_KOREAN = 'K', /**< Korean language */
MARKET_GATEWAY64_PAL = 'L', /**< PAL Gateway 64 */
MARKET_CANADIAN = 'N', /**< Canada region (English and French) language */
MARKET_EUROPEAN_BASIC = 'P', /**< European market and languages (must include English) */
MARKET_SPANISH = 'S', /**< Spanish language */
MARKET_AUSTRALIAN = 'U', /**< Australian (English) language */
MARKET_SCANDINAVIAN = 'W', /**< Scandinavian (Swedish, Norwegian, Finnish, etc.) languages */
MARKET_OTHER_X = 'X', /**< Undefined region and TBD language(s) */
MARKET_OTHER_Y = 'Y', /**< European region and language(s) */
MARKET_OTHER_Z = 'Z' /**< Undefined region and TBD language(s) */
} rom_destination_type_t;
/** @brief ROM CIC type enumeration. */
typedef enum {
ROM_CIC_TYPE_UNKNOWN = 0, // No known CIC type detected
ROM_CIC_TYPE_5101 = 5101, // Aleck64 CIC-5101
ROM_CIC_TYPE_5167 = 5167, // 64DD ROM conversion CIC-5167
ROM_CIC_TYPE_6101 = 6101, // NTSC CIC-6101
ROM_CIC_TYPE_7102 = 7102, // PAL CIC-7102
ROM_CIC_TYPE_x102 = 6102, // NTSC CIC-6102 / PAL CIC-7101
ROM_CIC_TYPE_x103 = 6103, // NTSC CIC-6103 / PAL CIC-7103
ROM_CIC_TYPE_x105 = 6105, // NTSC CIC-6105 / PAL CIC-7105
ROM_CIC_TYPE_x106 = 6106, // NTSC CIC-6106 / PAL CIC-7106
ROM_CIC_TYPE_8301 = 8301, // NDDJ0 64DD IPL
ROM_CIC_TYPE_8302 = 8302, // NDDJ1 64DD IPL
ROM_CIC_TYPE_8303 = 8303, // NDDJ2 64DD IPL
ROM_CIC_TYPE_8401 = 8401, // NDXJ0 64DD IPL
ROM_CIC_TYPE_8501 = 8501, // NDDE0 64DD IPL
ROM_CIC_TYPE_AUTOMATIC = -1, // Guess CIC from IPL3
ROM_CIC_TYPE_UNKNOWN = 0, /**< No known CIC type detected */
ROM_CIC_TYPE_5101 = 5101, /**< Aleck64 CIC-5101 */
ROM_CIC_TYPE_5167 = 5167, /**< 64DD ROM conversion CIC-5167 */
ROM_CIC_TYPE_6101 = 6101, /**< NTSC CIC-6101 */
ROM_CIC_TYPE_7102 = 7102, /**< PAL CIC-7102 */
ROM_CIC_TYPE_x102 = 6102, /**< NTSC CIC-6102 / PAL CIC-7101 */
ROM_CIC_TYPE_x103 = 6103, /**< NTSC CIC-6103 / PAL CIC-7103 */
ROM_CIC_TYPE_x105 = 6105, /**< NTSC CIC-6105 / PAL CIC-7105 */
ROM_CIC_TYPE_x106 = 6106, /**< NTSC CIC-6106 / PAL CIC-7106 */
ROM_CIC_TYPE_8301 = 8301, /**< NDDJ0 64DD IPL */
ROM_CIC_TYPE_8302 = 8302, /**< NDDJ1 64DD IPL */
ROM_CIC_TYPE_8303 = 8303, /**< NDDJ2 64DD IPL */
ROM_CIC_TYPE_8401 = 8401, /**< NDXJ0 64DD IPL */
ROM_CIC_TYPE_8501 = 8501, /**< NDDE0 64DD IPL */
ROM_CIC_TYPE_AUTOMATIC = -1, /**< Guess CIC from IPL3 */
} rom_cic_type_t;
/** @brief ROM save type enumeration. */
typedef enum {
/** @brief There is no expected save type. */
SAVE_TYPE_NONE = 0,
SAVE_TYPE_EEPROM_4KBIT = 1,
SAVE_TYPE_EEPROM_16KBIT = 2,
SAVE_TYPE_SRAM_256KBIT = 3,
SAVE_TYPE_SRAM_BANKED = 4,
SAVE_TYPE_SRAM_1MBIT = 5,
SAVE_TYPE_FLASHRAM_1MBIT = 6,
SAVE_TYPE_FLASHRAM_PKST2 = 7,
SAVE_TYPE_AUTOMATIC = -1,
SAVE_TYPE_NONE = 0, /**< No expected save type */
SAVE_TYPE_EEPROM_4KBIT = 1, /**< EEPROM 4Kbit */
SAVE_TYPE_EEPROM_16KBIT = 2, /**< EEPROM 16Kbit */
SAVE_TYPE_SRAM_256KBIT = 3, /**< SRAM 256Kbit */
SAVE_TYPE_SRAM_BANKED = 4, /**< SRAM Banked */
SAVE_TYPE_SRAM_1MBIT = 5, /**< SRAM 1Mbit */
SAVE_TYPE_FLASHRAM_1MBIT = 6, /**< FlashRAM 1Mbit */
SAVE_TYPE_FLASHRAM_PKST2 = 7, /**< FlashRAM PKST2 */
SAVE_TYPE_AUTOMATIC = -1, /**< Automatic save type detection */
} rom_save_type_t;
/** @brief ROM TV type enumeration. */
typedef enum {
ROM_TV_TYPE_PAL = 0,
ROM_TV_TYPE_NTSC = 1,
ROM_TV_TYPE_MPAL = 2,
ROM_TV_TYPE_UNKNOWN = 3,
ROM_TV_TYPE_AUTOMATIC = -1,
ROM_TV_TYPE_PAL = 0, /**< PAL TV type */
ROM_TV_TYPE_NTSC = 1, /**< NTSC TV type */
ROM_TV_TYPE_MPAL = 2, /**< MPAL TV type */
ROM_TV_TYPE_UNKNOWN = 3, /**< Unknown TV type */
ROM_TV_TYPE_AUTOMATIC = -1, /**< Automatic TV type detection */
} rom_tv_type_t;
/** @brief ROM memory requirements enumeration. */
typedef enum {
/** @brief The ROM is happy with 4MB of memory. */
EXPANSION_PAK_NONE,
/** @brief The ROM requires 8MB of memory. */
EXPANSION_PAK_REQUIRED,
/** @brief The ROM recommends 8MB of memory. */
EXPANSION_PAK_RECOMMENDED,
/** @brief The ROM suggests 8MB of memory. */
EXPANSION_PAK_SUGGESTED,
/** @brief The ROM is faulty when using 8MB of memory. */
EXPANSION_PAK_FAULTY,
EXPANSION_PAK_NONE, /**< Happy with 4MB of memory */
EXPANSION_PAK_REQUIRED, /**< Requires 8MB of memory */
EXPANSION_PAK_RECOMMENDED, /**< Recommends 8MB of memory */
EXPANSION_PAK_SUGGESTED, /**< Suggests 8MB of memory */
EXPANSION_PAK_FAULTY, /**< Faulty with 8MB of memory */
} rom_expansion_pak_t;
/** @brief ROM Information Structure. */
typedef struct {
/** @brief The file endian. */
rom_endianness_t endianness;
/** @brief The clock rate defined in the ROM's header. */
float clock_rate;
/** @brief The boot address defined in the ROM's header. */
uint32_t boot_address;
rom_endianness_t endianness; /**< The file endian */
float clock_rate; /**< The clock rate defined in the ROM's header */
uint32_t boot_address; /**< The boot address defined in the ROM's header */
struct {
/** @brief The SDK version defined in the ROM's header. */
uint8_t version;
/** @brief The SDK revision defined in the ROM's header. */
char revision;
uint8_t version; /**< The SDK version defined in the ROM's header */
char revision; /**< The SDK revision defined in the ROM's header */
} libultra;
/** @brief The check code defined in the ROM's header. */
uint64_t check_code;
/** @brief The title defined in the ROM's header. */
char title[20];
uint64_t check_code; /**< The check code defined in the ROM's header */
char title[20]; /**< The title defined in the ROM's header */
union {
/** @brief The game code defined in the ROM's header. */
char game_code[4];
char game_code[4]; /**< The game code defined in the ROM's header */
struct {
/** @brief The game media type. */
rom_category_type_t category_code : 8;
/** @brief The game unique identifier. */
char unique_code[2];
/** @brief The game region and or market. */
rom_destination_type_t destination_code : 8;
rom_category_type_t category_code : 8; /**< The game media type */
char unique_code[2]; /**< The game unique identifier */
rom_destination_type_t destination_code : 8; /**< The game region and or market */
};
};
/** @brief The ROM version defined in the ROM's header. */
uint8_t version;
uint8_t version; /**< The ROM version defined in the ROM's header */
rom_cic_type_t cic_type; /**< The CIC type required by the ROM */
rom_save_type_t save_type; /**< The save type required by the ROM */
rom_tv_type_t tv_type; /**< The TV type required by the ROM */
/** @brief The CIC type required by the ROM. */
rom_cic_type_t cic_type;
/** @brief The save type required by the ROM. */
rom_save_type_t save_type;
/** @brief The TV type required by the ROM. */
rom_tv_type_t tv_type;
/** @brief Overrides the auto-detected CIC/save/TV types during rom boot. */
struct {
bool cic;
rom_cic_type_t cic_type;
bool cic; /**< Override CIC type */
rom_cic_type_t cic_type; /**< CIC type */
bool save; /**< Override save type */
rom_save_type_t save_type; /**< Save type */
bool tv; /**< Override TV type */
rom_tv_type_t tv_type; /**< TV type */
} boot_override; /**< Overrides the auto-detected CIC/save/TV types during ROM boot */
bool save;
rom_save_type_t save_type;
bool tv;
rom_tv_type_t tv_type;
} boot_override;
/** @brief The supported ROM accessories. */
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;
rom_expansion_pak_t expansion_pak;
} features;
bool controller_pak; /**< Supports Controller Pak */
bool rumble_pak; /**< Supports Rumble Pak */
bool transfer_pak; /**< Supports Transfer Pak */
bool voice_recognition_unit; /**< Supports Voice Recognition Unit */
bool real_time_clock; /**< Supports Real Time Clock */
bool disk_conversion; /**< Supports Disk Conversion */
bool combo_rom_disk_game; /**< Supports Combo ROM/Disk Game */
rom_expansion_pak_t expansion_pak; /**< Expansion Pak requirements */
} features; /**< The supported ROM accessories */
/** @brief The ROM settings. */
struct {
bool cheats_enabled;
bool patches_enabled;
} settings;
bool cheats_enabled; /**< Cheats enabled */
bool patches_enabled; /**< Patches enabled */
} settings; /**< The ROM settings */
/** @brief The ROM metadata. */
struct {
char description[300];
} metadata;
char description[300]; /**< ROM description */
} metadata; /**< The ROM metadata */
} rom_info_t;
bool rom_info_get_cic_seed (rom_info_t *rom_info, uint8_t *seed);
rom_err_t rom_info_load (path_t *path, rom_info_t *rom_info);
/**
* @brief Get the CIC seed for the ROM.
*
* @param rom_info Pointer to the ROM information structure
* @param seed Pointer to the seed value
* @return true if successful, false otherwise
*/
bool rom_info_get_cic_seed(rom_info_t *rom_info, uint8_t *seed);
rom_cic_type_t rom_info_get_cic_type (rom_info_t *rom_info);
rom_err_t rom_info_override_cic_type (path_t *path, rom_info_t *rom_info, rom_cic_type_t cic_type);
/**
* @brief Load ROM information from a file.
*
* @param path Pointer to the path structure
* @param rom_info Pointer to the ROM information structure
* @return rom_err_t Error code
*/
rom_err_t rom_info_load(path_t *path, rom_info_t *rom_info);
rom_save_type_t rom_info_get_save_type (rom_info_t *rom_info);
rom_err_t rom_info_override_save_type (path_t *path, rom_info_t *rom_info, rom_save_type_t save_type);
/**
* @brief Get the CIC type for the ROM.
*
* @param rom_info Pointer to the ROM information structure
* @return rom_cic_type_t CIC type
*/
rom_cic_type_t rom_info_get_cic_type(rom_info_t *rom_info);
rom_tv_type_t rom_info_get_tv_type (rom_info_t *rom_info);
rom_err_t rom_info_override_tv_type (path_t *path, rom_info_t *rom_info, rom_tv_type_t tv_type);
/**
* @brief Override the CIC type for the ROM.
*
* @param path Pointer to the path structure
* @param rom_info Pointer to the ROM information structure
* @param cic_type CIC type to override
* @return rom_err_t Error code
*/
rom_err_t rom_info_override_cic_type(path_t *path, rom_info_t *rom_info, rom_cic_type_t cic_type);
#endif
/**
* @brief Get the save type for the ROM.
*
* @param rom_info Pointer to the ROM information structure
* @return rom_save_type_t Save type
*/
rom_save_type_t rom_info_get_save_type(rom_info_t *rom_info);
/**
* @brief Override the save type for the ROM.
*
* @param path Pointer to the path structure
* @param rom_info Pointer to the ROM information structure
* @param save_type Save type to override
* @return rom_err_t Error code
*/
rom_err_t rom_info_override_save_type(path_t *path, rom_info_t *rom_info, rom_save_type_t save_type);
/**
* @brief Get the TV type for the ROM.
*
* @param rom_info Pointer to the ROM information structure
* @return rom_tv_type_t TV type
*/
rom_tv_type_t rom_info_get_tv_type(rom_info_t *rom_info);
/**
* @brief Override the TV type for the ROM.
*
* @param path Pointer to the path structure
* @param rom_info Pointer to the ROM information structure
* @param tv_type TV type to override
* @return rom_err_t Error code
*/
rom_err_t rom_info_override_tv_type(path_t *path, rom_info_t *rom_info, rom_tv_type_t tv_type);
#endif // ROM_INFO_H__

22
src/menu/ui_components/constants.h
View File

@ -7,7 +7,7 @@
#ifndef COMPONENTS_CONSTANTS_H__
#define COMPONENTS_CONSTANTS_H__
/** @brief the height of the tabs in the main menu */
/** @brief The height of the tabs in the main menu. */
#define TAB_HEIGHT (20)
/** @brief The thickness of borders. */
@ -42,7 +42,7 @@
/** @brief The height of the visible display. */
#define VISIBLE_AREA_HEIGHT (VISIBLE_AREA_Y1 - VISIBLE_AREA_Y0)
/** @brief The layout actions seperator y. */
/** @brief The layout actions separator Y position. */
#define LAYOUT_ACTIONS_SEPARATOR_Y (400)
/** @brief The seek bar height. */
@ -68,9 +68,13 @@
/** @brief The margin of a message box. */
#define MESSAGEBOX_MARGIN (32)
/** @brief The horizontal text margin. */
#define TEXT_MARGIN_HORIZONTAL (10)
/** @brief The vertical text margin. */
#define TEXT_MARGIN_VERTICAL (6)
/** @brief The vertical text offset. */
#define TEXT_OFFSET_VERTICAL (1)
/** @brief The text line spacing adjustment. */
#define TEXT_LINE_SPACING_ADJUST (0)
/** @brief The boxart picture width. */
@ -80,7 +84,7 @@
/** @brief The boxart picture width (64DD). */
#define BOXART_WIDTH_DD (129)
/** @brief The boxart picture height. */
/** @brief The boxart picture height (64DD). */
#define BOXART_HEIGHT_DD (112)
/** @brief The boxart picture maximum width. */
@ -92,12 +96,12 @@
#define BOXART_X (VISIBLE_AREA_X1 - BOXART_WIDTH - 24)
/** @brief The box art position on the Y axis. */
#define BOXART_Y (LAYOUT_ACTIONS_SEPARATOR_Y - BOXART_HEIGHT - 24)
/** @brief The box art position on the X axis for japanese caratules.*/
/** @brief The box art position on the X axis for Japanese caratules. */
#define BOXART_X_JP (VISIBLE_AREA_X1 - BOXART_WIDTH_MAX + 21)
/** @brief The box art position on the Y axis for japanese caratules. */
/** @brief The box art position on the Y axis for Japanese caratules. */
#define BOXART_Y_JP (LAYOUT_ACTIONS_SEPARATOR_Y - BOXART_HEIGHT_MAX - 24)
/** @brief The box art position on the X axis for 64DD caratules.*/
/** @brief The box art position on the X axis for 64DD caratules. */
#define BOXART_X_DD (VISIBLE_AREA_X1 - BOXART_WIDTH_DD - 23)
/** @brief The box art position on the Y axis for 64DD caratules. */
#define BOXART_Y_DD (LAYOUT_ACTIONS_SEPARATOR_Y - BOXART_HEIGHT_DD - 24)
@ -115,7 +119,9 @@
#define LIST_ENTRIES (18)
/** @brief The maximum width available for a file list entry. */
#define FILE_LIST_MAX_WIDTH (480)
/** @brief The file list highlight width. */
#define FILE_LIST_HIGHLIGHT_WIDTH (VISIBLE_AREA_X1 - VISIBLE_AREA_X0 - LIST_SCROLLBAR_WIDTH)
/** @brief The file list highlight X position. */
#define FILE_LIST_HIGHLIGHT_X (VISIBLE_AREA_X0)
/** @brief The default background colour. */
@ -144,7 +150,7 @@
/** @brief The boxart loading colour. */
#define BOXART_LOADING_COLOR RGBA32(0x3F, 0x3F, 0x3F, 0xFF)
/** @brief The filelist highlight colour. */
/** @brief The file list highlight colour. */
#define FILE_LIST_HIGHLIGHT_COLOR RGBA32(0x3F, 0x3F, 0x3F, 0xFF)
/** @brief The menu highlight colour. */
@ -159,4 +165,4 @@
/** @brief The tab active background colour. */
#define TAB_ACTIVE_BACKGROUND_COLOR RGBA32(0x6F, 0x6F, 0x6F, 0xFF)
#endif
#endif /* COMPONENTS_CONSTANTS_H__ */

301
src/menu/views/views.h
View File

@ -7,73 +7,292 @@
#ifndef VIEWS_H__
#define VIEWS_H__
#include "../ui_components.h"
#include "../menu_state.h"
/**
* @addtogroup view
* @{
*/
void view_startup_init (menu_t *menu);
void view_startup_display (menu_t *menu, surface_t *display);
/**
* @brief Initialize the startup view.
*
* @param menu Pointer to the menu structure.
*/
void view_startup_init(menu_t *menu);
void view_browser_init (menu_t *menu);
void view_browser_display (menu_t *menu, surface_t *display);
/**
* @brief Display the startup view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_startup_display(menu_t *menu, surface_t *display);
void view_file_info_init (menu_t *menu);
void view_file_info_display (menu_t *menu, surface_t *display);
/**
* @brief Initialize the browser view.
*
* @param menu Pointer to the menu structure.
*/
void view_browser_init(menu_t *menu);
void view_system_info_init (menu_t *menu);
void view_system_info_display (menu_t *menu, surface_t *display);
/**
* @brief Display the browser view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_browser_display(menu_t *menu, surface_t *display);
void view_image_viewer_init (menu_t *menu);
void view_image_viewer_display (menu_t *menu, surface_t *display);
/**
* @brief Initialize the file info view.
*
* @param menu Pointer to the menu structure.
*/
void view_file_info_init(menu_t *menu);
void view_text_viewer_init (menu_t *menu);
void view_text_viewer_display (menu_t *menu, surface_t *display);
/**
* @brief Display the file info view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_file_info_display(menu_t *menu, surface_t *display);
void view_music_player_init (menu_t *menu);
void view_music_player_display (menu_t *menu, surface_t *display);
/**
* @brief Initialize the system info view.
*
* @param menu Pointer to the menu structure.
*/
void view_system_info_init(menu_t *menu);
void view_credits_init (menu_t *menu);
void view_credits_display (menu_t *menu, surface_t *display);
/**
* @brief Display the system info view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_system_info_display(menu_t *menu, surface_t *display);
void view_settings_init (menu_t *menu);
void view_settings_display (menu_t *menu, surface_t *display);
/**
* @brief Initialize the image viewer view.
*
* @param menu Pointer to the menu structure.
*/
void view_image_viewer_init(menu_t *menu);
void view_rtc_init (menu_t *menu);
void view_rtc_display (menu_t *menu, surface_t *display);
/**
* @brief Display the image viewer view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_image_viewer_display(menu_t *menu, surface_t *display);
void view_flashcart_info_init (menu_t *menu);
void view_flashcart_info_display (menu_t *menu, surface_t *display);
/**
* @brief Initialize the text viewer view.
*
* @param menu Pointer to the menu structure.
*/
void view_text_viewer_init(menu_t *menu);
void view_load_rom_init (menu_t *menu);
void view_load_rom_display (menu_t *menu, surface_t *display);
/**
* @brief Display the text viewer view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_text_viewer_display(menu_t *menu, surface_t *display);
void view_load_disk_init (menu_t *menu);
void view_load_disk_display (menu_t *menu, surface_t *display);
/**
* @brief Initialize the music player view.
*
* @param menu Pointer to the menu structure.
*/
void view_music_player_init(menu_t *menu);
void view_load_emulator_init (menu_t *menu);
void view_load_emulator_display (menu_t *menu, surface_t *display);
/**
* @brief Display the music player view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_music_player_display(menu_t *menu, surface_t *display);
void view_error_init (menu_t *menu);
void view_error_display (menu_t *menu, surface_t *display);
/**
* @brief Initialize the credits view.
*
* @param menu Pointer to the menu structure.
*/
void view_credits_init(menu_t *menu);
void view_fault_init (menu_t *menu);
void view_fault_display (menu_t *menu, surface_t *display);
/**
* @brief Display the credits view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_credits_display(menu_t *menu, surface_t *display);
void view_favorite_init (menu_t *menu);
void view_favorite_display (menu_t *menu, surface_t *display);
/**
* @brief Initialize the settings view.
*
* @param menu Pointer to the menu structure.
*/
void view_settings_init(menu_t *menu);
void view_history_init (menu_t *menu);
void view_history_display (menu_t *menu, surface_t *display);
/**
* @brief Display the settings view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_settings_display(menu_t *menu, surface_t *display);
void menu_show_error (menu_t *menu, char *error_message);
/**
* @brief Initialize the RTC view.
*
* @param menu Pointer to the menu structure.
*/
void view_rtc_init(menu_t *menu);
/**
* @brief Display the RTC view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_rtc_display(menu_t *menu, surface_t *display);
/**
* @brief Initialize the flashcart info view.
*
* @param menu Pointer to the menu structure.
*/
void view_flashcart_info_init(menu_t *menu);
/**
* @brief Display the flashcart info view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_flashcart_info_display(menu_t *menu, surface_t *display);
/**
* @brief Initialize the load ROM view.
*
* @param menu Pointer to the menu structure.
*/
void view_load_rom_init(menu_t *menu);
/**
* @brief Display the load ROM view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_load_rom_display(menu_t *menu, surface_t *display);
/**
* @brief Initialize the load disk view.
*
* @param menu Pointer to the menu structure.
*/
void view_load_disk_init(menu_t *menu);
/**
* @brief Display the load disk view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_load_disk_display(menu_t *menu, surface_t *display);
/**
* @brief Initialize the load emulator view.
*
* @param menu Pointer to the menu structure.
*/
void view_load_emulator_init(menu_t *menu);
/**
* @brief Display the load emulator view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_load_emulator_display(menu_t *menu, surface_t *display);
/**
* @brief Initialize the error view.
*
* @param menu Pointer to the menu structure.
*/
void view_error_init(menu_t *menu);
/**
* @brief Display the error view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_error_display(menu_t *menu, surface_t *display);
/**
* @brief Initialize the fault view.
*
* @param menu Pointer to the menu structure.
*/
void view_fault_init(menu_t *menu);
/**
* @brief Display the fault view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_fault_display(menu_t *menu, surface_t *display);
/**
* @brief Initialize the favorite view.
*
* @param menu Pointer to the menu structure.
*/
void view_favorite_init(menu_t *menu);
/**
* @brief Display the favorite view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_favorite_display(menu_t *menu, surface_t *display);
/**
* @brief Initialize the history view.
*
* @param menu Pointer to the menu structure.
*/
void view_history_init(menu_t *menu);
/**
* @brief Display the history view.
*
* @param menu Pointer to the menu structure.
* @param display Pointer to the display surface.
*/
void view_history_display(menu_t *menu, surface_t *display);
/**
* @brief Show an error message in the menu.
*
* @param menu Pointer to the menu structure.
* @param error_message Error message to be displayed.
*/
void menu_show_error(menu_t *menu, char *error_message);
/** @} */ /* view */
#endif
#endif // VIEWS_H__