gem5  v21.1.0.2
Classes | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
gem5::Iob Class Reference

#include <iob.hh>

Inheritance diagram for gem5::Iob:
gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

struct  IntBusy
 
struct  IntCtl
 
struct  IntMan
 

Public Member Functions

 PARAMS (Iob)
 
 Iob (const Params &p)
 
Tick read (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
Tick write (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
void generateIpi (Type type, int cpu_id, int vector)
 
void receiveDeviceInterrupt (DeviceId devid)
 
bool receiveJBusInterrupt (int cpu_id, int source, uint64_t d0, uint64_t d1)
 
AddrRangeList getAddrRanges () const override
 Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to. 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::PioDevice
 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
 

Private Types

enum  DeviceId {
  Interal = 0, Error = 1, SSI = 2, Reserved = 3,
  NumDeviceIds
}
 
enum  Type { Interrupt, Reset, Idle, Resume }
 

Private Member Functions

void writeIob (PacketPtr pkt)
 
void writeJBus (PacketPtr pkt)
 
void readIob (PacketPtr pkt)
 
void readJBus (PacketPtr pkt)
 

Private Attributes

Addr iobManAddr
 
Addr iobManSize
 
Addr iobJBusAddr
 
Addr iobJBusSize
 
Tick pioDelay
 
IntMan intMan [NumDeviceIds]
 
IntCtl intCtl [NumDeviceIds]
 
uint64_t jIntVec
 
uint64_t jBusData0 [MaxNiagaraProcs]
 
uint64_t jBusData1 [MaxNiagaraProcs]
 
IntBusy jIntBusy [MaxNiagaraProcs]
 

Additional Inherited Members

- Public Types inherited from gem5::PioDevice
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
 
- 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
 
- 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 inherited from gem5::PioDevice
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...
 

Detailed Description

Definition at line 72 of file iob.hh.

Member Enumeration Documentation

◆ DeviceId

enum gem5::Iob::DeviceId
private
Enumerator
Interal 
Error 
SSI 
Reserved 
NumDeviceIds 

Definition at line 81 of file iob.hh.

◆ Type

enum gem5::Iob::Type
private
Enumerator
Interrupt 
Reset 
Idle 
Resume 

Definition at line 108 of file iob.hh.

Constructor & Destructor Documentation

◆ Iob()

gem5::Iob::Iob ( const Params p)

Member Function Documentation

◆ generateIpi()

void gem5::Iob::generateIpi ( Type  type,
int  cpu_id,
int  vector 
)

◆ getAddrRanges()

AddrRangeList gem5::Iob::getAddrRanges ( ) const
overridevirtual

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

Implements gem5::PioDevice.

Definition at line 339 of file iob.cc.

References iobJBusAddr, iobJBusSize, iobManAddr, iobManSize, and gem5::RangeSize().

◆ PARAMS()

gem5::Iob::PARAMS ( Iob  )

◆ read()

Tick gem5::Iob::read ( PacketPtr  pkt)
overridevirtual

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

Implements gem5::PioDevice.

Definition at line 76 of file iob.cc.

References gem5::Packet::getAddr(), iobJBusAddr, iobJBusSize, iobManAddr, iobManSize, gem5::Packet::makeAtomicResponse(), panic, pioDelay, readIob(), and readJBus().

◆ readIob()

void gem5::Iob::readIob ( PacketPtr  pkt)
private

◆ readJBus()

void gem5::Iob::readJBus ( PacketPtr  pkt)
private

◆ receiveDeviceInterrupt()

void gem5::Iob::receiveDeviceInterrupt ( DeviceId  devid)

◆ receiveJBusInterrupt()

bool gem5::Iob::receiveJBusInterrupt ( int  cpu_id,
int  source,
uint64_t  d0,
uint64_t  d1 
)

◆ serialize()

void gem5::Iob::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 349 of file iob.cc.

References gem5::csprintf(), intCtl, intMan, jBusData0, jBusData1, jIntBusy, jIntVec, gem5::mask(), gem5::MaxNiagaraProcs, NumDeviceIds, gem5::paramOut(), SERIALIZE_ARRAY, SERIALIZE_SCALAR, gem5::X86ISA::vector, and gem5::RiscvISA::x.

◆ unserialize()

void gem5::Iob::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 370 of file iob.cc.

References gem5::csprintf(), intCtl, intMan, jBusData0, jBusData1, jIntBusy, jIntVec, gem5::mask(), gem5::MaxNiagaraProcs, NumDeviceIds, gem5::paramIn(), UNSERIALIZE_ARRAY, UNSERIALIZE_SCALAR, gem5::X86ISA::vector, and gem5::RiscvISA::x.

◆ write()

Tick gem5::Iob::write ( PacketPtr  pkt)
overridevirtual

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

Implements gem5::PioDevice.

Definition at line 170 of file iob.cc.

References gem5::Packet::getAddr(), iobJBusAddr, iobJBusSize, iobManAddr, iobManSize, gem5::Packet::makeAtomicResponse(), panic, pioDelay, writeIob(), and writeJBus().

◆ writeIob()

void gem5::Iob::writeIob ( PacketPtr  pkt)
private

◆ writeJBus()

void gem5::Iob::writeJBus ( PacketPtr  pkt)
private

Member Data Documentation

◆ intCtl

IntCtl gem5::Iob::intCtl[NumDeviceIds]
private

Definition at line 117 of file iob.hh.

Referenced by Iob(), readIob(), receiveDeviceInterrupt(), serialize(), unserialize(), and writeIob().

◆ intMan

IntMan gem5::Iob::intMan[NumDeviceIds]
private

Definition at line 116 of file iob.hh.

Referenced by Iob(), readIob(), receiveDeviceInterrupt(), serialize(), unserialize(), and writeIob().

◆ iobJBusAddr

Addr gem5::Iob::iobJBusAddr
private

Definition at line 77 of file iob.hh.

Referenced by getAddrRanges(), Iob(), read(), readJBus(), write(), and writeJBus().

◆ iobJBusSize

Addr gem5::Iob::iobJBusSize
private

Definition at line 78 of file iob.hh.

Referenced by getAddrRanges(), Iob(), read(), and write().

◆ iobManAddr

Addr gem5::Iob::iobManAddr
private

Definition at line 75 of file iob.hh.

Referenced by getAddrRanges(), Iob(), read(), readIob(), write(), and writeIob().

◆ iobManSize

Addr gem5::Iob::iobManSize
private

Definition at line 76 of file iob.hh.

Referenced by getAddrRanges(), Iob(), read(), and write().

◆ jBusData0

uint64_t gem5::Iob::jBusData0[MaxNiagaraProcs]
private

Definition at line 119 of file iob.hh.

Referenced by readJBus(), receiveJBusInterrupt(), serialize(), and unserialize().

◆ jBusData1

uint64_t gem5::Iob::jBusData1[MaxNiagaraProcs]
private

Definition at line 120 of file iob.hh.

Referenced by readJBus(), receiveJBusInterrupt(), serialize(), and unserialize().

◆ jIntBusy

IntBusy gem5::Iob::jIntBusy[MaxNiagaraProcs]
private

Definition at line 121 of file iob.hh.

Referenced by readJBus(), receiveJBusInterrupt(), serialize(), unserialize(), and writeJBus().

◆ jIntVec

uint64_t gem5::Iob::jIntVec
private

Definition at line 118 of file iob.hh.

Referenced by readIob(), receiveJBusInterrupt(), serialize(), unserialize(), and writeIob().

◆ pioDelay

Tick gem5::Iob::pioDelay
private

Definition at line 79 of file iob.hh.

Referenced by Iob(), read(), and write().


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

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