/* * funplay.c - Cartridge handling, Fun Play cart. * * Written by * Marco van den Heuvel * * This file is part of VICE, the Versatile Commodore Emulator. * See README for copyright notice. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA * 02111-1307 USA. * */ #include "vice.h" #include #include #define CARTRIDGE_INCLUDE_SLOTMAIN_API #include "c64cartsystem.h" #undef CARTRIDGE_INCLUDE_SLOTMAIN_API #include "c64mem.h" #include "cartio.h" #include "cartridge.h" #include "export.h" #include "funplay.h" #include "log.h" #include "monitor.h" #include "snapshot.h" #include "types.h" #include "util.h" #include "crt.h" /* "Fun Play" and "Power Play" game cartridges the funplay/powerplay carts have 16 banks of ROM at $8000-9FFF, (16*8K=128K) $DE00 is used for bank switching according to the following scheme: $DE00 bit 76543210 xx210xx3 leading to the following values: $00 -> Bank 0 $08 -> Bank 1 $10 -> Bank 2 $18 -> Bank 3 $20 -> Bank 4 $28 -> Bank 5 $30 -> Bank 6 $38 -> Bank 7 $01 -> Bank 8 $09 -> Bank 9 $11 -> Bank 10 $19 -> Bank 11 $21 -> Bank 12 $29 -> Bank 13 $31 -> Bank 14 $39 -> Bank 15 NOTE: as a special case, the "bank" numbers in a CRT file will be like the above register values, and NOT the linear bank number (0..15). bits 7,2,1 = 1, bit 6 = 0 (actual value used is $86) switches off the ROM Note: its unknown if the ROM can be turned on again by writing a different value, or if perhaps game/exrom can be controlled separately. Since both available ROM files work correctly with a standard 8k game config, it is assumed that this config is actually used by the hardware. FIXME: much of the above described behaviour is guesswork, it should get confirmed (and fixed) by someone who owns the cart (and then this message can be removed) */ static int currbank = 0; static uint8_t regval = 0; static void funplay_io1_store(uint16_t addr, uint8_t value) { regval = value; currbank = ((value >> 3) & 7) | ((value & 1) << 3); cart_romlbank_set_slotmain(currbank); if ((value & 0xc6) == 0x00) { /* 8k config */ cart_set_port_exrom_slotmain(1); cart_set_port_game_slotmain(0); } else if ((value & 0xc6) == 0x86) { /* ROMs off */ cart_set_port_exrom_slotmain(0); cart_set_port_game_slotmain(0); } else { log_warning(LOG_DEFAULT, "FUNPLAY: unknown register value\n"); } cart_set_port_phi1_slotmain(0); cart_set_port_phi2_slotmain(0); cart_port_config_changed_slotmain(); /* printf("FUNPLAY: addr: $de%02x value: $%02x bank: $%02x\n", addr, value, currbank); */ } static uint8_t funplay_io1_peek(uint16_t addr) { return regval; } static int funplay_dump(void) { mon_out("Bank: %d\n", currbank); return 0; } /* ---------------------------------------------------------------------*/ static io_source_t funplay_device = { CARTRIDGE_NAME_FUNPLAY, /* name of the device */ IO_DETACH_CART, /* use cartridge ID to detach the device when involved in a read-collision */ IO_DETACH_NO_RESOURCE, /* does not use a resource for detach */ 0xde00, 0xdeff, 0xff, /* range for the device, address is ignored, reg:$de00, mirrors:$de01-$deff */ 0, /* read is never valid, reg is write only */ funplay_io1_store, /* store function */ NULL, /* NO poke function */ NULL, /* NO read function */ funplay_io1_peek, /* peek function */ funplay_dump, /* device state information dump function */ CARTRIDGE_FUNPLAY, /* cartridge ID */ IO_PRIO_NORMAL, /* normal priority, device read needs to be checked for collisions */ 0, /* insertion order, gets filled in by the registration function */ IO_MIRROR_NONE /* NO mirroring */ }; static io_source_list_t *funplay_list_item = NULL; static const export_resource_t export_res = { CARTRIDGE_NAME_FUNPLAY, 0, 1, &funplay_device, NULL, CARTRIDGE_FUNPLAY }; /* ---------------------------------------------------------------------*/ void funplay_config_init(void) { /* 8k configuration */ cart_config_changed_slotmain(CMODE_8KGAME, CMODE_8KGAME, CMODE_READ); funplay_io1_store((uint16_t)0xde00, 0); } void funplay_config_setup(uint8_t *rawcart) { memcpy(roml_banks, rawcart, 0x2000 * 16); /* 8k configuration */ cart_config_changed_slotmain(CMODE_8KGAME, CMODE_8KGAME, CMODE_READ); } /* ---------------------------------------------------------------------*/ static int funplay_common_attach(void) { if (export_add(&export_res) < 0) { return -1; } funplay_list_item = io_source_register(&funplay_device); return 0; } int funplay_bin_attach(const char *filename, uint8_t *rawcart) { /* in a binary the banks are linear as usual */ if (util_file_load(filename, rawcart, 0x20000, UTIL_FILE_LOAD_SKIP_ADDRESS) < 0) { return -1; } return funplay_common_attach(); } int funplay_crt_attach(FILE *fd, uint8_t *rawcart) { crt_chip_header_t chip; unsigned int bank; while (1) { if (crt_read_chip_header(&chip, fd)) { break; } bank = (((chip.bank >> 3) & 7) | ((chip.bank & 1) << 3)); if ((bank > 15) || (chip.start != 0x8000) || (chip.size != 0x2000)) { return -1; } /* * CAUTION: the bank values in the CRT file are not the actual bank, but the * value written to the i/o register as described above. */ if (crt_read_chip(rawcart, bank << 13, &chip, fd)) { return -1; } } return funplay_common_attach(); } void funplay_detach(void) { io_source_unregister(funplay_list_item); funplay_list_item = NULL; export_remove(&export_res); } /* ---------------------------------------------------------------------*/ /* CARTFUNPLAY snapshot module format: type | name | version | description -------------------------------------- BYTE | regval | 1.1 | register BYTE | bank | 0.0+ | current bank ARRAY | ROML | 1.0+ | 131072 BYTES of ROML data Note: 0.0 is incompatible with 1.0+ snapshots. */ static const char snap_module_name[] = "CARTFUNPLAY"; #define SNAP_MAJOR 1 #define SNAP_MINOR 1 int funplay_snapshot_write_module(snapshot_t *s) { snapshot_module_t *m; m = snapshot_module_create(s, snap_module_name, SNAP_MAJOR, SNAP_MINOR); if (m == NULL) { return -1; } if (0 || SMW_B(m, regval) < 0 || SMW_B(m, (uint8_t)currbank) < 0 || SMW_BA(m, roml_banks, 0x2000 * 16) < 0) { snapshot_module_close(m); return -1; } return snapshot_module_close(m); } int funplay_snapshot_read_module(snapshot_t *s) { uint8_t vmajor, vminor; snapshot_module_t *m; m = snapshot_module_open(s, snap_module_name, &vmajor, &vminor); if (m == NULL) { return -1; } /* Do not accept versions higher than current */ if (snapshot_version_is_bigger(vmajor, vminor, SNAP_MAJOR, SNAP_MINOR)) { snapshot_set_error(SNAPSHOT_MODULE_HIGHER_VERSION); goto fail; } /* Only accept compatible snapshots */ if (snapshot_version_is_smaller(vmajor, vminor, 1, 0)) { snapshot_set_error(SNAPSHOT_MODULE_INCOMPATIBLE); goto fail; } /* new in 1.1 */ if (!snapshot_version_is_smaller(vmajor, vminor, 1, 1)) { if (SMR_B(m, ®val) < 0) { goto fail; } } else { regval = 0; } if (0 || SMR_B_INT(m, &currbank) < 0 || SMR_BA(m, roml_banks, 0x2000 * 16) < 0) { goto fail; } snapshot_module_close(m); return funplay_common_attach(); fail: snapshot_module_close(m); return -1; }