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:
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) | |
| Tick | clockPeriod () const |
| Get the clock period. More... | |
| void | registerWithClockDomain (Clocked *c) |
| Register a Clocked object with this ClockDomain. More... | |
| VoltageDomain * | voltageDomain () 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 Params * | params () 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 | regProbePoints () |
| Register probe points for this object. More... | |
| virtual void | regProbeListeners () |
| Register probe listeners for this object. More... | |
| ProbeManager * | getProbeManager () |
| Get the probe manager for this object. More... | |
| virtual Port & | getPort (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 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. 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 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... | |
| Public Member Functions inherited from Stats::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 (Stats::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 Info * | resolveStat (std::string name) const |
| Resolve a stat by its name within this group. More... | |
| Group ()=delete | |
| Group (const Group &)=delete | |
| Group & | operator= (const Group &)=delete |
Private Attributes | |
| ClockDomain & | parent |
| 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 SimObject * | find (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 () |
| Gets the fully-qualified name of the active section. More... | |
| static void | serializeAll (const std::string &cpt_dir) |
| Serializes all the SimObjects. More... | |
| static void | unserializeGlobals (CheckpointIn &cp) |
| 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 | |
| EventQueue * | eventq |
| 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 272 of file clock_domain.hh.
Member Typedef Documentation
◆ Params
| typedef DerivedClockDomainParams DerivedClockDomain::Params |
Definition at line 277 of file clock_domain.hh.
Constructor & Destructor Documentation
◆ DerivedClockDomain()
| DerivedClockDomain::DerivedClockDomain | ( | const Params * | p | ) |
Definition at line 190 of file clock_domain.cc.
References ClockDomain::addDerivedDomain(), clockDivider, fatal, parent, and updateClockPeriod().
Member Function Documentation
◆ updateClockPeriod()
| 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 210 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
◆ clockDivider
|
private |
Local clock divider of the domain.
Definition at line 298 of file clock_domain.hh.
Referenced by DerivedClockDomain(), and updateClockPeriod().
◆ parent
|
private |
Reference to the parent clock domain this clock domain derives its clock period from.
Definition at line 293 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