#include <watchdog_generic.hh>

Inheritance diagram for gem5::GenericWatchdog:

Classes
class	Listener
	System Counter Listener: This object is being notified any time there is a change in the SystemCounter. More...

Public Member Functions
	GenericWatchdog (const GenericWatchdogParams &params)

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

bool	enabled () 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.

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.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

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
AddrRangeList	getAddrRanges () const override
	Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to.

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.

uint32_t	readRefresh (Addr addr)

uint32_t	readControl (Addr addr)

void	writeRefresh (Addr addr, uint32_t data)

void	writeControl (Addr addr, uint32_t data)

void	explicitRefresh ()

void	refresh ()

void	timeout ()

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 Attributes
EventFunctionWrapper	timeoutEvent

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.

Private Types
enum class	RefreshOffset : Addr { WRR = 0x000 , W_IIDR = 0xfcc }

enum class	ControlOffset : Addr { WCS = 0x000 , WOR = 0x008 , WCV_LO = 0x010 , WCV_HI = 0x014 , W_IIDR = 0xfcc }

Private Member Functions
	BitUnion32 (WCTRLS) Bitfield< 2 > ws1

	EndBitUnion (WCTRLS) WCTRLS controlStatus
	Control and Status Register.

Private Attributes
Bitfield< 1 >	ws0

Bitfield< 0 >	enabled

uint32_t	offset
	Offset Register.

uint64_t	compare
	Compare Register.

const uint32_t	iidr
	Interface Identification Register.

const AddrRange	refreshFrame

const AddrRange	controlFrame

const Tick	pioLatency

SystemCounter &	cnt

Listener	cntListener

ArmInterruptPin *const	ws0
	Watchdog Signals (IRQs)

ArmInterruptPin *const	ws1

Additional Inherited Members
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

Detailed Description

Definition at line 57 of file watchdog_generic.hh.

Member Enumeration Documentation

◆ ControlOffset

enum class gem5::GenericWatchdog::ControlOffset : Addr

strongprivate

Enumerator
WCS
WOR
WCV_LO
WCV_HI
W_IIDR

Definition at line 119 of file watchdog_generic.hh.

◆ RefreshOffset

enum class gem5::GenericWatchdog::RefreshOffset : Addr

strongprivate

Enumerator
WRR
W_IIDR

Definition at line 113 of file watchdog_generic.hh.

Constructor & Destructor Documentation

◆ GenericWatchdog()

gem5::GenericWatchdog::GenericWatchdog ( const GenericWatchdogParams & params )

Definition at line 46 of file watchdog_generic.cc.

References timeout().

Member Function Documentation

◆ BitUnion32()

gem5::GenericWatchdog::BitUnion32 ( WCTRLS )

private

◆ enabled()

bool gem5::GenericWatchdog::enabled ( ) const

inline

Definition at line 65 of file watchdog_generic.hh.

◆ EndBitUnion()

gem5::GenericWatchdog::EndBitUnion ( WCTRLS )

private

Control and Status Register.

◆ explicitRefresh()

void gem5::GenericWatchdog::explicitRefresh ( )

protected

Definition at line 197 of file watchdog_generic.cc.

References gem5::ArmInterruptPin::clear(), refresh(), ws0, and ws1.

Referenced by writeControl(), and writeRefresh().

◆ getAddrRanges()

AddrRangeList gem5::GenericWatchdog::getAddrRanges ( ) const

overrideprotectedvirtual

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 65 of file watchdog_generic.cc.

References controlFrame, and refreshFrame.

◆ read()

Tick gem5::GenericWatchdog::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 74 of file watchdog_generic.cc.

References gem5::X86ISA::addr, gem5::AddrRange::contains(), controlFrame, gem5::Packet::getAddr(), gem5::Packet::getSize(), gem5::Packet::makeResponse(), panic, panic_if, pioLatency, readControl(), readRefresh(), refreshFrame, and gem5::Packet::setUintX().

◆ readControl()

uint32_t gem5::GenericWatchdog::readControl ( Addr addr )

protected

Definition at line 113 of file watchdog_generic.cc.

References gem5::X86ISA::addr, gem5::bits(), compare, controlFrame, iidr, offset, panic, gem5::AddrRange::start(), W_IIDR, WCS, WCV_HI, WCV_LO, and WOR.

Referenced by read().

◆ readRefresh()

uint32_t gem5::GenericWatchdog::readRefresh ( Addr addr )

protected

Definition at line 96 of file watchdog_generic.cc.

References gem5::X86ISA::addr, iidr, panic, refreshFrame, gem5::AddrRange::start(), W_IIDR, and WRR.

Referenced by read().

◆ refresh()

void gem5::GenericWatchdog::refresh ( )

protected

Definition at line 209 of file watchdog_generic.cc.

References cnt, compare, offset, gem5::EventManager::reschedule(), timeoutEvent, gem5::SystemCounter::value(), and gem5::SystemCounter::whenValue().

Referenced by explicitRefresh(), and timeout().

◆ serialize()

void gem5::GenericWatchdog::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 239 of file watchdog_generic.cc.

References compare, offset, gem5::Event::scheduled(), SERIALIZE_SCALAR, timeoutEvent, and gem5::Event::when().

◆ timeout()

void gem5::GenericWatchdog::timeout ( )

protected

Definition at line 222 of file watchdog_generic.cc.

References gem5::ArmInterruptPin::raise(), refresh(), ws0, and ws1.

Referenced by GenericWatchdog().

◆ unserialize()

void gem5::GenericWatchdog::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 252 of file watchdog_generic.cc.

References compare, offset, gem5::EventManager::reschedule(), timeoutEvent, and UNSERIALIZE_SCALAR.

◆ write()

Tick gem5::GenericWatchdog::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 135 of file watchdog_generic.cc.

References gem5::X86ISA::addr, gem5::AddrRange::contains(), controlFrame, data, gem5::Packet::getAddr(), gem5::Packet::getSize(), gem5::Packet::getUintX(), gem5::Packet::makeResponse(), panic, panic_if, pioLatency, refreshFrame, writeControl(), and writeRefresh().

◆ writeControl()

void gem5::GenericWatchdog::writeControl	(	Addr	addr,
		uint32_t	data )

protected

Definition at line 171 of file watchdog_generic.cc.

References gem5::X86ISA::addr, compare, controlFrame, data, explicitRefresh(), gem5::insertBits(), offset, panic, gem5::AddrRange::start(), WCS, WCV_HI, WCV_LO, and WOR.

Referenced by write().

◆ writeRefresh()

void gem5::GenericWatchdog::writeRefresh	(	Addr	addr,
		uint32_t	data )

protected

Definition at line 156 of file watchdog_generic.cc.

References gem5::X86ISA::addr, explicitRefresh(), panic, refreshFrame, gem5::AddrRange::start(), and WRR.

Referenced by write().

Member Data Documentation

◆ cnt

SystemCounter& gem5::GenericWatchdog::cnt

private

Definition at line 151 of file watchdog_generic.hh.

Referenced by refresh().

◆ cntListener

Listener gem5::GenericWatchdog::cntListener

private

Definition at line 152 of file watchdog_generic.hh.

◆ compare

uint64_t gem5::GenericWatchdog::compare

private

Compare Register.

Definition at line 141 of file watchdog_generic.hh.

Referenced by readControl(), refresh(), serialize(), unserialize(), and writeControl().

◆ controlFrame

const AddrRange gem5::GenericWatchdog::controlFrame

private

Definition at line 147 of file watchdog_generic.hh.

Referenced by getAddrRanges(), read(), readControl(), write(), and writeControl().

◆ enabled

Bitfield<0> gem5::GenericWatchdog::enabled

private

Definition at line 131 of file watchdog_generic.hh.

Referenced by gem5::GenericWatchdog::Listener::notify().

◆ iidr

const uint32_t gem5::GenericWatchdog::iidr

private

Interface Identification Register.

Definition at line 144 of file watchdog_generic.hh.

Referenced by readControl(), and readRefresh().

◆ offset

uint32_t gem5::GenericWatchdog::offset

private

Offset Register.

Definition at line 138 of file watchdog_generic.hh.

Referenced by readControl(), refresh(), serialize(), unserialize(), and writeControl().

◆ pioLatency

const Tick gem5::GenericWatchdog::pioLatency

private

Definition at line 149 of file watchdog_generic.hh.

Referenced by read(), and write().

◆ refreshFrame

const AddrRange gem5::GenericWatchdog::refreshFrame

private

Definition at line 146 of file watchdog_generic.hh.

Referenced by getAddrRanges(), read(), readRefresh(), write(), and writeRefresh().

◆ timeoutEvent

EventFunctionWrapper gem5::GenericWatchdog::timeoutEvent

protected

Definition at line 110 of file watchdog_generic.hh.

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

◆ ws0 [1/2]

Bitfield<1> gem5::GenericWatchdog::ws0

private

Definition at line 130 of file watchdog_generic.hh.

Referenced by explicitRefresh(), and timeout().

◆ ws0 [2/2]

ArmInterruptPin* const gem5::GenericWatchdog::ws0

private

Watchdog Signals (IRQs)

Definition at line 155 of file watchdog_generic.hh.

◆ ws1

ArmInterruptPin* const gem5::GenericWatchdog::ws1

private

Definition at line 156 of file watchdog_generic.hh.

Referenced by explicitRefresh(), and timeout().

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

dev/arm/watchdog_generic.hh
dev/arm/watchdog_generic.cc

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ControlOffset

◆ RefreshOffset

Constructor & Destructor Documentation

◆ GenericWatchdog()

Member Function Documentation

◆ BitUnion32()

◆ enabled()

◆ EndBitUnion()

◆ explicitRefresh()

◆ getAddrRanges()

◆ read()

◆ readControl()

◆ readRefresh()

◆ refresh()

◆ serialize()

◆ timeout()

◆ unserialize()

◆ write()

◆ writeControl()

◆ writeRefresh()

Member Data Documentation

◆ cnt

◆ cntListener

◆ compare

◆ controlFrame

◆ enabled

◆ iidr

◆ offset

◆ pioLatency

◆ refreshFrame

◆ timeoutEvent

◆ ws0 [1/2]

◆ ws0 [2/2]

◆ ws1