summaryrefslogtreecommitdiffstats
path: root/doc/itron3.0/memorypool.t
blob: 3aa9c407a4c43678bf88e5ed767cb4a24c828191 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
@c
@c  This is the chapter from the RTEMS ITRON User's Guide that
@c  documents the services provided by the memory pool
@c  manager.
@c
@c  $Id$
@c

@chapter Memory Pool Manager

@section Introduction

The 
memory pool manager is ...

The services provided by the memory pool manager are:

@itemize @bullet
@item @code{cre_mpl} - Create Variable-Size Memorypool
@item @code{del_mpl} - Delete Variable-Size Memorypool
@item @code{get_blk} - Get Variable-Size Memory Block
 Poll and Get Variable-Size Memory Block
 Get Variable-Size Memory Block with Timeout
@item @code{pget_blk} - Poll and Get Variable-Size Memory Block
@item @code{tget_blk} - Get Variable-Size Memory Block with Timeout
@item @code{rel_blk} - Release Variable-Size Memory Block
@item @code{ref_mpl} - Reference Variable-Size Memorypool Status
@end itemize

@section Background

@section Operations

@section System Calls

This section details the memory pool manager's services.
A subsection is dedicated to each of this manager's services
and describes the calling sequence, related constants, usage,
and status codes.


@c
@c  cre_mpl
@c

@page
@subsection cre_mpl - Create Variable-Size Memorypool

@subheading CALLING SEQUENCE:

@ifset is-C
@example
ER cre_mpl (
 ID mplid, T_CMPL *pk_cmpl
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES:


@c
@c  del_mpl
@c

@page
@subsection del_mpl - Delete Variable-Size Memorypool

@subheading CALLING SEQUENCE:

@ifset is-C
@example
ER del_mpl (
 ID mplid
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES:


@c
@c  get_blk
@c

@page
@subsection get_blk - Get Variable-Size Memory Block
 Poll and Get Variable-Size Memory Block
 Get Variable-Size Memory Block with Timeout

@subheading CALLING SEQUENCE:

@ifset is-C
@example
ER get_blk (
 VP *p_blk, ID mplid, INT blksz
 ER ercd =pget_blk 
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES:


@c
@c  pget_blk
@c

@page
@subsection pget_blk - Poll and Get Variable-Size Memory Block

@subheading CALLING SEQUENCE:

@ifset is-C
@example
ER ercd =pget_blk (
 VP *p_blk, ID mplid, INT blksz
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES:


@c
@c  tget_blk
@c

@page
@subsection tget_blk - Get Variable-Size Memory Block with Timeout

@subheading CALLING SEQUENCE:

@ifset is-C
@example
ER ercd =tget_blk (
 VP *p_blk, ID mplid, INT blksz, TMO tmout
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES:


@c
@c  rel_blk
@c

@page
@subsection rel_blk - Release Variable-Size Memory Block

@subheading CALLING SEQUENCE:

@ifset is-C
@example
ER rel_blk (
 ID mplid, VP blk
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES:


@c
@c  ref_mpl
@c

@page
@subsection ref_mpl - Reference Variable-Size Memorypool Status

@subheading CALLING SEQUENCE:

@ifset is-C
@example
ER ref_mpl (
 T_RMPL *pk_rmpl, ID mplid
);
@end example
@end ifset

@ifset is-Ada
@end ifset

@subheading STATUS CODES:

@code{EXXX} - 

@subheading DESCRIPTION:

@subheading NOTES: