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

#include <MSXMusic.hh>

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

Public Member Functions

void reset (EmuTime::param time) override
 This method is called on reset. More...
 
void writeIO (word port, byte value, EmuTime::param time) override
 Write a byte to a given IO port at a certain time to this device. More...
 
byte peekMem (word address, EmuTime::param time) const override
 Read a byte from a given memory location. More...
 
byte readMem (word address, EmuTime::param time) override
 Read a byte from a location at a certain time from this device. More...
 
const bytegetReadCacheLine (word start) const override
 Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for reading. More...
 
template<typename Archive >
void serialize (Archive &ar, unsigned version)
 
- 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. 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 void powerUp (EmuTime::param time)
 This method is called when MSX is powered up. 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 byte peekIO (word port, EmuTime::param time) const
 Read a byte from a given IO port. More...
 
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. More...
 
virtual bytegetWriteCacheLine (word start) const
 Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for writing. More...
 
virtual void globalWrite (word address, byte value, EmuTime::param time)
 Global writes. More...
 
virtual void globalRead (word address, EmuTime::param time)
 Global reads. More...
 
void invalidateMemCache (word start, unsigned size)
 Invalidate CPU memory-mapping cache. More...
 
MSXMotherBoardgetMotherBoard () const
 Get the mother board this device belongs to. More...
 
const XMLElementgetDeviceConfig () const
 Get the configuration section for this device. More...
 
const DeviceConfiggetDeviceConfig2 () const
 
const DevicesgetReferences () const
 Get the device references that are specified for this device. More...
 
EmuTime::param getCurrentTime () const
 
MSXCPUgetCPU () const
 
MSXCPUInterfacegetCPUInterface () const
 
SchedulergetScheduler () const
 
CliCommgetCliComm () const
 
ReactorgetReactor () const
 
CommandControllergetCommandController () const
 
PluggingControllergetPluggingController () const
 
LedStatusgetLedStatus () const
 
template<typename Archive >
void serialize (Archive &ar, unsigned version)
 

Protected Member Functions

 MSXMusicBase (const DeviceConfig &config)
 
 ~MSXMusicBase () override=default
 
void writeRegisterPort (byte value, EmuTime::param time)
 
void writeDataPort (byte value, EmuTime::param time)
 
- 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

Rom rom
 
YM2413 ym2413
 

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 MSXMusic.hh.

Constructor & Destructor Documentation

◆ MSXMusicBase()

openmsx::MSXMusicBase::MSXMusicBase ( const DeviceConfig config)
explicitprotected

◆ ~MSXMusicBase()

openmsx::MSXMusicBase::~MSXMusicBase ( )
overrideprotecteddefault

Member Function Documentation

◆ getReadCacheLine()

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

Definition at line 61 of file MSXMusic.cc.

References openmsx::Rom::getSize(), and rom.

Referenced by openmsx::MSXMusicWX::getReadCacheLine(), and peekMem().

◆ peekMem()

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

Definition at line 51 of file MSXMusic.cc.

References getReadCacheLine().

Referenced by openmsx::MSXMusicWX::peekMem(), and readMem().

◆ readMem()

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

Reimplemented in openmsx::MSXMusicWX.

Definition at line 56 of file MSXMusic.cc.

References peekMem().

◆ reset()

void openmsx::MSXMusicBase::reset ( EmuTime::param  time)
overridevirtual

This method is called on reset.

Default implementation does nothing.

Reimplemented from openmsx::MSXDevice.

Reimplemented in openmsx::MSXMusicWX.

Definition at line 23 of file MSXMusic.cc.

References openmsx::YM2413::reset(), and ym2413.

Referenced by MSXMusicBase(), openmsx::MSXFmPac::reset(), and openmsx::MSXMusicWX::reset().

◆ serialize()

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

Definition at line 69 of file MSXMusic.cc.

References openmsx::YM2413::serialize(), and ym2413.

◆ writeDataPort()

void openmsx::MSXMusicBase::writeDataPort ( byte  value,
EmuTime::param  time 
)
protected

Definition at line 46 of file MSXMusic.cc.

References openmsx::YM2413::writeReg(), and ym2413.

Referenced by writeIO(), and openmsx::MSXFmPac::writeMem().

◆ writeIO()

void openmsx::MSXMusicBase::writeIO ( word  port,
byte  value,
EmuTime::param  time 
)
overridevirtual

Write a byte to a given IO port at a certain time to this device.

The default implementation ignores the write (does nothing)

Reimplemented from openmsx::MSXDevice.

Definition at line 29 of file MSXMusic.cc.

References writeDataPort(), and writeRegisterPort().

Referenced by openmsx::MSXFmPac::writeIO().

◆ writeRegisterPort()

void openmsx::MSXMusicBase::writeRegisterPort ( byte  value,
EmuTime::param  time 
)
protected

Definition at line 41 of file MSXMusic.cc.

Referenced by writeIO(), and openmsx::MSXFmPac::writeMem().

Member Data Documentation

◆ rom

Rom openmsx::MSXMusicBase::rom
protected

◆ ym2413

YM2413 openmsx::MSXMusicBase::ym2413
protected

Definition at line 31 of file MSXMusic.hh.

Referenced by reset(), serialize(), and writeDataPort().


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