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

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 DerivedClockDomain:
ClockDomain SimObject EventManager Serializable Drainable

Public Types

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

Public Member Functions

 DerivedClockDomain (const Params *p)
 
void updateClockPeriod ()
 Called by the parent clock domain to propagate changes. More...
 
- Public Member Functions inherited from ClockDomain
 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...
 

Private Attributes

ClockDomainparent
 Reference to the parent clock domain this clock domain derives its clock period from. More...
 
const uint64_t clockDivider
 Local clock divider of the 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...
 
- Protected Attributes inherited from ClockDomain
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...
 

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 280 of file clock_domain.hh.

Member Typedef Documentation

typedef DerivedClockDomainParams DerivedClockDomain::Params

Definition at line 285 of file clock_domain.hh.

Constructor & Destructor Documentation

DerivedClockDomain::DerivedClockDomain ( const Params p)

Member Function Documentation

void 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 215 of file clock_domain.cc.

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

Referenced by DerivedClockDomain().

Member Data Documentation

const uint64_t DerivedClockDomain::clockDivider
private

Local clock divider of the domain.

Definition at line 306 of file clock_domain.hh.

Referenced by DerivedClockDomain(), and updateClockPeriod().

ClockDomain& DerivedClockDomain::parent
private

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

Definition at line 301 of file clock_domain.hh.

Referenced by DerivedClockDomain(), and updateClockPeriod().


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

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