1/*
2 * Copyright (c) 2015 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 * Authors: David Guillen Fandos
38 */
39
40#ifndef __SIM_THERMAL_DOMAIN_HH__
41#define __SIM_THERMAL_DOMAIN_HH__
42
43#include <vector>
44
45#include "base/statistics.hh"
46#include "params/ThermalDomain.hh"
47#include "sim/power/thermal_entity.hh"
48#include "sim/power/thermal_node.hh"
49#include "sim/sim_object.hh"
50#include "sim/sub_system.hh"
51
52template <class T> class ProbePointArg;
53
54/**
55 * A ThermalDomain is used to group objects under that operate under
56 * the same temperature. Theses domains can be tied together using thermal
57 * models (such as RC) to model temperature across components.
58 */
59class ThermalDomain : public SimObject, public ThermalEntity
60{
61  public:
62
63    typedef ThermalDomainParams Params;
64    ThermalDomain(const Params *p);
65
66    /**
67     * Get the startup temperature.
68     *
69     * @return Initial temperature of the domain
70     */
71    double initialTemperature() const { return _initTemperature; }
72
73    /**
74     * Get the current temperature.
75     *
76     * @return Initial temperature of the domain
77     */
78    double currentTemperature() const;
79
80    /** Set/Get circuit node associated with this domain */
81    void setNode(ThermalNode * n) { node = n; }
82    ThermalNode * getNode() const { return node; }
83
84    /** Get nodal equation imposed by this node */
85    LinearEquation getEquation(ThermalNode * tn, unsigned n,
86                               double step) const override;
87
88    /**
89      *  Emit a temperature update through probe points interface
90      */
91    void emitUpdate();
92
93    /**
94      *  Set the SubSystem reference we belong to
95      */
96    void setSubSystem(SubSystem * ss);
97
98    void regStats() override;
99    void serialize(CheckpointOut &cp) const override;
100    void unserialize(CheckpointIn &cp) override;
101
102  private:
103    double _initTemperature;
104    ThermalNode * node;
105    SubSystem * subsystem;
106
107    /** Stat for reporting voltage of the domain */
108    Stats::Value currentTemp;
109
110    /** Probe to signal for temperature changes in this domain */
111    ProbePointArg<double> *ppThermalUpdate;
112
113};
114
115#endif
116