2 * Copyright (c) 2013-2014 ARM Limited
3 * Copyright (c) 2013 Cornell University
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.
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.
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.
38 * Authors: Vasileios Spiliopoulos
42 * Stephan Diestelhorst
48 #include "debug/ClockDomain.hh"
49 #include "params/ClockDomain.hh"
50 #include "params/DerivedClockDomain.hh"
51 #include "params/SrcClockDomain.hh"
52 #include "sim/clock_domain.hh"
53 #include "sim/voltage_domain.hh"
54 #include "sim/clocked_object.hh"
57 ClockDomain::regStats()
59 using namespace Stats
;
61 // Expose the current clock period as a stat for observability in
65 .name(params()->name
+ ".clock")
66 .desc("Clock period in ticks")
71 ClockDomain::voltage() const
73 return _voltageDomain
->voltage();
76 SrcClockDomain::SrcClockDomain(const Params
*p
) :
77 ClockDomain(p
, p
->voltage_domain
),
78 freqOpPoints(p
->clock
),
79 _domainID(p
->domain_id
),
80 _perfLevel(p
->init_perf_level
)
82 VoltageDomain
*vdom
= p
->voltage_domain
;
84 fatal_if(freqOpPoints
.empty(), "DVFS: Empty set of frequencies for "\
85 "domain %d %s\n", _domainID
, name());
87 fatal_if(!vdom
, "DVFS: Empty voltage domain specified for "\
88 "domain %d %s\n", _domainID
, name());
90 fatal_if((vdom
->numVoltages() > 1) &&
91 (vdom
->numVoltages() != freqOpPoints
.size()),
92 "DVFS: Number of frequency and voltage scaling points do "\
93 "not match: %d:%d ID: %d %s.\n", vdom
->numVoltages(),
94 freqOpPoints
.size(), _domainID
, name());
96 // Frequency (& voltage) points should be declared in descending order,
97 // NOTE: Frequency is inverted to ticks, so checking for ascending ticks
98 fatal_if(!std::is_sorted(freqOpPoints
.begin(), freqOpPoints
.end()),
99 "DVFS: Frequency operation points not in descending order for "\
100 "domain with ID %d\n", _domainID
);
102 fatal_if(_perfLevel
>= freqOpPoints
.size(), "DVFS: Initial DVFS point %d "\
103 "is outside of list for Domain ID: %d\n", _perfLevel
, _domainID
);
105 clockPeriod(freqOpPoints
[_perfLevel
]);
107 vdom
->registerSrcClockDom(this);
111 SrcClockDomain::clockPeriod(Tick clock_period
)
113 if (clock_period
== 0) {
114 fatal("%s has a clock period of zero\n", name());
117 // Align all members to the current tick
118 for (auto m
= members
.begin(); m
!= members
.end(); ++m
) {
119 (*m
)->updateClockPeriod();
122 _clockPeriod
= clock_period
;
125 "Setting clock period to %d ticks for source clock %s\n",
126 _clockPeriod
, name());
128 // inform any derived clocks they need to updated their period
129 for (auto c
= children
.begin(); c
!= children
.end(); ++c
) {
130 (*c
)->updateClockPeriod();
135 SrcClockDomain::perfLevel(PerfLevel perf_level
)
137 assert(validPerfLevel(perf_level
));
139 if (perf_level
== _perfLevel
) {
140 // Silently ignore identical overwrites
144 DPRINTF(ClockDomain
, "DVFS: Switching performance level of domain %s "\
145 "(id: %d) from %d to %d\n", name(), domainID(), _perfLevel
,
148 _perfLevel
= perf_level
;
150 // Signal the voltage domain that we have changed our perf level so that the
151 // voltage domain can recompute its performance level
152 voltageDomain()->sanitiseVoltages();
154 // Integrated switching of the actual clock value, too
155 clockPeriod(clkPeriodAtPerfLevel());
159 SrcClockDomain::serialize(std::ostream
&os
)
161 SERIALIZE_SCALAR(_perfLevel
);
162 ClockDomain::serialize(os
);
166 SrcClockDomain::unserialize(Checkpoint
*cp
, const std::string
§ion
)
168 ClockDomain::unserialize(cp
, section
);
169 UNSERIALIZE_SCALAR(_perfLevel
);
173 SrcClockDomain::startup()
175 // Perform proper clock update when all related components have been
176 // created (i.e. after unserialization / object creation)
177 perfLevel(_perfLevel
);
181 SrcClockDomainParams::create()
183 return new SrcClockDomain(this);
186 DerivedClockDomain::DerivedClockDomain(const Params
*p
) :
187 ClockDomain(p
, p
->clk_domain
->voltageDomain()),
188 parent(*p
->clk_domain
),
189 clockDivider(p
->clk_divider
)
191 // Ensure that clock divider setting works as frequency divider and never
192 // work as frequency multiplier
193 if (clockDivider
< 1) {
194 fatal("Clock divider param cannot be less than 1");
197 // let the parent keep track of this derived domain so that it can
199 parent
.addDerivedDomain(this);
201 // update our clock period based on the parents clock
206 DerivedClockDomain::updateClockPeriod()
208 // Align all members to the current tick
209 for (auto m
= members
.begin(); m
!= members
.end(); ++m
) {
210 (*m
)->updateClockPeriod();
213 // recalculate the clock period, relying on the fact that changes
214 // propagate downwards in the tree
215 _clockPeriod
= parent
.clockPeriod() * clockDivider
;
218 "Setting clock period to %d ticks for derived clock %s\n",
219 _clockPeriod
, name());
221 // inform any derived clocks
222 for (auto c
= children
.begin(); c
!= children
.end(); ++c
) {
223 (*c
)->updateClockPeriod();
228 DerivedClockDomainParams::create()
230 return new DerivedClockDomain(this);