source: rtems/doc/new_chapters/confspace.t @ 16bed8a

4.104.114.84.9
Last change on this file since 16bed8a was 16bed8a, checked in by Joel Sherrill <joel.sherrill@…>, on Aug 4, 1998 at 7:25:14 PM

More complete shells generated.

  • Property mode set to 100644
File size: 4.2 KB
Line 
1@c
2@c  COPYRIGHT (c) 1988-1998.
3@c  On-Line Applications Research Corporation (OAR).
4@c  All rights reserved.
5@c
6@c  $Id$
7@c
8
9@chapter Configuration Space Manager
10
11@section Introduction
12
13The
14configuration space manager is ...
15
16The directives provided by the configuration space manager are:
17
18@itemize @bullet
19@item @code{cfg_mount} - Mount a Configuration Space
20@item @code{cfg_unmount} -
21@item @code{cfg_mknod} -
22@item @code{cfg_get} -
23@item @code{cfg_set} -
24@item @code{cfg_link} -
25@item @code{cfg_unlink} -
26@item @code{cfg_open} -
27@item @code{cfg_read} -
28@item @code{cfg_children} -
29@item @code{cfg_mark} -
30@item @code{cfg_close} -
31@end itemize
32
33@section Background
34
35@section Operations
36
37@section Directives
38
39This section details the configuration space manager's directives.
40A subsection is dedicated to each of this manager's directives
41and describes the calling sequence, related constants, usage,
42and status codes.
43
44@page
45@subsection cfg_mount - Mount a Configuration Space
46
47@subheading CALLING SEQUENCE:
48
49@ifset is-C
50@example
51int cfg_mount(
52  const char     *file,
53  const char     *cfgpath,
54  log_facility_t  notification,
55  int             logdes
56);
57@end example
58@end ifset
59
60@ifset is-Ada
61@end ifset
62
63@subheading STATUS CODES:
64
65@table @b
66@item EPERM
67The caller does not have the appropriate privilege.
68
69@end table
70
71@subheading DESCRIPTION:
72
73@subheading NOTES:
74
75@page
76@subsection cfg_unmount -
77
78@subheading CALLING SEQUENCE:
79
80@ifset is-C
81@example
82int cfg_unmount(
83);
84@end example
85@end ifset
86
87@ifset is-Ada
88@end ifset
89
90@subheading STATUS CODES:
91
92@table @b
93@item E
94The
95
96@end table
97
98@subheading DESCRIPTION:
99
100@subheading NOTES:
101
102@page
103@subsection cfg_mknod -
104
105@subheading CALLING SEQUENCE:
106
107@ifset is-C
108@example
109int cfg_mknod(
110);
111@end example
112@end ifset
113
114@ifset is-Ada
115@end ifset
116
117@subheading STATUS CODES:
118
119@table @b
120@item E
121The
122
123@end table
124
125@subheading DESCRIPTION:
126
127@subheading NOTES:
128
129@page
130@subsection cfg_get -
131
132@subheading CALLING SEQUENCE:
133
134@ifset is-C
135@example
136int cfg_get(
137);
138@end example
139@end ifset
140
141@ifset is-Ada
142@end ifset
143
144@subheading STATUS CODES:
145
146@table @b
147@item E
148The
149
150@end table
151
152@subheading DESCRIPTION:
153
154@subheading NOTES:
155
156@page
157@subsection cfg_set -
158
159@subheading CALLING SEQUENCE:
160
161@ifset is-C
162@example
163int cfg_set(
164);
165@end example
166@end ifset
167
168@ifset is-Ada
169@end ifset
170
171@subheading STATUS CODES:
172
173@table @b
174@item E
175The
176
177@end table
178
179@subheading DESCRIPTION:
180
181@subheading NOTES:
182
183@page
184@subsection cfg_link -
185
186@subheading CALLING SEQUENCE:
187
188@ifset is-C
189@example
190int cfg_link(
191);
192@end example
193@end ifset
194
195@ifset is-Ada
196@end ifset
197
198@subheading STATUS CODES:
199
200@table @b
201@item E
202The
203
204@end table
205
206@subheading DESCRIPTION:
207
208@subheading NOTES:
209
210@page
211@subsection cfg_unlink -
212
213@subheading CALLING SEQUENCE:
214
215@ifset is-C
216@example
217int cfg_unlink(
218);
219@end example
220@end ifset
221
222@ifset is-Ada
223@end ifset
224
225@subheading STATUS CODES:
226
227@table @b
228@item E
229The
230
231@end table
232
233@subheading DESCRIPTION:
234
235@subheading NOTES:
236
237@page
238@subsection cfg_open -
239
240@subheading CALLING SEQUENCE:
241
242@ifset is-C
243@example
244int cfg_open(
245);
246@end example
247@end ifset
248
249@ifset is-Ada
250@end ifset
251
252@subheading STATUS CODES:
253
254@table @b
255@item E
256The
257
258@end table
259
260@subheading DESCRIPTION:
261
262@subheading NOTES:
263
264@page
265@subsection cfg_read -
266
267@subheading CALLING SEQUENCE:
268
269@ifset is-C
270@example
271int cfg_read(
272);
273@end example
274@end ifset
275
276@ifset is-Ada
277@end ifset
278
279@subheading STATUS CODES:
280
281@table @b
282@item E
283The
284
285@end table
286
287@subheading DESCRIPTION:
288
289@subheading NOTES:
290
291@page
292@subsection cfg_children -
293
294@subheading CALLING SEQUENCE:
295
296@ifset is-C
297@example
298int cfg_children(
299);
300@end example
301@end ifset
302
303@ifset is-Ada
304@end ifset
305
306@subheading STATUS CODES:
307
308@table @b
309@item E
310The
311
312@end table
313
314@subheading DESCRIPTION:
315
316@subheading NOTES:
317
318@page
319@subsection cfg_mark -
320
321@subheading CALLING SEQUENCE:
322
323@ifset is-C
324@example
325int cfg_mark(
326);
327@end example
328@end ifset
329
330@ifset is-Ada
331@end ifset
332
333@subheading STATUS CODES:
334
335@table @b
336@item E
337The
338
339@end table
340
341@subheading DESCRIPTION:
342
343@subheading NOTES:
344
345@page
346@subsection cfg_close -
347
348@subheading CALLING SEQUENCE:
349
350@ifset is-C
351@example
352int cfg_close(
353);
354@end example
355@end ifset
356
357@ifset is-Ada
358@end ifset
359
360@subheading STATUS CODES:
361
362@table @b
363@item E
364The
365
366@end table
367
368@subheading DESCRIPTION:
369
370@subheading NOTES:
371
Note: See TracBrowser for help on using the repository browser.