gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
PioDevice Class Referenceabstract

This device is the base class which all devices senstive to an address range inherit from. More...

#include <io_device.hh>

Inheritance diagram for PioDevice:
MemObject ClockedObject SimObject Clocked EventManager Serializable Drainable BaseGic BasicPioDevice DmaDevice GenericTimerMem Gicv2m Iob NoMaliGpu PciHost VGic

Public Types

typedef PioDeviceParams Params
 
- Public Types inherited from MemObject
typedef MemObjectParams Params
 
- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 PioDevice (const Params *p)
 
virtual ~PioDevice ()
 
const Paramsparams () const
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
virtual BaseSlavePortgetSlavePort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a slave port with a given name and index. More...
 
- Public Member Functions inherited from MemObject
const Paramsparams () const
 
 MemObject (const Params *params)
 
virtual BaseMasterPortgetMasterPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a master port with a given name and index. More...
 
- Public Member Functions inherited from ClockedObject
 ClockedObject (const ClockedObjectParams *p)
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
Enums::PwrState pwrState () const
 
std::string pwrStateName () const
 
std::vector< double > pwrStateWeights () const
 Returns the percentage residency for each power state. More...
 
void computeStats ()
 Record stats values like state residency by computing the time difference from previous update. More...
 
void pwrState (Enums::PwrState)
 
void regStats () override
 Register statistics for this object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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 resetStats ()
 Reset statistics associated with this object. 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 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
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
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)
 
void setCurTick (Tick newVal)
 
- 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 Clocked
void updateClockPeriod () const
 Update the tick to the current tick. More...
 
Tick clockEdge (Cycles cycles=Cycles(0)) const
 Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...
 
Cycles curCycle () const
 Determine the current cycle, corresponding to a tick aligned to a clock edge. More...
 
Tick nextCycle () const
 Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...
 
uint64_t frequency () const
 
Tick clockPeriod () const
 
double voltage () const
 
Cycles ticksToCycles (Tick t) const
 
Tick cyclesToTicks (Cycles c) const
 

Protected Member Functions

virtual AddrRangeList getAddrRanges () const =0
 Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to. More...
 
virtual Tick read (PacketPtr pkt)=0
 Pure virtual function that the device must implement. More...
 
virtual Tick write (PacketPtr pkt)=0
 Pure virtual function that the device must implement. More...
 
- 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...
 
- Protected Member Functions inherited from Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (Clocked &)=delete
 
virtual ~Clocked ()
 Virtual destructor due to inheritance. More...
 
void resetClock () const
 Reset the object's clock using the current global tick value. More...
 

Protected Attributes

Systemsys
 
PioPort pioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- Protected Attributes inherited from ClockedObject
Enums::PwrState _currPwrState
 To keep track of the current power state. More...
 
Tick prvEvalTick
 
Stats::Scalar numPwrStateTransitions
 
Stats::Distribution pwrStateClkGateDist
 
Stats::Vector pwrStateResidencyTicks
 
- 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...
 

Friends

class PioPort
 

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 ()
 Get the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 

Detailed Description

This device is the base class which all devices senstive to an address range inherit from.

There are three pure virtual functions which all devices must implement getAddrRanges(), read(), and write(). The magic do choose which mode we are in, etc is handled by the PioPort so the device doesn't have to bother.

Definition at line 84 of file io_device.hh.

Member Typedef Documentation

typedef PioDeviceParams PioDevice::Params

Definition at line 116 of file io_device.hh.

Constructor & Destructor Documentation

PioDevice::PioDevice ( const Params p)

Definition at line 74 of file io_device.cc.

PioDevice::~PioDevice ( )
virtual

Definition at line 78 of file io_device.cc.

Member Function Documentation

virtual AddrRangeList PioDevice::getAddrRanges ( ) const
protectedpure virtual

Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to.

Returns
a list of non-overlapping address ranges

Implemented in UFSHostDevice, Pl111, Pl390, GenericTimerMem, GenericPciHost, X86ISA::I8042, VGic, PciDevice, BasicPioDevice, GpuDispatcher, Iob, HDLcd, Gicv2m, Uart8250, TsunamiPChip, and NoMaliGpu.

Referenced by PioPort::getAddrRanges().

BaseSlavePort & PioDevice::getSlavePort ( const std::string &  if_name,
PortID  idx = InvalidPortID 
)
virtual

Get a slave port with a given name and index.

This is used at binding time and returns a reference to a protocol-agnostic base master port.

Parameters
if_namePort name
idxIndex in the case of a VectorPort
Returns
A reference to the given port

Reimplemented from MemObject.

Reimplemented in X86ISA::Interrupts.

Definition at line 91 of file io_device.cc.

References MemObject::getSlavePort(), and pioPort.

Referenced by X86ISA::Interrupts::getSlavePort().

void PioDevice::init ( )
virtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from SimObject.

Reimplemented in IGbE, X86ISA::Interrupts, DmaDevice, EnergyCtrl, X86ISA::I82094AA, and NoMaliGpu.

Definition at line 83 of file io_device.cc.

References BaseSlavePort::isConnected(), SimObject::name(), panic, pioPort, and SlavePort::sendRangeChange().

Referenced by NoMaliGpu::init(), X86ISA::I82094AA::init(), EnergyCtrl::init(), DmaDevice::init(), and X86ISA::Interrupts::init().

const Params* PioDevice::params ( ) const
inline

Definition at line 121 of file io_device.hh.

References SimObject::_params.

virtual Tick PioDevice::read ( PacketPtr  pkt)
protectedpure virtual

Pure virtual function that the device must implement.

Called when a read command is recieved by the port.

Parameters
pktPacket describing this request
Returns
number of ticks it took to complete

Implemented in UFSHostDevice, IGbE, Pl390, Pl111, NSGigE, GenericTimerMem, GenericPciHost, Sinic::Device, X86ISA::I8042, X86ISA::Interrupts, VGic, CopyEngine, MuxingKvmGic, CpuLocalTimer, RealViewCtrl, Pl050, GpuDispatcher, Sp804, IdeController, I2CBus, Iob, EnergyCtrl, TsunamiIO, MaltaIO, PL031, AlphaBackdoor, Gicv2m, HDLcd, Uart8250, MaltaCChip, X86ISA::I82094AA, TsunamiCChip, X86ISA::I8259, X86ISA::I8254, X86ISA::Cmos, TsunamiPChip, IsaFake, A9SCU, X86ISA::Speaker, BadDevice, AmbaFake, Pl011, NoMaliGpu, DumbTOD, MmDisk, X86ISA::I8237, and PciVirtIO.

Referenced by PioPort::recvAtomic().

virtual Tick PioDevice::write ( PacketPtr  pkt)
protectedpure virtual

Pure virtual function that the device must implement.

Called when a write command is recieved by the port.

Parameters
pktPacket describing this request
Returns
number of ticks it took to complete

Implemented in UFSHostDevice, IGbE, Pl390, Pl111, NSGigE, GenericTimerMem, GenericPciHost, Sinic::Device, X86ISA::I8042, X86ISA::Interrupts, VGic, CopyEngine, MuxingKvmGic, CpuLocalTimer, RealViewCtrl, Sp804, Pl050, GpuDispatcher, IdeController, I2CBus, Iob, EnergyCtrl, TsunamiIO, PL031, MaltaIO, AlphaBackdoor, Gicv2m, HDLcd, Uart8250, MaltaCChip, X86ISA::I82094AA, TsunamiCChip, X86ISA::I8259, X86ISA::I8254, IsaFake, X86ISA::Cmos, TsunamiPChip, A9SCU, X86ISA::Speaker, BadDevice, AmbaFake, Pl011, NoMaliGpu, DumbTOD, MmDisk, X86ISA::I8237, and PciVirtIO.

Referenced by PioPort::recvAtomic().

Friends And Related Function Documentation

friend class PioPort
friend

Definition at line 131 of file io_device.hh.

Member Data Documentation

PioPort PioDevice::pioPort
protected

The pioPort that handles the requests for us and provides us requests that it sees.

Definition at line 91 of file io_device.hh.

Referenced by getSlavePort(), init(), PciDevice::unserialize(), Sinic::Device::unserialize(), and PciDevice::writeConfig().

System* PioDevice::sys
protected

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

Generated on Fri Jun 9 2017 13:04:16 for gem5 by doxygen 1.8.6