gem5  v21.1.0.2
Public Member Functions | Protected Member Functions | List of all members
gem5::RealViewOsc Class Reference

This is an implementation of a programmable oscillator on the that can be configured through the RealView/Versatile Express configuration interface. More...

#include <rv_ctrl.hh>

Inheritance diagram for gem5::RealViewOsc:
gem5::ClockDomain gem5::RealViewCtrl::Device gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Member Functions

 RealViewOsc (const RealViewOscParams &p)
 
virtual ~RealViewOsc ()
 
void startup () override
 startup() is the final initialization call before simulation. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
uint32_t read () const override
 
void write (uint32_t freq) override
 
- 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...
 
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
 

Protected Member Functions

void clockPeriod (Tick clock_period)
 
- 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...
 

Additional Inherited Members

- Public Types inherited from gem5::ClockDomain
typedef ClockDomainParams Params
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 
- 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 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...
 
- Private Member Functions inherited from gem5::RealViewCtrl::Device
 Device (RealViewCtrl &parent, DeviceFunc func, uint8_t site, uint8_t pos, uint8_t dcc, uint16_t dev)
 
virtual ~Device ()
 

Detailed Description

This is an implementation of a programmable oscillator on the that can be configured through the RealView/Versatile Express configuration interface.

See ARM DUI 0447J (ARM Motherboard Express uATX – V2M-P1).

Definition at line 202 of file rv_ctrl.hh.

Constructor & Destructor Documentation

◆ RealViewOsc()

gem5::RealViewOsc::RealViewOsc ( const RealViewOscParams &  p)

◆ ~RealViewOsc()

virtual gem5::RealViewOsc::~RealViewOsc ( )
inlinevirtual

Definition at line 207 of file rv_ctrl.hh.

Member Function Documentation

◆ clockPeriod()

void gem5::RealViewOsc::clockPeriod ( Tick  clock_period)
protected

◆ read()

uint32_t gem5::RealViewOsc::read ( ) const
overridevirtual

◆ serialize()

void gem5::RealViewOsc::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 262 of file rv_ctrl.cc.

References gem5::ClockDomain::_clockPeriod, and SERIALIZE_SCALAR.

◆ startup()

void gem5::RealViewOsc::startup ( )
overridevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from gem5::SimObject.

Definition at line 254 of file rv_ctrl.cc.

References gem5::ArmISA::m, and gem5::ClockDomain::members.

◆ unserialize()

void gem5::RealViewOsc::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 268 of file rv_ctrl.cc.

References gem5::ClockDomain::_clockPeriod, and UNSERIALIZE_SCALAR.

◆ write()

void gem5::RealViewOsc::write ( uint32_t  freq)
overridevirtual

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

Generated on Tue Sep 21 2021 12:28:00 for gem5 by doxygen 1.8.17