voltage_domain.hh revision 10022:db307bac42fc
1/* 2 * Copyright (c) 2012 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: Vasileios Spiliopoulos 38 * Akash Bagdia 39 */ 40 41#ifndef __SIM_VOLTAGE_DOMAIN_HH__ 42#define __SIM_VOLTAGE_DOMAIN_HH__ 43 44#include "base/statistics.hh" 45#include "params/VoltageDomain.hh" 46#include "sim/sim_object.hh" 47 48/** 49 * A VoltageDomain is used to group clock domains that operate under 50 * the same voltage. The class provides methods for setting and 51 * getting the voltage. 52 */ 53class VoltageDomain : public SimObject 54{ 55 56 private: 57 58 /** 59 * The voltage of the domain expressed in Volts 60 */ 61 double _voltage; 62 63 /** 64 * Stat for reporting voltage of the domain 65 */ 66 Stats::Value currentVoltage; 67 68 public: 69 70 typedef VoltageDomainParams Params; 71 VoltageDomain(const Params *p); 72 73 /** 74 * Get the current volate. 75 * 76 * @return Voltage of the domain 77 */ 78 inline double voltage() const { return _voltage; } 79 80 /** 81 * Set the voltage of the domain. 82 * 83 * @param Voltage value to be set 84 */ 85 void voltage(double voltage); 86 87 void regStats(); 88 89}; 90 91#endif 92