Per-CPU architected timer. More...

#include <generic_timer.hh>

Inheritance diagram for gem5::ArchTimer:

Public Member Functions
	ArchTimer (const std::string &name, SimObject &parent, SystemCounter &sysctr, ArmInterruptPin *interrupt)

std::string	name () const
	Returns the timer name.

uint64_t	compareValue () const
	Returns the CompareValue view of the timer.

void	setCompareValue (uint64_t val)
	Sets the CompareValue view of the timer.

uint32_t	timerValue () const
	Returns the TimerValue view of the timer.

void	setTimerValue (uint32_t val)
	Sets the TimerValue view of the timer.

uint32_t	control () const
	Sets the control register.

void	setControl (uint32_t val)

uint64_t	offset () const

void	setOffset (uint64_t val)

uint64_t	value () const
	Returns the value of the counter which this timer relies on.

Tick	whenValue (uint64_t target_val)

void	notify (void) override
	Called from the SystemCounter when a change in counting speed occurred Events should be rescheduled properly inside this member function.

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

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

DrainState	drain () override
	Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

void	drainResume () override
	Resume execution after a successful drain.

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

Protected Member Functions
	BitUnion32 (ArchTimerCtrl) Bitfield< 0 > enable
	Control register.

void	updateCounter ()
	Timer settings or the offset has changed, re-evaluate trigger condition and raise interrupt if necessary.

void	counterLimitReached ()
	Called when the upcounter reaches the programmed value.

virtual bool	scheduleEvents ()

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

void	signalDrainDone () const
	Signal that an object is drained.

Protected Attributes
Bitfield< 1 >	imask

Bitfield< 2 >	istatus

EndBitUnion(ArchTimerCtrl) const std SimObject &	_parent
	Name of this timer.

SystemCounter &	_systemCounter

ArmInterruptPin *const	_interrupt

ArchTimerCtrl	_control
	Value of the control register ({CNTP/CNTHP/CNTV}_CTL).

uint64_t	_counterLimit
	Programmed limit value for the upcounter ({CNTP/CNTHP/CNTV}_CVAL).

uint64_t	_offset
	Offset relative to the physical timer (CNTVOFF)

EventFunctionWrapper	_counterLimitReachedEvent

Private Member Functions
	ArchTimer (const ArchTimer &t)

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

Detailed Description

Per-CPU architected timer.

Definition at line 179 of file generic_timer.hh.

Constructor & Destructor Documentation

◆ ArchTimer() [1/2]

gem5::ArchTimer::ArchTimer	(	const std::string &	name,
		SimObject &	parent,
		SystemCounter &	sysctr,
		ArmInterruptPin *	interrupt )

Definition at line 260 of file generic_timer.cc.

References counterLimitReached().

◆ ArchTimer() [2/2]

gem5::ArchTimer::ArchTimer ( const ArchTimer & t )

private

Member Function Documentation

◆ BitUnion32()

gem5::ArchTimer::BitUnion32 ( ArchTimerCtrl )

protected

Control register.

◆ compareValue()

uint64_t gem5::ArchTimer::compareValue ( ) const

inline

Returns the CompareValue view of the timer.

Definition at line 229 of file generic_timer.hh.

References _counterLimit.

Referenced by gem5::GenericTimer::readMiscReg(), gem5::GenericTimerFrame::timerRead(), and gem5::GenericTimerFrame::timerWrite().

◆ control()

uint32_t gem5::ArchTimer::control ( ) const

inline

Sets the control register.

Definition at line 239 of file generic_timer.hh.

References _control.

Referenced by gem5::GenericTimer::readMiscReg(), and gem5::GenericTimerFrame::timerRead().

◆ counterLimitReached()

void gem5::ArchTimer::counterLimitReached ( )

protected

Called when the upcounter reaches the programmed value.

Definition at line 273 of file generic_timer.cc.

References _control, _interrupt, DPRINTF, gem5::ArmInterruptPin::raise(), and scheduleEvents().

Referenced by ArchTimer(), and updateCounter().

◆ drain()

DrainState gem5::ArchTimer::drain ( )

overridevirtual

Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

Draining is mostly used before forking and creating a check point.

This function notifies an object that it needs to drain its state.

If the object does not need further simulation to drain internal buffers, it returns DrainState::Drained and automatically switches to the Drained state. If the object needs more simulation, it returns DrainState::Draining and automatically enters the Draining state. Other return values are invalid.

Note: An object that has entered the Drained state can be disturbed by other objects in the system and consequently stop being drained. These perturbations are not visible in the drain state. The simulator therefore repeats the draining process until all objects return DrainState::Drained on the first call to drain().