gem5::Sp805 Class Reference

#include <watchdog_sp805.hh>

Inheritance diagram for gem5::Sp805:

Public Member Functions
	Sp805 (const Sp805Params &params)
void	serialize (CheckpointOut &cp) const override
	Serialize an object.
void	unserialize (CheckpointIn &cp) override
	Unserialize an object.
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.
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.
Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index.
Public Member Functions inherited from gem5::ClockedObject
	ClockedObject (const ClockedObjectParams &p)
Public Member Functions inherited from gem5::SimObject
const Params &	params () const
	SimObject (const Params &p)
virtual	~SimObject ()
virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.
virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.
virtual void	regProbePoints ()
	Register probe points for this object.
virtual void	regProbeListeners ()
	Register probe listeners for this object.
ProbeManager *	getProbeManager ()
	Get the probe manager for this object.
virtual void	startup ()
	startup() is the final initialization call before simulation.
DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.
virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.
virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.
Public Member Functions inherited from gem5::EventManager
EventQueue *	eventQueue () 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.
void	setCurTick (Tick newVal)
	EventManager (EventManager &em)
	Event manger manages events in the event queue.
	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.
void	serializeSection (CheckpointOut &cp, const std::string &name) const
void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.
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.
virtual void	notifyFork ()
	Notify a child process of a fork.
Public Member Functions inherited from gem5::statistics::Group
	Group (Group *parent, const char *name=nullptr)
	Construct a new statistics group.
virtual	~Group ()
virtual void	regStats ()
	Callback to set stat parameters.
virtual void	resetStats ()
	Callback to reset stats.
virtual void	preDumpStats ()
	Callback before stats are dumped.
void	addStat (statistics::Info *info)
	Register a stat with this group.
const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.
const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.
void	addStatGroup (const char *name, Group *block)
	Add a stat block as a child of this block.
const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.
void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.
	Group ()=delete
	Group (const Group &)=delete
Group &	operator= (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.
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.
Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge.
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.
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.
Tick	write (PacketPtr pkt) override
	Pure virtual function that the device must implement.
Protected Member Functions inherited from gem5::Drainable
	Drainable ()
virtual	~Drainable ()
virtual void	drainResume ()
	Resume execution after a successful drain.
void	signalDrainDone () const
	Signal that an object is drained.
Protected Member Functions inherited from gem5::Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters.
	Clocked (Clocked &)=delete
Clocked &	operator= (Clocked &)=delete
virtual	~Clocked ()
	Virtual destructor due to inheritance.
void	resetClock () const
	Reset the object's clock using the current global tick value.
virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.
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.
void	timeoutExpired (void)
	Triggered when value reaches 0.
void	restartCounter (void)
	Restarts the counter to the current timeout interval.
void	stopCounter (void)
	Stops the counter when watchdog becomes disabled.
void	sendInt (void)
	Raises an interrupt.
void	clearInt (void)
	Clears any active interrupts.

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

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

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.
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.
static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.
static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.
static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.
Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.
static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.
Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState
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.
Addr	pioSize
	Size that the device's address range.
Tick	pioDelay
	Delay that the device experinces on an access.
Protected Attributes inherited from gem5::PioDevice
System *	sys
PioPort< PioDevice >	pioPort
	The pioPort that handles the requests for us and provides us requests that it sees.
Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.
Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.
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

Pure virtual function that the device must implement.

Called when a read command is recieved by the port.

Parameters

pkt	Packet describing this request

Returns

number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 62 of file watchdog_sp805.cc.

References gem5::ArmInterruptPin::active(), gem5::X86ISA::addr, gem5::AmbaPioDevice::ambaId, DPRINTF, enabled, gem5::Packet::getAddr(), gem5::Packet::getSize(), gem5::Packet::getUintX(), integrationTestEnabled, gem5::AmbaIntDevice::interrupt, gem5::Packet::makeResponse(), panic_if, gem5::BasicPioDevice::pioAddr, gem5::BasicPioDevice::pioDelay, gem5::AmbaDevice::readId(), resetEnabled, gem5::Packet::setUintX(), timeoutInterval, value(), warn, WDOGCONTROL, WDOGINTCLR, WDOGITCR, WDOGITOP, WDOGLOAD, WDOGLOCK, WDOGMIS, WDOGRIS, WDOGVALUE, and writeAccessEnabled.

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

cp	Checkpoint state

Reimplemented from gem5::ClockedObject.

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

cp	Checkpoint state

Reimplemented from gem5::ClockedObject.

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

Pure virtual function that the device must implement.

Called when a write command is recieved by the port.

Parameters

pkt	Packet describing this request

Returns

number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 113 of file watchdog_sp805.cc.

References gem5::X86ISA::addr, gem5::bits(), clearInt(), data, DPRINTF, enabled, gem5::Packet::getAddr(), gem5::Packet::getSize(), gem5::Packet::getUintX(), gem5::Packet::makeResponse(), panic_if, gem5::BasicPioDevice::pioAddr, gem5::BasicPioDevice::pioDelay, resetEnabled, restartCounter(), gem5::Event::scheduled(), sendInt(), stopCounter(), timeoutEvent, timeoutInterval, warn, WDOGCONTROL, WDOGINTCLR, WDOGITCR, WDOGITOP, WDOGLOAD, WDOGLOCK, WDOGLOCK_MAGIC, WDOGMIS, WDOGRIS, WDOGVALUE, and writeAccessEnabled.

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

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:

• dev/arm/watchdog_sp805.hh
• dev/arm/watchdog_sp805.cc