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
30/*============================ MACROS ========================================*/
31
38#ifndef VSF_USART_CFG_MULTI_CLASS
39# define VSF_USART_CFG_MULTI_CLASS ENABLED
40#endif
41
50#if defined(VSF_HW_USART_COUNT) && !defined(VSF_HW_USART_MASK)
51# define VSF_HW_USART_MASK VSF_HAL_COUNT_TO_MASK(VSF_HW_USART_COUNT)
52#endif
53
62#if defined(VSF_HW_USART_MASK) && !defined(VSF_HW_USART_COUNT)
63# define VSF_HW_USART_COUNT VSF_HAL_MASK_TO_COUNT(VSF_HW_USART_MASK)
64#endif
65
83#ifndef VSF_USART_CFG_PREFIX
84# if VSF_USART_CFG_MULTI_CLASS == ENABLED
85# define VSF_USART_CFG_PREFIX vsf
86# elif defined(VSF_HW_USART_COUNT) && (VSF_HW_USART_COUNT != 0)
87# define VSF_USART_CFG_PREFIX vsf_hw
88# else
89# define VSF_USART_CFG_PREFIX vsf
90# endif
91#endif
92
101#ifndef VSF_USART_CFG_FUNCTION_RENAME
102# define VSF_USART_CFG_FUNCTION_RENAME ENABLED
103#endif
104
113#ifndef VSF_USART_CFG_REIMPLEMENT_TYPE_MODE
114# define VSF_USART_CFG_REIMPLEMENT_TYPE_MODE DISABLED
115#endif
116
125#ifndef VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK
126# define VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK DISABLED
127#endif
128
137#ifndef VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS
138# define VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS DISABLED
139#endif
140
149#ifndef VSF_USART_CFG_REIMPLEMENT_TYPE_CTRL
150# define VSF_USART_CFG_REIMPLEMENT_TYPE_CTRL DISABLED
151#endif
152
162#ifndef VSF_USART_CFG_REIMPLEMENT_MODE_TO_DATA_BITS
163# define VSF_USART_CFG_REIMPLEMENT_MODE_TO_DATA_BITS \
164 DISABLED
165#endif
166
176#ifndef VSF_USART_CFG_REIMPLEMENT_TYPE_CFG
177# define VSF_USART_CFG_REIMPLEMENT_TYPE_CFG DISABLED
178#endif
179
190#ifndef VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY
191# define VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
192#endif
193
202#ifndef VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS
203# define VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS DISABLED
204#endif
205
214#ifndef VSF_USART_CFG_INHERIT_HAL_CAPABILITY
215# define VSF_USART_CFG_INHERIT_HAL_CAPABILITY ENABLED
216#endif
217
218/*============================ MACROFIED FUNCTIONS ===========================*/
219
228#define VSF_USART_APIS(__prefix_name) \
229 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, init, VSF_MCONNECT(__prefix_name, _t) *usart_ptr, vsf_usart_cfg_t *cfg_ptr) \
230 __VSF_HAL_TEMPLATE_API(__prefix_name, void, usart, fini, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
231 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, get_configuration, VSF_MCONNECT(__prefix_name, _t) *usart_ptr, vsf_usart_cfg_t *cfg_ptr) \
232 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, usart, enable, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
233 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, usart, disable, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
234 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_usart_capability_t, usart, capability, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
235 __VSF_HAL_TEMPLATE_API(__prefix_name, void, usart, irq_enable, VSF_MCONNECT(__prefix_name, _t) *usart_ptr, vsf_usart_irq_mask_t irq_mask) \
236 __VSF_HAL_TEMPLATE_API(__prefix_name, void, usart, irq_disable, VSF_MCONNECT(__prefix_name, _t) *usart_ptr, vsf_usart_irq_mask_t irq_mask) \
237 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_usart_irq_mask_t, usart, irq_clear, VSF_MCONNECT(__prefix_name, _t) *usart_ptr, vsf_usart_irq_mask_t irq_mask) \
238 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_usart_status_t, usart, status, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
239 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast32_t, usart, rxfifo_get_data_count, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
240 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast32_t, usart, rxfifo_read, VSF_MCONNECT(__prefix_name, _t) *usart_ptr, void *buffer_ptr, uint_fast32_t count) \
241 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast32_t, usart, txfifo_get_free_count, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
242 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast32_t, usart, txfifo_write, VSF_MCONNECT(__prefix_name, _t) *usart_ptr, void *buffer_ptr, uint_fast32_t count) \
243 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, request_rx, VSF_MCONNECT(__prefix_name, _t) *usart_ptr, void *buffer_ptr, uint_fast32_t count) \
244 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, request_tx, VSF_MCONNECT(__prefix_name, _t) *usart_ptr, void *buffer_ptr, uint_fast32_t count) \
245 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, cancel_rx, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
246 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, cancel_tx, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
247 __VSF_HAL_TEMPLATE_API(__prefix_name, int_fast32_t, usart, get_rx_count, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
248 __VSF_HAL_TEMPLATE_API(__prefix_name, int_fast32_t, usart, get_tx_count, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
249 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, ctrl, VSF_MCONNECT(__prefix_name, _t) *usart_ptr, vsf_usart_ctrl_t ctrl, void* param)
250
251#define VSF_USART_ADDITIONAL_APIS(__prefix_name) \
252 static inline vsf_err_t VSF_MCONNECT(__prefix_name, _send_break) \
253 (VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
254 { \
255 return VSF_MCONNECT(__prefix_name, _ctrl)(usart_ptr, \
256 VSF_USART_CTRL_SEND_BREAK, NULL); \
257 } \
258 static inline vsf_err_t VSF_MCONNECT(__prefix_name, _set_break) \
259 (VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
260 { \
261 vsf_usart_capability_t cap = \
262 VSF_MCONNECT(__prefix_name, _capability)(usart_ptr); \
263 VSF_HAL_ASSERT(cap.support_set_and_clear_break); \
264 return VSF_MCONNECT(__prefix_name, _ctrl)(usart_ptr, \
265 VSF_USART_CTRL_SET_BREAK, NULL); \
266 } \
267 static inline vsf_err_t VSF_MCONNECT(__prefix_name, _clear_break) \
268 (VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
269 { \
270 vsf_usart_capability_t cap = \
271 VSF_MCONNECT(__prefix_name, _capability)(usart_ptr); \
272 VSF_HAL_ASSERT(cap.support_set_and_clear_break); \
273 return VSF_MCONNECT(__prefix_name, _ctrl)(usart_ptr, \
274 VSF_USART_CTRL_CLEAR_BREAK, NULL); \
275 }
276
277/*============================ TYPES =========================================*/
278
279#if VSF_USART_CFG_REIMPLEMENT_TYPE_MODE == DISABLED
312typedef enum vsf_usart_mode_t {
319 VSF_USART_NO_PARITY = (0x0ul << 0),
320 VSF_USART_EVEN_PARITY = (0x1ul << 0),
321 VSF_USART_ODD_PARITY = (0x2ul << 0),
322 VSF_USART_FORCE_0_PARITY = (0x3ul << 0),
323# define VSF_USART_FORCE_0_PARITY VSF_USART_FORCE_0_PARITY
324 VSF_USART_FORCE_1_PARITY = (0x4ul << 0),
325# define VSF_USART_FORCE_1_PARITY VSF_USART_FORCE_1_PARITY
326
333 VSF_USART_1_STOPBIT = (0x0ul << 3),
334 VSF_USART_1_5_STOPBIT = (0x1ul << 3),
335# define VSF_USART_1_5_STOPBIT VSF_USART_1_5_STOPBIT
336 VSF_USART_0_5_STOPBIT = (0x2ul << 3),
337# define VSF_USART_0_5_STOPBIT VSF_USART_0_5_STOPBIT
338 VSF_USART_2_STOPBIT = (0x3ul << 3),
339# define VSF_USART_2_STOPBIT VSF_USART_2_STOPBIT
340
347 VSF_USART_8_BIT_LENGTH = (0x0ul << 5),
348 VSF_USART_5_BIT_LENGTH = (0x1ul << 5),
349# define VSF_USART_5_BIT_LENGTH VSF_USART_5_BIT_LENGTH
350 VSF_USART_6_BIT_LENGTH = (0x2ul << 5),
351# define VSF_USART_6_BIT_LENGTH VSF_USART_6_BIT_LENGTH
352 VSF_USART_7_BIT_LENGTH = (0x3ul << 5),
353# define VSF_USART_7_BIT_LENGTH VSF_USART_7_BIT_LENGTH
354 VSF_USART_9_BIT_LENGTH = (0x4ul << 5),
355# define VSF_USART_9_BIT_LENGTH VSF_USART_9_BIT_LENGTH
356 VSF_USART_10_BIT_LENGTH = (0x5ul << 5),
357# define VSF_USART_10_BIT_LENGTH VSF_USART_10_BIT_LENGTH
358
365 VSF_USART_NO_HWCONTROL = (0x0ul << 8),
366 VSF_USART_RTS_HWCONTROL = (0x1ul << 8),
367# define VSF_USART_RTS_HWCONTROL VSF_USART_RTS_HWCONTROL
368 VSF_USART_CTS_HWCONTROL = (0x2ul << 8),
369# define VSF_USART_CTS_HWCONTROL VSF_USART_CTS_HWCONTROL
370 VSF_USART_RTS_CTS_HWCONTROL = (0x3ul << 8),
371# define VSF_USART_RTS_CTS_HWCONTROL VSF_USART_RTS_CTS_HWCONTROL
372
379 VSF_USART_TX_ENABLE = (0x0ul << 9),
380 VSF_USART_RX_ENABLE = (0x0ul << 10),
381 VSF_USART_TX_DISABLE = (0x1ul << 9),
382# define VSF_USART_TX_DISABLE VSF_USART_TX_DISABLE
383 VSF_USART_RX_DISABLE = (0x1ul << 10),
384# define VSF_USART_RX_DISABLE VSF_USART_RX_DISABLE
385
392 VSF_USART_SYNC_CLOCK_ENABLE = (0x0ul << 11),
393# define VSF_USART_SYNC_CLOCK_ENABLE VSF_USART_SYNC_CLOCK_ENABLE
394 VSF_USART_SYNC_CLOCK_DISABLE = (0x1ul << 11),
395
402 VSF_USART_HALF_DUPLEX_DISABLE = (0x0ul << 14),
403 VSF_USART_HALF_DUPLEX_ENABLE = (0x1ul << 14),
404# define VSF_USART_HALF_DUPLEX_ENABLE VSF_USART_HALF_DUPLEX_ENABLE
405
414 VSF_USART_TX_FIFO_THRESHOLD_EMPTY = (0x0ul << 15),
415# define VSF_USART_TX_FIFO_THRESHOLD_EMPTY VSF_USART_TX_FIFO_THRESHOLD_EMPTY
416 VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY = (0x1ul << 15),
417# define VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
418 VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL = (0x2ul << 15),
419# define VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL
420
429 VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY = (0x0ul << 17),
430# define VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY
431 VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL = (0x1ul << 17),
432# define VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL
433 VSF_USART_RX_FIFO_THRESHOLD_FULL = (0x2ul << 17),
434# define VSF_USART_RX_FIFO_THRESHOLD_FULL VSF_USART_RX_FIFO_THRESHOLD_FULL
435
447 // VSF_USART_SWAP = (0x1ul << 16), //!< \~english Swap RX and TX pins \~chinese 交换 RX 和 TX 引脚
448 // VSF_USART_TX_INVERT = (0x1ul << 17), //!< \~english Invert TX pin signal \~chinese 反转 TX 引脚信号
449 // VSF_USART_RX_INVERT = (0x1ul << 18), //!< \~english Invert RX pin signal \~chinese 反转 RX 引脚信号
450} vsf_usart_mode_t;
451#endif
452
464enum {
465#ifndef VSF_USART_PARITY_MASK
466 VSF_USART_PARITY_MASK = VSF_USART_NO_PARITY
467 | VSF_USART_EVEN_PARITY
468 | VSF_USART_ODD_PARITY
469 | VSF_USART_FORCE_0_PARITY
470 | VSF_USART_FORCE_1_PARITY,
471#endif
472
473#ifndef VSF_USART_STOPBIT_MASK
474 VSF_USART_STOPBIT_MASK = VSF_USART_1_STOPBIT
475 | VSF_USART_1_5_STOPBIT
476 | VSF_USART_0_5_STOPBIT
477 | VSF_USART_2_STOPBIT,
478#endif
479
480#ifndef VSF_USART_BIT_LENGTH_MASK
481 VSF_USART_BIT_LENGTH_MASK = VSF_USART_5_BIT_LENGTH
482 | VSF_USART_6_BIT_LENGTH
483 | VSF_USART_7_BIT_LENGTH
484 | VSF_USART_8_BIT_LENGTH
485 | VSF_USART_9_BIT_LENGTH
486 | VSF_USART_10_BIT_LENGTH,
487#endif
488
489#ifndef VSF_USART_TX_FIFO_THRESHOLD_MASK
490 VSF_USART_TX_FIFO_THRESHOLD_MASK = VSF_USART_TX_FIFO_THRESHOLD_EMPTY
491 | VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
492 | VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL,
493#endif
494
495#ifndef VSF_USART_RX_FIFO_THRESHOLD_MASK
496 VSF_USART_RX_FIFO_THRESHOLD_MASK = VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY
497 | VSF_USART_RX_FIFO_THRESHOLD_FULL
498 | VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL,
499#endif
500
501#ifndef VSF_USART_HWCONTROL_MASK
502 VSF_USART_HWCONTROL_MASK = VSF_USART_NO_HWCONTROL
503 | VSF_USART_RTS_HWCONTROL
504 | VSF_USART_CTS_HWCONTROL
505 | VSF_USART_RTS_CTS_HWCONTROL,
506#endif
507
508 VSF_USART_TX_MASK = VSF_USART_TX_ENABLE
509 | VSF_USART_TX_DISABLE,
510
511 VSF_USART_RX_MASK = VSF_USART_RX_ENABLE
512 | VSF_USART_RX_DISABLE,
513
514 VSF_USART_SYNC_CLOCK_MASK = VSF_USART_SYNC_CLOCK_ENABLE
515 | VSF_USART_SYNC_CLOCK_DISABLE,
516
517 VSF_USART_HALF_DUPLEX_MASK = VSF_USART_HALF_DUPLEX_DISABLE
518 | VSF_USART_HALF_DUPLEX_ENABLE,
519
520 VSF_USART_MODE_ALL_BITS_MASK = VSF_USART_PARITY_MASK
521 | VSF_USART_STOPBIT_MASK
522 | VSF_USART_BIT_LENGTH_MASK
523 | VSF_USART_HWCONTROL_MASK
524 | VSF_USART_TX_FIFO_THRESHOLD_MASK
525 | VSF_USART_RX_FIFO_THRESHOLD_MASK
526 | VSF_USART_TX_MASK
527 | VSF_USART_RX_MASK
528 | VSF_USART_SYNC_CLOCK_MASK
529 | VSF_USART_HALF_DUPLEX_MASK
530#ifdef VSF_USART_SYNC_CLOCK_LAST_BIT_MASK
531 | VSF_USART_SYNC_CLOCK_LAST_BIT_MASK
532#endif
533
534#ifdef VSF_USART_IRDA_PRESCALER_MASK
535 | VSF_USART_IRDA_PRESCALER_MASK
536#endif
537#ifdef VSF_USART_IRDA_MASK
538 | VSF_USART_IRDA_MASK
539#endif
540
541#ifdef VSF_USART_SMARTCARD_MASK
542 | VSF_USART_SMARTCARD_MASK
543#endif
544};
545
546#if VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
555typedef enum vsf_usart_irq_mask_t {
556 VSF_USART_IRQ_MASK_TX_CPL = (0x1ul << 0),
557 VSF_USART_IRQ_MASK_RX_CPL = (0x1ul << 1),
558 VSF_USART_IRQ_MASK_TX = (0x1ul << 2),
559 VSF_USART_IRQ_MASK_RX = (0x1ul << 3),
560
573 VSF_USART_IRQ_MASK_RX_TIMEOUT = (0x1ul << 4),
574# define VSF_USART_IRQ_MASK_RX_TIMEOUT VSF_USART_IRQ_MASK_RX_TIMEOUT
575
589 VSF_USART_IRQ_MASK_CTS = (0x1ul << 5),
590# define VSF_USART_IRQ_MASK_CTS VSF_USART_IRQ_MASK_CTS
591
627 VSF_USART_IRQ_MASK_FRAME_ERR = (0x1ul << 6),
628# define VSF_USART_IRQ_MASK_FRAME_ERR VSF_USART_IRQ_MASK_FRAME_ERR
629 VSF_USART_IRQ_MASK_BREAK_ERR = (0x1ul << 7),
630# define VSF_USART_IRQ_MASK_BREAK_ERR VSF_USART_IRQ_MASK_BREAK_ERR
631
645 VSF_USART_IRQ_MASK_PARITY_ERR = (0x1ul << 8),
646# define VSF_USART_IRQ_MASK_PARITY_ERR VSF_USART_IRQ_MASK_PARITY_ERR
647
661 VSF_USART_IRQ_MASK_RX_OVERFLOW_ERR = (0x1ul << 9),
662# define VSF_USART_IRQ_MASK_RX_OVERFLOW_ERR VSF_USART_IRQ_MASK_RX_OVERFLOW_ERR
663
664
673 VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR = (0x1ul << 10),
674# define VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR
675
684 VSF_USART_IRQ_MASK_TX_IDLE = (0x1ul << 11),
685# define VSF_USART_IRQ_MASK_TX_IDLE VSF_USART_IRQ_MASK_TX_IDLE
686
697 VSF_USART_IRQ_MASK_RX_IDLE = (0x1ul << 12),
698# define VSF_USART_IRQ_MASK_RX_IDLE VSF_USART_IRQ_MASK_RX_IDLE
699
708 VSF_USART_IRQ_MASK_NOISE_ERR = (0x1UL << 13)
709# define VSF_USART_IRQ_MASK_NOISE_ERR VSF_USART_IRQ_MASK_NOISE_ERR
710} vsf_usart_irq_mask_t;
711#endif
712
719enum {
720#ifndef VSF_USART_IRQ_MASK_RX_IDLE
721 VSF_USART_IRQ_MASK_RX_IDLE = VSF_USART_IRQ_MASK_RX_TIMEOUT,
722#endif
723 VSF_USART_IRQ_MASK_TX_FIFO_THRESHOLD = VSF_USART_IRQ_MASK_TX,
724 VSF_USART_IRQ_MASK_RX_FIFO_THRESHOLD = VSF_USART_IRQ_MASK_RX,
725
726#ifndef VSF_USART_IRQ_MASK_ERR
727 VSF_USART_IRQ_MASK_ERR = VSF_USART_IRQ_MASK_FRAME_ERR
728 | VSF_USART_IRQ_MASK_PARITY_ERR
729 | VSF_USART_IRQ_MASK_BREAK_ERR
730# ifdef VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR
731 | VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR
732# endif
733 | VSF_USART_IRQ_MASK_RX_OVERFLOW_ERR,
734#endif
735
736#ifndef VSF_USART_IRQ_ALL_BITS_MASK
737 VSF_USART_IRQ_ALL_BITS_MASK = VSF_USART_IRQ_MASK_TX
738 | VSF_USART_IRQ_MASK_RX
739 | VSF_USART_IRQ_MASK_RX_TIMEOUT
740#ifdef VSF_USART_IRQ_MASK_RX_IDLE
741 | VSF_USART_IRQ_MASK_RX_IDLE
742#endif
743#ifdef VSF_USART_IRQ_MASK_TX_IDLE
744 | VSF_USART_IRQ_MASK_TX_IDLE
745#endif
746 | VSF_USART_IRQ_MASK_CTS
747 | VSF_USART_IRQ_MASK_TX_CPL
748 | VSF_USART_IRQ_MASK_RX_CPL
749 | VSF_USART_IRQ_MASK_ERR,
750# ifdef VSF_USART_IRQ_MASK_TX_HALF_CPL
751 | VSF_USART_IRQ_MASK_TX_HALF_CPL
752# endif
753# ifdef VSF_USART_IRQ_MASK_RX_HALF_CPL
754 | VSF_USART_IRQ_MASK_RX_HALF_CPL
755# endif
756# ifdef VSF_USART_IRQ_MASK_CANCEL_TX_CPL
757 | VSF_USART_IRQ_MASK_CANCEL_TX_CPL
758# endif
759# ifdef VSF_USART_IRQ_MASK_CANCEL_RX_CPL
760 | VSF_USART_IRQ_MASK_CANCEL_RX_CPL
761# endif
762#endif
763};
764
765#if VSF_USART_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
772typedef struct vsf_usart_t vsf_usart_t;
773
817typedef void vsf_usart_isr_handler_t(void *target_ptr,
818 vsf_usart_t *usart_ptr,
819 vsf_usart_irq_mask_t irq_mask);
820
829typedef struct vsf_usart_isr_t {
830 vsf_usart_isr_handler_t *handler_fn;
831 void *target_ptr;
832 vsf_arch_prio_t prio;
833} vsf_usart_isr_t;
834
843typedef struct vsf_usart_cfg_t {
844 vsf_usart_mode_t mode;
845 uint32_t baudrate;
846 uint32_t rx_timeout;
847# ifdef VSF_USART_IRQ_MASK_RX_IDLE
848 uint32_t rx_idle_cnt;
849# endif
850 vsf_usart_isr_t isr;
851} vsf_usart_cfg_t;
852#endif
853
854#if VSF_USART_CFG_REIMPLEMENT_TYPE_CTRL == DISABLED
863typedef enum vsf_usart_ctrl_t {
872 VSF_USART_CTRL_SEND_BREAK = (0x01ul << 0),
873# define VSF_USART_CTRL_SEND_BREAK VSF_USART_CTRL_SEND_BREAK
874
883 VSF_USART_CTRL_SET_BREAK = (0x01ul << 1),
884# define VSF_USART_CTRL_SET_BREAK VSF_USART_CTRL_SET_BREAK
885
894 VSF_USART_CTRL_CLEAR_BREAK = (0x01ul << 2),
895# define VSF_USART_CTRL_CLEAR_BREAK VSF_USART_CTRL_CLEAR_BREAK
896
897 /*
898 VSF_USART_CTRL_REQUEST_RX_RESUME = (0x1ul << 3),
899 #define VSF_USART_CTRL_REQUEST_RX_RESUME VSF_USART_CTRL_REQUEST_RX_RESUME
900 VSF_USART_CTRL_REQUEST_TX_RESUME = (0x1ul << 4),
901 #define VSF_USART_CTRL_REQUEST_TX_RESUME VSF_USART_CTRL_REQUEST_TX_RESUME
902
903 VSF_USART_CTRL_REQUEST_RX_PAUSE = (0x1ul << 5),
904 #define VSF_USART_CTRL_REQUEST_RX_PAUSE VSF_USART_CTRL_REQUEST_RX_PAUSE
905 VSF_USART_CTRL_REQUEST_TX_PAUSE = (0x1ul << 6),
906 #define VSF_USART_CTRL_REQUEST_TX_PAUSE VSF_USART_CTRL_REQUEST_TX_PAUSE
907
908 VSF_USART_CTRL_HALF_DUPLEX_ENABLE_TRANSMITTER = (0x1ul << 7),
909 #define VSF_USART_CTRL_HALF_DUPLEX_ENABLE_TRANSMITTER VSF_USART_CTRL_HALF_DUPLEX_ENABLE_TRANSMITTER
910
911 VSF_USART_CTRL_HALF_DUPLEX_ENABLE_RECEIVER = (0x1ul << 8),
912 #define VSF_USART_CTRL_HALF_DUPLEX_ENABLE_RECEIVER VSF_USART_CTRL_HALF_DUPLEX_ENABLE_RECEIVER
913 */
914
915 // Ensure compilation passes when there are no commands
916 __VSF_USART_CTRL_DUMMY_MASK = (0x1ul << 3),
917} vsf_usart_ctrl_t;
918#endif
919
928#if VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED
929typedef struct vsf_usart_status_t {
930 union {
931 inherit(vsf_peripheral_status_t)
932 uint32_t value;
933 struct {
934 uint32_t is_busy : 1;
935 uint32_t is_tx_busy : 1;
936 uint32_t is_rx_busy : 1;
937 uint32_t break_sent : 1;
938 uint32_t __reserved : 4;
939 uint32_t tx_fifo_level : 8;
940 uint32_t rx_fifo_level : 8;
941 };
942 };
943} vsf_usart_status_t;
944#endif
945
954#if VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
955typedef struct vsf_usart_capability_t {
956#if VSF_USART_CFG_INHERIT_HAL_CAPABILITY == ENABLED
957 inherit(vsf_peripheral_capability_t)
958#endif
959 vsf_usart_irq_mask_t irq_mask;
960
961 uint32_t max_baudrate;
962 uint32_t min_baudrate;
963
964 uint8_t txfifo_depth;
965 uint8_t rxfifo_depth;
966
967 uint8_t max_data_bits;
968 uint8_t min_data_bits;
969
970 uint8_t support_rx_timeout : 1;
971 uint8_t support_send_break : 1;
972 uint8_t support_set_and_clear_break : 1;
973 uint8_t support_sync_clock : 1;
974# ifdef VSF_USART_IRQ_MASK_TX_IDLE
975 uint8_t support_tx_idle : 1;
976# endif
977# ifdef VSF_USART_IRQ_MASK_RX_IDLE
978 uint8_t support_rx_idle : 1;
979# endif
980} vsf_usart_capability_t;
981#endif
990typedef struct vsf_usart_op_t {
992#undef __VSF_HAL_TEMPLATE_API
993#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
995
996 VSF_USART_APIS(vsf_usart)
997} vsf_usart_op_t;
998
999#if VSF_USART_CFG_MULTI_CLASS == ENABLED
1008struct vsf_usart_t {
1009 const vsf_usart_op_t * op;
1010};
1011#endif
1012
1013/*============================ PROTOTYPES ====================================*/
1014
1032extern vsf_err_t vsf_usart_init(vsf_usart_t *usart_ptr, vsf_usart_cfg_t *cfg_ptr);
1033
1045extern void vsf_usart_fini(vsf_usart_t *usart_ptr);
1046
1064extern vsf_err_t vsf_usart_get_configuration(vsf_usart_t *usart_ptr, vsf_usart_cfg_t *cfg_ptr);
1065
1077extern fsm_rt_t vsf_usart_enable(vsf_usart_t *usart_ptr);
1078
1090extern fsm_rt_t vsf_usart_disable(vsf_usart_t *usart_ptr);
1091
1107extern void vsf_usart_irq_enable(vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask);
1108
1122extern void vsf_usart_irq_disable(vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask);
1123
1149extern vsf_usart_irq_mask_t vsf_usart_irq_clear(vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask);
1150
1162extern vsf_usart_status_t vsf_usart_status(vsf_usart_t *usart_ptr);
1163
1175extern vsf_usart_capability_t vsf_usart_capability(vsf_usart_t *usart_ptr);
1176
1188extern uint_fast32_t vsf_usart_rxfifo_get_data_count(vsf_usart_t *usart_ptr);
1189
1205extern uint_fast32_t vsf_usart_rxfifo_read(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count);
1206
1218extern uint_fast32_t vsf_usart_txfifo_get_free_count(vsf_usart_t *usart_ptr);
1219
1235extern uint_fast32_t vsf_usart_txfifo_write(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count);
1236
1254extern vsf_err_t vsf_usart_request_rx(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count);
1255
1273extern vsf_err_t vsf_usart_request_tx(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count);
1274
1286extern vsf_err_t vsf_usart_cancel_rx(vsf_usart_t *usart_ptr);
1287
1299extern vsf_err_t vsf_usart_cancel_tx(vsf_usart_t *usart_ptr);
1300
1316extern int_fast32_t vsf_usart_get_rx_count(vsf_usart_t *usart_ptr);
1317
1333extern int_fast32_t vsf_usart_get_tx_count(vsf_usart_t *usart_ptr);
1334
1352extern vsf_err_t vsf_usart_ctrl(vsf_usart_t *usart_ptr, vsf_usart_ctrl_t ctrl, void *param);
1353
1354/*============================ INLINE FUNCTIONS ==============================*/
1355
1356#if VSF_USART_CFG_REIMPLEMENT_MODE_TO_DATA_BITS == DISABLED
1367static inline uint8_t vsf_usart_mode_to_data_bits(vsf_usart_mode_t mode)
1368{
1369 switch (mode & VSF_USART_BIT_LENGTH_MASK) {
1370 case VSF_USART_5_BIT_LENGTH:
1371 return 5;
1372 case VSF_USART_6_BIT_LENGTH:
1373 return 6;
1374 case VSF_USART_7_BIT_LENGTH:
1375 return 7;
1376 case VSF_USART_8_BIT_LENGTH:
1377 return 8;
1378 case VSF_USART_9_BIT_LENGTH:
1379 return 9;
1380 case VSF_USART_10_BIT_LENGTH:
1381 return 10;
1382 default:
1383 return 0;
1384 }
1385}
1386#endif
1387
1400static inline vsf_err_t vsf_usart_send_break(vsf_usart_t *usart_ptr)
1401{
1402 vsf_usart_capability_t cap = vsf_usart_capability(usart_ptr);
1403 VSF_HAL_ASSERT(cap.support_send_break);
1404
1405 return vsf_usart_ctrl(usart_ptr, VSF_USART_CTRL_SEND_BREAK, NULL);
1406}
1407
1419static inline vsf_err_t vsf_usart_set_break(vsf_usart_t *usart_ptr)
1420{
1421 vsf_usart_capability_t cap = vsf_usart_capability(usart_ptr);
1422 VSF_HAL_ASSERT(cap.support_set_and_clear_break);
1423
1424 return vsf_usart_ctrl(usart_ptr, VSF_USART_CTRL_SET_BREAK, NULL);
1425}
1426
1438static inline vsf_err_t vsf_usart_clear_break(vsf_usart_t *usart_ptr)
1439{
1440 vsf_usart_capability_t cap = vsf_usart_capability(usart_ptr);
1441 VSF_HAL_ASSERT(cap.support_set_and_clear_break);
1442
1443 return vsf_usart_ctrl(usart_ptr, VSF_USART_CTRL_CLEAR_BREAK, NULL);
1444}
1445
1446/*============================ MACROFIED FUNCTIONS ===========================*/
1447
1449#if VSF_USART_CFG_FUNCTION_RENAME == ENABLED
1450# define __vsf_usart_t VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_t)
1451# define vsf_usart_init(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_init) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1452# define vsf_usart_fini(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_fini) ((__vsf_usart_t *)(__USART))
1453# define vsf_usart_get_configuration(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_get_configuration) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1454# define vsf_usart_capability(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_capability) ((__vsf_usart_t *)(__USART))
1455# define vsf_usart_enable(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_enable) ((__vsf_usart_t *)(__USART))
1456# define vsf_usart_disable(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_disable) ((__vsf_usart_t *)(__USART))
1457# define vsf_usart_irq_enable(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_irq_enable) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1458# define vsf_usart_irq_disable(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_irq_disable) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1459# define vsf_usart_irq_clear(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_irq_clear) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1460# define vsf_usart_status(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_status) ((__vsf_usart_t *)(__USART))
1461# 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__)
1462# define vsf_usart_rxfifo_read(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_rxfifo_read) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1463# 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__)
1464# define vsf_usart_txfifo_write(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_txfifo_write) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1465# define vsf_usart_request_rx(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_request_rx) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1466# define vsf_usart_request_tx(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_request_tx) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1467# define vsf_usart_cancel_rx(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_cancel_rx) ((__vsf_usart_t *)(__USART))
1468# define vsf_usart_cancel_tx(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_cancel_tx) ((__vsf_usart_t *)(__USART))
1469# define vsf_usart_get_rx_count(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_get_rx_count) ((__vsf_usart_t *)(__USART))
1470# define vsf_usart_get_tx_count(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_get_tx_count) ((__vsf_usart_t *)(__USART))
1471# define vsf_usart_send_break(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_send_break) ((__vsf_usart_t *)(__USART))
1472# define vsf_usart_set_break(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_set_break) ((__vsf_usart_t *)(__USART))
1473# define vsf_usart_clear_break(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_clear_break) ((__vsf_usart_t *)(__USART))
1474# define vsf_usart_ctrl(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_ctrl) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1475#endif
1477
1478/*============================ INCLUDES ======================================*/
1479
1480#ifdef __cplusplus
1481}
1482#endif
1483
1484#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
irq_mask
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
uint32_t
unsigned uint32_t
Definition stdint.h:9
uint_fast32_t
unsigned int uint_fast32_t
Definition stdint.h:27
int_fast32_t
int int_fast32_t
Definition stdint.h:26
uint8_t
unsigned char uint8_t
Definition stdint.h:5
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
USART capability structure Defines the hardware capabilities and limitations of the USART interface.
Definition vsf_template_usart.h:955
vsf_usart_capability_t::support_tx_idle
uint8_t support_tx_idle
Support TX idle interrupt.
Definition vsf_template_usart.h:975
vsf_usart_capability_t::max_data_bits
uint8_t max_data_bits
Maximum data bits per frame.
Definition vsf_template_usart.h:967
vsf_usart_capability_t::support_set_and_clear_break
uint8_t support_set_and_clear_break
Support set and clear break.
Definition vsf_template_usart.h:972
vsf_usart_capability_t::inherit
inherit(vsf_peripheral_capability_t) vsf_usart_irq_mask_t irq_mask
Supported interrupt mask bits.
vsf_usart_capability_t::irq_mask
vsf_usart_irq_mask_t irq_mask
Definition usart.h:387
vsf_usart_capability_t::support_rx_timeout
uint8_t support_rx_timeout
Support receive timeout.
Definition vsf_template_usart.h:970
vsf_usart_capability_t::rxfifo_depth
uint8_t rxfifo_depth
RX FIFO depth in data frames (0 means no FIFO)
Definition vsf_template_usart.h:965
vsf_usart_capability_t::support_rx_idle
uint8_t support_rx_idle
Support RX idle interrupt.
Definition vsf_template_usart.h:978
vsf_usart_capability_t::support_send_break
uint8_t support_send_break
Support send break.
Definition vsf_template_usart.h:971
vsf_usart_capability_t::txfifo_depth
uint8_t txfifo_depth
TX FIFO depth in data frames (0 means no FIFO)
Definition vsf_template_usart.h:964
vsf_usart_capability_t::min_data_bits
uint8_t min_data_bits
Minimum data bits per frame.
Definition vsf_template_usart.h:968
vsf_usart_capability_t::min_baudrate
uint32_t min_baudrate
Minimum supported baudrate (bps) according to current clock configurations.
Definition vsf_template_usart.h:962
vsf_usart_capability_t::max_baudrate
uint32_t max_baudrate
Maximum supported baudrate (bps) according to current clock configurations.
Definition vsf_template_usart.h:961
vsf_usart_capability_t::support_sync_clock
uint8_t support_sync_clock
Support Synchronous clock.
Definition vsf_template_usart.h:973
vsf_usart_cfg_t
USART configuration structure Contains all parameters needed to initialize and configure a USART inst...
Definition vsf_template_usart.h:843
vsf_usart_cfg_t::mode
vsf_usart_mode_t mode
USART working mode.
Definition vsf_template_usart.h:844
vsf_usart_cfg_t::baudrate
uint32_t baudrate
Baudrate in Hz.
Definition vsf_template_usart.h:845
vsf_usart_cfg_t::rx_timeout
uint32_t rx_timeout
RX timeout in microseconds.
Definition vsf_template_usart.h:846
vsf_usart_cfg_t::rx_idle_cnt
uint32_t rx_idle_cnt
Definition vsf_template_usart.h:848
vsf_usart_cfg_t::isr
vsf_usart_isr_t isr
Interrupt configuration.
Definition vsf_template_usart.h:850
vsf_usart_isr_t
USART interrupt configuration structure Contains all necessary information for configuring USART inte...
Definition vsf_template_usart.h:829
vsf_usart_isr_t::handler_fn
vsf_usart_isr_handler_t * handler_fn
Interrupt handler function pointer.
Definition vsf_template_usart.h:830
vsf_usart_isr_t::prio
vsf_arch_prio_t prio
Interrupt priority.
Definition vsf_template_usart.h:832
vsf_usart_isr_t::target_ptr
void * target_ptr
User target pointer.
Definition vsf_template_usart.h:831
vsf_usart_op_t
USART operation interface structure Contains function pointers for all USART operations.
Definition vsf_template_usart.h:990
vsf_usart_status_t
USART status information structure Contains the current status of USART operations and FIFO threshold...
Definition uart.h:157
vsf_usart_status_t::__reserved
uint32_t __reserved
Reserved.
Definition vsf_template_usart.h:938
vsf_usart_status_t::is_busy
uint32_t is_busy
USART is busy with any operation.
Definition vsf_template_usart.h:934
vsf_usart_status_t::is_tx_busy
uint32_t is_tx_busy
TX is busy transmitting data.
Definition vsf_template_usart.h:935
vsf_usart_status_t::value
uint32_t value
Definition usart.h:284
vsf_usart_status_t::break_sent
uint32_t break_sent
BREAK signal sent.
Definition vsf_template_usart.h:937
vsf_usart_status_t::tx_fifo_level
uint32_t tx_fifo_level
TX FIFO current data level (0-255)
Definition vsf_template_usart.h:939
vsf_usart_status_t::is_rx_busy
uint32_t is_rx_busy
RX is busy receiving data.
Definition vsf_template_usart.h:936
vsf_usart_status_t::rx_fifo_level
uint32_t rx_fifo_level
RX FIFO current data level (0-255)
Definition vsf_template_usart.h:940
vsf_usart_t
USART instance structure Used for USART Multi Class support.
Definition vsf_template_usart.h:1008
vsf_usart_t::op
const vsf_usart_op_t * op
Operation functions.
Definition vsf_template_usart.h:1009
vsf_usart_mode_t
vsf_usart_mode_t
Definition usart.h:116
vsf_usart_irq_mask_t
vsf_usart_irq_mask_t
Definition usart.h:174
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 usart.h:255
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_7_BIT_LENGTH
#define VSF_USART_7_BIT_LENGTH
Definition vsf_template_usart.h:353
VSF_USART_IRQ_MASK_RX_TIMEOUT
#define VSF_USART_IRQ_MASK_RX_TIMEOUT
Definition vsf_template_usart.h:574
vsf_usart_disable
fsm_rt_t vsf_usart_disable(vsf_usart_t *usart_ptr)
Disable a USART instance.
Definition usart_common.c:75
vsf_usart_status
vsf_usart_status_t vsf_usart_status(vsf_usart_t *usart_ptr)
Get the status of USART instance.
Definition usart_common.c:111
vsf_usart_cfg_t
struct vsf_usart_cfg_t vsf_usart_cfg_t
USART configuration structure Contains all parameters needed to initialize and configure a USART inst...
vsf_usart_request_rx
vsf_err_t vsf_usart_request_rx(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count)
Request a DMA receive operation through the USART.
Definition usart_common.c:165
VSF_USART_CTS_HWCONTROL
#define VSF_USART_CTS_HWCONTROL
Definition vsf_template_usart.h:369
vsf_usart_capability_t
struct vsf_usart_capability_t vsf_usart_capability_t
USART capability structure Defines the hardware capabilities and limitations of the USART interface.
vsf_usart_cancel_rx
vsf_err_t vsf_usart_cancel_rx(vsf_usart_t *usart_ptr)
Cancel an ongoing USART receive operation.
Definition usart_common.c:183
VSF_USART_HALF_DUPLEX_ENABLE
#define VSF_USART_HALF_DUPLEX_ENABLE
Definition vsf_template_usart.h:404
vsf_usart_mode_t
vsf_usart_mode_t
Predefined VSF USART modes that can be reimplemented in specific HAL drivers. Even if the hardware do...
Definition vsf_template_usart.h:312
VSF_USART_HALF_DUPLEX_DISABLE
@ VSF_USART_HALF_DUPLEX_DISABLE
USART Half-duplex configuration options.
Definition vsf_template_usart.h:402
VSF_USART_8_BIT_LENGTH
@ VSF_USART_8_BIT_LENGTH
USART Data bit length configuration options.
Definition vsf_template_usart.h:347
VSF_USART_EVEN_PARITY
@ VSF_USART_EVEN_PARITY
Even parity.
Definition vsf_template_usart.h:320
VSF_USART_ODD_PARITY
@ VSF_USART_ODD_PARITY
Odd parity.
Definition vsf_template_usart.h:321
VSF_USART_NO_PARITY
@ VSF_USART_NO_PARITY
USART Parity configuration options.
Definition vsf_template_usart.h:319
VSF_USART_RX_ENABLE
@ VSF_USART_RX_ENABLE
RX enabled.
Definition vsf_template_usart.h:380
VSF_USART_TX_ENABLE
@ VSF_USART_TX_ENABLE
USART TX/RX enable/disable options.
Definition vsf_template_usart.h:379
VSF_USART_1_STOPBIT
@ VSF_USART_1_STOPBIT
USART Stop bit configuration options.
Definition vsf_template_usart.h:333
VSF_USART_SYNC_CLOCK_DISABLE
@ VSF_USART_SYNC_CLOCK_DISABLE
Sync clock disabled.
Definition vsf_template_usart.h:394
VSF_USART_NO_HWCONTROL
@ VSF_USART_NO_HWCONTROL
USART Hardware flow control configuration options.
Definition vsf_template_usart.h:365
VSF_USART_IRQ_MASK_FRAME_ERR
#define VSF_USART_IRQ_MASK_FRAME_ERR
Definition vsf_template_usart.h:628
VSF_USART_IRQ_MASK_CTS
#define VSF_USART_IRQ_MASK_CTS
Definition vsf_template_usart.h:590
VSF_USART_5_BIT_LENGTH
#define VSF_USART_5_BIT_LENGTH
Definition vsf_template_usart.h:349
vsf_usart_rxfifo_get_data_count
uint_fast32_t vsf_usart_rxfifo_get_data_count(vsf_usart_t *usart_ptr)
Get the number of data currently received in the USART receive FIFO.
Definition usart_common.c:129
VSF_USART_9_BIT_LENGTH
#define VSF_USART_9_BIT_LENGTH
Definition vsf_template_usart.h:355
vsf_usart_rxfifo_read
uint_fast32_t vsf_usart_rxfifo_read(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count)
Try to read the maximum length of data from the USART receive FIFO.
VSF_USART_CTRL_SET_BREAK
#define VSF_USART_CTRL_SET_BREAK
Definition vsf_template_usart.h:884
VSF_USART_1_5_STOPBIT
#define VSF_USART_1_5_STOPBIT
Definition vsf_template_usart.h:335
VSF_USART_FORCE_1_PARITY
#define VSF_USART_FORCE_1_PARITY
Definition vsf_template_usart.h:325
VSF_USART_CTRL_SEND_BREAK
#define VSF_USART_CTRL_SEND_BREAK
Definition vsf_template_usart.h:873
vsf_usart_enable
fsm_rt_t vsf_usart_enable(vsf_usart_t *usart_ptr)
Enable a USART instance.
Definition usart_common.c:66
VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL
#define VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL
Definition vsf_template_usart.h:432
VSF_USART_TX_FIFO_THRESHOLD_EMPTY
#define VSF_USART_TX_FIFO_THRESHOLD_EMPTY
Definition vsf_template_usart.h:415
VSF_USART_TX_DISABLE
#define VSF_USART_TX_DISABLE
Definition vsf_template_usart.h:382
vsf_usart_isr_t
struct vsf_usart_isr_t vsf_usart_isr_t
USART interrupt configuration structure Contains all necessary information for configuring USART inte...
VSF_USART_RX_FIFO_THRESHOLD_FULL
#define VSF_USART_RX_FIFO_THRESHOLD_FULL
Definition vsf_template_usart.h:434
vsf_usart_irq_clear
vsf_usart_irq_mask_t vsf_usart_irq_clear(vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask)
Clear interrupt flags of USART instance and return previous state.
Definition usart_common.c:102
VSF_USART_10_BIT_LENGTH
#define VSF_USART_10_BIT_LENGTH
Definition vsf_template_usart.h:357
vsf_usart_request_tx
vsf_err_t vsf_usart_request_tx(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count)
Request a DMA transmit operation through the USART.
Definition usart_common.c:174
VSF_USART_RTS_CTS_HWCONTROL
#define VSF_USART_RTS_CTS_HWCONTROL
Definition vsf_template_usart.h:371
vsf_usart_txfifo_get_free_count
uint_fast32_t vsf_usart_txfifo_get_free_count(vsf_usart_t *usart_ptr)
Get the maximum number of data that can be sent through the USART send FIFO.
Definition usart_common.c:147
VSF_USART_IRQ_MASK_RX_OVERFLOW_ERR
#define VSF_USART_IRQ_MASK_RX_OVERFLOW_ERR
Definition vsf_template_usart.h:662
vsf_usart_cancel_tx
vsf_err_t vsf_usart_cancel_tx(vsf_usart_t *usart_ptr)
Cancel an ongoing USART transmit operation.
Definition usart_common.c:192
vsf_usart_irq_mask_t
vsf_usart_irq_mask_t
USART interrupt mask definitions These interrupts provide status and event notifications for USART op...
Definition vsf_template_usart.h:555
VSF_USART_IRQ_MASK_TX_CPL
@ VSF_USART_IRQ_MASK_TX_CPL
TX complete(for request_tx API, data is written to TX FIFO) interrupt.
Definition vsf_template_usart.h:556
VSF_USART_IRQ_MASK_TX
@ VSF_USART_IRQ_MASK_TX
TX FIFO threshold interrupt.
Definition vsf_template_usart.h:558
VSF_USART_IRQ_MASK_RX
@ VSF_USART_IRQ_MASK_RX
RX FIFO threshold interrupt.
Definition vsf_template_usart.h:559
VSF_USART_IRQ_MASK_RX_CPL
@ VSF_USART_IRQ_MASK_RX_CPL
RX complete(for request_rx API, data is read from RX FIFO) interrupt.
Definition vsf_template_usart.h:557
vsf_usart_fini
void vsf_usart_fini(vsf_usart_t *usart_ptr)
Finalize a USART instance.
Definition usart_common.c:47
VSF_USART_RTS_HWCONTROL
#define VSF_USART_RTS_HWCONTROL
Definition vsf_template_usart.h:367
VSF_USART_APIS
#define VSF_USART_APIS(__prefix_name)
USART API template, used to generate USART type, specific prefix function declarations,...
Definition vsf_template_usart.h:228
vsf_usart_irq_enable
void vsf_usart_irq_enable(vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask)
Enable interrupt masks of USART instance.
Definition usart_common.c:84
vsf_usart_irq_disable
void vsf_usart_irq_disable(vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask)
Disable interrupt masks of USART instance.
Definition usart_common.c:93
VSF_USART_IRQ_MASK_BREAK_ERR
#define VSF_USART_IRQ_MASK_BREAK_ERR
Definition vsf_template_usart.h:630
VSF_USART_FORCE_0_PARITY
#define VSF_USART_FORCE_0_PARITY
Definition vsf_template_usart.h:323
vsf_usart_status_t
struct vsf_usart_status_t vsf_usart_status_t
USART status information structure Contains the current status of USART operations and FIFO threshold...
VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY
#define VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY
Definition vsf_template_usart.h:430
vsf_usart_get_rx_count
int_fast32_t vsf_usart_get_rx_count(vsf_usart_t *usart_ptr)
Get the number of bytes received in the current or last USART operation.
Definition usart_common.c:201
VSF_USART_0_5_STOPBIT
#define VSF_USART_0_5_STOPBIT
Definition vsf_template_usart.h:337
vsf_usart_init
vsf_err_t vsf_usart_init(vsf_usart_t *usart_ptr, vsf_usart_cfg_t *cfg_ptr)
Initialize a USART instance.
Definition usart_common.c:38
VSF_USART_SYNC_CLOCK_ENABLE
#define VSF_USART_SYNC_CLOCK_ENABLE
Definition vsf_template_usart.h:393
VSF_USART_IRQ_MASK_PARITY_ERR
#define VSF_USART_IRQ_MASK_PARITY_ERR
Definition vsf_template_usart.h:646
VSF_USART_2_STOPBIT
#define VSF_USART_2_STOPBIT
Definition vsf_template_usart.h:339
vsf_usart_capability
vsf_usart_capability_t vsf_usart_capability(vsf_usart_t *usart_ptr)
Get the capability of USART instance.
Definition usart_common.c:120
vsf_usart_ctrl_t
vsf_usart_ctrl_t
USART control commands Defines the available control operations for USART instances.
Definition vsf_template_usart.h:863
__VSF_USART_CTRL_DUMMY_MASK
@ __VSF_USART_CTRL_DUMMY_MASK
Definition vsf_template_usart.h:916
vsf_usart_ctrl
vsf_err_t vsf_usart_ctrl(vsf_usart_t *usart_ptr, vsf_usart_ctrl_t ctrl, void *param)
Execute a control command on the USART instance.
Definition usart_common.c:219
vsf_usart_get_configuration
vsf_err_t vsf_usart_get_configuration(vsf_usart_t *usart_ptr, vsf_usart_cfg_t *cfg_ptr)
Get current configuration of a USART instance.
Definition usart_common.c:56
VSF_USART_IRQ_MASK_TX_IDLE
#define VSF_USART_IRQ_MASK_TX_IDLE
Definition vsf_template_usart.h:685
VSF_USART_CTRL_CLEAR_BREAK
#define VSF_USART_CTRL_CLEAR_BREAK
Definition vsf_template_usart.h:895
VSF_USART_RX_DISABLE
#define VSF_USART_RX_DISABLE
Definition vsf_template_usart.h:384
VSF_USART_IRQ_MASK_ERR
@ VSF_USART_IRQ_MASK_ERR
Combined error interrupt mask.
Definition vsf_template_usart.h:727
VSF_USART_IRQ_MASK_TX_FIFO_THRESHOLD
@ VSF_USART_IRQ_MASK_TX_FIFO_THRESHOLD
TX FIFO threshold interrupt mask.
Definition vsf_template_usart.h:723
VSF_USART_IRQ_ALL_BITS_MASK
@ VSF_USART_IRQ_ALL_BITS_MASK
All supported interrupt mask bits.
Definition vsf_template_usart.h:737
VSF_USART_IRQ_MASK_RX_FIFO_THRESHOLD
@ VSF_USART_IRQ_MASK_RX_FIFO_THRESHOLD
RX FIFO threshold interrupt mask.
Definition vsf_template_usart.h:724
VSF_USART_IRQ_MASK_RX_IDLE
#define VSF_USART_IRQ_MASK_RX_IDLE
Definition vsf_template_usart.h:698
vsf_usart_get_tx_count
int_fast32_t vsf_usart_get_tx_count(vsf_usart_t *usart_ptr)
Get the number of bytes transmitted in the current or last USART operation.
Definition usart_common.c:210
VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
#define VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
Definition vsf_template_usart.h:417
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)
USART interrupt handler function type declaration.
Definition vsf_template_usart.h:817
VSF_USART_BIT_LENGTH_MASK
@ VSF_USART_BIT_LENGTH_MASK
Definition vsf_template_usart.h:481
VSF_USART_TX_FIFO_THRESHOLD_MASK
@ VSF_USART_TX_FIFO_THRESHOLD_MASK
Definition vsf_template_usart.h:490
VSF_USART_PARITY_MASK
@ VSF_USART_PARITY_MASK
Definition vsf_template_usart.h:466
VSF_USART_MODE_ALL_BITS_MASK
@ VSF_USART_MODE_ALL_BITS_MASK
Definition vsf_template_usart.h:520
VSF_USART_HALF_DUPLEX_MASK
@ VSF_USART_HALF_DUPLEX_MASK
Definition vsf_template_usart.h:517
VSF_USART_HWCONTROL_MASK
@ VSF_USART_HWCONTROL_MASK
Definition vsf_template_usart.h:502
VSF_USART_RX_MASK
@ VSF_USART_RX_MASK
Definition vsf_template_usart.h:511
VSF_USART_STOPBIT_MASK
@ VSF_USART_STOPBIT_MASK
Definition vsf_template_usart.h:474
VSF_USART_RX_FIFO_THRESHOLD_MASK
@ VSF_USART_RX_FIFO_THRESHOLD_MASK
Definition vsf_template_usart.h:496
VSF_USART_SYNC_CLOCK_MASK
@ VSF_USART_SYNC_CLOCK_MASK
Definition vsf_template_usart.h:514
VSF_USART_TX_MASK
@ VSF_USART_TX_MASK
Definition vsf_template_usart.h:508
VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL
#define VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL
Definition vsf_template_usart.h:419
VSF_USART_IRQ_MASK_NOISE_ERR
#define VSF_USART_IRQ_MASK_NOISE_ERR
vsf_usart_txfifo_write
uint_fast32_t vsf_usart_txfifo_write(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count)
Try to write the maximum length of data to the USART send FIFO.
VSF_USART_6_BIT_LENGTH
#define VSF_USART_6_BIT_LENGTH
Definition vsf_template_usart.h:351
VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR
#define VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR
Definition vsf_template_usart.h:674
Generated from commit: vsfteam/vsf@3f091ef