#include <rtc_pl031.hh>

Inheritance diagram for PL031:

Public Types
typedef PL031Params	Params

Public Types inherited from AmbaIntDevice
typedef AmbaIntDeviceParams	Params

Public Types inherited from AmbaPioDevice
typedef AmbaPioDeviceParams	Params

Public Types inherited from BasicPioDevice
typedef BasicPioDeviceParams	Params

Public Types inherited from PioDevice
typedef PioDeviceParams	Params

Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Public Member Functions
const Params *	params () const

	PL031 (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 AmbaIntDevice
	AmbaIntDevice (const Params *p, Addr pio_size)

Public Member Functions inherited from AmbaPioDevice
	AmbaPioDevice (const Params *p, Addr pio_size)

Public Member Functions inherited from BasicPioDevice
	BasicPioDevice (const Params *p, Addr size)

const Params *	params () const

AddrRangeList	getAddrRanges () const override
	Determine the address ranges that this device responds to. More...

Public Member Functions inherited from PioDevice
	PioDevice (const Params *p)

virtual	~PioDevice ()

const Params *	params () const

void	init () override
	init() is called after all C++ SimObjects have been created and all ports are connected. More...

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index. More...

Public Member Functions inherited from ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () const

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

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

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

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

ProbeManager *	getProbeManager ()
	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 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. 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 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 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 Stats::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 (Stats::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 Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from 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 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 Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters. More...

	Clocked (Clocked &)=delete

Clocked &	operator= (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 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 AmbaIntDevice
ArmInterruptPin *const	interrupt

Tick	intDelay

Protected Attributes inherited from AmbaPioDevice
uint64_t	ambaId

Protected Attributes inherited from 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 PioDevice
System *	sys

PioPort< PioDevice >	pioPort
	The pioPort that handles the requests for us and provides us requests that it sees. More...

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

Protected Attributes inherited from EventManager
EventQueue *	eventq
	A pointer to this object's event queue. More...

Additional Inherited Members
Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it. More...

Static Public Member Functions inherited from Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section. More...

static void	serializeAll (const std::string &cpt_dir)
	Serializes all the SimObjects. More...

static void	unserializeGlobals (CheckpointIn &cp)

Public Attributes inherited from ClockedObject
PowerState *	powerState

Static Protected Attributes inherited from 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 48 of file rtc_pl031.hh.

Member Typedef Documentation

◆ Params

typedef PL031Params PL031::Params

Definition at line 100 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 51 of file rtc_pl031.hh.

Constructor & Destructor Documentation

◆ PL031()

PL031::PL031 ( Params * p )

The constructor for RealView just registers itself with the MMU.

Parameters

p	params structure

Definition at line 49 of file rtc_pl031.cc.

References counterMatch().

Member Function Documentation

◆ counterMatch()

void PL031::counterMatch ( )

protected

Called when the counter reaches matches.

Definition at line 181 of file rtc_pl031.cc.

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

Referenced by PL031().

◆ params()

const Params* PL031::params ( ) const

inline

Definition at line 102 of file rtc_pl031.hh.

References SimObject::_params.

◆ read()

Tick PL031::read ( PacketPtr pkt )

overridevirtual

Handle a read to the device.

Parameters

pkt	The memory request.
data	Where to put the data.

Implements PioDevice.

Definition at line 59 of file rtc_pl031.cc.

References AmbaPioDevice::ambaId, ControlReg, curTick(), data, DataReg, DPRINTF, Packet::getAddr(), Packet::getSize(), Packet::getUintX(), IntMask, lastWrittenTick, LoadReg, loadVal, Packet::makeAtomicResponse(), MaskedISR, maskInt, MatchReg, matchVal, panic, pendingInt, BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, BasicPioDevice::pioSize, rawInt, RawISR, AmbaDevice::readId(), SimClock::Int::s, Packet::setLE(), and timeVal.

◆ resyncMatch()

void PL031::resyncMatch ( )

protected

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

Definition at line 164 of file rtc_pl031.cc.

References curTick(), EventManager::deschedule(), DPRINTF, matchEvent, matchVal, SimClock::Int::s, EventManager::schedule(), Event::scheduled(), and timeVal.

Referenced by write().

◆ serialize()

void PL031::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 195 of file rtc_pl031.cc.

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

◆ unserialize()

void PL031::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 217 of file rtc_pl031.cc.

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

◆ write()

Tick PL031::write ( PacketPtr pkt )

overridevirtual

Handle writes to the device.

Parameters

pkt	The memory request.
data	the data

Implements PioDevice.

Definition at line 121 of file rtc_pl031.cc.

References AmbaPioDevice::ambaId, ControlReg, curTick(), DataReg, DPRINTF, Packet::getAddr(), Packet::getLE(), Packet::getSize(), IntClear, IntMask, lastWrittenTick, LoadReg, loadVal, Packet::makeAtomicResponse(), maskInt, MatchReg, matchVal, panic, pendingInt, BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, BasicPioDevice::pioSize, rawInt, AmbaDevice::readId(), resyncMatch(), and timeVal.

Member Data Documentation

◆ lastWrittenTick

Tick PL031::lastWrittenTick

protected

Definition at line 67 of file rtc_pl031.hh.

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

◆ loadVal

uint32_t PL031::loadVal

protected

Definition at line 70 of file rtc_pl031.hh.

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

◆ maskInt

bool PL031::maskInt

protected

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

Definition at line 84 of file rtc_pl031.hh.

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

◆ matchEvent

EventFunctionWrapper PL031::matchEvent

protected

Definition at line 92 of file rtc_pl031.hh.

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

◆ matchVal

uint32_t PL031::matchVal

protected

Definition at line 75 of file rtc_pl031.hh.

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

◆ pendingInt

bool PL031::pendingInt

protected

If an interrupt is currently pending.

Logical and of CTRL.intEnable and rawInt

Definition at line 88 of file rtc_pl031.hh.

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

◆ rawInt

bool PL031::rawInt

protected

If timer has caused an interrupt.

This is irrespective of interrupt enable

Definition at line 79 of file rtc_pl031.hh.

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

◆ timeVal

uint32_t PL031::timeVal

protected

Definition at line 64 of file rtc_pl031.hh.

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

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

dev/arm/rtc_pl031.hh
dev/arm/rtc_pl031.cc

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ PL031()

Member Function Documentation

◆ counterMatch()

◆ params()

◆ read()

◆ resyncMatch()

◆ serialize()

◆ unserialize()

◆ write()

Member Data Documentation

◆ lastWrittenTick

◆ loadVal

◆ maskInt

◆ matchEvent

◆ matchVal

◆ pendingInt

◆ rawInt

◆ timeVal