source: rtems/doc/itron3.0/memorypool.t @ eb91a4b

4.104.114.84.95
Last change on this file since eb91a4b was eb91a4b, checked in by Joel Sherrill <joel.sherrill@…>, on 06/04/99 at 13:37:43

Significantly cleaned up to make a much better starting point for the
class.

  • Property mode set to 100644
File size: 3.2 KB
Line 
1@c
2@c  This is the chapter from the RTEMS ITRON User's Guide that
3@c  documents the services provided by the memory pool
4@c  manager.
5@c
6@c  $Id$
7@c
8
9@chapter Memory Pool Manager
10
11@section Introduction
12
13The
14memory pool manager is ...
15
16The services provided by the memory pool manager are:
17
18@itemize @bullet
19@item @code{cre_mpl} - Create Variable-Size Memorypool
20@item @code{del_mpl} - Delete Variable-Size Memorypool
21@item @code{get_blk} - Get Variable-Size Memory Block
22@item @code{pget_blk} - Poll and Get Variable-Size Memory Block
23@item @code{tget_blk} - Get Variable-Size Memory Block with Timeout
24@item @code{rel_blk} - Release Variable-Size Memory Block
25@item @code{ref_mpl} - Reference Variable-Size Memorypool Status
26@end itemize
27
28@section Background
29
30@section Operations
31
32@section System Calls
33
34This section details the memory pool manager's services.
35A subsection is dedicated to each of this manager's services
36and describes the calling sequence, related constants, usage,
37and status codes.
38
39
40@c
41@c  cre_mpl
42@c
43
44@page
45@subsection cre_mpl - Create Variable-Size Memorypool
46
47@subheading CALLING SEQUENCE:
48
49@ifset is-C
50@example
51ER cre_mpl(
52  ID mplid,
53  T_CMPL *pk_cmpl
54);
55@end example
56@end ifset
57
58@ifset is-Ada
59@end ifset
60
61@subheading STATUS CODES:
62
63@code{EXXX} -
64
65@subheading DESCRIPTION:
66
67@subheading NOTES:
68
69
70@c
71@c  del_mpl
72@c
73
74@page
75@subsection del_mpl - Delete Variable-Size Memorypool
76
77@subheading CALLING SEQUENCE:
78
79@ifset is-C
80@example
81ER del_mpl(
82  ID mplid
83);
84@end example
85@end ifset
86
87@ifset is-Ada
88@end ifset
89
90@subheading STATUS CODES:
91
92@code{EXXX} -
93
94@subheading DESCRIPTION:
95
96@subheading NOTES:
97
98
99@c
100@c  get_blk
101@c
102
103@page
104@subsection get_blk - Get Variable-Size Memory Block
105
106@subheading CALLING SEQUENCE:
107
108@ifset is-C
109@example
110ER get_blk(
111  VP *p_blk,
112  ID mplid,
113  INT blksz
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  pget_blk
132@c
133
134@page
135@subsection pget_blk - Poll and Get Variable-Size Memory Block
136
137@subheading CALLING SEQUENCE:
138
139@ifset is-C
140@example
141ER ercd =pget_blk(
142  VP *p_blk,
143  ID mplid,
144  INT blksz
145);
146@end example
147@end ifset
148
149@ifset is-Ada
150@end ifset
151
152@subheading STATUS CODES:
153
154@code{EXXX} -
155
156@subheading DESCRIPTION:
157
158@subheading NOTES:
159
160
161@c
162@c  tget_blk
163@c
164
165@page
166@subsection tget_blk - Get Variable-Size Memory Block with Timeout
167
168@subheading CALLING SEQUENCE:
169
170@ifset is-C
171@example
172ER ercd =tget_blk(
173  VP *p_blk,
174  ID mplid,
175  INT blksz,
176  TMO tmout
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  rel_blk
195@c
196
197@page
198@subsection rel_blk - Release Variable-Size Memory Block
199
200@subheading CALLING SEQUENCE:
201
202@ifset is-C
203@example
204ER rel_blk(
205  ID mplid,
206  VP blk
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  ref_mpl
225@c
226
227@page
228@subsection ref_mpl - Reference Variable-Size Memorypool Status
229
230@subheading CALLING SEQUENCE:
231
232@ifset is-C
233@example
234ER ref_mpl(
235  T_RMPL *pk_rmpl,
236  ID mplid
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
Note: See TracBrowser for help on using the repository browser.