Akash Bagdia | 7d7ab73 | 2013-06-27 05:49:49 -0400 | [diff] [blame] | 1 | /* |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 2 | * Copyright (c) 2013-2014 ARM Limited |
Christopher Torng | b4b03a6 | 2013-12-29 19:29:45 -0600 | [diff] [blame] | 3 | * Copyright (c) 2013 Cornell University |
Akash Bagdia | 7d7ab73 | 2013-06-27 05:49:49 -0400 | [diff] [blame] | 4 | * All rights reserved |
| 5 | * |
| 6 | * The license below extends only to copyright in the software and shall |
| 7 | * not be construed as granting a license to any other intellectual |
| 8 | * property including but not limited to intellectual property relating |
| 9 | * to a hardware implementation of the functionality of the software |
| 10 | * licensed hereunder. You may use the software subject to the license |
| 11 | * terms below provided that you ensure that this notice is replicated |
| 12 | * unmodified and in its entirety in all distributions of the software, |
| 13 | * modified or unmodified, in source code or in binary form. |
| 14 | * |
| 15 | * Redistribution and use in source and binary forms, with or without |
| 16 | * modification, are permitted provided that the following conditions are |
| 17 | * met: redistributions of source code must retain the above copyright |
| 18 | * notice, this list of conditions and the following disclaimer; |
| 19 | * redistributions in binary form must reproduce the above copyright |
| 20 | * notice, this list of conditions and the following disclaimer in the |
| 21 | * documentation and/or other materials provided with the distribution; |
| 22 | * neither the name of the copyright holders nor the names of its |
| 23 | * contributors may be used to endorse or promote products derived from |
| 24 | * this software without specific prior written permission. |
| 25 | * |
| 26 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 27 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 28 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 29 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 30 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 31 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 32 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 33 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 34 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 35 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 36 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 37 | * |
| 38 | * Authors: Vasileios Spiliopoulos |
| 39 | * Akash Bagdia |
| 40 | * Andreas Hansson |
Christopher Torng | b4b03a6 | 2013-12-29 19:29:45 -0600 | [diff] [blame] | 41 | * Christopher Torng |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 42 | * Stephan Diestelhorst |
Akash Bagdia | 7d7ab73 | 2013-06-27 05:49:49 -0400 | [diff] [blame] | 43 | */ |
| 44 | |
Brandon Potter | 7a8dda4 | 2016-11-09 14:27:37 -0600 | [diff] [blame] | 45 | #include "sim/clock_domain.hh" |
| 46 | |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 47 | #include <algorithm> |
| 48 | #include <functional> |
| 49 | |
Brandon Potter | a928a43 | 2016-11-09 14:27:40 -0600 | [diff] [blame] | 50 | #include "base/trace.hh" |
Akash Bagdia | 7d7ab73 | 2013-06-27 05:49:49 -0400 | [diff] [blame] | 51 | #include "debug/ClockDomain.hh" |
| 52 | #include "params/ClockDomain.hh" |
| 53 | #include "params/DerivedClockDomain.hh" |
| 54 | #include "params/SrcClockDomain.hh" |
Christopher Torng | b4b03a6 | 2013-12-29 19:29:45 -0600 | [diff] [blame] | 55 | #include "sim/clocked_object.hh" |
Brandon Potter | 7a8dda4 | 2016-11-09 14:27:37 -0600 | [diff] [blame] | 56 | #include "sim/voltage_domain.hh" |
Akash Bagdia | 7d7ab73 | 2013-06-27 05:49:49 -0400 | [diff] [blame] | 57 | |
Andreas Hansson | 1d85e91 | 2014-01-24 15:29:30 -0600 | [diff] [blame] | 58 | void |
| 59 | ClockDomain::regStats() |
| 60 | { |
David Guillen Fandos | 70798b1 | 2016-06-06 17:16:43 +0100 | [diff] [blame] | 61 | SimObject::regStats(); |
| 62 | |
Andreas Hansson | 1d85e91 | 2014-01-24 15:29:30 -0600 | [diff] [blame] | 63 | using namespace Stats; |
| 64 | |
| 65 | // Expose the current clock period as a stat for observability in |
| 66 | // the dumps |
| 67 | currentClock |
| 68 | .scalar(_clockPeriod) |
| 69 | .name(params()->name + ".clock") |
| 70 | .desc("Clock period in ticks") |
| 71 | ; |
| 72 | } |
| 73 | |
Akash Bagdia | e7e17f9 | 2013-08-19 03:52:28 -0400 | [diff] [blame] | 74 | double |
| 75 | ClockDomain::voltage() const |
| 76 | { |
| 77 | return _voltageDomain->voltage(); |
| 78 | } |
| 79 | |
| 80 | SrcClockDomain::SrcClockDomain(const Params *p) : |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 81 | ClockDomain(p, p->voltage_domain), |
| 82 | freqOpPoints(p->clock), |
| 83 | _domainID(p->domain_id), |
| 84 | _perfLevel(p->init_perf_level) |
Akash Bagdia | 7d7ab73 | 2013-06-27 05:49:49 -0400 | [diff] [blame] | 85 | { |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 86 | VoltageDomain *vdom = p->voltage_domain; |
| 87 | |
| 88 | fatal_if(freqOpPoints.empty(), "DVFS: Empty set of frequencies for "\ |
| 89 | "domain %d %s\n", _domainID, name()); |
| 90 | |
| 91 | fatal_if(!vdom, "DVFS: Empty voltage domain specified for "\ |
| 92 | "domain %d %s\n", _domainID, name()); |
| 93 | |
| 94 | fatal_if((vdom->numVoltages() > 1) && |
| 95 | (vdom->numVoltages() != freqOpPoints.size()), |
| 96 | "DVFS: Number of frequency and voltage scaling points do "\ |
| 97 | "not match: %d:%d ID: %d %s.\n", vdom->numVoltages(), |
| 98 | freqOpPoints.size(), _domainID, name()); |
| 99 | |
| 100 | // Frequency (& voltage) points should be declared in descending order, |
| 101 | // NOTE: Frequency is inverted to ticks, so checking for ascending ticks |
| 102 | fatal_if(!std::is_sorted(freqOpPoints.begin(), freqOpPoints.end()), |
| 103 | "DVFS: Frequency operation points not in descending order for "\ |
| 104 | "domain with ID %d\n", _domainID); |
| 105 | |
| 106 | fatal_if(_perfLevel >= freqOpPoints.size(), "DVFS: Initial DVFS point %d "\ |
| 107 | "is outside of list for Domain ID: %d\n", _perfLevel, _domainID); |
| 108 | |
| 109 | clockPeriod(freqOpPoints[_perfLevel]); |
| 110 | |
| 111 | vdom->registerSrcClockDom(this); |
Akash Bagdia | 7d7ab73 | 2013-06-27 05:49:49 -0400 | [diff] [blame] | 112 | } |
| 113 | |
| 114 | void |
| 115 | SrcClockDomain::clockPeriod(Tick clock_period) |
| 116 | { |
| 117 | if (clock_period == 0) { |
| 118 | fatal("%s has a clock period of zero\n", name()); |
| 119 | } |
| 120 | |
Christopher Torng | b4b03a6 | 2013-12-29 19:29:45 -0600 | [diff] [blame] | 121 | // Align all members to the current tick |
| 122 | for (auto m = members.begin(); m != members.end(); ++m) { |
| 123 | (*m)->updateClockPeriod(); |
| 124 | } |
| 125 | |
Akash Bagdia | 7d7ab73 | 2013-06-27 05:49:49 -0400 | [diff] [blame] | 126 | _clockPeriod = clock_period; |
| 127 | |
| 128 | DPRINTF(ClockDomain, |
| 129 | "Setting clock period to %d ticks for source clock %s\n", |
| 130 | _clockPeriod, name()); |
| 131 | |
| 132 | // inform any derived clocks they need to updated their period |
| 133 | for (auto c = children.begin(); c != children.end(); ++c) { |
| 134 | (*c)->updateClockPeriod(); |
| 135 | } |
| 136 | } |
| 137 | |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 138 | void |
| 139 | SrcClockDomain::perfLevel(PerfLevel perf_level) |
| 140 | { |
| 141 | assert(validPerfLevel(perf_level)); |
| 142 | |
Stephan Diestelhorst | 4422d13 | 2014-06-16 14:59:44 +0100 | [diff] [blame] | 143 | if (perf_level == _perfLevel) { |
| 144 | // Silently ignore identical overwrites |
| 145 | return; |
| 146 | } |
| 147 | |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 148 | DPRINTF(ClockDomain, "DVFS: Switching performance level of domain %s "\ |
| 149 | "(id: %d) from %d to %d\n", name(), domainID(), _perfLevel, |
| 150 | perf_level); |
| 151 | |
| 152 | _perfLevel = perf_level; |
| 153 | |
Sascha Bischoff | ebc9e1d | 2016-04-01 16:22:44 +0100 | [diff] [blame] | 154 | signalPerfLevelUpdate(); |
| 155 | } |
| 156 | |
| 157 | void SrcClockDomain::signalPerfLevelUpdate() |
| 158 | { |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 159 | // Signal the voltage domain that we have changed our perf level so that the |
| 160 | // voltage domain can recompute its performance level |
| 161 | voltageDomain()->sanitiseVoltages(); |
| 162 | |
| 163 | // Integrated switching of the actual clock value, too |
| 164 | clockPeriod(clkPeriodAtPerfLevel()); |
| 165 | } |
| 166 | |
| 167 | void |
Andreas Sandberg | 76cd439 | 2015-07-07 09:51:03 +0100 | [diff] [blame] | 168 | SrcClockDomain::serialize(CheckpointOut &cp) const |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 169 | { |
| 170 | SERIALIZE_SCALAR(_perfLevel); |
Andreas Sandberg | 76cd439 | 2015-07-07 09:51:03 +0100 | [diff] [blame] | 171 | ClockDomain::serialize(cp); |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 172 | } |
| 173 | |
| 174 | void |
Andreas Sandberg | 76cd439 | 2015-07-07 09:51:03 +0100 | [diff] [blame] | 175 | SrcClockDomain::unserialize(CheckpointIn &cp) |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 176 | { |
Andreas Sandberg | 76cd439 | 2015-07-07 09:51:03 +0100 | [diff] [blame] | 177 | ClockDomain::unserialize(cp); |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 178 | UNSERIALIZE_SCALAR(_perfLevel); |
Stephan Diestelhorst | 4422d13 | 2014-06-16 14:59:44 +0100 | [diff] [blame] | 179 | } |
| 180 | |
| 181 | void |
| 182 | SrcClockDomain::startup() |
| 183 | { |
| 184 | // Perform proper clock update when all related components have been |
| 185 | // created (i.e. after unserialization / object creation) |
Sascha Bischoff | ebc9e1d | 2016-04-01 16:22:44 +0100 | [diff] [blame] | 186 | signalPerfLevelUpdate(); |
Stephan Diestelhorst | 65cea47 | 2014-06-30 13:56:06 -0400 | [diff] [blame] | 187 | } |
| 188 | |
Akash Bagdia | 7d7ab73 | 2013-06-27 05:49:49 -0400 | [diff] [blame] | 189 | SrcClockDomain * |
| 190 | SrcClockDomainParams::create() |
| 191 | { |
| 192 | return new SrcClockDomain(this); |
| 193 | } |
| 194 | |
| 195 | DerivedClockDomain::DerivedClockDomain(const Params *p) : |
Akash Bagdia | e7e17f9 | 2013-08-19 03:52:28 -0400 | [diff] [blame] | 196 | ClockDomain(p, p->clk_domain->voltageDomain()), |
Akash Bagdia | 7d7ab73 | 2013-06-27 05:49:49 -0400 | [diff] [blame] | 197 | parent(*p->clk_domain), |
| 198 | clockDivider(p->clk_divider) |
| 199 | { |
| 200 | // Ensure that clock divider setting works as frequency divider and never |
| 201 | // work as frequency multiplier |
| 202 | if (clockDivider < 1) { |
| 203 | fatal("Clock divider param cannot be less than 1"); |
| 204 | } |
| 205 | |
| 206 | // let the parent keep track of this derived domain so that it can |
| 207 | // propagate changes |
| 208 | parent.addDerivedDomain(this); |
| 209 | |
| 210 | // update our clock period based on the parents clock |
| 211 | updateClockPeriod(); |
| 212 | } |
| 213 | |
| 214 | void |
| 215 | DerivedClockDomain::updateClockPeriod() |
| 216 | { |
Christopher Torng | b4b03a6 | 2013-12-29 19:29:45 -0600 | [diff] [blame] | 217 | // Align all members to the current tick |
| 218 | for (auto m = members.begin(); m != members.end(); ++m) { |
| 219 | (*m)->updateClockPeriod(); |
| 220 | } |
| 221 | |
Akash Bagdia | 7d7ab73 | 2013-06-27 05:49:49 -0400 | [diff] [blame] | 222 | // recalculate the clock period, relying on the fact that changes |
| 223 | // propagate downwards in the tree |
| 224 | _clockPeriod = parent.clockPeriod() * clockDivider; |
| 225 | |
| 226 | DPRINTF(ClockDomain, |
| 227 | "Setting clock period to %d ticks for derived clock %s\n", |
| 228 | _clockPeriod, name()); |
| 229 | |
| 230 | // inform any derived clocks |
| 231 | for (auto c = children.begin(); c != children.end(); ++c) { |
| 232 | (*c)->updateClockPeriod(); |
| 233 | } |
| 234 | } |
| 235 | |
| 236 | DerivedClockDomain * |
| 237 | DerivedClockDomainParams::create() |
| 238 | { |
| 239 | return new DerivedClockDomain(this); |
| 240 | } |