This is an implementation of a programmable oscillator on the that can be configured through the RealView/Versatile Express configuration interface. More...

#include <rv_ctrl.hh>

Inheritance diagram for gem5::RealViewOsc:

Public Member Functions
	RealViewOsc (const RealViewOscParams &p)

virtual	~RealViewOsc ()

void	startup () override
	startup() is the final initialization call before simulation.

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

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

uint32_t	read () const override

void	write (uint32_t freq) override

Public Member Functions inherited from gem5::ClockDomain
	ClockDomain (const Params &p, VoltageDomain *voltage_domain)

Tick	clockPeriod () const
	Get the clock period.

void	registerWithClockDomain (Clocked *c)
	Register a Clocked object with this ClockDomain.

VoltageDomain *	voltageDomain () const
	Get the voltage domain.

double	voltage () const
	Get the current voltage this clock domain operates at.

void	addDerivedDomain (DerivedClockDomain *clock_domain)
	Add a derived domain.

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

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

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 Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID)
	Get a port with a given name and index.

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

Protected Member Functions
void	clockPeriod (Tick clock_period)

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.

Additional Inherited Members
Public Types inherited from gem5::ClockDomain
typedef ClockDomainParams	Params

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.

Protected Attributes inherited from gem5::ClockDomain
Tick	_clockPeriod
	Pre-computed clock period in ticks.

VoltageDomain *	_voltageDomain
	Voltage domain this clock domain belongs to.

std::vector< DerivedClockDomain * >	children
	Pointers to potential derived clock domains so we can propagate changes.

std::vector< Clocked * >	members
	Pointers to members of this clock domain, so that when the clock period changes, we can update each member's tick.

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 Member Functions inherited from gem5::RealViewCtrl::Device
	Device (RealViewCtrl &parent, DeviceFunc func, uint8_t site, uint8_t pos, uint8_t dcc, uint16_t dev)

virtual	~Device ()

Detailed Description

This is an implementation of a programmable oscillator on the that can be configured through the RealView/Versatile Express configuration interface.

See ARM DUI 0447J (ARM Motherboard Express uATX – V2M-P1).

Definition at line 202 of file rv_ctrl.hh.

Constructor & Destructor Documentation

◆ RealViewOsc()

gem5::RealViewOsc::RealViewOsc ( const RealViewOscParams & p )

Definition at line 240 of file rv_ctrl.cc.

References gem5::ClockDomain::_clockPeriod, fatal, gem5::MipsISA::p, and gem5::sim_clock::as_float::s.

◆ ~RealViewOsc()

virtual gem5::RealViewOsc::~RealViewOsc ( )

inlinevirtual

Definition at line 207 of file rv_ctrl.hh.

Member Function Documentation

◆ clockPeriod()

void gem5::RealViewOsc::clockPeriod ( Tick clock_period )

protected

Definition at line 274 of file rv_ctrl.cc.

References gem5::ClockDomain::_clockPeriod, gem5::ClockDomain::children, gem5::ArmISA::m, gem5::ClockDomain::members, gem5::Named::name(), and panic_if.

◆ read()

uint32_t gem5::RealViewOsc::read ( ) const

overridevirtual

Implements gem5::RealViewCtrl::Device.

Definition at line 290 of file rv_ctrl.cc.

References gem5::ClockDomain::_clockPeriod, DPRINTF, and gem5::sim_clock::as_float::s.

◆ serialize()

void gem5::RealViewOsc::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 262 of file rv_ctrl.cc.

References gem5::ClockDomain::_clockPeriod, and SERIALIZE_SCALAR.

◆ startup()

void gem5::RealViewOsc::startup ( )

overridevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from gem5::SimObject.

Definition at line 254 of file rv_ctrl.cc.

References gem5::ArmISA::m, and gem5::ClockDomain::members.