Mesen2/Core/Gameboy/GbMemoryManager.cpp
Sour 6334ef2a6a Debugger: GBC - Fixed crashes when memory viewer was opened and addresses FF76/FF77 were visible
This was causing the APU to run inside the UI thread, causing memory corruption/crashes
2025-03-11 17:50:19 +09:00

595 lines
No EOL
17 KiB
C++

#include "pch.h"
#include "Gameboy/Gameboy.h"
#include "Gameboy/GbMemoryManager.h"
#include "Gameboy/GbPpu.h"
#include "Gameboy/GbCpu.h"
#include "Gameboy/APU/GbApu.h"
#include "Gameboy/GbTimer.h"
#include "Gameboy/GbTypes.h"
#include "Gameboy/Carts/GbCart.h"
#include "Gameboy/GbDmaController.h"
#include "Gameboy/GbControlManager.h"
#include "Shared/Emulator.h"
#include "Shared/EmuSettings.h"
#include "Shared/CheatManager.h"
#include "Shared/MessageManager.h"
#include "SNES/Coprocessors/SGB/SuperGameboy.h"
#include "SNES/SnesControlManager.h"
#include "SNES/Input/SnesController.h"
#include "Utilities/VirtualFile.h"
#include "Utilities/Serializer.h"
#include "Utilities/HexUtilities.h"
#include "Shared/MemoryOperationType.h"
void GbMemoryManager::Init(Emulator* emu, Gameboy* gameboy, GbCart* cart, GbPpu* ppu, GbApu* apu, GbTimer* timer, GbDmaController* dmaController)
{
_highRam = gameboy->DebugGetMemory(MemoryType::GbHighRam);
_emu = emu;
_cpu = gameboy->GetCpu();
_apu = apu;
_ppu = ppu;
_gameboy = gameboy;
_cart = cart;
_timer = timer;
_dmaController = dmaController;
_controlManager = (GbControlManager*)gameboy->GetControlManager();
_settings = _emu->GetSettings();
memset(_reads, 0, sizeof(_reads));
memset(_writes, 0, sizeof(_writes));
_state = {};
_state.CgbWorkRamBank = 1;
_state.DisableBootRom = false;
MapRegisters(0x8000, 0x9FFF, RegisterAccess::ReadWrite);
MapRegisters(0xFE00, 0xFFFF, RegisterAccess::ReadWrite);
_cart->InitCart();
RefreshMappings();
}
GbMemoryManager::~GbMemoryManager()
{
}
GbMemoryManagerState& GbMemoryManager::GetState()
{
return _state;
}
void GbMemoryManager::RefreshMappings()
{
int wramBank = _ppu->IsCgbEnabled() ? std::max<int>(1, _state.CgbWorkRamBank) : 1;
Map(0xC000, 0xCFFF, GbMemoryType::WorkRam, 0, false);
Map(0xD000, 0xDFFF, GbMemoryType::WorkRam, wramBank * 0x1000, false);
Map(0xE000, 0xEFFF, GbMemoryType::WorkRam, 0, false);
Map(0xF000, 0xFFFF, GbMemoryType::WorkRam, wramBank * 0x1000, false);
_cart->RefreshMappings();
if(!_state.DisableBootRom) {
Map(0x0000, 0x00FF, GbMemoryType::BootRom, 0, true);
if(_gameboy->IsCgb()) {
Map(0x0200, 0x08FF, GbMemoryType::BootRom, 0x200, true);
}
}
}
void GbMemoryManager::ExecTimerDmaSerial()
{
_state.ApuCycleCount += _state.CgbHighSpeed ? 1 : 2;
_timer->Exec();
if((_cpu->GetState().CycleCount & 0x03) == 0) {
_dmaController->Exec();
}
if(_state.SerialBitCount && (_cpu->GetState().CycleCount & 0x1FF) == 0) {
_state.SerialData = (_state.SerialData << 1) | 0x01;
if(--_state.SerialBitCount == 0) {
//"It will be notified that the transfer is complete in two ways:
//SC's Bit 7 will be cleared"
_state.SerialControl &= 0x7F;
//"and the Serial Interrupt handler will be called"
RequestIrq(GbIrqSource::Serial);
}
}
}
void GbMemoryManager::ExecMasterCycle()
{
uint64_t& cycleCount = _cpu->GetState().CycleCount;
cycleCount++;
if(cycleCount & 1) {
ExecTimerDmaSerial();
}
_ppu->Exec<true>();
}
void GbMemoryManager::Exec()
{
uint64_t& cycleCount = _cpu->GetState().CycleCount;
cycleCount += 2;
ExecTimerDmaSerial();
_ppu->Exec<false>();
}
void GbMemoryManager::MapRegisters(uint16_t start, uint16_t end, RegisterAccess access)
{
for(int i = start; i < end; i += 0x100) {
_state.IsReadRegister[i >> 8] = ((int)access & (int)RegisterAccess::Read) != 0;
_state.IsWriteRegister[i >> 8] = ((int)access & (int)RegisterAccess::Write) != 0;
}
}
void GbMemoryManager::Map(uint16_t start, uint16_t end, GbMemoryType type, uint32_t offset, bool readonly)
{
uint8_t* src = _gameboy->DebugGetMemory((MemoryType)type);
uint32_t size = _gameboy->DebugGetMemorySize((MemoryType)type);
if(size > 0) {
while(offset >= size) {
offset -= size;
}
src += offset;
for(int i = start; i < end; i += 0x100) {
_reads[i >> 8] = src;
_writes[i >> 8] = readonly ? nullptr : src;
_state.MemoryType[i >> 8] = type;
_state.MemoryOffset[i >> 8] = offset;
_state.MemoryAccessType[i >> 8] = readonly ? RegisterAccess::Read : RegisterAccess::ReadWrite;
if(src) {
src += 0x100;
offset = (offset + 0x100);
if(offset >= size) {
offset = 0;
src = _gameboy->DebugGetMemory((MemoryType)type);
}
}
}
} else {
Unmap(start, end);
}
}
void GbMemoryManager::Unmap(uint16_t start, uint16_t end)
{
for(int i = start; i < end; i += 0x100) {
_reads[i >> 8] = nullptr;
_writes[i >> 8] = nullptr;
_state.MemoryType[i >> 8] = GbMemoryType::None;
_state.MemoryOffset[i >> 8] = 0;
_state.MemoryAccessType[i >> 8] = RegisterAccess::None;
}
}
template<MemoryOperationType opType, GbOamCorruptionType oamCorruptionType>
uint8_t GbMemoryManager::Read(uint16_t addr)
{
uint8_t value = 0;
if(_dmaController->IsOamDmaRunning()) {
addr = _dmaController->ProcessOamDmaReadConflict(addr);
}
if(_state.IsReadRegister[addr >> 8]) {
_ppu->ProcessOamCorruption<oamCorruptionType>(addr);
value = ReadRegister(addr);
} else if(_reads[addr >> 8]) {
value = _reads[addr >> 8][(uint8_t)addr];
}
if(_emu->GetCheatManager()->HasCheats<CpuType::Gameboy>()) {
_emu->GetCheatManager()->ApplyCheat<CpuType::Gameboy>(addr, value);
}
_emu->ProcessMemoryRead<CpuType::Gameboy>(addr, value, opType);
return value;
}
bool GbMemoryManager::IsOamDmaRunning()
{
return _dmaController->IsOamDmaRunning();
}
void GbMemoryManager::WriteDma(uint16_t addr, uint8_t value)
{
_emu->ProcessMemoryRead<CpuType::Gameboy>(addr, value, MemoryOperationType::DmaWrite);
_ppu->WriteOam((uint8_t)addr, value, true);
}
uint8_t GbMemoryManager::ReadDma(uint16_t addr)
{
uint8_t value = 0;
if(_reads[addr >> 8]) {
value = _reads[addr >> 8][(uint8_t)addr];
} else if(addr >= 0x8000 && addr <= 0x9FFF) {
value = ReadRegister(addr);
}
_emu->ProcessMemoryRead<CpuType::Gameboy>(addr, value, MemoryOperationType::DmaRead);
return value;
}
template<MemoryOperationType type>
void GbMemoryManager::Write(uint16_t addr, uint8_t value)
{
if(_emu->ProcessMemoryWrite<CpuType::Gameboy>(addr, value, type)) {
if(_dmaController->IsOamDmaRunning() && _dmaController->IsOamDmaConflict(addr)) {
//DMA conflict, can't write
return;
}
if(_state.IsWriteRegister[addr >> 8]) {
_ppu->ProcessOamCorruption<GbOamCorruptionType::Write>(addr);
WriteRegister(addr, value);
} else if(_writes[addr >> 8]) {
_writes[addr >> 8][(uint8_t)addr] = value;
}
}
}
uint8_t GbMemoryManager::DebugRead(uint16_t addr)
{
if(_state.IsReadRegister[addr >> 8]) {
return PeekRegister(addr);
} else {
uint8_t* ptr = _reads[addr >> 8];
if(ptr) {
return ptr[(uint8_t)addr];
}
}
return 0;
}
void GbMemoryManager::DebugWrite(uint16_t addr, uint8_t value)
{
if(_state.IsWriteRegister[addr >> 8]) {
//Do not write to registers via debug tools
} else {
uint8_t* ptr = _writes[addr >> 8];
if(ptr) {
ptr[(uint8_t)addr] = value;
}
}
}
uint8_t* GbMemoryManager::GetMappedBlock(uint16_t addr)
{
if(_reads[addr >> 8]) {
return _reads[addr >> 8];
}
return nullptr;
}
uint8_t GbMemoryManager::PeekRegister(uint16_t addr)
{
//Peek on oam/vram to avoid triggering the invalid oam/vram access break options
if(addr >= 0xFF40) {
if(_gameboy->IsCgb() && (addr == 0xFF76 || addr == 0xFF77)) {
//Avoid calling Run() on APU when debugger reads CGB-only APU registers
return _apu->PeekCgbRegister(addr);
}
return ReadRegister(addr);
} else if(addr >= 0xFE00 && addr <= 0xFE9F) {
return _ppu->PeekOam((uint8_t)addr);
} else if(addr >= 0xFF10 && addr <= 0xFF3F) {
return _apu->Peek(addr);
} else if(addr >= 0x8000 && addr <= 0x9FFF) {
return _ppu->PeekVram(addr);
} else {
//Avoid side effects
return 0xFF;
}
}
uint8_t GbMemoryManager::ReadRegister(uint16_t addr)
{
if(addr >= 0xFF00) {
if(addr == 0xFFFF) {
return _state.IrqEnabled; //IE - Interrupt Enable (R/W)
} else if(addr == 0xFF46) {
return _dmaController->Read();
} else if(addr >= 0xFF80) {
return _highRam[addr & 0x7F]; //80-FE
} else if(addr >= 0xFF4C) {
if(_gameboy->IsCgb()) {
switch(addr) {
//FF4D - KEY1 - CGB Mode Only - Prepare Speed Switch
case 0xFF4D:
if(_ppu->IsCgbEnabled()) {
return (
(_state.CgbHighSpeed ? 0x80 : 0) |
(_state.CgbSwitchSpeedRequest ? 0x01 : 0) |
0x7E
);
}
return 0xFF;
case 0xFF55: //CGB - DMA
return _ppu->IsCgbEnabled() ? _dmaController->ReadCgb(addr) : 0xFF;
case 0xFF56:
//TODO CGB - RP Infrared port
return _state.CgbRegRpInfrared | 0x3E;
case 0xFF4F: //CGB - VRAM bank
case 0xFF68: case 0xFF69: case 0xFF6A: case 0xFF6B: //CGB - Palette
return _ppu->ReadCgbRegister(addr);
//FF70 - SVBK - CGB Mode Only - WRAM Bank
case 0xFF70: return _ppu->IsCgbEnabled() ? (_state.CgbWorkRamBank | 0xF8) : 0xFF;
case 0xFF72: return _state.CgbRegFF72;
case 0xFF73: return _state.CgbRegFF73;
case 0xFF74:
if(_ppu->IsCgbEnabled()) {
return _state.CgbRegFF74;
}
return 0xFF;
case 0xFF75: return _state.CgbRegFF75 | 0x8F;
case 0xFF76: case 0xFF77:
return _apu->ReadCgbRegister(addr);
}
}
LogDebug("[Debug] GB - Missing read handler: $" + HexUtilities::ToHex(addr));
return 0xFF; //4C-7F, open bus
} else if(addr >= 0xFF40) {
return _ppu->Read(addr); //40-4B
} else if(addr >= 0xFF10) {
return _apu->Read(addr); //10-3F
} else {
//00-0F
switch(addr) {
case 0xFF00:
_controlManager->SetInputReadFlag();
return _controlManager->ReadInputPort();
case 0xFF01: return _state.SerialData; //SB - Serial transfer data (R/W)
case 0xFF02: return _state.SerialControl | (_gameboy->IsCgb() ? 0x7C : 0x7E); //SC - Serial Transfer Control (R/W)
case 0xFF04: case 0xFF05: case 0xFF06: case 0xFF07:
return _timer->Read(addr);
case 0xFF0F: return _state.IrqRequests | 0xE0; //IF - Interrupt flags (R/W)
default: return 0xFF; //Open bus
}
}
} else if(addr >= 0xFE00) {
return _ppu->ReadOam((uint8_t)addr);
} else if(addr >= 0x8000 && addr <= 0x9FFF) {
return _ppu->ReadVram(addr);
}
return _cart->ReadRegister(addr);
}
void GbMemoryManager::WriteRegister(uint16_t addr, uint8_t value)
{
if(addr >= 0xFF00) {
if(addr == 0xFFFF) {
_state.IrqEnabled = value; //IE register
} else if(addr == 0xFF46) {
_dmaController->Write(value);
} else if(addr >= 0xFF80) {
_highRam[addr & 0x7F] = value; //80-FE
} else if(addr >= 0xFF4C) {
//4C-7F
if(addr == 0xFF50) {
if(value & 0x01) {
_state.DisableBootRom = true;
RefreshMappings();
}
} else if(_gameboy->IsCgb()) {
switch(addr) {
case 0xFF4D:
//FF4D - KEY1 - CGB Mode Only - Prepare Speed Switch
if(_ppu->IsCgbEnabled()) {
_state.CgbSwitchSpeedRequest = (value & 0x01) != 0;
}
break;
case 0xFF51: case 0xFF52: case 0xFF53: case 0xFF54: case 0xFF55: //CGB - DMA
if(_ppu->IsCgbEnabled()) {
_dmaController->WriteCgb(addr, value);
}
break;
case 0xFF56:
//TODO CGB - RP Infrared port
if(_ppu->IsCgbEnabled()) {
_state.CgbRegRpInfrared = value & 0xC1;
}
break;
case 0xFF4C: //CGB - "LCDMODE", set by boot rom to turn off CGB features for the LCD for DMG games
if(!_state.DisableBootRom) {
_ppu->WriteCgbRegister(addr, value);
}
break;
case 0xFF4F: //CGB - VRAM banking
case 0xFF68: case 0xFF69: case 0xFF6A: case 0xFF6B: //CGB - Palette
_ppu->WriteCgbRegister(addr, value);
break;
case 0xFF70:
//FF70 - SVBK - CGB Mode Only - WRAM Bank
if(_ppu->IsCgbEnabled()) {
_state.CgbWorkRamBank = value & 0x07;
RefreshMappings();
}
break;
case 0xFF72: _state.CgbRegFF72 = value; break;
case 0xFF73: _state.CgbRegFF73 = value; break;
case 0xFF74:
if(_ppu->IsCgbEnabled()) {
_state.CgbRegFF74 = value;
}
break;
case 0xFF75: _state.CgbRegFF75 = value; break;
default:
LogDebug("[Debug] GBC - Missing write handler: $" + HexUtilities::ToHex(addr));
break;
}
}
} else if(addr >= 0xFF40) {
_ppu->Write(addr, value); //40-4B
} else if(addr >= 0xFF10) {
_apu->Write(addr, value); //10-3F
} else {
//00-0F
switch(addr) {
case 0xFF00: _controlManager->WriteInputPort(value); break;
case 0xFF01: _state.SerialData = value; break; //FF01 - SB - Serial transfer data (R/W)
case 0xFF02:
//FF02 - SC - Serial Transfer Control (R/W)
_state.SerialControl = value & (_gameboy->IsCgb() ? 0x83 : 0x81);
if((_state.SerialControl & 0x80) && (_state.SerialControl & 0x01)) {
_state.SerialBitCount = 8;
} else {
_state.SerialBitCount = 0;
}
break;
case 0xFF04: case 0xFF05: case 0xFF06: case 0xFF07:
_timer->Write(addr, value);
break;
case 0xFF0F: _state.IrqRequests = value & 0x1F; break; //IF - Interrupt flags (R/W)
}
}
} else if(addr >= 0xFE00) {
_ppu->WriteOam((uint8_t)addr, value, false);
} else if(addr >= 0x8000 && addr <= 0x9FFF) {
_ppu->WriteVram(addr, value);
} else {
_cart->WriteRegister(addr, value);
}
}
void GbMemoryManager::ProcessCpuWrite(uint16_t addr, uint8_t value)
{
if((addr & 0xFFC0) != 0xFF40) {
Exec();
Exec();
Write(addr, value);
return;
}
//Special cases for LCD registers reads/writes where effects
//need to be triggered a bit earlier than other writes
switch(addr) {
default:
//Default case, same write timing as all other writes
Exec();
Exec();
Write(addr, value);
break;
case 0xFF47:
//BGP writes appear to be effective slightly earlier than other writes?
//This allows the ppu_scanline_bgp and m3_bgp_change tests to display properly
ExecMasterCycle();
ExecMasterCycle();
ExecMasterCycle();
Write(addr, value);
ExecMasterCycle();
break;
case 0xFF40:
//LCDC - For GBC, clearing bit 4 (tile select) causes a glitch if done at the same time as
//the BG fetcher is loading tile data (either the LSB or MSB). When this bug is triggered,
//the tile data is replaced with the tile index (loaded at the first step of the fetching process)
//This needs to be triggered before running the last dot to get the correct result (cgb-acid-hell test)
Exec();
Exec();
if(_gameboy->IsCgb() && (_ppu->GetState().Control & 0x10) && !(value & 0x10)) {
//Trigger GBC fetch glitch at the same time as the write occurs
_ppu->SetTileFetchGlitchState();
}
Write(addr, value);
break;
}
}
void GbMemoryManager::RequestIrq(uint8_t source)
{
_state.IrqRequests |= source;
}
void GbMemoryManager::ClearIrqRequest(uint8_t source)
{
_state.IrqRequests &= ~source;
}
uint8_t GbMemoryManager::ProcessIrqRequests()
{
uint8_t irqsToProcess = _state.IrqRequests & _state.IrqEnabled;
if(irqsToProcess) {
if(irqsToProcess & GbIrqSource::VerticalBlank) {
return GbIrqSource::VerticalBlank;
} else if(irqsToProcess & GbIrqSource::LcdStat) {
return GbIrqSource::LcdStat;
} else if(irqsToProcess & GbIrqSource::Timer) {
return GbIrqSource::Timer;
} else if(irqsToProcess & GbIrqSource::Serial) {
return GbIrqSource::Serial;
} else if(irqsToProcess & GbIrqSource::Joypad) {
return GbIrqSource::Joypad;
}
}
return 0;
}
void GbMemoryManager::ToggleSpeed()
{
_state.CgbSwitchSpeedRequest = false;
_state.CgbHighSpeed = !_state.CgbHighSpeed;
}
bool GbMemoryManager::IsHighSpeed()
{
return _state.CgbHighSpeed;
}
bool GbMemoryManager::IsBootRomDisabled()
{
return _state.DisableBootRom;
}
uint64_t GbMemoryManager::GetApuCycleCount()
{
return _state.ApuCycleCount;
}
void GbMemoryManager::Serialize(Serializer& s)
{
SV(_state.DisableBootRom); SV(_state.IrqEnabled); SV(_state.IrqRequests);
SV(_state.ApuCycleCount); SV(_state.CgbHighSpeed); SV(_state.CgbSwitchSpeedRequest); SV(_state.CgbWorkRamBank);
SV(_state.SerialData); SV(_state.SerialControl); SV(_state.SerialBitCount);
SV(_state.CgbRegFF72); SV(_state.CgbRegFF73); SV(_state.CgbRegFF74); SV(_state.CgbRegFF75);
SV(_state.CgbRegRpInfrared);
if(!s.IsSaving()) {
RefreshMappings();
}
}
template uint8_t GbMemoryManager::Read<MemoryOperationType::Read, GbOamCorruptionType::Read>(uint16_t addr);
template uint8_t GbMemoryManager::Read<MemoryOperationType::Read, GbOamCorruptionType::ReadIncDec>(uint16_t addr);
template uint8_t GbMemoryManager::Read<MemoryOperationType::ExecOpCode, GbOamCorruptionType::Read>(uint16_t addr);
template uint8_t GbMemoryManager::Read<MemoryOperationType::ExecOpCode, GbOamCorruptionType::ReadIncDec>(uint16_t addr);
template uint8_t GbMemoryManager::Read<MemoryOperationType::ExecOperand, GbOamCorruptionType::ReadIncDec>(uint16_t addr);
template uint8_t GbMemoryManager::Read<MemoryOperationType::DmaRead, GbOamCorruptionType::Read>(uint16_t addr);
template void GbMemoryManager::Write<MemoryOperationType::Write>(uint16_t addr, uint8_t value);
template void GbMemoryManager::Write<MemoryOperationType::DmaWrite>(uint16_t addr, uint8_t value);