sim,misc: Rename M5OP_ANNOTATE to M5OP_RESERVED1.
[gem5.git] / src / sim / DVFSHandler.py
1 # Copyright (c) 2013-2014 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 from m5.params import *
37 from m5.SimObject import SimObject
38 from m5.proxy import *
39
40 # The handler in its current form is design to be centeralized, one per system
41 # and manages all the source clock domains (SrcClockDomain) it is configured to
42 # handle. The specific voltage and frequency points are configured per clock
43 # and voltage domain.
44 class DVFSHandler(SimObject):
45 type = 'DVFSHandler'
46 cxx_header = "sim/dvfs_handler.hh"
47
48 # List of controllable clock domains which in turn reference the appropriate
49 # voltage domains
50 domains = VectorParam.SrcClockDomain([], "list of domains")
51
52 # System domain (its clock and voltage) is not controllable
53 sys_clk_domain = Param.SrcClockDomain(Parent.clk_domain,
54 "Clk domain in which the handler is instantiated")
55
56 enable = Param.Bool(False, "Enable/Disable the handler")
57
58 # The transition latency depends on how much time the PLLs and voltage
59 # regualators takes to migrate from current levels to the new level, is
60 # usally variable and hardware implementation dependent. In order to
61 # accomodate this effect with ease, we provide a fixed transition latency
62 # associated with all migrations. Configure this to maximum latency that
63 # the hardware will take to migratate between any two perforamnce levels.
64 transition_latency = Param.Latency('100us',
65 "fixed latency for perf level migration")