gem5  v22.1.0.0
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
gem5::MHU Class Reference

Message Handling Unit. More...

#include <mhu.hh>

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

Public Types

enum  {
  SCP_INTR_L_STAT = 0x0 , SCP_INTR_L_SET = 0x8 , SCP_INTR_L_CLEAR = 0x10 , SCP_INTR_H_STAT = 0x20 ,
  SCP_INTR_H_SET = 0x28 , SCP_INTR_H_CLEAR = 0x30 , CPU_INTR_L_STAT = 0x100 , CPU_INTR_L_SET = 0x108 ,
  CPU_INTR_L_CLEAR = 0x110 , CPU_INTR_H_STAT = 0x120 , CPU_INTR_H_SET = 0x128 , CPU_INTR_H_CLEAR = 0x130 ,
  SCP_INTR_S_STAT = 0x200 , SCP_INTR_S_SET = 0x208 , SCP_INTR_S_CLEAR = 0x210 , CPU_INTR_S_STAT = 0x300 ,
  CPU_INTR_S_SET = 0x308 , CPU_INTR_S_CLEAR = 0x310 , MHU_SCFG = 0x400 , PID4 = 0xfd0 ,
  PID0 = 0xfe0 , PID1 = 0xfe4 , PID2 = 0xfe8 , PID3 = 0xfec ,
  COMPID0 = 0xff0 , COMPID1 = 0xff4 , COMPID2 = 0xff8 , COMPID3 = 0xffc
}
 
- 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
 

Public Member Functions

 MHU (const MHUParams &p)
 
AddrRangeList getAddrRanges () const override
 Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to. More...
 
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...
 
uint32_t read32 (const Addr addr, bool secure_access)
 
- Public Member Functions inherited from gem5::BasicPioDevice
 PARAMS (BasicPioDevice)
 
 BasicPioDevice (const Params &p, Addr size)
 
AddrRangeList getAddrRanges () const override
 Determine the address ranges that this device responds to. 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
 

Public Attributes

Scp2ApDoorbellscpLow
 
Scp2ApDoorbellscpHigh
 
Scp2ApDoorbellscpSec
 
Ap2ScpDoorbellapLow
 
Ap2ScpDoorbellapHigh
 
Ap2ScpDoorbellapSec
 
uint32_t pid [5]
 
uint32_t compid [4]
 
uint32_t scfg
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

Static Public Attributes

static const uint32_t SVI_INT = 0x80000000
 

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...
 
- 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::BasicPioDevice
Addr pioAddr
 Address that the device listens to. More...
 
Addr pioSize
 Size that the device's address range. More...
 
Tick pioDelay
 Delay that the device experinces on an access. 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

Message Handling Unit.

Definition at line 102 of file mhu.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SCP_INTR_L_STAT 

From SCP to Application Processor.

SCP_INTR_L_SET 
SCP_INTR_L_CLEAR 
SCP_INTR_H_STAT 
SCP_INTR_H_SET 
SCP_INTR_H_CLEAR 
CPU_INTR_L_STAT 

From Application Processor to SCP.

CPU_INTR_L_SET 
CPU_INTR_L_CLEAR 
CPU_INTR_H_STAT 
CPU_INTR_H_SET 
CPU_INTR_H_CLEAR 
SCP_INTR_S_STAT 
SCP_INTR_S_SET 
SCP_INTR_S_CLEAR 
CPU_INTR_S_STAT 
CPU_INTR_S_SET 
CPU_INTR_S_CLEAR 
MHU_SCFG 
PID4 
PID0 
PID1 
PID2 
PID3 
COMPID0 
COMPID1 
COMPID2 
COMPID3 

Definition at line 105 of file mhu.hh.

Constructor & Destructor Documentation

◆ MHU()

gem5::MHU::MHU ( const MHUParams &  p)

Definition at line 59 of file mhu.cc.

References apHigh, apLow, apSec, gem5::VegaISA::p, and gem5::Ap2ScpDoorbell::setScp().

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::MHU::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 77 of file mhu.cc.

References gem5::BasicPioDevice::pioAddr, gem5::BasicPioDevice::pioSize, and gem5::RangeSize().

◆ read()

Tick gem5::MHU::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 83 of file mhu.cc.

References gem5::X86ISA::addr, DPRINTF, gem5::Packet::getAddr(), gem5::Packet::isSecure(), gem5::Packet::makeAtomicResponse(), gem5::BasicPioDevice::pioAddr, gem5::BasicPioDevice::pioDelay, read32(), and gem5::Packet::setUintX().

◆ read32()

uint32_t gem5::MHU::read32 ( const Addr  addr,
bool  secure_access 
)

◆ write()

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

Member Data Documentation

◆ apHigh

Ap2ScpDoorbell* gem5::MHU::apHigh

Definition at line 162 of file mhu.hh.

Referenced by MHU(), read32(), and write().

◆ apLow

Ap2ScpDoorbell* gem5::MHU::apLow

Definition at line 161 of file mhu.hh.

Referenced by MHU(), read32(), and write().

◆ apSec

Ap2ScpDoorbell* gem5::MHU::apSec

Definition at line 163 of file mhu.hh.

Referenced by MHU(), read32(), and write().

◆ compid

uint32_t gem5::MHU::compid[4]

Definition at line 167 of file mhu.hh.

Referenced by read32().

◆ pid

uint32_t gem5::MHU::pid[5]

Definition at line 166 of file mhu.hh.

Referenced by read32().

◆ scfg

uint32_t gem5::MHU::scfg

Definition at line 169 of file mhu.hh.

Referenced by read32(), and write().

◆ scpHigh

Scp2ApDoorbell* gem5::MHU::scpHigh

Definition at line 158 of file mhu.hh.

Referenced by read32(), and write().

◆ scpLow

Scp2ApDoorbell* gem5::MHU::scpLow

Definition at line 157 of file mhu.hh.

Referenced by read32(), and write().

◆ scpSec

Scp2ApDoorbell* gem5::MHU::scpSec

Definition at line 159 of file mhu.hh.

Referenced by read32(), and write().

◆ SVI_INT

const uint32_t gem5::MHU::SVI_INT = 0x80000000
static

Definition at line 146 of file mhu.hh.

Referenced by read32().


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

Generated on Wed Dec 21 2022 10:23:16 for gem5 by doxygen 1.9.1