openMSX
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
openmsx::MSXRom Class Reference

#include <MSXRom.hh>

Inheritance diagram for openmsx::MSXRom:
Inheritance graph
[legend]
Collaboration diagram for openmsx::MSXRom:
Collaboration graph
[legend]

Public Member Functions

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.
 
bytegetWriteCacheLine (word address) const override
 Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for writing.
 
void getExtraDeviceInfo (TclObject &result) const override
 
void getInfo (TclObject &result) const
 Add dict values with info to result.
 
RomType getRomType () const
 
- Public Member Functions inherited from openmsx::MSXDevice
 MSXDevice (const MSXDevice &)=delete
 
MSXDeviceoperator= (const MSXDevice &)=delete
 
virtual ~MSXDevice ()=0
 
const HardwareConfiggetHardwareConfig () 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 void reset (EmuTime::param time)
 This method is called on reset.
 
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 void powerUp (EmuTime::param time)
 This method is called when MSX is powered up.
 
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 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 byte readMem (word address, EmuTime::param time)
 Read a byte from a location at a certain time from this device.
 
virtual const bytegetReadCacheLine (word start) const
 Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for reading.
 
virtual byte peekMem (word address, EmuTime::param time) const
 Read a byte from a given memory location.
 
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)
 
MSXMotherBoardgetMotherBoard () const
 Get the mother board this device belongs to.
 
const XMLElementgetDeviceConfig () const
 Get the configuration section for this device.
 
const DeviceConfiggetDeviceConfig2 () const
 
const DevicesgetReferences () const
 Get the device references that are specified for this device.
 
EmuTime::param getCurrentTime () const
 
MSXCPUgetCPU () const
 
MSXCPUInterfacegetCPUInterface () const
 
SchedulergetScheduler () const
 
MSXCliCommgetCliComm () const
 
ReactorgetReactor () const
 
CommandControllergetCommandController () const
 
PluggingControllergetPluggingController () const
 
LedStatusgetLedStatus () const
 
template<typename Archive >
void serialize (Archive &ar, unsigned version)
 

Protected Member Functions

 MSXRom (const DeviceConfig &config, Rom &&rom)
 
- 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 unsigned getBaseSizeAlignment () const
 The 'base' and 'size' attribute values need to be at least aligned to CacheLine::SIZE.
 
virtual bool allowUnaligned () const
 By default we don't allow unaligned <mem> specifications in the config file.
 
byte getPrimarySlot () const
 

Protected Attributes

Rom rom
 
- 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 10 of file MSXRom.hh.

Constructor & Destructor Documentation

◆ MSXRom()

openmsx::MSXRom::MSXRom ( const DeviceConfig config,
Rom &&  rom 
)
protected

Definition at line 8 of file MSXRom.cc.

Member Function Documentation

◆ getExtraDeviceInfo()

void openmsx::MSXRom::getExtraDeviceInfo ( TclObject result) const
overridevirtual
See also
getDeviceInfo() Default implementation does nothing. Subclasses can override this method to add extra info (like subtypes).

Reimplemented from openmsx::MSXDevice.

Definition at line 56 of file MSXRom.cc.

References openmsx::TclObject::addDictKeyValue(), openmsx::Rom::getFilename(), getInfo(), and rom.

◆ getInfo()

void openmsx::MSXRom::getInfo ( TclObject result) const

Add dict values with info to result.

Definition at line 40 of file MSXRom.cc.

References openmsx::TclObject::addDictKeyValues(), openmsx::Rom::getOriginalSHA1(), openmsx::Rom::getSHA1(), rom, and openmsx::Sha1Sum::toString().

Referenced by getExtraDeviceInfo().

◆ getRomType()

RomType openmsx::MSXRom::getRomType ( ) const

Definition at line 33 of file MSXRom.cc.

References openmsx::RomInfo::nameToRomType(), and openmsx::ROM_UNKNOWN.

◆ getWriteCacheLine()

byte * openmsx::MSXRom::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::ReproCartridgeV1, openmsx::ReproCartridgeV2, openmsx::RomAscii16_2, openmsx::RomAscii16kB, openmsx::RomAscii8_8, openmsx::RomAscii8kB, openmsx::RomCrossBlaim, openmsx::RomDooly, openmsx::RomFSA1FM1, openmsx::RomFSA1FM2, openmsx::RomGameMaster2, openmsx::RomGeneric16kB, openmsx::RomGeneric8kB, openmsx::RomHalnote, openmsx::RomHarryFox, openmsx::RomHolyQuran, openmsx::RomHolyQuran2, openmsx::ROMHunterMk2, openmsx::RomKonami, openmsx::RomKonamiSCC, openmsx::RomMajutsushi, openmsx::RomManbow2, openmsx::RomMatraCompilation, openmsx::RomMatraInk, openmsx::RomMitsubishiMLTS2, openmsx::RomMSXDOS2, openmsx::RomMSXtra, openmsx::RomMSXWrite, openmsx::RomNational, openmsx::RomNeo16, openmsx::RomNeo8, openmsx::RomNettouYakyuu, openmsx::RomPanasonic, openmsx::RomPlayBall, openmsx::RomRamFile, openmsx::RomRetroHard31in1, openmsx::RomRType, openmsx::RomSuperSwangi, openmsx::RomSynthesizer, openmsx::RomZemina126in1, openmsx::RomZemina25in1, openmsx::RomZemina80in1, and openmsx::RomZemina90in1.

Definition at line 19 of file MSXRom.cc.

References openmsx::MSXDevice::unmappedWrite.

◆ writeMem()

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

Member Data Documentation

◆ rom

Rom openmsx::MSXRom::rom
protected

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