1 | @c |
---|
2 | @c COPYRIGHT (c) 1988-1999. |
---|
3 | @c On-Line Applications Research Corporation (OAR). |
---|
4 | @c All rights reserved. |
---|
5 | @c |
---|
6 | @c This is the chapter from the RTEMS ITRON User's Guide that |
---|
7 | @c documents the services provided by the time |
---|
8 | @c manager. |
---|
9 | @c |
---|
10 | @c $Id$ |
---|
11 | @c |
---|
12 | |
---|
13 | @chapter Time Manager |
---|
14 | |
---|
15 | @section Introduction |
---|
16 | |
---|
17 | The |
---|
18 | time manager is ... |
---|
19 | |
---|
20 | The services provided by the time manager are: |
---|
21 | |
---|
22 | @itemize @bullet |
---|
23 | @item @code{get_tim} - Get System Clock |
---|
24 | @item @code{set_tim} - Set System Clock |
---|
25 | @item @code{dly_tsk} - Delay Task |
---|
26 | @item @code{def_cyc} - Define Cyclic Handler |
---|
27 | @item @code{act_cyc} - Activate Cyclic Handler |
---|
28 | @item @code{ref_cyc} - Reference Cyclic Handler Status |
---|
29 | @item @code{def_alm} - Define Alarm Handler |
---|
30 | @item @code{ref_alm} - Reference Alarm Handler Status |
---|
31 | @item @code{ret_tmr} - Return from Timer Handler |
---|
32 | @end itemize |
---|
33 | |
---|
34 | @section Background |
---|
35 | |
---|
36 | @section Operations |
---|
37 | |
---|
38 | @section System Calls |
---|
39 | |
---|
40 | This section details the time manager's services. |
---|
41 | A subsection is dedicated to each of this manager's services |
---|
42 | and describes the calling sequence, related constants, usage, |
---|
43 | and status codes. |
---|
44 | |
---|
45 | |
---|
46 | @c |
---|
47 | @c get_tim |
---|
48 | @c |
---|
49 | |
---|
50 | @page |
---|
51 | @subsection get_tim - Get System Clock |
---|
52 | |
---|
53 | @subheading CALLING SEQUENCE: |
---|
54 | |
---|
55 | @ifset is-C |
---|
56 | @example |
---|
57 | ER get_tim( |
---|
58 | SYSTIME *pk_tim |
---|
59 | ); |
---|
60 | @end example |
---|
61 | @end ifset |
---|
62 | |
---|
63 | @ifset is-Ada |
---|
64 | @end ifset |
---|
65 | |
---|
66 | @subheading STATUS CODES: |
---|
67 | |
---|
68 | @code{EXXX} - |
---|
69 | |
---|
70 | @subheading DESCRIPTION: |
---|
71 | |
---|
72 | @subheading NOTES: |
---|
73 | |
---|
74 | |
---|
75 | @c |
---|
76 | @c set_tim |
---|
77 | @c |
---|
78 | |
---|
79 | @page |
---|
80 | @subsection set_tim - Set System Clock |
---|
81 | |
---|
82 | @subheading CALLING SEQUENCE: |
---|
83 | |
---|
84 | @ifset is-C |
---|
85 | @example |
---|
86 | ER set_tim( |
---|
87 | SYSTIME *pk_tim |
---|
88 | ); |
---|
89 | @end example |
---|
90 | @end ifset |
---|
91 | |
---|
92 | @ifset is-Ada |
---|
93 | @end ifset |
---|
94 | |
---|
95 | @subheading STATUS CODES: |
---|
96 | |
---|
97 | @code{EXXX} - |
---|
98 | |
---|
99 | @subheading DESCRIPTION: |
---|
100 | |
---|
101 | @subheading NOTES: |
---|
102 | |
---|
103 | |
---|
104 | @c |
---|
105 | @c dly_tsk |
---|
106 | @c |
---|
107 | |
---|
108 | @page |
---|
109 | @subsection dly_tsk - Delay Task |
---|
110 | |
---|
111 | @subheading CALLING SEQUENCE: |
---|
112 | |
---|
113 | @ifset is-C |
---|
114 | @example |
---|
115 | ER dly_tsk( |
---|
116 | DLYTIME dlytim |
---|
117 | ); |
---|
118 | @end example |
---|
119 | @end ifset |
---|
120 | |
---|
121 | @ifset is-Ada |
---|
122 | @end ifset |
---|
123 | |
---|
124 | @subheading STATUS CODES: |
---|
125 | |
---|
126 | @code{EXXX} - |
---|
127 | |
---|
128 | @subheading DESCRIPTION: |
---|
129 | |
---|
130 | @subheading NOTES: |
---|
131 | |
---|
132 | |
---|
133 | @c |
---|
134 | @c def_cyc |
---|
135 | @c |
---|
136 | |
---|
137 | @page |
---|
138 | @subsection def_cyc - Define Cyclic Handler |
---|
139 | |
---|
140 | @subheading CALLING SEQUENCE: |
---|
141 | |
---|
142 | @ifset is-C |
---|
143 | @example |
---|
144 | ER def_cyc( |
---|
145 | HNO cycno, |
---|
146 | T_DCYC *pk_dcyc |
---|
147 | ); |
---|
148 | @end example |
---|
149 | @end ifset |
---|
150 | |
---|
151 | @ifset is-Ada |
---|
152 | @end ifset |
---|
153 | |
---|
154 | @subheading STATUS CODES: |
---|
155 | |
---|
156 | @code{EXXX} - |
---|
157 | |
---|
158 | @subheading DESCRIPTION: |
---|
159 | |
---|
160 | @subheading NOTES: |
---|
161 | |
---|
162 | |
---|
163 | @c |
---|
164 | @c act_cyc |
---|
165 | @c |
---|
166 | |
---|
167 | @page |
---|
168 | @subsection act_cyc - Activate Cyclic Handler |
---|
169 | |
---|
170 | @subheading CALLING SEQUENCE: |
---|
171 | |
---|
172 | @ifset is-C |
---|
173 | @example |
---|
174 | ER act_cyc( |
---|
175 | HNO cycno, |
---|
176 | UINT cycact |
---|
177 | ); |
---|
178 | @end example |
---|
179 | @end ifset |
---|
180 | |
---|
181 | @ifset is-Ada |
---|
182 | @end ifset |
---|
183 | |
---|
184 | @subheading STATUS CODES: |
---|
185 | |
---|
186 | @code{EXXX} - |
---|
187 | |
---|
188 | @subheading DESCRIPTION: |
---|
189 | |
---|
190 | @subheading NOTES: |
---|
191 | |
---|
192 | |
---|
193 | @c |
---|
194 | @c ref_cyc |
---|
195 | @c |
---|
196 | |
---|
197 | @page |
---|
198 | @subsection ref_cyc - Reference Cyclic Handler Status |
---|
199 | |
---|
200 | @subheading CALLING SEQUENCE: |
---|
201 | |
---|
202 | @ifset is-C |
---|
203 | @example |
---|
204 | ER ref_cyc( |
---|
205 | T_RCYC *pk_rcyc, |
---|
206 | HNO cycno |
---|
207 | ); |
---|
208 | @end example |
---|
209 | @end ifset |
---|
210 | |
---|
211 | @ifset is-Ada |
---|
212 | @end ifset |
---|
213 | |
---|
214 | @subheading STATUS CODES: |
---|
215 | |
---|
216 | @code{EXXX} - |
---|
217 | |
---|
218 | @subheading DESCRIPTION: |
---|
219 | |
---|
220 | @subheading NOTES: |
---|
221 | |
---|
222 | |
---|
223 | @c |
---|
224 | @c def_alm |
---|
225 | @c |
---|
226 | |
---|
227 | @page |
---|
228 | @subsection def_alm - Define Alarm Handler |
---|
229 | |
---|
230 | @subheading CALLING SEQUENCE: |
---|
231 | |
---|
232 | @ifset is-C |
---|
233 | @example |
---|
234 | ER def_alm( |
---|
235 | HNO almno, |
---|
236 | T_DALM *pk_dalm |
---|
237 | ); |
---|
238 | @end example |
---|
239 | @end ifset |
---|
240 | |
---|
241 | @ifset is-Ada |
---|
242 | @end ifset |
---|
243 | |
---|
244 | @subheading STATUS CODES: |
---|
245 | |
---|
246 | @code{EXXX} - |
---|
247 | |
---|
248 | @subheading DESCRIPTION: |
---|
249 | |
---|
250 | @subheading NOTES: |
---|
251 | |
---|
252 | |
---|
253 | @c |
---|
254 | @c ref_alm |
---|
255 | @c |
---|
256 | |
---|
257 | @page |
---|
258 | @subsection ref_alm - Reference Alarm Handler Status |
---|
259 | |
---|
260 | @subheading CALLING SEQUENCE: |
---|
261 | |
---|
262 | @ifset is-C |
---|
263 | @example |
---|
264 | ER ref_alm( |
---|
265 | T_RALM *pk_ralm, |
---|
266 | HNO almno |
---|
267 | ); |
---|
268 | @end example |
---|
269 | @end ifset |
---|
270 | |
---|
271 | @ifset is-Ada |
---|
272 | @end ifset |
---|
273 | |
---|
274 | @subheading STATUS CODES: |
---|
275 | |
---|
276 | @code{EXXX} - |
---|
277 | |
---|
278 | @subheading DESCRIPTION: |
---|
279 | |
---|
280 | @subheading NOTES: |
---|
281 | |
---|
282 | |
---|
283 | @c |
---|
284 | @c ret_tmr |
---|
285 | @c |
---|
286 | |
---|
287 | @page |
---|
288 | @subsection ret_tmr - Return from Timer Handler |
---|
289 | |
---|
290 | @subheading CALLING SEQUENCE: |
---|
291 | |
---|
292 | @ifset is-C |
---|
293 | @example |
---|
294 | void ret_tmr( |
---|
295 | |
---|
296 | ); |
---|
297 | @end example |
---|
298 | @end ifset |
---|
299 | |
---|
300 | @ifset is-Ada |
---|
301 | @end ifset |
---|
302 | |
---|
303 | @subheading STATUS CODES: |
---|
304 | |
---|
305 | @code{EXXX} - |
---|
306 | |
---|
307 | @subheading DESCRIPTION: |
---|
308 | |
---|
309 | @subheading NOTES: |
---|
310 | |
---|