gem5  v20.1.0.0
voltage_domain.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012, 2019 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 
38 #ifndef __SIM_VOLTAGE_DOMAIN_HH__
39 #define __SIM_VOLTAGE_DOMAIN_HH__
40 
41 #include <vector>
42 
43 #include "base/statistics.hh"
44 #include "params/VoltageDomain.hh"
45 #include "sim/clock_domain.hh"
46 #include "sim/sim_object.hh"
47 
53 class VoltageDomain : public SimObject
54 {
55  public:
56 
57  typedef VoltageDomainParams Params;
58  VoltageDomain(const Params *p);
59 
61 
67  double voltage() const { return voltageOpPoints[_perfLevel]; }
68 
75  double voltage(PerfLevel perf_level) const
76  {
77  chatty_assert(perf_level < numVoltages(), "VoltageDomain %s "\
78  "request for voltage perf level %u is outside "\
79  "of numVoltages %u", name(), perf_level,
80  numVoltages());
81  return voltageOpPoints[perf_level];
82  }
83 
84  uint32_t numVoltages() const { return (uint32_t)voltageOpPoints.size(); }
85 
90  void perfLevel(PerfLevel perf_level);
91 
96  PerfLevel perfLevel() const { return _perfLevel; }
97 
102  void registerSrcClockDom(SrcClockDomain *src_clock_dom) {
103  assert(src_clock_dom->voltageDomain() == this);
104  srcClockChildren.push_back(src_clock_dom);
105  }
106 
111  void startup() override;
112 
124  bool sanitiseVoltages();
125 
126  void serialize(CheckpointOut &cp) const override;
127  void unserialize(CheckpointIn &cp) override;
128 
129  private:
140 
142  {
144 
149  } stats;
150 
157 };
158 
159 #endif
SimObject::Params
SimObjectParams Params
Definition: sim_object.hh:113
VoltageDomain::srcClockChildren
SrcClockChildren srcClockChildren
Definition: voltage_domain.hh:156
VoltageDomain::voltage
double voltage() const
Get the current voltage.
Definition: voltage_domain.hh:67
VoltageDomain::numVoltages
uint32_t numVoltages() const
Definition: voltage_domain.hh:84
VoltageDomain::SrcClockChildren
std::vector< SrcClockDomain * > SrcClockChildren
List of associated SrcClockDomains that are connected to this voltage domain.
Definition: voltage_domain.hh:155
VoltageDomain::stats
VoltageDomain::VoltageDomainStats stats
SrcClockDomain
The source clock domains provides the notion of a clock domain that is connected to a tunable clock s...
Definition: clock_domain.hh:163
VoltageDomain::startup
void startup() override
Startup has all SrcClockDomains registered with this voltage domain, so try to make sure that all per...
Definition: voltage_domain.cc:119
std::vector< double >
Stats::Value
Definition: statistics.hh:2561
cp
Definition: cprintf.cc:40
VoltageDomain::registerSrcClockDom
void registerSrcClockDom(SrcClockDomain *src_clock_dom)
Register a SrcClockDomain with this voltage domain.
Definition: voltage_domain.hh:102
sim_object.hh
VoltageDomain::Voltages
std::vector< double > Voltages
Definition: voltage_domain.hh:130
VoltageDomain::sanitiseVoltages
bool sanitiseVoltages()
Recomputes the highest (fastest, i.e., numerically lowest) requested performance level of all associa...
Definition: voltage_domain.cc:80
statistics.hh
VoltageDomain
A VoltageDomain is used to group clock domains that operate under the same voltage.
Definition: voltage_domain.hh:53
VoltageDomain::_perfLevel
PerfLevel _perfLevel
Definition: voltage_domain.hh:139
chatty_assert
#define chatty_assert(cond,...)
The chatty assert macro will function like a normal assert, but will allow the specification of addit...
Definition: logging.hh:292
VoltageDomain::VoltageDomainStats::VoltageDomainStats
VoltageDomainStats(VoltageDomain &vd)
Definition: voltage_domain.cc:146
VoltageDomain::perfLevel
PerfLevel perfLevel() const
Get the voltage point of the domain.
Definition: voltage_domain.hh:96
VoltageDomain::VoltageDomain
VoltageDomain(const Params *p)
Definition: voltage_domain.cc:48
VoltageDomain::voltage
double voltage(PerfLevel perf_level) const
Get the voltage at specified performance level.
Definition: voltage_domain.hh:75
ClockDomain::voltageDomain
VoltageDomain * voltageDomain() const
Get the voltage domain.
Definition: clock_domain.hh:124
clock_domain.hh
SimObject::name
virtual const std::string name() const
Definition: sim_object.hh:133
VoltageDomain::voltageOpPoints
const Voltages voltageOpPoints
List of possible minimum voltage at each of the frequency operational points, should be in descending...
Definition: voltage_domain.hh:138
VoltageDomain::Params
VoltageDomainParams Params
Definition: voltage_domain.hh:57
VoltageDomain::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: voltage_domain.cc:140
Stats::Group
Statistics container.
Definition: group.hh:83
CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:63
VoltageDomain::VoltageDomainStats
Definition: voltage_domain.hh:141
VoltageDomain::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: voltage_domain.cc:134
MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:323
CheckpointIn
Definition: serialize.hh:67
SrcClockDomain::PerfLevel
uint32_t PerfLevel
Definition: clock_domain.hh:188
VoltageDomain::VoltageDomainStats::voltage
Stats::Value voltage
Stat for reporting voltage of the domain.
Definition: voltage_domain.hh:148
VoltageDomain::PerfLevel
SrcClockDomain::PerfLevel PerfLevel
Definition: voltage_domain.hh:60
SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:92

Generated on Wed Sep 30 2020 14:02:14 for gem5 by doxygen 1.8.17