mame/src/devices/bus/neogeo/slot.h
2016-05-25 08:19:21 +02:00

353 lines
12 KiB
C++

// license:BSD-3-Clause
// copyright-holders:S. Smith,David Haywood,Fabio Priuli
#ifndef __NEOGEO_SLOT_H
#define __NEOGEO_SLOT_H
#include "emu.h"
/* PCB */
enum
{
NEOGEO_STD = 0,
NEOGEO_FATFURY2,
NEOGEO_KOF98,
NEOGEO_MSLUGX,
NEOGEO_ZUPAPA,
NEOGEO_MSLUG3H,
NEOGEO_GANRYU,
NEOGEO_S1945P,
NEOGEO_PREIS2,
NEOGEO_BANGBD,
NEOGEO_NITD,
NEOGEO_SENGOK3,
NEOGEO_KOF99K,
NEOGEO_KOF2K1,
NEOGEO_KOF2KN,
NEOGEO_KOF99,
NEOGEO_GAROU,
NEOGEO_GAROUH,
NEOGEO_MSLUG3,
NEOGEO_KOF2K,
NEOGEO_MSLUG4,
NEOGEO_MSLUG4P,
NEOGEO_ROTD,
NEOGEO_PNYAA,
NEOGEO_KOF2K2,
NEOGEO_MATRIM,
NEOGEO_SAMSHO5,
NEOGEO_SAMSHO5S,
NEOGEO_KOF2K2P,
NEOGEO_MSLUG5,
NEOGEO_SVC,
NEOGEO_KOF2K3,
NEOGEO_KOF2K3H,
NEOGEO_CTHD2K3,
NEOGEO_CT2K3SP,
NEOGEO_CT2K3SA,
NEOGEO_MATRIMBL,
NEOGEO_SVCBOOT,
NEOGEO_SVCPLUS,
NEOGEO_SVCPLUSA,
NEOGEO_SVCSPLUS,
NEOGEO_KOF2K2B,
NEOGEO_KOF2K2MP,
NEOGEO_KOF2K2MP2,
NEOGEO_KOF2K3B,
NEOGEO_KOF2K3P,
NEOGEO_KOF2K3UP,
NEOGEO_GAROUBL,
NEOGEO_KOF97ORO,
NEOGEO_KF10THEP,
NEOGEO_KF2K5UNI,
NEOGEO_KF2K4SE,
NEOGEO_LANS2K4,
NEOGEO_SAMSHO5B,
NEOGEO_MSLUG3B6,
NEOGEO_MSLUG5P,
NEOGEO_KOG,
NEOGEO_SBP,
NEOGEO_KOF10TH,
NEOGEO_VLINER,
NEOGEO_JOCKEYGP,
};
/***************************************************************************
TYPE DEFINITIONS
***************************************************************************/
// ======================> device_neogeo_cart_interface
#define DECRYPT_ALL_PARAMS \
UINT8* cpuregion, UINT32 cpuregion_size,UINT8* spr_region, UINT32 spr_region_size,UINT8* fix_region, UINT32 fix_region_size,UINT8* ym_region, UINT32 ym_region_size,UINT8* ymdelta_region, UINT32 ymdelta_region_size,UINT8* audiocpu_region, UINT32 audio_region_size, UINT8* audiocrypt_region, UINT32 audiocrypt_region_size
class device_neogeo_cart_interface : public device_slot_card_interface
{
public:
// construction/destruction
device_neogeo_cart_interface(const machine_config &mconfig, device_t &device);
virtual ~device_neogeo_cart_interface();
// reading from ROM
virtual DECLARE_READ16_MEMBER(rom_r) { return 0xffff; }
virtual DECLARE_WRITE16_MEMBER(banksel_w) { };
virtual DECLARE_READ16_MEMBER(ram_r) { return 0xffff; }
virtual DECLARE_WRITE16_MEMBER(ram_w) { };
virtual DECLARE_READ16_MEMBER(protection_r) { return 0xffff; }
virtual DECLARE_WRITE16_MEMBER(protection_w) { };
virtual DECLARE_READ16_MEMBER(addon_r) { return 0xffff; }
virtual UINT32 get_bank_base(UINT16 sel) { return 0; }
virtual UINT32 get_special_bank() { return 0; }
virtual UINT16 get_helper() { return 0; }
virtual void decrypt_all(DECRYPT_ALL_PARAMS) { };
virtual int get_fixed_bank_type(void) { return 0; }
void rom_alloc(UINT32 size) { m_rom.resize(size/sizeof(UINT16)); }
UINT16* get_rom_base() { return &m_rom[0]; }
UINT32 get_rom_size() { return m_rom.size() * sizeof(UINT16); }
UINT16* get_region_rom_base() { if (m_region_rom.found()) return &m_region_rom->u16(0); return nullptr; }
UINT32 get_region_rom_size() { if (m_region_rom.found()) return m_region_rom->bytes(); return 0; }
void fixed_alloc(UINT32 size) { m_fixed.resize(size); }
UINT8* get_fixed_base() { return &m_fixed[0]; }
UINT32 get_fixed_size() { return m_fixed.size(); }
UINT8* get_region_fixed_base() { if (m_region_fixed.found()) return m_region_fixed->base(); return nullptr; }
UINT32 get_region_fixed_size() { if (m_region_fixed.found()) return m_region_fixed->bytes(); return 0; }
void audio_alloc(UINT32 size) { m_audio.resize(size); }
UINT8* get_audio_base() { return &m_audio[0]; }
UINT32 get_audio_size() { return m_audio.size(); }
UINT8* get_region_audio_base() { if (m_region_audio.found()) return m_region_audio->base(); return nullptr; }
UINT32 get_region_audio_size() { if (m_region_audio.found()) return m_region_audio->bytes(); return 0; }
void audiocrypt_alloc(UINT32 size) { m_audiocrypt.resize(size); }
UINT8* get_audiocrypt_base() { if (m_audiocrypt.size() == 0) return nullptr; else return &m_audiocrypt[0]; }
UINT32 get_audiocrypt_size() { return m_audiocrypt.size(); }
UINT8* get_region_audiocrypt_base() { if (m_region_audiocrypt.found()) return m_region_audiocrypt->base(); return nullptr; }
UINT32 get_region_audiocrypt_size() { if (m_region_audiocrypt.found()) return m_region_audiocrypt->bytes(); return 0; }
// TODO: review sprite code later!!
void sprites_alloc(UINT32 size) { m_sprites.resize(size); }
UINT8* get_sprites_base() { return &m_sprites[0]; }
UINT32 get_sprites_size() { return m_sprites.size(); }
UINT8* get_region_sprites_base() { if (m_region_spr.found()) return m_region_spr->base(); return nullptr; }
UINT32 get_region_sprites_size() { if (m_region_spr.found()) return m_region_spr->bytes(); return 0; }
void ym_alloc(UINT32 size) { m_ym.resize(size); }
UINT8* get_ym_base() { return &m_ym[0]; }
UINT32 get_ym_size() { return m_ym.size(); }
UINT8* get_region_ym_base() { if (m_region_ym.found()) return m_region_ym->base(); return nullptr; }
UINT32 get_region_ym_size() { if (m_region_ym.found()) return m_region_ym->bytes(); return 0; }
void ymdelta_alloc(UINT32 size) { m_ymdelta.resize(size); }
UINT8* get_ymdelta_base() { return &m_ymdelta[0]; }
UINT32 get_ymdelta_size() { return m_ymdelta.size(); }
UINT8* get_region_ymdelta_base() { if (m_region_ymd.found()) return m_region_ymd->base(); return nullptr; }
UINT32 get_region_ymdelta_size() { if (m_region_ymd.found()) return m_region_ymd->bytes(); return 0; }
// this is only used to setup optimized sprites when loading on multi-slot drivers from softlist
// therefore, we do not need a separate region accessor!
UINT8* get_sprites_opt_base() { return &m_sprites_opt[0]; }
UINT32 get_sprites_opt_size() { return m_sprites_opt.size(); }
void optimize_sprites(UINT8* region_sprites, UINT32 region_sprites_size);
protected:
// these are allocated when loading from softlist
std::vector<UINT16> m_rom;
std::vector<UINT8> m_fixed;
std::vector<UINT8> m_audio;
std::vector<UINT8> m_sprites;
std::vector<UINT8> m_ym;
std::vector<UINT8> m_ymdelta;
std::vector<UINT8> m_audiocrypt;
std::vector<UINT8> m_sprites_opt;
// these replace m_rom, etc. above for non-user configurable carts!
optional_memory_region m_region_rom;
optional_memory_region m_region_fixed;
optional_memory_region m_region_audio;
optional_memory_region m_region_audiocrypt;
optional_memory_region m_region_spr;
optional_memory_region m_region_ym;
optional_memory_region m_region_ymd;
UINT32 get_region_mask(UINT8* rgn, UINT32 rgn_size);
};
// ======================> neogeo_cart_slot_device
class neogeo_cart_slot_device : public device_t,
public device_image_interface,
public device_slot_interface
{
public:
// construction/destruction
neogeo_cart_slot_device(const machine_config &mconfig, const char *tag, device_t *owner, UINT16 clock);
virtual ~neogeo_cart_slot_device();
// device-level overrides
virtual void device_start() override;
virtual void device_config_complete() override;
// image-level overrides
virtual bool call_load() override;
virtual void call_unload() override;
virtual bool call_softlist_load(software_list_device &swlist, const char *swname, const rom_entry *start_entry) override;
virtual iodevice_t image_type() const override { return IO_CARTSLOT; }
virtual bool is_readable() const override { return 1; }
virtual bool is_writeable() const override { return 0; }
virtual bool is_creatable() const override { return 0; }
virtual bool must_be_loaded() const override { return 0; }
virtual bool is_reset_on_load() const override { return 1; }
virtual const option_guide *create_option_guide() const override { return nullptr; }
virtual const char *image_interface() const override { return "neo_cart"; }
virtual const char *file_extensions() const override { return "bin"; }
// slot interface overrides
virtual std::string get_default_card_software() override;
// reading and writing
DECLARE_READ16_MEMBER(rom_r);
DECLARE_WRITE16_MEMBER(banksel_w);
DECLARE_READ16_MEMBER(ram_r);
DECLARE_WRITE16_MEMBER(ram_w);
DECLARE_READ16_MEMBER(protection_r);
DECLARE_WRITE16_MEMBER(protection_w);
DECLARE_READ16_MEMBER(addon_r);
void set_cart_type(const char *slot);
int get_type() { return m_type; }
UINT16* get_rom_base() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_rom_base(); else return m_cart->get_rom_base();
}
return nullptr;
}
UINT32 get_rom_size() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_rom_size(); else return m_cart->get_rom_size();
}
return 0;
}
UINT8* get_fixed_base() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_fixed_base(); else return m_cart->get_fixed_base();
}
return nullptr;
}
UINT32 get_fixed_size() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_fixed_size(); else return m_cart->get_fixed_size();
}
return 0;
}
UINT8* get_sprites_base() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_sprites_base(); else return m_cart->get_sprites_base();
}
return nullptr;
}
UINT32 get_sprites_size() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_sprites_size(); else return m_cart->get_sprites_size();
}
return 0;
}
UINT8* get_audio_base() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_audio_base(); else return m_cart->get_audio_base();
}
return nullptr;
}
UINT32 get_audio_size() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_audio_size(); else return m_cart->get_audio_size();
}
return 0;
}
UINT8* get_audiocrypt_base() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_audiocrypt_base(); else return m_cart->get_audiocrypt_base();
}
return nullptr;
}
UINT32 get_audiocrypt_size() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_audiocrypt_size(); else return m_cart->get_audiocrypt_size();
}
return 0;
}
UINT8* get_ym_base() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_ym_base(); else return m_cart->get_ym_base();
}
return nullptr;
}
UINT32 get_ym_size() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_ym_size(); else return m_cart->get_ym_size();
}
return 0;
}
UINT8* get_ymdelta_base() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_ymdelta_base(); else return m_cart->get_ymdelta_base();
}
return nullptr;
}
UINT32 get_ymdelta_size() {
if (m_cart) {
if (!user_loadable()) return m_cart->get_region_ymdelta_size(); else return m_cart->get_ymdelta_size();
}
return 0;
}
UINT8* get_sprites_opt_base() {
if (m_cart) return m_cart->get_sprites_opt_base(); else return nullptr;
}
UINT32 get_sprites_opt_size() {
if (m_cart) return m_cart->get_sprites_opt_size(); else return 0;
}
int get_fixed_bank_type(void) { if (m_cart) return m_cart->get_fixed_bank_type(); return 0; }
UINT32 get_bank_base(UINT16 sel) { if (m_cart) return m_cart->get_bank_base(sel); return 0; }
UINT32 get_special_bank() { if (m_cart) return m_cart->get_special_bank(); return 0; }
UINT16 get_helper() { if (m_cart) return m_cart->get_helper(); return 0; }
void late_decrypt_all() { if (m_cart) m_cart->decrypt_all(
(UINT8*)get_rom_base(), get_rom_size(),
get_sprites_base(), get_sprites_size(),
get_fixed_base(), get_fixed_size(),
get_ym_base(), get_ym_size(),
get_ymdelta_base(), get_ymdelta_size(),
get_audio_base(), get_audio_size(),
get_audiocrypt_base(), get_audiocrypt_size()); }
private:
int m_type;
device_neogeo_cart_interface* m_cart;
};
// device type definition
extern const device_type NEOGEO_CART_SLOT;
/***************************************************************************
DEVICE CONFIGURATION MACROS
***************************************************************************/
#define MCFG_NEOGEO_CARTRIDGE_ADD(_tag,_slot_intf,_def_slot) \
MCFG_DEVICE_ADD(_tag, NEOGEO_CART_SLOT, 0) \
MCFG_DEVICE_SLOT_INTERFACE(_slot_intf, _def_slot, false)
#endif