flashcart.h File Reference

Flashcart Subsystem. More...

Go to the source code of this file.

Data Structures
struct	flashcart_disk_parameters_t
	Flashcart Disk Parameter Structure. More...
struct	flashcart_firmware_version_t
	Flashcart Firmware version Structure. More...
struct	flashcart_t
	Flashcart Structure. More...

Typedefs
typedef void	flashcart_progress_callback_t(float progress)
	Flashcart progress callback type.

Enumerations
enum	flashcart_err_t {   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 error enumeration. More...
enum	flashcart_features_t {   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 }
	List of optional supported flashcart features. More...
enum	flashcart_save_type_t {   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 enumeration. More...
enum	flashcart_reboot_mode_t { FLASHCART_REBOOT_MODE_MENU , FLASHCART_REBOOT_MODE_ROM }
	Flashcart save type enumeration. More...

Functions
char *	flashcart_convert_error_message (flashcart_err_t err)
	Convert a flashcart error code to a human-readable error message.
flashcart_err_t	flashcart_init (const char **storage_prefix)
	Initialize the flashcart.
flashcart_err_t	flashcart_deinit (void)
	Deinitialize the flashcart.
bool	flashcart_has_feature (flashcart_features_t feature)
	Check if the flashcart has a specific feature.
flashcart_firmware_version_t	flashcart_get_firmware_version (void)
	Get the flashcart firmware version.
flashcart_err_t	flashcart_load_rom (char *rom_path, bool byte_swap, flashcart_progress_callback_t *progress)
	Load a ROM onto the flashcart.
flashcart_err_t	flashcart_load_file (char *file_path, uint32_t rom_offset, uint32_t file_offset)
	Load a file onto the flashcart.
flashcart_err_t	flashcart_load_save (char *save_path, flashcart_save_type_t save_type)
	Load a save file onto the flashcart.
flashcart_err_t	flashcart_load_64dd_ipl (char *ipl_path, flashcart_progress_callback_t *progress)
	Load the 64DD IPL (BIOS) onto the flashcart.
flashcart_err_t	flashcart_load_64dd_disk (char *disk_path, flashcart_disk_parameters_t *disk_parameters)
	Load a 64DD disk onto the flashcart.
flashcart_err_t	flashcart_set_next_boot_mode (flashcart_reboot_mode_t boot_mode)

Detailed Description

Flashcart Subsystem.

---

Data Structure Documentation

flashcart_disk_parameters_t

struct flashcart_disk_parameters_t

Flashcart Disk Parameter Structure.

Data Fields
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_firmware_version_t

struct flashcart_firmware_version_t

Flashcart Firmware version Structure.

Data Fields
uint16_t	major	Major version
uint16_t	minor	Minor version
uint32_t	revision	Revision

flashcart_t

struct flashcart_t

Flashcart Structure.

Data Fields
flashcart_err_t(*)(void)	init	The flashcart initialization function.
flashcart_err_t(*)(void)	deinit	The flashcart de-initialization function.
bool(*)(flashcart_features_t feature)	has_feature	The flashcart feature function.
flashcart_firmware_version_t(*)(void)	get_firmware_version	The flashcart firmware version function.
flashcart_err_t(*)(char *rom_path, flashcart_progress_callback_t *progress)	load_rom	The flashcart ROM load function.
flashcart_err_t(*)(char *file_path, uint32_t rom_offset, uint32_t file_offset)	load_file	The flashcart file load function.
flashcart_err_t(*)(char *save_path)	load_save	The flashcart save file load function.
flashcart_err_t(*)(char *ipl_path, flashcart_progress_callback_t *progress)	load_64dd_ipl	The flashcart disk bios load function.
flashcart_err_t(*)(char *disk_path, flashcart_disk_parameters_t *disk_parameters)	load_64dd_disk	The flashcart disk load function.
flashcart_err_t(*)(flashcart_save_type_t save_type)	set_save_type	The flashcart set save type function.
flashcart_err_t(*)(char *save_path)	set_save_writeback	The flashcart set save writeback function.
flashcart_err_t(*)(flashcart_reboot_mode_t boot_mode)	set_next_boot_mode	The flashcart set boot mode function.

Enumeration Type Documentation

flashcart_err_t

enum flashcart_err_t

Flashcart error enumeration.

Enumerator
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_features_t

enum flashcart_features_t

List of optional supported flashcart features.

Enumerator
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_save_type_t

enum flashcart_save_type_t

Flashcart save type enumeration.

Enumerator
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_reboot_mode_t

enum flashcart_reboot_mode_t

Flashcart save type enumeration.

Enumerator
FLASHCART_REBOOT_MODE_MENU	The flashcart will reboot into the menu on soft reboot (using the RESET button)
FLASHCART_REBOOT_MODE_ROM	The flashcart will reboot into the previous ROM on soft reboot (using the RESET button)

Function Documentation

flashcart_convert_error_message()

char * flashcart_convert_error_message

(

flashcart_err_t

err

)

Convert a flashcart error code to a human-readable error message.

Parameters

err	The flashcart error code.

Returns

char* The human-readable error message.

Convert a flashcart error code to a human-readable error message.

Parameters

err	The flashcart error code.

Returns

char* The error message.

flashcart_init()

flashcart_err_t flashcart_init

(

const char **

storage_prefix

)

Initialize the flashcart.

Parameters

storage_prefix

Pointer to the storage prefix.

Returns

flashcart_err_t Error code.

flashcart_deinit()

flashcart_err_t flashcart_deinit

(

void

)

Deinitialize the flashcart.

Returns

flashcart_err_t Error code.

flashcart_has_feature()

bool flashcart_has_feature

(

flashcart_features_t

feature

)

Check if the flashcart has a specific feature.

Parameters

feature

The flashcart feature to check.

Returns

bool True if the feature is supported, false otherwise.

Parameters

feature

The feature to check.

Returns

true if the feature is supported, false otherwise.

flashcart_get_firmware_version()

flashcart_firmware_version_t flashcart_get_firmware_version

(

void

)

Get the flashcart firmware version.

Returns

flashcart_firmware_version_t The firmware version.

Get the flashcart firmware version.

Returns

flashcart_firmware_version_t The firmware version.

flashcart_load_rom()

flashcart_err_t flashcart_load_rom	(	char *	rom_path,
		bool	byte_swap,
		flashcart_progress_callback_t *	progress )

Load a ROM onto the flashcart.

Parameters

rom_path	The path to the ROM file.
byte_swap	Whether to byte swap the ROM.
progress	Callback function for progress updates.

Returns

flashcart_err_t Error code.

Load a ROM onto the flashcart.

Parameters

rom_path	Path to the ROM file.
byte_swap	Flag indicating whether to byte swap the ROM.
progress	Progress callback function.

Returns

flashcart_err_t Error code.

flashcart_load_file()

flashcart_err_t flashcart_load_file	(	char *	file_path,
		uint32_t	rom_offset,
		uint32_t	file_offset )

Load a file onto the flashcart.

Parameters

file_path	The path to the file.
rom_offset	The ROM offset.
file_offset	The file offset.

Returns

flashcart_err_t Error code.

Load a file onto the flashcart.

Parameters

file_path	Path to the file.
rom_offset	ROM offset.
file_offset	File offset.

Returns

flashcart_err_t Error code.

flashcart_load_save()

flashcart_err_t flashcart_load_save	(	char *	save_path,
		flashcart_save_type_t	save_type )

Load a save file onto the flashcart.

Parameters

save_path	The path to the save file.
save_type	The type of save.

Returns

flashcart_err_t Error code.

Load a save file onto the flashcart.

Parameters

save_path	Path to the save file.
save_type	The save type.

Returns

flashcart_err_t Error code.

flashcart_load_64dd_ipl()

flashcart_err_t flashcart_load_64dd_ipl	(	char *	ipl_path,
		flashcart_progress_callback_t *	progress )

Load the 64DD IPL (BIOS) onto the flashcart.

Parameters

ipl_path	The path to the IPL file.
progress	Callback function for progress updates.

Returns

flashcart_err_t Error code.

Load the 64DD IPL (BIOS) onto the flashcart.

Parameters

ipl_path	Path to the IPL file.
progress	Progress callback function.

Returns

flashcart_err_t Error code.

flashcart_load_64dd_disk()

flashcart_err_t flashcart_load_64dd_disk	(	char *	disk_path,
		flashcart_disk_parameters_t *	disk_parameters )

Load a 64DD disk onto the flashcart.

Parameters

disk_path	The path to the disk file.
disk_parameters	Pointer to the disk parameters structure.

Returns

flashcart_err_t Error code.

Load a 64DD disk onto the flashcart.

Parameters

disk_path	Path to the disk file.
disk_parameters	Pointer to the disk parameters.

Returns

flashcart_err_t Error code.