gem5  v21.1.0.2
Public Types | Public Member Functions | Private Attributes | List of all members
gem5::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 gem5::DerivedClockDomain:
gem5::ClockDomain gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

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. More...
 
- Public Member Functions inherited from gem5::ClockDomain
 ClockDomain (const Params &p, VoltageDomain *voltage_domain)
 
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 gem5::SimObject
const Paramsparams () 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. 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 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 PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. 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 gem5::EventManager
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)
 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 gem5::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 gem5::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 gem5::statistics::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 (statistics::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 InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (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

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 gem5::SimObject
static void serializeAll (const std::string &cpt_dir)
 Create a checkpoint by serializing 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 void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Protected Member Functions inherited from gem5::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 gem5::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 gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::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 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)

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:

Generated on Tue Sep 21 2021 12:27:29 for gem5 by doxygen 1.8.17