gem5  v21.1.0.2
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
gem5::Gicv3 Class Reference

#include <gic_v3.hh>

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

Public Types

enum  IntStatus { INT_INACTIVE, INT_PENDING, INT_ACTIVE, INT_ACTIVE_PENDING }
 
enum  GroupId { G0S, G1S, G1NS }
 
enum  IntTriggerType { INT_LEVEL_SENSITIVE, INT_EDGE_TRIGGERED }
 
- 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
 

Public Member Functions

 Gicv3 (const Params &p)
 
void deassertInt (uint32_t cpu, ArmISA::InterruptTypes int_type)
 
void deassertAll (uint32_t cpu)
 
bool haveAsserted (uint32_t cpu) const
 
Gicv3CPUInterfacegetCPUInterface (int cpu_id) const
 
Gicv3DistributorgetDistributor () const
 
Gicv3RedistributorgetRedistributor (ContextID context_id) const
 
Gicv3RedistributorgetRedistributorByAffinity (uint32_t affinity) const
 
Gicv3RedistributorgetRedistributorByAddr (Addr address) const
 
void postInt (uint32_t cpu, ArmISA::InterruptTypes int_type)
 
- Public Member Functions inherited from gem5::BaseGic
 BaseGic (const Params &p)
 
virtual ~BaseGic ()
 
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
 

Static Public Attributes

static const int INTID_SECURE = 1020
 
static const int INTID_NONSECURE = 1021
 
static const int INTID_SPURIOUS = 1023
 
static const int SGI_MAX = 16
 
static const int PPI_MAX = 16
 

Protected Member Functions

void clearInt (uint32_t int_id) override
 Clear an interrupt from a device that is connected to the GIC. More...
 
void clearPPInt (uint32_t int_id, uint32_t cpu) override
 
AddrRangeList getAddrRanges () const override
 Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to. More...
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
 PARAMS (Gicv3)
 
Tick read (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
void reset ()
 
void sendInt (uint32_t int_id) override
 Post an interrupt from a device that is connected to the GIC. More...
 
void sendPPInt (uint32_t int_id, uint32_t cpu) override
 Interface call for private peripheral interrupts. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
Tick write (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
bool supportsVersion (GicVersion version) override
 Check if version supported. 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

Gicv3Distributordistributor
 
std::vector< Gicv3Redistributor * > redistributors
 
std::vector< Gicv3CPUInterface * > cpuInterfaces
 
Gicv3Itsits
 
AddrRange distRange
 
AddrRange redistRange
 
AddrRangeList addrRanges
 
uint64_t redistSize
 
- 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...
 

Friends

class Gicv3CPUInterface
 
class Gicv3Redistributor
 

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 56 of file gic_v3.hh.

Member Enumeration Documentation

◆ GroupId

Enumerator
G0S 
G1S 
G1NS 

Definition at line 93 of file gic_v3.hh.

◆ IntStatus

Enumerator
INT_INACTIVE 
INT_PENDING 
INT_ACTIVE 
INT_ACTIVE_PENDING 

Definition at line 84 of file gic_v3.hh.

◆ IntTriggerType

Enumerator
INT_LEVEL_SENSITIVE 
INT_EDGE_TRIGGERED 

Definition at line 100 of file gic_v3.hh.

Constructor & Destructor Documentation

◆ Gicv3()

gem5::Gicv3::Gicv3 ( const Params p)

Definition at line 57 of file gic_v3.cc.

Member Function Documentation

◆ clearInt()

void gem5::Gicv3::clearInt ( uint32_t  num)
overrideprotectedvirtual

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 183 of file gic_v3.cc.

References gem5::Gicv3Distributor::clearInt(), distributor, and DPRINTF.

◆ clearPPInt()

void gem5::Gicv3::clearPPInt ( uint32_t  int_id,
uint32_t  cpu 
)
overrideprotectedvirtual

Implements gem5::BaseGic.

Definition at line 199 of file gic_v3.cc.

References DPRINTF, panic_if, and redistributors.

◆ deassertAll()

void gem5::Gicv3::deassertAll ( uint32_t  cpu)

◆ deassertInt()

void gem5::Gicv3::deassertInt ( uint32_t  cpu,
ArmISA::InterruptTypes  int_type 
)

◆ getAddrRanges()

AddrRangeList gem5::Gicv3::getAddrRanges ( ) const
inlineoverrideprotectedvirtual

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 112 of file gic_v3.hh.

References addrRanges.

◆ getCPUInterface()

Gicv3CPUInterface* gem5::Gicv3::getCPUInterface ( int  cpu_id) const
inline

Definition at line 138 of file gic_v3.hh.

References cpuInterfaces.

Referenced by gem5::Gicv3Redistributor::init(), and gem5::ArmISA::ISA::setupThreadContext().

◆ getDistributor()

Gicv3Distributor* gem5::Gicv3::getDistributor ( ) const
inline

◆ getRedistributor()

Gicv3Redistributor* gem5::Gicv3::getRedistributor ( ContextID  context_id) const
inline

◆ getRedistributorByAddr()

Gicv3Redistributor * gem5::Gicv3::getRedistributorByAddr ( Addr  address) const

◆ getRedistributorByAffinity()

Gicv3Redistributor * gem5::Gicv3::getRedistributorByAffinity ( uint32_t  affinity) const

Definition at line 244 of file gic_v3.cc.

References redistributors.

Referenced by gem5::Gicv3Distributor::route().

◆ haveAsserted()

bool gem5::Gicv3::haveAsserted ( uint32_t  cpu) const

◆ init()

void gem5::Gicv3::init ( )
overrideprotectedvirtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from gem5::BaseGic.

Definition at line 63 of file gic_v3.cc.

References gem5::Gicv3Distributor::ADDR_RANGE_SIZE, addrRanges, cpuInterfaces, distRange, distributor, Gicv3CPUInterface, Gicv3Redistributor, gem5::ArmISA::i, gem5::BaseGic::init(), gem5::Gicv3Distributor::init(), its, panic_if, gem5::BaseGic::params(), gem5::RangeSize(), redistRange, redistributors, redistSize, gem5::Gicv3Its::setGIC(), gem5::System::Threads::size(), gem5::PioDevice::sys, and gem5::System::threads.

◆ PARAMS()

gem5::Gicv3::PARAMS ( Gicv3  )
protected

◆ postInt()

void gem5::Gicv3::postInt ( uint32_t  cpu,
ArmISA::InterruptTypes  int_type 
)

◆ read()

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

◆ reset()

void gem5::Gicv3::reset ( )
protected

◆ sendInt()

void gem5::Gicv3::sendInt ( uint32_t  num)
overrideprotectedvirtual

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 176 of file gic_v3.cc.

References distributor, DPRINTF, and gem5::Gicv3Distributor::sendInt().

◆ sendPPInt()

void gem5::Gicv3::sendPPInt ( uint32_t  num,
uint32_t  cpu 
)
overrideprotectedvirtual

Interface call for private peripheral interrupts.

Parameters
numnumber of interrupt to send
cpuCPU to forward interrupt to

Implements gem5::BaseGic.

Definition at line 190 of file gic_v3.cc.

References DPRINTF, panic_if, and redistributors.

◆ serialize()

void gem5::Gicv3::serialize ( CheckpointOut cp) const
overrideprotectedvirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 272 of file gic_v3.cc.

References cpuInterfaces, gem5::csprintf(), distributor, redistributors, and gem5::Serializable::serializeSection().

◆ supportsVersion()

bool gem5::Gicv3::supportsVersion ( GicVersion  version)
overrideprotectedvirtual

Check if version supported.

Implements gem5::BaseGic.

Definition at line 216 of file gic_v3.cc.

References gem5::BaseGic::GIC_V3, gem5::BaseGic::GIC_V4, and gem5::BaseGic::params().

◆ unserialize()

void gem5::Gicv3::unserialize ( CheckpointIn cp)
overrideprotectedvirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 288 of file gic_v3.cc.

References cpuInterfaces, gem5::csprintf(), distributor, gem5::BaseGic::getSystem(), redistributors, gem5::ArmSystem::setGIC(), and gem5::Serializable::unserializeSection().

◆ write()

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

Friends And Related Function Documentation

◆ Gicv3CPUInterface

friend class Gicv3CPUInterface
friend

Definition at line 59 of file gic_v3.hh.

Referenced by init().

◆ Gicv3Redistributor

friend class Gicv3Redistributor
friend

Definition at line 60 of file gic_v3.hh.

Referenced by init().

Member Data Documentation

◆ addrRanges

AddrRangeList gem5::Gicv3::addrRanges
protected

Definition at line 68 of file gic_v3.hh.

Referenced by getAddrRanges(), and init().

◆ cpuInterfaces

std::vector<Gicv3CPUInterface *> gem5::Gicv3::cpuInterfaces
protected

Definition at line 64 of file gic_v3.hh.

Referenced by getCPUInterface(), init(), serialize(), and unserialize().

◆ distRange

AddrRange gem5::Gicv3::distRange
protected

Definition at line 66 of file gic_v3.hh.

Referenced by init(), read(), and write().

◆ distributor

Gicv3Distributor* gem5::Gicv3::distributor
protected

Definition at line 62 of file gic_v3.hh.

Referenced by clearInt(), getDistributor(), init(), read(), sendInt(), serialize(), unserialize(), and write().

◆ INTID_NONSECURE

const int gem5::Gicv3::INTID_NONSECURE = 1021
static

◆ INTID_SECURE

const int gem5::Gicv3::INTID_SECURE = 1020
static

◆ INTID_SPURIOUS

const int gem5::Gicv3::INTID_SPURIOUS = 1023
static

◆ its

Gicv3Its* gem5::Gicv3::its
protected

Definition at line 65 of file gic_v3.hh.

Referenced by init().

◆ PPI_MAX

const int gem5::Gicv3::PPI_MAX = 16
static

◆ redistRange

AddrRange gem5::Gicv3::redistRange
protected

Definition at line 67 of file gic_v3.hh.

Referenced by getRedistributorByAddr(), init(), read(), and write().

◆ redistributors

std::vector<Gicv3Redistributor *> gem5::Gicv3::redistributors
protected

◆ redistSize

uint64_t gem5::Gicv3::redistSize
protected

Definition at line 69 of file gic_v3.hh.

Referenced by getRedistributorByAddr(), init(), read(), and write().

◆ SGI_MAX

const int gem5::Gicv3::SGI_MAX = 16
static

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

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