view romdb.h @ 1442:59e1dbb795a7

Update README in anticipation of 0.5.1 release
author Michael Pavone <pavone@retrodev.com>
date Fri, 25 Aug 2017 20:12:21 -0700
parents 11ac0b511cff
children 14a2834d010c
line wrap: on
line source

#ifndef ROMDB_H_
#define ROMDB_H_

#define REGION_J 1
#define REGION_U 2
#define REGION_E 4

#define RAM_FLAG_ODD  0x18
#define RAM_FLAG_EVEN 0x10
#define RAM_FLAG_BOTH 0x00
#define RAM_FLAG_MASK RAM_FLAG_ODD
#define SAVE_I2C      0x01
#define SAVE_NOR      0x02
#define SAVE_NONE     0xFF

#include "tern.h"

typedef struct {
	uint32_t     start;
	uint32_t     end;
	uint16_t     sda_write_mask;
	uint16_t     scl_mask;
	uint8_t      sda_read_bit;
} eeprom_map;

typedef struct {
	uint8_t     *buffer;
	uint8_t     *page_buffer;
	uint32_t    size;
	uint32_t    page_size;
	uint32_t    current_page;
	uint32_t    last_write_cycle;
	uint16_t    product_id;
	uint8_t     mode;
	uint8_t     cmd_state;
	uint8_t     alt_cmd;
	uint8_t     bus_flags;
} nor_state;


typedef struct rom_info rom_info;

#include "backend.h"

struct rom_info {
	char          *name;
	memmap_chunk  *map;
	uint8_t       *save_buffer;
	void          *rom;
	eeprom_map    *eeprom_map;
	char          *port1_override;
	char          *port2_override;
	char          *ext_override;
	char          *mouse_mode;
	uint32_t      num_eeprom;
	uint32_t      map_chunks;
	uint32_t      rom_size;
	uint32_t      save_size;
	uint32_t      save_mask;
	uint32_t      save_page_size;
	uint16_t      save_product_id;
	uint16_t      mapper_start_index;
	uint8_t       save_type;
	uint8_t       save_bus; //only used for NOR currently
	uint8_t       regions;
	uint8_t       is_save_lock_on; //Does the save buffer actually belong to a lock-on cart?
};

#define GAME_ID_OFF 0x183
#define GAME_ID_LEN 8

tern_node *load_rom_db();
rom_info configure_rom(tern_node *rom_db, void *vrom, uint32_t rom_size, void *lock_on, uint32_t lock_on_size, memmap_chunk const *base_map, uint32_t base_chunks);
rom_info configure_rom_heuristics(uint8_t *rom, uint32_t rom_size, memmap_chunk const *base_map, uint32_t base_chunks);
uint8_t translate_region_char(uint8_t c);
char const *save_type_name(uint8_t save_type);
//Note: free_rom_info only frees things pointed to by a rom_info struct, not the struct itself
//this is because rom_info structs are typically stack allocated
void free_rom_info(rom_info *info);

#endif //ROMDB_H_