gem5  v21.1.0.2
Public Member Functions | Private Types | Private Attributes | List of all members
gem5::fastmodel::GIC Class Reference

#include <gic.hh>

Inheritance diagram for gem5::fastmodel::GIC:
gem5::BaseGic gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Member Functions

 GIC (const FastModelGICParams &params)
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
void sendInt (uint32_t num) override
 Post an interrupt from a device that is connected to the GIC. More...
 
void clearInt (uint32_t num) override
 Clear an interrupt from a device that is connected to the GIC. More...
 
void sendPPInt (uint32_t num, uint32_t cpu) override
 Interface call for private peripheral interrupts. More...
 
void clearPPInt (uint32_t num, uint32_t cpu) override
 
bool supportsVersion (GicVersion version) override
 Check if version supported. More...
 
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...
 
- Public Member Functions inherited from gem5::BaseGic
 BaseGic (const Params &p)
 
virtual ~BaseGic ()
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
const Paramsparams () const
 
ArmSystemgetSystem () const
 
- 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
 

Private Types

typedef sc_gem5::TlmInitiatorBaseWrapper< 64, svp_gicv3_comms::gicv3_comms_fw_if, svp_gicv3_comms::gicv3_comms_bw_if, 1, sc_core::SC_ONE_OR_MORE_BOUNDTlmGicInitiator
 

Private Attributes

AmbaInitiator ambaM
 
AmbaTarget ambaS
 
std::vector< std::unique_ptr< TlmGicInitiator > > redistributors
 
SCGICscGIC
 

Additional Inherited Members

- Public Types inherited from gem5::BaseGic
enum  GicVersion { GicVersion::GIC_V2, GicVersion::GIC_V3, GicVersion::GIC_V4 }
 
typedef BaseGicParams 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
 
- 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
 
- 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::BaseGic
Platformplatform
 Platform this GIC belongs to. 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

Definition at line 110 of file gic.hh.

Member Typedef Documentation

◆ TlmGicInitiator

typedef sc_gem5::TlmInitiatorBaseWrapper< 64, svp_gicv3_comms::gicv3_comms_fw_if, svp_gicv3_comms::gicv3_comms_bw_if, 1, sc_core::SC_ONE_OR_MORE_BOUND> gem5::fastmodel::GIC::TlmGicInitiator
private

Definition at line 116 of file gic.hh.

Constructor & Destructor Documentation

◆ GIC()

gem5::fastmodel::GIC::GIC ( const FastModelGICParams &  params)

Definition at line 303 of file gic.cc.

Member Function Documentation

◆ clearInt()

void gem5::fastmodel::GIC::clearInt ( uint32_t  num)
overridevirtual

Clear an interrupt from a device that is connected to the GIC.

Depending on the configuration, the GIC may de-assert it's CPU line.

Parameters
numnumber of interrupt to send

Implements gem5::BaseGic.

Definition at line 338 of file gic.cc.

References scGIC, and gem5::fastmodel::SCGIC::signalInterrupt.

◆ clearPPInt()

void gem5::fastmodel::GIC::clearPPInt ( uint32_t  num,
uint32_t  cpu 
)
overridevirtual

Implements gem5::BaseGic.

Definition at line 350 of file gic.cc.

References scGIC, and gem5::fastmodel::SCGIC::signalInterrupt.

◆ getAddrRanges()

AddrRangeList gem5::fastmodel::GIC::getAddrRanges ( ) const
inlineoverridevirtual

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 138 of file gic.hh.

◆ getPort()

Port & gem5::fastmodel::GIC::getPort ( const std::string &  if_name,
PortID  idx = InvalidPortID 
)
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 312 of file gic.cc.

References ambaM, ambaS, gem5::csprintf(), gem5::PioDevice::getPort(), gem5::Named::name(), redistributors, and scGIC.

◆ read()

Tick gem5::fastmodel::GIC::read ( PacketPtr  pkt)
inlineoverridevirtual

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 139 of file gic.hh.

◆ sendInt()

void gem5::fastmodel::GIC::sendInt ( uint32_t  num)
overridevirtual

Post an interrupt from a device that is connected to the GIC.

Depending on the configuration, the GIC will pass this interrupt on through to a CPU.

Parameters
numnumber of interrupt to send

Implements gem5::BaseGic.

Definition at line 332 of file gic.cc.

References scGIC, and gem5::fastmodel::SCGIC::signalInterrupt.

◆ sendPPInt()

void gem5::fastmodel::GIC::sendPPInt ( uint32_t  num,
uint32_t  cpu 
)
overridevirtual

Interface call for private peripheral interrupts.

Parameters
numnumber of interrupt to send
cpuCPU to forward interrupt to

Implements gem5::BaseGic.

Definition at line 344 of file gic.cc.

References scGIC, and gem5::fastmodel::SCGIC::signalInterrupt.

◆ supportsVersion()

bool gem5::fastmodel::GIC::supportsVersion ( GicVersion  version)
overridevirtual

Check if version supported.

Implements gem5::BaseGic.

Definition at line 356 of file gic.cc.

References gem5::BaseGic::GIC_V2, gem5::BaseGic::GIC_V3, gem5::BaseGic::GIC_V4, and scGIC.

◆ write()

Tick gem5::fastmodel::GIC::write ( PacketPtr  pkt)
inlineoverridevirtual

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 140 of file gic.hh.

Member Data Documentation

◆ ambaM

AmbaInitiator gem5::fastmodel::GIC::ambaM
private

Definition at line 118 of file gic.hh.

Referenced by getPort().

◆ ambaS

AmbaTarget gem5::fastmodel::GIC::ambaS
private

Definition at line 119 of file gic.hh.

Referenced by getPort().

◆ redistributors

std::vector<std::unique_ptr<TlmGicInitiator> > gem5::fastmodel::GIC::redistributors
private

Definition at line 120 of file gic.hh.

Referenced by getPort().

◆ scGIC

SCGIC* gem5::fastmodel::GIC::scGIC
private

Definition at line 122 of file gic.hh.

Referenced by clearInt(), clearPPInt(), getPort(), sendInt(), sendPPInt(), and supportsVersion().


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

Generated on Tue Sep 21 2021 12:29:00 for gem5 by doxygen 1.8.17