gem5  v22.1.0.0
clock_domain.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014, 2019 ARM Limited
3  * Copyright (c) 2013 Cornell University
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 
44 #ifndef __SIM_CLOCK_DOMAIN_HH__
45 #define __SIM_CLOCK_DOMAIN_HH__
46 
47 #include <algorithm>
48 
49 #include "base/statistics.hh"
50 #include "params/ClockDomain.hh"
51 #include "params/DerivedClockDomain.hh"
52 #include "params/SrcClockDomain.hh"
53 #include "sim/sim_object.hh"
54 
55 namespace gem5
56 {
57 
61 class DerivedClockDomain;
62 class VoltageDomain;
63 class Clocked;
64 
71 class ClockDomain : public SimObject
72 {
73  protected:
74 
80 
85 
91 
97 
98  public:
99 
100  typedef ClockDomainParams Params;
101  ClockDomain(const Params &p, VoltageDomain *voltage_domain);
102 
108  Tick clockPeriod() const { return _clockPeriod; }
109 
116  {
117  assert(c != NULL);
118  assert(std::find(members.begin(), members.end(), c) == members.end());
119  members.push_back(c);
120  }
121 
127  inline VoltageDomain *voltageDomain() const { return _voltageDomain; }
128 
129 
135  double voltage() const;
136 
143  { children.push_back(clock_domain); }
144 
145  private:
147  {
149 
154  } stats;
155 };
156 
167 {
168 
169  public:
170 
171  typedef SrcClockDomainParams Params;
172  SrcClockDomain(const Params &p);
173 
178  void clockPeriod(Tick clock_period);
179 
180  // Explicitly import the otherwise hidden clockPeriod
182 
183  typedef int32_t DomainID;
184  static const DomainID emptyDomainID = -1;
185 
189  uint32_t domainID() const { return _domainID; }
190 
191  typedef uint32_t PerfLevel;
200  bool validPerfLevel(PerfLevel perf_level) const {
201  return perf_level < numPerfLevels();
202  }
203 
209  void perfLevel(PerfLevel perf_level);
210 
214  PerfLevel perfLevel() const { return _perfLevel; }
215 
221  PerfLevel numPerfLevels() const {return freqOpPoints.size();}
222 
228 
230  {
231  assert(validPerfLevel(perf_level));
232  return freqOpPoints[perf_level];
233  }
234 
235  void startup() override;
236 
237  void serialize(CheckpointOut &cp) const override;
238  void unserialize(CheckpointIn &cp) override;
239 
240  private:
244  void signalPerfLevelUpdate();
245 
253 
258  const uint32_t _domainID;
259 
267 };
268 
276 {
277 
278  public:
279 
280  typedef DerivedClockDomainParams Params;
281  DerivedClockDomain(const Params &p);
282 
288  void updateClockPeriod();
289 
290  private:
291 
297 
301  const uint64_t clockDivider;
302 };
303 
304 } // namespace gem5
305 
306 #endif
The ClockDomain provides clock to group of clocked objects bundled under the same clock domain.
Definition: clock_domain.hh:72
ClockDomainParams Params
VoltageDomain * _voltageDomain
Voltage domain this clock domain belongs to.
Definition: clock_domain.hh:84
VoltageDomain * voltageDomain() const
Get the voltage domain.
std::vector< DerivedClockDomain * > children
Pointers to potential derived clock domains so we can propagate changes.
Definition: clock_domain.hh:90
ClockDomain(const Params &p, VoltageDomain *voltage_domain)
Definition: clock_domain.cc:66
Tick _clockPeriod
Pre-computed clock period in ticks.
Definition: clock_domain.hh:79
Tick clockPeriod() const
Get the clock period.
std::vector< Clocked * > members
Pointers to members of this clock domain, so that when the clock period changes, we can update each m...
Definition: clock_domain.hh:96
void registerWithClockDomain(Clocked *c)
Register a Clocked object with this ClockDomain.
void addDerivedDomain(DerivedClockDomain *clock_domain)
Add a derived domain.
double voltage() const
Get the current voltage this clock domain operates at.
Definition: clock_domain.cc:75
gem5::ClockDomain::ClockDomainStats stats
Helper class for objects that need to be clocked.
The derived clock domains provides the notion of a clock domain that is connected to a parent clock d...
DerivedClockDomainParams Params
const uint64_t clockDivider
Local clock divider of the domain.
DerivedClockDomain(const Params &p)
ClockDomain & parent
Reference to the parent clock domain this clock domain derives its clock period from.
void updateClockPeriod()
Called by the parent clock domain to propagate changes.
Abstract superclass for simulation objects.
Definition: sim_object.hh:148
The source clock domains provides the notion of a clock domain that is connected to a tunable clock s...
bool validPerfLevel(PerfLevel perf_level) const
Checks whether the performance level requested exists in the current domain configuration.
Tick clkPeriodAtPerfLevel() const
const uint32_t _domainID
Software recognizable id number for the domain, should be unique for each domain.
Tick clkPeriodAtPerfLevel(PerfLevel perf_level) const
const std::vector< Tick > freqOpPoints
List of possible frequency operational points, should be in descending order An empty list correspond...
static const DomainID emptyDomainID
SrcClockDomainParams Params
void signalPerfLevelUpdate()
Inform other components about the changed performance level.
uint32_t domainID() const
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Tick clockPeriod() const
Get the clock period.
PerfLevel numPerfLevels() const
Get the number of available performance levels for this clock domain.
void startup() override
startup() is the final initialization call before simulation.
void serialize(CheckpointOut &cp) const override
Serialize an object.
PerfLevel _perfLevel
Current performance level the domain is set to.
SrcClockDomain(const Params &p)
Definition: clock_domain.cc:80
PerfLevel perfLevel() const
A VoltageDomain is used to group clock domains that operate under the same voltage.
Statistics container.
Definition: group.hh:94
STL vector class.
Definition: stl.hh:37
Bitfield< 32 > cd
Definition: misc_types.hh:258
Bitfield< 2 > c
Definition: pagetable.hh:63
Bitfield< 54 > p
Definition: pagetable.hh:70
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
std::ostream CheckpointOut
Definition: serialize.hh:66
uint64_t Tick
Tick count type.
Definition: types.hh:58
Declaration of Statistics objects.
statistics::Value clock
Stat to report clock period of clock domain.

Generated on Wed Dec 21 2022 10:22:39 for gem5 by doxygen 1.9.1