mbed library sources. Supersedes mbed-src.
Fork of mbed-dev by
Diff: targets/TARGET_NUVOTON/TARGET_M451/device/StdDriver/m451_uart.h
- Revision:
- 153:9398a535854b
- Parent:
- 152:9a67f0b066fc
--- a/targets/TARGET_NUVOTON/TARGET_M451/device/StdDriver/m451_uart.h Thu Dec 15 11:48:27 2016 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,460 +0,0 @@ -/****************************************************************************** - * @file uart.h - * @version V3.00 - * $Revision: 36 $ - * $Date: 15/08/11 10:26a $ - * @brief M451 series UART driver header file - * - * @note - * Copyright (C) 2013~2015 Nuvoton Technology Corp. All rights reserved. -*****************************************************************************/ -#ifndef __UART_H__ -#define __UART_H__ - - -#ifdef __cplusplus -extern "C" -{ -#endif - - -/** @addtogroup Standard_Driver Standard Driver - @{ -*/ - -/** @addtogroup UART_Driver UART Driver - @{ -*/ - -/** @addtogroup UART_EXPORTED_CONSTANTS UART Exported Constants - @{ -*/ - -/*---------------------------------------------------------------------------------------------------------*/ -/* UART FIFO size constants definitions */ -/*---------------------------------------------------------------------------------------------------------*/ - -#define UART0_FIFO_SIZE 16 /*!< UART0 supports separated receive/transmit 16/16 bytes entry FIFO */ -#define UART1_FIFO_SIZE 16 /*!< UART1 supports separated receive/transmit 16/16 bytes entry FIFO */ -#define UART2_FIFO_SIZE 16 /*!< UART2 supports separated receive/transmit 16/16 bytes entry FIFO */ -#define UART3_FIFO_SIZE 16 /*!< UART3 supports separated receive/transmit 16/16 bytes entry FIFO */ - -/*---------------------------------------------------------------------------------------------------------*/ -/* UART_FIFO constants definitions */ -/*---------------------------------------------------------------------------------------------------------*/ - -#define UART_FIFO_RFITL_1BYTE (0x0 << UART_FIFO_RFITL_Pos) /*!< UART_FIFO setting to set RX FIFO Trigger Level to 1 byte */ -#define UART_FIFO_RFITL_4BYTES (0x1 << UART_FIFO_RFITL_Pos) /*!< UART_FIFO setting to set RX FIFO Trigger Level to 4 bytes */ -#define UART_FIFO_RFITL_8BYTES (0x2 << UART_FIFO_RFITL_Pos) /*!< UART_FIFO setting to set RX FIFO Trigger Level to 8 bytes */ -#define UART_FIFO_RFITL_14BYTES (0x3 << UART_FIFO_RFITL_Pos) /*!< UART_FIFO setting to set RX FIFO Trigger Level to 14 bytes */ - -#define UART_FIFO_RTSTRGLV_1BYTE (0x0 << UART_FIFO_RTSTRGLV_Pos) /*!< UART_FIFO setting to set RTS Trigger Level to 1 byte */ -#define UART_FIFO_RTSTRGLV_4BYTES (0x1 << UART_FIFO_RTSTRGLV_Pos) /*!< UART_FIFO setting to set RTS Trigger Level to 4 bytes */ -#define UART_FIFO_RTSTRGLV_8BYTES (0x2 << UART_FIFO_RTSTRGLV_Pos) /*!< UART_FIFO setting to set RTS Trigger Level to 8 bytes */ -#define UART_FIFO_RTSTRGLV_14BYTES (0x3 << UART_FIFO_RTSTRGLV_Pos) /*!< UART_FIFO setting to set RTS Trigger Level to 14 bytes */ - -/*---------------------------------------------------------------------------------------------------------*/ -/* UART_LINE constants definitions */ -/*---------------------------------------------------------------------------------------------------------*/ -#define UART_WORD_LEN_5 (0) /*!< UART_LINE setting to set UART word length to 5 bits */ -#define UART_WORD_LEN_6 (1) /*!< UART_LINE setting to set UART word length to 6 bits */ -#define UART_WORD_LEN_7 (2) /*!< UART_LINE setting to set UART word length to 7 bits */ -#define UART_WORD_LEN_8 (3) /*!< UART_LINE setting to set UART word length to 8 bits */ - -#define UART_PARITY_NONE (0x0 << UART_LINE_PBE_Pos) /*!< UART_LINE setting to set UART as no parity */ -#define UART_PARITY_ODD (0x1 << UART_LINE_PBE_Pos) /*!< UART_LINE setting to set UART as odd parity */ -#define UART_PARITY_EVEN (0x3 << UART_LINE_PBE_Pos) /*!< UART_LINE setting to set UART as even parity */ -#define UART_PARITY_MARK (0x5 << UART_LINE_PBE_Pos) /*!< UART_LINE setting to keep parity bit as '1' */ -#define UART_PARITY_SPACE (0x7 << UART_LINE_PBE_Pos) /*!< UART_LINE setting to keep parity bit as '0' */ - -#define UART_STOP_BIT_1 (0x0 << UART_LINE_NSB_Pos) /*!< UART_LINE setting for one stop bit */ -#define UART_STOP_BIT_1_5 (0x1 << UART_LINE_NSB_Pos) /*!< UART_LINE setting for 1.5 stop bit when 5-bit word length */ -#define UART_STOP_BIT_2 (0x1 << UART_LINE_NSB_Pos) /*!< UART_LINE setting for two stop bit when 6, 7, 8-bit word length */ - - -/*---------------------------------------------------------------------------------------------------------*/ -/* UART RTS ACTIVE LEVEL constants definitions */ -/*---------------------------------------------------------------------------------------------------------*/ -#define UART_RTS_IS_LOW_LEV_ACTIVE (0x1 << UART_MODEM_RTSACTLV_Pos) /*!< Set RTS is Low Level Active */ -#define UART_RTS_IS_HIGH_LEV_ACTIVE (0x0 << UART_MODEM_RTSACTLV_Pos) /*!< Set RTS is High Level Active */ - - -/*---------------------------------------------------------------------------------------------------------*/ -/* UART_IRDA constants definitions */ -/*---------------------------------------------------------------------------------------------------------*/ -#define UART_IRDA_TXEN (0x1 << UART_IRDA_TXEN_Pos) /*!< Set IrDA function Tx mode */ -#define UART_IRDA_RXEN (0x0 << UART_IRDA_TXEN_Pos) /*!< Set IrDA function Rx mode */ - - -/*---------------------------------------------------------------------------------------------------------*/ -/* UART_FUNCSEL constants definitions */ -/*---------------------------------------------------------------------------------------------------------*/ -#define UART_FUNCSEL_UART (0x0 << UART_FUNCSEL_FUNCSEL_Pos) /*!< UART_FUNCSEL setting to set UART Function (Default) */ -#define UART_FUNCSEL_LIN (0x1 << UART_FUNCSEL_FUNCSEL_Pos) /*!< UART_FUNCSEL setting to set LIN Function */ -#define UART_FUNCSEL_IrDA (0x2 << UART_FUNCSEL_FUNCSEL_Pos) /*!< UART_FUNCSEL setting to set IrDA Function */ -#define UART_FUNCSEL_RS485 (0x3 << UART_FUNCSEL_FUNCSEL_Pos) /*!< UART_FUNCSEL setting to set RS485 Function */ - - -/*---------------------------------------------------------------------------------------------------------*/ -/* UART_LINCTL constants definitions */ -/*---------------------------------------------------------------------------------------------------------*/ -#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 */ -#define UART_LINCTL_BSL(x) (((x)-1) << UART_LINCTL_BSL_Pos) /*!< UART_LINCTL setting to set LIN Break/Sync Delimiter Length, x = 1 ~ 4 */ -#define UART_LINCTL_HSEL_BREAK (0x0UL << UART_LINCTL_HSEL_Pos) /*!< UART_LINCTL setting to set LIN Header Select to break field */ -#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 */ -#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*/ -#define UART_LINCTL_PID(x) ((x) << UART_LINCTL_PID_Pos) /*!< UART_LINCTL setting to set LIN PID value */ - - -/*---------------------------------------------------------------------------------------------------------*/ -/* UART BAUDRATE MODE constants definitions */ -/*---------------------------------------------------------------------------------------------------------*/ -#define UART_BAUD_MODE0 (0) /*!< Set UART Baudrate Mode is Mode0 */ -#define UART_BAUD_MODE2 (UART_BAUD_BAUDM1_Msk | UART_BAUD_BAUDM0_Msk) /*!< Set UART Baudrate Mode is Mode2 */ - - -/*@}*/ /* end of group UART_EXPORTED_CONSTANTS */ - - -/** @addtogroup UART_EXPORTED_FUNCTIONS UART Exported Functions - @{ -*/ - - -/** - * @brief Calculate UART baudrate mode0 divider - * - * @param[in] u32SrcFreq UART clock frequency - * @param[in] u32BaudRate Baudrate of UART module - * - * @return UART baudrate mode0 divider - * - * @details This macro calculate UART baudrate mode0 divider. - */ -#define UART_BAUD_MODE0_DIVIDER(u32SrcFreq, u32BaudRate) ((((u32SrcFreq) + ((u32BaudRate)*8)) / (u32BaudRate) >> 4)-2) - - -/** - * @brief Calculate UART baudrate mode2 divider - * - * @param[in] u32SrcFreq UART clock frequency - * @param[in] u32BaudRate Baudrate of UART module - * - * @return UART baudrate mode2 divider - * - * @details This macro calculate UART baudrate mode2 divider. - */ -#define UART_BAUD_MODE2_DIVIDER(u32SrcFreq, u32BaudRate) ((((u32SrcFreq) + ((u32BaudRate)/2)) / (u32BaudRate))-2) - - -/** - * @brief Write UART data - * - * @param[in] uart The pointer of the specified UART module - * @param[in] u8Data Data byte to transmit. - * - * @return None - * - * @details This macro write Data to Tx data register. - */ -#define UART_WRITE(uart, u8Data) ((uart)->DAT = (u8Data)) - - -/** - * @brief Read UART data - * - * @param[in] uart The pointer of the specified UART module - * - * @return The oldest data byte in RX FIFO. - * - * @details This macro read Rx data register. - */ -#define UART_READ(uart) ((uart)->DAT) - - -/** - * @brief Get Tx empty - * - * @param[in] uart The pointer of the specified UART module - * - * @retval 0 Tx FIFO is not empty - * @retval >=1 Tx FIFO is empty - * - * @details This macro get Transmitter FIFO empty register value. - */ -#define UART_GET_TX_EMPTY(uart) ((uart)->FIFOSTS & UART_FIFOSTS_TXEMPTY_Msk) - - -/** - * @brief Get Rx empty - * - * @param[in] uart The pointer of the specified UART module - * - * @retval 0 Rx FIFO is not empty - * @retval >=1 Rx FIFO is empty - * - * @details This macro get Receiver FIFO empty register value. - */ -#define UART_GET_RX_EMPTY(uart) ((uart)->FIFOSTS & UART_FIFOSTS_RXEMPTY_Msk) - - -/** - * @brief Check specified uart port transmission is over. - * - * @param[in] uart The pointer of the specified UART module - * - * @retval 0 Tx transmission is not over - * @retval 1 Tx transmission is over - * - * @details This macro return Transmitter Empty Flag register bit value. - * It indicates if specified uart port transmission is over nor not. - */ -#define UART_IS_TX_EMPTY(uart) (((uart)->FIFOSTS & UART_FIFOSTS_TXEMPTYF_Msk) >> UART_FIFOSTS_TXEMPTYF_Pos) - - -/** - * @brief Wait specified uart port transmission is over - * - * @param[in] uart The pointer of the specified UART module - * - * @return None - * - * @details This macro wait specified uart port transmission is over. - */ -#define UART_WAIT_TX_EMPTY(uart) while(!((((uart)->FIFOSTS) & UART_FIFOSTS_TXEMPTYF_Msk) >> UART_FIFOSTS_TXEMPTYF_Pos)) - - -/** - * @brief Check RX is ready or not - * - * @param[in] uart The pointer of the specified UART module - * - * @retval 0 The number of bytes in the RX FIFO is less than the RFITL - * @retval 1 The number of bytes in the RX FIFO equals or larger than RFITL - * - * @details This macro check receive data available interrupt flag is set or not. - */ -#define UART_IS_RX_READY(uart) (((uart)->INTSTS & UART_INTSTS_RDAIF_Msk)>>UART_INTSTS_RDAIF_Pos) - - -/** - * @brief Check TX FIFO is full or not - * - * @param[in] uart The pointer of the specified UART module - * - * @retval 1 TX FIFO is full - * @retval 0 TX FIFO is not full - * - * @details This macro check TX FIFO is full or not. - */ -#define UART_IS_TX_FULL(uart) (((uart)->FIFOSTS & UART_FIFOSTS_TXFULL_Msk)>>UART_FIFOSTS_TXFULL_Pos) - - -/** - * @brief Check RX FIFO is full or not - * - * @param[in] uart The pointer of the specified UART module - * - * @retval 1 RX FIFO is full - * @retval 0 RX FIFO is not full - * - * @details This macro check RX FIFO is full or not. - */ -#define UART_IS_RX_FULL(uart) (((uart)->FIFOSTS & UART_FIFOSTS_RXFULL_Msk)>>UART_FIFOSTS_RXFULL_Pos) - - -/** - * @brief Get Tx full register value - * - * @param[in] uart The pointer of the specified UART module - * - * @retval 0 Tx FIFO is not full. - * @retval >=1 Tx FIFO is full. - * - * @details This macro get Tx full register value. - */ -#define UART_GET_TX_FULL(uart) ((uart)->FIFOSTS & UART_FIFOSTS_TXFULL_Msk) - - -/** - * @brief Get Rx full register value - * - * @param[in] uart The pointer of the specified UART module - * - * @retval 0 Rx FIFO is not full. - * @retval >=1 Rx FIFO is full. - * - * @details This macro get Rx full register value. - */ -#define UART_GET_RX_FULL(uart) ((uart)->FIFOSTS & UART_FIFOSTS_RXFULL_Msk) - - -/** - * @brief Enable specified UART interrupt - * - * @param[in] uart The pointer of the specified UART module - * @param[in] u32eIntSel Interrupt type select - * - \ref UART_INTEN_ABRIEN_Msk : Auto baud rate interrupt - * - \ref UART_INTEN_WKCTSIEN_Msk : CTS wakeup interrupt - * - \ref UART_INTEN_WKDATIEN_Msk : Data wakeup interrupt - * - \ref UART_INTEN_LINIEN_Msk : Lin bus interrupt - * - \ref UART_INTEN_BUFERRIEN_Msk : Buffer Error interrupt - * - \ref UART_INTEN_RXTOIEN_Msk : Rx time-out interrupt - * - \ref UART_INTEN_MODEMIEN_Msk : Modem interrupt - * - \ref UART_INTEN_RLSIEN_Msk : Rx Line status interrupt - * - \ref UART_INTEN_THREIEN_Msk : Tx empty interrupt - * - \ref UART_INTEN_RDAIEN_Msk : Rx ready interrupt - * - * @return None - * - * @details This macro enable specified UART interrupt. - */ -#define UART_ENABLE_INT(uart, u32eIntSel) ((uart)->INTEN |= (u32eIntSel)) - - -/** - * @brief Disable specified UART interrupt - * - * @param[in] uart The pointer of the specified UART module - * @param[in] u32eIntSel Interrupt type select - * - \ref UART_INTEN_ABRIEN_Msk : Auto baud rate interrupt - * - \ref UART_INTEN_WKCTSIEN_Msk : CTS wakeup interrupt - * - \ref UART_INTEN_WKDATIEN_Msk : Data wakeup interrupt - * - \ref UART_INTEN_LINIEN_Msk : Lin bus interrupt - * - \ref UART_INTEN_BUFERRIEN_Msk : Buffer Error interrupt - * - \ref UART_INTEN_RXTOIEN_Msk : Rx time-out interrupt - * - \ref UART_INTEN_MODEMIEN_Msk : Modem status interrupt - * - \ref UART_INTEN_RLSIEN_Msk : Receive Line status interrupt - * - \ref UART_INTEN_THREIEN_Msk : Tx empty interrupt - * - \ref UART_INTEN_RDAIEN_Msk : Rx ready interrupt - * - * @return None - * - * @details This macro enable specified UART interrupt. - */ -#define UART_DISABLE_INT(uart, u32eIntSel) ((uart)->INTEN &= ~ (u32eIntSel)) - - -/** - * @brief Get specified interrupt flag/status - * - * @param[in] uart The pointer of the specified UART module - * @param[in] u32eIntTypeFlag Interrupt Type Flag, should be - * - \ref UART_INTSTS_HWBUFEINT_Msk : In DMA Mode, Buffer Error Interrupt Indicator - * - \ref UART_INTSTS_HWTOINT_Msk : In DMA Mode, Time-out Interrupt Indicator - * - \ref UART_INTSTS_HWMODINT_Msk : In DMA Mode, MODEM Status Interrupt Indicator - * - \ref UART_INTSTS_HWRLSINT_Msk : In DMA Mode, Receive Line Status Interrupt Indicator - * - \ref UART_INTSTS_HWBUFEIF_Msk : In DMA Mode, Buffer Error Interrupt Flag - * - \ref UART_INTSTS_HWTOIF_Msk : In DMA Mode, Time-out Interrupt Flag - * - \ref UART_INTSTS_HWMODIF_Msk : In DMA Mode, MODEM Interrupt Flag - * - \ref UART_INTSTS_HWRLSIF_Msk : In DMA Mode, Receive Line Status Flag - * - \ref UART_INTSTS_LININT_Msk : LIN Bus Interrupt Indicator - * - \ref UART_INTSTS_BUFERRINT_Msk : Buffer Error Interrupt Indicator - * - \ref UART_INTSTS_RXTOINT_Msk : Time-out Interrupt Indicator - * - \ref UART_INTSTS_MODEMINT_Msk : Modem Status Interrupt Indicator - * - \ref UART_INTSTS_RLSINT_Msk : Receive Line Status Interrupt Indicator - * - \ref UART_INTSTS_THREINT_Msk : Transmit Holding Register Empty Interrupt Indicator - * - \ref UART_INTSTS_RDAINT_Msk : Receive Data Available Interrupt Indicator - * - \ref UART_INTSTS_LINIF_Msk : LIN Bus Flag - * - \ref UART_INTSTS_BUFERRIF_Msk : Buffer Error Interrupt Flag - * - \ref UART_INTSTS_RXTOIF_Msk : Rx Time-out Interrupt Flag - * - \ref UART_INTSTS_MODEMIF_Msk : Modem Interrupt Flag - * - \ref UART_INTSTS_RLSIF_Msk : Receive Line Status Interrupt Flag - * - \ref UART_INTSTS_THREIF_Msk : Tx Empty Interrupt Flag - * - \ref UART_INTSTS_RDAIF_Msk : Rx Ready Interrupt Flag - * - * @retval 0 The specified interrupt is not happened. - * 1 The specified interrupt is happened. - * - * @details This macro get specified interrupt flag or interrupt indicator status. - */ -#define UART_GET_INT_FLAG(uart,u32eIntTypeFlag) (((uart)->INTSTS & (u32eIntTypeFlag))?1:0) - - -/** - * @brief Set RTS pin to low - * - * @param[in] uart The pointer of the specified UART module - * - * @return None - * - * @details This macro set RTS pin to low. - */ -__STATIC_INLINE void UART_CLEAR_RTS(UART_T* uart) -{ - uart->MODEM |= UART_MODEM_RTSACTLV_Msk; - uart->MODEM &= ~UART_MODEM_RTS_Msk; -} - - -/** - * @brief Set RTS pin to high - * - * @param[in] uart The pointer of the specified UART module - * - * @return None - * - * @details This macro set RTS pin to high. - */ -__STATIC_INLINE void UART_SET_RTS(UART_T* uart) -{ - uart->MODEM |= UART_MODEM_RTSACTLV_Msk | UART_MODEM_RTS_Msk; -} - - -/** - * @brief Clear RS-485 Address Byte Detection Flag - * - * @param[in] uart The pointer of the specified UART module - * - * @return None - * - * @details This macro clear RS-485 address byte detection flag. - */ -#define UART_RS485_CLEAR_ADDR_FLAG(uart) ((uart)->FIFOSTS = UART_FIFOSTS_ADDRDETF_Msk) - - -/** - * @brief Get RS-485 Address Byte Detection Flag - * - * @param[in] uart The pointer of the specified UART module - * - * @retval 0 Receiver detects a data that is not an address bit. - * @retval 1 Receiver detects a data that is an address bit. - * - * @details This macro get RS-485 address byte detection flag. - */ -#define UART_RS485_GET_ADDR_FLAG(uart) (((uart)->FIFOSTS & UART_FIFOSTS_ADDRDETF_Msk) >> UART_FIFOSTS_ADDRDETF_Pos) - - -void UART_ClearIntFlag(UART_T* uart , uint32_t u32InterruptFlag); -void UART_Close(UART_T* uart); -void UART_DisableFlowCtrl(UART_T* uart); -void UART_DisableInt(UART_T* uart, uint32_t u32InterruptFlag); -void UART_EnableFlowCtrl(UART_T* uart); -void UART_EnableInt(UART_T* uart, uint32_t u32InterruptFlag); -void UART_Open(UART_T* uart, uint32_t u32baudrate); -uint32_t UART_Read(UART_T* uart, uint8_t *pu8RxBuf, uint32_t u32ReadBytes); -void UART_SetLine_Config(UART_T* uart, uint32_t u32baudrate, uint32_t u32data_width, uint32_t u32parity, uint32_t u32stop_bits); -void UART_SetTimeoutCnt(UART_T* uart, uint32_t u32TOC); -void UART_SelectIrDAMode(UART_T* uart, uint32_t u32Buadrate, uint32_t u32Direction); -void UART_SelectRS485Mode(UART_T* uart, uint32_t u32Mode, uint32_t u32Addr); -void UART_SelectLINMode(UART_T* uart, uint32_t u32Mode, uint32_t u32BreakLength); -uint32_t UART_Write(UART_T* uart, uint8_t *pu8TxBuf, uint32_t u32WriteBytes); - - - - -/*@}*/ /* end of group UART_EXPORTED_FUNCTIONS */ - -/*@}*/ /* end of group UART_Driver */ - -/*@}*/ /* end of group Standard_Driver */ - -#ifdef __cplusplus -} -#endif - -#endif //__UART_H__ - -/*** (C) COPYRIGHT 2013~2015 Nuvoton Technology Corp. ***/