gem5  v20.1.0.0
Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Friends | List of all members
Gicv3 Class Reference

#include <gic_v3.hh>

Inheritance diagram for Gicv3:
BaseGic PioDevice ClockedObject SimObject Clocked EventManager Serializable Drainable Stats::Group

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 BaseGic
enum  GicVersion { GicVersion::GIC_V2, GicVersion::GIC_V3, GicVersion::GIC_V4 }
 
typedef BaseGicParams Params
 
- Public Types inherited from PioDevice
typedef PioDeviceParams Params
 
- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from 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 BaseGic
 BaseGic (const Params *p)
 
virtual ~BaseGic ()
 
const Paramsparams () const
 
ArmSystemgetSystem () const
 
- Public Member Functions inherited from PioDevice
 PioDevice (const Params *p)
 
virtual ~PioDevice ()
 
const Paramsparams () const
 
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 ClockedObject
 ClockedObject (const ClockedObjectParams *p)
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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 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 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 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 Stats::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 (Stats::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...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from 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 Types

typedef Gicv3Params Params
 

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...
 
const Paramsparams () const
 
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 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 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 BaseGic
Platformplatform
 Platform this GIC belongs to. More...
 
- Protected Attributes inherited from PioDevice
Systemsys
 
PioPort< PioDevicepioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from 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 SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize 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 Public Member Functions inherited from Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 Serializes all the SimObjects. More...
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Public Attributes inherited from ClockedObject
PowerStatepowerState
 

Detailed Description

Definition at line 53 of file gic_v3.hh.

Member Typedef Documentation

◆ Params

typedef Gicv3Params Gicv3::Params
protected

Definition at line 59 of file gic_v3.hh.

Member Enumeration Documentation

◆ GroupId

Enumerator
G0S 
G1S 
G1NS 

Definition at line 90 of file gic_v3.hh.

◆ IntStatus

Enumerator
INT_INACTIVE 
INT_PENDING 
INT_ACTIVE 
INT_ACTIVE_PENDING 

Definition at line 82 of file gic_v3.hh.

◆ IntTriggerType

Enumerator
INT_LEVEL_SENSITIVE 
INT_EDGE_TRIGGERED 

Definition at line 96 of file gic_v3.hh.

Constructor & Destructor Documentation

◆ Gicv3()

Gicv3::Gicv3 ( const Params p)

Definition at line 54 of file gic_v3.cc.

Member Function Documentation

◆ clearInt()

void 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 BaseGic.

Definition at line 180 of file gic_v3.cc.

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

◆ clearPPInt()

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

Implements BaseGic.

Definition at line 196 of file gic_v3.cc.

References DPRINTF, panic_if, and redistributors.

◆ deassertAll()

void Gicv3::deassertAll ( uint32_t  cpu)

◆ deassertInt()

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

◆ getAddrRanges()

AddrRangeList 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 PioDevice.

Definition at line 107 of file gic_v3.hh.

References addrRanges.

◆ getCPUInterface()

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

Definition at line 137 of file gic_v3.hh.

References cpuInterfaces.

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

◆ getDistributor()

Gicv3Distributor* Gicv3::getDistributor ( ) const
inline

Definition at line 144 of file gic_v3.hh.

References distributor.

Referenced by Gicv3Redistributor::init(), Gicv3CPUInterface::init(), and Gicv3Its::read().

◆ getRedistributor()

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

◆ getRedistributorByAddr()

Gicv3Redistributor * Gicv3::getRedistributorByAddr ( Addr  address) const

◆ getRedistributorByAffinity()

Gicv3Redistributor * Gicv3::getRedistributorByAffinity ( uint32_t  affinity) const

Definition at line 237 of file gic_v3.cc.

References redistributors.

Referenced by Gicv3Distributor::route().

◆ haveAsserted()

bool Gicv3::haveAsserted ( uint32_t  cpu) const

◆ init()

void 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 BaseGic.

Definition at line 60 of file gic_v3.cc.

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

◆ params()

const Params* Gicv3::params ( ) const
inlineprotected

Definition at line 115 of file gic_v3.hh.

References SimObject::_params.

Referenced by init(), read(), Gicv3CPUInterface::setThreadContext(), supportsVersion(), and write().

◆ postInt()

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

◆ read()

Tick Gicv3::read ( PacketPtr  pkt)
overrideprotectedvirtual

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 PioDevice.

Definition at line 99 of file gic_v3.cc.

References addr, AddrRange::contains(), distRange, distributor, DPRINTF, Packet::getAddr(), getRedistributorByAddr(), Packet::getSize(), Packet::isSecure(), Packet::makeAtomicResponse(), panic, panic_if, params(), Gicv3Redistributor::processorNumber(), Gicv3Redistributor::read(), Gicv3Distributor::read(), redistRange, redistSize, Packet::req, Packet::setUintX(), and AddrRange::start().

◆ reset()

void Gicv3::reset ( )
protected

◆ sendInt()

void 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 BaseGic.

Definition at line 173 of file gic_v3.cc.

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

◆ sendPPInt()

void 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 BaseGic.

Definition at line 187 of file gic_v3.cc.

References DPRINTF, panic_if, and redistributors.

◆ serialize()

void Gicv3::serialize ( CheckpointOut cp) const
overrideprotectedvirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 265 of file gic_v3.cc.

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

◆ supportsVersion()

bool Gicv3::supportsVersion ( GicVersion  version)
overrideprotectedvirtual

Check if version supported.

Implements BaseGic.

Definition at line 212 of file gic_v3.cc.

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

◆ unserialize()

void Gicv3::unserialize ( CheckpointIn cp)
overrideprotectedvirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 281 of file gic_v3.cc.

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

◆ write()

Tick Gicv3::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 PioDevice.

Definition at line 136 of file gic_v3.cc.

References addr, AddrRange::contains(), data, distRange, distributor, DPRINTF, Packet::getAddr(), getRedistributorByAddr(), Packet::getSize(), Packet::getUintX(), Packet::isSecure(), Packet::makeAtomicResponse(), panic, panic_if, params(), Gicv3Redistributor::processorNumber(), redistRange, redistSize, Packet::req, AddrRange::start(), Gicv3Redistributor::write(), and Gicv3Distributor::write().

Friends And Related Function Documentation

◆ Gicv3CPUInterface

friend class Gicv3CPUInterface
friend

Definition at line 56 of file gic_v3.hh.

Referenced by init().

◆ Gicv3Redistributor

friend class Gicv3Redistributor
friend

Definition at line 57 of file gic_v3.hh.

Referenced by init().

Member Data Documentation

◆ addrRanges

AddrRangeList Gicv3::addrRanges
protected

Definition at line 66 of file gic_v3.hh.

Referenced by getAddrRanges(), and init().

◆ cpuInterfaces

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

Definition at line 62 of file gic_v3.hh.

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

◆ distRange

AddrRange Gicv3::distRange
protected

Definition at line 64 of file gic_v3.hh.

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

◆ distributor

Gicv3Distributor* Gicv3::distributor
protected

Definition at line 60 of file gic_v3.hh.

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

◆ INTID_NONSECURE

const int Gicv3::INTID_NONSECURE = 1021
static

Definition at line 73 of file gic_v3.hh.

Referenced by Gicv3CPUInterface::getHPPIR0(), and Gicv3CPUInterface::getHPPIR1().

◆ INTID_SECURE

const int Gicv3::INTID_SECURE = 1020
static

◆ INTID_SPURIOUS

const int Gicv3::INTID_SPURIOUS = 1023
static

◆ its

Gicv3Its* Gicv3::its
protected

Definition at line 63 of file gic_v3.hh.

Referenced by init().

◆ PPI_MAX

const int Gicv3::PPI_MAX = 16
static

◆ redistRange

AddrRange Gicv3::redistRange
protected

Definition at line 65 of file gic_v3.hh.

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

◆ redistributors

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

◆ redistSize

uint64_t Gicv3::redistSize
protected

Definition at line 67 of file gic_v3.hh.

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

◆ SGI_MAX

const int Gicv3::SGI_MAX = 16
static

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

Generated on Wed Sep 30 2020 14:02:25 for gem5 by doxygen 1.8.17