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_status_t, usart, status, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
238 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast32_t, usart, rxfifo_get_data_count, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
239 __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) \
240 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast32_t, usart, txfifo_get_free_count, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
241 __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) \
242 __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) \
243 __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) \
244 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, cancel_rx, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
245 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, usart, cancel_tx, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
246 __VSF_HAL_TEMPLATE_API(__prefix_name, int_fast32_t, usart, get_rx_count, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
247 __VSF_HAL_TEMPLATE_API(__prefix_name, int_fast32_t, usart, get_tx_count, VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
248 __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)
249
250#define VSF_USART_ADDITIONAL_APIS(__prefix_name) \
251 static inline vsf_err_t VSF_MCONNECT(__prefix_name, _send_break) \
252 (VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
253 { \
254 return VSF_MCONNECT(__prefix_name, _ctrl)(usart_ptr, \
255 VSF_USART_CTRL_SEND_BREAK, NULL); \
256 } \
257 static inline vsf_err_t VSF_MCONNECT(__prefix_name, _set_break) \
258 (VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
259 { \
260 vsf_usart_capability_t cap = \
261 VSF_MCONNECT(__prefix_name, _capability)(usart_ptr); \
262 VSF_HAL_ASSERT(cap.support_set_and_clear_break); \
263 return VSF_MCONNECT(__prefix_name, _ctrl)(usart_ptr, \
264 VSF_USART_CTRL_SET_BREAK, NULL); \
265 } \
266 static inline vsf_err_t VSF_MCONNECT(__prefix_name, _clear_break) \
267 (VSF_MCONNECT(__prefix_name, _t) *usart_ptr) \
268 { \
269 vsf_usart_capability_t cap = \
270 VSF_MCONNECT(__prefix_name, _capability)(usart_ptr); \
271 VSF_HAL_ASSERT(cap.support_set_and_clear_break); \
272 return VSF_MCONNECT(__prefix_name, _ctrl)(usart_ptr, \
273 VSF_USART_CTRL_CLEAR_BREAK, NULL); \
274 }
275
276/*============================ TYPES =========================================*/
277
278#if VSF_USART_CFG_REIMPLEMENT_TYPE_MODE == DISABLED
302typedef enum vsf_usart_mode_t {
309 VSF_USART_NO_PARITY = (0x0ul << 0),
310 VSF_USART_EVEN_PARITY = (0x1ul << 0),
311 VSF_USART_ODD_PARITY = (0x2ul << 0),
312 VSF_USART_FORCE_0_PARITY = (0x3ul << 0),
313 VSF_USART_FORCE_1_PARITY = (0x4ul << 0),
314
321 VSF_USART_1_STOPBIT = (0x0ul << 3),
322 VSF_USART_1_5_STOPBIT = (0x1ul << 3),
323 VSF_USART_0_5_STOPBIT = (0x2ul << 3),
324 VSF_USART_2_STOPBIT = (0x3ul << 3),
325
332 VSF_USART_5_BIT_LENGTH = (0x0ul << 5),
333 VSF_USART_6_BIT_LENGTH = (0x1ul << 5),
334 VSF_USART_7_BIT_LENGTH = (0x2ul << 5),
335 VSF_USART_8_BIT_LENGTH = (0x3ul << 5),
336 VSF_USART_9_BIT_LENGTH = (0x4ul << 5),
337 VSF_USART_10_BIT_LENGTH = (0x5ul << 5),
338
345 VSF_USART_NO_HWCONTROL = (0x0ul << 8),
346 VSF_USART_RTS_HWCONTROL = (0x1ul << 8),
347 VSF_USART_CTS_HWCONTROL = (0x2ul << 8),
348 VSF_USART_RTS_CTS_HWCONTROL = (0x3ul << 8),
349
356 VSF_USART_TX_ENABLE = (0x0ul << 9),
357 VSF_USART_TX_DISABLE = (0x1ul << 9),
358 VSF_USART_RX_ENABLE = (0x0ul << 10),
359 VSF_USART_RX_DISABLE = (0x1ul << 10),
360
367 VSF_USART_SYNC_CLOCK_ENABLE = (0x0ul << 11),
368 VSF_USART_SYNC_CLOCK_DISABLE = (0x1ul << 11),
369
376 VSF_USART_HALF_DUPLEX_DISABLE = (0x0ul << 14),
377 VSF_USART_HALF_DUPLEX_ENABLE = (0x1ul << 14),
378
387 VSF_USART_TX_FIFO_THRESHOLD_EMPTY = (0x0ul << 15),
388 VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY = (0x1ul << 15),
389 VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL = (0x2ul << 15),
390
399 VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY = (0x0ul << 17),
400 VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL = (0x1ul << 17),
401 VSF_USART_RX_FIFO_THRESHOLD_FULL = (0x2ul << 17),
402} vsf_usart_mode_t;
403#endif
404
405enum {
406#ifndef VSF_USART_PARITY_MASK
407 VSF_USART_PARITY_MASK = VSF_USART_NO_PARITY
408 | VSF_USART_EVEN_PARITY
409 | VSF_USART_ODD_PARITY
410 | VSF_USART_FORCE_0_PARITY
411 | VSF_USART_FORCE_1_PARITY,
412#endif
413
414#ifndef VSF_USART_STOPBIT_MASK
415 VSF_USART_STOPBIT_MASK = VSF_USART_1_STOPBIT
416 | VSF_USART_1_5_STOPBIT
417 | VSF_USART_0_5_STOPBIT
418 | VSF_USART_2_STOPBIT,
419#endif
420
421#ifndef VSF_USART_BIT_LENGTH_MASK
422 VSF_USART_BIT_LENGTH_MASK = VSF_USART_5_BIT_LENGTH
423 | VSF_USART_6_BIT_LENGTH
424 | VSF_USART_7_BIT_LENGTH
425 | VSF_USART_8_BIT_LENGTH
426 | VSF_USART_9_BIT_LENGTH
427 | VSF_USART_10_BIT_LENGTH,
428#endif
429
430#ifndef VSF_USART_TX_FIFO_THRESHOLD_MASK
431 VSF_USART_TX_FIFO_THRESHOLD_MASK = VSF_USART_TX_FIFO_THRESHOLD_EMPTY
432 | VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
433 | VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL,
434#endif
435
436#ifndef VSF_USART_RX_FIFO_THRESHOLD_MASK
437 VSF_USART_RX_FIFO_THRESHOLD_MASK = VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY
438 | VSF_USART_RX_FIFO_THRESHOLD_FULL
439 | VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL,
440#endif
441
442#ifndef VSF_USART_HWCONTROL_MASK
443 VSF_USART_HWCONTROL_MASK = VSF_USART_NO_HWCONTROL
444 | VSF_USART_RTS_HWCONTROL
445 | VSF_USART_CTS_HWCONTROL
446 | VSF_USART_RTS_CTS_HWCONTROL,
447#endif
448
449 VSF_USART_TX_MASK = VSF_USART_TX_ENABLE
450 | VSF_USART_TX_DISABLE,
451
452 VSF_USART_RX_MASK = VSF_USART_RX_ENABLE
453 | VSF_USART_RX_DISABLE,
454
455 VSF_USART_SYNC_CLOCK_MASK = VSF_USART_SYNC_CLOCK_ENABLE
456 | VSF_USART_SYNC_CLOCK_DISABLE,
457
458 VSF_USART_HALF_DUPLEX_MASK = VSF_USART_HALF_DUPLEX_DISABLE
459 | VSF_USART_HALF_DUPLEX_ENABLE,
460
461 VSF_USART_MODE_ALL_BITS_MASK = VSF_USART_PARITY_MASK
462 | VSF_USART_STOPBIT_MASK
463 | VSF_USART_BIT_LENGTH_MASK
464 | VSF_USART_HWCONTROL_MASK
465 | VSF_USART_TX_FIFO_THRESHOLD_MASK
466 | VSF_USART_RX_FIFO_THRESHOLD_MASK
467 | VSF_USART_TX_MASK
468 | VSF_USART_RX_MASK
469 | VSF_USART_SYNC_CLOCK_MASK
470 | VSF_USART_HALF_DUPLEX_MASK
471#ifdef VSF_USART_SYNC_CLOCK_LAST_BIT_MASK
472 | VSF_USART_SYNC_CLOCK_LAST_BIT_MASK
473#endif
474
475#ifdef VSF_USART_IRDA_PRESCALER_MASK
476 | VSF_USART_IRDA_PRESCALER_MASK
477#endif
478#ifdef VSF_USART_IRDA_MASK
479 | VSF_USART_IRDA_MASK
480#endif
481
482#ifdef VSF_USART_SMARTCARD_MASK
483 | VSF_USART_SMARTCARD_MASK
484#endif
485};
486
487#if VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
496typedef enum vsf_usart_irq_mask_t {
497 VSF_USART_IRQ_MASK_TX_CPL = (0x1ul << 0),
498 VSF_USART_IRQ_MASK_RX_CPL = (0x1ul << 1),
499 VSF_USART_IRQ_MASK_TX = (0x1ul << 2),
500 VSF_USART_IRQ_MASK_RX = (0x1ul << 3),
501 VSF_USART_IRQ_MASK_RX_TIMEOUT = (0x1ul << 4),
502 VSF_USART_IRQ_MASK_CTS = (0x1ul << 5),
503 VSF_USART_IRQ_MASK_FRAME_ERR = (0x1ul << 6),
504 VSF_USART_IRQ_MASK_PARITY_ERR = (0x1ul << 7),
505 VSF_USART_IRQ_MASK_BREAK_ERR = (0x1ul << 8),
506 VSF_USART_IRQ_MASK_RX_OVERFLOW_ERR = (0x1ul << 9),
507
508
517 VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR = (0x1ul << 10),
518# define VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR
519
528 VSF_USART_IRQ_MASK_TX_IDLE = (0x1ul << 11),
529# define VSF_USART_IRQ_MASK_TX_IDLE VSF_USART_IRQ_MASK_TX_IDLE
530
541 VSF_USART_IRQ_MASK_RX_IDLE = (0x1ul << 12),
542# define VSF_USART_IRQ_MASK_RX_IDLE VSF_USART_IRQ_MASK_RX_IDLE
543
552 VSF_USART_IRQ_MASK_NOISE_ERR = (0x1UL << 13)
553# define VSF_USART_IRQ_MASK_NOISE_ERR VSF_USART_IRQ_MASK_NOISE_ERR
554} vsf_usart_irq_mask_t;
555#endif
556
563enum {
564#ifndef VSF_USART_IRQ_MASK_RX_IDLE
565 VSF_USART_IRQ_MASK_RX_IDLE = VSF_USART_IRQ_MASK_RX_TIMEOUT,
566#endif
567 VSF_USART_IRQ_MASK_TX_FIFO_THRESHOLD = VSF_USART_IRQ_MASK_TX,
568 VSF_USART_IRQ_MASK_RX_FIFO_THRESHOLD = VSF_USART_IRQ_MASK_RX,
569
570#ifndef VSF_USART_IRQ_MASK_ERR
571 VSF_USART_IRQ_MASK_ERR = VSF_USART_IRQ_MASK_FRAME_ERR
572 | VSF_USART_IRQ_MASK_PARITY_ERR
573 | VSF_USART_IRQ_MASK_BREAK_ERR
574# ifdef VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR
575 | VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR
576# endif
577 | VSF_USART_IRQ_MASK_RX_OVERFLOW_ERR,
578#endif
579
580#ifndef VSF_USART_IRQ_ALL_BITS_MASK
581 VSF_USART_IRQ_ALL_BITS_MASK = VSF_USART_IRQ_MASK_TX
582 | VSF_USART_IRQ_MASK_RX
583 | VSF_USART_IRQ_MASK_RX_TIMEOUT
584#ifdef VSF_USART_IRQ_MASK_RX_IDLE
585 | VSF_USART_IRQ_MASK_RX_IDLE
586#endif
587#ifdef VSF_USART_IRQ_MASK_TX_IDLE
588 | VSF_USART_IRQ_MASK_TX_IDLE
589#endif
590 | VSF_USART_IRQ_MASK_CTS
591 | VSF_USART_IRQ_MASK_TX_CPL
592 | VSF_USART_IRQ_MASK_RX_CPL
593 | VSF_USART_IRQ_MASK_ERR,
594# ifdef VSF_USART_IRQ_MASK_TX_HALF_CPL
595 | VSF_USART_IRQ_MASK_TX_HALF_CPL
596# endif
597# ifdef VSF_USART_IRQ_MASK_RX_HALF_CPL
598 | VSF_USART_IRQ_MASK_RX_HALF_CPL
599# endif
600# ifdef VSF_USART_IRQ_MASK_CANCEL_TX_CPL
601 | VSF_USART_IRQ_MASK_CANCEL_TX_CPL
602# endif
603# ifdef VSF_USART_IRQ_MASK_CANCEL_RX_CPL
604 | VSF_USART_IRQ_MASK_CANCEL_RX_CPL
605# endif
606#endif
607};
608
609#if VSF_USART_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
616typedef struct vsf_usart_t vsf_usart_t;
617
661typedef void vsf_usart_isr_handler_t(void *target_ptr,
662 vsf_usart_t *usart_ptr,
663 vsf_usart_irq_mask_t irq_mask);
664
673typedef struct vsf_usart_isr_t {
674 vsf_usart_isr_handler_t *handler_fn;
675 void *target_ptr;
676 vsf_arch_prio_t prio;
677} vsf_usart_isr_t;
678
687typedef struct vsf_usart_cfg_t {
688 uint32_t mode;
689 uint32_t baudrate;
690 uint32_t rx_timeout;
691# ifdef VSF_USART_IRQ_MASK_RX_IDLE
692 uint32_t rx_idle_cnt;
693# endif
694 vsf_usart_isr_t isr;
695} vsf_usart_cfg_t;
696#endif
697
698#if VSF_USART_CFG_REIMPLEMENT_TYPE_CTRL == DISABLED
707typedef enum vsf_usart_ctrl_t {
716 VSF_USART_CTRL_SEND_BREAK = (0x01ul << 0),
717# define VSF_USART_CTRL_SEND_BREAK VSF_USART_CTRL_SEND_BREAK
718
727 VSF_USART_CTRL_SET_BREAK = (0x01ul << 1),
728# define VSF_USART_CTRL_SET_BREAK VSF_USART_CTRL_SET_BREAK
729
738 VSF_USART_CTRL_CLEAR_BREAK = (0x01ul << 2),
739# define VSF_USART_CTRL_CLEAR_BREAK VSF_USART_CTRL_CLEAR_BREAK
740
741 /*
742 VSF_USART_CTRL_REQUEST_RX_RESUME = (0x1ul << 3),
743 #define VSF_USART_CTRL_REQUEST_RX_RESUME VSF_USART_CTRL_REQUEST_RX_RESUME
744 VSF_USART_CTRL_REQUEST_TX_RESUME = (0x1ul << 4),
745 #define VSF_USART_CTRL_REQUEST_TX_RESUME VSF_USART_CTRL_REQUEST_TX_RESUME
746
747 VSF_USART_CTRL_REQUEST_RX_PAUSE = (0x1ul << 5),
748 #define VSF_USART_CTRL_REQUEST_RX_PAUSE VSF_USART_CTRL_REQUEST_RX_PAUSE
749 VSF_USART_CTRL_REQUEST_TX_PAUSE = (0x1ul << 6),
750 #define VSF_USART_CTRL_REQUEST_TX_PAUSE VSF_USART_CTRL_REQUEST_TX_PAUSE
751
752 VSF_USART_CTRL_HALF_DUPLEX_ENABLE_TRANSMITTER = (0x1ul << 7),
753 #define VSF_USART_CTRL_HALF_DUPLEX_ENABLE_TRANSMITTER VSF_USART_CTRL_HALF_DUPLEX_ENABLE_TRANSMITTER
754
755 VSF_USART_CTRL_HALF_DUPLEX_ENABLE_RECEIVER = (0x1ul << 8),
756 #define VSF_USART_CTRL_HALF_DUPLEX_ENABLE_RECEIVER VSF_USART_CTRL_HALF_DUPLEX_ENABLE_RECEIVER
757 */
758
759 // Ensure compilation passes when there are no commands
760 __VSF_USART_CTRL_DUMMY_MASK = (0x1ul << 3),
761} vsf_usart_ctrl_t;
762#endif
763
772#if VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED
773typedef struct vsf_usart_status_t {
774 union {
775 inherit(vsf_peripheral_status_t)
776 uint32_t value;
777 struct {
778 uint32_t is_busy : 1;
779 uint32_t is_tx_busy : 1;
780 uint32_t is_rx_busy : 1;
781 uint32_t tx_fifo_thresh : 8;
782 uint32_t rx_fifo_thresh : 8;
783 };
784 };
785} vsf_usart_status_t;
786#endif
787
796#if VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
797typedef struct vsf_usart_capability_t {
798#if VSF_USART_CFG_INHERIT_HAL_CAPABILITY == ENABLED
799 inherit(vsf_peripheral_capability_t)
800#endif
801 vsf_usart_irq_mask_t irq_mask;
802
803 uint32_t max_baudrate;
804 uint32_t min_baudrate;
805
806 uint8_t txfifo_depth;
807 uint8_t rxfifo_depth;
808
809 uint8_t max_data_bits;
810 uint8_t min_data_bits;
811
812 uint8_t support_rx_timeout : 1;
813 uint8_t support_send_break : 1;
814 uint8_t support_set_and_clear_break : 1;
815 uint8_t support_sync_clock : 1;
816# ifdef VSF_USART_IRQ_MASK_TX_IDLE
817 uint8_t support_tx_idle : 1;
818# endif
819# ifdef VSF_USART_IRQ_MASK_RX_IDLE
820 uint8_t support_rx_idle : 1;
821# endif
822} vsf_usart_capability_t;
823#endif
832typedef struct vsf_usart_op_t {
834#undef __VSF_HAL_TEMPLATE_API
835#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
837
838 VSF_USART_APIS(vsf_usart)
839} vsf_usart_op_t;
840
841#if VSF_USART_CFG_MULTI_CLASS == ENABLED
850struct vsf_usart_t {
851 const vsf_usart_op_t * op;
852};
853#endif
854
855/*============================ PROTOTYPES ====================================*/
856
874extern vsf_err_t vsf_usart_init(vsf_usart_t *usart_ptr, vsf_usart_cfg_t *cfg_ptr);
875
887extern void vsf_usart_fini(vsf_usart_t *usart_ptr);
888
906extern vsf_err_t vsf_usart_get_configuration(vsf_usart_t *usart_ptr, vsf_usart_cfg_t *cfg_ptr);
907
919extern fsm_rt_t vsf_usart_enable(vsf_usart_t *usart_ptr);
920
932extern fsm_rt_t vsf_usart_disable(vsf_usart_t *usart_ptr);
933
949extern void vsf_usart_irq_enable(vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask);
950
964extern void vsf_usart_irq_disable(vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask);
965
977extern vsf_usart_status_t vsf_usart_status(vsf_usart_t *usart_ptr);
978
990extern vsf_usart_capability_t vsf_usart_capability(vsf_usart_t *usart_ptr);
991
1003extern uint_fast32_t vsf_usart_rxfifo_get_data_count(vsf_usart_t *usart_ptr);
1004
1020extern uint_fast32_t vsf_usart_rxfifo_read(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count);
1021
1033extern uint_fast32_t vsf_usart_txfifo_get_free_count(vsf_usart_t *usart_ptr);
1034
1050extern uint_fast32_t vsf_usart_txfifo_write(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count);
1051
1069extern vsf_err_t vsf_usart_request_rx(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count);
1070
1088extern vsf_err_t vsf_usart_request_tx(vsf_usart_t *usart_ptr, void *buffer_ptr, uint_fast32_t count);
1089
1101extern vsf_err_t vsf_usart_cancel_rx(vsf_usart_t *usart_ptr);
1102
1114extern vsf_err_t vsf_usart_cancel_tx(vsf_usart_t *usart_ptr);
1115
1131extern int_fast32_t vsf_usart_get_rx_count(vsf_usart_t *usart_ptr);
1132
1148extern int_fast32_t vsf_usart_get_tx_count(vsf_usart_t *usart_ptr);
1149
1167extern vsf_err_t vsf_usart_ctrl(vsf_usart_t *usart_ptr, vsf_usart_ctrl_t ctrl, void *param);
1168
1169/*============================ INLINE FUNCTIONS ==============================*/
1170
1171#if VSF_USART_CFG_REIMPLEMENT_MODE_TO_DATA_BITS == DISABLED
1182static inline uint8_t vsf_usart_mode_to_data_bits(vsf_usart_mode_t mode)
1183{
1184 switch (mode & VSF_USART_BIT_LENGTH_MASK) {
1185 case VSF_USART_5_BIT_LENGTH:
1186 return 5;
1187 case VSF_USART_6_BIT_LENGTH:
1188 return 6;
1189 case VSF_USART_7_BIT_LENGTH:
1190 return 7;
1191 case VSF_USART_8_BIT_LENGTH:
1192 return 8;
1193 case VSF_USART_9_BIT_LENGTH:
1194 return 9;
1195 case VSF_USART_10_BIT_LENGTH:
1196 return 10;
1197 default:
1198 return 0;
1199 }
1200}
1201#endif
1202
1215static inline vsf_err_t vsf_usart_send_break(vsf_usart_t *usart_ptr)
1216{
1217 vsf_usart_capability_t cap = vsf_usart_capability(usart_ptr);
1218 VSF_HAL_ASSERT(cap.support_send_break);
1219
1220 return vsf_usart_ctrl(usart_ptr, VSF_USART_CTRL_SEND_BREAK, NULL);
1221}
1222
1234static inline vsf_err_t vsf_usart_set_break(vsf_usart_t *usart_ptr)
1235{
1236 vsf_usart_capability_t cap = vsf_usart_capability(usart_ptr);
1237 VSF_HAL_ASSERT(cap.support_set_and_clear_break);
1238
1239 return vsf_usart_ctrl(usart_ptr, VSF_USART_CTRL_SET_BREAK, NULL);
1240}
1241
1253static inline vsf_err_t vsf_usart_clear_break(vsf_usart_t *usart_ptr)
1254{
1255 vsf_usart_capability_t cap = vsf_usart_capability(usart_ptr);
1256 VSF_HAL_ASSERT(cap.support_set_and_clear_break);
1257
1258 return vsf_usart_ctrl(usart_ptr, VSF_USART_CTRL_CLEAR_BREAK, NULL);
1259}
1260
1261/*============================ MACROFIED FUNCTIONS ===========================*/
1262
1264#if VSF_USART_CFG_FUNCTION_RENAME == ENABLED
1265# define __vsf_usart_t VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_t)
1266# define vsf_usart_init(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_init) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1267# define vsf_usart_fini(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_fini) ((__vsf_usart_t *)(__USART))
1268# define vsf_usart_get_configuration(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_get_configuration) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1269# define vsf_usart_capability(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_capability) ((__vsf_usart_t *)(__USART))
1270# define vsf_usart_enable(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_enable) ((__vsf_usart_t *)(__USART))
1271# define vsf_usart_disable(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_disable) ((__vsf_usart_t *)(__USART))
1272# define vsf_usart_irq_enable(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_irq_enable) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1273# define vsf_usart_irq_disable(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_irq_disable) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1274# define vsf_usart_status(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_status) ((__vsf_usart_t *)(__USART))
1275# 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__)
1276# define vsf_usart_rxfifo_read(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_rxfifo_read) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1277# 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__)
1278# define vsf_usart_txfifo_write(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_txfifo_write) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1279# define vsf_usart_request_rx(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_request_rx) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1280# define vsf_usart_request_tx(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_request_tx) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1281# define vsf_usart_cancel_rx(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_cancel_rx) ((__vsf_usart_t *)(__USART))
1282# define vsf_usart_cancel_tx(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_cancel_tx) ((__vsf_usart_t *)(__USART))
1283# define vsf_usart_get_rx_count(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_get_rx_count) ((__vsf_usart_t *)(__USART))
1284# define vsf_usart_get_tx_count(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_get_tx_count) ((__vsf_usart_t *)(__USART))
1285# define vsf_usart_send_break(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_send_break) ((__vsf_usart_t *)(__USART))
1286# define vsf_usart_set_break(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_set_break) ((__vsf_usart_t *)(__USART))
1287# define vsf_usart_clear_break(__USART) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_clear_break) ((__vsf_usart_t *)(__USART))
1288# define vsf_usart_ctrl(__USART, ...) VSF_MCONNECT(VSF_USART_CFG_PREFIX, _usart_ctrl) ((__vsf_usart_t *)(__USART), ##__VA_ARGS__)
1289#endif
1291
1292/*============================ INCLUDES ======================================*/
1293
1294#ifdef __cplusplus
1295}
1296#endif
1297
1298#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:797
vsf_usart_capability_t::support_tx_idle
uint8_t support_tx_idle
Support TX idle interrupt.
Definition vsf_template_usart.h:817
vsf_usart_capability_t::max_data_bits
uint8_t max_data_bits
Maximum data bits per frame.
Definition vsf_template_usart.h:809
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:814
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:812
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:807
vsf_usart_capability_t::support_rx_idle
uint8_t support_rx_idle
Support RX idle interrupt.
Definition vsf_template_usart.h:820
vsf_usart_capability_t::support_send_break
uint8_t support_send_break
Support send break.
Definition vsf_template_usart.h:813
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:806
vsf_usart_capability_t::min_data_bits
uint8_t min_data_bits
Minimum data bits per frame.
Definition vsf_template_usart.h:810
vsf_usart_capability_t::min_baudrate
uint32_t min_baudrate
Minimum supported baudrate (bps) according to current clock configurations.
Definition vsf_template_usart.h:804
vsf_usart_capability_t::max_baudrate
uint32_t max_baudrate
Maximum supported baudrate (bps) according to current clock configurations.
Definition vsf_template_usart.h:803
vsf_usart_capability_t::support_sync_clock
uint8_t support_sync_clock
Support Synchronous clock.
Definition vsf_template_usart.h:815
vsf_usart_cfg_t
USART configuration structure Contains all parameters needed to initialize and configure a USART inst...
Definition vsf_template_usart.h:687
vsf_usart_cfg_t::mode
uint32_t mode
USART working mode.
Definition vsf_template_usart.h:688
vsf_usart_cfg_t::baudrate
uint32_t baudrate
Baudrate in Hz.
Definition vsf_template_usart.h:689
vsf_usart_cfg_t::rx_timeout
uint32_t rx_timeout
RX timeout in microseconds.
Definition vsf_template_usart.h:690
vsf_usart_cfg_t::rx_idle_cnt
uint32_t rx_idle_cnt
Definition vsf_template_usart.h:692
vsf_usart_cfg_t::isr
vsf_usart_isr_t isr
Interrupt configuration.
Definition vsf_template_usart.h:694
vsf_usart_isr_t
USART interrupt configuration structure Contains all necessary information for configuring USART inte...
Definition vsf_template_usart.h:673
vsf_usart_isr_t::handler_fn
vsf_usart_isr_handler_t * handler_fn
Interrupt handler function pointer.
Definition vsf_template_usart.h:674
vsf_usart_isr_t::prio
vsf_arch_prio_t prio
Interrupt priority.
Definition vsf_template_usart.h:676
vsf_usart_isr_t::target_ptr
void * target_ptr
User target pointer.
Definition vsf_template_usart.h:675
vsf_usart_op_t
USART operation interface structure Contains function pointers for all USART operations.
Definition vsf_template_usart.h:832
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::is_busy
uint32_t is_busy
USART is busy with any operation.
Definition vsf_template_usart.h:778
vsf_usart_status_t::is_tx_busy
uint32_t is_tx_busy
TX is busy transmitting data.
Definition vsf_template_usart.h:779
vsf_usart_status_t::value
uint32_t value
Definition usart.h:284
vsf_usart_status_t::tx_fifo_thresh
uint32_t tx_fifo_thresh
TX FIFO threshold level (0-255)
Definition vsf_template_usart.h:781
vsf_usart_status_t::rx_fifo_thresh
uint32_t rx_fifo_thresh
RX FIFO threshold level (0-255)
Definition vsf_template_usart.h:782
vsf_usart_status_t::is_rx_busy
uint32_t is_rx_busy
RX is busy receiving data.
Definition vsf_template_usart.h:780
vsf_usart_t
USART instance structure Used for USART Multi Class support.
Definition vsf_template_usart.h:850
vsf_usart_t::op
const vsf_usart_op_t * op
Operation functions.
Definition vsf_template_usart.h:851
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_IRQ_MASK_ERR
@ VSF_USART_IRQ_MASK_ERR
Combined error interrupt mask.
Definition vsf_template_usart.h:571
VSF_USART_IRQ_MASK_TX_FIFO_THRESHOLD
@ VSF_USART_IRQ_MASK_TX_FIFO_THRESHOLD
TX FIFO threshold interrupt mask.
Definition vsf_template_usart.h:567
VSF_USART_IRQ_ALL_BITS_MASK
@ VSF_USART_IRQ_ALL_BITS_MASK
All supported interrupt mask bits.
Definition vsf_template_usart.h:581
VSF_USART_IRQ_MASK_RX_FIFO_THRESHOLD
@ VSF_USART_IRQ_MASK_RX_FIFO_THRESHOLD
RX FIFO threshold interrupt mask.
Definition vsf_template_usart.h:568
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:102
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:156
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:174
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:302
VSF_USART_TX_FIFO_THRESHOLD_EMPTY
@ VSF_USART_TX_FIFO_THRESHOLD_EMPTY
USART TX FIFO threshold configuration options Note: Some devices may support additional threshold lev...
Definition vsf_template_usart.h:387
VSF_USART_HALF_DUPLEX_DISABLE
@ VSF_USART_HALF_DUPLEX_DISABLE
USART Half-duplex configuration options.
Definition vsf_template_usart.h:376
VSF_USART_8_BIT_LENGTH
@ VSF_USART_8_BIT_LENGTH
8-bit data length
Definition vsf_template_usart.h:335
VSF_USART_SYNC_CLOCK_ENABLE
@ VSF_USART_SYNC_CLOCK_ENABLE
USART Synchronous clock configuration options.
Definition vsf_template_usart.h:367
VSF_USART_EVEN_PARITY
@ VSF_USART_EVEN_PARITY
Even parity.
Definition vsf_template_usart.h:310
VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY
@ VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY
USART RX FIFO threshold configuration options Note: Some devices may support additional threshold lev...
Definition vsf_template_usart.h:399
VSF_USART_ODD_PARITY
@ VSF_USART_ODD_PARITY
Odd parity.
Definition vsf_template_usart.h:311
VSF_USART_NO_PARITY
@ VSF_USART_NO_PARITY
USART Parity configuration options.
Definition vsf_template_usart.h:309
VSF_USART_10_BIT_LENGTH
@ VSF_USART_10_BIT_LENGTH
10-bit data length
Definition vsf_template_usart.h:337
VSF_USART_RTS_HWCONTROL
@ VSF_USART_RTS_HWCONTROL
RTS hardware flow control.
Definition vsf_template_usart.h:346
VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL
@ VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL
RX FIFO half full.
Definition vsf_template_usart.h:400
VSF_USART_RX_ENABLE
@ VSF_USART_RX_ENABLE
RX enabled.
Definition vsf_template_usart.h:358
VSF_USART_FORCE_0_PARITY
@ VSF_USART_FORCE_0_PARITY
Force 0 parity.
Definition vsf_template_usart.h:312
VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL
@ VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL
TX FIFO not full.
Definition vsf_template_usart.h:389
VSF_USART_TX_ENABLE
@ VSF_USART_TX_ENABLE
USART TX/RX enable/disable options.
Definition vsf_template_usart.h:356
VSF_USART_9_BIT_LENGTH
@ VSF_USART_9_BIT_LENGTH
9-bit data length
Definition vsf_template_usart.h:336
VSF_USART_7_BIT_LENGTH
@ VSF_USART_7_BIT_LENGTH
7-bit data length
Definition vsf_template_usart.h:334
VSF_USART_1_STOPBIT
@ VSF_USART_1_STOPBIT
USART Stop bit configuration options.
Definition vsf_template_usart.h:321
VSF_USART_FORCE_1_PARITY
@ VSF_USART_FORCE_1_PARITY
Force 1 parity.
Definition vsf_template_usart.h:313
VSF_USART_RX_DISABLE
@ VSF_USART_RX_DISABLE
RX disabled.
Definition vsf_template_usart.h:359
VSF_USART_2_STOPBIT
@ VSF_USART_2_STOPBIT
2 stop bits
Definition vsf_template_usart.h:324
VSF_USART_CTS_HWCONTROL
@ VSF_USART_CTS_HWCONTROL
CTS hardware flow control.
Definition vsf_template_usart.h:347
VSF_USART_5_BIT_LENGTH
@ VSF_USART_5_BIT_LENGTH
USART Data bit length configuration options.
Definition vsf_template_usart.h:332
VSF_USART_SYNC_CLOCK_DISABLE
@ VSF_USART_SYNC_CLOCK_DISABLE
Sync clock disabled.
Definition vsf_template_usart.h:368
VSF_USART_RTS_CTS_HWCONTROL
@ VSF_USART_RTS_CTS_HWCONTROL
RTS/CTS hardware flow control.
Definition vsf_template_usart.h:348
VSF_USART_HALF_DUPLEX_ENABLE
@ VSF_USART_HALF_DUPLEX_ENABLE
Half-duplex enabled.
Definition vsf_template_usart.h:377
VSF_USART_TX_DISABLE
@ VSF_USART_TX_DISABLE
TX disabled.
Definition vsf_template_usart.h:357
VSF_USART_RX_FIFO_THRESHOLD_FULL
@ VSF_USART_RX_FIFO_THRESHOLD_FULL
RX FIFO full.
Definition vsf_template_usart.h:401
VSF_USART_6_BIT_LENGTH
@ VSF_USART_6_BIT_LENGTH
6-bit data length
Definition vsf_template_usart.h:333
VSF_USART_0_5_STOPBIT
@ VSF_USART_0_5_STOPBIT
0.5 stop bit
Definition vsf_template_usart.h:323
VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
@ VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
TX FIFO half empty.
Definition vsf_template_usart.h:388
VSF_USART_NO_HWCONTROL
@ VSF_USART_NO_HWCONTROL
USART Hardware flow control configuration options.
Definition vsf_template_usart.h:345
VSF_USART_1_5_STOPBIT
@ VSF_USART_1_5_STOPBIT
1.5 stop bits
Definition vsf_template_usart.h:322
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:120
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:728
VSF_USART_BIT_LENGTH_MASK
@ VSF_USART_BIT_LENGTH_MASK
Definition vsf_template_usart.h:422
VSF_USART_TX_FIFO_THRESHOLD_MASK
@ VSF_USART_TX_FIFO_THRESHOLD_MASK
Definition vsf_template_usart.h:431
VSF_USART_PARITY_MASK
@ VSF_USART_PARITY_MASK
Definition vsf_template_usart.h:407
VSF_USART_MODE_ALL_BITS_MASK
@ VSF_USART_MODE_ALL_BITS_MASK
Definition vsf_template_usart.h:461
VSF_USART_HALF_DUPLEX_MASK
@ VSF_USART_HALF_DUPLEX_MASK
Definition vsf_template_usart.h:458
VSF_USART_HWCONTROL_MASK
@ VSF_USART_HWCONTROL_MASK
Definition vsf_template_usart.h:443
VSF_USART_RX_MASK
@ VSF_USART_RX_MASK
Definition vsf_template_usart.h:452
VSF_USART_STOPBIT_MASK
@ VSF_USART_STOPBIT_MASK
Definition vsf_template_usart.h:415
VSF_USART_RX_FIFO_THRESHOLD_MASK
@ VSF_USART_RX_FIFO_THRESHOLD_MASK
Definition vsf_template_usart.h:437
VSF_USART_SYNC_CLOCK_MASK
@ VSF_USART_SYNC_CLOCK_MASK
Definition vsf_template_usart.h:455
VSF_USART_TX_MASK
@ VSF_USART_TX_MASK
Definition vsf_template_usart.h:449
VSF_USART_CTRL_SEND_BREAK
#define VSF_USART_CTRL_SEND_BREAK
Definition vsf_template_usart.h:717
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_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_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:165
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:138
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:183
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:496
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:497
VSF_USART_IRQ_MASK_CTS
@ VSF_USART_IRQ_MASK_CTS
CTS change interrupt.
Definition vsf_template_usart.h:502
VSF_USART_IRQ_MASK_TX
@ VSF_USART_IRQ_MASK_TX
TX FIFO threshold interrupt.
Definition vsf_template_usart.h:499
VSF_USART_IRQ_MASK_BREAK_ERR
@ VSF_USART_IRQ_MASK_BREAK_ERR
Break error interrupt.
Definition vsf_template_usart.h:505
VSF_USART_IRQ_MASK_RX
@ VSF_USART_IRQ_MASK_RX
RX FIFO threshold interrupt.
Definition vsf_template_usart.h:500
VSF_USART_IRQ_MASK_RX_TIMEOUT
@ VSF_USART_IRQ_MASK_RX_TIMEOUT
RX timeout interrupt.
Definition vsf_template_usart.h:501
VSF_USART_IRQ_MASK_RX_OVERFLOW_ERR
@ VSF_USART_IRQ_MASK_RX_OVERFLOW_ERR
RX overflow error interrupt.
Definition vsf_template_usart.h:506
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:498
VSF_USART_IRQ_MASK_PARITY_ERR
@ VSF_USART_IRQ_MASK_PARITY_ERR
Parity error interrupt.
Definition vsf_template_usart.h:504
VSF_USART_IRQ_MASK_FRAME_ERR
@ VSF_USART_IRQ_MASK_FRAME_ERR
Frame error interrupt.
Definition vsf_template_usart.h:503
vsf_usart_fini
void vsf_usart_fini(vsf_usart_t *usart_ptr)
Finalize a USART instance.
Definition usart_common.c:47
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_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_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:192
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_capability
vsf_usart_capability_t vsf_usart_capability(vsf_usart_t *usart_ptr)
Get the capability of USART instance.
Definition usart_common.c:111
vsf_usart_ctrl_t
vsf_usart_ctrl_t
USART control commands Defines the available control operations for USART instances.
Definition vsf_template_usart.h:707
__VSF_USART_CTRL_DUMMY_MASK
@ __VSF_USART_CTRL_DUMMY_MASK
Definition vsf_template_usart.h:760
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:210
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:529
VSF_USART_CTRL_CLEAR_BREAK
#define VSF_USART_CTRL_CLEAR_BREAK
Definition vsf_template_usart.h:739
VSF_USART_IRQ_MASK_RX_IDLE
#define VSF_USART_IRQ_MASK_RX_IDLE
Definition vsf_template_usart.h:542
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:201
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:661
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_IRQ_MASK_TX_OVERFLOW_ERR
#define VSF_USART_IRQ_MASK_TX_OVERFLOW_ERR
Definition vsf_template_usart.h:518
Generated from commit: vsfteam/vsf@74aa6ce