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

#include <plic.hh>

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

Classes

class  PlicRegisters
 MMIO Registers. More...
 

Public Types

typedef PlicParams Params
 
- 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

 Plic (const Params &params)
 
void post (int src_id)
 Interrupt interface. More...
 
void clear (int src_id)
 
void init () override
 SimObject functions. 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::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 ()
 
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
 

Protected Member Functions

Tick read (PacketPtr pkt) override
 PioDevice funcitons. More...
 
Tick write (PacketPtr pkt) override
 Pure virtual function that the device must implement. 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

Systemsystem
 
int nSrc
 
int nSrc32
 Number of 32-bit pending registers needed = ceil(nSrc / 32) More...
 
int nContext
 Number of interrupt contexts = nThread * 2 e.g. 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...
 

Private Types

using Register32 = PlicRegisters::Register32
 

Private Member Functions

void writePriority (Register32 &reg, const uint32_t &data, const int src_id)
 Register read / write callbacks. More...
 
void writeEnable (Register32 &reg, const uint32_t &data, const int src32_id, const int context_id)
 
void writeThreshold (Register32 &reg, const uint32_t &data, const int context_id)
 
uint32_t readClaim (Register32 &reg, const int context_id)
 
void writeClaim (Register32 &reg, const uint32_t &data, const int context_id)
 
void propagateOutput ()
 Trigger: More...
 
void updateOutput ()
 Trigger: More...
 
void updateInt ()
 Trigger: More...
 

Private Attributes

gem5::Plic::PlicRegisters registers
 
std::vector< uint32_t > pendingPriority
 
std::vector< std::vector< uint32_t > > effPriority
 
std::vector< uint32_t > lastID
 
PlicOutput output
 
std::map< Tick, PlicOutputoutputQueue
 
EventFunctionWrapper update
 

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...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 

Detailed Description

Definition at line 97 of file plic.hh.

Member Typedef Documentation

◆ Params

typedef PlicParams gem5::Plic::Params

Definition at line 120 of file plic.hh.

◆ Register32

Definition at line 217 of file plic.hh.

Constructor & Destructor Documentation

◆ Plic()

gem5::Plic::Plic ( const Params params)

Definition at line 55 of file plic.cc.

References updateOutput().

Member Function Documentation

◆ clear()

void gem5::Plic::clear ( int  src_id)

◆ init()

void gem5::Plic::init ( )
overridevirtual

◆ post()

void gem5::Plic::post ( int  src_id)

◆ propagateOutput()

void gem5::Plic::propagateOutput ( )
private

Trigger:

Task:

  • calculate new output
  • schedule next update event and/or add new output to outputQueue

Definition at line 391 of file plic.cc.

References gem5::curTick(), gem5::Clocked::cyclesToTicks(), DPRINTF, effPriority, gem5::ArmISA::i, nContext, outputQueue, gem5::EventManager::schedule(), gem5::Event::scheduled(), and update.

Referenced by clear(), post(), and write().

◆ read()

Tick gem5::Plic::read ( PacketPtr  pkt)
overrideprotectedvirtual

◆ readClaim()

uint32_t gem5::Plic::readClaim ( Register32 reg,
const int  context_id 
)
private

◆ serialize()

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

◆ unserialize()

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

◆ updateInt()

void gem5::Plic::updateInt ( )
private

◆ updateOutput()

void gem5::Plic::updateOutput ( )
private

Trigger:

Task:

  • set current output to new output
  • schedule next update event (if any)

Definition at line 423 of file plic.cc.

References DPRINTF, output, outputQueue, gem5::EventManager::schedule(), update, and updateInt().

Referenced by Plic().

◆ write()

Tick gem5::Plic::write ( PacketPtr  pkt)
overrideprotectedvirtual

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 144 of file plic.cc.

References DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getPtr(), gem5::Packet::getSize(), gem5::Packet::makeResponse(), gem5::BasicPioDevice::pioDelay, propagateOutput(), registers, updateInt(), and gem5::RegisterBank< BankByteOrder >::write().

Referenced by read().

◆ writeClaim()

void gem5::Plic::writeClaim ( Register32 reg,
const uint32_t &  data,
const int  context_id 
)
private

Plic spec states that this error should be silently ignored. However, this is not supposed to happen.

Definition at line 374 of file plic.cc.

References data, DPRINTF, lastID, gem5::X86ISA::reg, and updateInt().

Referenced by gem5::Plic::PlicRegisters::init().

◆ writeEnable()

void gem5::Plic::writeEnable ( Register32 reg,
const uint32_t &  data,
const int  src32_id,
const int  context_id 
)
private

◆ writePriority()

void gem5::Plic::writePriority ( Register32 reg,
const uint32_t &  data,
const int  src_id 
)
private

◆ writeThreshold()

void gem5::Plic::writeThreshold ( Register32 reg,
const uint32_t &  data,
const int  context_id 
)
private

Definition at line 334 of file plic.cc.

References DPRINTF, and gem5::X86ISA::reg.

Referenced by gem5::Plic::PlicRegisters::init().

Member Data Documentation

◆ effPriority

std::vector<std::vector<uint32_t> > gem5::Plic::effPriority
private

◆ lastID

std::vector<uint32_t> gem5::Plic::lastID
private

Definition at line 245 of file plic.hh.

Referenced by init(), readClaim(), serialize(), unserialize(), updateInt(), and writeClaim().

◆ nContext

int gem5::Plic::nContext
protected

Number of interrupt contexts = nThread * 2 e.g.

context 0 => thread 0 M mode context 1 => thread 0 S mode This is based on SiFive U54MC datasheet

Definition at line 117 of file plic.hh.

Referenced by clear(), init(), gem5::Plic::PlicRegisters::init(), post(), propagateOutput(), updateInt(), and writePriority().

◆ nSrc

int gem5::Plic::nSrc
protected

Definition at line 104 of file plic.hh.

Referenced by clear(), init(), gem5::Plic::PlicRegisters::init(), and writeEnable().

◆ nSrc32

int gem5::Plic::nSrc32
protected

Number of 32-bit pending registers needed = ceil(nSrc / 32)

Definition at line 109 of file plic.hh.

Referenced by init(), and gem5::Plic::PlicRegisters::init().

◆ output

PlicOutput gem5::Plic::output
private

Definition at line 246 of file plic.hh.

Referenced by init(), readClaim(), serialize(), unserialize(), updateInt(), and updateOutput().

◆ outputQueue

std::map<Tick, PlicOutput> gem5::Plic::outputQueue
private

Definition at line 260 of file plic.hh.

Referenced by propagateOutput(), serialize(), unserialize(), and updateOutput().

◆ pendingPriority

std::vector<uint32_t> gem5::Plic::pendingPriority
private

Definition at line 241 of file plic.hh.

Referenced by clear(), init(), post(), serialize(), unserialize(), writeEnable(), and writePriority().

◆ registers

gem5::Plic::PlicRegisters gem5::Plic::registers
private

◆ system

System* gem5::Plic::system
protected

Definition at line 101 of file plic.hh.

Referenced by init(), and updateInt().

◆ update

EventFunctionWrapper gem5::Plic::update
private

Definition at line 261 of file plic.hh.

Referenced by propagateOutput(), unserialize(), and updateOutput().


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

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