Mercurial > ecos
annotate packages/kernel/current/include/clock.hxx @ 124:0ec04793409a ecos-sw-2000-09-11
Merge from eCos master repository on 2000-09-11-03:00:13-BST
| author | jlarmour |
|---|---|
| date | Mon, 11 Sep 2000 02:42:46 +0000 |
| parents | 6ed91473a1cd |
| children | 8f2f7615e727 |
| rev | line source |
|---|---|
| 0 | 1 #ifndef CYGONCE_KERNEL_CLOCK_HXX |
| 2 #define CYGONCE_KERNEL_CLOCK_HXX | |
| 3 | |
| 4 //========================================================================== | |
| 5 // | |
| 2 | 6 // clock.hxx |
| 0 | 7 // |
| 2 | 8 // Clock and Alarm class declaration(s) |
| 0 | 9 // |
| 10 //========================================================================== | |
| 11 //####COPYRIGHTBEGIN#### | |
|
64
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
12 // |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
13 // ------------------------------------------- |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
14 // The contents of this file are subject to the Red Hat eCos Public License |
|
66
bf00f99aec69
Merge from eCos master repository on 2000-02-02-19:16:44-GMT
jlarmour
parents:
64
diff
changeset
|
15 // Version 1.1 (the "License"); you may not use this file except in |
|
64
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
16 // compliance with the License. You may obtain a copy of the License at |
|
66
bf00f99aec69
Merge from eCos master repository on 2000-02-02-19:16:44-GMT
jlarmour
parents:
64
diff
changeset
|
17 // http://www.redhat.com/ |
|
64
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
18 // |
|
66
bf00f99aec69
Merge from eCos master repository on 2000-02-02-19:16:44-GMT
jlarmour
parents:
64
diff
changeset
|
19 // Software distributed under the License is distributed on an "AS IS" |
|
64
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
20 // basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
21 // License for the specific language governing rights and limitations under |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
22 // the License. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
23 // |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
24 // The Original Code is eCos - Embedded Configurable Operating System, |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
25 // released September 30, 1998. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
26 // |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
27 // The Initial Developer of the Original Code is Red Hat. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
28 // Portions created by Red Hat are |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
29 // Copyright (C) 1998, 1999, 2000 Red Hat, Inc. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
30 // All Rights Reserved. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
31 // ------------------------------------------- |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
32 // |
| 0 | 33 //####COPYRIGHTEND#### |
| 34 //========================================================================== | |
| 35 //#####DESCRIPTIONBEGIN#### | |
| 36 // | |
| 2 | 37 // Author(s): nickg |
| 38 // Contributors: nickg | |
| 39 // Date: 1997-09-09 | |
| 40 // Purpose: Define Clock and Alarm class interfaces | |
| 41 // Description: The classes defined here collectively implement the | |
| 0 | 42 // internal API used to create, configure and manage Counters, |
| 43 // Clocks and Alarms. | |
| 44 // Usage: #include <cyg/kernel/clock.hxx> | |
| 45 // | |
| 46 //####DESCRIPTIONEND#### | |
| 47 // | |
| 48 //========================================================================== | |
| 49 | |
| 50 #include <cyg/kernel/ktypes.h> | |
| 51 #include <cyg/infra/cyg_ass.h> // assertion macros | |
| 52 | |
| 53 // ------------------------------------------------------------------------- | |
| 54 | |
| 55 class Cyg_Alarm; | |
| 56 | |
| 57 typedef void cyg_alarm_fn(Cyg_Alarm *alarm, CYG_ADDRWORD data); | |
| 58 | |
| 59 // ------------------------------------------------------------------------- | |
| 60 // Counter object. | |
| 61 | |
| 62 class Cyg_Counter | |
| 63 { | |
| 64 | |
| 65 friend class Cyg_Alarm; | |
| 66 | |
| 67 #if defined(CYGIMP_KERNEL_COUNTERS_SINGLE_LIST) | |
| 68 | |
| 69 Cyg_Alarm *alarm_list; // Linear list of Alarms | |
| 70 | |
| 71 #elif defined(CYGIMP_KERNEL_COUNTERS_MULTI_LIST) | |
| 72 | |
| 73 Cyg_Alarm *alarm_list[CYGNUM_KERNEL_COUNTERS_MULTI_LIST_SIZE]; | |
| 74 | |
| 75 #endif | |
| 76 | |
|
62
7a6ac9edc838
Merge from eCos master repository on 2000-01-24-19:43:49-GMT
jlarmour
parents:
2
diff
changeset
|
77 volatile cyg_tick_count counter; // counter value |
| 0 | 78 |
| 79 cyg_uint32 increment; // increment per tick | |
| 80 | |
| 81 public: | |
| 82 | |
| 83 CYGDBG_DEFINE_CHECK_THIS | |
| 84 | |
| 85 Cyg_Counter( | |
| 86 cyg_uint32 increment = 1 | |
| 87 ); | |
| 88 | |
| 89 ~Cyg_Counter(); | |
| 90 | |
| 91 // Return current value of counter | |
| 92 cyg_tick_count current_value(); | |
| 93 | |
| 94 // Return low and high halves of the | |
| 95 // counter value. | |
| 96 cyg_uint32 current_value_lo(); | |
| 97 cyg_uint32 current_value_hi(); | |
| 98 | |
| 99 // Set the counter's current value | |
| 100 void set_value( cyg_tick_count new_value); | |
| 101 | |
| 102 // Advance counter by some number of ticks | |
| 103 void tick( cyg_uint32 ticks = 1); | |
| 104 | |
| 105 // Add an alarm to this counter | |
| 106 void add_alarm( Cyg_Alarm *alarm ); | |
| 107 | |
| 108 // Remove an alarm from this counter | |
| 109 void rem_alarm( Cyg_Alarm *alarm ); | |
| 110 | |
| 111 }; | |
| 112 | |
| 113 // ------------------------------------------------------------------------- | |
| 114 // Clock class. This is derived from a Counter and defines extra | |
| 115 // features to support clock-like behaviour. | |
| 116 | |
| 117 class Cyg_Clock | |
| 118 : public Cyg_Counter | |
| 119 { | |
| 120 | |
| 121 public: | |
| 122 | |
| 123 CYGDBG_DEFINE_CHECK_THIS | |
| 124 | |
| 125 // This structure allows a more accurate representation | |
| 126 // of the resolution than a single integer would allow. | |
| 127 // The resolution is defined as dividend/divisor nanoseconds | |
| 128 // per tick. | |
| 129 struct cyg_resolution { | |
| 130 cyg_uint32 dividend; | |
| 131 cyg_uint32 divisor; | |
| 132 }; | |
| 133 | |
| 134 private: | |
| 135 | |
| 136 cyg_resolution resolution; // Current clock resolution | |
| 137 | |
| 138 public: | |
| 139 | |
| 140 Cyg_Clock( // Create clock with given resolution | |
| 141 cyg_resolution resolution | |
| 142 ); | |
| 143 | |
| 144 ~Cyg_Clock(); // Destructor | |
| 145 | |
| 146 cyg_resolution get_resolution(); // Return current resolution | |
| 147 | |
| 148 void set_resolution( // Set new resolution | |
| 149 cyg_resolution resolution | |
| 150 ); | |
| 151 | |
|
64
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
152 // There is a need for converting from "other" ticks to clock ticks. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
153 // We will construct 4 numbers to do the conversion as: |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
154 // clock_ticks = (((otherticks*mul1)/div1)*mul2/div2) |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
155 // with the values chosen to minimize the possibility of overflow. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
156 // Do the arithmetic in cyg_uint64s throughout. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
157 struct converter { |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
158 cyg_uint64 mul1, div1, mul2, div2; |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
159 }; |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
160 |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
161 // There are two of these because the 4 numbers are different depending |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
162 // on the direction of the conversion, to prevent loss of significance. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
163 // NB these relate to the resolution of the clock object they are |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
164 // called against, not necessarily "the" system real time clock. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
165 void get_other_to_clock_converter( cyg_uint64 ns_per_other_tick, |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
166 struct converter *pcc ); |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
167 |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
168 void get_clock_to_other_converter( cyg_uint64 ns_per_other_tick, |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
169 struct converter *pcc ); |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
170 |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
171 // A utility to perform the conversion in the obvious way, with |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
172 // rounding to nearest at each stage. Static because it uses a |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
173 // previously acquired converter. |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
174 static cyg_tick_count convert( cyg_tick_count value, |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
175 struct converter *pcc ); |
|
c38311975d4f
Merge from eCos master repository on 2000-01-28-04:28:11-GMT
jlarmour
parents:
62
diff
changeset
|
176 |
| 0 | 177 #ifdef CYGVAR_KERNEL_COUNTERS_CLOCK |
| 178 | |
| 179 // There is a system supplied real time clock... | |
| 180 | |
| 181 static Cyg_Clock *real_time_clock; | |
| 182 | |
| 183 #endif | |
| 184 | |
| 185 }; | |
| 186 | |
| 187 // ------------------------------------------------------------------------- | |
| 188 // Alarm class. An alarm may be attached to a counter (or a clock) to be | |
| 189 // called when the trigger value is reached. | |
| 190 | |
| 191 class Cyg_Alarm | |
| 192 { | |
| 193 friend class Cyg_Counter; | |
| 194 | |
| 195 #if defined(CYGIMP_KERNEL_COUNTERS_SINGLE_LIST) || defined(CYGIMP_KERNEL_COUNTERS_MULTI_LIST) | |
| 196 | |
| 197 Cyg_Alarm *next; // next alarm in list | |
| 198 | |
| 199 #endif | |
| 200 | |
| 201 protected: | |
| 202 Cyg_Counter *counter; // Attached to this counter/clock | |
| 203 | |
| 204 cyg_alarm_fn *alarm; // Call-back function | |
| 205 | |
| 206 CYG_ADDRWORD data; // Call-back data | |
| 207 | |
| 208 cyg_tick_count trigger; // Absolute trigger time | |
| 209 | |
| 210 cyg_tick_count interval; // Retrigger interval | |
| 211 | |
| 212 cyg_bool enabled; // True if enabled | |
| 213 | |
| 214 Cyg_Alarm(); | |
| 215 | |
| 216 void synchronize( void ); // deal with times in the past, | |
| 217 // make next alarm in synch. | |
| 218 | |
| 219 public: | |
| 220 | |
| 221 CYGDBG_DEFINE_CHECK_THIS | |
| 222 | |
| 223 Cyg_Alarm // Constructor | |
| 224 ( | |
| 225 Cyg_Counter *counter, // Attached to this counter | |
| 226 cyg_alarm_fn *alarm, // Call-back function | |
| 227 CYG_ADDRWORD data // Call-back data | |
| 228 ); | |
| 229 | |
| 230 ~Cyg_Alarm(); // Destructor | |
| 231 | |
| 232 void initialize( // Initialize Alarm | |
| 233 cyg_tick_count trigger, // Absolute trigger time | |
| 234 cyg_tick_count interval = 0 // Relative retrigger interval | |
| 235 ); | |
| 236 | |
| 237 void enable(); // Ensure alarm enabled | |
| 238 | |
| 239 void disable(); // Ensure alarm disabled | |
| 240 | |
|
115
6ed91473a1cd
Merge from eCos master repository on 2000-08-21-22:40:54-BST
jlarmour
parents:
66
diff
changeset
|
241 void get_times( |
|
6ed91473a1cd
Merge from eCos master repository on 2000-08-21-22:40:54-BST
jlarmour
parents:
66
diff
changeset
|
242 cyg_tick_count *trigger, // Next trigger time |
|
6ed91473a1cd
Merge from eCos master repository on 2000-08-21-22:40:54-BST
jlarmour
parents:
66
diff
changeset
|
243 cyg_tick_count *interval // Current interval |
|
6ed91473a1cd
Merge from eCos master repository on 2000-08-21-22:40:54-BST
jlarmour
parents:
66
diff
changeset
|
244 ); |
| 0 | 245 }; |
| 246 | |
| 247 // ------------------------------------------------------------------------- | |
| 248 | |
| 249 #endif // ifndef CYGONCE_KERNEL_CLOCK_HXX | |
| 250 // EOF clock.hxx |
