nu_uart.h 23 KB

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