mirror of
https://github.com/holub/mame
synced 2025-05-22 21:58:57 +03:00
bd598da61f
form systemname_biosnum.nv in cases when non-default bios is used. For default bios selection all stay the same.
334 lines
15 KiB
C++
334 lines
15 KiB
C++
/*********************************************************************
|
|
|
|
romload.h
|
|
|
|
ROM loading functions.
|
|
|
|
Copyright Nicola Salmoria and the MAME Team.
|
|
Visit http://mamedev.org for licensing and usage restrictions.
|
|
|
|
*********************************************************************/
|
|
|
|
#pragma once
|
|
|
|
#ifndef __EMU_H__
|
|
#error Dont include this file directly; include emu.h instead.
|
|
#endif
|
|
|
|
#ifndef __ROMLOAD_H__
|
|
#define __ROMLOAD_H__
|
|
|
|
|
|
|
|
/***************************************************************************
|
|
CONSTANTS
|
|
***************************************************************************/
|
|
|
|
/* ----- type constants ----- */
|
|
#define ROMENTRY_TYPEMASK 0x0000000f /* type of entry */
|
|
enum
|
|
{
|
|
ROMENTRYTYPE_ROM = 0, /* this entry is an actual ROM definition */
|
|
ROMENTRYTYPE_REGION, /* this entry marks the start of a region */
|
|
ROMENTRYTYPE_END, /* this entry marks the end of a region */
|
|
ROMENTRYTYPE_RELOAD, /* this entry reloads the previous ROM */
|
|
ROMENTRYTYPE_CONTINUE, /* this entry continues loading the previous ROM */
|
|
ROMENTRYTYPE_FILL, /* this entry fills an area with a constant value */
|
|
ROMENTRYTYPE_COPY, /* this entry copies data from another region/offset */
|
|
ROMENTRYTYPE_CARTRIDGE, /* this entry specifies a cartridge (MESS) */
|
|
ROMENTRYTYPE_IGNORE, /* this entry continues loading the previous ROM but throws the data away */
|
|
ROMENTRYTYPE_SYSTEM_BIOS, /* this entry specifies a bios */
|
|
ROMENTRYTYPE_DEFAULT_BIOS, /* this entry specifies a default bios */
|
|
ROMENTRYTYPE_COUNT
|
|
};
|
|
|
|
/* ----- per-region constants ----- */
|
|
#define ROMREGION_WIDTHMASK 0x00000300 /* native width of region, as power of 2 */
|
|
#define ROMREGION_8BIT 0x00000000 /* (non-CPU regions only) */
|
|
#define ROMREGION_16BIT 0x00000100
|
|
#define ROMREGION_32BIT 0x00000200
|
|
#define ROMREGION_64BIT 0x00000300
|
|
|
|
#define ROMREGION_ENDIANMASK 0x00000400 /* endianness of the region */
|
|
#define ROMREGION_LE 0x00000000 /* (non-CPU regions only) */
|
|
#define ROMREGION_BE 0x00000400
|
|
|
|
#define ROMREGION_INVERTMASK 0x00000800 /* invert the bits of the region */
|
|
#define ROMREGION_NOINVERT 0x00000000
|
|
#define ROMREGION_INVERT 0x00000800
|
|
|
|
#define ROMREGION_ERASEMASK 0x00002000 /* erase the region before loading */
|
|
#define ROMREGION_NOERASE 0x00000000
|
|
#define ROMREGION_ERASE 0x00002000
|
|
|
|
#define ROMREGION_DATATYPEMASK 0x00004000 /* type of region (ROM versus disk) */
|
|
#define ROMREGION_DATATYPEROM 0x00000000
|
|
#define ROMREGION_DATATYPEDISK 0x00004000
|
|
|
|
#define ROMREGION_LOADBYNAMEMASK 0x00008000 /* use region name as path to read from */
|
|
#define ROMREGION_NOLOADBYNAME 0x00000000
|
|
#define ROMREGION_LOADBYNAME 0x00008000
|
|
|
|
#define ROMREGION_ERASEVALMASK 0x00ff0000 /* value to erase the region to */
|
|
#define ROMREGION_ERASEVAL(x) ((((x) & 0xff) << 16) | ROMREGION_ERASE)
|
|
#define ROMREGION_ERASE00 ROMREGION_ERASEVAL(0)
|
|
#define ROMREGION_ERASEFF ROMREGION_ERASEVAL(0xff)
|
|
|
|
|
|
/* ----- per-ROM constants ----- */
|
|
#define DISK_READONLYMASK 0x00000010 /* is the disk read-only? */
|
|
#define DISK_READWRITE 0x00000000
|
|
#define DISK_READONLY 0x00000010
|
|
|
|
#define ROM_OPTIONALMASK 0x00000020 /* optional - won't hurt if it's not there */
|
|
#define ROM_REQUIRED 0x00000000
|
|
#define ROM_OPTIONAL 0x00000020
|
|
|
|
#define ROM_REVERSEMASK 0x00000040 /* reverse the byte order within a group */
|
|
#define ROM_NOREVERSE 0x00000000
|
|
#define ROM_REVERSE 0x00000040
|
|
|
|
#define ROM_INHERITFLAGSMASK 0x00000080 /* inherit all flags from previous definition */
|
|
#define ROM_INHERITFLAGS 0x00000080
|
|
|
|
#define ROM_GROUPMASK 0x00000f00 /* load data in groups of this size + 1 */
|
|
#define ROM_GROUPSIZE(n) ((((n) - 1) & 15) << 8)
|
|
#define ROM_GROUPBYTE ROM_GROUPSIZE(1)
|
|
#define ROM_GROUPWORD ROM_GROUPSIZE(2)
|
|
#define ROM_GROUPDWORD ROM_GROUPSIZE(4)
|
|
|
|
#define ROM_SKIPMASK 0x0000f000 /* skip this many bytes after each group */
|
|
#define ROM_SKIP(n) (((n) & 15) << 12)
|
|
#define ROM_NOSKIP ROM_SKIP(0)
|
|
|
|
#define ROM_BITWIDTHMASK 0x000f0000 /* width of data in bits */
|
|
#define ROM_BITWIDTH(n) (((n) & 15) << 16)
|
|
#define ROM_NIBBLE ROM_BITWIDTH(4)
|
|
#define ROM_FULLBYTE ROM_BITWIDTH(8)
|
|
|
|
#define ROM_BITSHIFTMASK 0x00f00000 /* left-shift count for the bits */
|
|
#define ROM_BITSHIFT(n) (((n) & 15) << 20)
|
|
#define ROM_NOSHIFT ROM_BITSHIFT(0)
|
|
#define ROM_SHIFT_NIBBLE_LO ROM_BITSHIFT(0)
|
|
#define ROM_SHIFT_NIBBLE_HI ROM_BITSHIFT(4)
|
|
|
|
#define ROM_BIOSFLAGSMASK 0xff000000 /* only loaded if value matches global bios value */
|
|
#define ROM_BIOS(n) (((n) & 255) << 24)
|
|
|
|
#define ROM_INHERITEDFLAGS (ROM_GROUPMASK | ROM_SKIPMASK | ROM_REVERSEMASK | ROM_BITWIDTHMASK | ROM_BITSHIFTMASK | ROM_BIOSFLAGSMASK)
|
|
|
|
|
|
|
|
/***************************************************************************
|
|
TYPE DEFINITIONS
|
|
***************************************************************************/
|
|
|
|
class machine_config;
|
|
class emu_options;
|
|
|
|
typedef device_t rom_source;
|
|
|
|
|
|
struct rom_entry
|
|
{
|
|
const char * _name; /* name of the file to load */
|
|
const char * _hashdata; /* hashing informations (checksums) */
|
|
UINT32 _offset; /* offset to load it to */
|
|
UINT32 _length; /* length of the file */
|
|
UINT32 _flags; /* flags */
|
|
};
|
|
|
|
|
|
|
|
/***************************************************************************
|
|
MACROS
|
|
***************************************************************************/
|
|
|
|
/* ----- per-entry macros ----- */
|
|
#define ROMENTRY_GETTYPE(r) ((r)->_flags & ROMENTRY_TYPEMASK)
|
|
#define ROMENTRY_ISSPECIAL(r) (ROMENTRY_GETTYPE(r) != ROMENTRYTYPE_ROM)
|
|
#define ROMENTRY_ISFILE(r) (ROMENTRY_GETTYPE(r) == ROMENTRYTYPE_ROM)
|
|
#define ROMENTRY_ISREGION(r) (ROMENTRY_GETTYPE(r) == ROMENTRYTYPE_REGION)
|
|
#define ROMENTRY_ISEND(r) (ROMENTRY_GETTYPE(r) == ROMENTRYTYPE_END)
|
|
#define ROMENTRY_ISRELOAD(r) (ROMENTRY_GETTYPE(r) == ROMENTRYTYPE_RELOAD)
|
|
#define ROMENTRY_ISCONTINUE(r) (ROMENTRY_GETTYPE(r) == ROMENTRYTYPE_CONTINUE)
|
|
#define ROMENTRY_ISFILL(r) (ROMENTRY_GETTYPE(r) == ROMENTRYTYPE_FILL)
|
|
#define ROMENTRY_ISCOPY(r) (ROMENTRY_GETTYPE(r) == ROMENTRYTYPE_COPY)
|
|
#define ROMENTRY_ISIGNORE(r) (ROMENTRY_GETTYPE(r) == ROMENTRYTYPE_IGNORE)
|
|
#define ROMENTRY_ISSYSTEM_BIOS(r) (ROMENTRY_GETTYPE(r) == ROMENTRYTYPE_SYSTEM_BIOS)
|
|
#define ROMENTRY_ISDEFAULT_BIOS(r) (ROMENTRY_GETTYPE(r) == ROMENTRYTYPE_DEFAULT_BIOS)
|
|
#define ROMENTRY_ISREGIONEND(r) (ROMENTRY_ISREGION(r) || ROMENTRY_ISEND(r))
|
|
|
|
/* ----- per-region macros ----- */
|
|
#define ROMREGION_GETTAG(r) ((r)->_name)
|
|
#define ROMREGION_GETLENGTH(r) ((r)->_length)
|
|
#define ROMREGION_GETFLAGS(r) ((r)->_flags)
|
|
#define ROMREGION_GETWIDTH(r) (8 << ((ROMREGION_GETFLAGS(r) & ROMREGION_WIDTHMASK) >> 8))
|
|
#define ROMREGION_ISLITTLEENDIAN(r) ((ROMREGION_GETFLAGS(r) & ROMREGION_ENDIANMASK) == ROMREGION_LE)
|
|
#define ROMREGION_ISBIGENDIAN(r) ((ROMREGION_GETFLAGS(r) & ROMREGION_ENDIANMASK) == ROMREGION_BE)
|
|
#define ROMREGION_ISINVERTED(r) ((ROMREGION_GETFLAGS(r) & ROMREGION_INVERTMASK) == ROMREGION_INVERT)
|
|
#define ROMREGION_ISERASE(r) ((ROMREGION_GETFLAGS(r) & ROMREGION_ERASEMASK) == ROMREGION_ERASE)
|
|
#define ROMREGION_GETERASEVAL(r) ((ROMREGION_GETFLAGS(r) & ROMREGION_ERASEVALMASK) >> 16)
|
|
#define ROMREGION_GETDATATYPE(r) (ROMREGION_GETFLAGS(r) & ROMREGION_DATATYPEMASK)
|
|
#define ROMREGION_ISROMDATA(r) (ROMREGION_GETDATATYPE(r) == ROMREGION_DATATYPEROM)
|
|
#define ROMREGION_ISDISKDATA(r) (ROMREGION_GETDATATYPE(r) == ROMREGION_DATATYPEDISK)
|
|
#define ROMREGION_ISLOADBYNAME(r) ((ROMREGION_GETFLAGS(r) & ROMREGION_LOADBYNAMEMASK) == ROMREGION_LOADBYNAME)
|
|
|
|
|
|
/* ----- per-ROM macros ----- */
|
|
#define ROM_GETNAME(r) ((r)->_name)
|
|
#define ROM_SAFEGETNAME(r) (ROMENTRY_ISFILL(r) ? "fill" : ROMENTRY_ISCOPY(r) ? "copy" : ROM_GETNAME(r))
|
|
#define ROM_GETOFFSET(r) ((r)->_offset)
|
|
#define ROM_GETLENGTH(r) ((r)->_length)
|
|
#define ROM_GETFLAGS(r) ((r)->_flags)
|
|
#define ROM_GETHASHDATA(r) ((r)->_hashdata)
|
|
#define ROM_ISOPTIONAL(r) ((ROM_GETFLAGS(r) & ROM_OPTIONALMASK) == ROM_OPTIONAL)
|
|
#define ROM_GETGROUPSIZE(r) (((ROM_GETFLAGS(r) & ROM_GROUPMASK) >> 8) + 1)
|
|
#define ROM_GETSKIPCOUNT(r) ((ROM_GETFLAGS(r) & ROM_SKIPMASK) >> 12)
|
|
#define ROM_ISREVERSED(r) ((ROM_GETFLAGS(r) & ROM_REVERSEMASK) == ROM_REVERSE)
|
|
#define ROM_GETBITWIDTH(r) (((ROM_GETFLAGS(r) & ROM_BITWIDTHMASK) >> 16) + 8 * ((ROM_GETFLAGS(r) & ROM_BITWIDTHMASK) == 0))
|
|
#define ROM_GETBITSHIFT(r) ((ROM_GETFLAGS(r) & ROM_BITSHIFTMASK) >> 20)
|
|
#define ROM_INHERITSFLAGS(r) ((ROM_GETFLAGS(r) & ROM_INHERITFLAGSMASK) == ROM_INHERITFLAGS)
|
|
#define ROM_GETBIOSFLAGS(r) ((ROM_GETFLAGS(r) & ROM_BIOSFLAGSMASK) >> 24)
|
|
|
|
|
|
/* ----- per-disk macros ----- */
|
|
#define DISK_GETINDEX(r) ((r)->_offset)
|
|
#define DISK_ISREADONLY(r) ((ROM_GETFLAGS(r) & DISK_READONLYMASK) == DISK_READONLY)
|
|
#define DISK_ISOPTIONAL(r) ((ROM_GETFLAGS(r) & ROM_OPTIONALMASK) == ROM_OPTIONAL)
|
|
|
|
|
|
/* ----- start/stop macros ----- */
|
|
#define ROM_NAME(name) rom_##name
|
|
#define ROM_START(name) static const rom_entry ROM_NAME(name)[] = {
|
|
#define ROM_END { NULL, NULL, 0, 0, ROMENTRYTYPE_END } };
|
|
|
|
|
|
/* ----- ROM region macros ----- */
|
|
#define ROM_REGION(length,tag,flags) { tag, NULL, 0, length, ROMENTRYTYPE_REGION | (flags) },
|
|
#define ROM_REGION16_LE(length,tag,flags) ROM_REGION(length, tag, (flags) | ROMREGION_16BIT | ROMREGION_LE)
|
|
#define ROM_REGION16_BE(length,tag,flags) ROM_REGION(length, tag, (flags) | ROMREGION_16BIT | ROMREGION_BE)
|
|
#define ROM_REGION32_LE(length,tag,flags) ROM_REGION(length, tag, (flags) | ROMREGION_32BIT | ROMREGION_LE)
|
|
#define ROM_REGION32_BE(length,tag,flags) ROM_REGION(length, tag, (flags) | ROMREGION_32BIT | ROMREGION_BE)
|
|
#define ROM_REGION64_LE(length,tag,flags) ROM_REGION(length, tag, (flags) | ROMREGION_64BIT | ROMREGION_LE)
|
|
#define ROM_REGION64_BE(length,tag,flags) ROM_REGION(length, tag, (flags) | ROMREGION_64BIT | ROMREGION_BE)
|
|
|
|
|
|
/* ----- core ROM loading macros ----- */
|
|
#define ROMX_LOAD(name,offset,length,hash,flags) { name, hash, offset, length, ROMENTRYTYPE_ROM | (flags) },
|
|
#define ROM_LOAD(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, 0)
|
|
#define ROM_LOAD_OPTIONAL(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, ROM_OPTIONAL)
|
|
|
|
|
|
/* ----- specialized loading macros ----- */
|
|
#define ROM_LOAD_NIB_HIGH(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, ROM_NIBBLE | ROM_SHIFT_NIBBLE_HI)
|
|
#define ROM_LOAD_NIB_LOW(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, ROM_NIBBLE | ROM_SHIFT_NIBBLE_LO)
|
|
#define ROM_LOAD16_BYTE(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, ROM_SKIP(1))
|
|
#define ROM_LOAD16_WORD(name,offset,length,hash) ROM_LOAD(name, offset, length, hash)
|
|
#define ROM_LOAD16_WORD_SWAP(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, ROM_GROUPWORD | ROM_REVERSE)
|
|
#define ROM_LOAD32_BYTE(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, ROM_SKIP(3))
|
|
#define ROM_LOAD32_WORD(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, ROM_GROUPWORD | ROM_SKIP(2))
|
|
#define ROM_LOAD32_WORD_SWAP(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, ROM_GROUPWORD | ROM_REVERSE | ROM_SKIP(2))
|
|
#define ROM_LOAD32_DWORD(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, ROM_GROUPDWORD)
|
|
#define ROM_LOAD64_WORD(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, ROM_GROUPWORD | ROM_SKIP(6))
|
|
#define ROM_LOAD64_WORD_SWAP(name,offset,length,hash) ROMX_LOAD(name, offset, length, hash, ROM_GROUPWORD | ROM_REVERSE | ROM_SKIP(6))
|
|
|
|
|
|
/* ----- ROM_RELOAD related macros ----- */
|
|
#define ROM_RELOAD(offset,length) { NULL, NULL, offset, length, ROMENTRYTYPE_RELOAD | ROM_INHERITFLAGS },
|
|
#define ROM_RELOAD_PLAIN(offset,length) { NULL, NULL, offset, length, ROMENTRYTYPE_RELOAD },
|
|
|
|
/* ----- additional ROM-related macros ----- */
|
|
#define ROM_CONTINUE(offset,length) { NULL, NULL, offset, length, ROMENTRYTYPE_CONTINUE | ROM_INHERITFLAGS },
|
|
#define ROM_IGNORE(length) { NULL, NULL, 0, length, ROMENTRYTYPE_IGNORE | ROM_INHERITFLAGS },
|
|
#define ROM_FILL(offset,length,value) { NULL, (const char *)value, offset, length, ROMENTRYTYPE_FILL },
|
|
#define ROM_COPY(srctag,srcoffs,offset,length) { srctag, (const char *)srcoffs, offset, length, ROMENTRYTYPE_COPY },
|
|
|
|
|
|
/* ----- system BIOS macros ----- */
|
|
#define ROM_SYSTEM_BIOS(value,name,description) { name, description, 0, 0, ROMENTRYTYPE_SYSTEM_BIOS | ROM_BIOS(value+1) },
|
|
#define ROM_DEFAULT_BIOS(name) { name, NULL, 0, 0, ROMENTRYTYPE_DEFAULT_BIOS },
|
|
|
|
|
|
/* ----- disk loading macros ----- */
|
|
#define DISK_REGION(tag) ROM_REGION(1, tag, ROMREGION_DATATYPEDISK)
|
|
#define DISK_IMAGE(name,idx,hash) ROMX_LOAD(name, idx, 0, hash, DISK_READWRITE)
|
|
#define DISK_IMAGE_READONLY(name,idx,hash) ROMX_LOAD(name, idx, 0, hash, DISK_READONLY)
|
|
#define DISK_IMAGE_READONLY_OPTIONAL(name,idx,hash) ROMX_LOAD(name, idx, 0, hash, DISK_READONLY | ROM_OPTIONAL)
|
|
|
|
|
|
|
|
/***************************************************************************
|
|
FUNCTION PROTOTYPES
|
|
***************************************************************************/
|
|
|
|
|
|
/* ----- ROM processing ----- */
|
|
|
|
/* load the ROMs and open the disk images associated with the given machine */
|
|
void rom_init(running_machine &machine);
|
|
|
|
/* return the number of warnings we generated */
|
|
int rom_load_warnings(running_machine &machine);
|
|
|
|
/* return the number of BAD_DUMP/NO_DUMP warnings we generated */
|
|
int rom_load_knownbad(running_machine &machine);
|
|
|
|
/* return id of selected bios */
|
|
int rom_system_bios(running_machine &machine);
|
|
|
|
/* return id of default bios */
|
|
int rom_default_bios(running_machine &machine);
|
|
|
|
/* ----- Helpers ----- */
|
|
|
|
file_error common_process_file(emu_options &options, const char *location, const char *ext, const rom_entry *romp, emu_file **image_file);
|
|
file_error common_process_file(emu_options &options, const char *location, bool has_crc, UINT32 crc, const rom_entry *romp, emu_file **image_file);
|
|
|
|
|
|
/* ----- ROM iteration ----- */
|
|
|
|
/* return pointer to first ROM source */
|
|
const rom_source *rom_first_source(const machine_config &config);
|
|
|
|
/* return pointer to next ROM source */
|
|
const rom_source *rom_next_source(const rom_source &previous);
|
|
|
|
/* return pointer to the first ROM region within a source */
|
|
const rom_entry *rom_first_region(const rom_source &romp);
|
|
|
|
/* return pointer to the next ROM region within a source */
|
|
const rom_entry *rom_next_region(const rom_entry *romp);
|
|
|
|
/* return pointer to the first ROM file within a region */
|
|
const rom_entry *rom_first_file(const rom_entry *romp);
|
|
|
|
/* return pointer to the next ROM file within a region */
|
|
const rom_entry *rom_next_file(const rom_entry *romp);
|
|
|
|
/* return TRUE if the given rom_source refers to the game driver itself */
|
|
int rom_source_is_gamedrv(const game_driver *drv, const rom_source *source);
|
|
|
|
/* return the expected size of a file given the ROM description */
|
|
UINT32 rom_file_size(const rom_entry *romp);
|
|
|
|
/* return the appropriate name for a rom region */
|
|
astring &rom_region_name(astring &result, const game_driver *drv, const rom_source *source, const rom_entry *romp);
|
|
|
|
|
|
|
|
/* ----- disk handling ----- */
|
|
|
|
/* open a disk image, searching up the parent and loading by checksum */
|
|
chd_error open_disk_image(emu_options &options, const game_driver *gamedrv, const rom_entry *romp, emu_file **image_file, chd_file **image_chd,const char *locationtag);
|
|
|
|
/* return a pointer to the CHD file associated with the given region */
|
|
chd_file *get_disk_handle(running_machine &machine, const char *region);
|
|
|
|
/* set a pointer to the CHD file associated with the given region */
|
|
void set_disk_handle(running_machine &machine, const char *region, emu_file &file, chd_file &chdfile);
|
|
|
|
void load_software_part_region(device_t *device, char *swlist, char *swname, rom_entry *start_region);
|
|
|
|
#endif /* __ROMLOAD_H__ */
|