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
|
/*
ChibiOS - Copyright (C) 2006..2015 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 (*dbnotify_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 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.
*/
dbnotify_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 sumber 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 Evaluates to @p TRUE if the specified input buffered 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 buffered 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) ((bool)(((ibqp)->bwrptr == (ibqp)->brdptr) && \
((ibqp)->bcounter != 0U)))
/** @} */
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void ibqObjectInit(io_buffers_queue_t *ibqp, uint8_t *bp,
size_t size, size_t n,
dbnotify_t infy, void *link);
void ibqResetI(input_buffers_queue_t *ibqp);
uint8_t *ibqGetEmptyBufferI(input_buffers_queue_t *ibqp);
void ibqPostBufferI(input_buffers_queue_t *ibqp, size_t size);
msg_t ibqGetDataTimeoutI(input_buffers_queue_t *ibqp, systime_t timeout);
void ibqReleaseDataI(input_buffers_queue_t *ibqp);
msg_t ibqGetTimeout(input_buffers_queue_t *ibqp, systime_t timeout);
size_t ibqReadTimeout(input_buffers_queue_t *ibqp, uint8_t *bp,
size_t n, systime_t timeout);
#ifdef __cplusplus
}
#endif
#endif /* _HAL_BUFFERS_H_ */
/** @} */
|
