gem5  v21.1.0.2
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
gem5::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 gem5::PioDevice:
gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::BaseGic gem5::BasicPioDevice gem5::DmaDevice gem5::GenericTimerFrame gem5::GenericTimerMem gem5::GenericWatchdog gem5::Gicv2m gem5::Iob gem5::NoMaliGpu gem5::PciHost gem5::VGic

Public Types

using Params = PioDeviceParams
 
- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 

Public Member Functions

 PioDevice (const Params &p)
 
virtual ~PioDevice ()
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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 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 gem5::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 gem5::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 gem5::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 gem5::statistics::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void regStats ()
 Callback to set stat parameters. More...
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (statistics::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...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from gem5::Named
 Named (const std::string &name_)
 
virtual ~Named ()=default
 
virtual std::string name () const
 
- Public Member Functions inherited from gem5::Clocked
void updateClockPeriod ()
 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 gem5::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 gem5::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...
 
virtual void clockPeriodUpdated ()
 A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...
 

Protected Attributes

Systemsys
 
PioPort< PioDevicepioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Friends

class PioPort< PioDevice >
 

Additional Inherited Members

- Static Public Member Functions inherited from gem5::SimObject
static void serializeAll (const std::string &cpt_dir)
 Create a checkpoint by serializing 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 void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

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 102 of file io_device.hh.

Member Typedef Documentation

◆ Params

using gem5::PioDevice::Params = PioDeviceParams

Definition at line 134 of file io_device.hh.

Constructor & Destructor Documentation

◆ PioDevice()

gem5::PioDevice::PioDevice ( const Params p)

Definition at line 50 of file io_device.cc.

◆ ~PioDevice()

gem5::PioDevice::~PioDevice ( )
virtual

Definition at line 54 of file io_device.cc.

Member Function Documentation

◆ getAddrRanges()

virtual AddrRangeList gem5::PioDevice::getAddrRanges ( ) const
protectedpure virtual

◆ getPort()

Port & gem5::PioDevice::getPort ( const std::string &  if_name,
PortID  idx = InvalidPortID 
)
overridevirtual

Get a port with a given name and index.

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

gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.

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

Reimplemented from gem5::SimObject.

Reimplemented in gem5::IGbE, gem5::NSGigE, gem5::sinic::Device, gem5::CopyEngine, gem5::Clint, gem5::X86ISA::I8042, gem5::X86ISA::I82094AA, gem5::X86ISA::I8259, gem5::X86ISA::Cmos, and gem5::X86ISA::I8254.

Definition at line 67 of file io_device.cc.

References gem5::SimObject::getPort(), and pioPort.

Referenced by gem5::X86ISA::I8254::getPort(), gem5::X86ISA::Cmos::getPort(), gem5::X86ISA::I8259::getPort(), gem5::X86ISA::I82094AA::getPort(), gem5::Gicv3Its::getPort(), gem5::fastmodel::GIC::getPort(), gem5::X86ISA::I8042::getPort(), gem5::Clint::getPort(), and gem5::DmaDevice::getPort().

◆ init()

void gem5::PioDevice::init ( )
overridevirtual

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 gem5::SimObject.

Reimplemented in gem5::IGbE, gem5::Clint, gem5::Plic, gem5::X86ISA::I82094AA, and gem5::X86ISA::I8259.

Definition at line 59 of file io_device.cc.

References gem5::Named::name(), panic, and pioPort.

Referenced by gem5::X86ISA::I8259::init(), gem5::NoMaliGpu::init(), gem5::BaseGic::init(), gem5::X86ISA::I82094AA::init(), gem5::Plic::init(), gem5::EnergyCtrl::init(), gem5::Clint::init(), gem5::CpuLocalTimer::init(), and gem5::DmaDevice::init().

◆ read()

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

◆ write()

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

Friends And Related Function Documentation

◆ PioPort< PioDevice >

friend class PioPort< PioDevice >
friend

Definition at line 143 of file io_device.hh.

Member Data Documentation

◆ pioPort

PioPort<PioDevice> gem5::PioDevice::pioPort
protected

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

Definition at line 109 of file io_device.hh.

Referenced by getPort(), init(), gem5::sinic::Device::unserialize(), gem5::PciDevice::unserialize(), and gem5::PciDevice::writeConfig().

◆ sys

System* gem5::PioDevice::sys
protected

Definition at line 105 of file io_device.hh.

Referenced by gem5::DmaDevice::cacheBlockSize(), gem5::GicV2::clearInt(), gem5::MaltaCChip::clearIntr(), gem5::HDLcd::cmdDisable(), gem5::HDLcd::cmdEnable(), gem5::Gicv3::deassertAll(), gem5::Gicv3::deassertInt(), gem5::Pl111::dmaDone(), gem5::HDLcd::drainResume(), gem5::FVPBasePwrCtrl::FVPBasePwrCtrl(), gem5::Iob::generateIpi(), gem5::GicV2::genSwiMask(), gem5::BaseGic::getSystem(), gem5::FVPBasePwrCtrl::getThreadContextByMPID(), gem5::Gicv3::haveAsserted(), gem5::Gicv3::init(), gem5::CpuLocalTimer::init(), gem5::GicV2::postDelayedFiq(), gem5::GicV2::postDelayedInt(), gem5::Gicv3::postInt(), gem5::MaltaCChip::postIntr(), gem5::FVPBasePwrCtrl::powerCoreOn(), gem5::HDLcd::pxlFrameDone(), gem5::HDLcd::pxlVSyncEnd(), gem5::A9SCU::read(), gem5::GicV2::readCpu(), gem5::GicV2::readDistributor(), gem5::Iob::receiveDeviceInterrupt(), gem5::Iob::receiveJBusInterrupt(), gem5::Gicv3Its::runProcess(), gem5::HSAPacketProcessor::sendAgentDispatchCompletionSignal(), gem5::HSAPacketProcessor::sendCompletionSignal(), gem5::CpuLocalTimer::serialize(), gem5::GicV2::softInt(), gem5::FVPBasePwrCtrl::startup(), gem5::GPUCommandProcessor::submitDispatchPkt(), gem5::GPUCommandProcessor::system(), gem5::GPUCommandProcessor::translateOrDie(), gem5::HSAPacketProcessor::translateOrDie(), gem5::CpuLocalTimer::unserialize(), gem5::VGic::updateIntState(), gem5::GicV2::updateIntState(), gem5::GicV2::updateRunPri(), gem5::GenericTimerMem::validateAccessPerm(), gem5::VGic::VGic(), and gem5::FVPBasePwrCtrl::write().


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

Generated on Tue Sep 21 2021 12:27:58 for gem5 by doxygen 1.8.17