clock_domain.hh (9827:f47274776aa0) clock_domain.hh (10000:99bd071911cf)
1/*
2 * Copyright (c) 2013 ARM Limited
1/*
2 * Copyright (c) 2013 ARM Limited
3 * Copyright (c) 2013 Cornell University
3 * All rights reserved
4 *
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

--- 20 unchanged lines hidden (view full) ---

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.
36 *
37 * Authors: Vasileios Spiliopoulos
38 * Akash Bagdia
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

--- 20 unchanged lines hidden (view full) ---

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 * Christopher Torng
39 */
40
41/**
42 * @file
43 * ClockDomain declarations.
44 */
45
46#ifndef __SIM_CLOCK_DOMAIN_HH__
47#define __SIM_CLOCK_DOMAIN_HH__
48
41 */
42
43/**
44 * @file
45 * ClockDomain declarations.
46 */
47
48#ifndef __SIM_CLOCK_DOMAIN_HH__
49#define __SIM_CLOCK_DOMAIN_HH__
50
51#include <algorithm>
52
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/**
56 * Forward declaration
57 */
58class DerivedClockDomain;
59class VoltageDomain;
53#include "base/statistics.hh"
54#include "params/ClockDomain.hh"
55#include "params/DerivedClockDomain.hh"
56#include "params/SrcClockDomain.hh"
57#include "sim/sim_object.hh"
58
59/**
60 * Forward declaration
61 */
62class DerivedClockDomain;
63class VoltageDomain;
64class ClockedObject;
60
61/**
62 * The ClockDomain provides clock to group of clocked objects bundled
63 * under the same clock domain. The clock domains, in turn, are
64 * grouped into voltage domains. The clock domains provide support for
65 * a hierarchial structure with source and derived domains.
66 */
67class ClockDomain : public SimObject

--- 13 unchanged lines hidden (view full) ---

81 VoltageDomain *_voltageDomain;
82
83 /**
84 * Pointers to potential derived clock domains so we can propagate
85 * changes.
86 */
87 std::vector<DerivedClockDomain*> children;
88
65
66/**
67 * The ClockDomain provides clock to group of clocked objects bundled
68 * under the same clock domain. The clock domains, in turn, are
69 * grouped into voltage domains. The clock domains provide support for
70 * a hierarchial structure with source and derived domains.
71 */
72class ClockDomain : public SimObject

--- 13 unchanged lines hidden (view full) ---

86 VoltageDomain *_voltageDomain;
87
88 /**
89 * Pointers to potential derived clock domains so we can propagate
90 * changes.
91 */
92 std::vector<DerivedClockDomain*> children;
93
94 /**
95 * Pointers to members of this clock domain, so that when the clock
96 * period changes, we can update each member's tick.
97 */
98 std::vector<ClockedObject*> members;
99
89 public:
90
91 typedef ClockDomainParams Params;
92 ClockDomain(const Params *p, VoltageDomain *voltage_domain) :
93 SimObject(p),
94 _clockPeriod(0),
95 _voltageDomain(voltage_domain) {}
96
97 /**
98 * Get the clock period.
99 *
100 * @return Clock period in ticks
101 */
102 inline Tick clockPeriod() const { return _clockPeriod; }
103
104 /**
100 public:
101
102 typedef ClockDomainParams Params;
103 ClockDomain(const Params *p, VoltageDomain *voltage_domain) :
104 SimObject(p),
105 _clockPeriod(0),
106 _voltageDomain(voltage_domain) {}
107
108 /**
109 * Get the clock period.
110 *
111 * @return Clock period in ticks
112 */
113 inline Tick clockPeriod() const { return _clockPeriod; }
114
115 /**
116 * Register a ClockedObject to this ClockDomain.
117 *
118 * @param ClockedObject to add as a member
119 */
120 void registerWithClockDomain(ClockedObject *c)
121 {
122 assert(c != NULL);
123 assert(std::find(members.begin(), members.end(), c) == members.end());
124 members.push_back(c);
125 }
126
127 /**
105 * Get the voltage domain.
106 *
107 * @return Voltage domain this clock domain belongs to
108 */
109 inline VoltageDomain *voltageDomain() const { return _voltageDomain; }
110
111
112 /**

--- 27 unchanged lines hidden (view full) ---

140 SrcClockDomain(const Params *p);
141
142 /**
143 * Set new clock value
144 * @param clock The new clock period in ticks
145 */
146 void clockPeriod(Tick clock_period);
147
128 * Get the voltage domain.
129 *
130 * @return Voltage domain this clock domain belongs to
131 */
132 inline VoltageDomain *voltageDomain() const { return _voltageDomain; }
133
134
135 /**

--- 27 unchanged lines hidden (view full) ---

163 SrcClockDomain(const Params *p);
164
165 /**
166 * Set new clock value
167 * @param clock The new clock period in ticks
168 */
169 void clockPeriod(Tick clock_period);
170
171 // Explicitly import the otherwise hidden clockPeriod
172 using ClockDomain::clockPeriod;
148};
149
150/**
151 * The derived clock domains provides the notion of a clock domain
152 * that is connected to a parent clock domain that can either be a
153 * source clock domain or a derived clock domain. It maintains the
154 * clock divider and provides methods for getting the clock.
155 */

--- 30 unchanged lines hidden --- 		173};
174
175/**
176 * The derived clock domains provides the notion of a clock domain
177 * that is connected to a parent clock domain that can either be a
178 * source clock domain or a derived clock domain. It maintains the
179 * clock divider and provides methods for getting the clock.
180 */

--- 30 unchanged lines hidden ---