1 | @c |
---|
2 | @c This is the chapter from the RTEMS ITRON User's Guide that |
---|
3 | @c documents the services provided by the fixed block |
---|
4 | @c manager. |
---|
5 | @c |
---|
6 | @c $Id$ |
---|
7 | @c |
---|
8 | |
---|
9 | @chapter Fixed Block Manager |
---|
10 | |
---|
11 | @section Introduction |
---|
12 | |
---|
13 | The |
---|
14 | fixed block manager is ... |
---|
15 | |
---|
16 | The services provided by the fixed block manager are: |
---|
17 | |
---|
18 | @itemize @bullet |
---|
19 | @item @code{cre_mpf} - Create Fixed-Size Memorypool
|
---|
20 | @item @code{del_mpf} - Delete Fixed-Size Memorypool
|
---|
21 | @item @code{get_blf} - Get Fixed-Size Memory Block
Poll and Get Fixed-Size Memory Block
Get Fixed-Size Memory Block with Timeout
|
---|
22 | @item @code{pget_blf} - Poll and Get Fixed-Size Memory Block
|
---|
23 | @item @code{tget_blf} - Get Fixed-Size Memory Block with Timeout
|
---|
24 | @item @code{rel_blf} - Release Fixed-Size Memory Block
|
---|
25 | @item @code{ref_mpf} - Reference Fixed-Size Memorypool Status
|
---|
26 | @end itemize |
---|
27 | |
---|
28 | @section Background |
---|
29 | |
---|
30 | @section Operations |
---|
31 | |
---|
32 | @section System Calls |
---|
33 | |
---|
34 | This section details the fixed block manager's services. |
---|
35 | A subsection is dedicated to each of this manager's services |
---|
36 | and describes the calling sequence, related constants, usage, |
---|
37 | and status codes. |
---|
38 | |
---|
39 | |
---|
40 | @c |
---|
41 | @c cre_mpf |
---|
42 | @c |
---|
43 | |
---|
44 | @page |
---|
45 | @subsection cre_mpf - Create Fixed-Size Memorypool
|
---|
46 | |
---|
47 | @subheading CALLING SEQUENCE: |
---|
48 | |
---|
49 | @ifset is-C |
---|
50 | @example |
---|
51 | int cre_mpf( |
---|
52 | ); |
---|
53 | @end example |
---|
54 | @end ifset |
---|
55 | |
---|
56 | @ifset is-Ada |
---|
57 | @end ifset |
---|
58 | |
---|
59 | @subheading STATUS CODES: |
---|
60 | |
---|
61 | @code{EXXX} - |
---|
62 | |
---|
63 | @subheading DESCRIPTION: |
---|
64 | |
---|
65 | @subheading NOTES: |
---|
66 | |
---|
67 | |
---|
68 | @c |
---|
69 | @c del_mpf |
---|
70 | @c |
---|
71 | |
---|
72 | @page |
---|
73 | @subsection del_mpf - Delete Fixed-Size Memorypool
|
---|
74 | |
---|
75 | @subheading CALLING SEQUENCE: |
---|
76 | |
---|
77 | @ifset is-C |
---|
78 | @example |
---|
79 | int del_mpf( |
---|
80 | ); |
---|
81 | @end example |
---|
82 | @end ifset |
---|
83 | |
---|
84 | @ifset is-Ada |
---|
85 | @end ifset |
---|
86 | |
---|
87 | @subheading STATUS CODES: |
---|
88 | |
---|
89 | @code{EXXX} - |
---|
90 | |
---|
91 | @subheading DESCRIPTION: |
---|
92 | |
---|
93 | @subheading NOTES: |
---|
94 | |
---|
95 | |
---|
96 | @c |
---|
97 | @c get_blf |
---|
98 | @c |
---|
99 | |
---|
100 | @page |
---|
101 | @subsection get_blf - Get Fixed-Size Memory Block
Poll and Get Fixed-Size Memory Block
Get Fixed-Size Memory Block with Timeout
|
---|
102 | |
---|
103 | @subheading CALLING SEQUENCE: |
---|
104 | |
---|
105 | @ifset is-C |
---|
106 | @example |
---|
107 | int get_blf( |
---|
108 | ); |
---|
109 | @end example |
---|
110 | @end ifset |
---|
111 | |
---|
112 | @ifset is-Ada |
---|
113 | @end ifset |
---|
114 | |
---|
115 | @subheading STATUS CODES: |
---|
116 | |
---|
117 | @code{EXXX} - |
---|
118 | |
---|
119 | @subheading DESCRIPTION: |
---|
120 | |
---|
121 | @subheading NOTES: |
---|
122 | |
---|
123 | |
---|
124 | @c |
---|
125 | @c pget_blf |
---|
126 | @c |
---|
127 | |
---|
128 | @page |
---|
129 | @subsection pget_blf - Poll and Get Fixed-Size Memory Block
|
---|
130 | |
---|
131 | @subheading CALLING SEQUENCE: |
---|
132 | |
---|
133 | @ifset is-C |
---|
134 | @example |
---|
135 | int pget_blf( |
---|
136 | ); |
---|
137 | @end example |
---|
138 | @end ifset |
---|
139 | |
---|
140 | @ifset is-Ada |
---|
141 | @end ifset |
---|
142 | |
---|
143 | @subheading STATUS CODES: |
---|
144 | |
---|
145 | @code{EXXX} - |
---|
146 | |
---|
147 | @subheading DESCRIPTION: |
---|
148 | |
---|
149 | @subheading NOTES: |
---|
150 | |
---|
151 | |
---|
152 | @c |
---|
153 | @c tget_blf |
---|
154 | @c |
---|
155 | |
---|
156 | @page |
---|
157 | @subsection tget_blf - Get Fixed-Size Memory Block with Timeout
|
---|
158 | |
---|
159 | @subheading CALLING SEQUENCE: |
---|
160 | |
---|
161 | @ifset is-C |
---|
162 | @example |
---|
163 | int tget_blf( |
---|
164 | ); |
---|
165 | @end example |
---|
166 | @end ifset |
---|
167 | |
---|
168 | @ifset is-Ada |
---|
169 | @end ifset |
---|
170 | |
---|
171 | @subheading STATUS CODES: |
---|
172 | |
---|
173 | @code{EXXX} - |
---|
174 | |
---|
175 | @subheading DESCRIPTION: |
---|
176 | |
---|
177 | @subheading NOTES: |
---|
178 | |
---|
179 | |
---|
180 | @c |
---|
181 | @c rel_blf |
---|
182 | @c |
---|
183 | |
---|
184 | @page |
---|
185 | @subsection rel_blf - Release Fixed-Size Memory Block
|
---|
186 | |
---|
187 | @subheading CALLING SEQUENCE: |
---|
188 | |
---|
189 | @ifset is-C |
---|
190 | @example |
---|
191 | int rel_blf( |
---|
192 | ); |
---|
193 | @end example |
---|
194 | @end ifset |
---|
195 | |
---|
196 | @ifset is-Ada |
---|
197 | @end ifset |
---|
198 | |
---|
199 | @subheading STATUS CODES: |
---|
200 | |
---|
201 | @code{EXXX} - |
---|
202 | |
---|
203 | @subheading DESCRIPTION: |
---|
204 | |
---|
205 | @subheading NOTES: |
---|
206 | |
---|
207 | |
---|
208 | @c |
---|
209 | @c ref_mpf |
---|
210 | @c |
---|
211 | |
---|
212 | @page |
---|
213 | @subsection ref_mpf - Reference Fixed-Size Memorypool Status
|
---|
214 | |
---|
215 | @subheading CALLING SEQUENCE: |
---|
216 | |
---|
217 | @ifset is-C |
---|
218 | @example |
---|
219 | int ref_mpf( |
---|
220 | ); |
---|
221 | @end example |
---|
222 | @end ifset |
---|
223 | |
---|
224 | @ifset is-Ada |
---|
225 | @end ifset |
---|
226 | |
---|
227 | @subheading STATUS CODES: |
---|
228 | |
---|
229 | @code{EXXX} - |
---|
230 | |
---|
231 | @subheading DESCRIPTION: |
---|
232 | |
---|
233 | @subheading NOTES: |
---|
234 | |
---|