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
|
/*
ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @file hal_buffers.h
* @brief I/O Buffers macros and structures.
*
* @addtogroup HAL_BUFFERS
* @{
*/
#ifndef HAL_BUFFERS_H
#define HAL_BUFFERS_H
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Type of a generic queue of buffers.
*/
typedef struct io_buffers_queue io_buffers_queue_t;
/**
* @brief Double buffer notification callback type.
*
* @param[in] iodbp the buffers queue pointer
*/
typedef void (*bqnotify_t)(io_buffers_queue_t *bqp);
/**
* @brief Structure of a generic buffers queue.
*/
struct io_buffers_queue {
/**
* @brief Queue of waiting threads.
*/
threads_queue_t waiting;
/**
* @brief Queue suspended state flag.
*/
bool suspended;
/**
* @brief Active buffers counter.
*/
volatile size_t bcounter;
/**
* @brief Buffer write pointer.
*/
uint8_t *bwrptr;
/**
* @brief Buffer read pointer.
*/
uint8_t *brdptr;
/**
* @brief Pointer to the buffers boundary.
*/
uint8_t *btop;
/**
* @brief Size of buffers.
* @note The buffer size must be not lower than <tt>sizeof(size_t) + 2</tt>
* because the first bytes are used to store the used size of the
* buffer.
*/
size_t bsize;
/**
* @brief Number of buffers.
*/
size_t bn;
/**
* @brief Queue of buffer objects.
*/
uint8_t *buffers;
/**
* @brief Pointer for R/W sequential access.
* @note It is @p NULL if a new buffer must be fetched from the queue.
*/
uint8_t *ptr;
/**
* @brief Boundary for R/W sequential access.
*/
uint8_t *top;
/**
* @brief Data notification callback.
*/
bqnotify_t notify;
/**
* @brief Application defined field.
*/
void *link;
};
/**
* @brief Type of an input buffers queue.
*/
typedef io_buffers_queue_t input_buffers_queue_t;
/**
* @brief Type of an output buffers queue.
*/
typedef io_buffers_queue_t output_buffers_queue_t;
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @brief Computes the size of a buffers queue buffer size.
*
* @param[in] n number of buffers in the queue
* @param[in] size size of the buffers
*/
#define BQ_BUFFER_SIZE(n, size) \
(((size_t)(size) + sizeof (size_t)) * (size_t)(n))
/**
* @name Macro Functions
* @{
*/
/**
* @brief Returns the queue's number of buffers.
*
* @param[in] bqp pointer to an @p io_buffers_queue_t structure
* @return The number of buffers.
*
* @xclass
*/
#define bqSizeX(bqp) ((bqp)->bn)
/**
* @brief Return the ready buffers number.
* @details Returns the number of filled buffers if used on an input queue
* or the number of empty buffers if used on an output queue.
*
* @param[in] bqp pointer to an @p io_buffers_queue_t structure
* @return The number of ready buffers.
*
* @iclass
*/
#define bqSpaceI(bqp) ((bqp)->bcounter)
/**
* @brief Returns the queue application-defined link.
*
* @param[in] bqp pointer to an @p io_buffers_queue_t structure
* @return The application-defined link.
*
* @special
*/
#define bqGetLinkX(bqp) ((bqp)->link)
/**
* @brief Return the suspended state of the queue.
*
* @param[in] bqp pointer to an @p io_buffers_queue_t structure
* @return The suspended state.
* @retval false if blocking access to the queue is enabled.
* @retval true if blocking access to the queue is suspended.
*
* @xclass
*/
#define bqIsSuspendedX(bqp) ((bqp)->suspended)
/**
* @brief Puts the queue in suspended state.
* @details When the queue is put in suspended state all waiting threads are
* woken with message @p MSG_RESET and subsequent attempt at waiting
* on the queue will result in an immediate return with @p MSG_RESET
* message.
* @note The content of the queue is not altered, queues can be accessed
* is suspended state until a blocking operation is met then a
* @p MSG_RESET occurs.
*
* @param[in] bqp pointer to an @p io_buffers_queue_t structure
*
* @iclass
*/
#define bqSuspendI(bqp) { \
(bqp)->suspended = true; \
osalThreadDequeueAllI(&(bqp)->waiting, MSG_RESET); \
}
/**
* @brief Resumes normal queue operations.
*
* @param[in] bqp pointer to an @p io_buffers_queue_t structure
*
* @xclass
*/
#define bqResumeX(bqp) { \
(bqp)->suspended = false; \
}
/**
* @brief Evaluates to @p true if the specified input buffers queue is empty.
*
* @param[in] ibqp pointer to an @p input_buffers_queue_t structure
* @return The queue status.
* @retval false if the queue is not empty.
* @retval true if the queue is empty.
*
* @iclass
*/
#define ibqIsEmptyI(ibqp) ((bool)(bqSpaceI(ibqp) == 0U))
/**
* @brief Evaluates to @p true if the specified input buffers queue is full.
*
* @param[in] ibqp pointer to an @p input_buffers_queue_t structure
* @return The queue status.
* @retval false if the queue is not full.
* @retval true if the queue is full.
*
* @iclass
*/
#define ibqIsFullI(ibqp) \
/*lint -save -e9007 [13.5] No side effects, a pointer is passed.*/ \
((bool)(((ibqp)->bwrptr == (ibqp)->brdptr) && ((ibqp)->bcounter != 0U))) \
/*lint -restore*/
/**
* @brief Evaluates to @p true if the specified output buffers queue is empty.
*
* @param[in] obqp pointer to an @p output_buffers_queue_t structure
* @return The queue status.
* @retval false if the queue is not empty.
* @retval true if the queue is empty.
*
* @iclass
*/
#define obqIsEmptyI(obqp) \
/*lint -save -e9007 [13.5] No side effects, a pointer is passed.*/ \
((bool)(((obqp)->bwrptr == (obqp)->brdptr) && ((obqp)->bcounter != 0U))) \
/*lint -restore*/
/**
* @brief Evaluates to @p true if the specified output buffers queue is full.
*
* @param[in] obqp pointer to an @p output_buffers_queue_t structure
* @return The queue status.
* @retval false if the queue is not full.
* @retval true if the queue is full.
*
* @iclass
*/
#define obqIsFullI(obqp) ((bool)(bqSpaceI(obqp) == 0U))
/** @} */
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void ibqObjectInit(input_buffers_queue_t *ibqp, bool suspended, uint8_t *bp,
size_t size, size_t n, bqnotify_t infy, void *link);
void ibqResetI(input_buffers_queue_t *ibqp);
uint8_t *ibqGetEmptyBufferI(input_buffers_queue_t *ibqp);
void ibqPostFullBufferI(input_buffers_queue_t *ibqp, size_t size);
msg_t ibqGetFullBufferTimeout(input_buffers_queue_t *ibqp,
sysinterval_t timeout);
msg_t ibqGetFullBufferTimeoutS(input_buffers_queue_t *ibqp,
sysinterval_t timeout);
void ibqReleaseEmptyBuffer(input_buffers_queue_t *ibqp);
void ibqReleaseEmptyBufferS(input_buffers_queue_t *ibqp);
msg_t ibqGetTimeout(input_buffers_queue_t *ibqp, sysinterval_t timeout);
size_t ibqReadTimeout(input_buffers_queue_t *ibqp, uint8_t *bp,
size_t n, sysinterval_t timeout);
void obqObjectInit(output_buffers_queue_t *obqp, bool suspended, uint8_t *bp,
size_t size, size_t n, bqnotify_t onfy, void *link);
void obqResetI(output_buffers_queue_t *obqp);
uint8_t *obqGetFullBufferI(output_buffers_queue_t *obqp,
size_t *sizep);
void obqReleaseEmptyBufferI(output_buffers_queue_t *obqp);
msg_t obqGetEmptyBufferTimeout(output_buffers_queue_t *obqp,
sysinterval_t timeout);
msg_t obqGetEmptyBufferTimeoutS(output_buffers_queue_t *obqp,
sysinterval_t timeout);
void obqPostFullBuffer(output_buffers_queue_t *obqp, size_t size);
void obqPostFullBufferS(output_buffers_queue_t *obqp, size_t size);
msg_t obqPutTimeout(output_buffers_queue_t *obqp, uint8_t b,
sysinterval_t timeout);
size_t obqWriteTimeout(output_buffers_queue_t *obqp, const uint8_t *bp,
size_t n, sysinterval_t timeout);
bool obqTryFlushI(output_buffers_queue_t *obqp);
void obqFlush(output_buffers_queue_t *obqp);
#ifdef __cplusplus
}
#endif
#endif /* HAL_BUFFERS_H */
/** @} */
|
