rom_info.c File Reference

ROM Information component implementation. More...

Data Structures
struct	rom_header_t
	ROM File Information Structure. More...
struct	match_t
	ROM Match Structure. More...
struct	rom_header_t.libultra
union	rom_header_t.__unnamed13__
struct	rom_header_t.__unnamed13__.__unnamed15__
union	match_t.fields
struct	match_t.fields.__unnamed19__
struct	match_t.data

Macros
#define	SWAP_VARS(x0, x1)
#define	PI_CONFIG_BIG_ENDIAN   (0x80371240)
#define	PI_CONFIG_LITTLE_ENDIAN   (0x40123780)
#define	PI_CONFIG_BYTE_SWAPPED   (0x37804012)
#define	PI_CONFIG_64DD_IPL   (0x80270740)
#define	CLOCK_RATE_DEFAULT   (0x0000000F)
#define	MATCH_ID(i, s, f)
#define	MATCH_ID_REGION(i, s, f)
#define	MATCH_ID_REGION_VERSION(i, v, s, f)
#define	MATCH_CHECK_CODE(c, s, f)
#define	MATCH_HOMEBREW_HEADER(i)
#define	MATCH_END   { .type = MATCH_TYPE_END, .data = { .save = SAVE_TYPE_NONE, .feat = FEAT_NONE } }

Enumerations
enum	match_type_t {   MATCH_TYPE_ID , MATCH_TYPE_ID_REGION , MATCH_TYPE_ID_REGION_VERSION , MATCH_TYPE_CHECK_CODE ,   MATCH_TYPE_HOMEBREW_HEADER , MATCH_TYPE_END }
	ROM Information Match Type Enumeration. More...
enum	feat_t {   FEAT_NONE = 0 , FEAT_CPAK = (1 << 0) , FEAT_RPAK = (1 << 1) , FEAT_TPAK = (1 << 2) ,   FEAT_VRU = (1 << 3) , FEAT_RTC = (1 << 4) , FEAT_EXP_PAK_REQUIRED = (1 << 5) , FEAT_EXP_PAK_RECOMMENDED = (1 << 6) ,   FEAT_EXP_PAK_ENHANCED = (1 << 7) , FEAT_EXP_PAK_BROKEN = (1 << 8) , FEAT_64DD_CONVERSION = (1 << 9) , FEAT_64DD_ENHANCED = (1 << 10) }
	ROM Features Enumeration. More...

Functions
rom_cic_type_t	rom_info_get_cic_type (rom_info_t *rom_info)
	Get the CIC type for the ROM.
bool	rom_info_get_cic_seed (rom_info_t *rom_info, uint8_t *seed)
	Get the CIC seed for the ROM.
rom_err_t	rom_config_override_cic_type (path_t *path, rom_info_t *rom_info, rom_cic_type_t cic_type)
	Override the CIC type for the ROM.
rom_save_type_t	rom_info_get_save_type (rom_info_t *rom_info)
	Get the save type for the ROM.
rom_err_t	rom_config_override_save_type (path_t *path, rom_info_t *rom_info, rom_save_type_t save_type)
	Override the save type for the ROM.
rom_tv_type_t	rom_info_get_tv_type (rom_info_t *rom_info)
	Get the TV type for the ROM.
rom_err_t	rom_config_override_tv_type (path_t *path, rom_info_t *rom_info, rom_tv_type_t tv_type)
	Override the TV type for the ROM.
rom_err_t	rom_config_setting_set_cheats (path_t *path, rom_info_t *rom_info, bool enabled)
	Set the cheats setting for the ROM.
rom_err_t	rom_config_load (path_t *path, rom_info_t *rom_info)
	Load ROM information from a file.

Detailed Description

ROM Information component implementation.

---

Data Structure Documentation

rom_header_t

struct rom_header_t

ROM File Information Structure.

Data Fields
uint32_t	pi_dom1_config
uint32_t	clock_rate
uint32_t	boot_address
struct rom_header_t.libultra	libultra
uint64_t	check_code
uint8_t	__unused_1[8]
char	title[20]
uint8_t	__unused_2[7]
union rom_header_t.__unnamed13__	__unnamed__
uint8_t	version
uint8_t	ipl3[IPL3_LENGTH]

match_t

struct match_t

ROM Match Structure.

Data Fields
match_type_t	type	Match type
union match_t.fields	fields
struct match_t.data	data

rom_header_t.libultra

struct rom_header_t.libultra

Data Fields
uint8_t	__unused_1[2]
uint8_t	version
char	revision

rom_header_t.__unnamed13__

union rom_header_t.__unnamed13__

Data Fields
char	game_code[4]
struct rom_header_t.__unnamed13__.__unnamed15__	__unnamed__

rom_header_t.__unnamed13__.__unnamed15__

struct rom_header_t.__unnamed13__.__unnamed15__

Data Fields
char	category_code
char	unique_code[2]
char	destination_code

match_t.fields

union match_t.fields

Data Fields
struct match_t.fields.__unnamed19__	__unnamed__
uint64_t	check_code	Game check code

match_t.fields.__unnamed19__

struct match_t.fields.__unnamed19__

Data Fields
const char *	id	Game code or unique ID
uint8_t	version	Game version

match_t.data

struct match_t.data

Data Fields
rom_save_type_t	save	Save type
feat_t	feat	Supported features

Macro Definition Documentation

SWAP_VARS

#define SWAP_VARS	(		x0,
			x1 )

Value:

{ typeof(x0) tmp = (x0); (x0) = (x1); (x1) = (tmp); }

MATCH_ID

#define MATCH_ID	(		i,
			s,
			f )

Value:

{ .type = MATCH_TYPE_ID, .fields = { .id = i }, .data = { .save = s, .feat = f } }

MATCH_ID_REGION

#define MATCH_ID_REGION	(		i,
			s,
			f )

Value:

{ .type = MATCH_TYPE_ID_REGION, .fields = { .id = i }, .data = { .save = s, .feat = f } }

MATCH_ID_REGION_VERSION

#define MATCH_ID_REGION_VERSION	(		i,
			v,
			s,
			f )

Value:

{ .type = MATCH_TYPE_ID_REGION_VERSION, .fields = { .id = i, .version = v }, .data = { .save = s, .feat = f } }

MATCH_CHECK_CODE

#define MATCH_CHECK_CODE	(		c,
			s,
			f )

Value:

{ .type = MATCH_TYPE_CHECK_CODE, .fields = { .check_code = c }, .data = { .save = s, .feat = f } }

MATCH_HOMEBREW_HEADER

#define MATCH_HOMEBREW_HEADER

(

i

)

Value:

{ .type = MATCH_TYPE_HOMEBREW_HEADER, .fields = { .id = i }, .data = { .feat = FEAT_NONE } }

Enumeration Type Documentation

match_type_t

enum match_type_t

ROM Information Match Type Enumeration.

Enumerator
MATCH_TYPE_ID	Check only game code
MATCH_TYPE_ID_REGION	Check game code and region
MATCH_TYPE_ID_REGION_VERSION	Check game code, region and version
MATCH_TYPE_CHECK_CODE	Check game check code
MATCH_TYPE_HOMEBREW_HEADER	Check for homebrew header ID
MATCH_TYPE_END	List end marker

feat_t

enum feat_t

ROM Features Enumeration.

Enumerator
FEAT_NONE	No features supported
FEAT_CPAK	Controller Pak
FEAT_RPAK	Rumble Pak
FEAT_TPAK	Transfer Pak
FEAT_VRU	Voice Recognition Unit
FEAT_RTC	Real Time Clock
FEAT_EXP_PAK_REQUIRED	Expansion Pak required
FEAT_EXP_PAK_RECOMMENDED	Expansion Pak recommended
FEAT_EXP_PAK_ENHANCED	Expansion Pak enhanced
FEAT_EXP_PAK_BROKEN	Expansion Pak broken
FEAT_64DD_CONVERSION	64DD disk to ROM conversion
FEAT_64DD_ENHANCED	Combo ROM + Disk games

Function Documentation

rom_info_get_cic_type()

rom_cic_type_t rom_info_get_cic_type

(

rom_info_t *

rom_info

)

Get the CIC type for the ROM.

Parameters

rom_info

Pointer to the ROM information structure

Returns

rom_cic_type_t CIC type

rom_info_get_cic_seed()

bool rom_info_get_cic_seed	(	rom_info_t *	rom_info,
		uint8_t *	seed )

Get the CIC seed for the ROM.

Parameters

rom_info	Pointer to the ROM information structure
seed	Pointer to the seed value

Returns

true if successful, false otherwise

rom_config_override_cic_type()

rom_err_t rom_config_override_cic_type	(	path_t *	path,
		rom_info_t *	rom_info,
		rom_cic_type_t	cic_type )

Override the CIC type for the ROM.

Parameters

path	Pointer to the path structure
rom_info	Pointer to the ROM information structure
cic_type	CIC type to override

Returns

rom_err_t Error code

rom_info_get_save_type()

rom_save_type_t rom_info_get_save_type

(

rom_info_t *

rom_info

)

Get the save type for the ROM.

Parameters

rom_info

Pointer to the ROM information structure

Returns

rom_save_type_t Save type

rom_config_override_save_type()

rom_err_t rom_config_override_save_type	(	path_t *	path,
		rom_info_t *	rom_info,
		rom_save_type_t	save_type )

Override the save type for the ROM.

Parameters

path	Pointer to the path structure
rom_info	Pointer to the ROM information structure
save_type	Save type to override

Returns

rom_err_t Error code

rom_info_get_tv_type()

rom_tv_type_t rom_info_get_tv_type

(

rom_info_t *

rom_info

)

Get the TV type for the ROM.

Parameters

rom_info

Pointer to the ROM information structure

Returns

rom_tv_type_t TV type

rom_config_override_tv_type()

rom_err_t rom_config_override_tv_type	(	path_t *	path,
		rom_info_t *	rom_info,
		rom_tv_type_t	tv_type )

Override the TV type for the ROM.

Parameters

path	Pointer to the path structure
rom_info	Pointer to the ROM information structure
tv_type	TV type to override

Returns

rom_err_t Error code

rom_config_setting_set_cheats()

rom_err_t rom_config_setting_set_cheats	(	path_t *	path,
		rom_info_t *	rom_info,
		bool	enabled )

Set the cheats setting for the ROM.

Parameters

path	Pointer to the path structure
rom_info	Pointer to the ROM information structure
enabled	True to enable cheats, false to disable

Returns

rom_err_t Error code

rom_config_load()

rom_err_t rom_config_load	(	path_t *	path,
		rom_info_t *	rom_info )

Load ROM information from a file.

Parameters

path	Pointer to the path structure
rom_info	Pointer to the ROM information structure

Returns

rom_err_t Error code