mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NUMAKER_PFM_M453/TOOLCHAIN_ARM_MICRO/m451_uart.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /******************************************************************************
AnnaBridge 171:3a7713b1edbc 2 * @file uart.h
AnnaBridge 171:3a7713b1edbc 3 * @version V3.00
AnnaBridge 171:3a7713b1edbc 4 * $Revision: 36 $
AnnaBridge 171:3a7713b1edbc 5 * $Date: 15/08/11 10:26a $
AnnaBridge 171:3a7713b1edbc 6 * @brief M451 series UART driver header file
AnnaBridge 171:3a7713b1edbc 7 *
AnnaBridge 171:3a7713b1edbc 8 * @note
AnnaBridge 171:3a7713b1edbc 9 * Copyright (C) 2013~2015 Nuvoton Technology Corp. All rights reserved.
AnnaBridge 171:3a7713b1edbc 10 *****************************************************************************/
AnnaBridge 171:3a7713b1edbc 11 #ifndef __UART_H__
AnnaBridge 171:3a7713b1edbc 12 #define __UART_H__
AnnaBridge 171:3a7713b1edbc 13
AnnaBridge 171:3a7713b1edbc 14
AnnaBridge 171:3a7713b1edbc 15 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 16 extern "C"
AnnaBridge 171:3a7713b1edbc 17 {
AnnaBridge 171:3a7713b1edbc 18 #endif
AnnaBridge 171:3a7713b1edbc 19
AnnaBridge 171:3a7713b1edbc 20
AnnaBridge 171:3a7713b1edbc 21 /** @addtogroup Standard_Driver Standard Driver
AnnaBridge 171:3a7713b1edbc 22 @{
AnnaBridge 171:3a7713b1edbc 23 */
AnnaBridge 171:3a7713b1edbc 24
AnnaBridge 171:3a7713b1edbc 25 /** @addtogroup UART_Driver UART Driver
AnnaBridge 171:3a7713b1edbc 26 @{
AnnaBridge 171:3a7713b1edbc 27 */
AnnaBridge 171:3a7713b1edbc 28
AnnaBridge 171:3a7713b1edbc 29 /** @addtogroup UART_EXPORTED_CONSTANTS UART Exported Constants
AnnaBridge 171:3a7713b1edbc 30 @{
AnnaBridge 171:3a7713b1edbc 31 */
AnnaBridge 171:3a7713b1edbc 32
AnnaBridge 171:3a7713b1edbc 33 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 34 /* UART FIFO size constants definitions */
AnnaBridge 171:3a7713b1edbc 35 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 36
AnnaBridge 171:3a7713b1edbc 37 #define UART0_FIFO_SIZE 16 /*!< UART0 supports separated receive/transmit 16/16 bytes entry FIFO */
AnnaBridge 171:3a7713b1edbc 38 #define UART1_FIFO_SIZE 16 /*!< UART1 supports separated receive/transmit 16/16 bytes entry FIFO */
AnnaBridge 171:3a7713b1edbc 39 #define UART2_FIFO_SIZE 16 /*!< UART2 supports separated receive/transmit 16/16 bytes entry FIFO */
AnnaBridge 171:3a7713b1edbc 40 #define UART3_FIFO_SIZE 16 /*!< UART3 supports separated receive/transmit 16/16 bytes entry FIFO */
AnnaBridge 171:3a7713b1edbc 41
AnnaBridge 171:3a7713b1edbc 42 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 43 /* UART_FIFO constants definitions */
AnnaBridge 171:3a7713b1edbc 44 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 45
AnnaBridge 171:3a7713b1edbc 46 #define UART_FIFO_RFITL_1BYTE (0x0 << UART_FIFO_RFITL_Pos) /*!< UART_FIFO setting to set RX FIFO Trigger Level to 1 byte */
AnnaBridge 171:3a7713b1edbc 47 #define UART_FIFO_RFITL_4BYTES (0x1 << UART_FIFO_RFITL_Pos) /*!< UART_FIFO setting to set RX FIFO Trigger Level to 4 bytes */
AnnaBridge 171:3a7713b1edbc 48 #define UART_FIFO_RFITL_8BYTES (0x2 << UART_FIFO_RFITL_Pos) /*!< UART_FIFO setting to set RX FIFO Trigger Level to 8 bytes */
AnnaBridge 171:3a7713b1edbc 49 #define UART_FIFO_RFITL_14BYTES (0x3 << UART_FIFO_RFITL_Pos) /*!< UART_FIFO setting to set RX FIFO Trigger Level to 14 bytes */
AnnaBridge 171:3a7713b1edbc 50
AnnaBridge 171:3a7713b1edbc 51 #define UART_FIFO_RTSTRGLV_1BYTE (0x0 << UART_FIFO_RTSTRGLV_Pos) /*!< UART_FIFO setting to set RTS Trigger Level to 1 byte */
AnnaBridge 171:3a7713b1edbc 52 #define UART_FIFO_RTSTRGLV_4BYTES (0x1 << UART_FIFO_RTSTRGLV_Pos) /*!< UART_FIFO setting to set RTS Trigger Level to 4 bytes */
AnnaBridge 171:3a7713b1edbc 53 #define UART_FIFO_RTSTRGLV_8BYTES (0x2 << UART_FIFO_RTSTRGLV_Pos) /*!< UART_FIFO setting to set RTS Trigger Level to 8 bytes */
AnnaBridge 171:3a7713b1edbc 54 #define UART_FIFO_RTSTRGLV_14BYTES (0x3 << UART_FIFO_RTSTRGLV_Pos) /*!< UART_FIFO setting to set RTS Trigger Level to 14 bytes */
AnnaBridge 171:3a7713b1edbc 55
AnnaBridge 171:3a7713b1edbc 56 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 57 /* UART_LINE constants definitions */
AnnaBridge 171:3a7713b1edbc 58 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 59 #define UART_WORD_LEN_5 (0) /*!< UART_LINE setting to set UART word length to 5 bits */
AnnaBridge 171:3a7713b1edbc 60 #define UART_WORD_LEN_6 (1) /*!< UART_LINE setting to set UART word length to 6 bits */
AnnaBridge 171:3a7713b1edbc 61 #define UART_WORD_LEN_7 (2) /*!< UART_LINE setting to set UART word length to 7 bits */
AnnaBridge 171:3a7713b1edbc 62 #define UART_WORD_LEN_8 (3) /*!< UART_LINE setting to set UART word length to 8 bits */
AnnaBridge 171:3a7713b1edbc 63
AnnaBridge 171:3a7713b1edbc 64 #define UART_PARITY_NONE (0x0 << UART_LINE_PBE_Pos) /*!< UART_LINE setting to set UART as no parity */
AnnaBridge 171:3a7713b1edbc 65 #define UART_PARITY_ODD (0x1 << UART_LINE_PBE_Pos) /*!< UART_LINE setting to set UART as odd parity */
AnnaBridge 171:3a7713b1edbc 66 #define UART_PARITY_EVEN (0x3 << UART_LINE_PBE_Pos) /*!< UART_LINE setting to set UART as even parity */
AnnaBridge 171:3a7713b1edbc 67 #define UART_PARITY_MARK (0x5 << UART_LINE_PBE_Pos) /*!< UART_LINE setting to keep parity bit as '1' */
AnnaBridge 171:3a7713b1edbc 68 #define UART_PARITY_SPACE (0x7 << UART_LINE_PBE_Pos) /*!< UART_LINE setting to keep parity bit as '0' */
AnnaBridge 171:3a7713b1edbc 69
AnnaBridge 171:3a7713b1edbc 70 #define UART_STOP_BIT_1 (0x0 << UART_LINE_NSB_Pos) /*!< UART_LINE setting for one stop bit */
AnnaBridge 171:3a7713b1edbc 71 #define UART_STOP_BIT_1_5 (0x1 << UART_LINE_NSB_Pos) /*!< UART_LINE setting for 1.5 stop bit when 5-bit word length */
AnnaBridge 171:3a7713b1edbc 72 #define UART_STOP_BIT_2 (0x1 << UART_LINE_NSB_Pos) /*!< UART_LINE setting for two stop bit when 6, 7, 8-bit word length */
AnnaBridge 171:3a7713b1edbc 73
AnnaBridge 171:3a7713b1edbc 74
AnnaBridge 171:3a7713b1edbc 75 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 76 /* UART RTS ACTIVE LEVEL constants definitions */
AnnaBridge 171:3a7713b1edbc 77 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 78 #define UART_RTS_IS_LOW_LEV_ACTIVE (0x1 << UART_MODEM_RTSACTLV_Pos) /*!< Set RTS is Low Level Active */
AnnaBridge 171:3a7713b1edbc 79 #define UART_RTS_IS_HIGH_LEV_ACTIVE (0x0 << UART_MODEM_RTSACTLV_Pos) /*!< Set RTS is High Level Active */
AnnaBridge 171:3a7713b1edbc 80
AnnaBridge 171:3a7713b1edbc 81
AnnaBridge 171:3a7713b1edbc 82 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 83 /* UART_IRDA constants definitions */
AnnaBridge 171:3a7713b1edbc 84 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 85 #define UART_IRDA_TXEN (0x1 << UART_IRDA_TXEN_Pos) /*!< Set IrDA function Tx mode */
AnnaBridge 171:3a7713b1edbc 86 #define UART_IRDA_RXEN (0x0 << UART_IRDA_TXEN_Pos) /*!< Set IrDA function Rx mode */
AnnaBridge 171:3a7713b1edbc 87
AnnaBridge 171:3a7713b1edbc 88
AnnaBridge 171:3a7713b1edbc 89 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 90 /* UART_FUNCSEL constants definitions */
AnnaBridge 171:3a7713b1edbc 91 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 92 #define UART_FUNCSEL_UART (0x0 << UART_FUNCSEL_FUNCSEL_Pos) /*!< UART_FUNCSEL setting to set UART Function (Default) */
AnnaBridge 171:3a7713b1edbc 93 #define UART_FUNCSEL_LIN (0x1 << UART_FUNCSEL_FUNCSEL_Pos) /*!< UART_FUNCSEL setting to set LIN Function */
AnnaBridge 171:3a7713b1edbc 94 #define UART_FUNCSEL_IrDA (0x2 << UART_FUNCSEL_FUNCSEL_Pos) /*!< UART_FUNCSEL setting to set IrDA Function */
AnnaBridge 171:3a7713b1edbc 95 #define UART_FUNCSEL_RS485 (0x3 << UART_FUNCSEL_FUNCSEL_Pos) /*!< UART_FUNCSEL setting to set RS485 Function */
AnnaBridge 171:3a7713b1edbc 96
AnnaBridge 171:3a7713b1edbc 97
AnnaBridge 171:3a7713b1edbc 98 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 99 /* UART_LINCTL constants definitions */
AnnaBridge 171:3a7713b1edbc 100 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 101 #define UART_LINCTL_BRKFL(x) (((x)-1) << UART_LINCTL_BRKFL_Pos) /*!< UART_LINCTL setting to set LIN Break Field Length, x = 10 ~ 15, default value is 12 */
AnnaBridge 171:3a7713b1edbc 102 #define UART_LINCTL_BSL(x) (((x)-1) << UART_LINCTL_BSL_Pos) /*!< UART_LINCTL setting to set LIN Break/Sync Delimiter Length, x = 1 ~ 4 */
AnnaBridge 171:3a7713b1edbc 103 #define UART_LINCTL_HSEL_BREAK (0x0UL << UART_LINCTL_HSEL_Pos) /*!< UART_LINCTL setting to set LIN Header Select to break field */
AnnaBridge 171:3a7713b1edbc 104 #define UART_LINCTL_HSEL_BREAK_SYNC (0x1UL << UART_LINCTL_HSEL_Pos) /*!< UART_LINCTL setting to set LIN Header Select to break field and sync field */
AnnaBridge 171:3a7713b1edbc 105 #define UART_LINCTL_HSEL_BREAK_SYNC_ID (0x2UL << UART_LINCTL_HSEL_Pos) /*!< UART_LINCTL setting to set LIN Header Select to break field, sync field and ID field*/
AnnaBridge 171:3a7713b1edbc 106 #define UART_LINCTL_PID(x) ((x) << UART_LINCTL_PID_Pos) /*!< UART_LINCTL setting to set LIN PID value */
AnnaBridge 171:3a7713b1edbc 107
AnnaBridge 171:3a7713b1edbc 108
AnnaBridge 171:3a7713b1edbc 109 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 110 /* UART BAUDRATE MODE constants definitions */
AnnaBridge 171:3a7713b1edbc 111 /*---------------------------------------------------------------------------------------------------------*/
AnnaBridge 171:3a7713b1edbc 112 #define UART_BAUD_MODE0 (0) /*!< Set UART Baudrate Mode is Mode0 */
AnnaBridge 171:3a7713b1edbc 113 #define UART_BAUD_MODE2 (UART_BAUD_BAUDM1_Msk | UART_BAUD_BAUDM0_Msk) /*!< Set UART Baudrate Mode is Mode2 */
AnnaBridge 171:3a7713b1edbc 114
AnnaBridge 171:3a7713b1edbc 115
AnnaBridge 171:3a7713b1edbc 116 /*@}*/ /* end of group UART_EXPORTED_CONSTANTS */
AnnaBridge 171:3a7713b1edbc 117
AnnaBridge 171:3a7713b1edbc 118
AnnaBridge 171:3a7713b1edbc 119 /** @addtogroup UART_EXPORTED_FUNCTIONS UART Exported Functions
AnnaBridge 171:3a7713b1edbc 120 @{
AnnaBridge 171:3a7713b1edbc 121 */
AnnaBridge 171:3a7713b1edbc 122
AnnaBridge 171:3a7713b1edbc 123
AnnaBridge 171:3a7713b1edbc 124 /**
AnnaBridge 171:3a7713b1edbc 125 * @brief Calculate UART baudrate mode0 divider
AnnaBridge 171:3a7713b1edbc 126 *
AnnaBridge 171:3a7713b1edbc 127 * @param[in] u32SrcFreq UART clock frequency
AnnaBridge 171:3a7713b1edbc 128 * @param[in] u32BaudRate Baudrate of UART module
AnnaBridge 171:3a7713b1edbc 129 *
AnnaBridge 171:3a7713b1edbc 130 * @return UART baudrate mode0 divider
AnnaBridge 171:3a7713b1edbc 131 *
AnnaBridge 171:3a7713b1edbc 132 * @details This macro calculate UART baudrate mode0 divider.
AnnaBridge 171:3a7713b1edbc 133 */
AnnaBridge 171:3a7713b1edbc 134 #define UART_BAUD_MODE0_DIVIDER(u32SrcFreq, u32BaudRate) ((((u32SrcFreq) + ((u32BaudRate)*8)) / (u32BaudRate) >> 4)-2)
AnnaBridge 171:3a7713b1edbc 135
AnnaBridge 171:3a7713b1edbc 136
AnnaBridge 171:3a7713b1edbc 137 /**
AnnaBridge 171:3a7713b1edbc 138 * @brief Calculate UART baudrate mode2 divider
AnnaBridge 171:3a7713b1edbc 139 *
AnnaBridge 171:3a7713b1edbc 140 * @param[in] u32SrcFreq UART clock frequency
AnnaBridge 171:3a7713b1edbc 141 * @param[in] u32BaudRate Baudrate of UART module
AnnaBridge 171:3a7713b1edbc 142 *
AnnaBridge 171:3a7713b1edbc 143 * @return UART baudrate mode2 divider
AnnaBridge 171:3a7713b1edbc 144 *
AnnaBridge 171:3a7713b1edbc 145 * @details This macro calculate UART baudrate mode2 divider.
AnnaBridge 171:3a7713b1edbc 146 */
AnnaBridge 171:3a7713b1edbc 147 #define UART_BAUD_MODE2_DIVIDER(u32SrcFreq, u32BaudRate) ((((u32SrcFreq) + ((u32BaudRate)/2)) / (u32BaudRate))-2)
AnnaBridge 171:3a7713b1edbc 148
AnnaBridge 171:3a7713b1edbc 149
AnnaBridge 171:3a7713b1edbc 150 /**
AnnaBridge 171:3a7713b1edbc 151 * @brief Write UART data
AnnaBridge 171:3a7713b1edbc 152 *
AnnaBridge 171:3a7713b1edbc 153 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 154 * @param[in] u8Data Data byte to transmit.
AnnaBridge 171:3a7713b1edbc 155 *
AnnaBridge 171:3a7713b1edbc 156 * @return None
AnnaBridge 171:3a7713b1edbc 157 *
AnnaBridge 171:3a7713b1edbc 158 * @details This macro write Data to Tx data register.
AnnaBridge 171:3a7713b1edbc 159 */
AnnaBridge 171:3a7713b1edbc 160 #define UART_WRITE(uart, u8Data) ((uart)->DAT = (u8Data))
AnnaBridge 171:3a7713b1edbc 161
AnnaBridge 171:3a7713b1edbc 162
AnnaBridge 171:3a7713b1edbc 163 /**
AnnaBridge 171:3a7713b1edbc 164 * @brief Read UART data
AnnaBridge 171:3a7713b1edbc 165 *
AnnaBridge 171:3a7713b1edbc 166 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 167 *
AnnaBridge 171:3a7713b1edbc 168 * @return The oldest data byte in RX FIFO.
AnnaBridge 171:3a7713b1edbc 169 *
AnnaBridge 171:3a7713b1edbc 170 * @details This macro read Rx data register.
AnnaBridge 171:3a7713b1edbc 171 */
AnnaBridge 171:3a7713b1edbc 172 #define UART_READ(uart) ((uart)->DAT)
AnnaBridge 171:3a7713b1edbc 173
AnnaBridge 171:3a7713b1edbc 174
AnnaBridge 171:3a7713b1edbc 175 /**
AnnaBridge 171:3a7713b1edbc 176 * @brief Get Tx empty
AnnaBridge 171:3a7713b1edbc 177 *
AnnaBridge 171:3a7713b1edbc 178 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 179 *
AnnaBridge 171:3a7713b1edbc 180 * @retval 0 Tx FIFO is not empty
AnnaBridge 171:3a7713b1edbc 181 * @retval >=1 Tx FIFO is empty
AnnaBridge 171:3a7713b1edbc 182 *
AnnaBridge 171:3a7713b1edbc 183 * @details This macro get Transmitter FIFO empty register value.
AnnaBridge 171:3a7713b1edbc 184 */
AnnaBridge 171:3a7713b1edbc 185 #define UART_GET_TX_EMPTY(uart) ((uart)->FIFOSTS & UART_FIFOSTS_TXEMPTY_Msk)
AnnaBridge 171:3a7713b1edbc 186
AnnaBridge 171:3a7713b1edbc 187
AnnaBridge 171:3a7713b1edbc 188 /**
AnnaBridge 171:3a7713b1edbc 189 * @brief Get Rx empty
AnnaBridge 171:3a7713b1edbc 190 *
AnnaBridge 171:3a7713b1edbc 191 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 192 *
AnnaBridge 171:3a7713b1edbc 193 * @retval 0 Rx FIFO is not empty
AnnaBridge 171:3a7713b1edbc 194 * @retval >=1 Rx FIFO is empty
AnnaBridge 171:3a7713b1edbc 195 *
AnnaBridge 171:3a7713b1edbc 196 * @details This macro get Receiver FIFO empty register value.
AnnaBridge 171:3a7713b1edbc 197 */
AnnaBridge 171:3a7713b1edbc 198 #define UART_GET_RX_EMPTY(uart) ((uart)->FIFOSTS & UART_FIFOSTS_RXEMPTY_Msk)
AnnaBridge 171:3a7713b1edbc 199
AnnaBridge 171:3a7713b1edbc 200
AnnaBridge 171:3a7713b1edbc 201 /**
AnnaBridge 171:3a7713b1edbc 202 * @brief Check specified uart port transmission is over.
AnnaBridge 171:3a7713b1edbc 203 *
AnnaBridge 171:3a7713b1edbc 204 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 205 *
AnnaBridge 171:3a7713b1edbc 206 * @retval 0 Tx transmission is not over
AnnaBridge 171:3a7713b1edbc 207 * @retval 1 Tx transmission is over
AnnaBridge 171:3a7713b1edbc 208 *
AnnaBridge 171:3a7713b1edbc 209 * @details This macro return Transmitter Empty Flag register bit value.
AnnaBridge 171:3a7713b1edbc 210 * It indicates if specified uart port transmission is over nor not.
AnnaBridge 171:3a7713b1edbc 211 */
AnnaBridge 171:3a7713b1edbc 212 #define UART_IS_TX_EMPTY(uart) (((uart)->FIFOSTS & UART_FIFOSTS_TXEMPTYF_Msk) >> UART_FIFOSTS_TXEMPTYF_Pos)
AnnaBridge 171:3a7713b1edbc 213
AnnaBridge 171:3a7713b1edbc 214
AnnaBridge 171:3a7713b1edbc 215 /**
AnnaBridge 171:3a7713b1edbc 216 * @brief Wait specified uart port transmission is over
AnnaBridge 171:3a7713b1edbc 217 *
AnnaBridge 171:3a7713b1edbc 218 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 219 *
AnnaBridge 171:3a7713b1edbc 220 * @return None
AnnaBridge 171:3a7713b1edbc 221 *
AnnaBridge 171:3a7713b1edbc 222 * @details This macro wait specified uart port transmission is over.
AnnaBridge 171:3a7713b1edbc 223 */
AnnaBridge 171:3a7713b1edbc 224 #define UART_WAIT_TX_EMPTY(uart) while(!((((uart)->FIFOSTS) & UART_FIFOSTS_TXEMPTYF_Msk) >> UART_FIFOSTS_TXEMPTYF_Pos))
AnnaBridge 171:3a7713b1edbc 225
AnnaBridge 171:3a7713b1edbc 226
AnnaBridge 171:3a7713b1edbc 227 /**
AnnaBridge 171:3a7713b1edbc 228 * @brief Check RX is ready or not
AnnaBridge 171:3a7713b1edbc 229 *
AnnaBridge 171:3a7713b1edbc 230 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 231 *
AnnaBridge 171:3a7713b1edbc 232 * @retval 0 The number of bytes in the RX FIFO is less than the RFITL
AnnaBridge 171:3a7713b1edbc 233 * @retval 1 The number of bytes in the RX FIFO equals or larger than RFITL
AnnaBridge 171:3a7713b1edbc 234 *
AnnaBridge 171:3a7713b1edbc 235 * @details This macro check receive data available interrupt flag is set or not.
AnnaBridge 171:3a7713b1edbc 236 */
AnnaBridge 171:3a7713b1edbc 237 #define UART_IS_RX_READY(uart) (((uart)->INTSTS & UART_INTSTS_RDAIF_Msk)>>UART_INTSTS_RDAIF_Pos)
AnnaBridge 171:3a7713b1edbc 238
AnnaBridge 171:3a7713b1edbc 239
AnnaBridge 171:3a7713b1edbc 240 /**
AnnaBridge 171:3a7713b1edbc 241 * @brief Check TX FIFO is full or not
AnnaBridge 171:3a7713b1edbc 242 *
AnnaBridge 171:3a7713b1edbc 243 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 244 *
AnnaBridge 171:3a7713b1edbc 245 * @retval 1 TX FIFO is full
AnnaBridge 171:3a7713b1edbc 246 * @retval 0 TX FIFO is not full
AnnaBridge 171:3a7713b1edbc 247 *
AnnaBridge 171:3a7713b1edbc 248 * @details This macro check TX FIFO is full or not.
AnnaBridge 171:3a7713b1edbc 249 */
AnnaBridge 171:3a7713b1edbc 250 #define UART_IS_TX_FULL(uart) (((uart)->FIFOSTS & UART_FIFOSTS_TXFULL_Msk)>>UART_FIFOSTS_TXFULL_Pos)
AnnaBridge 171:3a7713b1edbc 251
AnnaBridge 171:3a7713b1edbc 252
AnnaBridge 171:3a7713b1edbc 253 /**
AnnaBridge 171:3a7713b1edbc 254 * @brief Check RX FIFO is full or not
AnnaBridge 171:3a7713b1edbc 255 *
AnnaBridge 171:3a7713b1edbc 256 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 257 *
AnnaBridge 171:3a7713b1edbc 258 * @retval 1 RX FIFO is full
AnnaBridge 171:3a7713b1edbc 259 * @retval 0 RX FIFO is not full
AnnaBridge 171:3a7713b1edbc 260 *
AnnaBridge 171:3a7713b1edbc 261 * @details This macro check RX FIFO is full or not.
AnnaBridge 171:3a7713b1edbc 262 */
AnnaBridge 171:3a7713b1edbc 263 #define UART_IS_RX_FULL(uart) (((uart)->FIFOSTS & UART_FIFOSTS_RXFULL_Msk)>>UART_FIFOSTS_RXFULL_Pos)
AnnaBridge 171:3a7713b1edbc 264
AnnaBridge 171:3a7713b1edbc 265
AnnaBridge 171:3a7713b1edbc 266 /**
AnnaBridge 171:3a7713b1edbc 267 * @brief Get Tx full register value
AnnaBridge 171:3a7713b1edbc 268 *
AnnaBridge 171:3a7713b1edbc 269 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 270 *
AnnaBridge 171:3a7713b1edbc 271 * @retval 0 Tx FIFO is not full.
AnnaBridge 171:3a7713b1edbc 272 * @retval >=1 Tx FIFO is full.
AnnaBridge 171:3a7713b1edbc 273 *
AnnaBridge 171:3a7713b1edbc 274 * @details This macro get Tx full register value.
AnnaBridge 171:3a7713b1edbc 275 */
AnnaBridge 171:3a7713b1edbc 276 #define UART_GET_TX_FULL(uart) ((uart)->FIFOSTS & UART_FIFOSTS_TXFULL_Msk)
AnnaBridge 171:3a7713b1edbc 277
AnnaBridge 171:3a7713b1edbc 278
AnnaBridge 171:3a7713b1edbc 279 /**
AnnaBridge 171:3a7713b1edbc 280 * @brief Get Rx full register value
AnnaBridge 171:3a7713b1edbc 281 *
AnnaBridge 171:3a7713b1edbc 282 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 283 *
AnnaBridge 171:3a7713b1edbc 284 * @retval 0 Rx FIFO is not full.
AnnaBridge 171:3a7713b1edbc 285 * @retval >=1 Rx FIFO is full.
AnnaBridge 171:3a7713b1edbc 286 *
AnnaBridge 171:3a7713b1edbc 287 * @details This macro get Rx full register value.
AnnaBridge 171:3a7713b1edbc 288 */
AnnaBridge 171:3a7713b1edbc 289 #define UART_GET_RX_FULL(uart) ((uart)->FIFOSTS & UART_FIFOSTS_RXFULL_Msk)
AnnaBridge 171:3a7713b1edbc 290
AnnaBridge 171:3a7713b1edbc 291
AnnaBridge 171:3a7713b1edbc 292 /**
AnnaBridge 171:3a7713b1edbc 293 * @brief Enable specified UART interrupt
AnnaBridge 171:3a7713b1edbc 294 *
AnnaBridge 171:3a7713b1edbc 295 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 296 * @param[in] u32eIntSel Interrupt type select
AnnaBridge 171:3a7713b1edbc 297 * - \ref UART_INTEN_ABRIEN_Msk : Auto baud rate interrupt
AnnaBridge 171:3a7713b1edbc 298 * - \ref UART_INTEN_WKCTSIEN_Msk : CTS wakeup interrupt
AnnaBridge 171:3a7713b1edbc 299 * - \ref UART_INTEN_WKDATIEN_Msk : Data wakeup interrupt
AnnaBridge 171:3a7713b1edbc 300 * - \ref UART_INTEN_LINIEN_Msk : Lin bus interrupt
AnnaBridge 171:3a7713b1edbc 301 * - \ref UART_INTEN_BUFERRIEN_Msk : Buffer Error interrupt
AnnaBridge 171:3a7713b1edbc 302 * - \ref UART_INTEN_RXTOIEN_Msk : Rx time-out interrupt
AnnaBridge 171:3a7713b1edbc 303 * - \ref UART_INTEN_MODEMIEN_Msk : Modem interrupt
AnnaBridge 171:3a7713b1edbc 304 * - \ref UART_INTEN_RLSIEN_Msk : Rx Line status interrupt
AnnaBridge 171:3a7713b1edbc 305 * - \ref UART_INTEN_THREIEN_Msk : Tx empty interrupt
AnnaBridge 171:3a7713b1edbc 306 * - \ref UART_INTEN_RDAIEN_Msk : Rx ready interrupt
AnnaBridge 171:3a7713b1edbc 307 *
AnnaBridge 171:3a7713b1edbc 308 * @return None
AnnaBridge 171:3a7713b1edbc 309 *
AnnaBridge 171:3a7713b1edbc 310 * @details This macro enable specified UART interrupt.
AnnaBridge 171:3a7713b1edbc 311 */
AnnaBridge 171:3a7713b1edbc 312 #define UART_ENABLE_INT(uart, u32eIntSel) ((uart)->INTEN |= (u32eIntSel))
AnnaBridge 171:3a7713b1edbc 313
AnnaBridge 171:3a7713b1edbc 314
AnnaBridge 171:3a7713b1edbc 315 /**
AnnaBridge 171:3a7713b1edbc 316 * @brief Disable specified UART interrupt
AnnaBridge 171:3a7713b1edbc 317 *
AnnaBridge 171:3a7713b1edbc 318 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 319 * @param[in] u32eIntSel Interrupt type select
AnnaBridge 171:3a7713b1edbc 320 * - \ref UART_INTEN_ABRIEN_Msk : Auto baud rate interrupt
AnnaBridge 171:3a7713b1edbc 321 * - \ref UART_INTEN_WKCTSIEN_Msk : CTS wakeup interrupt
AnnaBridge 171:3a7713b1edbc 322 * - \ref UART_INTEN_WKDATIEN_Msk : Data wakeup interrupt
AnnaBridge 171:3a7713b1edbc 323 * - \ref UART_INTEN_LINIEN_Msk : Lin bus interrupt
AnnaBridge 171:3a7713b1edbc 324 * - \ref UART_INTEN_BUFERRIEN_Msk : Buffer Error interrupt
AnnaBridge 171:3a7713b1edbc 325 * - \ref UART_INTEN_RXTOIEN_Msk : Rx time-out interrupt
AnnaBridge 171:3a7713b1edbc 326 * - \ref UART_INTEN_MODEMIEN_Msk : Modem status interrupt
AnnaBridge 171:3a7713b1edbc 327 * - \ref UART_INTEN_RLSIEN_Msk : Receive Line status interrupt
AnnaBridge 171:3a7713b1edbc 328 * - \ref UART_INTEN_THREIEN_Msk : Tx empty interrupt
AnnaBridge 171:3a7713b1edbc 329 * - \ref UART_INTEN_RDAIEN_Msk : Rx ready interrupt
AnnaBridge 171:3a7713b1edbc 330 *
AnnaBridge 171:3a7713b1edbc 331 * @return None
AnnaBridge 171:3a7713b1edbc 332 *
AnnaBridge 171:3a7713b1edbc 333 * @details This macro enable specified UART interrupt.
AnnaBridge 171:3a7713b1edbc 334 */
AnnaBridge 171:3a7713b1edbc 335 #define UART_DISABLE_INT(uart, u32eIntSel) ((uart)->INTEN &= ~ (u32eIntSel))
AnnaBridge 171:3a7713b1edbc 336
AnnaBridge 171:3a7713b1edbc 337
AnnaBridge 171:3a7713b1edbc 338 /**
AnnaBridge 171:3a7713b1edbc 339 * @brief Get specified interrupt flag/status
AnnaBridge 171:3a7713b1edbc 340 *
AnnaBridge 171:3a7713b1edbc 341 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 342 * @param[in] u32eIntTypeFlag Interrupt Type Flag, should be
AnnaBridge 171:3a7713b1edbc 343 * - \ref UART_INTSTS_HWBUFEINT_Msk : In DMA Mode, Buffer Error Interrupt Indicator
AnnaBridge 171:3a7713b1edbc 344 * - \ref UART_INTSTS_HWTOINT_Msk : In DMA Mode, Time-out Interrupt Indicator
AnnaBridge 171:3a7713b1edbc 345 * - \ref UART_INTSTS_HWMODINT_Msk : In DMA Mode, MODEM Status Interrupt Indicator
AnnaBridge 171:3a7713b1edbc 346 * - \ref UART_INTSTS_HWRLSINT_Msk : In DMA Mode, Receive Line Status Interrupt Indicator
AnnaBridge 171:3a7713b1edbc 347 * - \ref UART_INTSTS_HWBUFEIF_Msk : In DMA Mode, Buffer Error Interrupt Flag
AnnaBridge 171:3a7713b1edbc 348 * - \ref UART_INTSTS_HWTOIF_Msk : In DMA Mode, Time-out Interrupt Flag
AnnaBridge 171:3a7713b1edbc 349 * - \ref UART_INTSTS_HWMODIF_Msk : In DMA Mode, MODEM Interrupt Flag
AnnaBridge 171:3a7713b1edbc 350 * - \ref UART_INTSTS_HWRLSIF_Msk : In DMA Mode, Receive Line Status Flag
AnnaBridge 171:3a7713b1edbc 351 * - \ref UART_INTSTS_LININT_Msk : LIN Bus Interrupt Indicator
AnnaBridge 171:3a7713b1edbc 352 * - \ref UART_INTSTS_BUFERRINT_Msk : Buffer Error Interrupt Indicator
AnnaBridge 171:3a7713b1edbc 353 * - \ref UART_INTSTS_RXTOINT_Msk : Time-out Interrupt Indicator
AnnaBridge 171:3a7713b1edbc 354 * - \ref UART_INTSTS_MODEMINT_Msk : Modem Status Interrupt Indicator
AnnaBridge 171:3a7713b1edbc 355 * - \ref UART_INTSTS_RLSINT_Msk : Receive Line Status Interrupt Indicator
AnnaBridge 171:3a7713b1edbc 356 * - \ref UART_INTSTS_THREINT_Msk : Transmit Holding Register Empty Interrupt Indicator
AnnaBridge 171:3a7713b1edbc 357 * - \ref UART_INTSTS_RDAINT_Msk : Receive Data Available Interrupt Indicator
AnnaBridge 171:3a7713b1edbc 358 * - \ref UART_INTSTS_LINIF_Msk : LIN Bus Flag
AnnaBridge 171:3a7713b1edbc 359 * - \ref UART_INTSTS_BUFERRIF_Msk : Buffer Error Interrupt Flag
AnnaBridge 171:3a7713b1edbc 360 * - \ref UART_INTSTS_RXTOIF_Msk : Rx Time-out Interrupt Flag
AnnaBridge 171:3a7713b1edbc 361 * - \ref UART_INTSTS_MODEMIF_Msk : Modem Interrupt Flag
AnnaBridge 171:3a7713b1edbc 362 * - \ref UART_INTSTS_RLSIF_Msk : Receive Line Status Interrupt Flag
AnnaBridge 171:3a7713b1edbc 363 * - \ref UART_INTSTS_THREIF_Msk : Tx Empty Interrupt Flag
AnnaBridge 171:3a7713b1edbc 364 * - \ref UART_INTSTS_RDAIF_Msk : Rx Ready Interrupt Flag
AnnaBridge 171:3a7713b1edbc 365 *
AnnaBridge 171:3a7713b1edbc 366 * @retval 0 The specified interrupt is not happened.
AnnaBridge 171:3a7713b1edbc 367 * 1 The specified interrupt is happened.
AnnaBridge 171:3a7713b1edbc 368 *
AnnaBridge 171:3a7713b1edbc 369 * @details This macro get specified interrupt flag or interrupt indicator status.
AnnaBridge 171:3a7713b1edbc 370 */
AnnaBridge 171:3a7713b1edbc 371 #define UART_GET_INT_FLAG(uart,u32eIntTypeFlag) (((uart)->INTSTS & (u32eIntTypeFlag))?1:0)
AnnaBridge 171:3a7713b1edbc 372
AnnaBridge 171:3a7713b1edbc 373
AnnaBridge 171:3a7713b1edbc 374 /**
AnnaBridge 171:3a7713b1edbc 375 * @brief Set RTS pin to low
AnnaBridge 171:3a7713b1edbc 376 *
AnnaBridge 171:3a7713b1edbc 377 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 378 *
AnnaBridge 171:3a7713b1edbc 379 * @return None
AnnaBridge 171:3a7713b1edbc 380 *
AnnaBridge 171:3a7713b1edbc 381 * @details This macro set RTS pin to low.
AnnaBridge 171:3a7713b1edbc 382 */
AnnaBridge 171:3a7713b1edbc 383 __STATIC_INLINE void UART_CLEAR_RTS(UART_T* uart)
AnnaBridge 171:3a7713b1edbc 384 {
AnnaBridge 171:3a7713b1edbc 385 uart->MODEM |= UART_MODEM_RTSACTLV_Msk;
AnnaBridge 171:3a7713b1edbc 386 uart->MODEM &= ~UART_MODEM_RTS_Msk;
AnnaBridge 171:3a7713b1edbc 387 }
AnnaBridge 171:3a7713b1edbc 388
AnnaBridge 171:3a7713b1edbc 389
AnnaBridge 171:3a7713b1edbc 390 /**
AnnaBridge 171:3a7713b1edbc 391 * @brief Set RTS pin to high
AnnaBridge 171:3a7713b1edbc 392 *
AnnaBridge 171:3a7713b1edbc 393 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 394 *
AnnaBridge 171:3a7713b1edbc 395 * @return None
AnnaBridge 171:3a7713b1edbc 396 *
AnnaBridge 171:3a7713b1edbc 397 * @details This macro set RTS pin to high.
AnnaBridge 171:3a7713b1edbc 398 */
AnnaBridge 171:3a7713b1edbc 399 __STATIC_INLINE void UART_SET_RTS(UART_T* uart)
AnnaBridge 171:3a7713b1edbc 400 {
AnnaBridge 171:3a7713b1edbc 401 uart->MODEM |= UART_MODEM_RTSACTLV_Msk | UART_MODEM_RTS_Msk;
AnnaBridge 171:3a7713b1edbc 402 }
AnnaBridge 171:3a7713b1edbc 403
AnnaBridge 171:3a7713b1edbc 404
AnnaBridge 171:3a7713b1edbc 405 /**
AnnaBridge 171:3a7713b1edbc 406 * @brief Clear RS-485 Address Byte Detection Flag
AnnaBridge 171:3a7713b1edbc 407 *
AnnaBridge 171:3a7713b1edbc 408 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 409 *
AnnaBridge 171:3a7713b1edbc 410 * @return None
AnnaBridge 171:3a7713b1edbc 411 *
AnnaBridge 171:3a7713b1edbc 412 * @details This macro clear RS-485 address byte detection flag.
AnnaBridge 171:3a7713b1edbc 413 */
AnnaBridge 171:3a7713b1edbc 414 #define UART_RS485_CLEAR_ADDR_FLAG(uart) ((uart)->FIFOSTS = UART_FIFOSTS_ADDRDETF_Msk)
AnnaBridge 171:3a7713b1edbc 415
AnnaBridge 171:3a7713b1edbc 416
AnnaBridge 171:3a7713b1edbc 417 /**
AnnaBridge 171:3a7713b1edbc 418 * @brief Get RS-485 Address Byte Detection Flag
AnnaBridge 171:3a7713b1edbc 419 *
AnnaBridge 171:3a7713b1edbc 420 * @param[in] uart The pointer of the specified UART module
AnnaBridge 171:3a7713b1edbc 421 *
AnnaBridge 171:3a7713b1edbc 422 * @retval 0 Receiver detects a data that is not an address bit.
AnnaBridge 171:3a7713b1edbc 423 * @retval 1 Receiver detects a data that is an address bit.
AnnaBridge 171:3a7713b1edbc 424 *
AnnaBridge 171:3a7713b1edbc 425 * @details This macro get RS-485 address byte detection flag.
AnnaBridge 171:3a7713b1edbc 426 */
AnnaBridge 171:3a7713b1edbc 427 #define UART_RS485_GET_ADDR_FLAG(uart) (((uart)->FIFOSTS & UART_FIFOSTS_ADDRDETF_Msk) >> UART_FIFOSTS_ADDRDETF_Pos)
AnnaBridge 171:3a7713b1edbc 428
AnnaBridge 171:3a7713b1edbc 429
AnnaBridge 171:3a7713b1edbc 430 void UART_ClearIntFlag(UART_T* uart , uint32_t u32InterruptFlag);
AnnaBridge 171:3a7713b1edbc 431 void UART_Close(UART_T* uart);
AnnaBridge 171:3a7713b1edbc 432 void UART_DisableFlowCtrl(UART_T* uart);
AnnaBridge 171:3a7713b1edbc 433 void UART_DisableInt(UART_T* uart, uint32_t u32InterruptFlag);
AnnaBridge 171:3a7713b1edbc 434 void UART_EnableFlowCtrl(UART_T* uart);
AnnaBridge 171:3a7713b1edbc 435 void UART_EnableInt(UART_T* uart, uint32_t u32InterruptFlag);
AnnaBridge 171:3a7713b1edbc 436 void UART_Open(UART_T* uart, uint32_t u32baudrate);
AnnaBridge 171:3a7713b1edbc 437 uint32_t UART_Read(UART_T* uart, uint8_t *pu8RxBuf, uint32_t u32ReadBytes);
AnnaBridge 171:3a7713b1edbc 438 void UART_SetLine_Config(UART_T* uart, uint32_t u32baudrate, uint32_t u32data_width, uint32_t u32parity, uint32_t u32stop_bits);
AnnaBridge 171:3a7713b1edbc 439 void UART_SetTimeoutCnt(UART_T* uart, uint32_t u32TOC);
AnnaBridge 171:3a7713b1edbc 440 void UART_SelectIrDAMode(UART_T* uart, uint32_t u32Buadrate, uint32_t u32Direction);
AnnaBridge 171:3a7713b1edbc 441 void UART_SelectRS485Mode(UART_T* uart, uint32_t u32Mode, uint32_t u32Addr);
AnnaBridge 171:3a7713b1edbc 442 void UART_SelectLINMode(UART_T* uart, uint32_t u32Mode, uint32_t u32BreakLength);
AnnaBridge 171:3a7713b1edbc 443 uint32_t UART_Write(UART_T* uart, uint8_t *pu8TxBuf, uint32_t u32WriteBytes);
AnnaBridge 171:3a7713b1edbc 444
AnnaBridge 171:3a7713b1edbc 445
AnnaBridge 171:3a7713b1edbc 446
AnnaBridge 171:3a7713b1edbc 447
AnnaBridge 171:3a7713b1edbc 448 /*@}*/ /* end of group UART_EXPORTED_FUNCTIONS */
AnnaBridge 171:3a7713b1edbc 449
AnnaBridge 171:3a7713b1edbc 450 /*@}*/ /* end of group UART_Driver */
AnnaBridge 171:3a7713b1edbc 451
AnnaBridge 171:3a7713b1edbc 452 /*@}*/ /* end of group Standard_Driver */
AnnaBridge 171:3a7713b1edbc 453
AnnaBridge 171:3a7713b1edbc 454 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 455 }
AnnaBridge 171:3a7713b1edbc 456 #endif
AnnaBridge 171:3a7713b1edbc 457
AnnaBridge 171:3a7713b1edbc 458 #endif //__UART_H__
AnnaBridge 171:3a7713b1edbc 459
AnnaBridge 171:3a7713b1edbc 460 /*** (C) COPYRIGHT 2013~2015 Nuvoton Technology Corp. ***/