#include <MSXMemoryMapper.hh>

Inheritance diagram for openmsx::MSXMemoryMapper:

Collaboration diagram for openmsx::MSXMemoryMapper:

Public Member Functions
	MSXMemoryMapper (const DeviceConfig &config)
virtual	~MSXMemoryMapper ()
virtual void	reset (EmuTime::param time)
	This method is called on reset.
virtual void	powerUp (EmuTime::param time)
	This method is called when MSX is powered up.
virtual byte	readMem (word address, EmuTime::param time)
	Read a byte from a location at a certain time from this device.
virtual void	writeMem (word address, byte value, EmuTime::param time)
	Write a given byte to a given location at a certain time to this device.
virtual const byte *	getReadCacheLine (word start) const
	Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for reading.
virtual byte *	getWriteCacheLine (word start) const
	Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for writing.
virtual byte	peekMem (word address, EmuTime::param time) const
	Read a byte from a given memory location.
template<typename Archive >
void	serialize (Archive &ar, unsigned version)
Public Member Functions inherited from openmsx::MSXDevice
virtual	~MSXDevice ()=0
const HardwareConfig &	getHardwareConfig () const
	Returns the hardwareconfig this device belongs to.
void	testRemove (Devices alreadyRemoved) 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 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 byte	readIO (word port, EmuTime::param time)
	Read a byte from an IO port at a certain time from this device.
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.
virtual byte	peekIO (word port, EmuTime::param time) const
	Read a byte from a given IO port.
virtual void	globalWrite (word address, byte value, EmuTime::param time)
	Global writes.
void	invalidateMemCache (word start, unsigned size)
	Invalidate CPU memory-mapping cache.
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
CliComm &	getCliComm () const
Reactor &	getReactor () const
CommandController &	getCommandController () const
PluggingController &	getPluggingController () const
LedStatus &	getLedStatus () const

Protected Member Functions
unsigned	calcAddress (word address) const
	Converts a Z80 address to a RAM address.
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.
	MSXDevice (const DeviceConfig &config)
virtual void	init ()
virtual void	getExtraDeviceInfo (TclObject &result) const

Protected Attributes
const std::unique_ptr< CheckedRam >	checkedRam

Additional Inherited Members
Public Types inherited from openmsx::MSXDevice
typedef std::vector< MSXDevice * >	Devices
Static Public Attributes inherited from openmsx::MSXDevice
static byte	unmappedRead [0x10000]
static byte	unmappedWrite [0x10000]

Detailed Description

Definition at line 12 of file MSXMemoryMapper.hh.

Constructor & Destructor Documentation

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

explicit

Definition at line 25 of file MSXMemoryMapper.cc.

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

openmsx::MSXMemoryMapper::~MSXMemoryMapper ( )

virtual

Definition at line 34 of file MSXMemoryMapper.cc.

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

Member Function Documentation

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 52 of file MSXMemoryMapper.cc.

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

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

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

virtual

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 75 of file MSXMemoryMapper.cc.

References calcAddress(), and checkedRam.

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

virtual

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 80 of file MSXMemoryMapper.cc.

References calcAddress(), and checkedRam.

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

virtual

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 60 of file MSXMemoryMapper.cc.

References calcAddress(), and checkedRam.

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

virtual

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 41 of file MSXMemoryMapper.cc.

References checkedRam, and reset().

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

virtual

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 65 of file MSXMemoryMapper.cc.

References calcAddress(), and checkedRam.

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

virtual

This method is called on reset.

Default implementation does nothing.

Reimplemented from openmsx::MSXDevice.

Definition at line 47 of file MSXMemoryMapper.cc.

References openmsx::MSXMapperIO::reset().

Referenced by powerUp().

template<typename Archive >

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

Reimplemented from openmsx::MSXDevice.

Reimplemented in openmsx::PanasonicRam.

Definition at line 86 of file MSXMemoryMapper.cc.

References checkedRam.

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

virtual

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 70 of file MSXMemoryMapper.cc.

References calcAddress(), and checkedRam.

Member Data Documentation

const std::unique_ptr<CheckedRam> openmsx::MSXMemoryMapper::checkedRam

protected

Definition at line 36 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

Member Function Documentation

Member Data Documentation