gem5  v21.1.0.2
Public Member Functions | Public Attributes | Protected Attributes | List of all members
gem5::scmi::PlatformChannel Class Reference

This is a Platform to Agent channel (The platform is the initiator) More...

#include <scmi_platform.hh>

Inheritance diagram for gem5::scmi::PlatformChannel:
gem5::scmi::VirtualChannel gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Member Functions

 PlatformChannel (const ScmiChannelParams &p)
 
void writeBackMessage (const Message &msg)
 
void notifyAgent ()
 
void clearDoorbell ()
 
void complete ()
 
- Public Member Functions inherited from gem5::scmi::VirtualChannel
 VirtualChannel (const ScmiChannelParams &p)
 
void setPlatform (Platform *_platform)
 Set a pointer to the SCMI platform. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
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 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 Attributes

EventFunctionWrapper clearDoorbellEvent
 
EventFunctionWrapper notifyAgentEvent
 
EventFunctionWrapper completeEvent
 
- Public Attributes inherited from gem5::scmi::VirtualChannel
Message msgBuffer
 
bool pendingMessage
 
const AddrRange shmem
 
const uint32_t physID
 
const uint32_t virtID
 
DmaPortdmaPort
 
Doorbelldoorbell
 
Platformplatform
 

Protected Attributes

uint32_t agentDoorbellVal
 
uint32_t platformDoorbellVal
 
- 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...
 

Additional Inherited Members

- 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...
 
- 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...
 

Detailed Description

This is a Platform to Agent channel (The platform is the initiator)

Definition at line 227 of file scmi_platform.hh.

Constructor & Destructor Documentation

◆ PlatformChannel()

gem5::PlatformChannel::PlatformChannel ( const ScmiChannelParams &  p)

Definition at line 135 of file scmi_platform.cc.

References clearDoorbell().

Member Function Documentation

◆ clearDoorbell()

void gem5::PlatformChannel::clearDoorbell ( )

◆ complete()

void gem5::PlatformChannel::complete ( )

◆ notifyAgent()

void gem5::PlatformChannel::notifyAgent ( )

◆ writeBackMessage()

void gem5::PlatformChannel::writeBackMessage ( const Message msg)

Member Data Documentation

◆ agentDoorbellVal

uint32_t gem5::scmi::PlatformChannel::agentDoorbellVal
protected

Definition at line 242 of file scmi_platform.hh.

Referenced by clearDoorbell().

◆ clearDoorbellEvent

EventFunctionWrapper gem5::scmi::PlatformChannel::clearDoorbellEvent

Definition at line 237 of file scmi_platform.hh.

Referenced by writeBackMessage().

◆ completeEvent

EventFunctionWrapper gem5::scmi::PlatformChannel::completeEvent

Definition at line 239 of file scmi_platform.hh.

Referenced by notifyAgent().

◆ notifyAgentEvent

EventFunctionWrapper gem5::scmi::PlatformChannel::notifyAgentEvent

Definition at line 238 of file scmi_platform.hh.

Referenced by clearDoorbell().

◆ platformDoorbellVal

uint32_t gem5::scmi::PlatformChannel::platformDoorbellVal
protected

Definition at line 243 of file scmi_platform.hh.

Referenced by notifyAgent().


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

Generated on Tue Sep 21 2021 12:32:17 for gem5 by doxygen 1.8.17