use crate::cartridge::BaseMapper;
use crate::cartridge::{Mapper, MapperCapabilities, NametableLayout};
pub struct TaitoTc0190Mapper {
base: BaseMapper,
mirroring: NametableLayout,
prg_bank: [u8; 2],
chr_bank_2k: [u8; 2],
chr_bank_1k: [u8; 4],
}
impl TaitoTc0190Mapper {
const REGISTER_MASK: u16 = 0xA003;
pub fn new(ctx: super::mapper::MapperContext) -> Self {
let mirroring = ctx.mirroring;
let capabilities = MapperCapabilities {
has_irq: false,
has_chr_banking: true,
has_dynamic_mirroring: true,
has_expansion_audio: false,
max_prg_ram_kb: 8,
prg_bank_size_kb: 8,
chr_bank_size_kb: 1,
trainer_jsr: false,
..Default::default()
};
let mut base = BaseMapper::new(&ctx, capabilities);
base.configure_prg_banking(0x2000); base.configure_chr_banking(0x0400); let mut mapper = Self {
base,
mirroring,
prg_bank: [0; 2],
chr_bank_2k: [0; 2],
chr_bank_1k: [0; 4],
};
mapper.update_banks();
mapper
}
fn update_banks(&mut self) {
self.base.select_prg_page(0, self.prg_bank[0] as i16);
self.base.select_prg_page(1, self.prg_bank[1] as i16);
self.base.select_prg_page(2, -2); self.base.select_prg_page(3, -1);
let b2k0 = self.chr_bank_2k[0] as i16 * 2;
let b2k1 = self.chr_bank_2k[1] as i16 * 2;
self.base.select_chr_page(0, b2k0);
self.base.select_chr_page(1, b2k0 + 1);
self.base.select_chr_page(2, b2k1);
self.base.select_chr_page(3, b2k1 + 1);
self.base.select_chr_page(4, self.chr_bank_1k[0] as i16);
self.base.select_chr_page(5, self.chr_bank_1k[1] as i16);
self.base.select_chr_page(6, self.chr_bank_1k[2] as i16);
self.base.select_chr_page(7, self.chr_bank_1k[3] as i16);
self.base.set_mirroring(self.mirroring);
}
}
impl Mapper for TaitoTc0190Mapper {
fn base(&self) -> &BaseMapper {
&self.base
}
fn base_mut(&mut self) -> &mut BaseMapper {
&mut self.base
}
fn write_prg(&mut self, addr: u16, value: u8) {
if self.base.try_write_prg_ram(addr, value) {
return;
}
if (0x8000..=0xBFFF).contains(&addr) {
match addr & Self::REGISTER_MASK {
0x8000 => {
self.prg_bank[0] = value & 0x3F;
self.mirroring = if (value & 0x40) != 0 {
NametableLayout::Horizontal
} else {
NametableLayout::Vertical
};
self.update_banks();
}
0x8001 => {
self.prg_bank[1] = value & 0x3F;
self.update_banks();
}
0x8002 => {
self.chr_bank_2k[0] = value;
self.update_banks();
}
0x8003 => {
self.chr_bank_2k[1] = value;
self.update_banks();
}
0xA000 => {
self.chr_bank_1k[0] = value;
self.update_banks();
}
0xA001 => {
self.chr_bank_1k[1] = value;
self.update_banks();
}
0xA002 => {
self.chr_bank_1k[2] = value;
self.update_banks();
}
0xA003 => {
self.chr_bank_1k[3] = value;
self.update_banks();
}
_ => {}
}
}
}
fn registers_snapshot(&self) -> Vec<u8> {
let mut snap = Vec::with_capacity(9);
snap.push(if self.mirroring == NametableLayout::Horizontal {
1
} else {
0
});
snap.extend_from_slice(&self.prg_bank);
snap.extend_from_slice(&self.chr_bank_2k);
snap.extend_from_slice(&self.chr_bank_1k);
snap
}
fn restore_registers(&mut self, data: &[u8]) {
if data.len() >= 9 {
self.mirroring = if data[0] != 0 {
NametableLayout::Horizontal
} else {
NametableLayout::Vertical
};
self.prg_bank.copy_from_slice(&data[1..3]);
self.chr_bank_2k.copy_from_slice(&data[3..5]);
self.chr_bank_1k.copy_from_slice(&data[5..9]);
self.update_banks();
}
}
}
#[cfg(test)]
mod tests {
use crate::cartridge::NametableLayout;
use crate::cartridge::mapper::{Mapper, MapperContext, create_mapper};
use crate::cartridge::taito_tc0190::TaitoTc0190Mapper;
use crate::cartridge::test_helpers::banked_data;
fn create_tc0190(
prg_rom: Vec<u8>,
chr_rom: Vec<u8>,
mirroring: NametableLayout,
) -> std::io::Result<Box<dyn Mapper>> {
create_mapper(MapperContext::new_for_test(33, prg_rom, chr_rom, mirroring))
}
#[test]
fn prg_bank0_is_switchable_at_8000() {
let prg_rom = banked_data(8 * 1024, 6);
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8000, 2); assert_eq!(mapper.read_prg(0x8000), 2);
assert_eq!(mapper.read_prg(0x9FFF), 2);
mapper.write_prg(0x8000, 3); assert_eq!(mapper.read_prg(0x8000), 3);
}
#[test]
fn prg_bank1_is_switchable_at_a000() {
let prg_rom = banked_data(8 * 1024, 6);
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8001, 1); assert_eq!(mapper.read_prg(0xA000), 1);
assert_eq!(mapper.read_prg(0xBFFF), 1);
mapper.write_prg(0x8001, 4);
assert_eq!(mapper.read_prg(0xA000), 4);
}
#[test]
fn prg_c000_is_fixed_to_second_last_bank() {
let prg_rom = banked_data(8 * 1024, 6); let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8000, 0);
mapper.write_prg(0x8001, 0);
assert_eq!(mapper.read_prg(0xC000), 4); assert_eq!(mapper.read_prg(0xDFFF), 4);
}
#[test]
fn prg_e000_is_fixed_to_last_bank() {
let prg_rom = banked_data(8 * 1024, 6); let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8000, 0);
mapper.write_prg(0x8001, 0);
assert_eq!(mapper.read_prg(0xE000), 5); assert_eq!(mapper.read_prg(0xFFFF), 5);
}
#[test]
fn prg_bank0_bit6_is_not_used_for_banking() {
let prg_rom = banked_data(8 * 1024, 3); let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8000, 0x41);
assert_eq!(mapper.read_prg(0x8000), 1);
}
#[test]
fn chr_2k_bank0_switchable_at_0000() {
let prg_rom = banked_data(8 * 1024, 2);
let chr_rom = banked_data(2 * 1024, 3);
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8002, 1); assert_eq!(mapper.read_chr(0x0000), 1);
assert_eq!(mapper.read_chr(0x07FF), 1);
}
#[test]
fn chr_2k_bank1_switchable_at_0800() {
let prg_rom = banked_data(8 * 1024, 2);
let chr_rom = banked_data(2 * 1024, 3);
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8003, 2); assert_eq!(mapper.read_chr(0x0800), 2);
assert_eq!(mapper.read_chr(0x0FFF), 2);
}
#[test]
fn chr_2k_bank_value_is_2kb_multiple_not_1kb() {
let prg_rom = banked_data(8 * 1024, 2);
let chr_rom = banked_data(2 * 1024, 5);
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8002, 3);
assert_eq!(mapper.read_chr(0x0000), 3);
}
#[test]
fn chr_1k_banks_switchable_at_1000_to_1c00() {
let prg_rom = banked_data(8 * 1024, 2);
let chr_rom = banked_data(1024, 48);
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0xA000, 10); mapper.write_prg(0xA001, 20); mapper.write_prg(0xA002, 30); mapper.write_prg(0xA003, 40);
assert_eq!(mapper.read_chr(0x1000), 10);
assert_eq!(mapper.read_chr(0x1400), 20);
assert_eq!(mapper.read_chr(0x1800), 30);
assert_eq!(mapper.read_chr(0x1C00), 40);
}
#[test]
fn chr_windows_do_not_alias_each_other() {
let prg_rom = banked_data(8 * 1024, 2);
let chr_rom = banked_data(1024, 48);
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8002, 0); mapper.write_prg(0x8003, 1); mapper.write_prg(0xA000, 2); mapper.write_prg(0xA001, 3); mapper.write_prg(0xA002, 4); mapper.write_prg(0xA003, 5);
assert_eq!(mapper.read_chr(0x0000), 0);
assert_eq!(mapper.read_chr(0x0800), 2); assert_eq!(mapper.read_chr(0x1000), 2);
assert_eq!(mapper.read_chr(0x1400), 3);
assert_eq!(mapper.read_chr(0x1800), 4);
assert_eq!(mapper.read_chr(0x1C00), 5);
}
#[test]
fn mirroring_bit6_zero_selects_vertical() {
let prg_rom = banked_data(8 * 1024, 2);
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Horizontal)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8000, 0x00); assert_eq!(mapper.get_mirroring(), NametableLayout::Vertical);
}
#[test]
fn mirroring_bit6_one_selects_horizontal() {
let prg_rom = banked_data(8 * 1024, 2);
let chr_rom = vec![0; 8 * 1024];
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8000, 0x40); assert_eq!(mapper.get_mirroring(), NametableLayout::Horizontal);
}
#[test]
fn prg_ram_read_write() {
let prg_rom = banked_data(8 * 1024, 2);
let chr_rom = vec![0; 8 * 1024];
let mut mapper = TaitoTc0190Mapper::new(MapperContext::new_for_test(
33,
prg_rom,
chr_rom,
NametableLayout::Vertical,
));
mapper.write_prg(0x6000, 0xAB);
assert_eq!(mapper.read_prg(0x6000), 0xAB);
mapper.write_prg(0x7FFF, 0xCD);
assert_eq!(mapper.read_prg(0x7FFF), 0xCD);
}
#[test]
fn prg_ram_snapshot_round_trips() {
let prg_rom = banked_data(8 * 1024, 2);
let chr_rom = vec![0; 8 * 1024];
let mut mapper = TaitoTc0190Mapper::new(MapperContext::new_for_test(
33,
prg_rom,
chr_rom,
NametableLayout::Vertical,
));
mapper.write_prg(0x6000, 0xBB);
let snap = mapper.wram_snapshot();
assert_eq!(snap[0], 0xBB);
mapper.write_prg(0x6000, 0x00);
mapper.load_wram_snapshot(&snap);
assert_eq!(mapper.read_prg(0x6000), 0xBB);
}
#[test]
fn registers_snapshot_restores_all_banks_and_mirroring() {
let prg_rom = banked_data(8 * 1024, 6);
let chr_rom = banked_data(1024, 48);
let mut mapper = create_tc0190(prg_rom.clone(), chr_rom.clone(), NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8000, 0x43); mapper.write_prg(0x8001, 5);
mapper.write_prg(0x8002, 2);
mapper.write_prg(0x8003, 4);
mapper.write_prg(0xA000, 10);
mapper.write_prg(0xA001, 20);
mapper.write_prg(0xA002, 30);
mapper.write_prg(0xA003, 40);
let snap = mapper.registers_snapshot();
let mut restored =
create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical).expect("mapper 33");
restored.restore_registers(&snap);
assert_eq!(restored.get_mirroring(), NametableLayout::Horizontal);
assert_eq!(restored.read_prg(0x8000), 3);
assert_eq!(restored.read_prg(0xA000), 5);
assert_eq!(restored.read_chr(0x0000), 4); assert_eq!(restored.read_chr(0x0800), 8); assert_eq!(restored.read_chr(0x1000), 10);
assert_eq!(restored.read_chr(0x1400), 20);
assert_eq!(restored.read_chr(0x1800), 30);
assert_eq!(restored.read_chr(0x1C00), 40);
}
#[test]
fn mirrored_write_addresses_reach_correct_registers() {
let prg_rom = banked_data(8 * 1024, 6);
let chr_rom = banked_data(1024, 48);
let mut mapper = create_tc0190(prg_rom, chr_rom, NametableLayout::Vertical)
.expect("mapper 33 must be supported");
mapper.write_prg(0x8004, 2); assert_eq!(mapper.read_prg(0x8000), 2);
mapper.write_prg(0x8005, 4); assert_eq!(mapper.read_prg(0xA000), 4);
mapper.write_prg(0x9002, 0); mapper.write_prg(0x9003, 1);
assert_eq!(mapper.read_chr(0x0000), 0);
assert_eq!(mapper.read_chr(0x0800), 2); }
}