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. More...
 
void reset (EmuTime::param time) override
 This method is called on reset. More...
 
byte readIO (word port, EmuTime::param time) override
 Read a byte from an IO port at a certain time from this device. More...
 
byte peekIO (word port, EmuTime::param time) const override
 Read a byte from a given IO port. 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 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...
 
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. More...
 
bytegetWriteCacheLine (word start) const override
 Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for writing. More...
 
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. 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 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 peekMem (word address, EmuTime::param time) const
 Read a byte from a given memory location. 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)
 
- Public Member Functions inherited from openmsx::RS232Connector
RS232DevicegetPluggedRS232Dev () const
 
string_view getDescription () const final override
 Get a description for this connector. More...
 
string_view getClass () const final override
 A Connector belong to a certain class. More...
 
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. More...
 
virtual void plug (Pluggable &device, EmuTime::param time)
 This plugs a Pluggable in this Connector. More...
 
virtual void unplug (EmuTime::param time)
 This unplugs the currently inserted Pluggable from this Connector. More...
 
PluggablegetPlugged () const
 Returns the Pluggable currently plugged in. More...
 
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 byte unmappedRead [0x10000]
 
static byte unmappedWrite [0x10000]
 
- 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 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. More...
 
 ~Connector ()
 
- Protected Member Functions inherited from openmsx::SerialDataInterface
 ~SerialDataInterface ()=default
 

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

Referenced by MSXRS232().

Member Function Documentation

◆ acceptsData()

bool openmsx::MSXRS232::acceptsData ( )
overridevirtual

Implements openmsx::RS232Connector.

Definition at line 402 of file MSXRS232.cc.

References openmsx::I8251::isRecvEnabled().

◆ 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 91 of file MSXRS232.cc.

References openmsx::RAM_OFFSET, 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 126 of file MSXRS232.cc.

References openmsx::RAM_OFFSET, 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 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 just returns 0xFF.

Reimplemented from openmsx::MSXDevice.

Definition at line 173 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 59 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 139 of file MSXRS232.cc.

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

◆ 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 76 of file MSXRS232.cc.

References openmsx::RAM_OFFSET.

◆ ready()

bool openmsx::MSXRS232::ready ( )
overridevirtual

Implements openmsx::RS232Connector.

Definition at line 397 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 422 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 65 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 431 of file MSXRS232.cc.

◆ setDataBits()

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

Implements openmsx::RS232Connector.

Definition at line 407 of file MSXRS232.cc.

References openmsx::I8251::setDataBits().

◆ setParityBit()

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

Implements openmsx::RS232Connector.

Definition at line 417 of file MSXRS232.cc.

References openmsx::I8251::setParityBit().

◆ setStopBits()

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

Implements openmsx::RS232Connector.

Definition at line 412 of file MSXRS232.cc.

References openmsx::I8251::setStopBits().

◆ writeIO()

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

◆ 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 106 of file MSXRS232.cc.

References openmsx::RAM_OFFSET.


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