ClockedObject.py revision 11527
15529Snate@binkert.org# Copyright (c) 2012, 2015-2016 ARM Limited 25529Snate@binkert.org# All rights reserved. 35529Snate@binkert.org# 45529Snate@binkert.org# The license below extends only to copyright in the software and shall 55529Snate@binkert.org# not be construed as granting a license to any other intellectual 65529Snate@binkert.org# property including but not limited to intellectual property relating 75529Snate@binkert.org# to a hardware implementation of the functionality of the software 85529Snate@binkert.org# licensed hereunder. You may use the software subject to the license 95529Snate@binkert.org# terms below provided that you ensure that this notice is replicated 105529Snate@binkert.org# unmodified and in its entirety in all distributions of the software, 115529Snate@binkert.org# modified or unmodified, in source code or in binary form. 125529Snate@binkert.org# 135529Snate@binkert.org# Redistribution and use in source and binary forms, with or without 145529Snate@binkert.org# modification, are permitted provided that the following conditions are 155529Snate@binkert.org# met: redistributions of source code must retain the above copyright 165529Snate@binkert.org# notice, this list of conditions and the following disclaimer; 175529Snate@binkert.org# redistributions in binary form must reproduce the above copyright 185529Snate@binkert.org# notice, this list of conditions and the following disclaimer in the 195529Snate@binkert.org# documentation and/or other materials provided with the distribution; 205529Snate@binkert.org# neither the name of the copyright holders nor the names of its 215529Snate@binkert.org# contributors may be used to endorse or promote products derived from 225529Snate@binkert.org# this software without specific prior written permission. 235529Snate@binkert.org# 245529Snate@binkert.org# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 255529Snate@binkert.org# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 265529Snate@binkert.org# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 275529Snate@binkert.org# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 285529Snate@binkert.org# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 295529Snate@binkert.org# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 305529Snate@binkert.org# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 315529Snate@binkert.org# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 325529Snate@binkert.org# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 335529Snate@binkert.org# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 345529Snate@binkert.org# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 355529Snate@binkert.org# 365529Snate@binkert.org# Authors: Andreas Hansson 375529Snate@binkert.org 385529Snate@binkert.orgfrom m5.SimObject import SimObject 395529Snate@binkert.orgfrom m5.params import * 405529Snate@binkert.orgfrom m5.proxy import * 415529Snate@binkert.org 425529Snate@binkert.org# Enumerate set of allowed power states that can be used by a clocked object. 435529Snate@binkert.org# The list is kept generic to express a base minimal set. 445529Snate@binkert.org# State definition :- 45# Undefined: Invalid state, no power state derived information is available. 46# On: The logic block is actively running and consuming dynamic and leakage 47# energy depending on the amount of processing required. 48# Clk_gated: The clock circuity within the block is gated to save dynamic 49# energy, the power supply to the block is still on and leakage 50# energy is being consumed by the block. 51# Sram_retention: The SRAMs within the logic blocks are pulled into retention 52# state to reduce leakage energy further. 53# Off: The logic block is power gated and is not consuming any energy. 54class PwrState(Enum): vals = ['UNDEFINED', 55 'ON', 56 'CLK_GATED', 57 'SRAM_RETENTION', 58 'OFF'] 59 60class ClockedObject(SimObject): 61 type = 'ClockedObject' 62 abstract = True 63 cxx_header = "sim/clocked_object.hh" 64 65 # The clock domain this clocked object belongs to, inheriting the 66 # parent's clock domain by default 67 clk_domain = Param.ClockDomain(Parent.clk_domain, "Clock domain") 68 69 # Power model for this ClockedObject 70 power_model = Param.PowerModel(NULL, "Power model") 71 72 # Provide initial power state, should ideally get redefined in startup 73 # routine 74 default_p_state = Param.PwrState("UNDEFINED", "Default Power State") 75 76 p_state_clk_gate_min = Param.Latency('1ns',"Min value of the distribution") 77 p_state_clk_gate_max = Param.Latency('1s',"Max value of the distribution") 78 p_state_clk_gate_bins = Param.Unsigned('20', 79 "# bins in clk gated distribution") 80