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

#include <rtc_pl031.hh>

Inheritance diagram for gem5::PL031:
gem5::AmbaIntDevice gem5::AmbaPioDevice gem5::BasicPioDevice gem5::AmbaDevice gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Types

using Params = PL031Params
 
- Public Types inherited from gem5::AmbaIntDevice
typedef AmbaIntDeviceParams Params
 
- Public Types inherited from gem5::AmbaPioDevice
typedef AmbaPioDeviceParams 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

 PL031 (const Params &p)
 The constructor for RealView just registers itself with the MMU. More...
 
Tick read (PacketPtr pkt) override
 Handle a read to the device. More...
 
Tick write (PacketPtr pkt) override
 Handle writes to the device. 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::AmbaIntDevice
 AmbaIntDevice (const Params &p, Addr pio_size)
 
- Public Member Functions inherited from gem5::AmbaPioDevice
 AmbaPioDevice (const Params &p, Addr pio_size)
 
- 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
 

Protected Types

enum  {
  DataReg = 0x00, MatchReg = 0x04, LoadReg = 0x08, ControlReg = 0x0C,
  IntMask = 0x10, RawISR = 0x14, MaskedISR = 0x18, IntClear = 0x1C
}
 

Protected Member Functions

void counterMatch ()
 Called when the counter reaches matches. More...
 
void resyncMatch ()
 Called to update the matchEvent when the load Value or match value are written. 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 Member Functions inherited from gem5::AmbaDevice
bool readId (PacketPtr pkt, uint64_t amba_id, Addr pio_addr)
 

Protected Attributes

uint32_t timeVal
 
Tick lastWrittenTick
 
uint32_t loadVal
 
uint32_t matchVal
 
bool rawInt
 If timer has caused an interrupt. More...
 
bool maskInt
 If the timer interrupt mask that is anded with the raw interrupt to generate a pending interrupt. More...
 
bool pendingInt
 If an interrupt is currently pending. More...
 
EventFunctionWrapper matchEvent
 
- Protected Attributes inherited from gem5::AmbaIntDevice
ArmInterruptPin *const interrupt
 
Tick intDelay
 
- Protected Attributes inherited from gem5::AmbaPioDevice
uint64_t ambaId
 
- 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...
 

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
 
- Static Protected Attributes inherited from gem5::AmbaDevice
static const int AMBA_PER_ID0 = 0xFE0
 
static const int AMBA_PER_ID1 = 0xFE4
 
static const int AMBA_PER_ID2 = 0xFE8
 
static const int AMBA_PER_ID3 = 0xFEC
 
static const int AMBA_CEL_ID0 = 0xFF0
 
static const int AMBA_CEL_ID1 = 0xFF4
 
static const int AMBA_CEL_ID2 = 0xFF8
 
static const int AMBA_CEL_ID3 = 0xFFC
 

Detailed Description

Definition at line 51 of file rtc_pl031.hh.

Member Typedef Documentation

◆ Params

using gem5::PL031::Params = PL031Params

Definition at line 104 of file rtc_pl031.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
DataReg 
MatchReg 
LoadReg 
ControlReg 
IntMask 
RawISR 
MaskedISR 
IntClear 

Definition at line 54 of file rtc_pl031.hh.

Constructor & Destructor Documentation

◆ PL031()

gem5::PL031::PL031 ( const Params p)

The constructor for RealView just registers itself with the MMU.

Parameters
pparams structure

Definition at line 52 of file rtc_pl031.cc.

References counterMatch().

Member Function Documentation

◆ counterMatch()

void gem5::PL031::counterMatch ( )
protected

Called when the counter reaches matches.

Definition at line 172 of file rtc_pl031.cc.

References DPRINTF, gem5::AmbaIntDevice::interrupt, maskInt, pendingInt, gem5::ArmInterruptPin::raise(), and rawInt.

Referenced by PL031().

◆ read()

Tick gem5::PL031::read ( PacketPtr  pkt)
overridevirtual

◆ resyncMatch()

void gem5::PL031::resyncMatch ( )
protected

Called to update the matchEvent when the load Value or match value are written.

Definition at line 155 of file rtc_pl031.cc.

References gem5::curTick(), gem5::EventManager::deschedule(), DPRINTF, matchEvent, matchVal, gem5::sim_clock::as_int::s, gem5::EventManager::schedule(), gem5::Event::scheduled(), and timeVal.

Referenced by write().

◆ serialize()

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

Serialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 186 of file rtc_pl031.cc.

References DPRINTF, lastWrittenTick, loadVal, maskInt, matchEvent, matchVal, pendingInt, rawInt, gem5::Event::scheduled(), SERIALIZE_SCALAR, timeVal, and gem5::Event::when().

◆ unserialize()

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

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 208 of file rtc_pl031.cc.

References DPRINTF, lastWrittenTick, loadVal, maskInt, matchEvent, matchVal, pendingInt, rawInt, gem5::EventManager::schedule(), timeVal, and UNSERIALIZE_SCALAR.

◆ write()

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

Member Data Documentation

◆ lastWrittenTick

Tick gem5::PL031::lastWrittenTick
protected

Definition at line 71 of file rtc_pl031.hh.

Referenced by read(), serialize(), unserialize(), and write().

◆ loadVal

uint32_t gem5::PL031::loadVal
protected

Definition at line 74 of file rtc_pl031.hh.

Referenced by read(), serialize(), unserialize(), and write().

◆ maskInt

bool gem5::PL031::maskInt
protected

If the timer interrupt mask that is anded with the raw interrupt to generate a pending interrupt.

Definition at line 88 of file rtc_pl031.hh.

Referenced by counterMatch(), read(), serialize(), unserialize(), and write().

◆ matchEvent

EventFunctionWrapper gem5::PL031::matchEvent
protected

Definition at line 96 of file rtc_pl031.hh.

Referenced by resyncMatch(), serialize(), and unserialize().

◆ matchVal

uint32_t gem5::PL031::matchVal
protected

Definition at line 79 of file rtc_pl031.hh.

Referenced by read(), resyncMatch(), serialize(), unserialize(), and write().

◆ pendingInt

bool gem5::PL031::pendingInt
protected

If an interrupt is currently pending.

Logical and of CTRL.intEnable and rawInt

Definition at line 92 of file rtc_pl031.hh.

Referenced by counterMatch(), read(), serialize(), unserialize(), and write().

◆ rawInt

bool gem5::PL031::rawInt
protected

If timer has caused an interrupt.

This is irrespective of interrupt enable

Definition at line 83 of file rtc_pl031.hh.

Referenced by counterMatch(), read(), serialize(), unserialize(), and write().

◆ timeVal

uint32_t gem5::PL031::timeVal
protected

Definition at line 68 of file rtc_pl031.hh.

Referenced by read(), resyncMatch(), serialize(), unserialize(), and write().


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