#include <MSXMemoryMapperBase.hh>

Inheritance diagram for openmsx::MSXMemoryMapperBase:

[legend]

Collaboration diagram for openmsx::MSXMemoryMapperBase:

[legend]

Public Member Functions
	MSXMemoryMapperBase (const DeviceConfig &config)

byte	getSelectedSegment (byte page) const override
	Returns the currently selected segment for the given page.

unsigned	getSizeInBlocks () const

void	reset (EmuTime::param time) override
	This method is called on reset.

void	powerUp (EmuTime::param time) override
	This method is called when MSX is powered up.

byte	readIO (word port, EmuTime::param time) override
	Read a byte from an IO port at a certain time from this device.

byte	peekIO (word port, EmuTime::param time) const override
	Read a byte from a given IO port.

byte	readMem (word address, EmuTime::param time) override
	Read a byte from a location at a certain time from this device.

void	writeMem (word address, byte value, EmuTime::param time) override
	Write a given byte to a given location at a certain time to this device.

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

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

byte	peekMem (word address, EmuTime::param time) const override
	Read a byte from a given memory location.

unsigned	getBaseSizeAlignment () const override
	The 'base' and 'size' attribute values need to be at least aligned to CacheLine::SIZE.

void	writeIO (word port, byte value, EmuTime::param time) override=0
	Write a byte to a given IO port at a certain time to this device.

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

Public Member Functions inherited from openmsx::MSXDevice
	MSXDevice (const MSXDevice &)=delete

	MSXDevice (MSXDevice &&)=delete

MSXDevice &	operator= (const MSXDevice &)=delete

MSXDevice &	operator= (MSXDevice &&)=delete

virtual	~MSXDevice ()=0

const HardwareConfig &	getHardwareConfig () const
	Returns the hardwareconfig this device belongs to.

void	testRemove (std::span< const std::unique_ptr< MSXDevice > > removed) const
	Checks whether this device can be removed (no other device has a reference to it).

virtual byte	readIRQVector ()
	Gets IRQ vector used in IM2.

virtual void	powerDown (EmuTime::param time)
	This method is called when MSX is powered down.

virtual const std::string &	getName () const
	Returns a human-readable name for this device.

virtual void	getNameList (TclObject &result) const
	Returns list of name(s) of this device.

void	getDeviceInfo (TclObject &result) const
	Get device info.

void	getVisibleMemRegion (unsigned &base, unsigned &size) const
	Returns the range where this device is visible in memory.

virtual void	globalWrite (word address, byte value, EmuTime::param time)
	Global writes.

virtual void	globalRead (word address, EmuTime::param time)
	Global reads.

void	invalidateDeviceRWCache ()
	Calls MSXCPUInterface::invalidateXXCache() for the specific (part of) the slot that this device is located in.

void	invalidateDeviceRCache ()

void	invalidateDeviceWCache ()

void	invalidateDeviceRWCache (unsigned start, unsigned size)

void	invalidateDeviceRCache (unsigned start, unsigned size)

void	invalidateDeviceWCache (unsigned start, unsigned size)

void	fillDeviceRWCache (unsigned start, unsigned size, byte *rwData)
	Calls MSXCPUInterface::fillXXCache() for the specific (part of) the slot that this device is located in.

void	fillDeviceRWCache (unsigned start, unsigned size, const byte rData, byte wData)

void	fillDeviceRCache (unsigned start, unsigned size, const byte *rData)

void	fillDeviceWCache (unsigned start, unsigned size, byte *wData)

MSXMotherBoard &	getMotherBoard () const
	Get the mother board this device belongs to.

const XMLElement &	getDeviceConfig () const
	Get the configuration section for this device.

const DeviceConfig &	getDeviceConfig2 () const

const Devices &	getReferences () const
	Get the device references that are specified for this device.

EmuTime::param	getCurrentTime () const

MSXCPU &	getCPU () const

MSXCPUInterface &	getCPUInterface () const

Scheduler &	getScheduler () const

MSXCliComm &	getCliComm () const

Reactor &	getReactor () const

CommandController &	getCommandController () const

PluggingController &	getPluggingController () const

LedStatus &	getLedStatus () const

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

Public Member Functions inherited from openmsx::MSXMapperIOClient
	MSXMapperIOClient (const MSXMapperIOClient &)=delete

	MSXMapperIOClient (MSXMapperIOClient &&)=delete

MSXMapperIOClient &	operator= (const MSXMapperIOClient &)=delete

MSXMapperIOClient &	operator= (MSXMapperIOClient &&)=delete

Protected Member Functions
unsigned	calcAddress (word address) const
	Converts a Z80 address to a RAM address.

unsigned	segmentOffset (byte page) const

void	writeIOImpl (word port, byte value, EmuTime::param time)

Protected Member Functions inherited from openmsx::MSXDevice
	MSXDevice (const DeviceConfig &config, std::string_view name)
	Every MSXDevice has a config entry; this constructor gets some device properties from that config entry.

	MSXDevice (const DeviceConfig &config)

virtual void	init ()

virtual bool	allowUnaligned () const
	By default we don't allow unaligned <mem> specifications in the config file.

virtual void	getExtraDeviceInfo (TclObject &result) const

byte	getPrimarySlot () const

Protected Member Functions inherited from openmsx::MSXMapperIOClient
	MSXMapperIOClient (MSXMotherBoard &motherBoard_)

	~MSXMapperIOClient ()

Protected Member Functions inherited from openmsx::MSXMemoryMapperInterface
	~MSXMemoryMapperInterface ()=default

Protected Attributes
CheckedRam	checkedRam

std::array< byte, 4 >	registers

Protected Attributes inherited from openmsx::MSXDevice
std::string	deviceName

Additional Inherited Members
Public Types inherited from openmsx::MSXDevice
using	Devices = std::vector< MSXDevice * >

Static Public Attributes inherited from openmsx::MSXDevice
static std::array< byte, 0x10000 >	unmappedRead

static std::array< byte, 0x10000 >	unmappedWrite

Detailed Description

Definition at line 13 of file MSXMemoryMapperBase.hh.

Constructor & Destructor Documentation

◆ MSXMemoryMapperBase()

openmsx::MSXMemoryMapperBase::MSXMemoryMapperBase ( const DeviceConfig & config )

explicit

Definition at line 25 of file MSXMemoryMapperBase.cc.

Member Function Documentation

◆ calcAddress()

unsigned openmsx::MSXMemoryMapperBase::calcAddress ( word address ) const

protected

Converts a Z80 address to a RAM address.

Parameters

address Index in Z80 address space.

Returns: Index in RAM address space.

Definition at line 77 of file MSXMemoryMapperBase.cc.

References segmentOffset().

Referenced by getReadCacheLine(), getWriteCacheLine(), openmsx::PanasonicRam::getWriteCacheLine(), peekMem(), readMem(), writeMem(), and openmsx::PanasonicRam::writeMem().

◆ getBaseSizeAlignment()

unsigned openmsx::MSXMemoryMapperBase::getBaseSizeAlignment ( ) const

overridevirtual

The 'base' and 'size' attribute values need to be at least aligned to CacheLine::SIZE.

Though some devices may need a stricter alignment. In that case they must override this method.

Reimplemented from openmsx::MSXDevice.

Definition at line 33 of file MSXMemoryMapperBase.cc.

◆ getReadCacheLine()

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

overridevirtual

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. The start of the interval is CacheLine::SIZE aligned.

Reimplemented from openmsx::MSXDevice.

Reimplemented in openmsx::MusicalMemoryMapper.

Definition at line 97 of file MSXMemoryMapperBase.cc.

References calcAddress(), checkedRam, and openmsx::CheckedRam::getReadCacheLine().

Referenced by openmsx::MusicalMemoryMapper::getReadCacheLine().

◆ getSelectedSegment()

byte openmsx::MSXMemoryMapperBase::getSelectedSegment ( byte page ) const

inlineoverridevirtual

Returns the currently selected segment for the given page.

Parameters

page	Z80 address page (0-3).

Implements openmsx::MSXMemoryMapperInterface.

Definition at line 22 of file MSXMemoryMapperBase.hh.

References registers.

◆ getSizeInBlocks()

unsigned openmsx::MSXMemoryMapperBase::getSizeInBlocks ( ) const

inline

Definition at line 24 of file MSXMemoryMapperBase.hh.

References checkedRam, and openmsx::CheckedRam::size().

◆ getWriteCacheLine()

byte * openmsx::MSXMemoryMapperBase::getWriteCacheLine ( word start )

overridevirtual

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. The start of the interval is CacheLine::SIZE aligned.

Reimplemented from openmsx::MSXDevice.

Reimplemented in openmsx::MusicalMemoryMapper, and openmsx::PanasonicRam.

Definition at line 102 of file MSXMemoryMapperBase.cc.

References calcAddress(), checkedRam, and openmsx::CheckedRam::getWriteCacheLine().

Referenced by openmsx::MusicalMemoryMapper::getWriteCacheLine().

◆ peekIO()

byte openmsx::MSXMemoryMapperBase::peekIO	(	word	port,
		EmuTime::param	time
	)		const

overridevirtual

Read a byte from a given IO port.

Reading via this method has no side effects (doesn't change the device status). If safe reading is not possible this method returns 0xFF. This method is not used by the emulation. It can however be used by a debugger. The default implementation just returns 0xFF.

Reimplemented from openmsx::MSXDevice.

Reimplemented in openmsx::MusicalMemoryMapper.

Definition at line 56 of file MSXMemoryMapperBase.cc.

References checkedRam, registers, and openmsx::CheckedRam::size().

Referenced by openmsx::MusicalMemoryMapper::peekIO(), and readIO().

◆ peekMem()

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

overridevirtual

Read a byte from a given memory location.

Reading memory via this method has no side effects (doesn't change the device status). If save reading is not possible this method returns 0xFF. This method is not used by the emulation. It can however be used by a debugger. The default implementation uses the cache mechanism (getReadCacheLine() method). If a certain region is not cacheable you cannot read it by default, Override this method if you want to improve this behaviour.

Reimplemented from openmsx::MSXDevice.

Reimplemented in openmsx::MusicalMemoryMapper.

Definition at line 82 of file MSXMemoryMapperBase.cc.

References calcAddress(), checkedRam, and openmsx::CheckedRam::peek().

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