1# Copyright (c) 2016-2018 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder.  You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Redistribution and use in source and binary forms, with or without
14# modification, are permitted provided that the following conditions are
15# met: redistributions of source code must retain the above copyright
16# notice, this list of conditions and the following disclaimer;
17# redistributions in binary form must reproduce the above copyright
18# notice, this list of conditions and the following disclaimer in the
19# documentation and/or other materials provided with the distribution;
20# neither the name of the copyright holders nor the names of its
21# contributors may be used to endorse or promote products derived from
22# this software without specific prior written permission.
23#
24# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35#
36# Authors: David Guillen Fandos
37
38from m5.SimObject import *
39from m5.params import *
40from m5.proxy import Parent
41
42# Enum for a type of  power model
43class PMType(Enum) : vals = ['All', 'Static', 'Dynamic']
44
45# Represents a power model for a simobj
46# The model itself is also a SimObject so we can make use some
47# nice features available such as Parent.any
48class PowerModel(SimObject):
49    type = 'PowerModel'
50    cxx_header = "sim/power/power_model.hh"
51
52    cxx_exports = [
53        PyBindMethod("getDynamicPower"),
54        PyBindMethod("getStaticPower"),
55    ]
56
57    # Keep a list of every model for every power state
58    pm = VectorParam.PowerModelState([], "List of per-state power models.")
59
60    # Need a reference to the system so we can query the thermal domain
61    # about temperature (temperature is needed for leakage calculation)
62    subsystem = Param.SubSystem(Parent.any, "subsystem")
63
64    # Type of power model
65    pm_type = Param.PMType("All", "Type of power model")
66
67    # Ambient temperature to be used when no thermal model is present
68    ambient_temp = Param.Float(25.0, "Ambient temperature")
69