1 # Copyright (c) 2012, 2015-2017 ARM Limited
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.
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.
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.
37 from m5
.SimObject
import SimObject
38 from m5
.params
import *
39 from m5
.proxy
import *
41 # Enumerate set of allowed power states that can be used by a clocked object.
42 # The list is kept generic to express a base minimal set.
44 # Undefined: Invalid state, no power state derived information is available.
45 # On: The logic block is actively running and consuming dynamic and leakage
46 # energy depending on the amount of processing required.
47 # Clk_gated: The clock circuity within the block is gated to save dynamic
48 # energy, the power supply to the block is still on and leakage
49 # energy is being consumed by the block.
50 # Sram_retention: The SRAMs within the logic blocks are pulled into retention
51 # state to reduce leakage energy further.
52 # Off: The logic block is power gated and is not consuming any energy.
53 class PwrState(Enum
): vals
= [
54 'UNDEFINED', 'ON', 'CLK_GATED', 'SRAM_RETENTION', 'OFF'
57 class PowerState(SimObject
):
59 cxx_header
= "sim/power_state.hh"
61 # Provide initial power state, should ideally get redefined in startup
63 default_state
= Param
.PwrState("UNDEFINED", "Default Power State")
65 # Possible power states this object can be in sorted from the most
66 # to the least performant
67 possible_states
= VectorParam
.PwrState(
68 [], "Power states this object can be in")
70 clk_gate_min
= Param
.Latency('1ns',"Min value of the distribution")
71 clk_gate_max
= Param
.Latency('1s',"Max value of the distribution")
72 clk_gate_bins
= Param
.Unsigned('20', "# bins in clk gated distribution")
74 # The objects which drive the power state of this object. If the list is
75 # empty, the object determines its power state independently.
76 leaders
= VectorParam
.PowerState(
77 [], "Objects which drive the power state of this object")