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

#include <watchdog_sp805.hh>

Inheritance diagram for gem5::Sp805:
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 Member Functions

 Sp805 (const Sp805Params &params)
 
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 Member Functions

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

Private Types

enum  Offset : Addr {
  WDOGLOAD = 0x000, WDOGVALUE = 0x004, WDOGCONTROL = 0x008, WDOGINTCLR = 0x00c,
  WDOGRIS = 0x010, WDOGMIS = 0x014, WDOGLOCK = 0xc00, WDOGITCR = 0xf00,
  WDOGITOP = 0xf04
}
 

Private Member Functions

uint32_t value (void) const
 Returns the current counter value. More...
 
void timeoutExpired (void)
 Triggered when value reaches 0. More...
 
void restartCounter (void)
 Restarts the counter to the current timeout interval. More...
 
void stopCounter (void)
 Stops the counter when watchdog becomes disabled. More...
 
void sendInt (void)
 Raises an interrupt. More...
 
void clearInt (void)
 Clears any active interrupts. More...
 

Private Attributes

uint32_t timeoutInterval
 Timeout interval (in cycles) as specified in WdogLoad. More...
 
Tick timeoutStartTick
 Timeout start tick to keep track of the counter value. More...
 
uint32_t persistedValue
 Value as persisted when the watchdog is stopped. More...
 
bool enabled
 Indicates if watchdog (counter and interrupt) is enabled. More...
 
bool resetEnabled
 Indicates if reset behaviour is enabled when counter reaches 0. More...
 
bool writeAccessEnabled
 Indicates if write access to registers is enabled. More...
 
bool integrationTestEnabled
 Indicates if integration test harness is enabled. More...
 
EventFunctionWrapper timeoutEvent
 Timeout event, triggered when the counter value reaches 0. More...
 

Static Private Attributes

static constexpr uint32_t WDOGLOCK_MAGIC = 0x1acce551
 If written into WdogLock, registers are unlocked for writes. More...
 

Additional Inherited Members

- 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
 
- 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 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...
 
- 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 55 of file watchdog_sp805.hh.

Member Enumeration Documentation

◆ Offset

enum gem5::Sp805::Offset : Addr
private
Enumerator
WDOGLOAD 
WDOGVALUE 
WDOGCONTROL 
WDOGINTCLR 
WDOGRIS 
WDOGMIS 
WDOGLOCK 
WDOGITCR 
WDOGITOP 

Definition at line 68 of file watchdog_sp805.hh.

Constructor & Destructor Documentation

◆ Sp805()

gem5::Sp805::Sp805 ( const Sp805Params &  params)

Definition at line 48 of file watchdog_sp805.cc.

References timeoutExpired().

Member Function Documentation

◆ clearInt()

void gem5::Sp805::clearInt ( void  )
private

Clears any active interrupts.

Definition at line 224 of file watchdog_sp805.cc.

References gem5::ArmInterruptPin::clear(), and gem5::AmbaIntDevice::interrupt.

Referenced by write().

◆ read()

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

◆ restartCounter()

void gem5::Sp805::restartCounter ( void  )
private

Restarts the counter to the current timeout interval.

Definition at line 196 of file watchdog_sp805.cc.

References gem5::Clocked::clockEdge(), gem5::curTick(), gem5::EventManager::reschedule(), timeoutEvent, timeoutInterval, and timeoutStartTick.

Referenced by timeoutExpired(), and write().

◆ sendInt()

void gem5::Sp805::sendInt ( void  )
private

Raises an interrupt.

If there is already a pending interrupt and reset behaviour is enabled, asserts system reset

Definition at line 211 of file watchdog_sp805.cc.

References gem5::ArmInterruptPin::active(), enabled, gem5::AmbaIntDevice::interrupt, gem5::ArmInterruptPin::raise(), resetEnabled, and warn.

Referenced by timeoutExpired(), and write().

◆ serialize()

void gem5::Sp805::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 230 of file watchdog_sp805.cc.

References enabled, integrationTestEnabled, persistedValue, resetEnabled, gem5::Event::scheduled(), SERIALIZE_SCALAR, timeoutEvent, timeoutInterval, timeoutStartTick, gem5::Event::when(), and writeAccessEnabled.

◆ stopCounter()

void gem5::Sp805::stopCounter ( void  )
private

Stops the counter when watchdog becomes disabled.

Definition at line 203 of file watchdog_sp805.cc.

References gem5::EventManager::deschedule(), gem5::MaxTick, persistedValue, timeoutEvent, timeoutStartTick, and value().

Referenced by write().

◆ timeoutExpired()

void gem5::Sp805::timeoutExpired ( void  )
private

Triggered when value reaches 0.

Definition at line 188 of file watchdog_sp805.cc.

References gem5::MaxTick, restartCounter(), sendInt(), and timeoutStartTick.

Referenced by Sp805().

◆ unserialize()

void gem5::Sp805::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 247 of file watchdog_sp805.cc.

References enabled, integrationTestEnabled, persistedValue, gem5::EventManager::reschedule(), resetEnabled, timeoutEvent, timeoutInterval, timeoutStartTick, UNSERIALIZE_SCALAR, and writeAccessEnabled.

◆ value()

uint32_t gem5::Sp805::value ( void  ) const
private

Returns the current counter value.

Definition at line 180 of file watchdog_sp805.cc.

References gem5::Clocked::clockPeriod(), persistedValue, gem5::Event::scheduled(), timeoutEvent, timeoutInterval, timeoutStartTick, and gem5::Event::when().

Referenced by read(), and stopCounter().

◆ write()

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

Member Data Documentation

◆ enabled

bool gem5::Sp805::enabled
private

Indicates if watchdog (counter and interrupt) is enabled.

Definition at line 95 of file watchdog_sp805.hh.

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

◆ integrationTestEnabled

bool gem5::Sp805::integrationTestEnabled
private

Indicates if integration test harness is enabled.

Definition at line 104 of file watchdog_sp805.hh.

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

◆ persistedValue

uint32_t gem5::Sp805::persistedValue
private

Value as persisted when the watchdog is stopped.

Definition at line 92 of file watchdog_sp805.hh.

Referenced by serialize(), stopCounter(), unserialize(), and value().

◆ resetEnabled

bool gem5::Sp805::resetEnabled
private

Indicates if reset behaviour is enabled when counter reaches 0.

Definition at line 98 of file watchdog_sp805.hh.

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

◆ timeoutEvent

EventFunctionWrapper gem5::Sp805::timeoutEvent
private

Timeout event, triggered when the counter value reaches 0.

Definition at line 107 of file watchdog_sp805.hh.

Referenced by restartCounter(), serialize(), stopCounter(), unserialize(), value(), and write().

◆ timeoutInterval

uint32_t gem5::Sp805::timeoutInterval
private

Timeout interval (in cycles) as specified in WdogLoad.

Definition at line 86 of file watchdog_sp805.hh.

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

◆ timeoutStartTick

Tick gem5::Sp805::timeoutStartTick
private

Timeout start tick to keep track of the counter value.

Definition at line 89 of file watchdog_sp805.hh.

Referenced by restartCounter(), serialize(), stopCounter(), timeoutExpired(), unserialize(), and value().

◆ WDOGLOCK_MAGIC

constexpr uint32_t gem5::Sp805::WDOGLOCK_MAGIC = 0x1acce551
staticconstexprprivate

If written into WdogLock, registers are unlocked for writes.

Definition at line 131 of file watchdog_sp805.hh.

Referenced by write().

◆ writeAccessEnabled

bool gem5::Sp805::writeAccessEnabled
private

Indicates if write access to registers is enabled.

Definition at line 101 of file watchdog_sp805.hh.

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


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

Generated on Tue Sep 21 2021 12:28:13 for gem5 by doxygen 1.8.17