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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
|
/*
ChibiOS - Copyright (C) 2016..2018 Theodore Ateba
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 USARTv1/hal_uart_lld.h
* @brief AVR UART subsystem low level driver header.
*
* @addtogroup UART
* @{
*/
#ifndef HAL_UART_LLD_H
#define HAL_UART_LLD_H
#if (HAL_USE_UART == TRUE) || defined(__DOXYGEN__)
/*==========================================================================*/
/* Driver constants. */
/*==========================================================================*/
/**
* @brief USART communication mode enumerations.
*/
typedef enum {
USART_CMODE_ASYNCHRONOUS = 0x00, /**< USART asynchronous mode. */
USART_CMODE_SYNCHRONOUS = 0x01, /**< USART synchronous mode. */
USART_CMODE_IRCOM = 0x10, /**< USART IRCOM mode. */
USART_CMODE_MSPI = 0x11, /**< USART MSPI mode. */
} usartcmode_t;
/**
* @brief USART parity mode enumerations.
*/
typedef enum {
USART_PMODE_DISABLE = 0x00, /**< USART use no parity. */
USART_PMODE_EVEN = 0x10, /**< USART use even parity. */
USART_PMODE_ODD = 0x11 /**< USART use odd parity. */
} usartpmode_t;
/**
* @brief USART stop bit mode enumerations.
*/
typedef enum {
USART_SBMODE_1BIT = FALSE, /**< USART use 1 stop bit. */
USART_SBMODE_2BIT = TRUE /**< USART use 2 stop bit. */
} usartsbmode_t;
/**
* @brief character size enumerations.
*/
typedef enum {
USART_CHSIZE_5BIT = 0x00, /**< USART use 5 bytes for data. */
USART_CHSIZE_6BIT = 0x01, /**< USART use 6 bytes for data. */
USART_CHSIZE_7BIT = 0x02, /**< USART use 7 bytes for data. */
USART_CHSIZE_8BIT = 0x03, /**< USART use 8 bytes for data. */
USART_CHSIZE_9BIT = 0x07 /**< USART use 9 bytes for data. */
} usartchsize_t;
/*==========================================================================*/
/* Driver pre-compile time settings. */
/*==========================================================================*/
/**
* @name PLATFORM configuration options
* @{
*/
/**
* @brief UART driver on USART1 (USARTC0) enable switch.
* @details If set to @p TRUE the support for USART1 is included.
* @note The default is @p FALSE.
*/
#if !defined(AVR_UART_USE_USART1) || defined(__DOXYGEN__)
#define AVR_UART_USE_USART1 FALSE
#endif
/**
* @brief UART driver on USART2 (USARTC1) enable switch.
* @details If set to @p TRUE the support for USART2 is included.
* @note The default is @p FALSE.
*/
#if !defined(AVR_UART_USE_USART2) || defined(__DOXYGEN__)
#define AVR_UART_USE_UART1 FALSE
#endif
/**
* @brief UART driver on USART3 (USARTD0) enable switch.
* @details If set to @p TRUE the support for USART3 is included.
* @note The default is @p FALSE.
*/
#if !defined(AVR_UART_USE_USART3) || defined(__DOXYGEN__)
#define AVR_UART_USE_USART3 FALSE
#endif
/**
* @brief UART driver on USART4 (USARTD1) enable switch.
* @details If set to @p TRUE the support for USART4 is included.
* @note The default is @p FALSE.
*/
#if !defined(AVR_UART_USE_USART4) || defined(__DOXYGEN__)
#define AVR_UART_USE_USART4 FALSE
#endif
/**
* @brief UART driver on USARTE0 enable switch.
* @details If set to @p TRUE the support for USARTE0 is included.
* @note The default is @p FALSE.
*/
#if !defined(AVR_UART_USE_USART5) || defined(__DOXYGEN__)
#define AVR_UART_USE_USART5 FALSE
#endif
/**
* @brief USART1 (USARTC0) interrupt priority level setting.
*/
#if !defined(AVR_UART_USART1_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define AVR_UART_USART1_IRQ_PRIORITY 12
#endif
/**
* @brief USART2 (USARTC1) interrupt priority level setting.
*/
#if !defined(AVR_UART_USART2_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define AVR_UART_USART2_IRQ_PRIORITY 12
#endif
/**
* @brief USART3 (USARTD0) interrupt priority level setting.
*/
#if !defined(AVR_UART_USART3_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define AVR_UART_USART3_IRQ_PRIORITY 12
#endif
/**
* @brief USART4 (USARTD1) interrupt priority level setting.
*/
#if !defined(AVR_UART_USART4_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define AVR_UART_USART4_IRQ_PRIORITY 12
#endif
/**
* @brief USART5 (USARTE0) interrupt priority level setting.
*/
#if !defined(AVR_UART_USART5_IRQ_PRIORITY) || defined(__DOXYGEN__)
#define AVR_UART_USART5_IRQ_PRIORITY 12
#endif
/**
* @brief USART1 (USARTC0) DMA priority (0..3|lowest..highest).
* @note The priority level is used for both the TX and RX DMA channels but
* because of the channels ordering the RX channel has always priority
* over the TX channel.
*/
#if !defined(AVR_UART_USART1_DMA_PRIORITY) || defined(__DOXYGEN__)
#define AVR_UART_USART1_DMA_PRIORITY 0
#endif
/**
* @brief USART2 (USARTC1) DMA priority (0..3|lowest..highest).
* @note The priority level is used for both the TX and RX DMA channels but
* because of the channels ordering the RX channel has always priority
* over the TX channel.
*/
#if !defined(AVR_UART_USART2_DMA_PRIORITY) || defined(__DOXYGEN__)
#define AVR_UART_USART2_DMA_PRIORITY 0
#endif
/**
* @brief USART3 (USARTD0) DMA priority (0..3|lowest..highest).
* @note The priority level is used for both the TX and RX DMA channels but
* because of the channels ordering the RX channel has always priority
* over the TX channel.
*/
#if !defined(AVR_UART_USART3_DMA_PRIORITY) || defined(__DOXYGEN__)
#define AVR_UART_USART3_DMA_PRIORITY 0
#endif
/**
* @brief USART4 (USARTD1) DMA priority (0..3|lowest..highest).
* @note The priority level is used for both the TX and RX DMA channels but
* because of the channels ordering the RX channel has always priority
* over the TX channel.
*/
#if !defined(AVR_UART_USART4_DMA_PRIORITY) || defined(__DOXYGEN__)
#define AVR_UART_USART4_DMA_PRIORITY 0
#endif
/**
* @brief USART5 (USARTE0) DMA priority (0..3|lowest..highest).
* @note The priority level is used for both the TX and RX DMA channels but
* because of the channels ordering the RX channel has always priority
* over the TX channel.
*/
#if !defined(AVR_UART_USART5_DMA_PRIORITY) || defined(__DOXYGEN__)
#define AVR_UART_USART5_DMA_PRIORITY 0
#endif
/** @} */
/*==========================================================================*/
/* Derived constants and error checks. */
/*==========================================================================*/
#if !AVR_UART_USE_USART1 && !AVR_UART_USE_USART2 && \
!AVR_UART_USE_USART3 && !AVR_UART_USE_USART4 && \
!AVR_UART_USE_USART5
#error "UART driver activated but no USART peripheral assigned"
#endif
/*==========================================================================*/
/* Driver data structures and types. */
/*==========================================================================*/
/**
* @brief UART driver condition flags type.
*/
typedef uint8_t uartflags_t;
/**
* @brief Type of structure representing an UART driver.
*/
typedef struct UARTDriver UARTDriver;
/**
* @brief Generic UART notification callback type.
*
* @param[in] uartp pointer to the @p UARTDriver object
*/
typedef void (*uartcb_t)(UARTDriver *uartp);
/**
* @brief Character received UART notification callback type.
*
* @param[in] uartp pointer to the @p UARTDriver object triggering the
* callback
* @param[in] c received character
*/
typedef void (*uartccb_t)(UARTDriver *uartp, uint16_t c);
/**
* @brief Receive error UART notification callback type.
*
* @param[in] uartp pointer to the @p UARTDriver object triggering the
* callback
* @param[in] e receive error mask
*/
typedef void (*uartecb_t)(UARTDriver *uartp, uartflags_t e);
/**
* @brief Driver configuration structure.
* @note Implementations may extend this structure to contain more,
* architecture dependent, fields.
*/
typedef struct {
/**
* @brief End of transmission buffer callback.
*/
uartcb_t txend1_cb;
/**
* @brief Physical end of transmission callback.
*/
uartcb_t txend2_cb;
/**
* @brief Receive buffer filled callback.
*/
uartcb_t rxend_cb;
/**
* @brief Character received while out if the @p UART_RECEIVE state.
*/
uartccb_t rxchar_cb;
/**
* @brief Receive error callback.
*/
uartecb_t rxerr_cb;
/* End of tihe mandatory fields. */
/**
* @brief Bit rate.
*/
uint32_t speed;
/**
* @brief Double transmission speed.
*/
bool clk2x;
/**
* @brief Multiprocessor communication mode bit.
*/
bool mpcm;
/**
* @brief Transmission bit 8.
*/
bool txb8;
/**
* @brief Communication mode.
*/
uint8_t cmode;
/**
* @brief Parity mode.
*/
uint8_t pmode;
/**
* @brief Stop bit mode.
*/
bool sbmode;
/**
* @brief Caractere size.
*/
uint8_t chsize;
} UARTConfig;
/**
* @brief Structure representing an UART driver.
* @note Implementations may extend this structure to contain more,
* architecture dependent, fields.
*/
struct UARTDriver {
/**
* @brief Driver state.
*/
uartstate_t state;
/**
* @brief Transmitter state.
*/
uarttxstate_t txstate;
/**
* @brief Receiver state.
*/
uartrxstate_t rxstate;
/**
* @brief Current configuration data.
*/
const UARTConfig *config;
#if (UART_USE_WAIT == TRUE) || defined(__DOXYGEN__)
/**
* @brief Synchronization flag for transmit operations.
*/
bool early;
/**
* @brief Waiting thread on RX.
*/
thread_reference_t threadrx;
/**
* @brief Waiting thread on TX.
*/
thread_reference_t threadtx;
#endif /* UART_USE_WAIT */
#if (UART_USE_MUTUAL_EXCLUSION == TRUE) || defined(__DOXYGEN__)
/**
* @brief Mutex protecting the peripheral.
*/
mutex_t mutex;
#endif /* UART_USE_MUTUAL_EXCLUSION */
#if defined(UART_DRIVER_EXT_FIELDS)
UART_DRIVER_EXT_FIELDS
#endif
/* End of the mandatory fields. */
/**
* @brief Pointer to the USART registers block.
*/
USART_t *usart;
/**
* @brief Clock frequency for the associated USART/UART.
*/
uint32_t clock;
/**
* @brief DMA mode bit mask.
*/
uint32_t dmamode;
/**
* @brief Receive DMA channel.
*/
const DMA_t *dmarx;
/**
* @brief Transmit DMA channel.
*/
const DMA_t *dmatx;
/**
* @brief Default receive buffer while into @p UART_RX_IDLE state.
*/
volatile uint16_t rxbuf;
};
/*==========================================================================*/
/* Driver macros. */
/*==========================================================================*/
/**
* @brief This is a macro function to calcul BSEL value according to
* the baudrate selected by the user.
*
* @param[in] baud the baudrate to be configure
*/
#define get_bsel(baud) (F_CPU/(16*baud))-1
/*==========================================================================*/
/* External declarations. */
/*==========================================================================*/
#if (AVR_UART_USE_USART1 == TRUE) && !defined(__DOXYGEN__)
extern UARTDriver USART1D;
#endif
#if (AVR_UART_USE_USART2 == TRUE) && !defined(__DOXYGEN__)
extern UARTDriver USART2D;
#endif
#if (AVR_UART_USE_USART3 == TRUE) && !defined(__DOXYGEN__)
extern UARTDriver USART3D;
#endif
#if (AVR_UART_USE_USART4 == TRUE) && !defined(__DOXYGEN__)
extern UARTDriver USART4D;
#endif
#if (AVR_UART_USE_USART5 == TRUE) && !defined(__DOXYGEN__)
extern UARTDriver USART5D;
#endif
#ifdef __cplusplus
extern "C" {
#endif
void uart_lld_init(void);
void uart_lld_start(UARTDriver *uartp);
void uart_lld_stop(UARTDriver *uartp);
void uart_lld_start_send(UARTDriver *uartp, size_t n, const uint8_t *txbuf);
size_t uart_lld_stop_send(UARTDriver *uartp);
void uart_lld_start_receive(UARTDriver *uartp, size_t n, void *rxbuf);
size_t uart_lld_stop_receive(UARTDriver *uartp);
#ifdef __cplusplus
}
#endif
#endif /* HAL_USE_UART == TRUE */
#endif /* HAL_UART_LLD_H */
/** @} */
|
