18#ifndef __HAL_DRIVER_${SERIES/USART_IP}_USART_H__
19#define __HAL_DRIVER_${SERIES/USART_IP}_USART_H__
25#if VSF_HAL_USE_USART == ENABLED
44#if defined(__VSF_HAL_${USART_IP}_USART_CLASS_IMPLEMENT)
45# define __VSF_CLASS_IMPLEMENT__
46#elif defined(__VSF_HAL_${USART_IP}_USART_CLASS_INHERIT__)
47# define __VSF_CLASS_INHERIT__
64#ifndef VSF_${USART_IP}_USART_CFG_MULTI_CLASS
65# define VSF_${USART_IP}_USART_CFG_MULTI_CLASS VSF_USART_CFG_MULTI_CLASS
82#define VSF_USART_CFG_REIMPLEMENT_TYPE_MODE ENABLED
83#define VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS ENABLED
84#define VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK ENABLED
85#define VSF_USART_CFG_REIMPLEMENT_TYPE_CTRL ENABLED
86#define VSF_USART_CFG_REIMPLEMENT_TYPE_CFG ENABLED
87#define VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY ENABLED
96#if VSF_${USART_IP}_CFG_MULTI_CLASS == ENABLED
115#if VSF_USART_CFG_REIMPLEMENT_TYPE_MODE == ENABLED
173#if VSF_USART_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
210#if VSF_USART_CFG_REIMPLEMENT_TYPE_CTRL == ENABLED
221 #define VSF_USART_CTRL_SET_BREAK VSF_USART_CTRL_SET_BREAK
233#if VSF_USART_CFG_REIMPLEMENT_TYPE_STATUS == ENABLED
253#if VSF_USART_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
267# ifdef VSF_USART_IRQ_MASK_RX_IDLE
276#if VSF_USART_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
293# ifdef VSF_USART_IRQ_MASK_TX_IDLE
296# ifdef VSF_USART_IRQ_MASK_RX_IDLE
320#undef __VSF_HAL_${USART_IP}_USART_CLASS_IMPLEMENT
321#undef __VSF_HAL_${USART_IP}_USART_CLASS_INHERIT__
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_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_RX_ENABLE
Definition usart.h:96
@ VSF_USART_FORCE_0_PARITY
Definition usart.h:186
@ 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_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_USART_IRQ_MASK_FRAME_ERR
Definition usart.h:247
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_USART_CTRL_SET_BREAK
Definition usart.h:259
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
#define VSF_USART_9_BIT_LENGTH
Definition usart.h:81
#define VSF_USART_RX_FIFO_THRESHOLD_HALF_FULL
Definition usart.h:131
#define VSF_USART_TX_FIFO_THRESHOLD_EMPTY
Definition usart.h:126
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_NOT_EMPTY
Definition usart.h:129
#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_NOT_FULL
Definition usart.h:116
@ 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
#define vsf_class(__name)
Definition ooc_class.h:48
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
Definition vsf_template_hal_driver.h:196
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
uint32_t rx_idle_cnt
Definition vsf_template_usart.h:692
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_busy
USART is busy with any operation.
Definition vsf_template_usart.h:778
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_thresh
TX FIFO threshold level (0-255)
Definition vsf_template_usart.h:781
uint32_t rx_fifo_thresh
RX FIFO threshold level (0-255)
Definition vsf_template_usart.h:782
uint32_t is_rx_busy
RX is busy receiving data.
Definition vsf_template_usart.h:780
USART instance structure Used for USART Multi Class support.
Definition vsf_template_usart.h:850
vsf_usart_isr_t isr
Definition usart.h:110
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