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

#include <energy_ctrl.hh>

Inheritance diagram for EnergyCtrl:
BasicPioDevice PioDevice MemObject ClockedObject SimObject Clocked EventManager Serializable Drainable

Public Types

enum  Registers {
  DVFS_HANDLER_STATUS = 0, DVFS_NUM_DOMAINS, DVFS_DOMAINID_AT_INDEX, DVFS_HANDLER_TRANS_LATENCY,
  DOMAIN_ID, PERF_LEVEL, PERF_LEVEL_ACK, NUM_OF_PERF_LEVELS,
  PERF_LEVEL_TO_READ, FREQ_AT_PERF_LEVEL, VOLT_AT_PERF_LEVEL, PIO_NUM_FIELDS
}
 

Discovery flows:

More...
 
typedef EnergyCtrlParams Params
 
- Public Types inherited from BasicPioDevice
typedef BasicPioDeviceParams Params
 
- Public Types inherited from PioDevice
typedef PioDeviceParams Params
 
- Public Types inherited from MemObject
typedef MemObjectParams Params
 
- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

 EnergyCtrl (const Params *p)
 
Tick read (PacketPtr pkt) override
 Read command sent to the device. More...
 
Tick write (PacketPtr pkt) override
 Write command sent to the device. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
void startup () override
 startup() is the final initialization call before simulation. More...
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
- Public Member Functions inherited from BasicPioDevice
 BasicPioDevice (const Params *p, Addr size)
 
const Paramsparams () const
 
virtual AddrRangeList getAddrRanges () const
 Determine the address ranges that this device responds to. More...
 
- Public Member Functions inherited from PioDevice
 PioDevice (const Params *p)
 
virtual ~PioDevice ()
 
const Paramsparams () const
 
virtual BaseSlavePortgetSlavePort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a slave port with a given name and index. More...
 
- Public Member Functions inherited from MemObject
const Paramsparams () const
 
 MemObject (const Params *params)
 
virtual BaseMasterPortgetMasterPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a master port with a given name and index. More...
 
- Public Member Functions inherited from ClockedObject
 ClockedObject (const ClockedObjectParams *p)
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
Enums::PwrState pwrState () const
 
std::string pwrStateName () const
 
std::vector< double > pwrStateWeights () const
 Returns the percentage residency for each power state. More...
 
void computeStats ()
 Record stats values like state residency by computing the time difference from previous update. More...
 
void pwrState (Enums::PwrState)
 
void regStats () override
 Register statistics for this object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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...
 
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...
 
- Public Member Functions inherited from Clocked
void updateClockPeriod () const
 Update the tick to the current tick. More...
 
Tick clockEdge (Cycles cycles=Cycles(0)) const
 Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...
 
Cycles curCycle () const
 Determine the current cycle, corresponding to a tick aligned to a clock edge. More...
 
Tick nextCycle () const
 Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...
 
uint64_t frequency () const
 
Tick clockPeriod () const
 
double voltage () const
 
Cycles ticksToCycles (Tick t) const
 
Tick cyclesToTicks (Cycles c) const
 

Private Member Functions

void updatePLAck ()
 Update the acknowledgment that is read back by the software to confirm newly requested performance level has been set. More...
 

Static Private Member Functions

static uint32_t ticksTokHz (Tick period)
 
static uint32_t toMicroVolt (double voltage)
 

Private Attributes

DVFSHandlerdvfsHandler
 
uint32_t domainID
 Cluster ID (DOMAIN_ID) R/W register, programmed to ID of the domain for which the set/get performance level command can be issued. More...
 
uint32_t domainIDIndexToRead
 Index for getting the domain ID from the domain ID list available with the DVFS handler. More...
 
uint32_t perfLevelAck
 Acknowledgment (PERF_LEVEL_ACK) RO register, software polls this register to read back the status of the last programmed change in the domain ID and/or the performance level. More...
 
uint32_t perfLevelToRead
 
EventWrapper< EnergyCtrl,&EnergyCtrl::updatePLAckupdateAckEvent
 

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 Member Functions inherited from Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (Clocked &)=delete
 
virtual ~Clocked ()
 Virtual destructor due to inheritance. More...
 
void resetClock () const
 Reset the object's clock using the current global tick value. More...
 
- Protected Attributes inherited from BasicPioDevice
Addr pioAddr
 Address that the device listens to. More...
 
Addr pioSize
 Size that the device's address range. More...
 
Tick pioDelay
 Delay that the device experinces on an access. More...
 
- Protected Attributes inherited from PioDevice
Systemsys
 
PioPort pioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- Protected Attributes inherited from ClockedObject
Enums::PwrState _currPwrState
 To keep track of the current power state. More...
 
Tick prvEvalTick
 
Stats::Scalar numPwrStateTransitions
 
Stats::Distribution pwrStateClkGateDist
 
Stats::Vector pwrStateResidencyTicks
 
- 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

Definition at line 65 of file energy_ctrl.hh.

Member Typedef Documentation

typedef EnergyCtrlParams EnergyCtrl::Params

Definition at line 119 of file energy_ctrl.hh.

Member Enumeration Documentation

Discovery flows:

  • get basic DVFS handler information read(DVFS_HANDLER_STATUS) read(DVFS_HANDLER_TRANS_LATENCY)
  • get the number of domain IDs read(DVFS_NUM_DOMAINS) -> domains
  • query the driver to get the IDs for all i in domains write(DVFS_DOMAINID_AT_INDEX <- i) read(DOMAIN_ID) -> domainID_i
  • for each domainID i get voltage / frequency pairs write(DOMAIN_ID <- domainID_i) read(NUM_OF_PERF_LEVELS) -> levels_i
    • for each l in levels_i write(PERF_LEVEL_TO_READ <- l) read(FREQ_AT_PERF_LEVEL) -> freq_l_i read(VOLT_AT_PERF_LEVEL) -> volt_l_i

Setting a specific performance level (V/F combination)

  • get performance for domain_ID i write(DOMAIN_ID <- i) read(PERF_LEVEL) -> perf_level_i
  • set performance for domain_ID i write(DOMAIN_ID <- i) write(PERF_LEVEL <- perf_level_i)
    • wait for DVFS transition completion while (!read(PERF_LEVEL_ACK));
Enumerator
DVFS_HANDLER_STATUS 
DVFS_NUM_DOMAINS 
DVFS_DOMAINID_AT_INDEX 
DVFS_HANDLER_TRANS_LATENCY 
DOMAIN_ID 
PERF_LEVEL 
PERF_LEVEL_ACK 
NUM_OF_PERF_LEVELS 
PERF_LEVEL_TO_READ 
FREQ_AT_PERF_LEVEL 
VOLT_AT_PERF_LEVEL 
PIO_NUM_FIELDS 

Definition at line 104 of file energy_ctrl.hh.

Constructor & Destructor Documentation

EnergyCtrl::EnergyCtrl ( const Params p)

Definition at line 50 of file energy_ctrl.cc.

References fatal_if().

Member Function Documentation

void EnergyCtrl::init ( )
overridevirtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from PioDevice.

Definition at line 261 of file energy_ctrl.cc.

References PioDevice::init().

Tick EnergyCtrl::read ( PacketPtr  pkt)
overridevirtual
void EnergyCtrl::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 220 of file energy_ctrl.cc.

References domainID, domainIDIndexToRead, perfLevelAck, perfLevelToRead, Event::scheduled(), SERIALIZE_SCALAR, updateAckEvent, and Event::when().

void EnergyCtrl::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 SimObject.

Definition at line 253 of file energy_ctrl.cc.

References dvfsHandler, DVFSHandler::isEnabled(), and warn.

static uint32_t EnergyCtrl::ticksTokHz ( Tick  period)
inlinestaticprivate

Definition at line 169 of file energy_ctrl.hh.

References SimClock::Int::ms.

Referenced by read().

static uint32_t EnergyCtrl::toMicroVolt ( double  voltage)
inlinestaticprivate

Definition at line 173 of file energy_ctrl.hh.

Referenced by read().

void EnergyCtrl::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 232 of file energy_ctrl.cc.

References domainID, domainIDIndexToRead, perfLevelAck, perfLevelToRead, EventManager::schedule(), UNSERIALIZE_SCALAR, and updateAckEvent.

void EnergyCtrl::updatePLAck ( )
inlineprivate

Update the acknowledgment that is read back by the software to confirm newly requested performance level has been set.

Definition at line 181 of file energy_ctrl.hh.

References perfLevelAck.

Tick EnergyCtrl::write ( PacketPtr  pkt)
overridevirtual

Member Data Documentation

uint32_t EnergyCtrl::domainID
private

Cluster ID (DOMAIN_ID) R/W register, programmed to ID of the domain for which the set/get performance level command can be issued.

Definition at line 148 of file energy_ctrl.hh.

Referenced by read(), serialize(), unserialize(), and write().

uint32_t EnergyCtrl::domainIDIndexToRead
private

Index for getting the domain ID from the domain ID list available with the DVFS handler.

Definition at line 154 of file energy_ctrl.hh.

Referenced by read(), serialize(), unserialize(), and write().

DVFSHandler* EnergyCtrl::dvfsHandler
private

Definition at line 142 of file energy_ctrl.hh.

Referenced by read(), startup(), and write().

uint32_t EnergyCtrl::perfLevelAck
private

Acknowledgment (PERF_LEVEL_ACK) RO register, software polls this register to read back the status of the last programmed change in the domain ID and/or the performance level.

Valid values are: '0' - Ack is not OK yet '1' - Ack is OK It is a read destructive register with a read of '1' resets the ack to '0'.

Definition at line 165 of file energy_ctrl.hh.

Referenced by read(), serialize(), unserialize(), and updatePLAck().

uint32_t EnergyCtrl::perfLevelToRead
private

Definition at line 167 of file energy_ctrl.hh.

Referenced by read(), serialize(), unserialize(), and write().

EventWrapper<EnergyCtrl, &EnergyCtrl::updatePLAck> EnergyCtrl::updateAckEvent
private

Definition at line 185 of file energy_ctrl.hh.

Referenced by serialize(), unserialize(), and write().


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

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