111420Sdavid.guillen@arm.com/* 211420Sdavid.guillen@arm.com * Copyright (c) 2015 ARM Limited 311420Sdavid.guillen@arm.com * All rights reserved 411420Sdavid.guillen@arm.com * 511420Sdavid.guillen@arm.com * The license below extends only to copyright in the software and shall 611420Sdavid.guillen@arm.com * not be construed as granting a license to any other intellectual 711420Sdavid.guillen@arm.com * property including but not limited to intellectual property relating 811420Sdavid.guillen@arm.com * to a hardware implementation of the functionality of the software 911420Sdavid.guillen@arm.com * licensed hereunder. You may use the software subject to the license 1011420Sdavid.guillen@arm.com * terms below provided that you ensure that this notice is replicated 1111420Sdavid.guillen@arm.com * unmodified and in its entirety in all distributions of the software, 1211420Sdavid.guillen@arm.com * modified or unmodified, in source code or in binary form. 1311420Sdavid.guillen@arm.com * 1411420Sdavid.guillen@arm.com * Redistribution and use in source and binary forms, with or without 1511420Sdavid.guillen@arm.com * modification, are permitted provided that the following conditions are 1611420Sdavid.guillen@arm.com * met: redistributions of source code must retain the above copyright 1711420Sdavid.guillen@arm.com * notice, this list of conditions and the following disclaimer; 1811420Sdavid.guillen@arm.com * redistributions in binary form must reproduce the above copyright 1911420Sdavid.guillen@arm.com * notice, this list of conditions and the following disclaimer in the 2011420Sdavid.guillen@arm.com * documentation and/or other materials provided with the distribution; 2111420Sdavid.guillen@arm.com * neither the name of the copyright holders nor the names of its 2211420Sdavid.guillen@arm.com * contributors may be used to endorse or promote products derived from 2311420Sdavid.guillen@arm.com * this software without specific prior written permission. 2411420Sdavid.guillen@arm.com * 2511420Sdavid.guillen@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2611420Sdavid.guillen@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2711420Sdavid.guillen@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2811420Sdavid.guillen@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2911420Sdavid.guillen@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3011420Sdavid.guillen@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3111420Sdavid.guillen@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3211420Sdavid.guillen@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3311420Sdavid.guillen@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3411420Sdavid.guillen@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3511420Sdavid.guillen@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3611420Sdavid.guillen@arm.com * 3711420Sdavid.guillen@arm.com * Authors: David Guillen Fandos 3811420Sdavid.guillen@arm.com */ 3911420Sdavid.guillen@arm.com 4011420Sdavid.guillen@arm.com#ifndef __SIM_THERMAL_DOMAIN_HH__ 4111420Sdavid.guillen@arm.com#define __SIM_THERMAL_DOMAIN_HH__ 4211420Sdavid.guillen@arm.com 4311420Sdavid.guillen@arm.com#include <vector> 4411420Sdavid.guillen@arm.com 4511420Sdavid.guillen@arm.com#include "base/statistics.hh" 4611420Sdavid.guillen@arm.com#include "params/ThermalDomain.hh" 4711420Sdavid.guillen@arm.com#include "sim/power/thermal_entity.hh" 4811899Sandreas.sandberg@arm.com#include "sim/power/thermal_node.hh" 4911420Sdavid.guillen@arm.com#include "sim/sim_object.hh" 5011899Sandreas.sandberg@arm.com#include "sim/sub_system.hh" 5111420Sdavid.guillen@arm.com 5211800Sbrandon.potter@amd.comtemplate <class T> class ProbePointArg; 5311420Sdavid.guillen@arm.com 5411420Sdavid.guillen@arm.com/** 5511420Sdavid.guillen@arm.com * A ThermalDomain is used to group objects under that operate under 5611420Sdavid.guillen@arm.com * the same temperature. Theses domains can be tied together using thermal 5711420Sdavid.guillen@arm.com * models (such as RC) to model temperature across components. 5811420Sdavid.guillen@arm.com */ 5911420Sdavid.guillen@arm.comclass ThermalDomain : public SimObject, public ThermalEntity 6011420Sdavid.guillen@arm.com{ 6111420Sdavid.guillen@arm.com public: 6211420Sdavid.guillen@arm.com 6311420Sdavid.guillen@arm.com typedef ThermalDomainParams Params; 6411420Sdavid.guillen@arm.com ThermalDomain(const Params *p); 6511420Sdavid.guillen@arm.com 6611420Sdavid.guillen@arm.com /** 6711420Sdavid.guillen@arm.com * Get the startup temperature. 6811420Sdavid.guillen@arm.com * 6911420Sdavid.guillen@arm.com * @return Initial temperature of the domain 7011420Sdavid.guillen@arm.com */ 7111420Sdavid.guillen@arm.com double initialTemperature() const { return _initTemperature; } 7211420Sdavid.guillen@arm.com 7311420Sdavid.guillen@arm.com /** 7411420Sdavid.guillen@arm.com * Get the current temperature. 7511420Sdavid.guillen@arm.com * 7611420Sdavid.guillen@arm.com * @return Initial temperature of the domain 7711420Sdavid.guillen@arm.com */ 7811420Sdavid.guillen@arm.com double currentTemperature() const; 7911420Sdavid.guillen@arm.com 8011420Sdavid.guillen@arm.com /** Set/Get circuit node associated with this domain */ 8111420Sdavid.guillen@arm.com void setNode(ThermalNode * n) { node = n; } 8211420Sdavid.guillen@arm.com ThermalNode * getNode() const { return node; } 8311420Sdavid.guillen@arm.com 8411420Sdavid.guillen@arm.com /** Get nodal equation imposed by this node */ 8511420Sdavid.guillen@arm.com LinearEquation getEquation(ThermalNode * tn, unsigned n, 8611442Sandreas.hansson@arm.com double step) const override; 8711420Sdavid.guillen@arm.com 8811420Sdavid.guillen@arm.com /** 8911420Sdavid.guillen@arm.com * Emit a temperature update through probe points interface 9011420Sdavid.guillen@arm.com */ 9111420Sdavid.guillen@arm.com void emitUpdate(); 9211420Sdavid.guillen@arm.com 9311420Sdavid.guillen@arm.com /** 9411420Sdavid.guillen@arm.com * Set the SubSystem reference we belong to 9511420Sdavid.guillen@arm.com */ 9611420Sdavid.guillen@arm.com void setSubSystem(SubSystem * ss); 9711420Sdavid.guillen@arm.com 9811442Sandreas.hansson@arm.com void regStats() override; 9911420Sdavid.guillen@arm.com void serialize(CheckpointOut &cp) const override; 10011420Sdavid.guillen@arm.com void unserialize(CheckpointIn &cp) override; 10111420Sdavid.guillen@arm.com 10211420Sdavid.guillen@arm.com private: 10311420Sdavid.guillen@arm.com double _initTemperature; 10411420Sdavid.guillen@arm.com ThermalNode * node; 10511420Sdavid.guillen@arm.com SubSystem * subsystem; 10611420Sdavid.guillen@arm.com 10711420Sdavid.guillen@arm.com /** Stat for reporting voltage of the domain */ 10811420Sdavid.guillen@arm.com Stats::Value currentTemp; 10911420Sdavid.guillen@arm.com 11011420Sdavid.guillen@arm.com /** Probe to signal for temperature changes in this domain */ 11111420Sdavid.guillen@arm.com ProbePointArg<double> *ppThermalUpdate; 11211420Sdavid.guillen@arm.com 11311420Sdavid.guillen@arm.com}; 11411420Sdavid.guillen@arm.com 11511420Sdavid.guillen@arm.com#endif 116