gameboy-rust/crates/gba-core/tests/inactive_devices.rs

//! Original bus/CPU/DMA regressions for the disabled-device initialization subset.
use gba_core::{
    cpu::Cpu,
    dma::DMA_BASE,
    io::{
        JOYCNT, JOY_RECV, RCNT, SIOCNT, SIODATA32, SIODATA8, SOUNDBIAS, SOUNDCNT_H, SOUNDCNT_X,
        WAVE_RAM,
    },
    machine::Machine,
    memory::{Memory, MemoryError, ROM_START},
};

fn memory() -> Memory {
    Memory::new(vec![0xfe, 0xff, 0xff, 0xea]).unwrap()
}

#[test]
fn disabled_sound_registers_masks_lanes_and_wave_ram() {
    let mut bus = memory();
    for address in (0x04000060..0x04000082).step_by(2) {
        bus.write16(address, 0xffff).unwrap();
        assert_eq!(bus.read16(address).unwrap(), 0);
    }
    bus.write16(SOUNDCNT_H, 0xffff).unwrap();
    assert_eq!(bus.read16(SOUNDCNT_H).unwrap(), 0x770f); // Reset strobes do not latch.
    bus.write8(SOUNDCNT_H, 0).unwrap();
    assert_eq!(bus.read16(SOUNDCNT_H).unwrap(), 0x7700);
    bus.write32(SOUNDBIAS, u32::MAX).unwrap();
    assert_eq!(bus.read32(SOUNDBIAS).unwrap(), 0xc3fe);
    for index in 0..16 {
        bus.write8(WAVE_RAM + index, index as u8 * 13).unwrap();
    }
    bus.write32(SOUNDCNT_X, 0x7f).unwrap(); // Status bits are read-only; master stays off.
    assert_eq!(bus.read32(SOUNDCNT_X).unwrap(), 0);
    for index in 0..16 {
        assert_eq!(bus.read8(WAVE_RAM + index).unwrap(), index as u8 * 13);
    }
    assert_eq!(bus.read16(SOUNDCNT_H).unwrap(), 0x7700);
    assert_eq!(bus.read16(SOUNDBIAS).unwrap(), 0xc3fe);
    // FIFOs are not ordinary register latches.
    assert!(bus.write32(0x040000a0, 0).is_err());
    assert!(bus.read32(0x040000a0).is_err());
}

#[test]
fn disconnected_gpio_inputs_pull_high_and_outputs_follow_latches() {
    let mut bus = memory();
    bus.write16(RCNT, 0x8000).unwrap();
    assert_eq!(bus.read16(RCNT).unwrap(), 0x800f);
    bus.write16(RCNT, 0x80f5).unwrap();
    assert_eq!(bus.read16(RCNT).unwrap(), 0x80f5);
    bus.write8(RCNT, 0x20).unwrap(); // SD output low; SC/SI/SO pulled high.
    assert_eq!(bus.read16(RCNT).unwrap(), 0x802d);
    bus.write8(RCNT, 0x22).unwrap();
    assert_eq!(bus.read16(RCNT).unwrap(), 0x802f);
    bus.write16(RCNT, 0).unwrap();
    assert!(bus.read8(RCNT).is_err()); // Unsupported normal-mode pin readback is not guessed.
    assert_eq!(bus.read8(RCNT + 1).unwrap(), 0);
}

#[test]
fn idle_normal_serial_data_and_control_have_distinct_widths() {
    let mut bus = memory();
    bus.write32(SIODATA32, 0x12345678).unwrap();
    assert_eq!(bus.read32(SIODATA32).unwrap(), 0x12345678);
    bus.write16(SIODATA32, 0).unwrap();
    assert_eq!(bus.read32(SIODATA32).unwrap(), 0x12340000);
    bus.write16(SIODATA8, 0xabcd).unwrap();
    assert_eq!(bus.read16(SIODATA8).unwrap(), 0xcd);
    bus.write16(SIOCNT, 0x500b).unwrap();
    assert_eq!(bus.read16(SIOCNT).unwrap(), 0x500f); // Disconnected SI is high.
    bus.advance_cycles(1000000);
    assert_eq!(bus.read16(SIOCNT).unwrap(), 0x500f); // No fabricated completion or IRQ.
    assert_eq!(bus.read16(0x04000202).unwrap() & 0x80, 0);
    bus.write16(JOYCNT, 7).unwrap(); // Clear empty status flags.
    assert_eq!(bus.read16(JOYCNT).unwrap(), 0);
}

#[test]
fn unsupported_operations_have_specific_retryable_diagnostics() {
    let mut bus = memory();
    for (address, value, description) in [
        (SOUNDCNT_X, 0x80, "sound master enable"),
        (SIOCNT, 0x80, "serial transfer start"),
        (SIOCNT + 1, 0x20, "multiplayer/UART"),
        (RCNT + 1, 0x40, "Joybus serial mode"),
        (RCNT + 1, 1, "GPIO serial interrupt"),
        (JOYCNT, 0x40, "Joybus interrupt"),
        (JOY_RECV, 1, "Joybus data access"),
    ] {
        let error = bus.write8(address, value).unwrap_err();
        assert!(matches!(error, MemoryError::UnsupportedIo { .. }));
        assert!(error.to_string().contains(description));
        assert_eq!(bus.write8(address, value), Err(error));
    }
    bus.write16(RCNT, 0x8055).unwrap();
    assert!(bus.write16(RCNT, 0xc0aa).is_err());
    assert_eq!(bus.read16(RCNT).unwrap(), 0x805f); // Low byte was not committed.
    bus.write16(SIOCNT, 0x4008).unwrap();
    assert!(bus.write32(SIOCNT, 0xaabb2080).is_err());
    assert_eq!(bus.read16(SIOCNT).unwrap(), 0x400c);
    assert_eq!(bus.read16(SIODATA8).unwrap(), 0);
}

#[test]
fn block_store_rejects_later_activation_before_earlier_control_writes() {
    let code: [u32; 7] = [
        0xe3a00301, 0xe2800080, 0xe59f1008, 0xe3a02080, 0xe8a00006, 0xeafffffe, 0x770f0000,
    ];
    let bus = Memory::new(code.into_iter().flat_map(u32::to_le_bytes).collect()).unwrap();
    let mut machine = Machine::new(Cpu::new(ROM_START), bus);
    for _ in 0..4 {
        machine.step().unwrap();
    }
    let before = machine.cpu().clone();
    let cycles = machine.cycles();
    let error = machine.step().unwrap_err();
    assert!(error.to_string().contains("sound master enable"));
    assert_eq!(machine.cpu(), &before);
    assert_eq!(machine.cycles(), cycles);
    assert_eq!(machine.memory().read16(SOUNDCNT_H).unwrap(), 0);
    assert_eq!(machine.step(), Err(error));
}

#[test]
fn dma_activation_error_preserves_channel_progress_and_clocks() {
    let mut bus = memory();
    bus.write32(0x02000000, 0x80).unwrap();
    bus.write32(DMA_BASE, 0x02000000).unwrap();
    bus.write32(DMA_BASE + 4, SOUNDCNT_X).unwrap();
    bus.write32(DMA_BASE + 8, 0x84000001).unwrap();
    let mut machine = Machine::new(Cpu::new(ROM_START), bus);
    let before = machine.cpu().clone();
    let error = machine.step().unwrap_err();
    assert!(error.to_string().contains("sound master enable"));
    assert_eq!(machine.cycles(), 0);
    assert_eq!(machine.cpu(), &before);
    assert_eq!(machine.step(), Err(error));
    machine.memory_mut().write32(0x02000000, 0).unwrap();
    machine.step().unwrap();
    assert_eq!(machine.memory().read16(DMA_BASE + 10).unwrap() & 0x8000, 0);
}