VSF Documented
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 __HAL_DRIVER_NATIONS_N32H76X_N32H78X_USART_H__
19#define __HAL_DRIVER_NATIONS_N32H76X_N32H78X_USART_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "hal/vsf_hal_cfg.h"
24
25#if VSF_HAL_USE_USART == ENABLED
26
27/*\note Refer to template/README.md for usage cases.
28 * For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
29 * For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
30 * For emulated drivers, **** No reimplementation ****.
31 */
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37/*============================ MACROS ========================================*/
38
39// HW
40/*\note hw USART driver can reimplement following types:
41 * To enable reimplementation, please enable macro below:
42 * VSF_USART_CFG_REIMPLEMENT_TYPE_MODE for vsf_usart_mode_t
43 * VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS for vsf_usart_status_t
44 * VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK for vsf_usart_irq_mask_t
45 * VSF_USART_CFG_REIMPLEMENT_TYPE_CTRL for vsf_usart_ctrl_t
46 * VSF_USART_CFG_REIMPLEMENT_TYPE_CFG for vsf_usart_cfg_t
47 * VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_usart_capability_t
48 * Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers.
49 * *** DO NOT reimplement these in emulated drivers. ***
50 */
51
52#define VSF_USART_CFG_REIMPLEMENT_TYPE_MODE ENABLED
53#define VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS ENABLED
54#define VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK ENABLED
55#define VSF_USART_CFG_REIMPLEMENT_TYPE_CTRL ENABLED
56#define VSF_USART_CFG_REIMPLEMENT_TYPE_CFG DISABLED
57#define VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
58// HW end
59
60// TODO: add comments about fifo2req
61
62/*============================ TYPES =========================================*/
63
64// HW/IPCore, not for emulated drivers
65#if VSF_USART_CFG_REIMPLEMENT_TYPE_MODE == ENABLED
66typedef enum vsf_usart_mode_t {
67 // 1..2: TXEN(2)/RXEN(1) in USART_CTRL1
72
73 // 3..4: PCEN(4)/PSEL(3) in USART_CTRL1
75 VSF_USART_ODD_PARITY = (1 << 4) | (1 << 3),
77
78 // 5: WL(5) in USART_CTRL1
81#define VSF_USART_9_BIT_LENGTH VSF_USART_9_BIT_LENGTH
82
83 // 6..7: STPB(5:6) in USART_CTRL2, left shifted by 1
84 VSF_USART_1_STOPBIT = (0 << 5) << 1,
85 VSF_USART_0_5_STOPBIT = (1 << 5) << 1,
86#define VSF_USART_0_5_STOPBIT VSF_USART_0_5_STOPBIT
87 VSF_USART_1_5_STOPBIT = (3 << 5) << 1,
89 VSF_USART_2_STOPBIT = (2 << 5) << 1,
90#define VSF_USART_2_STOPBIT VSF_USART_2_STOPBIT
91
92 // 8: CLKEN(8) in USART_CTRL2
96#define VSF_USART_SYNC_CLOCK_DISABLE VSF_USART_SYNC_CLOCK_DISABLE
97 // 9: CLKPOL(9) in USART_CTRL2
101#define VSF_USART_SYNC_CLOCK_POLARITY_HIGH VSF_USART_SYNC_CLOCK_POLARITY_HIGH
102 // 10: CLKPHA(9) in USART_CTRL2
106#define VSF_USART_SYNC_CLOCK_PHASE_2_EDGE VSF_USART_SYNC_CLOCK_PHASE_2_EDGE
107 // 11: LBCLK(11) in USART_CTRL2
110#define VSF_USART_SYNC_CLOCK_LAST_BIT_ENABLE VSF_USART_SYNC_CLOCK_LAST_BIT_ENABLE
111#define VSF_USART_SYNC_CLOCK_LAST_BIT_DISABLE VSF_USART_SYNC_CLOCK_LAST_BIT_DISABLE
112#define VSF_USART_SYNC_CLOCK_LAST_BIT_MASK VSF_USART_SYNC_CLOCK_LAST_BIT_ENABLE | VSF_USART_SYNC_CLOCK_LAST_BIT_DISABLE
113
114 // 12|14..19: RXFTCFG(5..7)/TXFTCFG(2..4)/EN(0) in USART_FIFO, left shifted by 12
115 VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL = ((7 << 2) | (1 << 0)) << 12,
117 VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY = ((2 << 2) | (1 << 0)) << 12,
118#define VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
119 VSF_USART_TX_FIFO_THRESHOLD_ONE_EIGHTH = ((0 << 2) | (1 << 0)) << 12,
121 VSF_USART_TX_FIFO_THRESHOLD_QUARTER = ((1 << 2) | (1 << 0)) << 12,
122#define VSF_USART_TX_FIFO_THRESHOLD_QUARTER VSF_USART_TX_FIFO_THRESHOLD_QUARTER
123 VSF_USART_TX_FIFO_THRESHOLD_THREE_FOURTH = ((1 << 2) | (1 << 0)) << 12,
125 VSF_USART_TX_FIFO_THRESHOLD_EMPTY = ((5 << 2) | (1 << 0)) << 12,
126#define VSF_USART_TX_FIFO_THRESHOLD_EMPTY VSF_USART_TX_FIFO_THRESHOLD_EMPTY
127
128 VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY = ((7 << 5) | (1 << 0)) << 12,
130 VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL = ((2 << 5) | (1 << 0)) << 12,
131#define VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL
132 VSF_USART_RX_FIFO_THRESHOLD_ONE_EIGHTH = ((0 << 5) | (1 << 0)) << 12,
134 VSF_USART_RX_FIFO_THRESHOLD_QUARTER = ((1 << 5) | (1 << 0)) << 12,
135#define VSF_USART_RX_FIFO_THRESHOLD_QUARTER VSF_USART_RX_FIFO_THRESHOLD_QUARTER
136 VSF_USART_RX_FIFO_THRESHOLD_THREE_FOURTH = ((1 << 5) | (1 << 0)) << 12,
138 VSF_USART_RX_FIFO_THRESHOLD_FULL = ((5 << 5) | (1 << 0)) << 12,
139#define VSF_USART_RX_FIFO_THRESHOLD_FULL VSF_USART_RX_FIFO_THRESHOLD_FULL
140
141#define VSF_USART_TX_FIFO_THRESHOLD_MASK ( VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL\
142 | VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY\
143 | VSF_USART_TX_FIFO_THRESHOLD_EMPTY\
144 | VSF_USART_TX_FIFO_THRESHOLD_ONE_EIGHTH\
145 | VSF_USART_TX_FIFO_THRESHOLD_QUARTER\
146 | VSF_USART_TX_FIFO_THRESHOLD_THREE_FOURTH)
147#define VSF_USART_RX_FIFO_THRESHOLD_MASK ( VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY\
148 | VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL\
149 | VSF_USART_RX_FIFO_THRESHOLD_FULL\
150 | VSF_USART_RX_FIFO_THRESHOLD_ONE_EIGHTH\
151 | VSF_USART_RX_FIFO_THRESHOLD_QUARTER\
152 | VSF_USART_RX_FIFO_THRESHOLD_THREE_FOURTH )
153
154 // 20|22: RTSEN(2)/CTSEN(0) in USART_CTRL3, right shifted by 20
157 VSF_USART_RTS_HWCONTROL = (1 << 2) << 20,
158#define VSF_USART_RTS_HWCONTROL VSF_USART_RTS_HWCONTROL
159 VSF_USART_CTS_HWCONTROL = (1 << 0) << 20,
164
165 // 24: HDMEN(4) in USART_CTRL3, right shifted by 20
167#define VSF_USART_HALF_DUPLEX_ENABLE VSF_USART_HALF_DUPLEX_ENABLE
169#define VSF_USART_HALF_DUPLEX_DISABLE VSF_USART_HALF_DUPLEX_DISABLE
170
171 // more vendor specified modes can be added here
172
173 // 26: OSPM(26) in USART_CTRL1
177 // 27: SWAP(27) in USART_CTRL1
178 VSF_USART_SWAP = (1 << 27),
179#define VSF_USART_SWAP VSF_USART_SWAP
180
181
191
209
214
219
220 // not supported, allocate unused bits: 0|13|21|25|28..31
221 // 28..30
226 // 31
229
237#endif
238
239#if VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
241 // 3: CTSIEN(1) in USART_CTRL3
244
245 // usart request interrupt
246 // TODO: add DMA support
249
250 // 7: TXDE(7) in USART_CTTL1
252
253 // 8: IDLEIEN(8) in USART_CTRL1
256
257 // 9: RXDNEIE(9) in USART_CTRL1
259
260 // 11: TXCIEN(11) in USART_CTRL1
263
264 // usart error interrupt
265 // 12: PEIEN(12) in USART_CTRL1
267
268 // 15|17: RTOIEN(17)/RTOEN(15) in USART_CTRL2
269 VSF_USART_IRQ_MASK_RX_TIMEOUT = (1 << 15) | (1 << 17),
270#define VSF_USART_IRQ_MASK_RX_TIMEOUT VSF_USART_IRQ_MASK_RX_TIMEOUT
271
272 // 18: OREF(13) in USART_STS
274 // 19: OREF(14) in USART_STS
276#define VSF_USART_IRQ_MASK_NOISE_ERR VSF_USART_IRQ_MASK_NOISE_ERR
277 // 20: FEF(15) in USART_STS
281
282 // more vendor specified irq_masks can be added here
283
307#endif
308
309#if VSF_USART_CFG_REIMPLEMENT_TYPE_CTRL == ENABLED
310typedef enum vsf_usart_ctrl_t {
311 // 13: SDBRK in USART_CTRL1
314
316
317 // not supported
321#endif
322
327#if VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS == ENABLED
328typedef struct vsf_usart_status_t {
329 union {
330// bits to be inverted:
331// TXC(is_tx_complete) => is_tx_busy
332#define __VSF_HW_USART_STS_XOR_MASK (1 << 8)
333#define __VSF_HW_USART_STS_MASK 0xF7FF
334 struct {
335 uint32_t is_txfifo_full : 1; // TXFF(0) in USART_STS
336 uint32_t is_rxfifo_full : 1; // RXFF(1) in USART_STS
337 uint32_t is_txfifo_empty : 1; // TXFE(2) in USART_STS
338 uint32_t is_rxfifo_empty : 1; // RXFE(3) in USART_STS
339 uint32_t is_rxfifo_threshold: 1; // RXFT(4) in USART_STS
340 uint32_t is_txfifo_threahold: 1; // TXFT(5) in USART_STS
341 uint32_t is_rx_idle : 1; // IDLE(6) in USART_STS
342 uint32_t txde : 1; // TXDEF(7) in USART_STS
343 uint32_t is_tx_busy : 1; // TXC(8) in USART_STS
344 uint32_t rxdne : 1; // RXDNE(9) in USART_STS
345 uint32_t cts_changed : 1; // CTSF(10) in USART_STS
347#define VSF_USART_STATUS_BREAK_SENT 11
348 uint32_t parity_err : 1; // PEF(12) in USART_STS
349 uint32_t overrun_err : 1; // OREF(13) in USART_STS
350 uint32_t noise_err : 1; // NEF(14) in USART_STS
351 uint32_t frame_err : 1; // FEF(15) in USART_STS
352 uint32_t rx_timeout : 1; // RTOF(16) in USART_STS
355 };
357 };
359#endif
360
365#if VSF_USART_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
367typedef void vsf_usart_isr_handler_t(void *target_ptr,
368 vsf_usart_t *usart_ptr,
370typedef struct vsf_usart_isr_t {
372 void *target_ptr;
375typedef struct vsf_usart_cfg_t {
380
381 // more vendor specified cfg can be added here
383#endif
384
385#if VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
386typedef struct vsf_usart_capability_t {
388
391
394
397
402# ifdef VSF_USART_IRQ_MASK_TX_IDLE
404# endif
405# ifdef VSF_USART_IRQ_MASK_RX_IDLE
407# endif
408
409 // more vendor specified capability can be added here
411#endif
412// HW/IPCore end
413
414/*============================ GLOBAL VARIABLES ==============================*/
415/*============================ PROTOTYPES ====================================*/
416
417#ifdef __cplusplus
418}
419#endif
420
421#endif // VSF_HAL_USE_USART
422#endif // __HAL_DRIVER_NATIONS_N32H76X_N32H78X_USART_H__
423/* EOF */
vsf_usart_mode_t
Definition uart.h:32
vsf_usart_irq_mask_t
Definition uart.h:106
vsf_usart_mode_t
Definition usart.h:86
@ VSF_USART_HALF_DUPLEX_DISABLE
Definition usart.h:108
@ VSF_USART_SYNC_CLOCK_ENABLE
Definition usart.h:116
@ VSF_USART_OVERSAMPLE_16
Definition usart.h:148
@ VSF_USART_SYNC_CLOCK_PHASE_1_EDGE
Definition usart.h:122
@ VSF_USART_10_BIT_LENGTH
Definition usart.h:132
@ VSF_USART_RTS_HWCONTROL
Definition usart.h:101
@ VSF_USART_SWAP
Definition usart.h:142
@ VSF_USART_RX_ENABLE
Definition usart.h:96
@ VSF_USART_FORCE_0_PARITY
Definition usart.h:186
@ __VSF_HW_USART_NOT_SUPPORT_MASK
Definition usart.h:201
@ VSF_USART_OVERSAMPLE_MASK
Definition usart.h:149
@ VSF_USART_TX_ENABLE
Definition usart.h:94
@ VSF_USART_SYNC_CLOCK_POLARITY_HIGH
Definition usart.h:120
@ VSF_USART_1_STOPBIT
Definition usart.h:89
@ VSF_USART_FORCE_1_PARITY
Definition usart.h:187
@ VSF_USART_SYNC_CLOCK_POLARITY_LOW
Definition usart.h:119
@ VSF_USART_RX_DISABLE
Definition usart.h:97
@ VSF_USART_2_STOPBIT
Definition usart.h:91
@ VSF_USART_CTS_HWCONTROL
Definition usart.h:102
@ VSF_USART_SYNC_CLOCK_DISABLE
Definition usart.h:117
@ VSF_USART_RTS_CTS_HWCONTROL
Definition usart.h:103
@ VSF_USART_SYNC_CLOCK_PHASE_2_EDGE
Definition usart.h:123
@ VSF_USART_HALF_DUPLEX_ENABLE
Definition usart.h:107
@ VSF_USART_TX_DISABLE
Definition usart.h:95
@ VSF_USART_OVERSAMPLE_8
Definition usart.h:147
@ VSF_USART_0_5_STOPBIT
Definition usart.h:88
@ VSF_USART_NO_HWCONTROL
Definition usart.h:100
@ VSF_USART_1_5_STOPBIT
Definition usart.h:90
vsf_usart_irq_mask_t
Definition usart.h:207
@ VSF_USART_IRQ_MASK_TX_CPL
Definition usart.h:222
@ VSF_USART_IRQ_MASK_CTS
Definition usart.h:217
@ VSF_USART_IRQ_MASK_TX
Definition usart.h:212
@ VSF_USART_IRQ_MASK_BREAK_ERR
Definition usart.h:248
@ VSF_USART_IRQ_MASK_RX
Definition usart.h:210
@ VSF_USART_IRQ_MASK_RX_TIMEOUT
Definition usart.h:214
@ VSF_USART_IRQ_MASK_RX_OVERFLOW_ERR
Definition usart.h:249
@ VSF_USART_IRQ_MASK_RX_CPL
Definition usart.h:221
@ VSF_USART_IRQ_MASK_PARITY_ERR
Definition usart.h:226
@ __VSF_HW_USART_IRQ_MASK
Definition usart.h:230
@ VSF_USART_IRQ_MASK_FRAME_ERR
Definition usart.h:247
#define VSF_USART_SYNC_CLOCK_LAST_BIT_ENABLE
Definition usart.h:127
vsf_usart_ctrl_t
Definition usart.h:256
@ VSF_USART_CTRL_CLEAR_BREAK
Definition usart.h:260
@ VSF_USART_CTRL_SEND_BREAK
Definition usart.h:257
@ __VSF_HW_USART_SUPPORT_CMD_MASK
Definition usart.h:262
@ VSF_USART_CTRL_SET_BREAK
Definition usart.h:259
#define VSF_USART_SYNC_CLOCK_LAST_BIT_DISABLE
Definition usart.h:128
struct vsf_usart_cfg_t vsf_usart_cfg_t
struct vsf_usart_capability_t vsf_usart_capability_t
@ VSF_USART_EVEN_PARITY
Definition usart.h:76
@ VSF_USART_ODD_PARITY
Definition usart.h:75
@ VSF_USART_NO_PARITY
Definition usart.h:74
@ __VSF_HW_USART_CTRL3_SHIFT_MASK
Definition usart.h:212
@ __VSF_HW_USART_CTRL1_MASK
Definition usart.h:182
@ __VSF_HW_USART_FIFO_SHIFT_BITS
Definition usart.h:218
@ __VSF_HW_USART_FIFO_MASK
Definition usart.h:215
@ __VSF_HW_USART_CTRL3_SHIFT_BITS
Definition usart.h:213
@ __VSF_HW_USART_CTRL2_MASK
Definition usart.h:192
@ __VSF_HW_USART_FIFO_SHIFT_MASK
Definition usart.h:217
@ __VSF_HW_USART_CTRL2_SHIFT_BITS
Definition usart.h:208
@ __VSF_HW_USART_CTRL2_SHIFT_MASK
Definition usart.h:204
@ __VSF_HW_USART_CTRL3_MASK
Definition usart.h:210
#define VSF_USART_TX_FIFO_THRESHOLD_ONE_EIGHTH
Definition usart.h:120
#define VSF_USART_TX_FIFO_THRESHOLD_THREE_FOURTH
Definition usart.h:124
#define VSF_USART_9_BIT_LENGTH
Definition usart.h:81
#define VSF_USART_RX_FIFO_THRESHOLD_QUARTER
Definition usart.h:135
#define VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL
Definition usart.h:131
#define VSF_USART_TX_FIFO_THRESHOLD_EMPTY
Definition usart.h:126
#define VSF_USART_RX_FIFO_THRESHOLD_ONE_EIGHTH
Definition usart.h:133
#define VSF_USART_RX_FIFO_THRESHOLD_MASK
Definition usart.h:147
struct vsf_usart_isr_t vsf_usart_isr_t
#define VSF_USART_RX_FIFO_THRESHOLD_FULL
Definition usart.h:139
#define VSF_USART_RX_FIFO_THRESHOLD_THREE_FOURTH
Definition usart.h:137
#define VSF_USART_TX_FIFO_THRESHOLD_MASK
Definition usart.h:141
@ __VSF_HW_USART_CTRL3_IRQ_MASK
Definition usart.h:302
@ __VSF_HW_USART_CTRL2_IRQ_MASK
Definition usart.h:301
@ __VSF_HW_USART_STS_IRQ_MASK
Definition usart.h:303
@ __VSF_HW_USART_CTRL1_IRQ_MASK
Definition usart.h:293
#define VSF_USART_RX_FIFO_THRESHOLD_NOT_EMPTY
Definition usart.h:129
#define VSF_USART_IRQ_MASK_TX_IDLE
Definition usart.h:262
#define VSF_USART_IRQ_MASK_RX_IDLE
Definition usart.h:255
#define VSF_USART_TX_FIFO_THRESHOLD_HALF_EMPTY
Definition usart.h:118
void vsf_usart_isr_handler_t(void *target_ptr, vsf_usart_t *usart_ptr, vsf_usart_irq_mask_t irq_mask)
Definition usart.h:367
#define VSF_USART_TX_FIFO_THRESHOLD_QUARTER
Definition usart.h:122
#define VSF_USART_TX_FIFO_THRESHOLD_NOT_FULL
Definition usart.h:116
#define VSF_USART_IRQ_MASK_NOISE_ERR
Definition usart.h:276
@ VSF_USART_8_BIT_LENGTH
Definition usart.h:43
@ VSF_USART_7_BIT_LENGTH
Definition usart.h:44
@ VSF_USART_5_BIT_LENGTH
Definition usart.h:46
@ VSF_USART_6_BIT_LENGTH
Definition usart.h:45
struct vsf_usart_status_t vsf_usart_status_t
vsf_arch_prio_t
Definition cortex_a_generic.h:88
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
unsigned uint32_t
Definition stdint.h:9
unsigned char uint8_t
Definition stdint.h:5
USART capability structure Defines the hardware capabilities and limitations of the USART interface.
Definition vsf_template_usart.h:797
uint8_t support_tx_idle
Support TX idle interrupt.
Definition vsf_template_usart.h:817
uint8_t max_data_bits
Maximum data bits per frame.
Definition vsf_template_usart.h:809
uint8_t support_set_and_clear_break
Support set and clear break.
Definition vsf_template_usart.h:814
vsf_usart_irq_mask_t irq_mask
Definition usart.h:387
uint8_t support_rx_timeout
Support receive timeout.
Definition vsf_template_usart.h:812
uint8_t rxfifo_depth
RX FIFO depth in data frames (0 means no FIFO)
Definition vsf_template_usart.h:807
uint8_t support_rx_idle
Support RX idle interrupt.
Definition vsf_template_usart.h:820
uint8_t support_send_break
Support send break.
Definition vsf_template_usart.h:813
uint8_t txfifo_depth
TX FIFO depth in data frames (0 means no FIFO)
Definition vsf_template_usart.h:806
uint8_t min_data_bits
Minimum data bits per frame.
Definition vsf_template_usart.h:810
uint32_t min_baudrate
Minimum supported baudrate (bps) according to current clock configurations.
Definition vsf_template_usart.h:804
uint32_t max_baudrate
Maximum supported baudrate (bps) according to current clock configurations.
Definition vsf_template_usart.h:803
uint8_t support_sync_clock
Support Synchronous clock.
Definition vsf_template_usart.h:815
USART configuration structure Contains all parameters needed to initialize and configure a USART inst...
Definition vsf_template_usart.h:687
uint32_t mode
USART working mode.
Definition vsf_template_usart.h:688
uint32_t baudrate
Baudrate in Hz.
Definition vsf_template_usart.h:689
uint32_t rx_timeout
RX timeout in microseconds.
Definition vsf_template_usart.h:690
vsf_usart_isr_t isr
Interrupt configuration.
Definition vsf_template_usart.h:694
USART interrupt configuration structure Contains all necessary information for configuring USART inte...
Definition vsf_template_usart.h:673
vsf_usart_isr_handler_t * handler_fn
Interrupt handler function pointer.
Definition vsf_template_usart.h:674
vsf_arch_prio_t prio
Interrupt priority.
Definition vsf_template_usart.h:676
void * target_ptr
User target pointer.
Definition vsf_template_usart.h:675
USART status information structure Contains the current status of USART operations and FIFO threshold...
Definition uart.h:157
uint32_t is_rxfifo_empty
Definition usart.h:338
uint32_t is_txfifo_full
Definition usart.h:335
uint32_t noise_err
Definition usart.h:270
uint32_t cts_changed
Definition usart.h:277
uint32_t rxdne
Definition usart.h:344
uint32_t overrun_err
Definition usart.h:271
uint32_t is_rxfifo_full
Definition usart.h:336
uint32_t is_txfifo_threahold
Definition usart.h:340
uint32_t is_tx_busy
TX is busy transmitting data.
Definition vsf_template_usart.h:779
uint32_t value
Definition usart.h:284
uint32_t tx_fifo_data
Definition usart.h:353
uint32_t is_txfifo_empty
Definition usart.h:337
uint32_t txde
Definition usart.h:342
uint32_t frame_err
Definition usart.h:269
uint32_t break_sent
Definition usart.h:346
uint32_t rx_fifo_data
Definition usart.h:354
uint32_t is_rx_idle
Definition usart.h:341
uint32_t rx_timeout
Definition usart.h:352
uint32_t is_rxfifo_threshold
Definition usart.h:339
uint32_t parity_err
Definition usart.h:268
USART instance structure Used for USART Multi Class support.
Definition vsf_template_usart.h:850
vsf_usart_irq_mask_t
Definition usart.h:174
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_usart_ctrl_t
USART control commands Defines the available control operations for USART instances.
Definition vsf_template_usart.h:707
Generated from commit: vsfteam/vsf@74aa6ce