Nano103 BSP  V3.01.002
The Board Support Package for Nano103 Series
uart.h
Go to the documentation of this file.
1 /**************************************************************************/
13 #ifndef __UART_H__
14 #define __UART_H__
15 
16 #ifdef __cplusplus
17 extern "C"
18 {
19 #endif
20 
21 
35 /*---------------------------------------------------------------------------------------------------------*/
36 /* UA_LCR constants definitions */
37 /*---------------------------------------------------------------------------------------------------------*/
38 #define UART_WORD_LEN_5 (0)
39 #define UART_WORD_LEN_6 (1)
40 #define UART_WORD_LEN_7 (2)
41 #define UART_WORD_LEN_8 (3)
43 #define UART_PARITY_NONE (0x0 << UART_LINE_PBE_Pos)
44 #define UART_PARITY_ODD (0x1 << UART_LINE_PBE_Pos)
45 #define UART_PARITY_EVEN (0x3 << UART_LINE_PBE_Pos)
46 #define UART_PARITY_MARK (0x5 << UART_LINE_PBE_Pos)
47 #define UART_PARITY_SPACE (0x7 << UART_LINE_PBE_Pos)
49 #define UART_STOP_BIT_1 (0x0 << UART_LINE_NSB_Pos)
50 #define UART_STOP_BIT_1_5 (0x1 << UART_LINE_NSB_Pos)
51 #define UART_STOP_BIT_2 (0x1 << UART_LINE_NSB_Pos)
53 #define UART_LINE_RFITL_1BYTE (0x0 << UART_LINE_RFITL_Pos)
54 #define UART_LINE_RFITL_4BYTES (0x1 << UART_LINE_RFITL_Pos)
55 #define UART_LINE_RFITL_8BYTES (0x2 << UART_LINE_RFITL_Pos)
56 #define UART_LINE_RFITL_14BYTES (0x3 << UART_LINE_RFITL_Pos)
58 #define UART_LINE_RTS_TRI_LEV_1BYTE (0x0 << UART_LINE_RTSTRGLV_Pos)
59 #define UART_LINE_RTS_TRI_LEV_4BYTES (0x1 << UART_LINE_RTSTRGLV_Pos)
60 #define UART_LINE_RTS_TRI_LEV_8BYTES (0x2 << UART_LINE_RTSTRGLV_Pos)
61 #define UART_LINE_RTS_TRI_LEV_14BYTES (0x3 << UART_LINE_RTSTRGLV_Pos)
64 /*---------------------------------------------------------------------------------------------------------*/
65 /* UART RTS LEVEL TRIGGER constants definitions */
66 /*---------------------------------------------------------------------------------------------------------*/
67 #define UART_RTS_IS_HIGH_LEV_TRG (0x1 << UART_MODEM_RTSACTLV_Pos)
68 #define UART_RTS_IS_LOW_LEV_TRG (0x0 << UART_MODEM_RTSACTLV_Pos)
70 /*---------------------------------------------------------------------------------------------------------*/
71 /* UA_FUNC_SEL constants definitions */
72 /*---------------------------------------------------------------------------------------------------------*/
73 #define UART_FUNCSEL_UART (0x0 << UART_FUNCSEL_FUNCSEL_Pos)
74 #define UART_FUNCSEL_LIN (0x1 << UART_FUNCSEL_FUNCSEL_Pos)
75 #define UART_FUNCSEL_IrDA (0x2 << UART_FUNCSEL_FUNCSEL_Pos)
76 #define UART_FUNCSEL_RS485 (0x3 << UART_FUNCSEL_FUNCSEL_Pos)
79  /* end of group NANO103_UART_EXPORTED_CONSTANTS */
80 
81 
94 #define UART_BAUD_MODE0 (0)
95 
104 #define UART_BAUD_MODE1 (UART_BAUD_DIV16EN_Msk)
105 
106 
116 #define UART_BAUD_MODE1_DIVIDER(u32SrcFreq, u32BaudRate) (((u32SrcFreq + (u32BaudRate*8)) / u32BaudRate >> 4)-1)
117 
126 #define UART_BAUD_MODE0_DIVIDER(u32SrcFreq, u32BaudRate) (((u32SrcFreq + (u32BaudRate/2)) / u32BaudRate)-1)
127 
128 
137 #define UART_WRITE(uart, u8Data) (uart->DAT = (u8Data))
138 
146 #define UART_READ(uart) (uart->DAT)
147 
148 
156 #define UART_GET_TX_EMPTY(uart) (uart->FIFOSTS & UART_FIFOSTS_TXEMPTY_Msk)
157 
158 
166 #define UART_GET_RX_EMPTY(uart) (uart->FIFOSTS & UART_FIFOSTS_RXEMPTY_Msk)
167 
175 #define UART_IS_TX_EMPTY(uart) ((uart->FIFOSTS & UART_FIFOSTS_TXENDF_Msk) >> UART_FIFOSTS_TXENDF_Pos)
176 
177 
185 #define UART_WAIT_TX_EMPTY(uart) while(!(((uart->FIFOSTS) & UART_FIFOSTS_TXENDF_Msk) >> UART_FIFOSTS_TXENDF_Pos))
186 
196 #define UART_IS_RX_READY(uart) ((uart->INTSTS & UART_INTSTS_RDAIF_Msk)>>UART_INTSTS_RDAIF_Pos)
197 
198 
208 #define UART_IS_TX_FULL(uart) ((uart->FIFOSTS & UART_FIFOSTS_TXFULL_Msk)>>UART_FIFOSTS_TXFULL_Pos)
209 
220 #define UART_IS_RX_FULL(uart) ((uart->FIFOSTS & UART_FIFOSTS_RXFULL_Msk)>>UART_FIFOSTS_RXFULL_Pos)
221 
222 
230 #define UART_GET_TX_FULL(uart) (uart->FIFOSTS & UART_FIFOSTS_TXFULL_Msk)
231 
232 
240 #define UART_GET_RX_FULL(uart) (uart->FIFOSTS & UART_FIFOSTS_RXFULL_Msk)
241 
250 #define UART_SET_RX_FIFO_INTTRGLV(uart, u32TriggerLevel) ((uart)->LINE = ((uart)->LINE & ~UART_LINE_RFITL_Msk) | (u32TriggerLevel))
251 
270 #define UART_ENABLE_INT(uart, u32eIntSel) (uart->INTEN |= (u32eIntSel))
271 
272 
290 #define UART_DISABLE_INT(uart, u32eIntSel) (uart->INTEN &= ~ (u32eIntSel))
291 
292 
312 #define UART_GET_INT_FLAG(uart,u32eIntTypeFlag) ((uart->INTSTS & (u32eIntTypeFlag))?1:0)
313 
314 
321 __INLINE void UART_CLEAR_RTS(UART_T* uart)
322 {
324 }
325 
332 __INLINE void UART_SET_RTS(UART_T* uart)
333 {
334  uart->MODEM &= ~UART_MODEM_RTSACTLV_Msk;
335 }
336 
343 #define UART_RS485_CLEAR_ADDR_FLAG(uart) (uart->TRSR = UART_TRSR_ADDRDETF_Msk)
344 
345 
352 #define UART_RS485_GET_ADDR_FLAG(uart) ((uart->TRSR & UART_TRSR_ADDRDETF_Msk) >> UART_TRSR_ADDRDETF_Pos)
353 
354 
355 void UART_ClearIntFlag(UART_T* uart, uint32_t u32InterruptFlag);
356 void UART_Close(UART_T* uart );
357 void UART_DisableFlowCtrl(UART_T* uart );
358 void UART_DisableInt(UART_T* uart, uint32_t u32InterruptFlag );
359 void UART_EnableFlowCtrl(UART_T* uart );
360 void UART_EnableInt(UART_T* uart, uint32_t u32InterruptFlag );
361 void UART_Open(UART_T* uart, uint32_t u32baudrate);
362 uint32_t UART_Read(UART_T* uart, uint8_t *pu8RxBuf, uint32_t u32ReadBytes);
363 void UART_SetLine_Config(UART_T* uart, uint32_t u32baudrate, uint32_t u32data_width, uint32_t u32parity, uint32_t u32stop_bits);
364 void UART_SetTimeoutCnt(UART_T* uart, uint32_t u32TOC);
365 void UART_SelectIrDAMode(UART_T* uart, uint32_t u32Buadrate, uint32_t u32Direction);
366 void UART_SelectRS485Mode(UART_T* uart, uint32_t u32Mode, uint32_t u32Addr);
367 void UART_SelectLINMode(UART_T* uart, uint32_t u32Mode, uint32_t u32BreakLength);
368 uint32_t UART_Write(UART_T* uart,uint8_t *pu8TxBuf, uint32_t u32WriteBytes);
369 
370  /* end of group NANO103_UART_EXPORTED_FUNCTIONS */
372  /* end of group NANO103_UART_Driver */
374  /* end of group NANO103_Device_Driver */
376 
377 #ifdef __cplusplus
378 }
379 #endif
380 
381 #endif //__UART_H__
382 
383 /*** (C) COPYRIGHT 2015 Nuvoton Technology Corp. ***/
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:300
void UART_ClearIntFlag(UART_T *uart, uint32_t u32InterruptFlag)
The function is used to clear UART specified interrupt flag.
Definition: uart.c:99
#define UART_MODEM_RTSACTLV_Msk
Definition: Nano103.h:20308
void UART_Close(UART_T *uart)
The function is used to disable UART.
Definition: uart.c:141
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:266
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:411
void UART_SelectLINMode(UART_T *uart, uint32_t u32Mode, uint32_t u32BreakLength)
Select and configure LIN function.
Definition: uart.c:390
__INLINE void UART_CLEAR_RTS(UART_T *uart)
Set RTS pin is low.
Definition: uart.h:321
void UART_SetTimeoutCnt(UART_T *uart, uint32_t u32TOC)
This function use to set Rx timeout count.
Definition: uart.c:329
void UART_DisableFlowCtrl(UART_T *uart)
The function is used to disable UART auto flow control.
Definition: uart.c:154
void UART_DisableInt(UART_T *uart, uint32_t u32InterruptFlag)
The function is used to disable UART specified interrupt.
Definition: uart.c:178
void UART_Open(UART_T *uart, uint32_t u32baudrate)
This function use to enable UART function and set baud-rate.
Definition: uart.c:231
__INLINE void UART_SET_RTS(UART_T *uart)
Set RTS pin is high.
Definition: uart.h:332
void UART_SelectRS485Mode(UART_T *uart, uint32_t u32Mode, uint32_t u32Addr)
The function is used to set RS485 relative setting.
Definition: uart.c:369
void UART_EnableFlowCtrl(UART_T *uart)
The function is used to Enable UART auto flow control.
Definition: uart.c:192
void UART_EnableInt(UART_T *uart, uint32_t u32InterruptFlag)
The function is used to enable UART specified interrupt.
Definition: uart.c:217
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:345
__IO uint32_t MODEM
Definition: Nano103.h:20110