MINI58_BSP V3.01.005
The Board Support Package for Mini58 Series MCU
uart.h
Go to the documentation of this file.
1/**************************************************************************/
12#ifndef __UART_H__
13#define __UART_H__
14
15#ifdef __cplusplus
16extern "C"
17{
18#endif
19
20
33/*---------------------------------------------------------------------------------------------------------*/
34/* UART_FIFO constants definitions */
35/*---------------------------------------------------------------------------------------------------------*/
36
37#define UART_FIFO_RFITL_1BYTE (0x0 << UART_FIFO_RFITL_Pos)
38#define UART_FIFO_RFITL_4BYTES (0x1 << UART_FIFO_RFITL_Pos)
39#define UART_FIFO_RFITL_8BYTES (0x2 << UART_FIFO_RFITL_Pos)
40#define UART_FIFO_RFITL_14BYTES (0x3 << UART_FIFO_RFITL_Pos)
42#define UART_FIFO_RTSTRGLV_1BYTE (0x0 << UART_FIFO_RTSTRGLV_Pos)
43#define UART_FIFO_RTSTRGLV_4BYTES (0x1 << UART_FIFO_RTSTRGLV_Pos)
44#define UART_FIFO_RTSTRGLV_8BYTES (0x2 << UART_FIFO_RTSTRGLV_Pos)
45#define UART_FIFO_RTSTRGLV_14BYTES (0x3 << UART_FIFO_RTSTRGLV_Pos)
47/*---------------------------------------------------------------------------------------------------------*/
48/* UART_LINE constants definitions */
49/*---------------------------------------------------------------------------------------------------------*/
50#define UART_WORD_LEN_5 (0)
51#define UART_WORD_LEN_6 (1)
52#define UART_WORD_LEN_7 (2)
53#define UART_WORD_LEN_8 (3)
55#define UART_PARITY_NONE (0x0 << UART_LINE_PBE_Pos)
56#define UART_PARITY_ODD (0x1 << UART_LINE_PBE_Pos)
57#define UART_PARITY_EVEN (0x3 << UART_LINE_PBE_Pos)
58#define UART_PARITY_MARK (0x5 << UART_LINE_PBE_Pos)
59#define UART_PARITY_SPACE (0x7 << UART_LINE_PBE_Pos)
61#define UART_STOP_BIT_1 (0x0 << UART_LINE_NSB_Pos)
62#define UART_STOP_BIT_1_5 (0x1 << UART_LINE_NSB_Pos)
63#define UART_STOP_BIT_2 (0x1 << UART_LINE_NSB_Pos)
66/*---------------------------------------------------------------------------------------------------------*/
67/* UART RTS LEVEL TRIGGER constants definitions */
68/*---------------------------------------------------------------------------------------------------------*/
69#define UART_RTS_IS_HIGH_LEV_TRG (0x1 << UART_MODEM_RTSACTLV_Pos)
70#define UART_RTS_IS_LOW_LEV_TRG (0x0 << UART_MODEM_RTSACTLV_Pos)
72/*---------------------------------------------------------------------------------------------------------*/
73/* UA_FUNC_SEL constants definitions */
74/*---------------------------------------------------------------------------------------------------------*/
75#define UART_FUNC_SEL_UART (0x0 << UART_FUNSEL_FUN_SEL_Pos)
76#define UART_FUNC_SEL_IrDA (0x2 << UART_FUNSEL_FUN_SEL_Pos)
77#define UART_FUNC_SEL_RS485 (0x3 << UART_FUNSEL_FUN_SEL_Pos) /* end of group Mini58_UART_EXPORTED_CONSTANTS */
81
82
95#define UART_BAUD_MODE0 (0)
96
105#define UART_BAUD_MODE1 (UART_BAUD_BAUDM1_Msk)
106
115#define UART_BAUD_MODE2 (UART_BAUD_BAUDM1_Msk | UART_BAUD_BAUDM0_Msk)
116
117
127#define UART_BAUD_MODE0_DIVIDER(u32SrcFreq, u32BaudRate) (((u32SrcFreq + (u32BaudRate*8)) / u32BaudRate >> 4)-2)
128
137#define UART_BAUD_MODE2_DIVIDER(u32SrcFreq, u32BaudRate) (((u32SrcFreq + (u32BaudRate/2)) / u32BaudRate)-2)
138
139
148#define UART_WRITE(uart, u8Data) (uart->DAT = (u8Data))
149
157#define UART_READ(uart) (uart->DAT)
158
159
167#define UART_GET_TX_EMPTY(uart) (uart->FIFOSTS & UART_FIFOSTS_TXEMPTYF_Msk)
168
169
177#define UART_GET_RX_EMPTY(uart) (uart->FIFOSTS & UART_FIFOSTS_RXEMPTY_Msk)
178
186#define UART_IS_TX_EMPTY(uart) ((uart->FIFOSTS & UART_FIFOSTS_TXEMPTYF_Msk) >> UART_FIFOSTS_TXEMPTYF_Pos)
187
188
196#define UART_WAIT_TX_EMPTY(uart) while(!(((uart->FIFOSTS) & UART_FIFOSTS_TXEMPTYF_Msk) >> UART_FIFOSTS_TXEMPTYF_Pos))
197
207#define UART_IS_RX_READY(uart) ((uart->INTSTS & UART_INTSTS_RDAIF_Msk)>>UART_INTSTS_RDAIF_Pos)
208
209
219#define UART_IS_TX_FULL(uart) ((uart->FIFOSTS & UART_FIFOSTS_TXFULL_Msk)>>UART_FIFOSTS_TXFULL_Pos)
220
231#define UART_IS_RX_FULL(uart) ((uart->FIFOSTS & UART_FIFOSTS_RXFULL_Msk)>>UART_FIFOSTS_RXFULL_Pos)
232
233
241#define UART_GET_TX_FULL(uart) (uart->FIFOSTS & UART_FIFOSTS_TXFULL_Msk)
242
243
251#define UART_GET_RX_FULL(uart) (uart->FIFOSTS & UART_FIFOSTS_RXFULL_Msk)
252
253
270#define UART_ENABLE_INT(uart, u32eIntSel) (uart->INTEN |= (u32eIntSel))
271
272
288#define UART_DISABLE_INT(uart, u32eIntSel) (uart->INTEN &= ~ (u32eIntSel))
289
290
314#define UART_GET_INT_FLAG(uart,u32eIntTypeFlag) ((uart->INTSTS & (u32eIntTypeFlag))?1:0)
315
316
323__INLINE void UART_CLEAR_RTS(UART_T* uart)
324{
326 uart->MODEM &= ~UART_MODEM_RTS_Msk;
327}
328
335__INLINE void UART_SET_RTS(UART_T* uart)
336{
338}
339
346#define UART_RS485_CLEAR_ADDR_FLAG(uart) (uart->FIFOSTS |= UART_FIFOSTS_ADDRDETF_Msk)
347
348
355#define UART_RS485_GET_ADDR_FLAG(uart) ((uart->FIFOSTS & UART_FIFOSTS_ADDRDETF_Msk) >> UART_FIFOSTS_ADDRDETF_Pos)
356
357
358void UART_ClearIntFlag(UART_T* uart, uint32_t u32InterruptFlag);
359void UART_Close(UART_T* uart );
360void UART_DisableFlowCtrl(UART_T* uart );
361void UART_DisableInt(UART_T* uart, uint32_t u32InterruptFlag );
362void UART_EnableFlowCtrl(UART_T* uart );
363void UART_EnableInt(UART_T* uart, uint32_t u32InterruptFlag );
364void UART_Open(UART_T* uart, uint32_t u32baudrate);
365uint32_t UART_Read(UART_T* uart, uint8_t *pu8RxBuf, uint32_t u32ReadBytes);
366void UART_SetLine_Config(UART_T* uart, uint32_t u32baudrate, uint32_t u32data_width, uint32_t u32parity, uint32_t u32stop_bits);
367void UART_SetTimeoutCnt(UART_T* uart, uint32_t u32TOC);
368void UART_SelectIrDAMode(UART_T* uart, uint32_t u32Buadrate, uint32_t u32Direction);
369void UART_SelectRS485Mode(UART_T* uart, uint32_t u32Mode, uint32_t u32Addr);
370uint32_t UART_Write(UART_T* uart,uint8_t *pu8TxBuf, uint32_t u32WriteBytes);
371
372 /* end of group Mini58_UART_EXPORTED_FUNCTIONS */
374 /* end of group Mini58_UART_Driver */
376 /* end of group Mini58_Device_Driver */
378
379#ifdef __cplusplus
380}
381#endif
382
383#endif //__UART_H__
384
385/*** (C) COPYRIGHT 2022 Nuvoton Technology Corp. ***/
#define UART_MODEM_RTS_Msk
#define UART_MODEM_RTSACTLV_Msk
void UART_SelectRS485Mode(UART_T *uart, uint32_t u32Mode, uint32_t u32Addr)
The function is used to set RS485 relative setting.
Definition: uart.c:419
void UART_EnableInt(UART_T *uart, uint32_t u32InterruptFlag)
The function is used to enable UART specified interrupt and disable NVIC UART IRQ.
Definition: uart.c:141
void UART_SetTimeoutCnt(UART_T *uart, uint32_t u32TOC)
This function use to set Rx timeout count.
Definition: uart.c:367
void UART_Close(UART_T *uart)
The function is used to disable UART.
Definition: uart.c:67
void UART_ClearIntFlag(UART_T *uart, uint32_t u32InterruptFlag)
The function is used to clear UART specified interrupt flag.
Definition: uart.c:37
void UART_DisableFlowCtrl(UART_T *uart)
The function is used to disable UART auto flow control.
Definition: uart.c:80
void UART_EnableFlowCtrl(UART_T *uart)
The function is used to Enable UART auto flow control.
Definition: uart.c:116
uint32_t UART_Write(UART_T *uart, uint8_t *pu8TxBuf, uint32_t u32WriteBytes)
The function is to write data into TX buffer to transmit data by UART.
Definition: uart.c:436
void UART_SetLine_Config(UART_T *uart, uint32_t u32baudrate, uint32_t u32data_width, uint32_t u32parity, uint32_t u32stop_bits)
This function use to config UART line setting.
Definition: uart.c:280
void UART_DisableInt(UART_T *uart, uint32_t u32InterruptFlag)
The function is used to disable UART specified interrupt and disable NVIC UART IRQ.
Definition: uart.c:102
__INLINE void UART_SET_RTS(UART_T *uart)
Set RTS pin is high.
Definition: uart.h:335
void UART_SelectIrDAMode(UART_T *uart, uint32_t u32Buadrate, uint32_t u32Direction)
The function is used to configure IrDA relative settings. It consists of TX or RX mode and baudrate.
Definition: uart.c:383
uint32_t UART_Read(UART_T *uart, uint8_t *pu8RxBuf, uint32_t u32ReadBytes)
The function is used to read Rx data from RX FIFO and the data will be stored in pu8RxBuf.
Definition: uart.c:246
void UART_Open(UART_T *uart, uint32_t u32baudrate)
This function use to enable UART function and set baud-rate.
Definition: uart.c:155
__INLINE void UART_CLEAR_RTS(UART_T *uart)
Set RTS pin is low.
Definition: uart.h:323
__IO uint32_t MODEM