1 | @c |
---|
2 | @c This is the chapter from the RTEMS ITRON User's Guide that |
---|
3 | @c documents the services provided by the eventflags |
---|
4 | @c manager. |
---|
5 | @c |
---|
6 | @c $Id$ |
---|
7 | @c |
---|
8 | |
---|
9 | @chapter Eventflags Manager |
---|
10 | |
---|
11 | @section Introduction |
---|
12 | |
---|
13 | The |
---|
14 | eventflags manager is ... |
---|
15 | |
---|
16 | The services provided by the eventflags manager are: |
---|
17 | |
---|
18 | @itemize @bullet |
---|
19 | @item @code{cre_flg} - Create Eventflag |
---|
20 | @item @code{del_flg} - Delete Eventflag |
---|
21 | @item @code{set_flg} - Set Eventflag |
---|
22 | @item @code{clr_flg} - Clear Eventflag |
---|
23 | @item @code{wai_flg} - Wait on Eventflag |
---|
24 | @item @code{pol_flg} - Wait for Eventflag(Polling) |
---|
25 | @item @code{twai_flg} - Wait on Eventflag with Timeout |
---|
26 | @item @code{ref_flg} - Reference Eventflag Status |
---|
27 | @end itemize |
---|
28 | |
---|
29 | @section Background |
---|
30 | |
---|
31 | @section Operations |
---|
32 | |
---|
33 | @section System Calls |
---|
34 | |
---|
35 | This section details the eventflags manager's services. |
---|
36 | A subsection is dedicated to each of this manager's services |
---|
37 | and describes the calling sequence, related constants, usage, |
---|
38 | and status codes. |
---|
39 | |
---|
40 | |
---|
41 | @c |
---|
42 | @c cre_flg |
---|
43 | @c |
---|
44 | |
---|
45 | @page |
---|
46 | @subsection cre_flg - Create Eventflag |
---|
47 | |
---|
48 | @subheading CALLING SEQUENCE: |
---|
49 | |
---|
50 | @ifset is-C |
---|
51 | @example |
---|
52 | ER cre_flg( |
---|
53 | ID flgid, |
---|
54 | T_CFLG *pk_cflg |
---|
55 | ); |
---|
56 | @end example |
---|
57 | @end ifset |
---|
58 | |
---|
59 | @ifset is-Ada |
---|
60 | @end ifset |
---|
61 | |
---|
62 | @subheading STATUS CODES: |
---|
63 | |
---|
64 | @code{EXXX} - |
---|
65 | |
---|
66 | @subheading DESCRIPTION: |
---|
67 | |
---|
68 | @subheading NOTES: |
---|
69 | |
---|
70 | |
---|
71 | @c |
---|
72 | @c del_flg |
---|
73 | @c |
---|
74 | |
---|
75 | @page |
---|
76 | @subsection del_flg - Delete Eventflag |
---|
77 | |
---|
78 | @subheading CALLING SEQUENCE: |
---|
79 | |
---|
80 | @ifset is-C |
---|
81 | @example |
---|
82 | ER del_flg( |
---|
83 | ID flgid |
---|
84 | ); |
---|
85 | @end example |
---|
86 | @end ifset |
---|
87 | |
---|
88 | @ifset is-Ada |
---|
89 | @end ifset |
---|
90 | |
---|
91 | @subheading STATUS CODES: |
---|
92 | |
---|
93 | @code{EXXX} - |
---|
94 | |
---|
95 | @subheading DESCRIPTION: |
---|
96 | |
---|
97 | @subheading NOTES: |
---|
98 | |
---|
99 | |
---|
100 | @c |
---|
101 | @c set_flg |
---|
102 | @c |
---|
103 | |
---|
104 | @page |
---|
105 | @subsection set_flg - Set Eventflag |
---|
106 | |
---|
107 | @subheading CALLING SEQUENCE: |
---|
108 | |
---|
109 | @ifset is-C |
---|
110 | @example |
---|
111 | ER set_flg( |
---|
112 | ID flgid, |
---|
113 | UINT setptn |
---|
114 | ); |
---|
115 | @end example |
---|
116 | @end ifset |
---|
117 | |
---|
118 | @ifset is-Ada |
---|
119 | @end ifset |
---|
120 | |
---|
121 | @subheading STATUS CODES: |
---|
122 | |
---|
123 | @code{EXXX} - |
---|
124 | |
---|
125 | @subheading DESCRIPTION: |
---|
126 | |
---|
127 | @subheading NOTES: |
---|
128 | |
---|
129 | |
---|
130 | @c |
---|
131 | @c clr_flg |
---|
132 | @c |
---|
133 | |
---|
134 | @page |
---|
135 | @subsection clr_flg - Clear Eventflag |
---|
136 | |
---|
137 | @subheading CALLING SEQUENCE: |
---|
138 | |
---|
139 | @ifset is-C |
---|
140 | @example |
---|
141 | ER clr_flg( |
---|
142 | ID flgid, |
---|
143 | UINT clrptn |
---|
144 | ); |
---|
145 | @end example |
---|
146 | @end ifset |
---|
147 | |
---|
148 | @ifset is-Ada |
---|
149 | @end ifset |
---|
150 | |
---|
151 | @subheading STATUS CODES: |
---|
152 | |
---|
153 | @code{EXXX} - |
---|
154 | |
---|
155 | @subheading DESCRIPTION: |
---|
156 | |
---|
157 | @subheading NOTES: |
---|
158 | |
---|
159 | |
---|
160 | @c |
---|
161 | @c wai_flg |
---|
162 | @c |
---|
163 | |
---|
164 | @page |
---|
165 | @subsection wai_flg - Wait on Eventflag |
---|
166 | |
---|
167 | @subheading CALLING SEQUENCE: |
---|
168 | |
---|
169 | @ifset is-C |
---|
170 | @example |
---|
171 | ER wai_flg( |
---|
172 | UINT *p_flgptn, |
---|
173 | ID flgid, |
---|
174 | UINT waiptn, |
---|
175 | UINT wfmode |
---|
176 | ); |
---|
177 | @end example |
---|
178 | @end ifset |
---|
179 | |
---|
180 | @ifset is-Ada |
---|
181 | @end ifset |
---|
182 | |
---|
183 | @subheading STATUS CODES: |
---|
184 | |
---|
185 | @code{EXXX} - |
---|
186 | |
---|
187 | @subheading DESCRIPTION: |
---|
188 | |
---|
189 | @subheading NOTES: |
---|
190 | |
---|
191 | |
---|
192 | @c |
---|
193 | @c pol_flg |
---|
194 | @c |
---|
195 | |
---|
196 | @page |
---|
197 | @subsection pol_flg - Wait for Eventflag(Polling) |
---|
198 | |
---|
199 | @subheading CALLING SEQUENCE: |
---|
200 | |
---|
201 | @ifset is-C |
---|
202 | @example |
---|
203 | ER pol_flg( |
---|
204 | UINT *p_flgptn, |
---|
205 | ID flgid, |
---|
206 | UINT waiptn, |
---|
207 | UINT wfmode |
---|
208 | ); |
---|
209 | @end example |
---|
210 | @end ifset |
---|
211 | |
---|
212 | @ifset is-Ada |
---|
213 | @end ifset |
---|
214 | |
---|
215 | @subheading STATUS CODES: |
---|
216 | |
---|
217 | @code{EXXX} - |
---|
218 | |
---|
219 | @subheading DESCRIPTION: |
---|
220 | |
---|
221 | @subheading NOTES: |
---|
222 | |
---|
223 | |
---|
224 | @c |
---|
225 | @c twai_flg |
---|
226 | @c |
---|
227 | |
---|
228 | @page |
---|
229 | @subsection twai_flg - Wait on Eventflag with Timeout |
---|
230 | |
---|
231 | @subheading CALLING SEQUENCE: |
---|
232 | |
---|
233 | @ifset is-C |
---|
234 | @example |
---|
235 | ER ercd =twai_flg( |
---|
236 | UINT *p_flgptn, |
---|
237 | ID flgid, |
---|
238 | UINT waiptn, |
---|
239 | UINT wfmode, |
---|
240 | ); |
---|
241 | @end example |
---|
242 | @end ifset |
---|
243 | |
---|
244 | @ifset is-Ada |
---|
245 | @end ifset |
---|
246 | |
---|
247 | @subheading STATUS CODES: |
---|
248 | |
---|
249 | @code{EXXX} - |
---|
250 | |
---|
251 | @subheading DESCRIPTION: |
---|
252 | |
---|
253 | @subheading NOTES: |
---|
254 | |
---|
255 | |
---|
256 | @c |
---|
257 | @c ref_flg |
---|
258 | @c |
---|
259 | |
---|
260 | @page |
---|
261 | @subsection ref_flg - Reference Eventflag Status |
---|
262 | |
---|
263 | @subheading CALLING SEQUENCE: |
---|
264 | |
---|
265 | @ifset is-C |
---|
266 | @example |
---|
267 | ER ref_flg( |
---|
268 | T_RFLG *pk_rflg, |
---|
269 | ID flgid |
---|
270 | ); |
---|
271 | @end example |
---|
272 | @end ifset |
---|
273 | |
---|
274 | @ifset is-Ada |
---|
275 | @end ifset |
---|
276 | |
---|
277 | @subheading STATUS CODES: |
---|
278 | |
---|
279 | @code{EXXX} - |
---|
280 | |
---|
281 | @subheading DESCRIPTION: |
---|
282 | |
---|
283 | @subheading NOTES: |
---|
284 | |
---|