Data Structures
struct	sc64_buffers_t
	The SC64 buffers structure. More...

struct	sc64_disk_mapping_t
	The SC64 Disk Mapping Structure. More...

struct	sc64_disk_mapping_t.disks

Macros
#define	SC64_BUFFERS_BASE (0x1FFE0000UL)

#define	SC64_BUFFERS ((sc64_buffers_t *) SC64_BUFFERS_BASE)

Enumerations
enum	sc64_error_t { 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 }
	The SC64 State Enumeration. More...

enum	sc64_cfg_id_t { 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 }
	The SC64 Configuration ID Enumeration. More...

enum	sc64_dd_mode_t { DD_MODE_DISABLED = 0 , DD_MODE_REGS = 1 , DD_MODE_IPL = 2 , DD_MODE_FULL = 3 }
	The SC64 Disk Drive Mode Enumeration. More...

enum	sc64_boot_mode_t { BOOT_MODE_MENU = 0 , BOOT_MODE_ROM = 1 , BOOT_MODE_DDIPL = 2 , BOOT_MODE_DIRECT_ROM = 3 , BOOT_MODE_DIRECT_DDIPL = 4 }
	The SC64 Boot Mode Enumeration. More...

enum	sc64_save_type_t { 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 }
	The SC64 Save Type Enumeration. More...

enum	sc64_cic_seed_t { CIC_SEED_AUTO = 0xFFFF }
	The SC64 CIC Seed Enumeration. More...

enum	sc64_tv_type_t { TV_TYPE_PAL = 0 , TV_TYPE_NTSC = 1 , TV_TYPE_MPAL = 2 , TV_TYPE_PASSTHROUGH = 3 }
	The SC64 TV Type Enumeration. More...

enum	sc64_drive_type_t { DRIVE_TYPE_RETAIL , DRIVE_TYPE_DEVELOPMENT }
	The SC64 Drive Type Enumeration. More...

enum	sc64_disk_state_t { DISK_STATE_EJECTED , DISK_STATE_INSERTED , DISK_STATE_CHANGED }
	The SC64 Disk State Enumeration. More...

enum	sc64_button_mode_t { BUTTON_MODE_NONE , BUTTON_MODE_N64_IRQ , BUTTON_MODE_USB_PACKET , BUTTON_MODE_DD_DISK_SWAP }
	The SC64 Button Mode Enumeration. More...

Functions
flashcart_t *	sc64_get_flashcart (void)

void	sc64_ll_lock (void)
	Lock the SC64.

sc64_error_t	sc64_ll_get_version (uint16_t major, uint16_t minor, uint32_t *revision)
	Get the SC64 version.

sc64_error_t	sc64_ll_get_config (sc64_cfg_id_t cfg, uint32_t *value)
	Get the SC64 configuration.

sc64_error_t	sc64_ll_set_config (sc64_cfg_id_t cfg, uint32_t value)
	Set the SC64 configuration.

sc64_error_t	sc64_ll_set_disk_mapping (sc64_disk_mapping_t *disk_mapping)
	Set the SC64 disk mapping.

sc64_error_t	sc64_ll_writeback_pending (bool *pending)
	Check if writeback is pending.

sc64_error_t	sc64_ll_writeback_enable (void *address)
	Enable writeback.

sc64_error_t	sc64_ll_flash_wait_busy (void)
	Wait for flash to be not busy.

sc64_error_t	sc64_ll_flash_get_erase_block_size (size_t *erase_block_size)
	Get the flash erase block size.

sc64_error_t	sc64_ll_flash_erase_block (void *address)
	Erase a flash block.

Detailed Description

Data Structure Documentation

◆ sc64_buffers_t

struct sc64_buffers_t

The SC64 buffers structure.

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

struct sc64_disk_mapping_t

The SC64 Disk Mapping Structure.

Data Fields
int	count	Number of disks
struct sc64_disk_mapping_t.disks	disks[4]	Array of disks

◆ sc64_disk_mapping_t.disks

struct sc64_disk_mapping_t.disks

Data Fields
uint32_t	thb_table	THB table
uint32_t	sector_table	Sector table

Enumeration Type Documentation

◆ sc64_error_t

enum sc64_error_t

The SC64 State Enumeration.

Enumerator
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	Unknown command error

◆ sc64_cfg_id_t

enum sc64_cfg_id_t

The SC64 Configuration ID Enumeration.

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

enum sc64_dd_mode_t

The SC64 Disk Drive Mode Enumeration.

Enumerator
DD_MODE_DISABLED	Disk Drive disabled
DD_MODE_REGS	Disk Drive registers mode
DD_MODE_IPL	Disk Drive IPL mode
DD_MODE_FULL	Disk Drive full mode

◆ sc64_boot_mode_t

enum sc64_boot_mode_t

The SC64 Boot Mode Enumeration.

Enumerator
BOOT_MODE_MENU	Boot to menu
BOOT_MODE_ROM	Boot to ROM
BOOT_MODE_DDIPL	Boot to Disk Drive IPL
BOOT_MODE_DIRECT_ROM	Direct boot to ROM
BOOT_MODE_DIRECT_DDIPL	Direct boot to Disk Drive IPL

◆ sc64_save_type_t

enum sc64_save_type_t

The SC64 Save Type Enumeration.

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

enum sc64_cic_seed_t

The SC64 CIC Seed Enumeration.

Enumerator
CIC_SEED_AUTO	Automatic CIC seed

◆ sc64_tv_type_t

enum sc64_tv_type_t

The SC64 TV Type Enumeration.

Enumerator
TV_TYPE_PAL	PAL TV type
TV_TYPE_NTSC	NTSC TV type
TV_TYPE_MPAL	MPAL TV type
TV_TYPE_PASSTHROUGH	Passthrough TV type

◆ sc64_drive_type_t

enum sc64_drive_type_t

The SC64 Drive Type Enumeration.

Enumerator
DRIVE_TYPE_RETAIL	Retail drive type
DRIVE_TYPE_DEVELOPMENT	Development drive type

◆ sc64_disk_state_t

enum sc64_disk_state_t

The SC64 Disk State Enumeration.

Enumerator
DISK_STATE_EJECTED	Disk ejected
DISK_STATE_INSERTED	Disk inserted
DISK_STATE_CHANGED	Disk state changed

◆ sc64_button_mode_t

enum sc64_button_mode_t

The SC64 Button Mode Enumeration.

Enumerator
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

Function Documentation

◆ sc64_ll_lock()

void sc64_ll_lock ( void )

Lock the SC64.

◆ sc64_ll_get_version()

sc64_error_t sc64_ll_get_version	(	uint16_t *	major,
		uint16_t *	minor,
		uint32_t *	revision )

Get the SC64 version.

Parameters

major	Pointer to store the major version.
minor	Pointer to store the minor version.
revision	Pointer to store the revision.

Returns: sc64_error_t Error code.

Get the SC64 version.

Parameters

major	Pointer to store the major version.
minor	Pointer to store the minor version.
revision	Pointer to store the revision number.

Returns: sc64_error_t Error code.

◆ sc64_ll_get_config()

sc64_error_t sc64_ll_get_config	(	sc64_cfg_id_t	id,
		uint32_t *	value )

Get the SC64 configuration.

Parameters

cfg	Configuration ID.
value	Pointer to store the configuration value.

Returns: sc64_error_t Error code.

Get the SC64 configuration.

Parameters

id	Configuration ID.
value	Pointer to store the configuration value.

Returns: sc64_error_t Error code.

◆ sc64_ll_set_config()

sc64_error_t sc64_ll_set_config	(	sc64_cfg_id_t	id,
		uint32_t	value )

Set the SC64 configuration.

Parameters

cfg	Configuration ID.
value	Configuration value.

Returns: sc64_error_t Error code.

Set the SC64 configuration.

Parameters

id	Configuration ID.
value	Configuration value.

Returns: sc64_error_t Error code.

◆ sc64_ll_set_disk_mapping()

sc64_error_t sc64_ll_set_disk_mapping ( sc64_disk_mapping_t * disk_mapping )

Set the SC64 disk mapping.

Parameters

disk_mapping Pointer to the disk mapping structure.

Returns: sc64_error_t Error code.

Set the SC64 disk mapping.

Parameters

disk_mapping Pointer to the disk mapping structure.

Returns: sc64_error_t Error code.

◆ sc64_ll_writeback_pending()

sc64_error_t sc64_ll_writeback_pending ( bool * pending )

Check if writeback is pending.

Parameters

pending Pointer to store the pending status.

Returns: sc64_error_t Error code.

Check if writeback is pending.

Parameters

pending Pointer to store the pending status.

Returns: sc64_error_t Error code.

◆ sc64_ll_writeback_enable()

sc64_error_t sc64_ll_writeback_enable ( void * address )

Enable writeback.

Parameters

address Address to enable writeback.

Returns: sc64_error_t Error code.

Enable writeback.

Parameters

address Address to enable writeback.

Returns: sc64_error_t Error code.

◆ sc64_ll_flash_wait_busy()

sc64_error_t sc64_ll_flash_wait_busy ( void )

Wait for flash to be not busy.

Returns: sc64_error_t Error code.

Wait for flash to be not busy.

Returns: sc64_error_t Error code.

◆ sc64_ll_flash_get_erase_block_size()

sc64_error_t sc64_ll_flash_get_erase_block_size ( size_t * erase_block_size )

Get the flash erase block size.

Parameters

erase_block_size Pointer to store the erase block size.

Returns: sc64_error_t Error code.

Get the flash erase block size.

Parameters

erase_block_size Pointer to store the erase block size.

Returns: sc64_error_t Error code.

◆ sc64_ll_flash_erase_block()

sc64_error_t sc64_ll_flash_erase_block ( void * address )

Erase a flash block.

Parameters

address Address of the block to erase.

Returns: sc64_error_t Error code.

Erase a flash block.

Parameters

address Address of the block to erase.

Returns: sc64_error_t Error code.

Data Structures

Macros

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ sc64_buffers_t

◆ sc64_disk_mapping_t

◆ sc64_disk_mapping_t.disks

Enumeration Type Documentation

◆ sc64_error_t

◆ sc64_cfg_id_t

◆ sc64_dd_mode_t

◆ sc64_boot_mode_t

◆ sc64_save_type_t

◆ sc64_cic_seed_t

◆ sc64_tv_type_t

◆ sc64_drive_type_t

◆ sc64_disk_state_t

◆ sc64_button_mode_t

Function Documentation

◆ sc64_ll_lock()

◆ sc64_ll_get_version()

◆ sc64_ll_get_config()

◆ sc64_ll_set_config()

◆ sc64_ll_set_disk_mapping()

◆ sc64_ll_writeback_pending()

◆ sc64_ll_writeback_enable()

◆ sc64_ll_flash_wait_busy()

◆ sc64_ll_flash_get_erase_block_size()

◆ sc64_ll_flash_erase_block()