gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Attributes | Private Attributes | List of all members
ClockDomain Class Reference

The ClockDomain provides clock to group of clocked objects bundled under the same clock domain. More...

#include <clock_domain.hh>

Inheritance diagram for ClockDomain:
SimObject EventManager Serializable Drainable DerivedClockDomain RealViewOsc SrcClockDomain

Public Types

typedef ClockDomainParams Params
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 ClockDomain (const Params *p, VoltageDomain *voltage_domain)
 
void regStats ()
 Register statistics for this object. More...
 
Tick clockPeriod () const
 Get the clock period. More...
 
void registerWithClockDomain (Clocked *c)
 Register a Clocked object with this ClockDomain. More...
 
VoltageDomainvoltageDomain () const
 Get the voltage domain. More...
 
double voltage () const
 Get the current voltage this clock domain operates at. More...
 
void addDerivedDomain (DerivedClockDomain *clock_domain)
 Add a derived domain. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
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 resetStats ()
 Reset statistics associated with this object. More...
 
virtual void regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 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
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
EventQueueeventQueue () 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)
 
void setCurTick (Tick newVal)
 
- 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...
 

Protected Attributes

Tick _clockPeriod
 Pre-computed clock period in ticks. More...
 
VoltageDomain_voltageDomain
 Voltage domain this clock domain belongs to. More...
 
std::vector< DerivedClockDomain * > children
 Pointers to potential derived clock domains so we can propagate changes. More...
 
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. More...
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Private Attributes

Stats::Value currentClock
 Stat to report clock period of clock domain. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize all SimObjects in the system. More...
 
static SimObjectfind (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 ()
 Get the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 
- 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...
 

Detailed Description

The ClockDomain provides clock to group of clocked objects bundled under the same clock domain.

The clock domains, in turn, are grouped into voltage domains. The clock domains provide support for a hierarchial structure with source and derived domains.

Definition at line 73 of file clock_domain.hh.

Member Typedef Documentation

typedef ClockDomainParams ClockDomain::Params

Definition at line 110 of file clock_domain.hh.

Constructor & Destructor Documentation

ClockDomain::ClockDomain ( const Params p,
VoltageDomain voltage_domain 
)
inline

Definition at line 111 of file clock_domain.hh.

Member Function Documentation

void ClockDomain::addDerivedDomain ( DerivedClockDomain clock_domain)
inline

Add a derived domain.

Parameters
Deriveddomain to add as a child

Definition at line 157 of file clock_domain.hh.

References children.

Referenced by DerivedClockDomain::DerivedClockDomain().

Tick ClockDomain::clockPeriod ( ) const
inline

Get the clock period.

Returns
Clock period in ticks

Definition at line 123 of file clock_domain.hh.

References _clockPeriod.

Referenced by Clocked::clockPeriod(), SrcClockDomain::signalPerfLevelUpdate(), SrcClockDomain::SrcClockDomain(), DerivedClockDomain::updateClockPeriod(), and RealViewOsc::write().

void ClockDomain::registerWithClockDomain ( Clocked c)
inline

Register a Clocked object with this ClockDomain.

Parameters
Clockedto add as a member

Definition at line 130 of file clock_domain.hh.

References ArmISA::c, and members.

Referenced by Clocked::Clocked().

void ClockDomain::regStats ( )
virtual
double ClockDomain::voltage ( ) const

Get the current voltage this clock domain operates at.

Returns
Voltage applied to the clock domain

Definition at line 75 of file clock_domain.cc.

References _voltageDomain, and VoltageDomain::voltage().

Referenced by Clocked::voltage().

VoltageDomain* ClockDomain::voltageDomain ( ) const
inline

Get the voltage domain.

Returns
Voltage domain this clock domain belongs to

Definition at line 142 of file clock_domain.hh.

References _voltageDomain.

Referenced by VoltageDomain::registerSrcClockDom(), VoltageDomain::sanitiseVoltages(), SrcClockDomain::signalPerfLevelUpdate(), and DVFSHandler::voltageAtPerfLevel().

Member Data Documentation

Tick ClockDomain::_clockPeriod
protected

Pre-computed clock period in ticks.

This is populated by the inheriting classes based on how their period is determined.

Definition at line 89 of file clock_domain.hh.

Referenced by clockPeriod(), SrcClockDomain::clockPeriod(), RealViewOsc::clockPeriod(), RealViewOsc::read(), RealViewOsc::RealViewOsc(), regStats(), RealViewOsc::serialize(), RealViewOsc::unserialize(), and DerivedClockDomain::updateClockPeriod().

VoltageDomain* ClockDomain::_voltageDomain
protected

Voltage domain this clock domain belongs to.

Definition at line 94 of file clock_domain.hh.

Referenced by voltage(), and voltageDomain().

std::vector<DerivedClockDomain*> ClockDomain::children
protected

Pointers to potential derived clock domains so we can propagate changes.

Definition at line 100 of file clock_domain.hh.

Referenced by addDerivedDomain(), SrcClockDomain::clockPeriod(), RealViewOsc::clockPeriod(), and DerivedClockDomain::updateClockPeriod().

Stats::Value ClockDomain::currentClock
private

Stat to report clock period of clock domain.

Definition at line 81 of file clock_domain.hh.

Referenced by regStats().

std::vector<Clocked *> ClockDomain::members
protected

Pointers to members of this clock domain, so that when the clock period changes, we can update each member's tick.

Definition at line 106 of file clock_domain.hh.

Referenced by SrcClockDomain::clockPeriod(), RealViewOsc::clockPeriod(), registerWithClockDomain(), RealViewOsc::startup(), and DerivedClockDomain::updateClockPeriod().


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

Generated on Fri Jun 9 2017 13:04:05 for gem5 by doxygen 1.8.6