openMSX
Public Member Functions | Protected Member Functions | Friends | List of all members
openmsx::IDECDROM Class Referencefinal

#include <IDECDROM.hh>

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

Public Member Functions

 IDECDROM (const IDECDROM &)=delete
 
IDECDROMoperator= (const IDECDROM &)=delete
 
 IDECDROM (const DeviceConfig &config)
 
 ~IDECDROM () override
 
void eject ()
 
void insert (const std::string &filename)
 
template<typename Archive >
void serialize (Archive &ar, unsigned version)
 
- Public Member Functions inherited from openmsx::AbstractIDEDevice
void reset (EmuTime::param time) override
 
word readData (EmuTime::param time) override
 
byte readReg (nibble reg, EmuTime::param time) override
 
void writeData (word value, EmuTime::param time) override
 
void writeReg (nibble reg, byte value, EmuTime::param time) override
 
template<typename Archive >
void serialize (Archive &ar, unsigned version)
 
- Public Member Functions inherited from openmsx::IDEDevice
virtual ~IDEDevice ()=default
 

Protected Member Functions

bool isPacketDevice () override
 Is this device a packet (ATAPI) device? More...
 
const std::string & getDeviceName () override
 Gets the device name to insert as "model number" into the identify block. More...
 
void fillIdentifyBlock (AlignedBuffer &buffer) override
 Tells a subclass to fill the device specific parts of the identify block located in the buffer. More...
 
unsigned readBlockStart (AlignedBuffer &buffer, unsigned count) override
 Called when a block of read data should be buffered by the controller: when the buffer is empty or at the start of the transfer. More...
 
void readEnd () override
 Called when a read transfer completes. More...
 
void writeBlockComplete (AlignedBuffer &buffer, unsigned count) override
 Called when a block of written data has been buffered by the controller: when the buffer is full or at the end of the transfer. More...
 
void executeCommand (byte cmd) override
 Starts execution of an IDE command. More...
 
- Protected Member Functions inherited from openmsx::AbstractIDEDevice
 AbstractIDEDevice (MSXMotherBoard &motherBoard)
 
 ~AbstractIDEDevice () override=default
 
void setError (byte error)
 Indicates an error: sets error register, error flag, aborts transfers. More...
 
unsigned getSectorNumber () const
 Creates an LBA sector address from the contents of the sectorNumReg, cylinderLowReg, cylinderHighReg and devHeadReg registers. More...
 
unsigned getNumSectors () const
 Gets the number of sectors indicated by the sector count register. More...
 
void setInterruptReason (byte value)
 Writes the interrupt reason register. More...
 
unsigned getByteCount ()
 Reads the byte count limit of a packet transfer in the registers. More...
 
void setByteCount (unsigned count)
 Writes the byte count of a packet transfer in the registers. More...
 
void setSectorNumber (unsigned lba)
 Writes a 28-bit LBA sector number in the registers. More...
 
void startLongReadTransfer (unsigned count)
 Indicates the start of a read data transfer which uses blocks. More...
 
AlignedBufferstartShortReadTransfer (unsigned count)
 Indicates the start of a read data transfer where all data fits into the buffer at once. More...
 
void abortReadTransfer (byte error)
 Aborts the read transfer in progress. More...
 
void startWriteTransfer (unsigned count)
 Indicates the start of a write data transfer. More...
 
void abortWriteTransfer (byte error)
 Aborts the write transfer in progress. More...
 
byte getFeatureReg () const
 
void setLBALow (byte value)
 
void setLBAMid (byte value)
 
void setLBAHigh (byte value)
 
MSXMotherBoardgetMotherBoard () const
 

Friends

class CDXCommand
 

Additional Inherited Members

- Static Protected Attributes inherited from openmsx::AbstractIDEDevice
static constexpr byte DRDY = 0x40
 
static constexpr byte DSC = 0x10
 
static constexpr byte DRQ = 0x08
 
static constexpr byte ERR = 0x01
 
static constexpr byte UNC = 0x40
 
static constexpr byte IDNF = 0x10
 
static constexpr byte ABORT = 0x04
 

Detailed Description

Definition at line 14 of file IDECDROM.hh.

Constructor & Destructor Documentation

◆ IDECDROM() [1/2]

openmsx::IDECDROM::IDECDROM ( const IDECDROM )
delete

◆ IDECDROM() [2/2]

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

◆ ~IDECDROM()

openmsx::IDECDROM::~IDECDROM ( )
override

Member Function Documentation

◆ eject()

void openmsx::IDECDROM::eject ( )

◆ executeCommand()

void openmsx::IDECDROM::executeCommand ( byte  cmd)
overrideprotectedvirtual

◆ fillIdentifyBlock()

void openmsx::IDECDROM::fillIdentifyBlock ( AlignedBuffer buffer)
overrideprotectedvirtual

Tells a subclass to fill the device specific parts of the identify block located in the buffer.

The generic part is already written there.

Parameters
bufferArray of 512 bytes.

Implements openmsx::AbstractIDEDevice.

Definition at line 89 of file IDECDROM.cc.

◆ getDeviceName()

const std::string & openmsx::IDECDROM::getDeviceName ( )
overrideprotectedvirtual

Gets the device name to insert as "model number" into the identify block.

Returns
An ASCII string, up to 40 characters long.

Implements openmsx::AbstractIDEDevice.

Definition at line 83 of file IDECDROM.cc.

◆ insert()

void openmsx::IDECDROM::insert ( const std::string &  filename)

◆ isPacketDevice()

bool openmsx::IDECDROM::isPacketDevice ( )
overrideprotectedvirtual

Is this device a packet (ATAPI) device?

Returns
True iff this device supports the packet commands.

Implements openmsx::AbstractIDEDevice.

Definition at line 78 of file IDECDROM.cc.

◆ operator=()

IDECDROM& openmsx::IDECDROM::operator= ( const IDECDROM )
delete

◆ readBlockStart()

unsigned openmsx::IDECDROM::readBlockStart ( AlignedBuffer buffer,
unsigned  count 
)
overrideprotectedvirtual

Called when a block of read data should be buffered by the controller: when the buffer is empty or at the start of the transfer.

Parameters
bufferPointer to the start of a byte array.
countNumber of bytes to be filled by this method. This number will not exceed the array size nor the transfer length.
Returns
The number of bytes that was added to the array, or 0 if the transfer was aborted (the implementation of this method must set the relevant error flags as well).

Implements openmsx::AbstractIDEDevice.

Definition at line 109 of file IDECDROM.cc.

References openmsx::AbstractIDEDevice::abortReadTransfer(), LZ4::count(), openmsx::File::is_open(), openmsx::File::read(), and openmsx::File::seek().

◆ readEnd()

void openmsx::IDECDROM::readEnd ( )
overrideprotectedvirtual

Called when a read transfer completes.

The default implementation does nothing.

Reimplemented from openmsx::AbstractIDEDevice.

Definition at line 126 of file IDECDROM.cc.

References openmsx::AbstractIDEDevice::setInterruptReason().

◆ serialize()

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

Definition at line 396 of file IDECDROM.cc.

References openmsx::filename.

◆ writeBlockComplete()

void openmsx::IDECDROM::writeBlockComplete ( AlignedBuffer buffer,
unsigned  count 
)
overrideprotectedvirtual

Called when a block of written data has been buffered by the controller: when the buffer is full or at the end of the transfer.

Parameters
bufferPointer to the start of a byte array.
countNumber of data bytes in the array.

Implements openmsx::AbstractIDEDevice.

Definition at line 131 of file IDECDROM.cc.

Friends And Related Function Documentation

◆ CDXCommand

friend class CDXCommand
friend

Definition at line 73 of file IDECDROM.hh.


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