#include <MSXCPUInterface.hh>

Public Types
using	BreakPoints = std::vector< BreakPoint >

using	WatchPoints = std::vector< std::shared_ptr< WatchPoint > >

using	Conditions = std::vector< DebugCondition >

Public Member Functions
	MSXCPUInterface (const MSXCPUInterface &)=delete

MSXCPUInterface &	operator= (const MSXCPUInterface &)=delete

	MSXCPUInterface (MSXMotherBoard &motherBoard)

	~MSXCPUInterface ()

void	register_IO_In (byte port, MSXDevice *device)
	Devices can register their In ports. More...

void	unregister_IO_In (byte port, MSXDevice *device)

void	register_IO_Out (byte port, MSXDevice *device)
	Devices can register their Out ports. More...

void	unregister_IO_Out (byte port, MSXDevice *device)

bool	replace_IO_In (byte port, MSXDevice oldDevice, MSXDevice newDevice)
	These methods replace a previously registered device with a new one. More...

bool	replace_IO_Out (byte port, MSXDevice oldDevice, MSXDevice newDevice)

void	registerMemDevice (MSXDevice &device, int ps, int ss, int base, int size)
	Devices can register themself in the MSX slotstructure. More...

void	unregisterMemDevice (MSXDevice &device, int ps, int ss, int base, int size)

void	registerGlobalWrite (MSXDevice &device, word address)
	(Un)register global writes. More...

void	unregisterGlobalWrite (MSXDevice &device, word address)

void	registerGlobalRead (MSXDevice &device, word address)
	(Un)register global read. More...

void	unregisterGlobalRead (MSXDevice &device, word address)

void	reset ()
	Reset (the slot state) More...

byte	readMem (word address, EmuTime::param time)
	This reads a byte from the currently selected device. More...

void	writeMem (word address, byte value, EmuTime::param time)
	This writes a byte to the currently selected device. More...

byte	readIO (word port, EmuTime::param time)
	This read a byte from the given IO-port. More...

void	writeIO (word port, byte value, EmuTime::param time)
	This writes a byte to the given IO-port. More...

const byte *	getReadCacheLine (word start) const
	Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for reading. More...

byte *	getWriteCacheLine (word start) const
	Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for writing. More...

byte	readIRQVector ()
	CPU uses this method to read 'extra' data from the databus used in interrupt routines. More...

void	setPrimarySlots (byte value)

byte	peekMem (word address, EmuTime::param time) const
	Peek memory location. More...

byte	peekSlottedMem (unsigned address, EmuTime::param time) const

byte	readSlottedMem (unsigned address, EmuTime::param time)

void	writeSlottedMem (unsigned address, byte value, EmuTime::param time)

void	setExpanded (int ps)

void	unsetExpanded (int ps)

void	testUnsetExpanded (int ps, std::vector< MSXDevice *> allowed) const

bool	isExpanded (int ps) const

void	changeExpanded (bool newExpanded)

DummyDevice &	getDummyDevice ()

void	setWatchPoint (const std::shared_ptr< WatchPoint > &watchPoint)

void	removeWatchPoint (std::shared_ptr< WatchPoint > watchPoint)

const WatchPoints &	getWatchPoints () const

void	doBreak ()

void	doStep ()

void	doContinue ()

void	setFastForward (bool fastForward_)

bool	isFastForward () const

template<typename Archive >
void	serialize (Archive &ar, unsigned version)

Static Public Member Functions
static void	insertBreakPoint (BreakPoint bp)

static void	removeBreakPoint (const BreakPoint &bp)

static const BreakPoints &	getBreakPoints ()

static void	setCondition (DebugCondition cond)

static void	removeCondition (const DebugCondition &cond)

static const Conditions &	getConditions ()

static bool	isBreaked ()

static bool	anyBreakPoints ()

static bool	checkBreakPoints (unsigned pc, MSXMotherBoard &motherBoard)

static void	cleanup ()

Detailed Description

Definition at line 40 of file MSXCPUInterface.hh.

Member Typedef Documentation

◆ BreakPoints

using openmsx::MSXCPUInterface::BreakPoints = std::vector<BreakPoint>

Definition at line 218 of file MSXCPUInterface.hh.

◆ Conditions

using openmsx::MSXCPUInterface::Conditions = std::vector<DebugCondition>

Definition at line 229 of file MSXCPUInterface.hh.

◆ WatchPoints

using openmsx::MSXCPUInterface::WatchPoints = std::vector<std::shared_ptr<WatchPoint> >

Definition at line 224 of file MSXCPUInterface.hh.

Constructor & Destructor Documentation

◆ MSXCPUInterface() [1/2]

openmsx::MSXCPUInterface::MSXCPUInterface ( const MSXCPUInterface & )

delete

◆ MSXCPUInterface() [2/2]

openmsx::MSXCPUInterface::MSXCPUInterface ( MSXMotherBoard & motherBoard )

explicit

Definition at line 51 of file MSXCPUInterface.cc.

References openmsx::DeviceFactory::createVDPIODelay(), ranges::fill(), openmsx::Reactor::getCommandController(), openmsx::MSXMotherBoard::getMachineConfig(), openmsx::MSXMotherBoard::getReactor(), openmsx::MSXMotherBoard::isTurboR(), openmsx::HardwareConfig::parseSlotMap(), reset(), and openmsx::MSXCPU::setInterface().

◆ ~MSXCPUInterface()

openmsx::MSXCPUInterface::~MSXCPUInterface ( )

Definition at line 113 of file MSXCPUInterface.cc.

References openmsx::CacheLine::BITS, g, openmsx::MSXDevice::getName(), isExpanded(), openmsx::CacheLine::LOW, openmsx::WatchPoint::READ_MEM, openmsx::MSXDevice::readMem(), removeWatchPoint(), openmsx::MSXCPU::setInterface(), unlikely, UNREACHABLE, openmsx::WatchPoint::WRITE_MEM, and openmsx::MSXDevice::writeMem().

Member Function Documentation

◆ anyBreakPoints()

static bool openmsx::MSXCPUInterface::anyBreakPoints ( )

inlinestatic

Definition at line 238 of file MSXCPUInterface.hh.

◆ changeExpanded()

void openmsx::MSXCPUInterface::changeExpanded ( bool newExpanded )

Definition at line 286 of file MSXCPUInterface.cc.

References openmsx::CacheLine::HIGH, openmsx::MSXCPU::invalidateMemCache(), and openmsx::SECONDARY_SLOT_BIT.

Referenced by setExpanded(), setPrimarySlots(), and unsetExpanded().

◆ checkBreakPoints()

static bool openmsx::MSXCPUInterface::checkBreakPoints	(	unsigned	pc,
		MSXMotherBoard &	motherBoard
	)

inlinestatic

Definition at line 242 of file MSXCPUInterface.hh.

References ranges::equal_range().

Referenced by removeBreakPoint().

◆ cleanup()

void openmsx::MSXCPUInterface::cleanup ( )

static

Definition at line 976 of file MSXCPUInterface.cc.

Referenced by openmsx::Interpreter::~Interpreter().

◆ doBreak()

void openmsx::MSXCPUInterface::doBreak ( )

Definition at line 939 of file MSXCPUInterface.cc.

References openmsx::Reactor::block(), openmsx::EventDistributor::distributeEvent(), openmsx::MSXCPU::exitCPULoopSync(), openmsx::Reactor::getCliComm(), openmsx::Reactor::getEventDistributor(), openmsx::MSXMotherBoard::getReactor(), isFastForward(), openmsx::OPENMSX_BREAK_EVENT, openmsx::CliComm::STATUS, and openmsx::CliComm::update().

◆ doContinue()

void openmsx::MSXCPUInterface::doContinue ( )

Definition at line 962 of file MSXCPUInterface.cc.

References openmsx::Reactor::getCliComm(), openmsx::MSXMotherBoard::getReactor(), openmsx::MSXMotherBoard::getRealTime(), isFastForward(), openmsx::RealTime::resync(), openmsx::CliComm::STATUS, openmsx::Reactor::unblock(), and openmsx::CliComm::update().

Referenced by doStep().

◆ doStep()

void openmsx::MSXCPUInterface::doStep ( )

Definition at line 954 of file MSXCPUInterface.cc.

References doContinue(), isFastForward(), and setCondition().

◆ getBreakPoints()

static const BreakPoints& openmsx::MSXCPUInterface::getBreakPoints ( )

inlinestatic

Definition at line 219 of file MSXCPUInterface.hh.

◆ getConditions()

static const Conditions& openmsx::MSXCPUInterface::getConditions ( )

inlinestatic

Definition at line 230 of file MSXCPUInterface.hh.

◆ getDummyDevice()

DummyDevice& openmsx::MSXCPUInterface::getDummyDevice ( )

inline

Definition at line 214 of file MSXCPUInterface.hh.

Referenced by openmsx::VDPIODelay::VDPIODelay().

◆ getReadCacheLine()

const byte* openmsx::MSXCPUInterface::getReadCacheLine ( word start ) const

inline

Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for reading.

If it is, a pointer to a buffer containing this interval must be returned. If not, a null pointer must be returned. Cacheable for reading means the data may be read directly from the buffer, thus bypassing the readMem() method, and thus also ignoring EmuTime. The default implementation always returns a null pointer. An interval will never cross a 16KB border. An interval will never contain the address 0xffff.

Definition at line 160 of file MSXCPUInterface.hh.

References openmsx::CacheLine::BITS, and unlikely.

◆ getWatchPoints()

const WatchPoints& openmsx::MSXCPUInterface::getWatchPoints ( ) const

inline

Definition at line 225 of file MSXCPUInterface.hh.

Referenced by openmsx::Debugger::transfer().

◆ getWriteCacheLine()

byte* openmsx::MSXCPUInterface::getWriteCacheLine ( word start ) const

inline

Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for writing.

If it is, a pointer to a buffer containing this interval must be returned. If not, a null pointer must be returned. Cacheable for writing means the data may be written directly to the buffer, thus bypassing the writeMem() method, and thus also ignoring EmuTime. The default implementation always returns a null pointer. An interval will never cross a 16KB border. An interval will never contain the address 0xffff.

Definition at line 179 of file MSXCPUInterface.hh.

References openmsx::CacheLine::BITS, and unlikely.

◆ insertBreakPoint()

void openmsx::MSXCPUInterface::insertBreakPoint ( BreakPoint bp )

static

Definition at line 722 of file MSXCPUInterface.cc.

References ranges::upper_bound().

◆ isBreaked()

static bool openmsx::MSXCPUInterface::isBreaked ( )

inlinestatic

Definition at line 232 of file MSXCPUInterface.hh.

◆ isExpanded()

bool openmsx::MSXCPUInterface::isExpanded ( int ps ) const

inline

Definition at line 211 of file MSXCPUInterface.hh.

Referenced by openmsx::HardwareConfig::parseSlots(), peekMem(), peekSlottedMem(), readSlottedMem(), registerMemDevice(), setExpanded(), setPrimarySlots(), testUnsetExpanded(), unsetExpanded(), writeSlottedMem(), and ~MSXCPUInterface().

◆ isFastForward()

bool openmsx::MSXCPUInterface::isFastForward ( ) const

inline

Definition at line 260 of file MSXCPUInterface.hh.

References openmsx::serialize().

Referenced by doBreak(), doContinue(), and doStep().

◆ operator=()

MSXCPUInterface& openmsx::MSXCPUInterface::operator= ( const MSXCPUInterface & )

delete

◆ peekMem()

byte openmsx::MSXCPUInterface::peekMem	(	word	address,
		EmuTime::param	time
	)		const

Peek memory location.

See also: MSXDevice::peekMem()

Definition at line 661 of file MSXCPUInterface.cc.

References isExpanded(), and openmsx::MSXDevice::peekMem().

Referenced by openmsx::dasm().

◆ peekSlottedMem()

byte openmsx::MSXCPUInterface::peekSlottedMem	(	unsigned	address,
		EmuTime::param	time
	)		const

Definition at line 670 of file MSXCPUInterface.cc.

References isExpanded(), and openmsx::MSXDevice::peekMem().

Referenced by openmsx::MSXMirrorDevice::peekMem().

◆ readIO()

byte openmsx::MSXCPUInterface::readIO	(	word	port,
		EmuTime::param	time
	)

inline

This read a byte from the given IO-port.

See also: MSXDevice::readIO()

Definition at line 136 of file MSXCPUInterface.hh.

◆ readIRQVector()

byte openmsx::MSXCPUInterface::readIRQVector ( )

CPU uses this method to read 'extra' data from the databus used in interrupt routines.

In MSX this returns always 255.

Definition at line 595 of file MSXCPUInterface.cc.

References openmsx::MSXMotherBoard::readIRQVector().

◆ readMem()

byte openmsx::MSXCPUInterface::readMem	(	word	address,
		EmuTime::param	time
	)

inline

This reads a byte from the currently selected device.

Definition at line 114 of file MSXCPUInterface.hh.

References openmsx::CacheLine::BITS, and unlikely.

◆ readSlottedMem()

byte openmsx::MSXCPUInterface::readSlottedMem	(	unsigned	address,
		EmuTime::param	time
	)

Definition at line 687 of file MSXCPUInterface.cc.

References isExpanded(), and openmsx::MSXDevice::peekMem().

Referenced by openmsx::MSXMirrorDevice::readMem().

◆ register_IO_In()

void openmsx::MSXCPUInterface::register_IO_In	(	byte	port,
		MSXDevice *	device
	)

Devices can register their In ports.

This is normally done in their constructor. Once device are registered, their readIO() method can get called.

Definition at line 311 of file MSXCPUInterface.cc.

Referenced by openmsx::ColecoSuperGameModule::ColecoSuperGameModule(), openmsx::MSXMotherBoard::createMapperIO(), openmsx::MSXDevice::getVisibleMemRegion(), openmsx::PanasonicAudioPeriphery::getWriteCacheLine(), openmsx::MSXDeviceSwitch::registerDevice(), openmsx::RomArc::RomArc(), openmsx::RomKonamiKeyboardMaster::RomKonamiKeyboardMaster(), openmsx::RomManbow2::RomManbow2(), and openmsx::MSXMidi::writeIO().

◆ register_IO_Out()

void openmsx::MSXCPUInterface::register_IO_Out	(	byte	port,
		MSXDevice *	device
	)

Devices can register their Out ports.

This is normally done in their constructor. Once device are registered, their writeIO() method can get called.

Definition at line 323 of file MSXCPUInterface.cc.

Referenced by openmsx::ColecoSuperGameModule::ColecoSuperGameModule(), openmsx::MSXMotherBoard::createMapperIO(), openmsx::MSXDevice::getVisibleMemRegion(), openmsx::MegaFlashRomSCCPlusSD::getWriteCacheLine(), openmsx::PanasonicAudioPeriphery::getWriteCacheLine(), openmsx::MegaFlashRomSCCPlus::MegaFlashRomSCCPlus(), openmsx::MegaFlashRomSCCPlusSD::MegaFlashRomSCCPlusSD(), openmsx::MSXMidi::MSXMidi(), openmsx::MSXDeviceSwitch::registerDevice(), openmsx::ReproCartridgeV1::ReproCartridgeV1(), openmsx::ReproCartridgeV2::ReproCartridgeV2(), openmsx::RomArc::RomArc(), openmsx::RomKonamiKeyboardMaster::RomKonamiKeyboardMaster(), openmsx::RomManbow2::RomManbow2(), openmsx::RomZemina90in1::RomZemina90in1(), and openmsx::MSXMidi::writeIO().

◆ registerGlobalRead()

void openmsx::MSXCPUInterface::registerGlobalRead	(	MSXDevice &	device,
		word	address
	)

(Un)register global read.

See also: MSXDevice::globalRead()

Definition at line 550 of file MSXCPUInterface.cc.

References openmsx::CacheLine::BITS, openmsx::GLOBAL_RW_BIT, openmsx::CacheLine::HIGH, and openmsx::MSXCPU::invalidateMemCache().

Referenced by openmsx::GlobalReadClient< Carnivore2, CT_Interval< 0x0000 >, CT_Interval< 0x4000, 0x4010 > >::GlobalReadClient().

◆ registerGlobalWrite()

void openmsx::MSXCPUInterface::registerGlobalWrite	(	MSXDevice &	device,
		word	address
	)

(Un)register global writes.

See also: MSXDevice::globalWrite()

Definition at line 526 of file MSXCPUInterface.cc.

References openmsx::CacheLine::BITS, openmsx::GLOBAL_RW_BIT, openmsx::CacheLine::HIGH, and openmsx::MSXCPU::invalidateMemCache().

Referenced by openmsx::GlobalWriteClient< RomSuperLodeRunner, CT_Interval< 0x0000 > >::GlobalWriteClient().

◆ registerMemDevice()

void openmsx::MSXCPUInterface::registerMemDevice	(	MSXDevice &	device,
		int	ps,
		int	ss,
		int	base,
		int	size
	)

Devices can register themself in the MSX slotstructure.

This is normally done in their constructor. Once devices are registered their readMem() / writeMem() methods can get called.

Definition at line 484 of file MSXCPUInterface.cc.

References isExpanded(), and gl::min().

Referenced by openmsx::MSXDevice::getPluggingController().

◆ removeBreakPoint()

void openmsx::MSXCPUInterface::removeBreakPoint ( const BreakPoint & bp )

static

Definition at line 728 of file MSXCPUInterface.cc.

References checkBreakPoints(), ranges::equal_range(), ranges::find_if(), find_if_unguarded(), openmsx::BreakPoint::getAddress(), openmsx::Reactor::getGlobalCliComm(), openmsx::BreakPoint::getId(), openmsx::Reactor::getInterpreter(), openmsx::MSXMotherBoard::getReactor(), and removeCondition().

◆ removeCondition()

void openmsx::MSXCPUInterface::removeCondition ( const DebugCondition & cond )

static

Definition at line 823 of file MSXCPUInterface.cc.

References ranges::find_if(), openmsx::WatchPoint::getBeginAddress(), openmsx::DebugCondition::getId(), and rfind_if_unguarded().

Referenced by removeBreakPoint().

◆ removeWatchPoint()

void openmsx::MSXCPUInterface::removeWatchPoint ( std::shared_ptr< WatchPoint > watchPoint )

Definition at line 791 of file MSXCPUInterface.cc.

References ranges::find(), openmsx::WatchPoint::READ_IO, openmsx::WatchPoint::READ_MEM, UNREACHABLE, openmsx::WatchPoint::WRITE_IO, and openmsx::WatchPoint::WRITE_MEM.

Referenced by ~MSXCPUInterface().

◆ replace_IO_In()

bool openmsx::MSXCPUInterface::replace_IO_In	(	byte	port,
		MSXDevice *	oldDevice,
		MSXDevice *	newDevice
	)

These methods replace a previously registered device with a new one.

This method checks whether the current device is the same as the 'oldDevice' parameter.

If it's the same, the current device is replace with 'newDevice' and this method returns true.
If it's not the same, then no changes are made and this method returns false.

The intention is that devices using these methods extend (=wrap) the functionality of a previously registered device. Typically the destructor of the wrapping device will perform the inverse replacement.

Definition at line 380 of file MSXCPUInterface.cc.