The derived clock domains provides the notion of a clock domain that is connected to a parent clock domain that can either be a source clock domain or a derived clock domain. More...

#include <clock_domain.hh>

Inheritance diagram for gem5::DerivedClockDomain:

Public Types
typedef DerivedClockDomainParams	Params

Public Types inherited from gem5::ClockDomain
typedef ClockDomainParams	Params

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	DerivedClockDomain (const Params &p)

void	updateClockPeriod ()
	Called by the parent clock domain to propagate changes.

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.

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

Private Attributes
ClockDomain &	parent
	Reference to the parent clock domain this clock domain derives its clock period from.

const uint64_t	clockDivider
	Local clock divider of the domain.

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

Detailed Description

The derived clock domains provides the notion of a clock domain that is connected to a parent clock domain that can either be a source clock domain or a derived clock domain.

It maintains the clock divider and provides methods for getting the clock.

Definition at line 275 of file clock_domain.hh.

Member Typedef Documentation

◆ Params

typedef DerivedClockDomainParams gem5::DerivedClockDomain::Params

Definition at line 280 of file clock_domain.hh.

Constructor & Destructor Documentation

◆ DerivedClockDomain()

gem5::DerivedClockDomain::DerivedClockDomain ( const Params & p )

Definition at line 189 of file clock_domain.cc.

References gem5::ClockDomain::addDerivedDomain(), clockDivider, fatal, parent, and updateClockPeriod().

Member Function Documentation

◆ updateClockPeriod()

void gem5::DerivedClockDomain::updateClockPeriod ( )

Called by the parent clock domain to propagate changes.

This also involves propagating the change further to any children of the derived domain itself.

Definition at line 209 of file clock_domain.cc.

References gem5::ClockDomain::_clockPeriod, gem5::ArmISA::c, gem5::ClockDomain::children, clockDivider, gem5::ClockDomain::clockPeriod(), DPRINTF, gem5::ArmISA::m, gem5::ClockDomain::members, gem5::Named::name(), and parent.

Referenced by DerivedClockDomain().

Member Data Documentation

◆ clockDivider

const uint64_t gem5::DerivedClockDomain::clockDivider

private

Local clock divider of the domain.

Definition at line 301 of file clock_domain.hh.

Referenced by DerivedClockDomain(), and updateClockPeriod().

◆ parent

ClockDomain& gem5::DerivedClockDomain::parent

private

Reference to the parent clock domain this clock domain derives its clock period from.

Definition at line 296 of file clock_domain.hh.

Referenced by DerivedClockDomain(), and updateClockPeriod().

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

sim/clock_domain.hh
sim/clock_domain.cc

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members