gem5  v21.1.0.2
thermal_domain.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_DOMAIN_HH__
39 #define __SIM_THERMAL_DOMAIN_HH__
40 
41 #include <vector>
42 
43 #include "base/statistics.hh"
44 #include "base/temperature.hh"
45 #include "params/ThermalDomain.hh"
48 #include "sim/sim_object.hh"
49 #include "sim/sub_system.hh"
50 
51 namespace gem5
52 {
53 
54 template <class T> class ProbePointArg;
55 
61 class ThermalDomain : public SimObject, public ThermalEntity
62 {
63  public:
64 
65  typedef ThermalDomainParams Params;
66  ThermalDomain(const Params &p);
67 
74 
81 
83  void setNode(ThermalNode * n) { node = n; }
84  ThermalNode * getNode() const { return node; }
85 
87  LinearEquation getEquation(ThermalNode * tn, unsigned n,
88  double step) const override;
89 
93  void emitUpdate();
94 
98  void setSubSystem(SubSystem * ss);
99 
100  private:
104 
107 
110 
111 };
112 
113 } // namespace gem5
114 
115 #endif
gem5::ThermalDomain::subsystem
SubSystem * subsystem
Definition: thermal_domain.hh:103
gem5::ThermalDomain::currentTemp
statistics::Value currentTemp
Stat for reporting voltage of the domain.
Definition: thermal_domain.hh:106
gem5::ThermalDomain::getNode
ThermalNode * getNode() const
Definition: thermal_domain.hh:84
gem5::ThermalDomain::setNode
void setNode(ThermalNode *n)
Set/Get circuit node associated with this domain.
Definition: thermal_domain.hh:83
thermal_entity.hh
gem5::Temperature
The class stores temperatures in Kelvin and provides helper methods to convert to/from Celsius.
Definition: temperature.hh:50
gem5::ThermalDomain::Params
ThermalDomainParams Params
Definition: thermal_domain.hh:65
gem5::ThermalDomain::node
ThermalNode * node
Definition: thermal_domain.hh:102
gem5::SubSystem
The SubSystem simobject does nothing, it is just a container for other simobjects used by the configu...
Definition: sub_system.hh:60
thermal_node.hh
sim_object.hh
gem5::ThermalDomain::currentTemperature
Temperature currentTemperature() const
Get the current temperature.
Definition: thermal_domain.cc:64
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
statistics.hh
gem5::ThermalNode
A ThermalNode is used to connect thermal entities, such as resistors, capacitors, references and doma...
Definition: thermal_node.hh:54
gem5::LinearEquation
This class describes a linear equation with constant coefficients.
Definition: linear_solver.hh:55
ss
std::stringstream ss
Definition: trace.test.cc:45
gem5::ThermalEntity
An abstract class that represents any thermal entity which is used in the circuital thermal equivalen...
Definition: thermal_entity.hh:54
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::ThermalDomain::initialTemperature
Temperature initialTemperature() const
Get the startup temperature.
Definition: thermal_domain.hh:73
gem5::ThermalDomain::setSubSystem
void setSubSystem(SubSystem *ss)
Set the SubSystem reference we belong to.
Definition: thermal_domain.cc:70
temperature.hh
gem5::ProbePointArg
ProbePointArg generates a point for the class of Arg.
Definition: thermal_domain.hh:54
gem5::ThermalDomain::ppThermalUpdate
ProbePointArg< Temperature > * ppThermalUpdate
Probe to signal for temperature changes in this domain.
Definition: thermal_domain.hh:109
sub_system.hh
gem5::ThermalDomain::ThermalDomain
ThermalDomain(const Params &p)
Definition: thermal_domain.cc:54
gem5::ThermalDomain::emitUpdate
void emitUpdate()
Emit a temperature update through probe points interface.
Definition: thermal_domain.cc:80
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::ThermalDomain::_initTemperature
const Temperature _initTemperature
Definition: thermal_domain.hh:101
gem5::statistics::Value
Definition: statistics.hh:1979
gem5::ThermalDomain::getEquation
LinearEquation getEquation(ThermalNode *tn, unsigned n, double step) const override
Get nodal equation imposed by this node.
Definition: thermal_domain.cc:87
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40

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