gem5  v21.1.0.2
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
gem5::scmi::Platform Class Reference

#include <scmi_platform.hh>

Inheritance diagram for gem5::scmi::Platform:
gem5::Scp gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::HiFive gem5::Malta gem5::Pc gem5::RealView gem5::T1000

Public Types

using ProtocolList = std::unordered_map< uint8_t, Protocol * >
 
- 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

 PARAMS (ScmiPlatform)
 
 Platform (const Params &p)
 
 ~Platform ()
 
void handleMessage (AgentChannel *ch, Message &msg)
 
uint32_t numAgents () const
 Returns the number of agents in the system. More...
 
const char * getAgent (unsigned index) const
 Returns the name of an agent given an index. More...
 
uint32_t numProtocols () const
 Returns the number of protocols implemented, except for the base protocol. More...
 
PortgetPort (const std::string &if_name, PortID idx) override
 Get a port with a given name and index. More...
 
void raiseInterrupt (const Doorbell *doorbell) override
 
void clearInterrupt (const Doorbell *doorbell) override
 
const ProtocolListprotocolList () const
 
AgentChannelfind (PlatformChannel *platform) const
 
PlatformChannelfind (AgentChannel *agent) const
 
- Public Member Functions inherited from gem5::Scp
 Scp (const ClockedObjectParams &p)
 
virtual ~Scp ()
 
- 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 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 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
 

Static Public Member Functions

static uint32_t protocolID (const Message &msg)
 
static uint32_t messageID (const Message &msg)
 
static uint32_t messageType (const Message &msg)
 
- 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...
 

Private Attributes

std::vector< Communication * > comms
 
const std::vector< std::string > agents
 
ProtocolList protocols
 
DmaPort dmaPort
 

Additional Inherited Members

- 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::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 264 of file scmi_platform.hh.

Member Typedef Documentation

◆ ProtocolList

using gem5::scmi::Platform::ProtocolList = std::unordered_map<uint8_t, Protocol *>

Definition at line 267 of file scmi_platform.hh.

Constructor & Destructor Documentation

◆ Platform()

gem5::Platform::Platform ( const Params p)

Definition at line 36 of file platform.cc.

◆ ~Platform()

gem5::Platform::~Platform ( )

Definition at line 222 of file scmi_platform.cc.

References protocols.

Member Function Documentation

◆ clearInterrupt()

void gem5::Platform::clearInterrupt ( const Doorbell doorbell)
overridevirtual

Implements gem5::Scp.

Definition at line 281 of file scmi_platform.cc.

References DPRINTF.

Referenced by gem5::VGic::unPostVInt().

◆ find() [1/2]

PlatformChannel * gem5::Platform::find ( AgentChannel agent) const

Definition at line 299 of file scmi_platform.cc.

References comms.

◆ find() [2/2]

AgentChannel * gem5::Platform::find ( PlatformChannel platform) const

Definition at line 287 of file scmi_platform.cc.

References comms.

Referenced by gem5::scmi::PlatformChannel::clearDoorbell(), and handleMessage().

◆ getAgent()

const char* gem5::scmi::Platform::getAgent ( unsigned  index) const
inline

Returns the name of an agent given an index.

Definition at line 280 of file scmi_platform.hh.

References agents, and gem5::MipsISA::index.

Referenced by gem5::scmi::BaseProtocol::discoverAgent().

◆ getPort()

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

Definition at line 230 of file scmi_platform.cc.

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

◆ handleMessage()

void gem5::Platform::handleMessage ( AgentChannel ch,
Message msg 
)

◆ messageID()

static uint32_t gem5::scmi::Platform::messageID ( const Message msg)
inlinestatic

◆ messageType()

static uint32_t gem5::scmi::Platform::messageType ( const Message msg)
inlinestatic

Definition at line 309 of file scmi_platform.hh.

References gem5::bits(), and gem5::scmi::Message::header.

◆ numAgents()

uint32_t gem5::scmi::Platform::numAgents ( ) const
inline

Returns the number of agents in the system.

Definition at line 276 of file scmi_platform.hh.

References agents.

Referenced by gem5::scmi::BaseProtocol::attributes(), and gem5::scmi::BaseProtocol::discoverAgent().

◆ numProtocols()

uint32_t gem5::scmi::Platform::numProtocols ( ) const
inline

Returns the number of protocols implemented, except for the base protocol.

Definition at line 289 of file scmi_platform.hh.

References protocols.

Referenced by gem5::scmi::BaseProtocol::attributes(), and gem5::scmi::BaseProtocol::discoverListProtocols().

◆ PARAMS()

gem5::scmi::Platform::PARAMS ( ScmiPlatform  )

◆ protocolID()

static uint32_t gem5::scmi::Platform::protocolID ( const Message msg)
inlinestatic

Definition at line 297 of file scmi_platform.hh.

References gem5::bits(), and gem5::scmi::Message::header.

Referenced by handleMessage().

◆ protocolList()

const ProtocolList& gem5::scmi::Platform::protocolList ( ) const
inline

Definition at line 315 of file scmi_platform.hh.

References protocols.

Referenced by gem5::scmi::BaseProtocol::discoverListProtocols().

◆ raiseInterrupt()

void gem5::Platform::raiseInterrupt ( const Doorbell doorbell)
overridevirtual

Implements gem5::Scp.

Definition at line 259 of file scmi_platform.cc.

References comms, DPRINTF, and panic.

Member Data Documentation

◆ agents

const std::vector<std::string> gem5::scmi::Platform::agents
private

Definition at line 325 of file scmi_platform.hh.

Referenced by getAgent(), and numAgents().

◆ comms

std::vector<Communication *> gem5::scmi::Platform::comms
private

Definition at line 324 of file scmi_platform.hh.

Referenced by find(), and raiseInterrupt().

◆ dmaPort

DmaPort gem5::scmi::Platform::dmaPort
private

Definition at line 329 of file scmi_platform.hh.

Referenced by getPort().

◆ protocols

ProtocolList gem5::scmi::Platform::protocols
private

Definition at line 327 of file scmi_platform.hh.

Referenced by handleMessage(), numProtocols(), protocolList(), and ~Platform().


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

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