2 * Copyright (c) 2013 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
42 #include "debug/ClockDomain.hh"
43 #include "params/ClockDomain.hh"
44 #include "params/DerivedClockDomain.hh"
45 #include "params/SrcClockDomain.hh"
46 #include "sim/clock_domain.hh"
47 #include "sim/voltage_domain.hh"
50 ClockDomain::voltage() const
52 return _voltageDomain
->voltage();
55 SrcClockDomain::SrcClockDomain(const Params
*p
) :
56 ClockDomain(p
, p
->voltage_domain
)
58 clockPeriod(p
->clock
);
62 SrcClockDomain::clockPeriod(Tick clock_period
)
64 if (clock_period
== 0) {
65 fatal("%s has a clock period of zero\n", name());
68 _clockPeriod
= clock_period
;
71 "Setting clock period to %d ticks for source clock %s\n",
72 _clockPeriod
, name());
74 // inform any derived clocks they need to updated their period
75 for (auto c
= children
.begin(); c
!= children
.end(); ++c
) {
76 (*c
)->updateClockPeriod();
81 SrcClockDomainParams::create()
83 return new SrcClockDomain(this);
86 DerivedClockDomain::DerivedClockDomain(const Params
*p
) :
87 ClockDomain(p
, p
->clk_domain
->voltageDomain()),
88 parent(*p
->clk_domain
),
89 clockDivider(p
->clk_divider
)
91 // Ensure that clock divider setting works as frequency divider and never
92 // work as frequency multiplier
93 if (clockDivider
< 1) {
94 fatal("Clock divider param cannot be less than 1");
97 // let the parent keep track of this derived domain so that it can
99 parent
.addDerivedDomain(this);
101 // update our clock period based on the parents clock
106 DerivedClockDomain::updateClockPeriod()
108 // recalculate the clock period, relying on the fact that changes
109 // propagate downwards in the tree
110 _clockPeriod
= parent
.clockPeriod() * clockDivider
;
113 "Setting clock period to %d ticks for derived clock %s\n",
114 _clockPeriod
, name());
116 // inform any derived clocks
117 for (auto c
= children
.begin(); c
!= children
.end(); ++c
) {
118 (*c
)->updateClockPeriod();
123 DerivedClockDomainParams::create()
125 return new DerivedClockDomain(this);