gem5  v21.1.0.2
thermal_model.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015, 2021 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_THERMAL_MODEL_HH__
39 #define __SIM_THERMAL_MODEL_HH__
40 
41 #include <vector>
42 
43 #include "base/temperature.hh"
44 #include "sim/clocked_object.hh"
48 #include "sim/sim_object.hh"
49 
50 namespace gem5
51 {
52 
53 struct ThermalCapacitorParams;
54 struct ThermalModelParams;
55 struct ThermalReferenceParams;
56 struct ThermalResistorParams;
57 
63 class ThermalResistor : public SimObject, public ThermalEntity
64 {
65  public:
66  typedef ThermalResistorParams Params;
67  ThermalResistor(const Params &p);
68 
69  void setNodes(ThermalNode * n1, ThermalNode * n2) {
70  node1 = n1;
71  node2 = n2;
72  }
73 
74  LinearEquation getEquation(ThermalNode * tn, unsigned n,
75  double step) const override;
76 
77  private:
78  /* Resistance value in K/W */
79  const double _resistance;
80  /* Nodes connected to the resistor */
82 };
83 
90 {
91  public:
92  typedef ThermalCapacitorParams Params;
93  ThermalCapacitor(const Params &p);
94 
95  LinearEquation getEquation(ThermalNode * tn, unsigned n,
96  double step) const override;
97 
98  void setNodes(ThermalNode * n1, ThermalNode * n2) {
99  node1 = n1;
100  node2 = n2;
101  }
102 
103  private:
104  /* Capacitance value in J/K */
105  const double _capacitance;
106  /* Nodes connected to the resistor */
108 };
109 
115 {
116  public:
117  typedef ThermalReferenceParams Params;
118  ThermalReference(const Params &p);
119 
120  void
122  {
123  node = n;
124  }
125 
126  LinearEquation getEquation(ThermalNode * tn, unsigned n,
127  double step) const override;
128 
129  /* Fixed temperature value */
131  /* Nodes connected to the resistor */
133 };
134 
135 
145 {
146  public:
147  typedef ThermalModelParams Params;
148  ThermalModel(const Params &p);
149 
150  void addDomain(ThermalDomain * d);
153  void addResistor(ThermalResistor * r);
154 
155  void addNode(ThermalNode * n) { nodes.push_back(n); }
156 
157  Temperature getTemperature() const;
158 
159  void startup() override;
160  void doStep();
161 
162  private:
163 
164  /* Keep track of all components used for the thermal model */
169 
171 
172  /* Keep a list of the instantiated nodes */
175 
178 
180  const double _step;
181 };
182 
183 } // namespace gem5
184 
185 #endif
gem5::ThermalModel::eq_nodes
std::vector< ThermalNode * > eq_nodes
Definition: thermal_model.hh:174
gem5::ThermalResistor::getEquation
LinearEquation getEquation(ThermalNode *tn, unsigned n, double step) const override
Definition: thermal_model.cc:77
gem5::ThermalModel::addNode
void addNode(ThermalNode *n)
Definition: thermal_model.hh:155
gem5::ThermalReference::node
ThermalNode * node
Definition: thermal_model.hh:132
gem5::ThermalReference::getEquation
LinearEquation getEquation(ThermalNode *tn, unsigned n, double step) const override
Definition: thermal_model.cc:62
gem5::ThermalModel::addReference
void addReference(ThermalReference *r)
Definition: thermal_model.cc:220
gem5::ThermalModel
Definition: thermal_model.hh:144
gem5::ThermalReference::setNode
void setNode(ThermalNode *n)
Definition: thermal_model.hh:121
gem5::ThermalModel::domains
std::vector< ThermalDomain * > domains
Definition: thermal_model.hh:165
gem5::ThermalModel::Params
ThermalModelParams Params
Definition: thermal_model.hh:147
gem5::ThermalModel::addCapacitor
void addCapacitor(ThermalCapacitor *c)
Definition: thermal_model.cc:227
thermal_entity.hh
std::vector
STL vector class.
Definition: stl.hh:37
gem5::Temperature
The class stores temperatures in Kelvin and provides helper methods to convert to/from Celsius.
Definition: temperature.hh:50
gem5::ThermalCapacitor::_capacitance
const double _capacitance
Definition: thermal_model.hh:105
gem5::ThermalResistor::ThermalResistor
ThermalResistor(const Params &p)
ThermalResistor.
Definition: thermal_model.cc:71
gem5::ThermalCapacitor
A ThermalCapacitor is used to model a thermal capacitance between two thermal domains.
Definition: thermal_model.hh:89
gem5::ThermalModel::resistors
std::vector< ThermalResistor * > resistors
Definition: thermal_model.hh:168
gem5::ThermalModel::nodes
std::vector< ThermalNode * > nodes
Definition: thermal_model.hh:173
gem5::ThermalResistor::Params
ThermalResistorParams Params
Definition: thermal_model.hh:66
gem5::ThermalReference::ThermalReference
ThermalReference(const Params &p)
ThermalReference.
Definition: thermal_model.cc:56
thermal_node.hh
gem5::ThermalModel::startup
void startup() override
startup() is the final initialization call before simulation.
Definition: thermal_model.cc:180
gem5::ThermalCapacitor::node1
ThermalNode * node1
Definition: thermal_model.hh:107
gem5::ThermalModel::stepEvent
EventFunctionWrapper stepEvent
Stepping event to update the model values.
Definition: thermal_model.hh:177
gem5::ThermalCapacitor::Params
ThermalCapacitorParams Params
Definition: thermal_model.hh:92
sim_object.hh
gem5::ThermalResistor::_resistance
const double _resistance
Definition: thermal_model.hh:79
gem5::ArmISA::d
Bitfield< 9 > d
Definition: misc_types.hh:63
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::ThermalModel::ThermalModel
ThermalModel(const Params &p)
ThermalModel.
Definition: thermal_model.cc:145
gem5::ThermalNode
A ThermalNode is used to connect thermal entities, such as resistors, capacitors, references and doma...
Definition: thermal_node.hh:54
gem5::ThermalModel::doStep
void doStep()
Definition: thermal_model.cc:151
gem5::ThermalModel::references
std::vector< ThermalReference * > references
Definition: thermal_model.hh:166
gem5::LinearEquation
This class describes a linear equation with constant coefficients.
Definition: linear_solver.hh:55
gem5::ThermalEntity
An abstract class that represents any thermal entity which is used in the circuital thermal equivalen...
Definition: thermal_entity.hh:54
gem5::ThermalReference
A ThermalReference is a thermal domain with fixed temperature.
Definition: thermal_model.hh:114
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::ArmISA::c
Bitfield< 29 > c
Definition: misc_types.hh:53
thermal_domain.hh
gem5::ThermalCapacitor::node2
ThermalNode * node2
Definition: thermal_model.hh:107
gem5::ThermalResistor::node1
ThermalNode * node1
Definition: thermal_model.hh:81
gem5::ThermalModel::capacitors
std::vector< ThermalCapacitor * > capacitors
Definition: thermal_model.hh:167
gem5::ClockedObject
The ClockedObject class extends the SimObject with a clock and accessor functions to relate ticks to ...
Definition: clocked_object.hh:234
gem5::ThermalResistor
A ThermalResistor is used to model a thermal resistance between two thermal domains.
Definition: thermal_model.hh:63
temperature.hh
gem5::EventFunctionWrapper
Definition: eventq.hh:1115
gem5::ThermalModel::entities
std::vector< ThermalEntity * > entities
Definition: thermal_model.hh:170
gem5::ArmISA::n
Bitfield< 31 > n
Definition: misc_types.hh:455
gem5::ThermalDomain
A ThermalDomain is used to group objects under that operate under the same temperature.
Definition: thermal_domain.hh:61
gem5::ThermalModel::getTemperature
Temperature getTemperature() const
Definition: thermal_model.cc:241
gem5::ThermalModel::addDomain
void addDomain(ThermalDomain *d)
Definition: thermal_model.cc:213
clocked_object.hh
gem5::ThermalResistor::setNodes
void setNodes(ThermalNode *n1, ThermalNode *n2)
Definition: thermal_model.hh:69
gem5::ThermalReference::Params
ThermalReferenceParams Params
Definition: thermal_model.hh:117
gem5::ThermalModel::addResistor
void addResistor(ThermalResistor *r)
Definition: thermal_model.cc:234
gem5::MipsISA::r
r
Definition: pra_constants.hh:98
gem5::ThermalReference::_temperature
const Temperature _temperature
Definition: thermal_model.hh:130
gem5::ThermalModel::_step
const double _step
Step in seconds for thermal updates.
Definition: thermal_model.hh:180
gem5::ClockedObject::Params
ClockedObjectParams Params
Parameters of ClockedObject.
Definition: clocked_object.hh:240
gem5::ThermalResistor::node2
ThermalNode * node2
Definition: thermal_model.hh:81
gem5::ThermalCapacitor::setNodes
void setNodes(ThermalNode *n1, ThermalNode *n2)
Definition: thermal_model.hh:98
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::ThermalCapacitor::getEquation
LinearEquation getEquation(ThermalNode *tn, unsigned n, double step) const override
Definition: thermal_model.cc:112
gem5::ThermalCapacitor::ThermalCapacitor
ThermalCapacitor(const Params &p)
ThermalCapacitor.
Definition: thermal_model.cc:106

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