gem5  v20.1.0.0
Public Types | Public Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
IdeDisk Class Reference

IDE Disk device model. More...

#include <ide_disk.hh>

Inheritance diagram for IdeDisk:
SimObject EventManager Serializable Drainable Stats::Group

Public Types

typedef IdeDiskParams Params
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 IdeDisk (const Params *p)
 
 ~IdeDisk ()
 Delete the data buffer. More...
 
void reset (int id)
 Reset the device state. More...
 
void regStats () override
 Register Statistics. More...
 
void setController (IdeController *c, Addr page_bytes)
 Set the controller for this device. More...
 
void readCommand (const Addr offset, int size, uint8_t *data)
 
void readControl (const Addr offset, int size, uint8_t *data)
 
void writeCommand (const Addr offset, int size, const uint8_t *data)
 
void writeControl (const Addr offset, int size, const uint8_t *data)
 
void startDma (const uint32_t &prdTableBase)
 
void abortDma ()
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
virtual void loadState (CheckpointIn &cp)
 loadState() is called on each SimObject when restoring from a checkpoint. More...
 
virtual void initState ()
 initState() is called on each SimObject when not restoring from a checkpoint. More...
 
virtual void regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. More...
 
virtual void startup ()
 startup() is the final initialization call before simulation. More...
 
DrainState drain () override
 Provide a default implementation of the drain interface for objects that don't need draining. More...
 
virtual void memWriteback ()
 Write back dirty buffers to memory using functional writes. More...
 
virtual void memInvalidate ()
 Invalidate the contents of memory buffers. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from EventManager
EventQueueeventQueue () const
 
void schedule (Event &event, Tick when)
 
void deschedule (Event &event)
 
void reschedule (Event &event, Tick when, bool always=false)
 
void schedule (Event *event, Tick when)
 
void deschedule (Event *event)
 
void reschedule (Event *event, Tick when, bool always=false)
 
void wakeupEventQueue (Tick when=(Tick) -1)
 This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers. More...
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 Event manger manages events in the event queue. More...
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
- Public Member Functions inherited from Serializable
 Serializable ()
 
virtual ~Serializable ()
 
void serializeSection (CheckpointOut &cp, const char *name) const
 Serialize an object into a new section. More...
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object. More...
 
void unserializeSection (CheckpointIn &cp, const std::string &name)
 
- Public Member Functions inherited from Drainable
DrainState drainState () const
 Return the current drain state of an object. More...
 
virtual void notifyFork ()
 Notify a child process of a fork. More...
 
- Public Member Functions inherited from Stats::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (Stats::Info *info)
 Register a stat with this group. More...
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object. More...
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object. More...
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block. More...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 

Protected Attributes

IdeControllerctrl
 The IDE controller for this disk. More...
 
DiskImageimage
 The image that contains the data of this disk. More...
 
int diskDelay
 The disk delay in microseconds. More...
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Private Member Functions

void startCommand ()
 
void intrPost ()
 
void intrClear ()
 
void doDmaTransfer ()
 
void doDmaDataRead ()
 
void doDmaRead ()
 
void doDmaDataWrite ()
 
void doDmaWrite ()
 
void dmaPrdReadDone ()
 
void dmaReadDone ()
 
void dmaWriteDone ()
 
void readDisk (uint32_t sector, uint8_t *data)
 
void writeDisk (uint32_t sector, uint8_t *data)
 
void updateState (DevAction_t action)
 
bool isBSYSet ()
 
bool isIENSet ()
 
bool isDEVSelect ()
 
void setComplete ()
 
uint32_t getLBABase ()
 
Addr pciToDma (Addr pciAddr)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 

Private Attributes

struct ataparams driveID
 Drive identification structure for this disk. More...
 
uint8_t * dataBuffer
 Data buffer for transfers. More...
 
uint32_t cmdBytes
 Number of bytes in command data transfer. More...
 
uint32_t cmdBytesLeft
 Number of bytes left in command data transfer. More...
 
uint32_t drqBytesLeft
 Number of bytes left in DRQ block. More...
 
uint32_t curSector
 Current sector in access. More...
 
CommandReg_t cmdReg
 Command block registers. More...
 
uint8_t status
 Status register. More...
 
bool nIENBit
 Interrupt enable bit. More...
 
DevState_t devState
 Device state. More...
 
DmaState_t dmaState
 Dma state. More...
 
bool dmaRead
 Dma transaction is a read. More...
 
Addr pageBytes
 Size of OS pages. More...
 
uint32_t curPrdAddr
 PRD table base address. More...
 
PrdTableEntry curPrd
 PRD entry. More...
 
int devID
 Device ID (device0=0/device1=1) More...
 
bool intrPending
 Interrupt pending. More...
 
bool dmaAborted
 DMA Aborted. More...
 
Stats::Scalar dmaReadFullPages
 
Stats::Scalar dmaReadBytes
 
Stats::Scalar dmaReadTxs
 
Stats::Scalar dmaWriteFullPages
 
Stats::Scalar dmaWriteBytes
 
Stats::Scalar dmaWriteTxs
 
EventFunctionWrapper dmaTransferEvent
 
ChunkGeneratordmaReadCG
 
EventFunctionWrapper dmaReadWaitEvent
 
ChunkGeneratordmaWriteCG
 
EventFunctionWrapper dmaWriteWaitEvent
 
EventFunctionWrapper dmaPrdReadEvent
 
EventFunctionWrapper dmaReadEvent
 
EventFunctionWrapper dmaWriteEvent
 

Additional Inherited Members

- Static Public Member Functions inherited from SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize all SimObjects in the system. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
- Static Public Member Functions inherited from Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 Serializes all the SimObjects. More...
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Protected Member Functions inherited from Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 

Detailed Description

IDE Disk device model.

Definition at line 205 of file ide_disk.hh.

Member Typedef Documentation

◆ Params

typedef IdeDiskParams IdeDisk::Params

Definition at line 263 of file ide_disk.hh.

Constructor & Destructor Documentation

◆ IdeDisk()

IdeDisk::IdeDisk ( const Params p)

Definition at line 61 of file ide_disk.cc.

References doDmaTransfer().

◆ ~IdeDisk()

IdeDisk::~IdeDisk ( )

Delete the data buffer.

Definition at line 135 of file ide_disk.cc.

References dataBuffer.

Member Function Documentation

◆ abortDma()

void IdeDisk::abortDma ( )

◆ dmaPrdReadDone()

void IdeDisk::dmaPrdReadDone ( )
private

◆ dmaReadDone()

void IdeDisk::dmaReadDone ( )
private

◆ dmaWriteDone()

void IdeDisk::dmaWriteDone ( )
private

◆ doDmaDataRead()

void IdeDisk::doDmaDataRead ( )
private
Todo:
we need to figure out what the delay actually will be

Definition at line 378 of file ide_disk.cc.

References curPrd, curTick(), diskDelay, dmaReadWaitEvent, DPRINTF, PrdTableEntry::getByteCount(), EventManager::schedule(), and SectorSize.

Referenced by dmaPrdReadDone().

◆ doDmaDataWrite()

void IdeDisk::doDmaDataWrite ( )
private
Todo:
we need to figure out what the delay actually will be

Definition at line 485 of file ide_disk.cc.

References cmdBytesLeft, curPrd, curSector, curTick(), dataBuffer, diskDelay, dmaWriteWaitEvent, DPRINTF, PrdTableEntry::getByteCount(), MAX_DMA_SIZE, readDisk(), EventManager::schedule(), and SectorSize.

Referenced by dmaPrdReadDone().

◆ doDmaRead()

void IdeDisk::doDmaRead ( )
private

◆ doDmaTransfer()

void IdeDisk::doDmaTransfer ( )
private

◆ doDmaWrite()

void IdeDisk::doDmaWrite ( )
private

◆ getLBABase()

uint32_t IdeDisk::getLBABase ( )
inlineprivate

Definition at line 357 of file ide_disk.hh.

References cmdReg, CommandReg::cyl_high, CommandReg::cyl_low, CommandReg::head, and CommandReg::sec_num.

Referenced by startCommand().

◆ intrClear()

void IdeDisk::intrClear ( )
private

Definition at line 753 of file ide_disk.cc.

References ctrl, DPRINTF, PciDevice::intrClear(), intrPending, and panic.

Referenced by updateState().

◆ intrPost()

void IdeDisk::intrPost ( )
private

Definition at line 738 of file ide_disk.cc.

References ctrl, DPRINTF, intrPending, IdeController::intrPost(), and panic.

Referenced by updateState().

◆ isBSYSet()

bool IdeDisk::isBSYSet ( )
inlineprivate

Definition at line 343 of file ide_disk.hh.

References status, and STATUS_BSY_BIT.

◆ isDEVSelect()

bool IdeDisk::isDEVSelect ( )
private

Definition at line 186 of file ide_disk.cc.

References ctrl, and IdeController::isDiskSelected().

Referenced by updateState().

◆ isIENSet()

bool IdeDisk::isIENSet ( )
inlineprivate

Definition at line 344 of file ide_disk.hh.

References nIENBit.

Referenced by updateState().

◆ pciToDma()

Addr IdeDisk::pciToDma ( Addr  pciAddr)
inlineprivate

Definition at line 192 of file ide_disk.cc.

References ctrl, panic, and PciDevice::pciToDma().

Referenced by dmaPrdReadDone(), doDmaRead(), doDmaWrite(), and startDma().

◆ readCommand()

void IdeDisk::readCommand ( const Addr  offset,
int  size,
uint8_t *  data 
)

◆ readControl()

void IdeDisk::readControl ( const Addr  offset,
int  size,
uint8_t *  data 
)

Definition at line 251 of file ide_disk.cc.

References ALTSTAT_OFFSET, data, DPRINTF, ArmISA::offset, panic, and status.

◆ readDisk()

void IdeDisk::readDisk ( uint32_t  sector,
uint8_t *  data 
)
private

Definition at line 568 of file ide_disk.cc.

References data, image, SimObject::name(), panic, DiskImage::read(), and SectorSize.

Referenced by doDmaDataWrite(), and updateState().

◆ regStats()

void IdeDisk::regStats ( )
overridevirtual

◆ reset()

void IdeDisk::reset ( int  id)

◆ serialize()

void IdeDisk::serialize ( CheckpointOut cp) const
overrideprivatevirtual

◆ setComplete()

void IdeDisk::setComplete ( )
inlineprivate

Definition at line 347 of file ide_disk.hh.

References status, STATUS_DRDY_BIT, and STATUS_SEEK_BIT.

Referenced by updateState().

◆ setController()

void IdeDisk::setController ( IdeController c,
Addr  page_bytes 
)
inline

Set the controller for this device.

Parameters
cThe IDE controller

Definition at line 286 of file ide_disk.hh.

References ArmISA::c, ctrl, pageBytes, and panic_if.

◆ startCommand()

void IdeDisk::startCommand ( )
private

◆ startDma()

void IdeDisk::startDma ( const uint32_t &  prdTableBase)

◆ unserialize()

void IdeDisk::unserialize ( CheckpointIn cp)
overrideprivatevirtual

◆ updateState()

void IdeDisk::updateState ( DevAction_t  action)
private

◆ writeCommand()

void IdeDisk::writeCommand ( const Addr  offset,
int  size,
const uint8_t *  data 
)

◆ writeControl()

void IdeDisk::writeControl ( const Addr  offset,
int  size,
const uint8_t *  data 
)

◆ writeDisk()

void IdeDisk::writeDisk ( uint32_t  sector,
uint8_t *  data 
)
private

Definition at line 578 of file ide_disk.cc.

References data, image, SimObject::name(), panic, SectorSize, and DiskImage::write().

Referenced by dmaReadDone(), and updateState().

Member Data Documentation

◆ cmdBytes

uint32_t IdeDisk::cmdBytes
private

Number of bytes in command data transfer.

Definition at line 223 of file ide_disk.hh.

Referenced by reset(), serialize(), startCommand(), unserialize(), and updateState().

◆ cmdBytesLeft

uint32_t IdeDisk::cmdBytesLeft
private

Number of bytes left in command data transfer.

Definition at line 225 of file ide_disk.hh.

Referenced by dmaPrdReadDone(), dmaReadDone(), dmaWriteDone(), doDmaDataWrite(), reset(), serialize(), startCommand(), unserialize(), and updateState().

◆ cmdReg

CommandReg_t IdeDisk::cmdReg
private

Command block registers.

Definition at line 231 of file ide_disk.hh.

Referenced by getLBABase(), readCommand(), reset(), serialize(), startCommand(), unserialize(), updateState(), and writeCommand().

◆ ctrl

IdeController* IdeDisk::ctrl
protected

The IDE controller for this disk.

Definition at line 209 of file ide_disk.hh.

Referenced by doDmaRead(), doDmaTransfer(), doDmaWrite(), intrClear(), intrPost(), isDEVSelect(), pciToDma(), setController(), and updateState().

◆ curPrd

PrdTableEntry IdeDisk::curPrd
private

◆ curPrdAddr

uint32_t IdeDisk::curPrdAddr
private

PRD table base address.

Definition at line 245 of file ide_disk.hh.

Referenced by dmaPrdReadDone(), doDmaTransfer(), reset(), serialize(), startDma(), and unserialize().

◆ curSector

uint32_t IdeDisk::curSector
private

Current sector in access.

Definition at line 229 of file ide_disk.hh.

Referenced by dmaPrdReadDone(), dmaReadDone(), doDmaDataWrite(), reset(), serialize(), startCommand(), unserialize(), and updateState().

◆ dataBuffer

uint8_t* IdeDisk::dataBuffer
private

Data buffer for transfers.

Definition at line 221 of file ide_disk.hh.

Referenced by dmaReadDone(), doDmaDataWrite(), doDmaRead(), doDmaWrite(), reset(), serialize(), unserialize(), updateState(), and ~IdeDisk().

◆ devID

int IdeDisk::devID
private

Device ID (device0=0/device1=1)

Definition at line 249 of file ide_disk.hh.

Referenced by reset(), serialize(), unserialize(), and updateState().

◆ devState

DevState_t IdeDisk::devState
private

Device state.

Definition at line 237 of file ide_disk.hh.

Referenced by abortDma(), doDmaTransfer(), reset(), serialize(), startCommand(), startDma(), unserialize(), updateState(), and writeControl().

◆ diskDelay

int IdeDisk::diskDelay
protected

The disk delay in microseconds.

Definition at line 215 of file ide_disk.hh.

Referenced by doDmaDataRead(), and doDmaDataWrite().

◆ dmaAborted

bool IdeDisk::dmaAborted
private

DMA Aborted.

Definition at line 253 of file ide_disk.hh.

Referenced by dmaPrdReadDone(), doDmaRead(), doDmaTransfer(), doDmaWrite(), reset(), serialize(), unserialize(), and updateState().

◆ dmaPrdReadEvent

EventFunctionWrapper IdeDisk::dmaPrdReadEvent
private

Definition at line 327 of file ide_disk.hh.

Referenced by doDmaTransfer(), serialize(), and unserialize().

◆ dmaRead

bool IdeDisk::dmaRead
private

Dma transaction is a read.

Definition at line 241 of file ide_disk.hh.

Referenced by dmaPrdReadDone(), reset(), serialize(), startCommand(), and unserialize().

◆ dmaReadBytes

Stats::Scalar IdeDisk::dmaReadBytes
private

Definition at line 256 of file ide_disk.hh.

Referenced by doDmaRead(), and regStats().

◆ dmaReadCG

ChunkGenerator* IdeDisk::dmaReadCG
private

Definition at line 317 of file ide_disk.hh.

Referenced by doDmaRead().

◆ dmaReadEvent

EventFunctionWrapper IdeDisk::dmaReadEvent
private

Definition at line 330 of file ide_disk.hh.

Referenced by serialize(), and unserialize().

◆ dmaReadFullPages

Stats::Scalar IdeDisk::dmaReadFullPages
private

Definition at line 255 of file ide_disk.hh.

Referenced by doDmaRead(), and regStats().

◆ dmaReadTxs

Stats::Scalar IdeDisk::dmaReadTxs
private

Definition at line 257 of file ide_disk.hh.

Referenced by doDmaRead(), and regStats().

◆ dmaReadWaitEvent

EventFunctionWrapper IdeDisk::dmaReadWaitEvent
private

Definition at line 318 of file ide_disk.hh.

Referenced by doDmaDataRead(), doDmaRead(), serialize(), and unserialize().

◆ dmaState

DmaState_t IdeDisk::dmaState
private

◆ dmaTransferEvent

EventFunctionWrapper IdeDisk::dmaTransferEvent
private

Definition at line 312 of file ide_disk.hh.

Referenced by doDmaTransfer(), serialize(), startDma(), and unserialize().

◆ dmaWriteBytes

Stats::Scalar IdeDisk::dmaWriteBytes
private

Definition at line 259 of file ide_disk.hh.

Referenced by doDmaWrite(), and regStats().

◆ dmaWriteCG

ChunkGenerator* IdeDisk::dmaWriteCG
private

Definition at line 323 of file ide_disk.hh.

Referenced by doDmaWrite().

◆ dmaWriteEvent

EventFunctionWrapper IdeDisk::dmaWriteEvent
private

Definition at line 333 of file ide_disk.hh.

Referenced by serialize(), and unserialize().

◆ dmaWriteFullPages

Stats::Scalar IdeDisk::dmaWriteFullPages
private

Definition at line 258 of file ide_disk.hh.

Referenced by doDmaWrite(), and regStats().

◆ dmaWriteTxs

Stats::Scalar IdeDisk::dmaWriteTxs
private

Definition at line 260 of file ide_disk.hh.

Referenced by doDmaWrite(), and regStats().

◆ dmaWriteWaitEvent

EventFunctionWrapper IdeDisk::dmaWriteWaitEvent
private

Definition at line 324 of file ide_disk.hh.

Referenced by doDmaDataWrite(), doDmaWrite(), serialize(), and unserialize().

◆ driveID

struct ataparams IdeDisk::driveID
private

Drive identification structure for this disk.

Definition at line 219 of file ide_disk.hh.

Referenced by updateState().

◆ drqBytesLeft

uint32_t IdeDisk::drqBytesLeft
private

Number of bytes left in DRQ block.

Definition at line 227 of file ide_disk.hh.

Referenced by reset(), serialize(), unserialize(), and updateState().

◆ image

DiskImage* IdeDisk::image
protected

The image that contains the data of this disk.

Definition at line 211 of file ide_disk.hh.

Referenced by readDisk(), startCommand(), and writeDisk().

◆ intrPending

bool IdeDisk::intrPending
private

Interrupt pending.

Definition at line 251 of file ide_disk.hh.

Referenced by intrClear(), intrPost(), reset(), serialize(), unserialize(), and updateState().

◆ nIENBit

bool IdeDisk::nIENBit
private

Interrupt enable bit.

Definition at line 235 of file ide_disk.hh.

Referenced by isIENSet(), serialize(), unserialize(), and writeControl().

◆ pageBytes

Addr IdeDisk::pageBytes
private

Size of OS pages.

Definition at line 243 of file ide_disk.hh.

Referenced by doDmaRead(), doDmaWrite(), and setController().

◆ status

uint8_t IdeDisk::status
private

Status register.

Definition at line 233 of file ide_disk.hh.

Referenced by isBSYSet(), readCommand(), readControl(), reset(), serialize(), setComplete(), startCommand(), unserialize(), and updateState().


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

Generated on Wed Sep 30 2020 14:02:26 for gem5 by doxygen 1.8.17