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

#include <Carnivore2.hh>

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

Public Member Functions

 Carnivore2 (const DeviceConfig &config)
 
 ~Carnivore2 () 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 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.
 
void globalRead (word address, EmuTime::param time) override
 Global reads.
 
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 getSelectedSegment (byte page) const override
 
template<typename Archive >
void serialize (Archive &ar, unsigned version)
 
- Public Member Functions inherited from openmsx::MSXDevice
 MSXDevice (const MSXDevice &)=delete
 
 MSXDevice (MSXDevice &&)=delete
 
MSXDeviceoperator= (const MSXDevice &)=delete
 
MSXDeviceoperator= (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 const bytegetReadCacheLine (word start) const
 Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for reading.
 
virtual bytegetWriteCacheLine (word start)
 Test that the memory in the interval [start, start + CacheLine::SIZE) is cacheable for writing.
 
virtual void globalWrite (word address, byte value, EmuTime::param time)
 Global writes.
 
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::MSXMapperIOClient
 MSXMapperIOClient (const MSXMapperIOClient &)=delete
 
 MSXMapperIOClient (MSXMapperIOClient &&)=delete
 
MSXMapperIOClientoperator= (const MSXMapperIOClient &)=delete
 
MSXMapperIOClientoperator= (MSXMapperIOClient &&)=delete
 
- Public Member Functions inherited from openmsx::GlobalReadClient< Carnivore2, CT_Interval< 0x0000 >, CT_Interval< 0x4000, 0x4010 > >
 GlobalReadClient (const GlobalReadClient &)=delete
 
 GlobalReadClient (GlobalReadClient &&)=delete
 
 GlobalReadClient ()
 
GlobalReadClientoperator= (const GlobalReadClient &)=delete
 
GlobalReadClientoperator= (GlobalReadClient &&)=delete
 
 ~GlobalReadClient ()
 
- Public Member Functions inherited from openmsx::GlobalRWHelper< MSXDEVICE, CT_INTERVALS >
void execute (std::invocable< MSXCPUInterface &, MSXDevice &, unsigned > auto action)
 

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 Member Functions inherited from openmsx::MSXMapperIOClient
 MSXMapperIOClient (MSXMotherBoard &motherBoard_)
 
 ~MSXMapperIOClient ()
 
- Protected Member Functions inherited from openmsx::MSXMemoryMapperInterface
 ~MSXMemoryMapperInterface ()=default
 
- Protected Attributes inherited from openmsx::MSXDevice
std::string deviceName
 

Detailed Description

Definition at line 22 of file Carnivore2.hh.

Constructor & Destructor Documentation

◆ Carnivore2()

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

Definition at line 27 of file Carnivore2.cc.

◆ ~Carnivore2()

openmsx::Carnivore2::~Carnivore2 ( )
override

Member Function Documentation

◆ getSelectedSegment()

byte openmsx::Carnivore2::getSelectedSegment ( byte  page) const
overridevirtual

Implements openmsx::MSXMemoryMapperInterface.

Definition at line 844 of file Carnivore2.cc.

Referenced by peekIO().

◆ globalRead()

void openmsx::Carnivore2::globalRead ( word  address,
EmuTime::param  time 
)
overridevirtual

Global reads.

Similar to globalWrite() but then for reads. 'Carnivore2' is an example of a device that monitors the MSX bus for reads in any slot.

Reimplemented from openmsx::MSXDevice.

Definition at line 128 of file Carnivore2.cc.

References openmsx::MSXDevice::getCPU(), and xrange().

◆ peekIO()

byte openmsx::Carnivore2::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 786 of file Carnivore2.cc.

References openmsx::MSXDevice::getPrimarySlot(), and getSelectedSegment().

Referenced by readIO().

◆ peekMem()

byte openmsx::Carnivore2::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 189 of file Carnivore2.cc.

◆ powerUp()

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

References openmsx::SCC::powerUp(), and reset().

◆ readIO()

byte openmsx::Carnivore2::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 781 of file Carnivore2.cc.

References peekIO().

◆ readMem()

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

◆ reset()

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

This method is called on reset.

Default implementation does nothing.

Reimplemented from openmsx::MSXDevice.

Definition at line 69 of file Carnivore2.cc.

References ranges::iota(), openmsx::AY8910::reset(), openmsx::SCC::reset(), and openmsx::YM2413::reset().

Referenced by powerUp().

◆ serialize()

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

Definition at line 853 of file Carnivore2.cc.

References openmsx::MSXDevice::getCurrentTime().

◆ writeIO()

void openmsx::Carnivore2::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 802 of file Carnivore2.cc.

References openmsx::MSXDevice::invalidateDeviceRWCache(), openmsx::YM2413::writePort(), and openmsx::AY8910::writeRegister().

◆ writeMem()

void openmsx::Carnivore2::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 204 of file Carnivore2.cc.


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