VSF Documented
vsf_template_usart.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __VSF_TEMPLATE_USART_H__
19#define __VSF_TEMPLATE_USART_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "./vsf_template_hal_driver.h"
24#include "hal/arch/vsf_arch.h"
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29/*============================ MACROS ========================================*/
30
31// multi-class support enabled by default for maximum availability.
32#ifndef VSF_USART_CFG_MULTI_CLASS
33# define VSF_USART_CFG_MULTI_CLASS ENABLED
34#endif
35
36#if defined(VSF_HW_USART_COUNT) && !defined(VSF_HW_USART_MASK)
37# define VSF_HW_USART_MASK VSF_HAL_COUNT_TO_MASK(VSF_HW_USART_COUNT)
38#endif
39
40#if defined(VSF_HW_USART_MASK) && !defined(VSF_HW_USART_COUNT)
41# define VSF_HW_USART_COUNT VSF_HAL_MASK_TO_COUNT(VSF_HW_USART_MASK)
42#endif
43
53#ifndef VSF_USART_CFG_PREFIX
54# if VSF_USART_CFG_MULTI_CLASS == ENABLED
55# define VSF_USART_CFG_PREFIX vsf
56# elif defined(VSF_HW_USART_COUNT) && (VSF_HW_USART_COUNT != 0)
57# define VSF_USART_CFG_PREFIX vsf_hw
58# else
59# define VSF_USART_CFG_PREFIX vsf
60# endif
61#endif
62
65#ifndef VSF_USART_CFG_FUNCTION_RENAME
66# define VSF_USART_CFG_FUNCTION_RENAME ENABLED
67#endif
68
71#ifndef VSF_USART_CFG_REIMPLEMENT_TYPE_MODE
72# define VSF_USART_CFG_REIMPLEMENT_TYPE_MODE DISABLED
73#endif
74
77#ifndef VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK
78# define VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK DISABLED
79#endif
80
83#ifndef VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS
84# define VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS DISABLED
85#endif
86
89#ifndef VSF_USART_CFG_REIMPLEMENT_TYPE_CMD
90# define VSF_USART_CFG_REIMPLEMENT_TYPE_CMD DISABLED
91#endif
92
93#ifndef VSF_USART_CFG_REIMPLEMENT_MODE_TO_DATA_BITS
94# define VSF_USART_CFG_REIMPLEMENT_MODE_TO_DATA_BITS \
95 DISABLED
96#endif
97
101#if VSF_USART_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
102# define VSF_USART_CFG_REIMPLEMENT_TYPE_CFG DISABLED
103#endif
104
108#if VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
109# define VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
110#endif
111
112#ifndef VSF_USART_CFG_INHERT_HAL_CAPABILITY
113# define VSF_USART_CFG_INHERT_HAL_CAPABILITY ENABLED
114#endif
115
116#ifndef VSF_USART_CFG_REQUEST_API
117# define VSF_USART_CFG_REQUEST_API ENABLED
118#endif
119
120#ifndef VSF_USART_CFG_FIFO_API
121# define VSF_USART_CFG_FIFO_API ENABLED
122#endif
123
124/*============================ MACROFIED FUNCTIONS ===========================*/
125
126#define __VSF_USART_BASE_APIS(__prefix_name) \
127 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, init, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr, vsf_usart_cfg_t *cfg_ptr) \
128 __VSF_HAL_TEMPLATE_API(__prefix_name, void, usart, fini, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
129 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, usart, enable, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
130 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, usart, disable, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
131 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_usart_capability_t, usart, capability, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
132 __VSF_HAL_TEMPLATE_API(__prefix_name, void, usart, irq_enable, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr, vsf_usart_irq_mask_t irq_mask) \
133 __VSF_HAL_TEMPLATE_API(__prefix_name, void, usart, irq_disable, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr, vsf_usart_irq_mask_t irq_mask) \
134 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_usart_status_t, usart, status, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr)
135
136#if VSF_USART_CFG_FIFO_API == ENABLED
137# define __VSF_USART_FIFO_APIS(__prefix_name) \
138 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast16_t, usart, rxfifo_get_data_count, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
139 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast16_t, usart, rxfifo_read, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr, void *buffer_ptr, uint_fast16_t count) \
140 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast16_t, usart, txfifo_get_free_count, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
141 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast16_t, usart, txfifo_write, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr, void *buffer_ptr, uint_fast16_t count)
142#else
143# define __VSF_USART_FIFO_APIS(__prefix_name)
144#endif
145
146#if VSF_USART_CFG_REQUEST_API == ENABLED
147# define __VSF_USART_REQUEST_APIS(__prefix_name) \
148 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, request_rx, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr, void *buffer_ptr, uint_fast32_t count) \
149 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, request_tx, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr, void *buffer_ptr, uint_fast32_t count) \
150 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, cancel_rx, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
151 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, cancel_tx, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
152 __VSF_HAL_TEMPLATE_API(__prefix_name, int_fast32_t, usart, get_rx_count, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
153 __VSF_HAL_TEMPLATE_API(__prefix_name, int_fast32_t, usart, get_tx_count, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr)
154#else
155# define __VSF_USART_REQUEST_APIS(__prefix_name)
156#endif
157
158#define __VSF_USART_REQUEST_EXTRA_APIS(__prefix_name) \
159 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, cmd, VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr, vsf_usart_cmd_t cmd, void* param)
160
161#define VSF_USART_ADDITIONAL_APIS(__prefix_name) \
162 static inline vsf_err_t VSF_MCONNECT(__prefix_name, _usart_send_break) \
163 (VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
164 { \
165 return VSF_MCONNECT(__prefix_name, _usart_cmd)(usart_ptr, \
166 VSF_USART_CMD_SEND_BREAK, NULL); \
167 } \
168 static inline vsf_err_t VSF_MCONNECT(__prefix_name, _usart_set_break) \
169 (VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
170 { \
171 vsf_usart_capability_t cap = \
172 VSF_MCONNECT(__prefix_name, _usart_capability)(usart_ptr); \
173 VSF_HAL_ASSERT(cap.support_set_and_clear_break); \
174 return VSF_MCONNECT(__prefix_name, _usart_cmd)(usart_ptr, \
175 VSF_USART_CMD_SET_BREAK, NULL); \
176 } \
177 static inline vsf_err_t VSF_MCONNECT(__prefix_name, _usart_clear_break) \
178 (VSF_MCONNECT(__prefix_name, _usart_t) *usart_ptr) \
179 { \
180 vsf_usart_capability_t cap = \
181 VSF_MCONNECT(__prefix_name, _usart_capability)(usart_ptr); \
182 VSF_HAL_ASSERT(cap.support_set_and_clear_break); \
183 return VSF_MCONNECT(__prefix_name, _usart_cmd)(usart_ptr, \
184 VSF_USART_CMD_CLEAR_BREAK, NULL); \
185 }
186
187#define VSF_USART_APIS(__prefix_name) \
188 __VSF_USART_BASE_APIS(__prefix_name) \
189 __VSF_USART_FIFO_APIS(__prefix_name) \
190 __VSF_USART_REQUEST_APIS(__prefix_name) \
191 __VSF_USART_REQUEST_EXTRA_APIS(__prefix_name)
192
193/*============================ TYPES =========================================*/
194
195#if VSF_USART_CFG_REIMPLEMENT_TYPE_MODE == DISABLED
270typedef enum vsf_usart_mode_t {
272 VSF_USART_NO_PARITY = (0x0ul << 0),
273 VSF_USART_EVEN_PARITY = (0x1ul << 0),
274 VSF_USART_ODD_PARITY = (0x2ul << 0),
275 VSF_USART_FORCE_0_PARITY = (0x3ul << 0),
276 VSF_USART_FORCE_1_PARITY = (0x4ul << 0),
277
279 VSF_USART_1_STOPBIT = (0x0ul << 3),
280 VSF_USART_1_5_STOPBIT = (0x1ul << 3),
281 VSF_USART_0_5_STOPBIT = (0x2ul << 3),
282 VSF_USART_2_STOPBIT = (0x3ul << 3),
283
285 VSF_USART_5_BIT_LENGTH = (0x0ul << 5),
286 VSF_USART_6_BIT_LENGTH = (0x1ul << 5),
287 VSF_USART_7_BIT_LENGTH = (0x2ul << 5),
288 VSF_USART_8_BIT_LENGTH = (0x3ul << 5),
289 VSF_USART_9_BIT_LENGTH = (0x4ul << 5),
290 VSF_USART_10_BIT_LENGTH = (0x5ul << 5),
291
293 VSF_USART_NO_HWCONTROL = (0x0ul << 8),
294 VSF_USART_RTS_HWCONTROL = (0x1ul << 8),
295 VSF_USART_CTS_HWCONTROL = (0x2ul << 8),
296 VSF_USART_RTS_CTS_HWCONTROL = (0x3ul << 8),
297
298 VSF_USART_TX_ENABLE = (0x0ul << 9),
299 VSF_USART_TX_DISABLE = (0x1ul << 9),
300
301 VSF_USART_RX_ENABLE = (0x0ul << 10),
302 VSF_USART_RX_DISABLE = (0x1ul << 10),
303
304 VSF_USART_SYNC_CLOCK_ENABLE = (0x0ul << 11),
305 VSF_USART_SYNC_CLOCK_DISABLE = (0x1ul << 11),
306
308 VSF_USART_SYNC_CLOCK_POLARITY_LOW = (0x0ul << 12),
309 VSF_USART_SYNC_CLOCK_POLARITY_HIGH = (0x1ul << 12),
310 VSF_USART_SYNC_CLOCK_PHASE_1_EDGE = (0x0ul << 13),
311 VSF_USART_SYNC_CLOCK_PHASE_2_EDGE = (0x1ul << 13),
312
313 VSF_USART_HALF_DUPLEX_DISABLE = (0x0ul << 14),
314 VSF_USART_HALF_DUPLEX_ENABLE = (0x1ul << 14),
315
318 /*
319 // Here are some examples of fifo implementations
320
321 // Example A of driver-specific threshold
322 VSF_USART_TX_FIFO_THRESHOLD_1_8 = (0x0ul << 15), //!< TX FIFO reaches 1/8 of its depth
323 VSF_USART_TX_FIFO_THRESHOLD_1_4 = (0x1ul << 15), //!< TX FIFO reaches 1/4 of its depth
324 VSF_USART_TX_FIFO_THRESHOLD_1_2 = (0x2ul << 15), //!< TX FIFO reaches 1/2 of its depth
325 VSF_USART_TX_FIFO_THRESHOLD_3_4 = (0x3ul << 15), //!< TX FIFO reaches 3/4 of its depth
326 VSF_USART_TX_FIFO_THRESHOLD_7_8 = (0x4ul << 15), //!< TX FIFO reaches 7/8 of its depth
327 VSF_USART_TX_FIFO_THRESHOLD_EMPTY = (0x5ul << 15), //!< TX FIFO becoms empty
328 VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY = VSF_USART_TX_FIFO_THRESHOLD_1_2,
329 VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL = (0x6ul << 15),
330
331 // Example B of driver-specific threshold
332 VSF_USART_TX_FIFO_THRESHOLD_1 = (0x0ul << 15), //!< Triggers VSF_USART_IRQ_MASK_TX interrupt when the data in TX FIFO is less than 1
333 VSF_USART_TX_FIFO_THRESHOLD_2 = (0x1ul << 15), //!< Triggers VSF_USART_IRQ_MASK_TX interrupt when the data in TX FIFO is less than 2
334 VSF_USART_TX_FIFO_THRESHOLD_3 = (0x2ul << 15), //!< Triggers VSF_USART_IRQ_MASK_TX interrupt when the data in TX FIFO is less than 3
335 VSF_USART_TX_FIFO_THRESHOLD_4 = (0x3ul << 15), //!< Triggers VSF_USART_IRQ_MASK_TX interrupt when the data in TX FIFO is less than 4
336 VSF_USART_TX_FIFO_THRESHOLD_5 = (0x4ul << 15), //!< Triggers VSF_USART_IRQ_MASK_TX interrupt when the data in TX FIFO is less than 5
337 VSF_USART_TX_FIFO_THRESHOLD_6 = (0x5ul << 15), //!< Triggers VSF_USART_IRQ_MASK_TX interrupt when the data in TX FIFO is less than 6
338 VSF_USART_TX_FIFO_THRESHOLD_7 = (0x6ul << 15), //!< Triggers VSF_USART_IRQ_MASK_TX interrupt when the data in TX FIFO is less than 7
339 VSF_USART_TX_FIFO_THRESHOLD_8 = (0x7ul << 15), //!< Triggers VSF_USART_IRQ_MASK_TX interrupt when the data in TX FIFO is less than 8
340 VSF_USART_TX_FIFO_THRESHOLD_EMPTY = VSF_USART_TX_FIFO_THRESHOLD_1,
341 VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY = VSF_USART_TX_FIFO_THRESHOLD_4,
342 VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL = VSF_USART_TX_FIFO_THRESHOLD_8,
343 */
344 VSF_USART_TX_FIFO_THRESHOLD_EMPTY = (0x0ul << 15),
345 VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY = (0x1ul << 15),
349 VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL = (0x2ul << 15),
350
351 /*
352 // Here are some examples of fifo implementations
353
354 // Example A of driver-specific threshold
355 VSF_USART_RX_FIFO_THRESHOLD_1_8 = (0x0ul << 17), //!< RX FIFO reaches 1/8 of its depth
356 VSF_USART_RX_FIFO_THRESHOLD_1_4 = (0x1ul << 17), //!< RX FIFO reaches 1/4 of its depth
357 VSF_USART_RX_FIFO_THRESHOLD_1_2 = (0x2ul << 17), //!< RX FIFO reaches 1/2 of its depth
358 VSF_USART_RX_FIFO_THRESHOLD_3_4 = (0x3ul << 17), //!< RX FIFO reaches 3/4 of its depth
359 VSF_USART_RX_FIFO_THRESHOLD_7_8 = (0x4ul << 17), //!< RX FIFO reaches 7/8 of its depth
360 VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY = VSF_USART_RX_FIFO_THRESHOLD_1_8,
361 VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL = VSF_USART_RX_FIFO_THRESHOLD_1_2,
362 VSF_USART_RX_FIFO_THRESHOLD_FULL = (0x5ul << 17), //!< RX FIFO becomes full
363
364 // Example B of driver-specific threshold
366 VSF_USART_RX_FIFO_THRESHOLD_1 = (0x0ul << 17),
368 VSF_USART_RX_FIFO_THRESHOLD_2 = (0x1ul << 17),
370 VSF_USART_RX_FIFO_THRESHOLD_3 = (0x2ul << 17),
372 VSF_USART_RX_FIFO_THRESHOLD_4 = (0x3ul << 17),
374 VSF_USART_RX_FIFO_THRESHOLD_5 = (0x4ul << 17),
376 VSF_USART_RX_FIFO_THRESHOLD_6 = (0x5ul << 17),
378 VSF_USART_RX_FIFO_THRESHOLD_7 = (0x6ul << 17),
380 VSF_USART_RX_FIFO_THRESHOLD_8 = (0x7ul << 17),
381 VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY = VSF_USART_RX_FIFO_THRESHOLD_1,
382 VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL = VSF_USART_RX_FIFO_THRESHOLD_4,
383 VSF_USART_RX_FIFO_THRESHOLD_FULL = VSF_USART_RX_FIFO_THRESHOLD_8,
384 */
387 VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY = (0x0ul << 17),
388 VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL = (0x1ul << 17),
389 VSF_USART_RX_FIFO_THRESHOLD_FULL = (0x2ul << 17),
390
391 /* Optional mode
393 VSF_USART_IRDA_ENABLE = (0x1ul << 18),
394 VSF_USART_IRDA_DISABLE = (0x0ul << 18),
395 #define VSF_USART_IRDA_ENABLE VSF_USART_IRDA_ENABLE
396 #define VSF_USART_IRDA_DISABLE VSF_USART_IRDA_DISABLE
397 #define VSF_USART_IRDA_MASK VSF_USART_IRDA_ENABLE | VSF_USART_IRDA_DISABLE
398
399 VSF_USART_SMARTCARD_ENABLE = (0x1ul << 19),
400 VSF_USART_SMARTCARD_DISABLE = (0x0ul << 19),
401 #define VSF_USART_SMARTCARD_ENABLE VSF_USART_SMARTCARD_ENABLE
402 #define VSF_USART_SMARTCARD_DISABLE VSF_USART_SMARTCARD_DISABLE
403 #define VSF_USART_SMARTCARD_MASK VSF_USART_SMARTCARDENABLE | VSF_USART_SMARTCARD_DISABLE
404
405 // whether the clock pulse corresponding to the last transmitted
406 VSF_USART_SYNC_CLOCK_LAST_BIT_ENABLE = (0x0ul << 20),
407 VSF_USART_SYNC_CLOCK_LAST_BIT_DISABLE = (0x0ul << 20),
408 #define VSF_USART_SYNC_CLOCK_LAST_BIT_ENABLE VSF_USART_SYNC_CLOCK_LAST_BIT_ENABLE
409 #define VSF_USART_SYNC_CLOCK_LAST_BIT_DISABLE VSF_USART_SYNC_CLOCK_LAST_BIT_DISABLE
410 #define VSF_USART_SYNC_CLOCK_LAST_BIT_MASK VSF_USART_SYNC_CLOCK_LAST_BIT_ENABLE | \
411 VSF_USART_SYNC_CLOCK_LAST_BIT_DISABLE
412
413 // divisor of IRDA clock
414 VSF_USART_IRDA_PRESCALER_BIT_OFFSET = (21),
415 VSF_USART_IRDA_PRESCALER_MASK = (0xFul << VSF_USART_IRDA_PRESCALER_BIT_OFFSET),
416 #define VSF_USART_IRDA_PRESCALER_BIT_OFFSET VSF_USART_IRDA_PRESCALER_BIT_OFFSET
417 #define VSF_USART_IRDA_PRESCALER_MASK VSF_USART_IRDA_PRESCALER_MASK
418 */
419} vsf_usart_mode_t;
420#endif
421
422enum {
423#ifndef VSF_USART_PARITY_MASK
424 VSF_USART_PARITY_MASK = VSF_USART_NO_PARITY
425 | VSF_USART_EVEN_PARITY
426 | VSF_USART_ODD_PARITY
427 | VSF_USART_FORCE_0_PARITY
428 | VSF_USART_FORCE_1_PARITY,
429#endif
430
431#ifndef VSF_USART_STOPBIT_MASK
432 VSF_USART_STOPBIT_MASK = VSF_USART_1_STOPBIT
433 | VSF_USART_1_5_STOPBIT
434 | VSF_USART_0_5_STOPBIT
435 | VSF_USART_2_STOPBIT,
436#endif
437
438#ifndef VSF_USART_BIT_LENGTH_MASK
439 VSF_USART_BIT_LENGTH_MASK = VSF_USART_5_BIT_LENGTH
440 | VSF_USART_6_BIT_LENGTH
441 | VSF_USART_7_BIT_LENGTH
442 | VSF_USART_8_BIT_LENGTH
443 | VSF_USART_9_BIT_LENGTH
444 | VSF_USART_10_BIT_LENGTH,
445#endif
446
447#ifndef VSF_USART_TX_FIFO_THRESHOLD_MASK
448 VSF_USART_TX_FIFO_THRESHOLD_MASK = VSF_USART_TX_FIFO_THRESHOLD_EMPTY
449 | VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
450 | VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL,
451#endif
452
453#ifndef VSF_USART_RX_FIFO_THRESHOLD_MASK
454 VSF_USART_RX_FIFO_THRESHOLD_MASK = VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY
455 | VSF_USART_RX_FIFO_THRESHOLD_FULL
456 | VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL,
457#endif
458
459#ifndef VSF_USART_HWCONTROL_MASK
460 VSF_USART_HWCONTROL_MASK = VSF_USART_NO_HWCONTROL
461 | VSF_USART_RTS_HWCONTROL
462 | VSF_USART_CTS_HWCONTROL
463 | VSF_USART_RTS_CTS_HWCONTROL,
464#endif
465
466 VSF_USART_TX_MASK = VSF_USART_TX_ENABLE
467 | VSF_USART_TX_DISABLE,
468
469 VSF_USART_RX_MASK = VSF_USART_RX_ENABLE
470 | VSF_USART_RX_DISABLE,
471
472 VSF_USART_SYNC_CLOCK_MASK = VSF_USART_SYNC_CLOCK_ENABLE
473 | VSF_USART_SYNC_CLOCK_DISABLE,
474
475 VSF_USART_HALF_DUPLEX_MASK = VSF_USART_HALF_DUPLEX_DISABLE
476 | VSF_USART_HALF_DUPLEX_ENABLE,
477
478 VSF_USART_SYNC_CLOCK_POLARITY_MASK = VSF_USART_SYNC_CLOCK_POLARITY_LOW
479 | VSF_USART_SYNC_CLOCK_POLARITY_HIGH,
480
481 VSF_USART_SYNC_CLOCK_PHASE_MASK = VSF_USART_SYNC_CLOCK_PHASE_1_EDGE
482 | VSF_USART_SYNC_CLOCK_PHASE_2_EDGE,
483
484
485
486 VSF_USART_MODE_ALL_BITS_MASK = VSF_USART_PARITY_MASK
487 | VSF_USART_STOPBIT_MASK
488 | VSF_USART_BIT_LENGTH_MASK
489 | VSF_USART_HWCONTROL_MASK
490 | VSF_USART_TX_FIFO_THRESHOLD_MASK
491 | VSF_USART_RX_FIFO_THRESHOLD_MASK
492 | VSF_USART_TX_MASK
493 | VSF_USART_RX_MASK
494 | VSF_USART_SYNC_CLOCK_MASK
495 | VSF_USART_HALF_DUPLEX_MASK
496 | VSF_USART_SYNC_CLOCK_POLARITY_MASK
497 | VSF_USART_SYNC_CLOCK_PHASE_MASK
498#ifdef VSF_USART_SYNC_CLOCK_LAST_BIT_MASK
499 | VSF_USART_SYNC_CLOCK_LAST_BIT_MASK
500#endif
501
502#ifdef VSF_USART_IRDA_PRESCALER_MASK
503 | VSF_USART_IRDA_PRESCALER_MASK
504#endif
505#ifdef VSF_USART_IRDA_MASK
506 | VSF_USART_IRDA_MASK
507#endif
508
509#ifdef VSF_USART_SMARTCARD_MASK
510 | VSF_USART_SMARTCARD_MASK
511#endif
512};
513
514#if VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
537typedef enum vsf_usart_irq_mask_t {
538 // request_rx/request_tx complete
539 VSF_USART_IRQ_MASK_TX_CPL = (0x1ul << 0),
540 VSF_USART_IRQ_MASK_RX_CPL = (0x1ul << 1),
541
542 // TX/RX reach fifo threshold, threshold on some devices is bound to 1
543 VSF_USART_IRQ_MASK_TX = (0x1ul << 2),
544 VSF_USART_IRQ_MASK_RX = (0x1ul << 3),
545 VSF_USART_IRQ_MASK_RX_TIMEOUT = (0x1ul << 4),
546
547 // clear to send interrupt
548 VSF_USART_IRQ_MASK_CTS = (0x1ul << 5),
549
550 // Error interrupt
551 VSF_USART_IRQ_MASK_FRAME_ERR = (0x1ul << 6),
552 VSF_USART_IRQ_MASK_PARITY_ERR = (0x1ul << 7),
553 VSF_USART_IRQ_MASK_BREAK_ERR = (0x1ul << 8),
554 VSF_USART_IRQ_MASK_OVERFLOW_ERR = (0x1ul << 9),
555
556 /*
557 VSF_USART_IRQ_MASK_TX_HALF_CPL = (0x1ul << 10),
558 #define VSF_USART_IRQ_MASK_TX_HALF_CPL VSF_USART_IRQ_MASK_TX_HALF_CPL
559 VSF_USART_IRQ_MASK_RX_HALF_CPL = (0x1ul << 11),
560 #define VSF_USART_IRQ_MASK_RX_HALF_CPL VSF_USART_IRQ_MASK_RX_HALF_CPL
561
562 VSF_USART_IRQ_MASK_CANCEL_TX_CPL = (0x1ul << 12),
563 #define VSF_USART_IRQ_MASK_CANCEL_TX_CPL VSF_USART_IRQ_MASK_CANCEL_TX_CPL
564 VSF_USART_IRQ_MASK_CANCEL_RX_CPL = (0x1ul << 13),
565 #define VSF_USART_IRQ_MASK_CANCEL_RX_CPL VSF_USART_IRQ_MASK_CANCEL_RX_CPL
566
567 VSF_USART_IRQ_MASK_NOISE_ERR = (0x1ul << 14),
568 #define VSF_USART_IRQ_MASK_NOISE_ERR VSF_USART_IRQ_MASK_NOISE_ERR
569 */
570} vsf_usart_irq_mask_t;
571#endif
572
573enum {
574 VSF_USART_IRQ_MASK_RX_IDLE = VSF_USART_IRQ_MASK_RX_TIMEOUT,
575 VSF_USART_IRQ_MASK_TX_FIFO_THRESHOLD = VSF_USART_IRQ_MASK_TX,
576 VSF_USART_IRQ_MASK_RX_FIFO_THRESHOLD = VSF_USART_IRQ_MASK_RX,
577
578#ifndef VSF_USART_IRQ_MASK_ERR
579 VSF_USART_IRQ_MASK_ERR = VSF_USART_IRQ_MASK_FRAME_ERR
580 | VSF_USART_IRQ_MASK_PARITY_ERR
581 | VSF_USART_IRQ_MASK_BREAK_ERR
582 | VSF_USART_IRQ_MASK_OVERFLOW_ERR,
583#endif
584
585#ifndef VSF_USART_IRQ_ALL_BITS_MASK
586 VSF_USART_IRQ_ALL_BITS_MASK = VSF_USART_IRQ_MASK_TX
587 | VSF_USART_IRQ_MASK_RX
588 | VSF_USART_IRQ_MASK_RX_TIMEOUT
589 | VSF_USART_IRQ_MASK_CTS
590 | VSF_USART_IRQ_MASK_TX_CPL
591 | VSF_USART_IRQ_MASK_RX_CPL
592 | VSF_USART_IRQ_MASK_ERR,
593# ifdef VSF_USART_IRQ_MASK_TX_HALF_CPL
594 | VSF_USART_IRQ_MASK_TX_HALF_CPL
595# endif
596# ifdef VSF_USART_IRQ_MASK_RX_HALF_CPL
597 | VSF_USART_IRQ_MASK_RX_HALF_CPL
598# endif
599# ifdef VSF_USART_IRQ_MASK_CANCEL_TX_CPL
600 | VSF_USART_IRQ_MASK_CANCEL_TX_CPL
601# endif
602# ifdef VSF_USART_IRQ_MASK_CANCEL_RX_CPL
603 | VSF_USART_IRQ_MASK_CANCEL_RX_CPL
604# endif
605#endif
606};
607
608#if VSF_USART_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
609typedef struct vsf_usart_t vsf_usart_t;
610
611typedef void vsf_usart_isr_handler_t(void *target_ptr,
612 vsf_usart_t *usart_ptr,
613 vsf_usart_irq_mask_t irq_mask);
614
615typedef struct vsf_usart_isr_t {
616 vsf_usart_isr_handler_t *handler_fn;
617 void *target_ptr;
618 vsf_arch_prio_t prio;
619} vsf_usart_isr_t;
620
621typedef struct vsf_usart_cfg_t {
622 uint32_t mode;
623 uint32_t baudrate;
624 uint32_t rx_timeout;
625 vsf_usart_isr_t isr;
626} vsf_usart_cfg_t;
627#endif
628
629#if VSF_USART_CFG_REIMPLEMENT_TYPE_CMD == DISABLED
647typedef enum vsf_usart_cmd_t {
651 VSF_USART_CMD_SEND_BREAK = (0x01ul << 0),
652
654 VSF_USART_CMD_SET_BREAK = (0x01ul << 1),
656 VSF_USART_CMD_CLEAR_BREAK = (0x01ul << 2),
657
658 /*
659 VSF_USART_CMD_REQUEST_RX_RESUME = (0x1ul << 3),
660 #define VSF_USART_CMD_REQUEST_RX_RESUME VSF_USART_CMD_REQUEST_RX_RESUME
661 VSF_USART_CMD_REQUEST_TX_RESUME = (0x1ul << 4),
662 #define VSF_USART_CMD_REQUEST_TX_RESUME VSF_USART_CMD_REQUEST_TX_RESUME
663
664 VSF_USART_CMD_REQUEST_RX_PAUSE = (0x1ul << 5),
665 #define VSF_USART_CMD_REQUEST_RX_PAUSE VSF_USART_CMD_REQUEST_RX_PAUSE
666 VSF_USART_CMD_REQUEST_TX_PAUSE = (0x1ul << 6),
667 #define VSF_USART_CMD_REQUEST_TX_PAUSE VSF_USART_CMD_REQUEST_TX_PAUSE
668
669 VSF_USART_CMD_HALF_DUPLEX_ENABLE_TRANSMITTER = (0x1ul << 7),
670 #define VSF_USART_CMD_HALF_DUPLEX_ENABLE_TRANSMITTER VSF_USART_CMD_HALF_DUPLEX_ENABLE_TRANSMITTER
671
672 VSF_USART_CMD_HALF_DUPLEX_ENABLE_RECEIVER = (0x1ul << 8),
673 #define VSF_USART_CMD_HALF_DUPLEX_ENABLE_RECEIVER VSF_USART_CMD_HALF_DUPLEX_ENABLE_RECEIVER
674 */
675} vsf_usart_cmd_t;
676#endif
677
678#if VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED
679typedef struct vsf_usart_status_t {
680 union {
681 inherit(vsf_peripheral_status_t)
682 struct {
683 uint32_t is_busy : 1;
684 uint32_t is_tx_busy : 1;
685 uint32_t is_rx_busy : 1;
686 // TX FIFO threshold in bytes
687 uint32_t tx_fifo_thresh : 8;
688 // RX FIFO threshold in bytes
689 uint32_t rx_fifo_thresh : 8;
690 };
691 };
692} vsf_usart_status_t;
693#endif
694
695typedef struct vsf_usart_capability_t {
696#if VSF_USART_CFG_INHERT_HAL_CAPABILITY == ENABLED
697 inherit(vsf_peripheral_capability_t)
698#endif
699 vsf_usart_irq_mask_t irq_mask;
700
701 // baudrate range
702 uint32_t max_baudrate;
703 uint32_t min_baudrate;
704
705 // TX FIFO depth, in data count (frame)
706 uint8_t txfifo_depth;
707 // RX FIFO depth, in data count (frame)
708 uint8_t rxfifo_depth;
709
710 uint8_t max_data_bits;
711 uint8_t min_data_bits;
712
713 uint8_t support_rx_timeout : 1;
714 uint8_t support_send_break : 1;
715 uint8_t support_set_and_clear_break : 1;
716} vsf_usart_capability_t;
717
718typedef struct vsf_usart_op_t {
719#undef __VSF_HAL_TEMPLATE_API
720#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
721
722 VSF_USART_APIS(vsf)
723} vsf_usart_op_t;
724
725#if VSF_USART_CFG_MULTI_CLASS == ENABLED
726struct vsf_usart_t {
727 const vsf_usart_op_t * op;
728};
729#endif
730
731/*============================ PROTOTYPES ====================================*/
732
752extern vsf_err_t vsf_usart_init(vsf_usart_t *usart_ptr, vsf_usart_cfg_t *cfg_ptr);
753
765extern void vsf_usart_fini(vsf_usart_t *usart_ptr);
766
778extern fsm_rt_t vsf_usart_enable(vsf_usart_t *usart_ptr);
779
791extern fsm_rt_t vsf_usart_disable(vsf_usart_t *usart_ptr);
792
808extern void vsf_usart_irq_enable(vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask);
809
823extern void vsf_usart_irq_disable(vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask);
824
836extern vsf_usart_status_t vsf_usart_status(vsf_usart_t *usart_ptr);
837
849extern vsf_usart_capability_t vsf_usart_capability(vsf_usart_t *usart_ptr);
850
862extern uint_fast16_t vsf_usart_rxfifo_get_data_count(vsf_usart_t *usart_ptr);
863
879extern uint_fast16_t vsf_usart_rxfifo_read(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast16_t count);
880
898extern uint_fast16_t vsf_usart_txfifo_get_free_count(vsf_usart_t *usart_ptr);
899
915extern uint_fast16_t vsf_usart_txfifo_write(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast16_t count);
916
932extern vsf_err_t vsf_usart_request_rx(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count);
933
951extern vsf_err_t vsf_usart_request_tx(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count);
952
964extern vsf_err_t vsf_usart_cancel_rx(vsf_usart_t *usart_ptr);
965
976extern vsf_err_t vsf_usart_cancel_tx(vsf_usart_t *usart_ptr);
977
990extern int_fast32_t vsf_usart_get_rx_count(vsf_usart_t *usart_ptr);
991
1004extern int_fast32_t vsf_usart_get_tx_count(vsf_usart_t *usart_ptr);
1005
1021extern vsf_err_t vsf_usart_cmd(vsf_usart_t *usart_ptr, vsf_usart_cmd_t cmd, void * param);
1022
1023/*============================ INLINE FUNCTIONS ==============================*/
1024
1025#if VSF_USART_CFG_REIMPLEMENT_MODE_TO_DATA_BITS == DISABLED
1026static inline uint8_t vsf_usart_mode_to_data_bits(vsf_usart_mode_t mode)
1027{
1028 switch (mode & VSF_USART_BIT_LENGTH_MASK) {
1029 case VSF_USART_5_BIT_LENGTH:
1030 return 5;
1031 case VSF_USART_6_BIT_LENGTH:
1032 return 6;
1033 case VSF_USART_7_BIT_LENGTH:
1034 return 7;
1035 case VSF_USART_8_BIT_LENGTH:
1036 return 8;
1037 case VSF_USART_9_BIT_LENGTH:
1038 return 9;
1039 case VSF_USART_10_BIT_LENGTH:
1040 return 10;
1041 default:
1042 return 0;
1043 }
1044}
1045#endif
1046
1059static inline vsf_err_t vsf_usart_send_break(vsf_usart_t *usart_ptr)
1060{
1061 vsf_usart_capability_t cap = vsf_usart_capability(usart_ptr);
1062 VSF_HAL_ASSERT(cap.support_send_break);
1063
1064 return vsf_usart_cmd(usart_ptr, VSF_USART_CMD_SEND_BREAK, NULL);
1065}
1066
1078static inline vsf_err_t vsf_usart_set_break(vsf_usart_t *usart_ptr)
1079{
1080 vsf_usart_capability_t cap = vsf_usart_capability(usart_ptr);
1081 VSF_HAL_ASSERT(cap.support_set_and_clear_break);
1082
1083 return vsf_usart_cmd(usart_ptr, VSF_USART_CMD_SET_BREAK, NULL);
1084}
1085
1097static inline vsf_err_t vsf_usart_clear_break(vsf_usart_t *usart_ptr)
1098{
1099 vsf_usart_capability_t cap = vsf_usart_capability(usart_ptr);
1100 VSF_HAL_ASSERT(cap.support_set_and_clear_break);
1101
1102 return vsf_usart_cmd(usart_ptr, VSF_USART_CMD_CLEAR_BREAK, NULL);
1103}
1104
1105/*============================ MACROFIED FUNCTIONS ===========================*/
1106
1107#if VSF_USART_CFG_FUNCTION_RENAME == ENABLED
1108# define __vsf_usart_t VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_t)
1109# define vsf_usart_init(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_init) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1110# define vsf_usart_fini(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_fini) ((__vsf_usart_t *)(__USART))
1111# define vsf_usart_capability(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_capability) ((__vsf_usart_t *)(__USART))
1112# define vsf_usart_enable(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_enable) ((__vsf_usart_t *)(__USART))
1113# define vsf_usart_disable(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_disable) ((__vsf_usart_t *)(__USART))
1114# define vsf_usart_irq_enable(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_irq_enable) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1115# define vsf_usart_irq_disable(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_irq_disable) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1116# define vsf_usart_status(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_status) ((__vsf_usart_t *)(__USART))
1117# define vsf_usart_rxfifo_get_data_count(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_rxfifo_get_data_count) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1118# define vsf_usart_rxfifo_read(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_rxfifo_read) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1119# define vsf_usart_txfifo_get_free_count(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_txfifo_get_free_count) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1120# define vsf_usart_txfifo_write(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_txfifo_write) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1121# define vsf_usart_request_rx(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_request_rx) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1122# define vsf_usart_request_tx(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_request_tx) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1123# define vsf_usart_cancel_rx(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_cancel_rx) ((__vsf_usart_t *)(__USART))
1124# define vsf_usart_cancel_tx(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_cancel_tx) ((__vsf_usart_t *)(__USART))
1125# define vsf_usart_get_rx_count(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_get_rx_count) ((__vsf_usart_t *)(__USART))
1126# define vsf_usart_get_tx_count(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_get_tx_count) ((__vsf_usart_t *)(__USART))
1127# define vsf_usart_send_break(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_send_break) ((__vsf_usart_t *)(__USART))
1128# define vsf_usart_set_break(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_send_break) ((__vsf_usart_t *)(__USART))
1129# define vsf_usart_clear_break(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_send_break) ((__vsf_usart_t *)(__USART))
1130# define vsf_usart_cmd(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_cmd) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1131#endif
1132
1133/*============================ INCLUDES ======================================*/
1134
1135#ifdef __cplusplus
1136}
1137#endif
1138
1139#endif
vsf_err_t
vsf_err_t
Definition __type.h:42
vsf_usart_mode_t
vsf_usart_mode_t
Definition uart.h:32
vsf_usart_irq_mask_t
vsf_usart_irq_mask_t
Definition uart.h:106
VSF_USART_SYNC_CLOCK_LAST_BIT_MASK
#define VSF_USART_SYNC_CLOCK_LAST_BIT_MASK
Definition usart.h:129
vsf_arch_prio_t
vsf_arch_prio_t
Definition cortex_a_generic.h:88
NULL
#define NULL
Definition lvgl.h:26
uint32_t
unsigned int uint32_t
Definition lvgl.h:43
uint8_t
unsigned char uint8_t
Definition lvgl.h:40
irq_mask
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
uint_fast32_t
unsigned int uint_fast32_t
Definition stdint.h:27
int_fast32_t
int int_fast32_t
Definition stdint.h:26
uint_fast16_t
unsigned short uint_fast16_t
Definition stdint.h:25
vsf_peripheral_capability_t
Definition vsf_template_hal_driver.h:203
vsf_peripheral_status_t
Definition vsf_template_hal_driver.h:196
vsf_usart_capability_t
Definition vsf_template_usart.h:695
vsf_usart_capability_t::max_data_bits
uint8_t max_data_bits
Definition vsf_template_usart.h:710
vsf_usart_capability_t::support_set_and_clear_break
uint8_t support_set_and_clear_break
Definition vsf_template_usart.h:715
vsf_usart_capability_t::inherit
inherit(vsf_peripheral_capability_t) vsf_usart_irq_mask_t irq_mask
vsf_usart_capability_t::support_rx_timeout
uint8_t support_rx_timeout
Definition vsf_template_usart.h:713
vsf_usart_capability_t::rxfifo_depth
uint8_t rxfifo_depth
Definition vsf_template_usart.h:708
vsf_usart_capability_t::support_send_break
uint8_t support_send_break
Definition vsf_template_usart.h:714
vsf_usart_capability_t::txfifo_depth
uint8_t txfifo_depth
Definition vsf_template_usart.h:706
vsf_usart_capability_t::min_data_bits
uint8_t min_data_bits
Definition vsf_template_usart.h:711
vsf_usart_capability_t::min_baudrate
uint32_t min_baudrate
Definition vsf_template_usart.h:703
vsf_usart_capability_t::max_baudrate
uint32_t max_baudrate
Definition vsf_template_usart.h:702
vsf_usart_cfg_t
Definition vsf_template_usart.h:621
vsf_usart_cfg_t::mode
uint32_t mode
Definition vsf_template_usart.h:622
vsf_usart_cfg_t::baudrate
uint32_t baudrate
Definition vsf_template_usart.h:623
vsf_usart_cfg_t::rx_timeout
uint32_t rx_timeout
Definition vsf_template_usart.h:624
vsf_usart_cfg_t::isr
vsf_usart_isr_t isr
Definition vsf_template_usart.h:625
vsf_usart_isr_t
Definition vsf_template_usart.h:615
vsf_usart_isr_t::prio
vsf_arch_prio_t prio
Definition vsf_template_usart.h:618
vsf_usart_isr_t::handler_fn
vsf_usart_isr_handler_t * handler_fn
Definition vsf_template_usart.h:616
vsf_usart_isr_t::target_ptr
void * target_ptr
Definition vsf_template_usart.h:617
vsf_usart_op_t
Definition vsf_template_usart.h:718
vsf_usart_status_t
Definition uart.h:156
vsf_usart_status_t::is_busy
uint32_t is_busy
Definition usart.h:280
vsf_usart_t
Definition vsf_template_usart.h:726
vsf_usart_t::op
const vsf_usart_op_t * op
Definition vsf_template_usart.h:727
vsf_arch.h
fsm_rt_t
fsm_rt_t
Definition vsf_fsm.h:315
VSF_HAL_ASSERT
#define VSF_HAL_ASSERT(__CON)
all hal modules use this configuration file
Definition vsf_hal_cfg.h:36
vsf_template_hal_driver.h
vsf_usart_send_break
#define vsf_usart_send_break(__USART,...)
Definition vsf_template_usart.h:1127
vsf_usart_txfifo_get_free_count
#define vsf_usart_txfifo_get_free_count(__USART,...)
Definition vsf_template_usart.h:1119
vsf_usart_disable
#define vsf_usart_disable(__USART)
Definition vsf_template_usart.h:1113
VSF_USART_IRQ_MASK_ERR
@ VSF_USART_IRQ_MASK_ERR
Definition vsf_template_usart.h:579
VSF_USART_IRQ_MASK_TX_FIFO_THRESHOLD
@ VSF_USART_IRQ_MASK_TX_FIFO_THRESHOLD
Definition vsf_template_usart.h:575
VSF_USART_IRQ_ALL_BITS_MASK
@ VSF_USART_IRQ_ALL_BITS_MASK
Definition vsf_template_usart.h:586
VSF_USART_IRQ_MASK_RX_IDLE
@ VSF_USART_IRQ_MASK_RX_IDLE
Definition vsf_template_usart.h:574
VSF_USART_IRQ_MASK_RX_FIFO_THRESHOLD
@ VSF_USART_IRQ_MASK_RX_FIFO_THRESHOLD
Definition vsf_template_usart.h:576
vsf_usart_init
#define vsf_usart_init(__USART,...)
Definition vsf_template_usart.h:1109
vsf_usart_capability
#define vsf_usart_capability(__USART)
Definition vsf_template_usart.h:1111
vsf_usart_mode_t
vsf_usart_mode_t
Predefined VSF USART modes that can be reimplemented in specific hal drivers.
Definition vsf_template_usart.h:270
VSF_USART_TX_FIFO_THRESHOLD_EMPTY
@ VSF_USART_TX_FIFO_THRESHOLD_EMPTY
TX FIFO becomes emtpy.
Definition vsf_template_usart.h:344
VSF_USART_HALF_DUPLEX_DISABLE
@ VSF_USART_HALF_DUPLEX_DISABLE
Definition vsf_template_usart.h:313
VSF_USART_8_BIT_LENGTH
@ VSF_USART_8_BIT_LENGTH
data bits : 8,
Definition vsf_template_usart.h:288
VSF_USART_SYNC_CLOCK_ENABLE
@ VSF_USART_SYNC_CLOCK_ENABLE
Definition vsf_template_usart.h:304
VSF_USART_EVEN_PARITY
@ VSF_USART_EVEN_PARITY
Definition vsf_template_usart.h:273
VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY
@ VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY
Definition vsf_template_usart.h:387
VSF_USART_ODD_PARITY
@ VSF_USART_ODD_PARITY
Definition vsf_template_usart.h:274
VSF_USART_SYNC_CLOCK_PHASE_1_EDGE
@ VSF_USART_SYNC_CLOCK_PHASE_1_EDGE
Definition vsf_template_usart.h:310
VSF_USART_NO_PARITY
@ VSF_USART_NO_PARITY
USART Parity.
Definition vsf_template_usart.h:272
VSF_USART_10_BIT_LENGTH
@ VSF_USART_10_BIT_LENGTH
data bits : 10,
Definition vsf_template_usart.h:290
VSF_USART_RTS_HWCONTROL
@ VSF_USART_RTS_HWCONTROL
Definition vsf_template_usart.h:294
VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL
@ VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL
Half of the threshold for RX FIFO.
Definition vsf_template_usart.h:388
VSF_USART_RX_ENABLE
@ VSF_USART_RX_ENABLE
Definition vsf_template_usart.h:301
VSF_USART_FORCE_0_PARITY
@ VSF_USART_FORCE_0_PARITY
Definition vsf_template_usart.h:275
VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL
@ VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL
Definition vsf_template_usart.h:349
VSF_USART_TX_ENABLE
@ VSF_USART_TX_ENABLE
Definition vsf_template_usart.h:298
VSF_USART_SYNC_CLOCK_POLARITY_HIGH
@ VSF_USART_SYNC_CLOCK_POLARITY_HIGH
Definition vsf_template_usart.h:309
VSF_USART_9_BIT_LENGTH
@ VSF_USART_9_BIT_LENGTH
data bits : 9,
Definition vsf_template_usart.h:289
VSF_USART_7_BIT_LENGTH
@ VSF_USART_7_BIT_LENGTH
data bits : 7,
Definition vsf_template_usart.h:287
VSF_USART_1_STOPBIT
@ VSF_USART_1_STOPBIT
USART Stopbit.
Definition vsf_template_usart.h:279
VSF_USART_FORCE_1_PARITY
@ VSF_USART_FORCE_1_PARITY
Definition vsf_template_usart.h:276
VSF_USART_SYNC_CLOCK_POLARITY_LOW
@ VSF_USART_SYNC_CLOCK_POLARITY_LOW
USART SYNC Mode Clock.
Definition vsf_template_usart.h:308
VSF_USART_RX_DISABLE
@ VSF_USART_RX_DISABLE
Definition vsf_template_usart.h:302
VSF_USART_2_STOPBIT
@ VSF_USART_2_STOPBIT
stopbit: 2 bit
Definition vsf_template_usart.h:282
VSF_USART_CTS_HWCONTROL
@ VSF_USART_CTS_HWCONTROL
Definition vsf_template_usart.h:295
VSF_USART_5_BIT_LENGTH
@ VSF_USART_5_BIT_LENGTH
USART Databit Lenght.
Definition vsf_template_usart.h:285
VSF_USART_SYNC_CLOCK_DISABLE
@ VSF_USART_SYNC_CLOCK_DISABLE
Definition vsf_template_usart.h:305
VSF_USART_RTS_CTS_HWCONTROL
@ VSF_USART_RTS_CTS_HWCONTROL
Definition vsf_template_usart.h:296
VSF_USART_SYNC_CLOCK_PHASE_2_EDGE
@ VSF_USART_SYNC_CLOCK_PHASE_2_EDGE
Definition vsf_template_usart.h:311
VSF_USART_HALF_DUPLEX_ENABLE
@ VSF_USART_HALF_DUPLEX_ENABLE
Definition vsf_template_usart.h:314
VSF_USART_TX_DISABLE
@ VSF_USART_TX_DISABLE
Definition vsf_template_usart.h:299
VSF_USART_RX_FIFO_THRESHOLD_FULL
@ VSF_USART_RX_FIFO_THRESHOLD_FULL
Full of the threshold for RX FIFO.
Definition vsf_template_usart.h:389
VSF_USART_6_BIT_LENGTH
@ VSF_USART_6_BIT_LENGTH
data bits : 6,
Definition vsf_template_usart.h:286
VSF_USART_0_5_STOPBIT
@ VSF_USART_0_5_STOPBIT
stopbit: 0.5 bit
Definition vsf_template_usart.h:281
VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
@ VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
Definition vsf_template_usart.h:345
VSF_USART_NO_HWCONTROL
@ VSF_USART_NO_HWCONTROL
USART Hardware Control.
Definition vsf_template_usart.h:293
VSF_USART_1_5_STOPBIT
@ VSF_USART_1_5_STOPBIT
stopbit: 1.5 bit
Definition vsf_template_usart.h:280
vsf_usart_request_tx
#define vsf_usart_request_tx(__USART,...)
Definition vsf_template_usart.h:1122
vsf_usart_clear_break
#define vsf_usart_clear_break(__USART)
Definition vsf_template_usart.h:1129
vsf_usart_rxfifo_read
#define vsf_usart_rxfifo_read(__USART,...)
Definition vsf_template_usart.h:1118
vsf_usart_irq_disable
#define vsf_usart_irq_disable(__USART,...)
Definition vsf_template_usart.h:1115
vsf_usart_rxfifo_get_data_count
#define vsf_usart_rxfifo_get_data_count(__USART,...)
Definition vsf_template_usart.h:1117
vsf_usart_cmd
#define vsf_usart_cmd(__USART,...)
Definition vsf_template_usart.h:1130
vsf_usart_cancel_tx
#define vsf_usart_cancel_tx(__USART)
Definition vsf_template_usart.h:1124
vsf_usart_request_rx
#define vsf_usart_request_rx(__USART,...)
Definition vsf_template_usart.h:1121
vsf_usart_cmd_t
vsf_usart_cmd_t
Predefined VSF USART command that can be reimplemented in specific hal drivers.
Definition vsf_template_usart.h:647
VSF_USART_CMD_SET_BREAK
@ VSF_USART_CMD_SET_BREAK
usart set break condition
Definition vsf_template_usart.h:654
VSF_USART_CMD_CLEAR_BREAK
@ VSF_USART_CMD_CLEAR_BREAK
usart clean break condition
Definition vsf_template_usart.h:656
VSF_USART_CMD_SEND_BREAK
@ VSF_USART_CMD_SEND_BREAK
Definition vsf_template_usart.h:651
VSF_USART_BIT_LENGTH_MASK
@ VSF_USART_BIT_LENGTH_MASK
Definition vsf_template_usart.h:439
VSF_USART_SYNC_CLOCK_POLARITY_MASK
@ VSF_USART_SYNC_CLOCK_POLARITY_MASK
Definition vsf_template_usart.h:478
VSF_USART_TX_FIFO_THRESHOLD_MASK
@ VSF_USART_TX_FIFO_THRESHOLD_MASK
Definition vsf_template_usart.h:448
VSF_USART_PARITY_MASK
@ VSF_USART_PARITY_MASK
Definition vsf_template_usart.h:424
VSF_USART_MODE_ALL_BITS_MASK
@ VSF_USART_MODE_ALL_BITS_MASK
Definition vsf_template_usart.h:486
VSF_USART_HALF_DUPLEX_MASK
@ VSF_USART_HALF_DUPLEX_MASK
Definition vsf_template_usart.h:475
VSF_USART_HWCONTROL_MASK
@ VSF_USART_HWCONTROL_MASK
Definition vsf_template_usart.h:460
VSF_USART_RX_MASK
@ VSF_USART_RX_MASK
Definition vsf_template_usart.h:469
VSF_USART_SYNC_CLOCK_PHASE_MASK
@ VSF_USART_SYNC_CLOCK_PHASE_MASK
Definition vsf_template_usart.h:481
VSF_USART_STOPBIT_MASK
@ VSF_USART_STOPBIT_MASK
Definition vsf_template_usart.h:432
VSF_USART_RX_FIFO_THRESHOLD_MASK
@ VSF_USART_RX_FIFO_THRESHOLD_MASK
Definition vsf_template_usart.h:454
VSF_USART_SYNC_CLOCK_MASK
@ VSF_USART_SYNC_CLOCK_MASK
Definition vsf_template_usart.h:472
VSF_USART_TX_MASK
@ VSF_USART_TX_MASK
Definition vsf_template_usart.h:466
vsf_usart_txfifo_write
#define vsf_usart_txfifo_write(__USART,...)
Definition vsf_template_usart.h:1120
vsf_usart_cancel_rx
#define vsf_usart_cancel_rx(__USART)
Definition vsf_template_usart.h:1123
vsf_usart_irq_mask_t
vsf_usart_irq_mask_t
Predefined VSF USART interrupt that can be reimplemented in specific hal drivers.
Definition vsf_template_usart.h:537
VSF_USART_IRQ_MASK_TX_CPL
@ VSF_USART_IRQ_MASK_TX_CPL
Definition vsf_template_usart.h:539
VSF_USART_IRQ_MASK_OVERFLOW_ERR
@ VSF_USART_IRQ_MASK_OVERFLOW_ERR
Definition vsf_template_usart.h:554
VSF_USART_IRQ_MASK_CTS
@ VSF_USART_IRQ_MASK_CTS
Definition vsf_template_usart.h:548
VSF_USART_IRQ_MASK_TX
@ VSF_USART_IRQ_MASK_TX
Definition vsf_template_usart.h:543
VSF_USART_IRQ_MASK_BREAK_ERR
@ VSF_USART_IRQ_MASK_BREAK_ERR
Definition vsf_template_usart.h:553
VSF_USART_IRQ_MASK_RX
@ VSF_USART_IRQ_MASK_RX
Definition vsf_template_usart.h:544
VSF_USART_IRQ_MASK_RX_TIMEOUT
@ VSF_USART_IRQ_MASK_RX_TIMEOUT
Definition vsf_template_usart.h:545
VSF_USART_IRQ_MASK_RX_CPL
@ VSF_USART_IRQ_MASK_RX_CPL
Definition vsf_template_usart.h:540
VSF_USART_IRQ_MASK_PARITY_ERR
@ VSF_USART_IRQ_MASK_PARITY_ERR
Definition vsf_template_usart.h:552
VSF_USART_IRQ_MASK_FRAME_ERR
@ VSF_USART_IRQ_MASK_FRAME_ERR
Definition vsf_template_usart.h:551
vsf_usart_get_tx_count
#define vsf_usart_get_tx_count(__USART)
Definition vsf_template_usart.h:1126
vsf_usart_status
#define vsf_usart_status(__USART)
Definition vsf_template_usart.h:1116
vsf_usart_get_rx_count
#define vsf_usart_get_rx_count(__USART)
Definition vsf_template_usart.h:1125
VSF_USART_APIS
#define VSF_USART_APIS(__prefix_name)
Definition vsf_template_usart.h:187
vsf_usart_status_t
struct vsf_usart_status_t vsf_usart_status_t
vsf_usart_enable
#define vsf_usart_enable(__USART)
Definition vsf_template_usart.h:1112
vsf_usart_fini
#define vsf_usart_fini(__USART)
Definition vsf_template_usart.h:1110
vsf_usart_isr_handler_t
void vsf_usart_isr_handler_t(void *target_ptr, vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask)
Definition vsf_template_usart.h:611
vsf_usart_irq_enable
#define vsf_usart_irq_enable(__USART,...)
Definition vsf_template_usart.h:1114
vsf_usart_set_break
#define vsf_usart_set_break(__USART)
Definition vsf_template_usart.h:1128
Generated by doxygen 1.9.8