openMSX
Classes | Public Member Functions | List of all members
openmsx::MSXRS232 Class Referencefinal

#include <MSXRS232.hh>

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

Public Member Functions

 MSXRS232 (const DeviceConfig &config)
 
 ~MSXRS232 () override
 
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.
 
const bytegetReadCacheLine (word start) const override
 Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for reading.
 
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 start) const override
 Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for writing.
 
bool allowUnaligned () const override
 By default we don't allow unaligned <mem> specifications in the config file.
 
void setDataBits (DataBits bits) override
 
void setStopBits (StopBits bits) override
 
void setParityBit (bool enable, ParityBit parity) override
 
void recvByte (byte value, EmuTime::param time) override
 
bool ready () override
 
bool acceptsData () override
 
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.
 
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 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)
 
- Public Member Functions inherited from openmsx::RS232Connector
RS232DevicegetPluggedRS232Dev () const
 
std::string_view getDescription () const final
 Get a description for this connector.
 
std::string_view getClass () const final
 A Connector belong to a certain class.
 
template<typename Archive >
void serialize (Archive &ar, unsigned version)
 
- Public Member Functions inherited from openmsx::Connector
 Connector (const Connector &)=delete
 
Connectoroperator= (const Connector &)=delete
 
const std::string & getName () const
 Name that identifies this connector.
 
virtual void plug (Pluggable &device, EmuTime::param time)
 This plugs a Pluggable in this Connector.
 
virtual void unplug (EmuTime::param time)
 This unplugs the currently inserted Pluggable from this Connector.
 
PluggablegetPlugged () const
 Returns the Pluggable currently plugged in.
 
PluggingControllergetPluggingController () const
 
template<typename Archive >
void serialize (Archive &ar, unsigned version)
 

Additional Inherited Members

- Public Types inherited from openmsx::MSXDevice
using Devices = std::vector< MSXDevice * >
 
- Public Types inherited from openmsx::SerialDataInterface
enum  DataBits { DATA_5 = 5 , DATA_6 = 6 , DATA_7 = 7 , DATA_8 = 8 }
 
enum  StopBits { STOP_INV = 0 , STOP_1 = 2 , STOP_15 = 3 , STOP_2 = 4 }
 
enum  ParityBit { EVEN = 0 , ODD = 1 }
 
- 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 void getExtraDeviceInfo (TclObject &result) const
 
byte getPrimarySlot () const
 
- Protected Member Functions inherited from openmsx::RS232Connector
 RS232Connector (PluggingController &pluggingController, std::string name)
 
 ~RS232Connector ()=default
 
- Protected Member Functions inherited from openmsx::Connector
 Connector (PluggingController &pluggingController, std::string name, std::unique_ptr< Pluggable > dummy)
 Creates a new Connector.
 
 ~Connector ()
 
- Protected Member Functions inherited from openmsx::SerialDataInterface
 ~SerialDataInterface ()=default
 
- Protected Attributes inherited from openmsx::MSXDevice
std::string deviceName
 

Detailed Description

Definition at line 17 of file MSXRS232.hh.

Constructor & Destructor Documentation

◆ MSXRS232()

openmsx::MSXRS232::MSXRS232 ( const DeviceConfig config)
explicit

◆ ~MSXRS232()

openmsx::MSXRS232::~MSXRS232 ( )
overridedefault

Member Function Documentation

◆ acceptsData()

bool openmsx::MSXRS232::acceptsData ( )
overridevirtual

Implements openmsx::RS232Connector.

Definition at line 399 of file MSXRS232.cc.

References openmsx::I8251::isRecvEnabled().

◆ allowUnaligned()

bool openmsx::MSXRS232::allowUnaligned ( ) const
overridevirtual

By default we don't allow unaligned <mem> specifications in the config file.

Though for a machine like 'Victor HC-95A' is it useful to model it with combinations of unaligned devices. So we do allow it for a select few devices: devices that promise to not call any of the 'fillDeviceXXXCache()' methods.

Reimplemented from openmsx::MSXDevice.

Definition at line 140 of file MSXRS232.cc.

◆ getReadCacheLine()

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

References openmsx::CacheLine::HIGH, openmsx::RAM_OFFSET, openmsx::RAM_SIZE, and openmsx::MSXDevice::unmappedRead.

◆ getWriteCacheLine()

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

Definition at line 127 of file MSXRS232.cc.

References openmsx::CacheLine::HIGH, openmsx::RAM_OFFSET, openmsx::RAM_SIZE, and openmsx::MSXDevice::unmappedWrite.

◆ peekIO()

byte openmsx::MSXRS232::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 174 of file MSXRS232.cc.

References openmsx::I8254::peekIO(), openmsx::I8251::peekIO(), and UNREACHABLE.

◆ powerUp()

void openmsx::MSXRS232::powerUp ( EmuTime::param  time)
overridevirtual

This method is called when MSX is powered up.

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

Parameters
timeThe moment in time the power up occurs.

Reimplemented from openmsx::MSXDevice.

Definition at line 60 of file MSXRS232.cc.

References reset().

Referenced by MSXRS232().

◆ readIO()

byte openmsx::MSXRS232::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 146 of file MSXRS232.cc.

◆ readMem()

byte openmsx::MSXRS232::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 77 of file MSXRS232.cc.

References openmsx::RAM_OFFSET, and openmsx::RAM_SIZE.

◆ ready()

bool openmsx::MSXRS232::ready ( )
overridevirtual

Implements openmsx::RS232Connector.

Definition at line 394 of file MSXRS232.cc.

References openmsx::I8251::isRecvReady().

◆ recvByte()

void openmsx::MSXRS232::recvByte ( byte  value,
EmuTime::param  time 
)
overridevirtual

Implements openmsx::RS232Connector.

Definition at line 419 of file MSXRS232.cc.

References openmsx::I8251::recvByte().

◆ reset()

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

This method is called on reset.

Default implementation does nothing.

Reimplemented from openmsx::MSXDevice.

Definition at line 66 of file MSXRS232.cc.

References openmsx::IntHelper< SOURCE >::reset().

Referenced by powerUp().

◆ serialize()

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

Definition at line 428 of file MSXRS232.cc.

◆ setDataBits()

void openmsx::MSXRS232::setDataBits ( DataBits  bits)
overridevirtual

Implements openmsx::RS232Connector.

Definition at line 404 of file MSXRS232.cc.

References openmsx::I8251::setDataBits().

◆ setParityBit()

void openmsx::MSXRS232::setParityBit ( bool  enable,
ParityBit  parity 
)
overridevirtual

Implements openmsx::RS232Connector.

Definition at line 414 of file MSXRS232.cc.

References openmsx::I8251::setParityBit().

◆ setStopBits()

void openmsx::MSXRS232::setStopBits ( StopBits  bits)
overridevirtual

Implements openmsx::RS232Connector.

Definition at line 409 of file MSXRS232.cc.

References openmsx::I8251::setStopBits().

◆ writeIO()

void openmsx::MSXRS232::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 196 of file MSXRS232.cc.

◆ writeMem()

void openmsx::MSXRS232::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 107 of file MSXRS232.cc.

References openmsx::RAM_OFFSET, and openmsx::RAM_SIZE.


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