gem5  v21.1.0.2
energy_ctrl.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012-2014 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
53 #ifndef __DEV_ARM_ENERGY_CTRL_HH__
54 #define __DEV_ARM_ENERGY_CTRL_HH__
55 
56 #include "dev/io_device.hh"
57 #include "params/EnergyCtrl.hh"
58 
59 namespace gem5
60 {
61 
62 class DVFSHandler;
63 
64 class EnergyCtrl : public BasicPioDevice
65 {
66  public:
104  {
117  };
118 
119  typedef EnergyCtrlParams Params;
120  EnergyCtrl(const Params &p);
121 
127  Tick read(PacketPtr pkt) override;
133  Tick write(PacketPtr pkt) override;
134 
135  void serialize(CheckpointOut &cp) const override;
136  void unserialize(CheckpointIn &cp) override;
137 
138  void startup() override;
139  void init() override;
140 
141  private:
143 
148  uint32_t domainID;
149 
155 
165  uint32_t perfLevelAck;
166 
167  uint32_t perfLevelToRead;
168 
169  static uint32_t ticksTokHz(Tick period) {
170  return (uint32_t)(sim_clock::as_int::ms / period);
171  }
172 
173  static uint32_t toMicroVolt(double voltage) {
174  return (uint32_t)(voltage * 1000000);
175  }
176 
181  void updatePLAck() {
182  perfLevelAck = 1;
183  }
184 
186 };
187 
188 } // namespace gem5
189 
190 #endif //__DEV_ARM_ENERGY_CTRL_HH__
gem5::EnergyCtrl::PERF_LEVEL
@ PERF_LEVEL
Definition: energy_ctrl.hh:110
gem5::EnergyCtrl::read
Tick read(PacketPtr pkt) override
Read command sent to the device.
Definition: energy_ctrl.cc:65
gem5::EnergyCtrl::perfLevelAck
uint32_t perfLevelAck
Acknowledgment (PERF_LEVEL_ACK) RO register, software polls this register to read back the status of ...
Definition: energy_ctrl.hh:165
gem5::EnergyCtrl::toMicroVolt
static uint32_t toMicroVolt(double voltage)
Definition: energy_ctrl.hh:173
gem5::EnergyCtrl::dvfsHandler
DVFSHandler * dvfsHandler
Definition: energy_ctrl.hh:142
io_device.hh
gem5::EnergyCtrl::VOLT_AT_PERF_LEVEL
@ VOLT_AT_PERF_LEVEL
Definition: energy_ctrl.hh:115
gem5::EnergyCtrl::DVFS_HANDLER_STATUS
@ DVFS_HANDLER_STATUS
Definition: energy_ctrl.hh:105
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::EnergyCtrl::EnergyCtrl
EnergyCtrl(const Params &p)
Definition: energy_ctrl.cc:51
gem5::EnergyCtrl::PIO_NUM_FIELDS
@ PIO_NUM_FIELDS
Definition: energy_ctrl.hh:116
gem5::EnergyCtrl::Params
EnergyCtrlParams Params
Definition: energy_ctrl.hh:119
gem5::EnergyCtrl::PERF_LEVEL_TO_READ
@ PERF_LEVEL_TO_READ
Definition: energy_ctrl.hh:113
gem5::EnergyCtrl
Definition: energy_ctrl.hh:64
gem5::EnergyCtrl::FREQ_AT_PERF_LEVEL
@ FREQ_AT_PERF_LEVEL
Definition: energy_ctrl.hh:114
gem5::EnergyCtrl::DVFS_NUM_DOMAINS
@ DVFS_NUM_DOMAINS
Definition: energy_ctrl.hh:106
gem5::EnergyCtrl::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: energy_ctrl.cc:221
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::Clocked::voltage
double voltage() const
Definition: clocked_object.hh:219
gem5::EnergyCtrl::DVFS_DOMAINID_AT_INDEX
@ DVFS_DOMAINID_AT_INDEX
Definition: energy_ctrl.hh:107
gem5::EnergyCtrl::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: energy_ctrl.cc:233
gem5::EnergyCtrl::updateAckEvent
EventFunctionWrapper updateAckEvent
Definition: energy_ctrl.hh:185
gem5::EnergyCtrl::startup
void startup() override
startup() is the final initialization call before simulation.
Definition: energy_ctrl.cc:249
gem5::EnergyCtrl::domainIDIndexToRead
uint32_t domainIDIndexToRead
Index for getting the domain ID from the domain ID list available with the DVFS handler.
Definition: energy_ctrl.hh:154
gem5::EnergyCtrl::ticksTokHz
static uint32_t ticksTokHz(Tick period)
Definition: energy_ctrl.hh:169
gem5::EnergyCtrl::DOMAIN_ID
@ DOMAIN_ID
Definition: energy_ctrl.hh:109
gem5::EnergyCtrl::DVFS_HANDLER_TRANS_LATENCY
@ DVFS_HANDLER_TRANS_LATENCY
Definition: energy_ctrl.hh:108
gem5::EventFunctionWrapper
Definition: eventq.hh:1115
gem5::EnergyCtrl::init
void init() override
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: energy_ctrl.cc:257
gem5::EnergyCtrl::updatePLAck
void updatePLAck()
Update the acknowledgment that is read back by the software to confirm newly requested performance le...
Definition: energy_ctrl.hh:181
gem5::DVFSHandler
DVFS Handler class, maintains a list of all the domains it can handle.
Definition: dvfs_handler.hh:74
gem5::EnergyCtrl::domainID
uint32_t domainID
Cluster ID (DOMAIN_ID) R/W register, programmed to ID of the domain for which the set/get performance...
Definition: energy_ctrl.hh:148
gem5::EnergyCtrl::write
Tick write(PacketPtr pkt) override
Write command sent to the device.
Definition: energy_ctrl.cc:151
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5::EnergyCtrl::perfLevelToRead
uint32_t perfLevelToRead
Definition: energy_ctrl.hh:167
gem5::sim_clock::as_int::ms
Tick ms
millisecond
Definition: core.cc:69
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::BasicPioDevice
Definition: io_device.hh:147
gem5::EnergyCtrl::PERF_LEVEL_ACK
@ PERF_LEVEL_ACK
Definition: energy_ctrl.hh:111
gem5::EnergyCtrl::Registers
Registers
Definition: energy_ctrl.hh:103
gem5::EnergyCtrl::NUM_OF_PERF_LEVELS
@ NUM_OF_PERF_LEVELS
Definition: energy_ctrl.hh:112

Generated on Tue Sep 21 2021 12:25:09 for gem5 by doxygen 1.8.17