#include <MSXMemoryMapper.hh>

Inheritance diagram for openmsx::MSXMemoryMapper:

Collaboration diagram for openmsx::MSXMemoryMapper:

[legend]

Public Member Functions
	MSXMemoryMapper (const DeviceConfig &config)

virtual	~MSXMemoryMapper ()

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

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

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

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. More...

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

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

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

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

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

MSXDevice &	operator= (const MSXDevice &)=delete

virtual	~MSXDevice ()=0

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

void	testRemove (Devices alreadyRemoved) const
	Checks whether this device can be removed (no other device has a reference to it). More...

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

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

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

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

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

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

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

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

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

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

void	invalidateMemCache (word start, unsigned size)
	Invalidate CPU memory-mapping cache. More...

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

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

const DeviceConfig &	getDeviceConfig2 () const

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

EmuTime::param	getCurrentTime () const

MSXCPU &	getCPU () const

MSXCPUInterface &	getCPUInterface () const

Scheduler &	getScheduler () const

CliComm &	getCliComm () const

Reactor &	getReactor () const

CommandController &	getCommandController () const

PluggingController &	getPluggingController () const

LedStatus &	getLedStatus () const

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

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

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

	MSXDevice (const DeviceConfig &config)

virtual void	init ()

virtual void	getExtraDeviceInfo (TclObject &result) const

Protected Attributes
CheckedRam	checkedRam

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

Static Public Attributes inherited from openmsx::MSXDevice
static byte	unmappedRead [0x10000]

static byte	unmappedWrite [0x10000]

Detailed Description

Definition at line 11 of file MSXMemoryMapper.hh.

Constructor & Destructor Documentation

◆ MSXMemoryMapper()

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

explicit

Definition at line 22 of file MSXMemoryMapper.cc.

References checkedRam, openmsx::CheckedRam::getSize(), and openmsx::MSXMapperIO::registerMapper().

◆ ~MSXMemoryMapper()

openmsx::MSXMemoryMapper::~MSXMemoryMapper ( )

virtual

Definition at line 31 of file MSXMemoryMapper.cc.

References checkedRam, openmsx::MSXMotherBoard::destroyMapperIO(), openmsx::MSXDevice::getMotherBoard(), openmsx::CheckedRam::getSize(), and openmsx::MSXMapperIO::unregisterMapper().

Member Function Documentation

◆ calcAddress()

unsigned openmsx::MSXMemoryMapper::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 49 of file MSXMemoryMapper.cc.

References checkedRam, openmsx::MSXMapperIO::getSelectedPage(), and openmsx::CheckedRam::getSize().

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

◆ getReadCacheLine()

const byte * openmsx::MSXMemoryMapper::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.

Definition at line 72 of file MSXMemoryMapper.cc.

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

◆ getWriteCacheLine()

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

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::PanasonicRam.

Definition at line 77 of file MSXMemoryMapper.cc.

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

◆ peekMem()

byte openmsx::MSXMemoryMapper::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.

Definition at line 57 of file MSXMemoryMapper.cc.

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

◆ powerUp()

void openmsx::MSXMemoryMapper::powerUp ( EmuTime::param time )

overridevirtual

This method is called when MSX is powered up.

The default implementation calls reset(), this is usually ok.

Parameters

time	The moment in time the power up occurs.

Reimplemented from openmsx::MSXDevice.

Definition at line 38 of file MSXMemoryMapper.cc.

References checkedRam, openmsx::CheckedRam::clear(), and reset().

◆ readMem()

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

overridevirtual

Read a byte from a location at a certain time from this device.

The default implementation returns 255.

Reimplemented from openmsx::MSXDevice.

Definition at line 62 of file MSXMemoryMapper.cc.

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

◆ reset()

void openmsx::MSXMemoryMapper::reset ( EmuTime::param time )

overridevirtual

This method is called on reset.

Default implementation does nothing.

Reimplemented from openmsx::MSXDevice.

Definition at line 44 of file MSXMemoryMapper.cc.

References openmsx::MSXMapperIO::reset().

Referenced by powerUp().

◆ serialize()

template<typename Archive >

void openmsx::MSXMemoryMapper::serialize	(	Archive &	ar,
		unsigned	version
	)

Definition at line 83 of file MSXMemoryMapper.cc.

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

◆ writeMem()

void openmsx::MSXMemoryMapper::writeMem	(	word	address,
		byte	value,
		EmuTime::param	time
	)

overridevirtual

Write a given byte to a given location at a certain time to this device.

The default implementation ignores the write (does nothing).

Reimplemented from openmsx::MSXDevice.

Reimplemented in openmsx::PanasonicRam.

Definition at line 67 of file MSXMemoryMapper.cc.

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

Member Data Documentation

◆ checkedRam

CheckedRam openmsx::MSXMemoryMapper::checkedRam

protected

Definition at line 35 of file MSXMemoryMapper.hh.

Referenced by calcAddress(), getReadCacheLine(), openmsx::PanasonicRam::getWriteCacheLine(), getWriteCacheLine(), MSXMemoryMapper(), openmsx::PanasonicRam::PanasonicRam(), peekMem(), powerUp(), readMem(), serialize(), openmsx::PanasonicRam::writeMem(), writeMem(), and ~MSXMemoryMapper().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MSXMemoryMapper()

◆ ~MSXMemoryMapper()

Member Function Documentation

◆ calcAddress()

◆ getReadCacheLine()

◆ getWriteCacheLine()

◆ peekMem()

◆ powerUp()

◆ readMem()

◆ reset()

◆ serialize()

◆ writeMem()

Member Data Documentation

◆ checkedRam