gem5  v20.1.0.0
Public Member Functions | Public Attributes | Friends | List of all members
SMMUv3DeviceInterface Class Reference

#include <smmu_v3_deviceifc.hh>

Inheritance diagram for SMMUv3DeviceInterface:
ClockedObject SimObject Clocked EventManager Serializable Drainable Stats::Group

Public Member Functions

Tick recvAtomic (PacketPtr pkt)
 
bool recvTimingReq (PacketPtr pkt)
 
void schedTimingResp (PacketPtr pkt)
 
Tick atsRecvAtomic (PacketPtr pkt)
 
bool atsRecvTimingReq (PacketPtr pkt)
 
bool atsRecvTimingResp (PacketPtr pkt)
 
void schedAtsTimingResp (PacketPtr pkt)
 
void scheduleDeviceRetry ()
 
void sendDeviceRetry ()
 
void atsSendDeviceRetry ()
 
PortgetPort (const std::string &name, PortID id) override
 Get a port with a given name and index. More...
 
 SMMUv3DeviceInterface (const SMMUv3DeviceInterfaceParams *p)
 
 ~SMMUv3DeviceInterface ()
 
const SMMUv3DeviceInterfaceParams * params () const
 
DrainState drain () override
 Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight. More...
 
void setSMMU (SMMUv3 *_smmu)
 
void sendRange ()
 
- 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...
 
- 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 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 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 (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
 
- Public Member Functions inherited from 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
 

Public Attributes

SMMUv3smmu
 
SMMUTLBmicroTLB
 
SMMUTLBmainTLB
 
const bool microTLBEnable
 
const bool mainTLBEnable
 
SMMUSemaphore devicePortSem
 
SMMUSemaphore microTLBSem
 
SMMUSemaphore mainTLBSem
 
const Cycles microTLBLat
 
const Cycles mainTLBLat
 
SMMUDevicePortdevicePort
 
SMMUATSDevicePort atsDevicePort
 
SMMUATSMemoryPort atsMemPort
 
const unsigned portWidth
 
unsigned wrBufSlotsRemaining
 
unsigned xlateSlotsRemaining
 
unsigned pendingMemAccesses
 
const bool prefetchEnable
 
const bool prefetchReserveLastWay
 
std::list< SMMUTranslationProcess * > duplicateReqs
 
SMMUSignal duplicateReqRemoved
 
std::list< SMMUTranslationProcess * > dependentReads [SMMU_MAX_TRANS_ID]
 
std::list< SMMUTranslationProcess * > dependentWrites [SMMU_MAX_TRANS_ID]
 
SMMUSignal dependentReqRemoved
 
bool deviceNeedsRetry
 
bool atsDeviceNeedsRetry
 
SMMUDeviceRetryEvent sendDeviceRetryEvent
 
EventWrapper< SMMUv3DeviceInterface, &SMMUv3DeviceInterface::atsSendDeviceRetryatsSendDeviceRetryEvent
 
- Public Attributes inherited from ClockedObject
PowerStatepowerState
 

Friends

class SMMUTranslationProcess
 

Additional Inherited Members

- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 
- 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...
 
- 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...
 
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 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...
 

Detailed Description

Definition at line 55 of file smmu_v3_deviceifc.hh.

Constructor & Destructor Documentation

◆ SMMUv3DeviceInterface()

SMMUv3DeviceInterface::SMMUv3DeviceInterface ( const SMMUv3DeviceInterfaceParams *  p)

Definition at line 45 of file smmu_v3_deviceifc.cc.

◆ ~SMMUv3DeviceInterface()

SMMUv3DeviceInterface::~SMMUv3DeviceInterface ( )
inline

Definition at line 123 of file smmu_v3_deviceifc.hh.

References mainTLB, and microTLB.

Member Function Documentation

◆ atsRecvAtomic()

Tick SMMUv3DeviceInterface::atsRecvAtomic ( PacketPtr  pkt)

◆ atsRecvTimingReq()

bool SMMUv3DeviceInterface::atsRecvTimingReq ( PacketPtr  pkt)

◆ atsRecvTimingResp()

bool SMMUv3DeviceInterface::atsRecvTimingResp ( PacketPtr  pkt)

◆ atsSendDeviceRetry()

void SMMUv3DeviceInterface::atsSendDeviceRetry ( )

Definition at line 237 of file smmu_v3_deviceifc.cc.

References atsDevicePort, DPRINTF, and ResponsePort::sendRetryReq().

◆ drain()

DrainState SMMUv3DeviceInterface::drain ( )
overridevirtual

Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

Draining is mostly used before forking and creating a check point.

This function notifies an object that it needs to drain its state.

If the object does not need further simulation to drain internal buffers, it returns DrainState::Drained and automatically switches to the Drained state. If the object needs more simulation, it returns DrainState::Draining and automatically enters the Draining state. Other return values are invalid.

Note
An object that has entered the Drained state can be disturbed by other objects in the system and consequently stop being drained. These perturbations are not visible in the drain state. The simulator therefore repeats the draining process until all objects return DrainState::Drained on the first call to drain().
Returns
DrainState::Drained if the object is drained at this point in time, DrainState::Draining if it needs further simulation.

Implements Drainable.

Definition at line 254 of file smmu_v3_deviceifc.cc.

References Drained, Draining, params(), and xlateSlotsRemaining.

◆ getPort()

Port & SMMUv3DeviceInterface::getPort ( const std::string &  if_name,
PortID  idx 
)
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 SimObject.

Definition at line 92 of file smmu_v3_deviceifc.cc.

References atsDevicePort, atsMemPort, devicePort, SimObject::getPort(), and SimObject::name().

◆ params()

const SMMUv3DeviceInterfaceParams* SMMUv3DeviceInterface::params ( ) const
inline

Definition at line 130 of file smmu_v3_deviceifc.hh.

References SimObject::_params.

Referenced by drain().

◆ recvAtomic()

Tick SMMUv3DeviceInterface::recvAtomic ( PacketPtr  pkt)

◆ recvTimingReq()

bool SMMUv3DeviceInterface::recvTimingReq ( PacketPtr  pkt)

◆ schedAtsTimingResp()

void SMMUv3DeviceInterface::schedAtsTimingResp ( PacketPtr  pkt)

◆ schedTimingResp()

void SMMUv3DeviceInterface::schedTimingResp ( PacketPtr  pkt)

◆ scheduleDeviceRetry()

void SMMUv3DeviceInterface::scheduleDeviceRetry ( )

◆ sendDeviceRetry()

void SMMUv3DeviceInterface::sendDeviceRetry ( )

Definition at line 231 of file smmu_v3_deviceifc.cc.

References devicePort, and ResponsePort::sendRetryReq().

Referenced by SMMUDeviceRetryEvent::process().

◆ sendRange()

void SMMUv3DeviceInterface::sendRange ( )

◆ setSMMU()

void SMMUv3DeviceInterface::setSMMU ( SMMUv3 _smmu)
inline

Definition at line 137 of file smmu_v3_deviceifc.hh.

References smmu.

Friends And Related Function Documentation

◆ SMMUTranslationProcess

friend class SMMUTranslationProcess
friend

Definition at line 58 of file smmu_v3_deviceifc.hh.

Referenced by atsRecvTimingReq(), and recvTimingReq().

Member Data Documentation

◆ atsDeviceNeedsRetry

bool SMMUv3DeviceInterface::atsDeviceNeedsRetry

Definition at line 111 of file smmu_v3_deviceifc.hh.

Referenced by schedAtsTimingResp().

◆ atsDevicePort

SMMUATSDevicePort SMMUv3DeviceInterface::atsDevicePort

Definition at line 76 of file smmu_v3_deviceifc.hh.

Referenced by atsSendDeviceRetry(), getPort(), and schedAtsTimingResp().

◆ atsMemPort

SMMUATSMemoryPort SMMUv3DeviceInterface::atsMemPort

Definition at line 77 of file smmu_v3_deviceifc.hh.

Referenced by getPort().

◆ atsSendDeviceRetryEvent

EventWrapper< SMMUv3DeviceInterface, &SMMUv3DeviceInterface::atsSendDeviceRetry> SMMUv3DeviceInterface::atsSendDeviceRetryEvent

Definition at line 116 of file smmu_v3_deviceifc.hh.

Referenced by schedAtsTimingResp().

◆ dependentReads

std::list<SMMUTranslationProcess *> SMMUv3DeviceInterface::dependentReads[SMMU_MAX_TRANS_ID]

◆ dependentReqRemoved

SMMUSignal SMMUv3DeviceInterface::dependentReqRemoved

◆ dependentWrites

std::list<SMMUTranslationProcess *> SMMUv3DeviceInterface::dependentWrites[SMMU_MAX_TRANS_ID]

◆ deviceNeedsRetry

bool SMMUv3DeviceInterface::deviceNeedsRetry

Definition at line 110 of file smmu_v3_deviceifc.hh.

Referenced by atsRecvTimingReq(), recvTimingReq(), and scheduleDeviceRetry().

◆ devicePort

SMMUDevicePort* SMMUv3DeviceInterface::devicePort

◆ devicePortSem

SMMUSemaphore SMMUv3DeviceInterface::devicePortSem

Definition at line 68 of file smmu_v3_deviceifc.hh.

Referenced by SMMUTranslationProcess::main().

◆ duplicateReqRemoved

SMMUSignal SMMUv3DeviceInterface::duplicateReqRemoved

◆ duplicateReqs

std::list<SMMUTranslationProcess *> SMMUv3DeviceInterface::duplicateReqs

◆ mainTLB

SMMUTLB* SMMUv3DeviceInterface::mainTLB

◆ mainTLBEnable

const bool SMMUv3DeviceInterface::mainTLBEnable

◆ mainTLBLat

const Cycles SMMUv3DeviceInterface::mainTLBLat

Definition at line 73 of file smmu_v3_deviceifc.hh.

Referenced by SMMUTranslationProcess::ifcTLBLookup().

◆ mainTLBSem

SMMUSemaphore SMMUv3DeviceInterface::mainTLBSem

◆ microTLB

SMMUTLB* SMMUv3DeviceInterface::microTLB

◆ microTLBEnable

const bool SMMUv3DeviceInterface::microTLBEnable

◆ microTLBLat

const Cycles SMMUv3DeviceInterface::microTLBLat

Definition at line 72 of file smmu_v3_deviceifc.hh.

Referenced by SMMUTranslationProcess::microTLBLookup().

◆ microTLBSem

SMMUSemaphore SMMUv3DeviceInterface::microTLBSem

◆ pendingMemAccesses

unsigned SMMUv3DeviceInterface::pendingMemAccesses

◆ portWidth

const unsigned SMMUv3DeviceInterface::portWidth

◆ prefetchEnable

const bool SMMUv3DeviceInterface::prefetchEnable

◆ prefetchReserveLastWay

const bool SMMUv3DeviceInterface::prefetchReserveLastWay

Definition at line 87 of file smmu_v3_deviceifc.hh.

Referenced by SMMUTranslationProcess::ifcTLBUpdate().

◆ sendDeviceRetryEvent

SMMUDeviceRetryEvent SMMUv3DeviceInterface::sendDeviceRetryEvent

Definition at line 113 of file smmu_v3_deviceifc.hh.

Referenced by scheduleDeviceRetry().

◆ smmu

SMMUv3* SMMUv3DeviceInterface::smmu

◆ wrBufSlotsRemaining

unsigned SMMUv3DeviceInterface::wrBufSlotsRemaining

◆ xlateSlotsRemaining

unsigned SMMUv3DeviceInterface::xlateSlotsRemaining

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

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