#include <MSXAudio.hh>

Inheritance diagram for openmsx::MSXAudio:

Collaboration diagram for openmsx::MSXAudio:

[legend]

Public Member Functions
	MSXAudio (const DeviceConfig &config)

	~MSXAudio () override

Y8950Periphery &	createPeriphery (const std::string &soundDeviceName)
	Creates a periphery object for this MSXAudio cartridge.

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

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

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.

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.

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

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

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.

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)

Friends
class	MusicModulePeriphery

class	PanasonicAudioPeriphery

class	ToshibaAudioPeriphery

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

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.

virtual void	getExtraDeviceInfo (TclObject &result) const

byte	getPrimarySlot () const

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

Detailed Description

Definition at line 14 of file MSXAudio.hh.

Constructor & Destructor Documentation

◆ MSXAudio()

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

explicit

Definition at line 12 of file MSXAudio.cc.

References openmsx::DeviceConfig::getChildData(), openmsx::MSXDevice::getCurrentTime(), openmsx::MSXDevice::getName(), and powerUp().

◆ ~MSXAudio()

openmsx::MSXAudio::~MSXAudio ( )

override

Definition at line 27 of file MSXAudio.cc.

Member Function Documentation

◆ createPeriphery()

Y8950Periphery & openmsx::MSXAudio::createPeriphery ( const std::string & soundDeviceName )

Creates a periphery object for this MSXAudio cartridge.

The ownership of the object remains with the MSXAudio instance.

Definition at line 34 of file MSXAudio.cc.

References openmsx::Y8950PeripheryFactory::create(), and openmsx::MSXDevice::getDeviceConfig2().

◆ getReadCacheLine()

const byte * openmsx::MSXAudio::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 105 of file MSXAudio.cc.

◆ getWriteCacheLine()

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

Definition at line 109 of file MSXAudio.cc.

◆ peekIO()

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

Definition at line 65 of file MSXAudio.cc.

References openmsx::Y8950::peekReg(), and openmsx::Y8950::peekStatus().

◆ peekMem()

byte openmsx::MSXAudio::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 97 of file MSXAudio.cc.

◆ powerUp()

void openmsx::MSXAudio::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 41 of file MSXAudio.cc.

References openmsx::Y8950::clearRam(), and reset().

Referenced by MSXAudio().

◆ readIO()

byte openmsx::MSXAudio::readIO	(	word	port,
		EmuTime::param	time
	)

overridevirtual

Read a byte from an IO port at a certain time from this device.

The default implementation returns 255.

Reimplemented from openmsx::MSXDevice.

Definition at line 54 of file MSXAudio.cc.

References openmsx::Y8950::readReg(), and openmsx::Y8950::readStatus().

◆ readMem()

byte openmsx::MSXAudio::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 93 of file MSXAudio.cc.

◆ reset()

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

overridevirtual

This method is called on reset.

Default implementation does nothing.

Reimplemented from openmsx::MSXDevice.

Definition at line 47 of file MSXAudio.cc.

References openmsx::Y8950::reset().

Referenced by powerUp().

◆ serialize()

template<typename Archive >

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

Definition at line 124 of file MSXAudio.cc.

References openmsx::MSXDevice::getCurrentTime().

◆ writeIO()

void openmsx::MSXAudio::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 76 of file MSXAudio.cc.

References openmsx::Y8950::writeReg().

◆ writeMem()

void openmsx::MSXAudio::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.

Definition at line 101 of file MSXAudio.cc.

Friends And Related Symbol Documentation

◆ MusicModulePeriphery

friend class MusicModulePeriphery

friend

Definition at line 50 of file MSXAudio.hh.

◆ PanasonicAudioPeriphery

friend class PanasonicAudioPeriphery

friend

Definition at line 51 of file MSXAudio.hh.

◆ ToshibaAudioPeriphery

friend class ToshibaAudioPeriphery

friend

Definition at line 52 of file MSXAudio.hh.

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MSXAudio()

◆ ~MSXAudio()

Member Function Documentation

◆ createPeriphery()

◆ getReadCacheLine()

◆ getWriteCacheLine()

◆ peekIO()

◆ peekMem()

◆ powerUp()

◆ readIO()

◆ readMem()

◆ reset()

◆ serialize()

◆ writeIO()

◆ writeMem()

Friends And Related Symbol Documentation

◆ MusicModulePeriphery

◆ PanasonicAudioPeriphery

◆ ToshibaAudioPeriphery