2 * Copyright (c) 2012-2014 ARM Limited
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.
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.
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.
37 * Authors: Vasileios Spiliopoulos
39 * Stephan Diestelhorst
42 #include "dev/arm/energy_ctrl.hh"
44 #include "debug/EnergyCtrl.hh"
45 #include "mem/packet.hh"
46 #include "mem/packet_access.hh"
47 #include "params/EnergyCtrl.hh"
48 #include "sim/dvfs_handler.hh"
50 EnergyCtrl::EnergyCtrl(const Params
*p
)
51 : BasicPioDevice(p
, PIO_NUM_FIELDS
* 4), // each field is 32 bit
52 dvfsHandler(p
->dvfs_handler
),
54 domainIDIndexToRead(0),
57 updateAckEvent([this]{ updatePLAck(); }, name())
59 fatal_if(!p
->dvfs_handler
, "EnergyCtrl: Needs a DVFSHandler for a "
60 "functioning system.\n");
64 EnergyCtrl::read(PacketPtr pkt
)
66 assert(pkt
->getAddr() >= pioAddr
&& pkt
->getAddr() < pioAddr
+ pioSize
);
67 assert(pkt
->getSize() == 4);
69 Addr daddr
= pkt
->getAddr() - pioAddr
;
70 assert((daddr
& 3) == 0);
71 Registers reg
= Registers(daddr
/ 4);
73 if (!dvfsHandler
->isEnabled()) {
74 // NB: Zero is a good response if the handler is disabled
75 pkt
->set
<uint32_t>(0);
76 warn_once("EnergyCtrl: Disabled handler, ignoring read from reg %i\n",
78 DPRINTF(EnergyCtrl
, "dvfs handler disabled, return 0 for read from "\
80 pkt
->makeAtomicResponse();
89 case DVFS_HANDLER_STATUS
:
91 DPRINTF(EnergyCtrl
, "dvfs handler enabled\n");
93 case DVFS_NUM_DOMAINS
:
94 result
= dvfsHandler
->numDomains();
95 DPRINTF(EnergyCtrl
, "reading number of domains %d\n", result
);
97 case DVFS_DOMAINID_AT_INDEX
:
98 result
= dvfsHandler
->domainID(domainIDIndexToRead
);
99 DPRINTF(EnergyCtrl
, "reading domain id at index %d as %d\n",
100 domainIDIndexToRead
, result
);
102 case DVFS_HANDLER_TRANS_LATENCY
:
103 // Return transition latency in nanoseconds
104 result
= dvfsHandler
->transLatency() / SimClock::Int::ns
;
105 DPRINTF(EnergyCtrl
, "reading dvfs handler trans latency %d ns\n",
110 DPRINTF(EnergyCtrl
, "reading domain id:%d\n", result
);
113 result
= dvfsHandler
->perfLevel(domainID
);
114 DPRINTF(EnergyCtrl
, "reading domain %d perf level: %d\n",
118 result
= perfLevelAck
;
119 DPRINTF(EnergyCtrl
, "reading ack:%d\n", result
);
120 // Signal is set for a single read only
124 case NUM_OF_PERF_LEVELS
:
125 result
= dvfsHandler
->numPerfLevels(domainID
);
126 DPRINTF(EnergyCtrl
, "reading num of perf level:%d\n", result
);
128 case FREQ_AT_PERF_LEVEL
:
129 period
= dvfsHandler
->clkPeriodAtPerfLevel(domainID
, perfLevelToRead
);
130 result
= ticksTokHz(period
);
131 DPRINTF(EnergyCtrl
, "reading freq %d KHz at perf level: %d\n",
132 result
, perfLevelToRead
);
134 case VOLT_AT_PERF_LEVEL
:
135 voltage
= dvfsHandler
->voltageAtPerfLevel(domainID
, perfLevelToRead
);
136 result
= toMicroVolt(voltage
);
137 DPRINTF(EnergyCtrl
, "reading voltage %d u-volt at perf level: %d\n",
138 result
, perfLevelToRead
);
141 panic("Tried to read EnergyCtrl at offset %#x / reg %i\n", daddr
,
144 pkt
->set
<uint32_t>(result
);
145 pkt
->makeAtomicResponse();
150 EnergyCtrl::write(PacketPtr pkt
)
152 assert(pkt
->getAddr() >= pioAddr
&& pkt
->getAddr() < pioAddr
+ pioSize
);
153 assert(pkt
->getSize() == 4);
156 data
= pkt
->get
<uint32_t>();
158 Addr daddr
= pkt
->getAddr() - pioAddr
;
159 assert((daddr
& 3) == 0);
160 Registers reg
= Registers(daddr
/ 4);
162 if (!dvfsHandler
->isEnabled()) {
163 // Ignore writes to a disabled controller
164 warn_once("EnergyCtrl: Disabled handler, ignoring write %u to "\
165 "reg %i\n", data
, reg
);
166 DPRINTF(EnergyCtrl
, "dvfs handler disabled, ignoring write %u to "\
167 "reg %i\n", data
, reg
);
168 pkt
->makeAtomicResponse();
173 case DVFS_DOMAINID_AT_INDEX
:
174 domainIDIndexToRead
= data
;
175 DPRINTF(EnergyCtrl
, "writing domain id index:%d\n",
176 domainIDIndexToRead
);
179 // Extra check to ensure that a valid domain ID is being queried
180 if (dvfsHandler
->validDomainID(data
)) {
182 DPRINTF(EnergyCtrl
, "writing domain id:%d\n", domainID
);
184 DPRINTF(EnergyCtrl
, "invalid domain id:%d\n", domainID
);
188 if (dvfsHandler
->perfLevel(domainID
, data
)) {
189 if (updateAckEvent
.scheduled()) {
190 // The OS driver is trying to change the perf level while
191 // another change is in flight. This is fine, but only a
192 // single acknowledgment will be sent.
193 DPRINTF(EnergyCtrl
, "descheduling previous pending ack "\
195 deschedule(updateAckEvent
);
197 schedule(updateAckEvent
, curTick() + dvfsHandler
->transLatency());
198 DPRINTF(EnergyCtrl
, "writing domain %d perf level: %d\n",
201 DPRINTF(EnergyCtrl
, "invalid / ineffective perf level:%d for "\
202 "domain:%d\n", data
, domainID
);
205 case PERF_LEVEL_TO_READ
:
206 perfLevelToRead
= data
;
207 DPRINTF(EnergyCtrl
, "writing perf level to read opp at: %d\n",
211 panic("Tried to write EnergyCtrl at offset %#x\n", daddr
);
215 pkt
->makeAtomicResponse();
220 EnergyCtrl::serialize(CheckpointOut
&cp
) const
222 SERIALIZE_SCALAR(domainID
);
223 SERIALIZE_SCALAR(domainIDIndexToRead
);
224 SERIALIZE_SCALAR(perfLevelToRead
);
225 SERIALIZE_SCALAR(perfLevelAck
);
227 Tick next_event
= updateAckEvent
.scheduled() ? updateAckEvent
.when() : 0;
228 SERIALIZE_SCALAR(next_event
);
232 EnergyCtrl::unserialize(CheckpointIn
&cp
)
234 UNSERIALIZE_SCALAR(domainID
);
235 UNSERIALIZE_SCALAR(domainIDIndexToRead
);
236 UNSERIALIZE_SCALAR(perfLevelToRead
);
237 UNSERIALIZE_SCALAR(perfLevelAck
);
239 UNSERIALIZE_SCALAR(next_event
);
241 // restore scheduled events
242 if (next_event
!= 0) {
243 schedule(updateAckEvent
, next_event
);
247 EnergyCtrl
* EnergyCtrlParams::create()
249 return new EnergyCtrl(this);
253 EnergyCtrl::startup()
255 if (!dvfsHandler
->isEnabled()) {
256 warn("Existing EnergyCtrl, but no enabled DVFSHandler found.\n");
263 BasicPioDevice::init();