| NUC029FAE BSP V3.01.002 The Board Support Package for NUC029FAE

uart.h
Go to the documentation of this file.
1 /**************************************************************************/
12 #ifndef __UART_H__
13 #define __UART_H__
14
15 #ifdef __cplusplus
16 extern "C"
17 {
18 #endif
19
20
33 /*---------------------------------------------------------------------------------------------------------*/
34 /* UA_FCR constants definitions */
35 /*---------------------------------------------------------------------------------------------------------*/
36
37 #define UART_FCR_RFITL_1BYTE (0x0 << UART_FCR_RFITL_Pos)
38 #define UART_FCR_RFITL_4BYTES (0x1 << UART_FCR_RFITL_Pos)
39 #define UART_FCR_RFITL_8BYTES (0x2 << UART_FCR_RFITL_Pos)
40 #define UART_FCR_RFITL_14BYTES (0x3 << UART_FCR_RFITL_Pos)
42 #define UART_FCR_RTS_TRI_LEV_1BYTE (0x0 << UART_FCR_RTS_TRI_LEV_Pos)
43 #define UART_FCR_RTS_TRI_LEV_4BYTES (0x1 << UART_FCR_RTS_TRI_LEV_Pos)
44 #define UART_FCR_RTS_TRI_LEV_8BYTES (0x2 << UART_FCR_RTS_TRI_LEV_Pos)
45 #define UART_FCR_RTS_TRI_LEV_14BYTES (0x3 << UART_FCR_RTS_TRI_LEV_Pos)
47 /*---------------------------------------------------------------------------------------------------------*/
48 /* UA_LCR 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_LCR_PBE_Pos)
56 #define UART_PARITY_ODD (0x1 << UART_LCR_PBE_Pos)
57 #define UART_PARITY_EVEN (0x3 << UART_LCR_PBE_Pos)
58 #define UART_PARITY_MARK (0x5 << UART_LCR_PBE_Pos)
59 #define UART_PARITY_SPACE (0x7 << UART_LCR_PBE_Pos)
61 #define UART_STOP_BIT_1 (0x0 << UART_LCR_NSB_Pos)
62 #define UART_STOP_BIT_1_5 (0x1 << UART_LCR_NSB_Pos)
63 #define UART_STOP_BIT_2 (0x1 << UART_LCR_NSB_Pos)
66 /*---------------------------------------------------------------------------------------------------------*/
67 /* UART RTS LEVEL TRIGGER constants definitions */
68 /*---------------------------------------------------------------------------------------------------------*/
69 #define UART_RTS_IS_HIGH_LEV_TRG (0x1 << UART_MCR_LEV_RTS_Pos)
70 #define UART_RTS_IS_LOW_LEV_TRG (0x0 << UART_MCR_LEV_RTS_Pos)
72 /*---------------------------------------------------------------------------------------------------------*/
73 /* UA_FUNC_SEL constants definitions */
74 /*---------------------------------------------------------------------------------------------------------*/
75 #define UART_FUNC_SEL_UART (0x0 << UART_FUN_SEL_FUN_SEL_Pos)
76 #define UART_FUNC_SEL_IrDA (0x2 << UART_FUN_SEL_FUN_SEL_Pos)
77 #define UART_FUNC_SEL_RS485 (0x3 << UART_FUN_SEL_FUN_SEL_Pos)
80 /* end of group NUC029FAE_UART_EXPORTED_CONSTANTS */
81
82
95 #define UART_BAUD_MODE0 (0)
96
105 #define UART_BAUD_MODE2 (UART_BAUD_DIV_X_EN_Msk | UART_BAUD_DIV_X_ONE_Msk)
106
107
117 #define UART_BAUD_MODE0_DIVIDER(u32SrcFreq, u32BaudRate) (((u32SrcFreq + (u32BaudRate*8)) / u32BaudRate >> 4)-2)
118
127 #define UART_BAUD_MODE2_DIVIDER(u32SrcFreq, u32BaudRate) (((u32SrcFreq + (u32BaudRate/2)) / u32BaudRate)-2)
128
129
138 #define UART_WRITE(uart, u8Data) (uart->THR = (u8Data))
139
147 #define UART_READ(uart) (uart->RBR)
148
149
157 #define UART_GET_TX_EMPTY(uart) (uart->FSR & UART_FSR_TX_EMPTY_Msk)
158
159
167 #define UART_GET_RX_EMPTY(uart) (uart->FSR & UART_FSR_RX_EMPTY_Msk)
168
176 #define UART_IS_TX_EMPTY(uart) ((uart->FSR & UART_FSR_TE_FLAG_Msk) >> UART_FSR_TE_FLAG_Pos)
177
178
186 #define UART_WAIT_TX_EMPTY(uart) while(!(((uart->FSR) & UART_FSR_TE_FLAG_Msk) >> UART_FSR_TE_FLAG_Pos))
187
197 #define UART_IS_RX_READY(uart) ((uart->ISR & UART_ISR_RDA_IF_Msk)>>UART_ISR_RDA_IF_Pos)
198
199
209 #define UART_IS_TX_FULL(uart) ((uart->FSR & UART_FSR_TX_FULL_Msk)>>UART_FSR_TX_FULL_Pos)
210
221 #define UART_IS_RX_FULL(uart) ((uart->FSR & UART_FSR_RX_FULL_Msk)>>UART_FSR_RX_FULL_Pos)
222
223
231 #define UART_GET_TX_FULL(uart) (uart->FSR & UART_FSR_TX_FULL_Msk)
232
233
241 #define UART_GET_RX_FULL(uart) (uart->FSR & UART_FSR_RX_FULL_Msk)
242
243
260 #define UART_ENABLE_INT(uart, u32eIntSel) (uart->IER |= (u32eIntSel))
261
262
278 #define UART_DISABLE_INT(uart, u32eIntSel) (uart->IER &= ~ (u32eIntSel))
279
280
299 #define UART_GET_INT_FLAG(uart,u32eIntTypeFlag) ((uart->ISR & (u32eIntTypeFlag))?1:0)
300
301
308 __INLINE void UART_CLEAR_RTS(UART_T* uart)
309 {
310 uart->MCR |= UART_MCR_LEV_RTS_Msk;
311 uart->MCR &= UART_MCR_RTS_Msk;
312 }
313
320 __INLINE void UART_SET_RTS(UART_T* uart)
321 {
322 uart->MCR |= UART_MCR_LEV_RTS_Msk | UART_MCR_RTS_Msk;
323 }
324
331 #define UART_RS485_CLEAR_ADDR_FLAG(uart) (uart->FSR |= UART_FSR_RS485_ADD_DETF_Msk)
332
333
340 #define UART_RS485_GET_ADDR_FLAG(uart) ((uart->FSR & UART_FSR_RS485_ADD_DETF_Msk) >> UART_FSR_RS485_ADD_DETF_Pos)
341
342
343 void UART_ClearIntFlag(UART_T* uart, uint32_t u32InterruptFlag);
344 void UART_Close(UART_T* uart );
345 void UART_DisableFlowCtrl(UART_T* uart );
346 void UART_DisableInt(UART_T* uart, uint32_t u32InterruptFlag );
347 void UART_EnableFlowCtrl(UART_T* uart );
348 void UART_EnableInt(UART_T* uart, uint32_t u32InterruptFlag );
349 void UART_Open(UART_T* uart, uint32_t u32baudrate);
350 uint32_t UART_Read(UART_T* uart, uint8_t *pu8RxBuf, uint32_t u32ReadBytes);
351 void UART_SetLine_Config(UART_T* uart, uint32_t u32baudrate, uint32_t u32data_width, uint32_t u32parity, uint32_t u32stop_bits);
352 void UART_SetTimeoutCnt(UART_T* uart, uint32_t u32TOC);
353 void UART_SelectIrDAMode(UART_T* uart, uint32_t u32Buadrate, uint32_t u32Direction);
354 void UART_SelectRS485Mode(UART_T* uart, uint32_t u32Mode, uint32_t u32Addr);
355 uint32_t UART_Write(UART_T* uart,uint8_t *pu8TxBuf, uint32_t u32WriteBytes);
356
357 /* end of group NUC029FAE_UART_EXPORTED_FUNCTIONS */
359 /* end of group NUC029FAE_UART_Driver */
361 /* end of group NUC029FAE_Device_Driver */
363
364 #ifdef __cplusplus
365 }
366 #endif
367
368 #endif //__UART_H__
369
370 /*** (C) COPYRIGHT 2013 Nuvoton Technology Corp. ***/
371
372
373
374
375
376
377
378
UART_DisableFlowCtrl
void UART_DisableFlowCtrl(UART_T *uart)
The function is used to disable UART auto flow control.
Definition: uart.c:80
UART_ClearIntFlag
void UART_ClearIntFlag(UART_T *uart, uint32_t u32InterruptFlag)
The function is used to clear UART specified interrupt flag.
Definition: uart.c:37
UART_SelectRS485Mode
void UART_SelectRS485Mode(UART_T *uart, uint32_t u32Mode, uint32_t u32Addr)
The function is used to set RS485 relative setting.
Definition: uart.c:287
UART_CLEAR_RTS
__INLINE void UART_CLEAR_RTS(UART_T *uart)
Set RTS pin is low.
Definition: uart.h:308
UART_EnableFlowCtrl
void UART_EnableFlowCtrl(UART_T *uart)
The function is used to Enable UART auto flow control.
Definition: uart.c:116
UART_Write
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:304
UART_Close
void UART_Close(UART_T *uart)
The function is used to disable UART.
Definition: uart.c:67
UART_SelectIrDAMode
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:267
UART_SetTimeoutCnt
void UART_SetTimeoutCnt(UART_T *uart, uint32_t u32TOC)
This function use to set Rx timeout count.
Definition: uart.c:251
UART_SET_RTS
__INLINE void UART_SET_RTS(UART_T *uart)
Set RTS pin is high.
Definition: uart.h:320
UART_DisableInt
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
UART_T
Definition: NUC029FAE.h:2867
UART_EnableInt
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
UART_T::MCR
__IO uint32_t MCR
Definition: NUC029FAE.h:2877
UART_SetLine_Config
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:222
UART_Read
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:188
UART_Open
void UART_Open(UART_T *uart, uint32_t u32baudrate)
This function use to enable UART function and set baud-rate.
Definition: uart.c:155