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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
|
/*
ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio.
This file is part of ChibiOS.
ChibiOS is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
ChibiOS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file chobjfifos.h
* @brief Objects FIFO structures and macros.
* @details This module implements a generic FIFO queue of objects by
* coupling a Guarded Memory Pool (for objects storage) and
* a MailBox.<br>
* On the sender side free objects are taken from the pool, filled
* and then sent to the receiver, on the receiver side objects are
* fetched, used and then returned to the pool.
* Operations defined for object FIFOs:
* - <b>Take</b>: An object is taken from the pool of the free
* objects, can be blocking.
* - <b>Return</b>: An object is returned to the pool of the
* free objects, it is guaranteed to be non-blocking.
* - <b>Send</b>: An object is sent through the mailbox, it is
* guaranteed to be non-blocking
* - <b>Receive</b>: An object is received from the mailbox,
* can be blocking.
* .
*
* @addtogroup oslib_objects_fifos
* @{
*/
#ifndef CHOBJFIFOS_H
#define CHOBJFIFOS_H
#if (CH_CFG_USE_OBJ_FIFOS == TRUE) || defined(__DOXYGEN__)
/*===========================================================================*/
/* Module constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Module pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if CH_CFG_USE_MEMPOOLS == FALSE
#error "CH_CFG_USE_OBJ_FIFOS requires CH_CFG_USE_MEMPOOLS"
#endif
#if CH_CFG_USE_SEMAPHORES == FALSE
#error "CH_CFG_USE_OBJ_FIFOS requires CH_CFG_USE_SEMAPHORES"
#endif
#if CH_CFG_USE_MAILBOXES == FALSE
#error "CH_CFG_USE_OBJ_FIFOS requires CH_CFG_USE_MAILBOXES"
#endif
/*===========================================================================*/
/* Module data structures and types. */
/*===========================================================================*/
/**
* @brief Type of an objects FIFO.
*/
typedef struct ch_objects_fifo {
/**
* @brief Pool of the free objects.
*/
guarded_memory_pool_t free;
/**
* @brief Mailbox of the sent objects.
*/
mailbox_t mbx;
} objects_fifo_t;
/*===========================================================================*/
/* Module macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
#ifdef __cplusplus
}
#endif
/*===========================================================================*/
/* Module inline functions. */
/*===========================================================================*/
/**
* @brief Initializes a FIFO object.
* @pre The messages size must be a multiple of the alignment
* requirement.
*
* @param[out] ofp pointer to a @p objects_fifo_t structure
* @param[in] objsize size of objects
* @param[in] objn number of objects available
* @param[in] objalign required objects alignment
* @param[in] objbuf pointer to the buffer of objects, it must be able
* to hold @p objn objects of @p objsize size with
* @p objealign alignment
* @param[in] msgbuf pointer to the buffer of messages, it must be able
* to hold @p objn messages
*
* @init
*/
static inline void chFifoObjectInitAligned(objects_fifo_t *ofp, size_t objsize,
size_t objn, unsigned objalign,
void *objbuf, msg_t *msgbuf) {
chDbgCheck((objsize >= objalign) && ((objsize % objalign) == 0U));
chGuardedPoolObjectInitAligned(&ofp->free, objsize, objalign);
chGuardedPoolLoadArray(&ofp->free, objbuf, objn);
chMBObjectInit(&ofp->mbx, msgbuf, objn);
}
/**
* @brief Initializes a FIFO object.
* @pre The messages size must be a multiple of the alignment
* requirement.
*
* @param[out] ofp pointer to a @p objects_fifo_t structure
* @param[in] objsize size of objects
* @param[in] objn number of objects available
* @param[in] objbuf pointer to the buffer of objects, it must be able
* to hold @p objn objects of @p objsize size with
* @p objealign alignment
* @param[in] msgbuf pointer to the buffer of messages, it must be able
* to hold @p objn messages
*
* @init
*/
static inline void chFifoObjectInit(objects_fifo_t *ofp, size_t objsize,
size_t objn, void *objbuf,
msg_t *msgbuf) {
chFifoObjectInitAligned(ofp, objsize, objn,
PORT_NATURAL_ALIGN,
objbuf, msgbuf);
}
/**
* @brief Allocates a free object.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @return The pointer to the allocated object.
* @retval NULL if an object is not immediately available.
*
* @iclass
*/
static inline void *chFifoTakeObjectI(objects_fifo_t *ofp) {
return chGuardedPoolAllocI(&ofp->free);
}
/**
* @brief Allocates a free object.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout.
* - @a TIME_INFINITE no timeout.
* .
* @return The pointer to the allocated object.
* @retval NULL if an object is not available within the specified
* timeout.
*
* @sclass
*/
static inline void *chFifoTakeObjectTimeoutS(objects_fifo_t *ofp,
sysinterval_t timeout) {
return chGuardedPoolAllocTimeoutS(&ofp->free, timeout);
}
/**
* @brief Allocates a free object.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout.
* - @a TIME_INFINITE no timeout.
* .
* @return The pointer to the allocated object.
* @retval NULL if an object is not available within the specified
* timeout.
*
* @api
*/
static inline void *chFifoTakeObjectTimeout(objects_fifo_t *ofp,
sysinterval_t timeout) {
return chGuardedPoolAllocTimeout(&ofp->free, timeout);
}
/**
* @brief Releases a fetched object.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objp pointer to the object to be released
*
* @iclass
*/
static inline void chFifoReturnObjectI(objects_fifo_t *ofp,
void *objp) {
chGuardedPoolFreeI(&ofp->free, objp);
}
/**
* @brief Releases a fetched object.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objp pointer to the object to be released
*
* @sclass
*/
static inline void chFifoReturnObjectS(objects_fifo_t *ofp,
void *objp) {
chGuardedPoolFreeS(&ofp->free, objp);
}
/**
* @brief Releases a fetched object.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objp pointer to the object to be released
*
* @api
*/
static inline void chFifoReturnObject(objects_fifo_t *ofp,
void *objp) {
chGuardedPoolFree(&ofp->free, objp);
}
/**
* @brief Posts an object.
* @note By design the object can be always immediately posted.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objp pointer to the object to be posted
*
* @iclass
*/
static inline void chFifoSendObjectI(objects_fifo_t *ofp,
void *objp) {
msg_t msg;
msg = chMBPostI(&ofp->mbx, (msg_t)objp);
chDbgAssert(msg == MSG_OK, "post failed");
}
/**
* @brief Posts an object.
* @note By design the object can be always immediately posted.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objp pointer to the object to be posted
*
* @sclass
*/
static inline void chFifoSendObjectS(objects_fifo_t *ofp,
void *objp) {
msg_t msg;
msg = chMBPostTimeoutS(&ofp->mbx, (msg_t)objp, TIME_IMMEDIATE);
chDbgAssert(msg == MSG_OK, "post failed");
}
/**
* @brief Posts an object.
* @note By design the object can be always immediately posted.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objp pointer to the object to be released
*
* @api
*/
static inline void chFifoSendObject(objects_fifo_t *ofp, void *objp) {
msg_t msg;
msg = chMBPostTimeout(&ofp->mbx, (msg_t)objp, TIME_IMMEDIATE);
chDbgAssert(msg == MSG_OK, "post failed");
}
/**
* @brief Posts an high priority object.
* @note By design the object can be always immediately posted.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objp pointer to the object to be posted
*
* @iclass
*/
static inline void chFifoSendObjectAheadI(objects_fifo_t *ofp,
void *objp) {
msg_t msg;
msg = chMBPostAheadI(&ofp->mbx, (msg_t)objp);
chDbgAssert(msg == MSG_OK, "post failed");
}
/**
* @brief Posts an high priority object.
* @note By design the object can be always immediately posted.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objp pointer to the object to be posted
*
* @sclass
*/
static inline void chFifoSendObjectAheadS(objects_fifo_t *ofp,
void *objp) {
msg_t msg;
msg = chMBPostAheadTimeoutS(&ofp->mbx, (msg_t)objp, TIME_IMMEDIATE);
chDbgAssert(msg == MSG_OK, "post failed");
}
/**
* @brief Posts an high priority object.
* @note By design the object can be always immediately posted.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objp pointer to the object to be released
*
* @api
*/
static inline void chFifoSendObjectAhead(objects_fifo_t *ofp, void *objp) {
msg_t msg;
msg = chMBPostAheadTimeout(&ofp->mbx, (msg_t)objp, TIME_IMMEDIATE);
chDbgAssert(msg == MSG_OK, "post failed");
}
/**
* @brief Fetches an object.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objpp pointer to the fetched object reference
* @return The operation status.
* @retval MSG_OK if an object has been correctly fetched.
* @retval MSG_TIMEOUT if the FIFO is empty and a message cannot be fetched.
*
* @iclass
*/
static inline msg_t chFifoReceiveObjectI(objects_fifo_t *ofp,
void **objpp) {
return chMBFetchI(&ofp->mbx, (msg_t *)objpp);
}
/**
* @brief Fetches an object.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objpp pointer to the fetched object reference
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout.
* - @a TIME_INFINITE no timeout.
* .
* @return The operation status.
* @retval MSG_OK if an object has been correctly fetched.
* @retval MSG_TIMEOUT if the operation has timed out.
*
* @sclass
*/
static inline msg_t chFifoReceiveObjectTimeoutS(objects_fifo_t *ofp,
void **objpp,
sysinterval_t timeout) {
return chMBFetchTimeoutS(&ofp->mbx, (msg_t *)objpp, timeout);
}
/**
* @brief Fetches an object.
*
* @param[in] ofp pointer to a @p objects_fifo_t structure
* @param[in] objpp pointer to the fetched object reference
* @param[in] timeout the number of ticks before the operation timeouts,
* the following special values are allowed:
* - @a TIME_IMMEDIATE immediate timeout.
* - @a TIME_INFINITE no timeout.
* .
* @return The operation status.
* @retval MSG_OK if an object has been correctly fetched.
* @retval MSG_TIMEOUT if the operation has timed out.
*
* @api
*/
static inline msg_t chFifoReceiveObjectTimeout(objects_fifo_t *ofp,
void **objpp,
sysinterval_t timeout) {
return chMBFetchTimeout(&ofp->mbx, (msg_t *)objpp, timeout);
}
#endif /* CH_CFG_USE_OBJ_FIFOS == TRUE */
#endif /* CHOBJFIFOS_H */
/** @} */
|
