You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

1624 lines
82 KiB

  1. /**
  2. ******************************************************************************
  3. * @file stm32h7xx_hal_uart.h
  4. * @author MCD Application Team
  5. * @brief Header file of UART HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
  10. * All rights reserved.</center></h2>
  11. *
  12. * This software component is licensed by ST under BSD 3-Clause license,
  13. * the "License"; You may not use this file except in compliance with the
  14. * License. You may obtain a copy of the License at:
  15. * opensource.org/licenses/BSD-3-Clause
  16. *
  17. ******************************************************************************
  18. */
  19. /* Define to prevent recursive inclusion -------------------------------------*/
  20. #ifndef STM32H7xx_HAL_UART_H
  21. #define STM32H7xx_HAL_UART_H
  22. #ifdef __cplusplus
  23. extern "C" {
  24. #endif
  25. /* Includes ------------------------------------------------------------------*/
  26. #include "stm32h7xx_hal_def.h"
  27. /** @addtogroup STM32H7xx_HAL_Driver
  28. * @{
  29. */
  30. /** @addtogroup UART
  31. * @{
  32. */
  33. /* Exported types ------------------------------------------------------------*/
  34. /** @defgroup UART_Exported_Types UART Exported Types
  35. * @{
  36. */
  37. /**
  38. * @brief UART Init Structure definition
  39. */
  40. typedef struct
  41. {
  42. uint32_t BaudRate; /*!< This member configures the UART communication baud rate.
  43. The baud rate register is computed using the following formula:
  44. LPUART:
  45. =======
  46. Baud Rate Register = ((256 * lpuart_ker_ckpres) / ((huart->Init.BaudRate)))
  47. where lpuart_ker_ck_pres is the UART input clock divided by a prescaler
  48. UART:
  49. =====
  50. - If oversampling is 16 or in LIN mode,
  51. Baud Rate Register = ((uart_ker_ckpres) / ((huart->Init.BaudRate)))
  52. - If oversampling is 8,
  53. Baud Rate Register[15:4] = ((2 * uart_ker_ckpres) / ((huart->Init.BaudRate)))[15:4]
  54. Baud Rate Register[3] = 0
  55. Baud Rate Register[2:0] = (((2 * uart_ker_ckpres) / ((huart->Init.BaudRate)))[3:0]) >> 1
  56. where uart_ker_ck_pres is the UART input clock divided by a prescaler */
  57. uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
  58. This parameter can be a value of @ref UARTEx_Word_Length. */
  59. uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
  60. This parameter can be a value of @ref UART_Stop_Bits. */
  61. uint32_t Parity; /*!< Specifies the parity mode.
  62. This parameter can be a value of @ref UART_Parity
  63. @note When parity is enabled, the computed parity is inserted
  64. at the MSB position of the transmitted data (9th bit when
  65. the word length is set to 9 data bits; 8th bit when the
  66. word length is set to 8 data bits). */
  67. uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
  68. This parameter can be a value of @ref UART_Mode. */
  69. uint32_t HwFlowCtl; /*!< Specifies whether the hardware flow control mode is enabled
  70. or disabled.
  71. This parameter can be a value of @ref UART_Hardware_Flow_Control. */
  72. uint32_t OverSampling; /*!< Specifies whether the Over sampling 8 is enabled or disabled, to achieve higher speed (up to f_PCLK/8).
  73. This parameter can be a value of @ref UART_Over_Sampling. */
  74. uint32_t OneBitSampling; /*!< Specifies whether a single sample or three samples' majority vote is selected.
  75. Selecting the single sample method increases the receiver tolerance to clock
  76. deviations. This parameter can be a value of @ref UART_OneBit_Sampling. */
  77. uint32_t ClockPrescaler; /*!< Specifies the prescaler value used to divide the UART clock source.
  78. This parameter can be a value of @ref UART_ClockPrescaler. */
  79. } UART_InitTypeDef;
  80. /**
  81. * @brief UART Advanced Features initialization structure definition
  82. */
  83. typedef struct
  84. {
  85. uint32_t AdvFeatureInit; /*!< Specifies which advanced UART features is initialized. Several
  86. Advanced Features may be initialized at the same time .
  87. This parameter can be a value of @ref UART_Advanced_Features_Initialization_Type. */
  88. uint32_t TxPinLevelInvert; /*!< Specifies whether the TX pin active level is inverted.
  89. This parameter can be a value of @ref UART_Tx_Inv. */
  90. uint32_t RxPinLevelInvert; /*!< Specifies whether the RX pin active level is inverted.
  91. This parameter can be a value of @ref UART_Rx_Inv. */
  92. uint32_t DataInvert; /*!< Specifies whether data are inverted (positive/direct logic
  93. vs negative/inverted logic).
  94. This parameter can be a value of @ref UART_Data_Inv. */
  95. uint32_t Swap; /*!< Specifies whether TX and RX pins are swapped.
  96. This parameter can be a value of @ref UART_Rx_Tx_Swap. */
  97. uint32_t OverrunDisable; /*!< Specifies whether the reception overrun detection is disabled.
  98. This parameter can be a value of @ref UART_Overrun_Disable. */
  99. uint32_t DMADisableonRxError; /*!< Specifies whether the DMA is disabled in case of reception error.
  100. This parameter can be a value of @ref UART_DMA_Disable_on_Rx_Error. */
  101. uint32_t AutoBaudRateEnable; /*!< Specifies whether auto Baud rate detection is enabled.
  102. This parameter can be a value of @ref UART_AutoBaudRate_Enable. */
  103. uint32_t AutoBaudRateMode; /*!< If auto Baud rate detection is enabled, specifies how the rate
  104. detection is carried out.
  105. This parameter can be a value of @ref UART_AutoBaud_Rate_Mode. */
  106. uint32_t MSBFirst; /*!< Specifies whether MSB is sent first on UART line.
  107. This parameter can be a value of @ref UART_MSB_First. */
  108. } UART_AdvFeatureInitTypeDef;
  109. /**
  110. * @brief HAL UART State definition
  111. * @note HAL UART State value is a combination of 2 different substates: gState and RxState (see @ref UART_State_Definition).
  112. * - gState contains UART state information related to global Handle management
  113. * and also information related to Tx operations.
  114. * gState value coding follow below described bitmap :
  115. * b7-b6 Error information
  116. * 00 : No Error
  117. * 01 : (Not Used)
  118. * 10 : Timeout
  119. * 11 : Error
  120. * b5 Peripheral initialization status
  121. * 0 : Reset (Peripheral not initialized)
  122. * 1 : Init done (Peripheral not initialized. HAL UART Init function already called)
  123. * b4-b3 (not used)
  124. * xx : Should be set to 00
  125. * b2 Intrinsic process state
  126. * 0 : Ready
  127. * 1 : Busy (Peripheral busy with some configuration or internal operations)
  128. * b1 (not used)
  129. * x : Should be set to 0
  130. * b0 Tx state
  131. * 0 : Ready (no Tx operation ongoing)
  132. * 1 : Busy (Tx operation ongoing)
  133. * - RxState contains information related to Rx operations.
  134. * RxState value coding follow below described bitmap :
  135. * b7-b6 (not used)
  136. * xx : Should be set to 00
  137. * b5 Peripheral initialization status
  138. * 0 : Reset (Peripheral not initialized)
  139. * 1 : Init done (Peripheral not initialized)
  140. * b4-b2 (not used)
  141. * xxx : Should be set to 000
  142. * b1 Rx state
  143. * 0 : Ready (no Rx operation ongoing)
  144. * 1 : Busy (Rx operation ongoing)
  145. * b0 (not used)
  146. * x : Should be set to 0.
  147. */
  148. typedef uint32_t HAL_UART_StateTypeDef;
  149. /**
  150. * @brief UART clock sources definition
  151. */
  152. typedef enum
  153. {
  154. UART_CLOCKSOURCE_D2PCLK1 = 0x00U, /*!< Domain2 PCLK1 clock source */
  155. UART_CLOCKSOURCE_D2PCLK2 = 0x01U, /*!< Domain2 PCLK2 clock source */
  156. UART_CLOCKSOURCE_D3PCLK1 = 0x02U, /*!< Domain3 PCLK1 clock source */
  157. UART_CLOCKSOURCE_PLL2 = 0x04U, /*!< PLL2Q clock source */
  158. UART_CLOCKSOURCE_PLL3 = 0x08U, /*!< PLL3Q clock source */
  159. UART_CLOCKSOURCE_HSI = 0x10U, /*!< HSI clock source */
  160. UART_CLOCKSOURCE_CSI = 0x20U, /*!< CSI clock source */
  161. UART_CLOCKSOURCE_LSE = 0x40U, /*!< LSE clock source */
  162. UART_CLOCKSOURCE_UNDEFINED = 0x80U /*!< Undefined clock source */
  163. } UART_ClockSourceTypeDef;
  164. /**
  165. * @brief UART handle Structure definition
  166. */
  167. typedef struct __UART_HandleTypeDef
  168. {
  169. USART_TypeDef *Instance; /*!< UART registers base address */
  170. UART_InitTypeDef Init; /*!< UART communication parameters */
  171. UART_AdvFeatureInitTypeDef AdvancedInit; /*!< UART Advanced Features initialization parameters */
  172. uint8_t *pTxBuffPtr; /*!< Pointer to UART Tx transfer Buffer */
  173. uint16_t TxXferSize; /*!< UART Tx Transfer size */
  174. __IO uint16_t TxXferCount; /*!< UART Tx Transfer Counter */
  175. uint8_t *pRxBuffPtr; /*!< Pointer to UART Rx transfer Buffer */
  176. uint16_t RxXferSize; /*!< UART Rx Transfer size */
  177. __IO uint16_t RxXferCount; /*!< UART Rx Transfer Counter */
  178. uint16_t Mask; /*!< UART Rx RDR register mask */
  179. uint32_t FifoMode; /*!< Specifies if the FIFO mode is being used.
  180. This parameter can be a value of @ref UARTEx_FIFO_mode. */
  181. uint16_t NbRxDataToProcess; /*!< Number of data to process during RX ISR execution */
  182. uint16_t NbTxDataToProcess; /*!< Number of data to process during TX ISR execution */
  183. void (*RxISR)(struct __UART_HandleTypeDef *huart); /*!< Function pointer on Rx IRQ handler */
  184. void (*TxISR)(struct __UART_HandleTypeDef *huart); /*!< Function pointer on Tx IRQ handler */
  185. DMA_HandleTypeDef *hdmatx; /*!< UART Tx DMA Handle parameters */
  186. DMA_HandleTypeDef *hdmarx; /*!< UART Rx DMA Handle parameters */
  187. HAL_LockTypeDef Lock; /*!< Locking object */
  188. __IO HAL_UART_StateTypeDef gState; /*!< UART state information related to global Handle management
  189. and also related to Tx operations.
  190. This parameter can be a value of @ref HAL_UART_StateTypeDef */
  191. __IO HAL_UART_StateTypeDef RxState; /*!< UART state information related to Rx operations.
  192. This parameter can be a value of @ref HAL_UART_StateTypeDef */
  193. __IO uint32_t ErrorCode; /*!< UART Error code */
  194. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  195. void (* TxHalfCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Tx Half Complete Callback */
  196. void (* TxCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Tx Complete Callback */
  197. void (* RxHalfCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Rx Half Complete Callback */
  198. void (* RxCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Rx Complete Callback */
  199. void (* ErrorCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Error Callback */
  200. void (* AbortCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Complete Callback */
  201. void (* AbortTransmitCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Transmit Complete Callback */
  202. void (* AbortReceiveCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Receive Complete Callback */
  203. void (* WakeupCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Wakeup Callback */
  204. void (* RxFifoFullCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Rx Fifo Full Callback */
  205. void (* TxFifoEmptyCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Tx Fifo Empty Callback */
  206. void (* MspInitCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Msp Init callback */
  207. void (* MspDeInitCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Msp DeInit callback */
  208. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  209. } UART_HandleTypeDef;
  210. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  211. /**
  212. * @brief HAL UART Callback ID enumeration definition
  213. */
  214. typedef enum
  215. {
  216. HAL_UART_TX_HALFCOMPLETE_CB_ID = 0x00U, /*!< UART Tx Half Complete Callback ID */
  217. HAL_UART_TX_COMPLETE_CB_ID = 0x01U, /*!< UART Tx Complete Callback ID */
  218. HAL_UART_RX_HALFCOMPLETE_CB_ID = 0x02U, /*!< UART Rx Half Complete Callback ID */
  219. HAL_UART_RX_COMPLETE_CB_ID = 0x03U, /*!< UART Rx Complete Callback ID */
  220. HAL_UART_ERROR_CB_ID = 0x04U, /*!< UART Error Callback ID */
  221. HAL_UART_ABORT_COMPLETE_CB_ID = 0x05U, /*!< UART Abort Complete Callback ID */
  222. HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U, /*!< UART Abort Transmit Complete Callback ID */
  223. HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID = 0x07U, /*!< UART Abort Receive Complete Callback ID */
  224. HAL_UART_WAKEUP_CB_ID = 0x08U, /*!< UART Wakeup Callback ID */
  225. HAL_UART_RX_FIFO_FULL_CB_ID = 0x09U, /*!< UART Rx Fifo Full Callback ID */
  226. HAL_UART_TX_FIFO_EMPTY_CB_ID = 0x0AU, /*!< UART Tx Fifo Empty Callback ID */
  227. HAL_UART_MSPINIT_CB_ID = 0x0BU, /*!< UART MspInit callback ID */
  228. HAL_UART_MSPDEINIT_CB_ID = 0x0CU /*!< UART MspDeInit callback ID */
  229. } HAL_UART_CallbackIDTypeDef;
  230. /**
  231. * @brief HAL UART Callback pointer definition
  232. */
  233. typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer to an UART callback function */
  234. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  235. /**
  236. * @}
  237. */
  238. /* Exported constants --------------------------------------------------------*/
  239. /** @defgroup UART_Exported_Constants UART Exported Constants
  240. * @{
  241. */
  242. /** @defgroup UART_State_Definition UART State Code Definition
  243. * @{
  244. */
  245. #define HAL_UART_STATE_RESET 0x00000000U /*!< Peripheral is not initialized
  246. Value is allowed for gState and RxState */
  247. #define HAL_UART_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for use
  248. Value is allowed for gState and RxState */
  249. #define HAL_UART_STATE_BUSY 0x00000024U /*!< an internal process is ongoing
  250. Value is allowed for gState only */
  251. #define HAL_UART_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing
  252. Value is allowed for gState only */
  253. #define HAL_UART_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing
  254. Value is allowed for RxState only */
  255. #define HAL_UART_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception process is ongoing
  256. Not to be used for neither gState nor RxState.
  257. Value is result of combination (Or) between gState and RxState values */
  258. #define HAL_UART_STATE_TIMEOUT 0x000000A0U /*!< Timeout state
  259. Value is allowed for gState only */
  260. #define HAL_UART_STATE_ERROR 0x000000E0U /*!< Error
  261. Value is allowed for gState only */
  262. /**
  263. * @}
  264. */
  265. /** @defgroup UART_Error_Definition UART Error Definition
  266. * @{
  267. */
  268. #define HAL_UART_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
  269. #define HAL_UART_ERROR_PE ((uint32_t)0x00000001U) /*!< Parity error */
  270. #define HAL_UART_ERROR_NE ((uint32_t)0x00000002U) /*!< Noise error */
  271. #define HAL_UART_ERROR_FE ((uint32_t)0x00000004U) /*!< Frame error */
  272. #define HAL_UART_ERROR_ORE ((uint32_t)0x00000008U) /*!< Overrun error */
  273. #define HAL_UART_ERROR_DMA ((uint32_t)0x00000010U) /*!< DMA transfer error */
  274. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  275. #define HAL_UART_ERROR_INVALID_CALLBACK ((uint32_t)0x00000020U) /*!< Invalid Callback error */
  276. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  277. /**
  278. * @}
  279. */
  280. /** @defgroup UART_Stop_Bits UART Number of Stop Bits
  281. * @{
  282. */
  283. #define UART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< UART frame with 0.5 stop bit */
  284. #define UART_STOPBITS_1 0x00000000U /*!< UART frame with 1 stop bit */
  285. #define UART_STOPBITS_1_5 (USART_CR2_STOP_0 | USART_CR2_STOP_1) /*!< UART frame with 1.5 stop bits */
  286. #define UART_STOPBITS_2 USART_CR2_STOP_1 /*!< UART frame with 2 stop bits */
  287. /**
  288. * @}
  289. */
  290. /** @defgroup UART_Parity UART Parity
  291. * @{
  292. */
  293. #define UART_PARITY_NONE 0x00000000U /*!< No parity */
  294. #define UART_PARITY_EVEN USART_CR1_PCE /*!< Even parity */
  295. #define UART_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< Odd parity */
  296. /**
  297. * @}
  298. */
  299. /** @defgroup UART_Hardware_Flow_Control UART Hardware Flow Control
  300. * @{
  301. */
  302. #define UART_HWCONTROL_NONE 0x00000000U /*!< No hardware control */
  303. #define UART_HWCONTROL_RTS USART_CR3_RTSE /*!< Request To Send */
  304. #define UART_HWCONTROL_CTS USART_CR3_CTSE /*!< Clear To Send */
  305. #define UART_HWCONTROL_RTS_CTS (USART_CR3_RTSE | USART_CR3_CTSE) /*!< Request and Clear To Send */
  306. /**
  307. * @}
  308. */
  309. /** @defgroup UART_Mode UART Transfer Mode
  310. * @{
  311. */
  312. #define UART_MODE_RX USART_CR1_RE /*!< RX mode */
  313. #define UART_MODE_TX USART_CR1_TE /*!< TX mode */
  314. #define UART_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< RX and TX mode */
  315. /**
  316. * @}
  317. */
  318. /** @defgroup UART_State UART State
  319. * @{
  320. */
  321. #define UART_STATE_DISABLE 0x00000000U /*!< UART disabled */
  322. #define UART_STATE_ENABLE USART_CR1_UE /*!< UART enabled */
  323. /**
  324. * @}
  325. */
  326. /** @defgroup UART_Over_Sampling UART Over Sampling
  327. * @{
  328. */
  329. #define UART_OVERSAMPLING_16 0x00000000U /*!< Oversampling by 16 */
  330. #define UART_OVERSAMPLING_8 USART_CR1_OVER8 /*!< Oversampling by 8 */
  331. /**
  332. * @}
  333. */
  334. /** @defgroup UART_OneBit_Sampling UART One Bit Sampling Method
  335. * @{
  336. */
  337. #define UART_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< One-bit sampling disable */
  338. #define UART_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< One-bit sampling enable */
  339. /**
  340. * @}
  341. */
  342. /** @defgroup UART_ClockPrescaler UART Clock Prescaler
  343. * @{
  344. */
  345. #define UART_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */
  346. #define UART_PRESCALER_DIV2 0x00000001U /*!< fclk_pres = fclk/2 */
  347. #define UART_PRESCALER_DIV4 0x00000002U /*!< fclk_pres = fclk/4 */
  348. #define UART_PRESCALER_DIV6 0x00000003U /*!< fclk_pres = fclk/6 */
  349. #define UART_PRESCALER_DIV8 0x00000004U /*!< fclk_pres = fclk/8 */
  350. #define UART_PRESCALER_DIV10 0x00000005U /*!< fclk_pres = fclk/10 */
  351. #define UART_PRESCALER_DIV12 0x00000006U /*!< fclk_pres = fclk/12 */
  352. #define UART_PRESCALER_DIV16 0x00000007U /*!< fclk_pres = fclk/16 */
  353. #define UART_PRESCALER_DIV32 0x00000008U /*!< fclk_pres = fclk/32 */
  354. #define UART_PRESCALER_DIV64 0x00000009U /*!< fclk_pres = fclk/64 */
  355. #define UART_PRESCALER_DIV128 0x0000000AU /*!< fclk_pres = fclk/128 */
  356. #define UART_PRESCALER_DIV256 0x0000000BU /*!< fclk_pres = fclk/256 */
  357. /**
  358. * @}
  359. */
  360. /** @defgroup UART_AutoBaud_Rate_Mode UART Advanced Feature AutoBaud Rate Mode
  361. * @{
  362. */
  363. #define UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT 0x00000000U /*!< Auto Baud rate detection on start bit */
  364. #define UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE USART_CR2_ABRMODE_0 /*!< Auto Baud rate detection on falling edge */
  365. #define UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME USART_CR2_ABRMODE_1 /*!< Auto Baud rate detection on 0x7F frame detection */
  366. #define UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME USART_CR2_ABRMODE /*!< Auto Baud rate detection on 0x55 frame detection */
  367. /**
  368. * @}
  369. */
  370. /** @defgroup UART_Receiver_TimeOut UART Receiver TimeOut
  371. * @{
  372. */
  373. #define UART_RECEIVER_TIMEOUT_DISABLE 0x00000000U /*!< UART receiver timeout disable */
  374. #define UART_RECEIVER_TIMEOUT_ENABLE USART_CR2_RTOEN /*!< UART receiver timeout enable */
  375. /**
  376. * @}
  377. */
  378. /** @defgroup UART_LIN UART Local Interconnection Network mode
  379. * @{
  380. */
  381. #define UART_LIN_DISABLE 0x00000000U /*!< Local Interconnect Network disable */
  382. #define UART_LIN_ENABLE USART_CR2_LINEN /*!< Local Interconnect Network enable */
  383. /**
  384. * @}
  385. */
  386. /** @defgroup UART_LIN_Break_Detection UART LIN Break Detection
  387. * @{
  388. */
  389. #define UART_LINBREAKDETECTLENGTH_10B 0x00000000U /*!< LIN 10-bit break detection length */
  390. #define UART_LINBREAKDETECTLENGTH_11B USART_CR2_LBDL /*!< LIN 11-bit break detection length */
  391. /**
  392. * @}
  393. */
  394. /** @defgroup UART_DMA_Tx UART DMA Tx
  395. * @{
  396. */
  397. #define UART_DMA_TX_DISABLE 0x00000000U /*!< UART DMA TX disabled */
  398. #define UART_DMA_TX_ENABLE USART_CR3_DMAT /*!< UART DMA TX enabled */
  399. /**
  400. * @}
  401. */
  402. /** @defgroup UART_DMA_Rx UART DMA Rx
  403. * @{
  404. */
  405. #define UART_DMA_RX_DISABLE 0x00000000U /*!< UART DMA RX disabled */
  406. #define UART_DMA_RX_ENABLE USART_CR3_DMAR /*!< UART DMA RX enabled */
  407. /**
  408. * @}
  409. */
  410. /** @defgroup UART_Half_Duplex_Selection UART Half Duplex Selection
  411. * @{
  412. */
  413. #define UART_HALF_DUPLEX_DISABLE 0x00000000U /*!< UART half-duplex disabled */
  414. #define UART_HALF_DUPLEX_ENABLE USART_CR3_HDSEL /*!< UART half-duplex enabled */
  415. /**
  416. * @}
  417. */
  418. /** @defgroup UART_WakeUp_Methods UART WakeUp Methods
  419. * @{
  420. */
  421. #define UART_WAKEUPMETHOD_IDLELINE 0x00000000U /*!< UART wake-up on idle line */
  422. #define UART_WAKEUPMETHOD_ADDRESSMARK USART_CR1_WAKE /*!< UART wake-up on address mark */
  423. /**
  424. * @}
  425. */
  426. /** @defgroup UART_Request_Parameters UART Request Parameters
  427. * @{
  428. */
  429. #define UART_AUTOBAUD_REQUEST USART_RQR_ABRRQ /*!< Auto-Baud Rate Request */
  430. #define UART_SENDBREAK_REQUEST USART_RQR_SBKRQ /*!< Send Break Request */
  431. #define UART_MUTE_MODE_REQUEST USART_RQR_MMRQ /*!< Mute Mode Request */
  432. #define UART_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */
  433. #define UART_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush Request */
  434. /**
  435. * @}
  436. */
  437. /** @defgroup UART_Advanced_Features_Initialization_Type UART Advanced Feature Initialization Type
  438. * @{
  439. */
  440. #define UART_ADVFEATURE_NO_INIT 0x00000000U /*!< No advanced feature initialization */
  441. #define UART_ADVFEATURE_TXINVERT_INIT 0x00000001U /*!< TX pin active level inversion */
  442. #define UART_ADVFEATURE_RXINVERT_INIT 0x00000002U /*!< RX pin active level inversion */
  443. #define UART_ADVFEATURE_DATAINVERT_INIT 0x00000004U /*!< Binary data inversion */
  444. #define UART_ADVFEATURE_SWAP_INIT 0x00000008U /*!< TX/RX pins swap */
  445. #define UART_ADVFEATURE_RXOVERRUNDISABLE_INIT 0x00000010U /*!< RX overrun disable */
  446. #define UART_ADVFEATURE_DMADISABLEONERROR_INIT 0x00000020U /*!< DMA disable on Reception Error */
  447. #define UART_ADVFEATURE_AUTOBAUDRATE_INIT 0x00000040U /*!< Auto Baud rate detection initialization */
  448. #define UART_ADVFEATURE_MSBFIRST_INIT 0x00000080U /*!< Most significant bit sent/received first */
  449. /**
  450. * @}
  451. */
  452. /** @defgroup UART_Tx_Inv UART Advanced Feature TX Pin Active Level Inversion
  453. * @{
  454. */
  455. #define UART_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */
  456. #define UART_ADVFEATURE_TXINV_ENABLE USART_CR2_TXINV /*!< TX pin active level inversion enable */
  457. /**
  458. * @}
  459. */
  460. /** @defgroup UART_Rx_Inv UART Advanced Feature RX Pin Active Level Inversion
  461. * @{
  462. */
  463. #define UART_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */
  464. #define UART_ADVFEATURE_RXINV_ENABLE USART_CR2_RXINV /*!< RX pin active level inversion enable */
  465. /**
  466. * @}
  467. */
  468. /** @defgroup UART_Data_Inv UART Advanced Feature Binary Data Inversion
  469. * @{
  470. */
  471. #define UART_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */
  472. #define UART_ADVFEATURE_DATAINV_ENABLE USART_CR2_DATAINV /*!< Binary data inversion enable */
  473. /**
  474. * @}
  475. */
  476. /** @defgroup UART_Rx_Tx_Swap UART Advanced Feature RX TX Pins Swap
  477. * @{
  478. */
  479. #define UART_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */
  480. #define UART_ADVFEATURE_SWAP_ENABLE USART_CR2_SWAP /*!< TX/RX pins swap enable */
  481. /**
  482. * @}
  483. */
  484. /** @defgroup UART_Overrun_Disable UART Advanced Feature Overrun Disable
  485. * @{
  486. */
  487. #define UART_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */
  488. #define UART_ADVFEATURE_OVERRUN_DISABLE USART_CR3_OVRDIS /*!< RX overrun disable */
  489. /**
  490. * @}
  491. */
  492. /** @defgroup UART_AutoBaudRate_Enable UART Advanced Feature Auto BaudRate Enable
  493. * @{
  494. */
  495. #define UART_ADVFEATURE_AUTOBAUDRATE_DISABLE 0x00000000U /*!< RX Auto Baud rate detection enable */
  496. #define UART_ADVFEATURE_AUTOBAUDRATE_ENABLE USART_CR2_ABREN /*!< RX Auto Baud rate detection disable */
  497. /**
  498. * @}
  499. */
  500. /** @defgroup UART_DMA_Disable_on_Rx_Error UART Advanced Feature DMA Disable On Rx Error
  501. * @{
  502. */
  503. #define UART_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */
  504. #define UART_ADVFEATURE_DMA_DISABLEONRXERROR USART_CR3_DDRE /*!< DMA disable on Reception Error */
  505. /**
  506. * @}
  507. */
  508. /** @defgroup UART_MSB_First UART Advanced Feature MSB First
  509. * @{
  510. */
  511. #define UART_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received first disable */
  512. #define UART_ADVFEATURE_MSBFIRST_ENABLE USART_CR2_MSBFIRST /*!< Most significant bit sent/received first enable */
  513. /**
  514. * @}
  515. */
  516. /** @defgroup UART_Stop_Mode_Enable UART Advanced Feature Stop Mode Enable
  517. * @{
  518. */
  519. #define UART_ADVFEATURE_STOPMODE_DISABLE 0x00000000U /*!< UART stop mode disable */
  520. #define UART_ADVFEATURE_STOPMODE_ENABLE USART_CR1_UESM /*!< UART stop mode enable */
  521. /**
  522. * @}
  523. */
  524. /** @defgroup UART_Mute_Mode UART Advanced Feature Mute Mode Enable
  525. * @{
  526. */
  527. #define UART_ADVFEATURE_MUTEMODE_DISABLE 0x00000000U /*!< UART mute mode disable */
  528. #define UART_ADVFEATURE_MUTEMODE_ENABLE USART_CR1_MME /*!< UART mute mode enable */
  529. /**
  530. * @}
  531. */
  532. /** @defgroup UART_CR2_ADDRESS_LSB_POS UART Address-matching LSB Position In CR2 Register
  533. * @{
  534. */
  535. #define UART_CR2_ADDRESS_LSB_POS 24U /*!< UART address-matching LSB position in CR2 register */
  536. /**
  537. * @}
  538. */
  539. /** @defgroup UART_WakeUp_from_Stop_Selection UART WakeUp From Stop Selection
  540. * @{
  541. */
  542. #define UART_WAKEUP_ON_ADDRESS 0x00000000U /*!< UART wake-up on address */
  543. #define UART_WAKEUP_ON_STARTBIT USART_CR3_WUS_1 /*!< UART wake-up on start bit */
  544. #define UART_WAKEUP_ON_READDATA_NONEMPTY USART_CR3_WUS /*!< UART wake-up on receive data register not empty or RXFIFO is not empty */
  545. /**
  546. * @}
  547. */
  548. /** @defgroup UART_DriverEnable_Polarity UART DriverEnable Polarity
  549. * @{
  550. */
  551. #define UART_DE_POLARITY_HIGH 0x00000000U /*!< Driver enable signal is active high */
  552. #define UART_DE_POLARITY_LOW USART_CR3_DEP /*!< Driver enable signal is active low */
  553. /**
  554. * @}
  555. */
  556. /** @defgroup UART_CR1_DEAT_ADDRESS_LSB_POS UART Driver Enable Assertion Time LSB Position In CR1 Register
  557. * @{
  558. */
  559. #define UART_CR1_DEAT_ADDRESS_LSB_POS 21U /*!< UART Driver Enable assertion time LSB position in CR1 register */
  560. /**
  561. * @}
  562. */
  563. /** @defgroup UART_CR1_DEDT_ADDRESS_LSB_POS UART Driver Enable DeAssertion Time LSB Position In CR1 Register
  564. * @{
  565. */
  566. #define UART_CR1_DEDT_ADDRESS_LSB_POS 16U /*!< UART Driver Enable de-assertion time LSB position in CR1 register */
  567. /**
  568. * @}
  569. */
  570. /** @defgroup UART_Interruption_Mask UART Interruptions Flag Mask
  571. * @{
  572. */
  573. #define UART_IT_MASK 0x001FU /*!< UART interruptions flags mask */
  574. /**
  575. * @}
  576. */
  577. /** @defgroup UART_TimeOut_Value UART polling-based communications time-out value
  578. * @{
  579. */
  580. #define HAL_UART_TIMEOUT_VALUE 0x1FFFFFFU /*!< UART polling-based communications time-out value */
  581. /**
  582. * @}
  583. */
  584. /** @defgroup UART_Flags UART Status Flags
  585. * Elements values convention: 0xXXXX
  586. * - 0xXXXX : Flag mask in the ISR register
  587. * @{
  588. */
  589. #define UART_FLAG_TXFT USART_ISR_TXFT /*!< UART TXFIFO threshold flag */
  590. #define UART_FLAG_RXFT USART_ISR_RXFT /*!< UART RXFIFO threshold flag */
  591. #define UART_FLAG_RXFF USART_ISR_RXFF /*!< UART RXFIFO Full flag */
  592. #define UART_FLAG_TXFE USART_ISR_TXFE /*!< UART TXFIFO Empty flag */
  593. #define UART_FLAG_REACK USART_ISR_REACK /*!< UART receive enable acknowledge flag */
  594. #define UART_FLAG_TEACK USART_ISR_TEACK /*!< UART transmit enable acknowledge flag */
  595. #define UART_FLAG_WUF USART_ISR_WUF /*!< UART wake-up from stop mode flag */
  596. #define UART_FLAG_RWU USART_ISR_RWU /*!< UART receiver wake-up from mute mode flag */
  597. #define UART_FLAG_SBKF USART_ISR_SBKF /*!< UART send break flag */
  598. #define UART_FLAG_CMF USART_ISR_CMF /*!< UART character match flag */
  599. #define UART_FLAG_BUSY USART_ISR_BUSY /*!< UART busy flag */
  600. #define UART_FLAG_ABRF USART_ISR_ABRF /*!< UART auto Baud rate flag */
  601. #define UART_FLAG_ABRE USART_ISR_ABRE /*!< UART auto Baud rate error */
  602. #define UART_FLAG_CTS USART_ISR_CTS /*!< UART clear to send flag */
  603. #define UART_FLAG_CTSIF USART_ISR_CTSIF /*!< UART clear to send interrupt flag */
  604. #define UART_FLAG_LBDF USART_ISR_LBDF /*!< UART LIN break detection flag */
  605. #define UART_FLAG_TXE USART_ISR_TXE_TXFNF /*!< UART transmit data register empty */
  606. #define UART_FLAG_TXFNF USART_ISR_TXE_TXFNF /*!< UART TXFIFO not full */
  607. #define UART_FLAG_TC USART_ISR_TC /*!< UART transmission complete */
  608. #define UART_FLAG_RXNE USART_ISR_RXNE_RXFNE /*!< UART read data register not empty */
  609. #define UART_FLAG_RXFNE USART_ISR_RXNE_RXFNE /*!< UART RXFIFO not empty */
  610. #define UART_FLAG_IDLE USART_ISR_IDLE /*!< UART idle flag */
  611. #define UART_FLAG_ORE USART_ISR_ORE /*!< UART overrun error */
  612. #define UART_FLAG_NE USART_ISR_NE /*!< UART noise error */
  613. #define UART_FLAG_FE USART_ISR_FE /*!< UART frame error */
  614. #define UART_FLAG_PE USART_ISR_PE /*!< UART parity error */
  615. /**
  616. * @}
  617. */
  618. /** @defgroup UART_Interrupt_definition UART Interrupts Definition
  619. * Elements values convention: 000ZZZZZ0XXYYYYYb
  620. * - YYYYY : Interrupt source position in the XX register (5bits)
  621. * - XX : Interrupt source register (2bits)
  622. * - 01: CR1 register
  623. * - 10: CR2 register
  624. * - 11: CR3 register
  625. * - ZZZZZ : Flag position in the ISR register(5bits)
  626. * Elements values convention: 000000000XXYYYYYb
  627. * - YYYYY : Interrupt source position in the XX register (5bits)
  628. * - XX : Interrupt source register (2bits)
  629. * - 01: CR1 register
  630. * - 10: CR2 register
  631. * - 11: CR3 register
  632. * Elements values convention: 0000ZZZZ00000000b
  633. * - ZZZZ : Flag position in the ISR register(4bits)
  634. * @{
  635. */
  636. #define UART_IT_PE 0x0028U /*!< UART parity error interruption */
  637. #define UART_IT_TXE 0x0727U /*!< UART transmit data register empty interruption */
  638. #define UART_IT_TXFNF 0x0727U /*!< UART TX FIFO not full interruption */
  639. #define UART_IT_TC 0x0626U /*!< UART transmission complete interruption */
  640. #define UART_IT_RXNE 0x0525U /*!< UART read data register not empty interruption */
  641. #define UART_IT_RXFNE 0x0525U /*!< UART RXFIFO not empty interruption */
  642. #define UART_IT_IDLE 0x0424U /*!< UART idle interruption */
  643. #define UART_IT_LBD 0x0846U /*!< UART LIN break detection interruption */
  644. #define UART_IT_CTS 0x096AU /*!< UART CTS interruption */
  645. #define UART_IT_CM 0x112EU /*!< UART character match interruption */
  646. #define UART_IT_WUF 0x1476U /*!< UART wake-up from stop mode interruption */
  647. #define UART_IT_RXFF 0x183FU /*!< UART RXFIFO full interruption */
  648. #define UART_IT_TXFE 0x173EU /*!< UART TXFIFO empty interruption */
  649. #define UART_IT_RXFT 0x1A7CU /*!< UART RXFIFO threshold reached interruption */
  650. #define UART_IT_TXFT 0x1B77U /*!< UART TXFIFO threshold reached interruption */
  651. #define UART_IT_ERR 0x0060U /*!< UART error interruption */
  652. #define UART_IT_ORE 0x0300U /*!< UART overrun error interruption */
  653. #define UART_IT_NE 0x0200U /*!< UART noise error interruption */
  654. #define UART_IT_FE 0x0100U /*!< UART frame error interruption */
  655. /**
  656. * @}
  657. */
  658. /** @defgroup UART_IT_CLEAR_Flags UART Interruption Clear Flags
  659. * @{
  660. */
  661. #define UART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
  662. #define UART_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
  663. #define UART_CLEAR_NEF USART_ICR_NECF /*!< Noise Error detected Clear Flag */
  664. #define UART_CLEAR_OREF USART_ICR_ORECF /*!< Overrun Error Clear Flag */
  665. #define UART_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */
  666. #define UART_CLEAR_TXFECF USART_ICR_TXFECF /*!< TXFIFO empty clear flag */
  667. #define UART_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
  668. #define UART_CLEAR_LBDF USART_ICR_LBDCF /*!< LIN Break Detection Clear Flag */
  669. #define UART_CLEAR_CTSF USART_ICR_CTSCF /*!< CTS Interrupt Clear Flag */
  670. #define UART_CLEAR_CMF USART_ICR_CMCF /*!< Character Match Clear Flag */
  671. #define UART_CLEAR_WUF USART_ICR_WUCF /*!< Wake Up from stop mode Clear Flag */
  672. /**
  673. * @}
  674. */
  675. /**
  676. * @}
  677. */
  678. /* Exported macros -----------------------------------------------------------*/
  679. /** @defgroup UART_Exported_Macros UART Exported Macros
  680. * @{
  681. */
  682. /** @brief Reset UART handle states.
  683. * @param __HANDLE__ UART handle.
  684. * @retval None
  685. */
  686. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  687. #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \
  688. (__HANDLE__)->gState = HAL_UART_STATE_RESET; \
  689. (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \
  690. (__HANDLE__)->MspInitCallback = NULL; \
  691. (__HANDLE__)->MspDeInitCallback = NULL; \
  692. } while(0U)
  693. #else
  694. #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \
  695. (__HANDLE__)->gState = HAL_UART_STATE_RESET; \
  696. (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \
  697. } while(0U)
  698. #endif /*USE_HAL_UART_REGISTER_CALLBACKS */
  699. /** @brief Flush the UART Data registers.
  700. * @param __HANDLE__ specifies the UART Handle.
  701. * @retval None
  702. */
  703. #define __HAL_UART_FLUSH_DRREGISTER(__HANDLE__) \
  704. do{ \
  705. SET_BIT((__HANDLE__)->Instance->RQR, UART_RXDATA_FLUSH_REQUEST); \
  706. SET_BIT((__HANDLE__)->Instance->RQR, UART_TXDATA_FLUSH_REQUEST); \
  707. } while(0U)
  708. /** @brief Clear the specified UART pending flag.
  709. * @param __HANDLE__ specifies the UART Handle.
  710. * @param __FLAG__ specifies the flag to check.
  711. * This parameter can be any combination of the following values:
  712. * @arg @ref UART_CLEAR_PEF Parity Error Clear Flag
  713. * @arg @ref UART_CLEAR_FEF Framing Error Clear Flag
  714. * @arg @ref UART_CLEAR_NEF Noise detected Clear Flag
  715. * @arg @ref UART_CLEAR_OREF Overrun Error Clear Flag
  716. * @arg @ref UART_CLEAR_IDLEF IDLE line detected Clear Flag
  717. * @arg @ref UART_CLEAR_TXFECF TXFIFO empty clear Flag
  718. * @arg @ref UART_CLEAR_TCF Transmission Complete Clear Flag
  719. * @arg @ref UART_CLEAR_LBDF LIN Break Detection Clear Flag
  720. * @arg @ref UART_CLEAR_CTSF CTS Interrupt Clear Flag
  721. * @arg @ref UART_CLEAR_CMF Character Match Clear Flag
  722. * @arg @ref UART_CLEAR_WUF Wake Up from stop mode Clear Flag
  723. * @retval None
  724. */
  725. #define __HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  726. /** @brief Clear the UART PE pending flag.
  727. * @param __HANDLE__ specifies the UART Handle.
  728. * @retval None
  729. */
  730. #define __HAL_UART_CLEAR_PEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_PEF)
  731. /** @brief Clear the UART FE pending flag.
  732. * @param __HANDLE__ specifies the UART Handle.
  733. * @retval None
  734. */
  735. #define __HAL_UART_CLEAR_FEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_FEF)
  736. /** @brief Clear the UART NE pending flag.
  737. * @param __HANDLE__ specifies the UART Handle.
  738. * @retval None
  739. */
  740. #define __HAL_UART_CLEAR_NEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_NEF)
  741. /** @brief Clear the UART ORE pending flag.
  742. * @param __HANDLE__ specifies the UART Handle.
  743. * @retval None
  744. */
  745. #define __HAL_UART_CLEAR_OREFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_OREF)
  746. /** @brief Clear the UART IDLE pending flag.
  747. * @param __HANDLE__ specifies the UART Handle.
  748. * @retval None
  749. */
  750. #define __HAL_UART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_IDLEF)
  751. /** @brief Clear the UART TX FIFO empty clear flag.
  752. * @param __HANDLE__ specifies the UART Handle.
  753. * @retval None
  754. */
  755. #define __HAL_UART_CLEAR_TXFECF(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_TXFECF)
  756. /** @brief Check whether the specified UART flag is set or not.
  757. * @param __HANDLE__ specifies the UART Handle.
  758. * @param __FLAG__ specifies the flag to check.
  759. * This parameter can be one of the following values:
  760. * @arg @ref UART_FLAG_TXFT TXFIFO threshold flag
  761. * @arg @ref UART_FLAG_RXFT RXFIFO threshold flag
  762. * @arg @ref UART_FLAG_RXFF RXFIFO Full flag
  763. * @arg @ref UART_FLAG_TXFE TXFIFO Empty flag
  764. * @arg @ref UART_FLAG_REACK Receive enable acknowledge flag
  765. * @arg @ref UART_FLAG_TEACK Transmit enable acknowledge flag
  766. * @arg @ref UART_FLAG_WUF Wake up from stop mode flag
  767. * @arg @ref UART_FLAG_RWU Receiver wake up flag (if the UART in mute mode)
  768. * @arg @ref UART_FLAG_SBKF Send Break flag
  769. * @arg @ref UART_FLAG_CMF Character match flag
  770. * @arg @ref UART_FLAG_BUSY Busy flag
  771. * @arg @ref UART_FLAG_ABRF Auto Baud rate detection flag
  772. * @arg @ref UART_FLAG_ABRE Auto Baud rate detection error flag
  773. * @arg @ref UART_FLAG_CTS CTS Change flag
  774. * @arg @ref UART_FLAG_LBDF LIN Break detection flag
  775. * @arg @ref UART_FLAG_TXE Transmit data register empty flag
  776. * @arg @ref UART_FLAG_TXFNF UART TXFIFO not full flag
  777. * @arg @ref UART_FLAG_TC Transmission Complete flag
  778. * @arg @ref UART_FLAG_RXNE Receive data register not empty flag
  779. * @arg @ref UART_FLAG_RXFNE UART RXFIFO not empty flag
  780. * @arg @ref UART_FLAG_IDLE Idle Line detection flag
  781. * @arg @ref UART_FLAG_ORE Overrun Error flag
  782. * @arg @ref UART_FLAG_NE Noise Error flag
  783. * @arg @ref UART_FLAG_FE Framing Error flag
  784. * @arg @ref UART_FLAG_PE Parity Error flag
  785. * @retval The new state of __FLAG__ (TRUE or FALSE).
  786. */
  787. #define __HAL_UART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
  788. /** @brief Enable the specified UART interrupt.
  789. * @param __HANDLE__ specifies the UART Handle.
  790. * @param __INTERRUPT__ specifies the UART interrupt source to enable.
  791. * This parameter can be one of the following values:
  792. * @arg @ref UART_IT_RXFF RXFIFO Full interrupt
  793. * @arg @ref UART_IT_TXFE TXFIFO Empty interrupt
  794. * @arg @ref UART_IT_RXFT RXFIFO threshold interrupt
  795. * @arg @ref UART_IT_TXFT TXFIFO threshold interrupt
  796. * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt
  797. * @arg @ref UART_IT_CM Character match interrupt
  798. * @arg @ref UART_IT_CTS CTS change interrupt
  799. * @arg @ref UART_IT_LBD LIN Break detection interrupt
  800. * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
  801. * @arg @ref UART_IT_TXFNF TX FIFO not full interrupt
  802. * @arg @ref UART_IT_TC Transmission complete interrupt
  803. * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
  804. * @arg @ref UART_IT_RXFNE RXFIFO not empty interrupt
  805. * @arg @ref UART_IT_IDLE Idle line detection interrupt
  806. * @arg @ref UART_IT_PE Parity Error interrupt
  807. * @arg @ref UART_IT_ERR Error interrupt (frame error, noise error, overrun error)
  808. * @retval None
  809. */
  810. #define __HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
  811. ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
  812. ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & UART_IT_MASK))))
  813. /** @brief Disable the specified UART interrupt.
  814. * @param __HANDLE__ specifies the UART Handle.
  815. * @param __INTERRUPT__ specifies the UART interrupt source to disable.
  816. * This parameter can be one of the following values:
  817. * @arg @ref UART_IT_RXFF RXFIFO Full interrupt
  818. * @arg @ref UART_IT_TXFE TXFIFO Empty interrupt
  819. * @arg @ref UART_IT_RXFT RXFIFO threshold interrupt
  820. * @arg @ref UART_IT_TXFT TXFIFO threshold interrupt
  821. * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt
  822. * @arg @ref UART_IT_CM Character match interrupt
  823. * @arg @ref UART_IT_CTS CTS change interrupt
  824. * @arg @ref UART_IT_LBD LIN Break detection interrupt
  825. * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
  826. * @arg @ref UART_IT_TXFNF TX FIFO not full interrupt
  827. * @arg @ref UART_IT_TC Transmission complete interrupt
  828. * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
  829. * @arg @ref UART_IT_RXFNE RXFIFO not empty interrupt
  830. * @arg @ref UART_IT_IDLE Idle line detection interrupt
  831. * @arg @ref UART_IT_PE Parity Error interrupt
  832. * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)
  833. * @retval None
  834. */
  835. #define __HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
  836. ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & UART_IT_MASK))): \
  837. ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & UART_IT_MASK))))
  838. /** @brief Check whether the specified UART interrupt has occurred or not.
  839. * @param __HANDLE__ specifies the UART Handle.
  840. * @param __INTERRUPT__ specifies the UART interrupt to check.
  841. * This parameter can be one of the following values:
  842. * @arg @ref UART_IT_RXFF RXFIFO Full interrupt
  843. * @arg @ref UART_IT_TXFE TXFIFO Empty interrupt
  844. * @arg @ref UART_IT_RXFT RXFIFO threshold interrupt
  845. * @arg @ref UART_IT_TXFT TXFIFO threshold interrupt
  846. * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt
  847. * @arg @ref UART_IT_CM Character match interrupt
  848. * @arg @ref UART_IT_CTS CTS change interrupt
  849. * @arg @ref UART_IT_LBD LIN Break detection interrupt
  850. * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
  851. * @arg @ref UART_IT_TXFNF TX FIFO not full interrupt
  852. * @arg @ref UART_IT_TC Transmission complete interrupt
  853. * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
  854. * @arg @ref UART_IT_RXFNE RXFIFO not empty interrupt
  855. * @arg @ref UART_IT_IDLE Idle line detection interrupt
  856. * @arg @ref UART_IT_PE Parity Error interrupt
  857. * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)
  858. * @retval The new state of __INTERRUPT__ (SET or RESET).
  859. */
  860. #define __HAL_UART_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR & (1U << ((__INTERRUPT__)>> 8U))) != RESET) ? SET : RESET)
  861. /** @brief Check whether the specified UART interrupt source is enabled or not.
  862. * @param __HANDLE__ specifies the UART Handle.
  863. * @param __INTERRUPT__ specifies the UART interrupt source to check.
  864. * This parameter can be one of the following values:
  865. * @arg @ref UART_IT_RXFF RXFIFO Full interrupt
  866. * @arg @ref UART_IT_TXFE TXFIFO Empty interrupt
  867. * @arg @ref UART_IT_RXFT RXFIFO threshold interrupt
  868. * @arg @ref UART_IT_TXFT TXFIFO threshold interrupt
  869. * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt
  870. * @arg @ref UART_IT_CM Character match interrupt
  871. * @arg @ref UART_IT_CTS CTS change interrupt
  872. * @arg @ref UART_IT_LBD LIN Break detection interrupt
  873. * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt
  874. * @arg @ref UART_IT_TXFNF TX FIFO not full interrupt
  875. * @arg @ref UART_IT_TC Transmission complete interrupt
  876. * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt
  877. * @arg @ref UART_IT_RXFNE RXFIFO not empty interrupt
  878. * @arg @ref UART_IT_IDLE Idle line detection interrupt
  879. * @arg @ref UART_IT_PE Parity Error interrupt
  880. * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error)
  881. * @retval The new state of __INTERRUPT__ (SET or RESET).
  882. */
  883. #define __HAL_UART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U) ? (__HANDLE__)->Instance->CR1 : \
  884. (((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U) ? (__HANDLE__)->Instance->CR2 : \
  885. (__HANDLE__)->Instance->CR3)) & (1U << (((uint16_t)(__INTERRUPT__)) & UART_IT_MASK))) != RESET) ? SET : RESET)
  886. /** @brief Clear the specified UART ISR flag, in setting the proper ICR register flag.
  887. * @param __HANDLE__ specifies the UART Handle.
  888. * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
  889. * to clear the corresponding interrupt
  890. * This parameter can be one of the following values:
  891. * @arg @ref UART_CLEAR_PEF Parity Error Clear Flag
  892. * @arg @ref UART_CLEAR_FEF Framing Error Clear Flag
  893. * @arg @ref UART_CLEAR_NEF Noise detected Clear Flag
  894. * @arg @ref UART_CLEAR_OREF Overrun Error Clear Flag
  895. * @arg @ref UART_CLEAR_IDLEF IDLE line detected Clear Flag
  896. * @arg @ref UART_CLEAR_TXFECF TXFIFO empty Clear Flag
  897. * @arg @ref UART_CLEAR_TCF Transmission Complete Clear Flag
  898. * @arg @ref UART_CLEAR_LBDF LIN Break Detection Clear Flag
  899. * @arg @ref UART_CLEAR_CTSF CTS Interrupt Clear Flag
  900. * @arg @ref UART_CLEAR_CMF Character Match Clear Flag
  901. * @arg @ref UART_CLEAR_WUF Wake Up from stop mode Clear Flag
  902. * @retval None
  903. */
  904. #define __HAL_UART_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
  905. /** @brief Set a specific UART request flag.
  906. * @param __HANDLE__ specifies the UART Handle.
  907. * @param __REQ__ specifies the request flag to set
  908. * This parameter can be one of the following values:
  909. * @arg @ref UART_AUTOBAUD_REQUEST Auto-Baud Rate Request
  910. * @arg @ref UART_SENDBREAK_REQUEST Send Break Request
  911. * @arg @ref UART_MUTE_MODE_REQUEST Mute Mode Request
  912. * @arg @ref UART_RXDATA_FLUSH_REQUEST Receive Data flush Request
  913. * @arg @ref UART_TXDATA_FLUSH_REQUEST Transmit data flush Request
  914. * @retval None
  915. */
  916. #define __HAL_UART_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
  917. /** @brief Enable the UART one bit sample method.
  918. * @param __HANDLE__ specifies the UART Handle.
  919. * @retval None
  920. */
  921. #define __HAL_UART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
  922. /** @brief Disable the UART one bit sample method.
  923. * @param __HANDLE__ specifies the UART Handle.
  924. * @retval None
  925. */
  926. #define __HAL_UART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT)
  927. /** @brief Enable UART.
  928. * @param __HANDLE__ specifies the UART Handle.
  929. * @retval None
  930. */
  931. #define __HAL_UART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
  932. /** @brief Disable UART.
  933. * @param __HANDLE__ specifies the UART Handle.
  934. * @retval None
  935. */
  936. #define __HAL_UART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
  937. /** @brief Enable CTS flow control.
  938. * @note This macro allows to enable CTS hardware flow control for a given UART instance,
  939. * without need to call HAL_UART_Init() function.
  940. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  941. * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
  942. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  943. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  944. * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
  945. * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
  946. * @param __HANDLE__ specifies the UART Handle.
  947. * @retval None
  948. */
  949. #define __HAL_UART_HWCONTROL_CTS_ENABLE(__HANDLE__) \
  950. do{ \
  951. SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
  952. (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_CTSE; \
  953. } while(0U)
  954. /** @brief Disable CTS flow control.
  955. * @note This macro allows to disable CTS hardware flow control for a given UART instance,
  956. * without need to call HAL_UART_Init() function.
  957. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  958. * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need
  959. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  960. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  961. * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
  962. * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
  963. * @param __HANDLE__ specifies the UART Handle.
  964. * @retval None
  965. */
  966. #define __HAL_UART_HWCONTROL_CTS_DISABLE(__HANDLE__) \
  967. do{ \
  968. CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \
  969. (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_CTSE); \
  970. } while(0U)
  971. /** @brief Enable RTS flow control.
  972. * @note This macro allows to enable RTS hardware flow control for a given UART instance,
  973. * without need to call HAL_UART_Init() function.
  974. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  975. * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
  976. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  977. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  978. * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
  979. * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
  980. * @param __HANDLE__ specifies the UART Handle.
  981. * @retval None
  982. */
  983. #define __HAL_UART_HWCONTROL_RTS_ENABLE(__HANDLE__) \
  984. do{ \
  985. SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE); \
  986. (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_RTSE; \
  987. } while(0U)
  988. /** @brief Disable RTS flow control.
  989. * @note This macro allows to disable RTS hardware flow control for a given UART instance,
  990. * without need to call HAL_UART_Init() function.
  991. * As involving direct access to UART registers, usage of this macro should be fully endorsed by user.
  992. * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need
  993. * for USART instance Deinit/Init, following conditions for macro call should be fulfilled :
  994. * - UART instance should have already been initialised (through call of HAL_UART_Init() )
  995. * - macro could only be called when corresponding UART instance is disabled (i.e. __HAL_UART_DISABLE(__HANDLE__))
  996. * and should be followed by an Enable macro (i.e. __HAL_UART_ENABLE(__HANDLE__)).
  997. * @param __HANDLE__ specifies the UART Handle.
  998. * @retval None
  999. */
  1000. #define __HAL_UART_HWCONTROL_RTS_DISABLE(__HANDLE__) \
  1001. do{ \
  1002. CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE);\
  1003. (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_RTSE); \
  1004. } while(0U)
  1005. /**
  1006. * @}
  1007. */
  1008. /* Private macros --------------------------------------------------------*/
  1009. /** @defgroup UART_Private_Macros UART Private Macros
  1010. * @{
  1011. */
  1012. /** @brief Get UART clok division factor from clock prescaler value.
  1013. * @param __CLOCKPRESCALER__ UART prescaler value.
  1014. * @retval UART clock division factor
  1015. */
  1016. #define UART_GET_DIV_FACTOR(__CLOCKPRESCALER__) \
  1017. (((__CLOCKPRESCALER__) == UART_PRESCALER_DIV1) ? 1U : \
  1018. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV2) ? 2U : \
  1019. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV4) ? 4U : \
  1020. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV6) ? 6U : \
  1021. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV8) ? 8U : \
  1022. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV10) ? 10U : \
  1023. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV12) ? 12U : \
  1024. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV16) ? 16U : \
  1025. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV32) ? 32U : \
  1026. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV64) ? 64U : \
  1027. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV128) ? 128U : \
  1028. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV256) ? 256U : 1U)
  1029. /** @brief BRR division operation to set BRR register with LPUART.
  1030. * @param __PCLK__ LPUART clock.
  1031. * @param __BAUD__ Baud rate set by the user.
  1032. * @param __CLOCKPRESCALER__ UART prescaler value.
  1033. * @retval Division result
  1034. */
  1035. #define UART_DIV_LPUART(__PCLK__, __BAUD__, __CLOCKPRESCALER__) ((uint32_t)(((((uint64_t)(__PCLK__)/UART_GET_DIV_FACTOR((__CLOCKPRESCALER__)))*256U) + (uint32_t)((__BAUD__)/2U)) / (__BAUD__)))
  1036. /** @brief BRR division operation to set BRR register in 8-bit oversampling mode.
  1037. * @param __PCLK__ UART clock.
  1038. * @param __BAUD__ Baud rate set by the user.
  1039. * @param __CLOCKPRESCALER__ UART prescaler value.
  1040. * @retval Division result
  1041. */
  1042. #define UART_DIV_SAMPLING8(__PCLK__, __BAUD__, __CLOCKPRESCALER__) (((((__PCLK__)/UART_GET_DIV_FACTOR((__CLOCKPRESCALER__)))*2U) + ((__BAUD__)/2U)) / (__BAUD__))
  1043. /** @brief BRR division operation to set BRR register in 16-bit oversampling mode.
  1044. * @param __PCLK__ UART clock.
  1045. * @param __BAUD__ Baud rate set by the user.
  1046. * @param __CLOCKPRESCALER__ UART prescaler value.
  1047. * @retval Division result
  1048. */
  1049. #define UART_DIV_SAMPLING16(__PCLK__, __BAUD__, __CLOCKPRESCALER__) ((((__PCLK__)/UART_GET_DIV_FACTOR((__CLOCKPRESCALER__))) + ((__BAUD__)/2U)) / (__BAUD__))
  1050. /** @brief Check whether or not UART instance is Low Power UART.
  1051. * @param __HANDLE__ specifies the UART Handle.
  1052. * @retval SET (instance is LPUART) or RESET (instance isn't LPUART)
  1053. */
  1054. #define UART_INSTANCE_LOWPOWER(__HANDLE__) (IS_LPUART_INSTANCE((__HANDLE__)->Instance))
  1055. /** @brief Check UART Baud rate.
  1056. * @param __BAUDRATE__ Baudrate specified by the user.
  1057. * The maximum Baud Rate is derived from the maximum clock on H7 (i.e. 100 MHz)
  1058. * divided by the smallest oversampling used on the USART (i.e. 8)
  1059. * @retval SET (__BAUDRATE__ is valid) or RESET (__BAUDRATE__ is invalid)
  1060. */
  1061. #define IS_UART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 12500001U)
  1062. /** @brief Check UART assertion time.
  1063. * @param __TIME__ 5-bit value assertion time.
  1064. * @retval Test result (TRUE or FALSE).
  1065. */
  1066. #define IS_UART_ASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1FU)
  1067. /** @brief Check UART deassertion time.
  1068. * @param __TIME__ 5-bit value deassertion time.
  1069. * @retval Test result (TRUE or FALSE).
  1070. */
  1071. #define IS_UART_DEASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1FU)
  1072. /**
  1073. * @brief Ensure that UART frame number of stop bits is valid.
  1074. * @param __STOPBITS__ UART frame number of stop bits.
  1075. * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
  1076. */
  1077. #define IS_UART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == UART_STOPBITS_0_5) || \
  1078. ((__STOPBITS__) == UART_STOPBITS_1) || \
  1079. ((__STOPBITS__) == UART_STOPBITS_1_5) || \
  1080. ((__STOPBITS__) == UART_STOPBITS_2))
  1081. /**
  1082. * @brief Ensure that LPUART frame number of stop bits is valid.
  1083. * @param __STOPBITS__ LPUART frame number of stop bits.
  1084. * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
  1085. */
  1086. #define IS_LPUART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == UART_STOPBITS_1) || \
  1087. ((__STOPBITS__) == UART_STOPBITS_2))
  1088. /**
  1089. * @brief Ensure that UART frame parity is valid.
  1090. * @param __PARITY__ UART frame parity.
  1091. * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
  1092. */
  1093. #define IS_UART_PARITY(__PARITY__) (((__PARITY__) == UART_PARITY_NONE) || \
  1094. ((__PARITY__) == UART_PARITY_EVEN) || \
  1095. ((__PARITY__) == UART_PARITY_ODD))
  1096. /**
  1097. * @brief Ensure that UART hardware flow control is valid.
  1098. * @param __CONTROL__ UART hardware flow control.
  1099. * @retval SET (__CONTROL__ is valid) or RESET (__CONTROL__ is invalid)
  1100. */
  1101. #define IS_UART_HARDWARE_FLOW_CONTROL(__CONTROL__)\
  1102. (((__CONTROL__) == UART_HWCONTROL_NONE) || \
  1103. ((__CONTROL__) == UART_HWCONTROL_RTS) || \
  1104. ((__CONTROL__) == UART_HWCONTROL_CTS) || \
  1105. ((__CONTROL__) == UART_HWCONTROL_RTS_CTS))
  1106. /**
  1107. * @brief Ensure that UART communication mode is valid.
  1108. * @param __MODE__ UART communication mode.
  1109. * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
  1110. */
  1111. #define IS_UART_MODE(__MODE__) ((((__MODE__) & (~((uint32_t)(UART_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U))
  1112. /**
  1113. * @brief Ensure that UART state is valid.
  1114. * @param __STATE__ UART state.
  1115. * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid)
  1116. */
  1117. #define IS_UART_STATE(__STATE__) (((__STATE__) == UART_STATE_DISABLE) || \
  1118. ((__STATE__) == UART_STATE_ENABLE))
  1119. /**
  1120. * @brief Ensure that UART oversampling is valid.
  1121. * @param __SAMPLING__ UART oversampling.
  1122. * @retval SET (__SAMPLING__ is valid) or RESET (__SAMPLING__ is invalid)
  1123. */
  1124. #define IS_UART_OVERSAMPLING(__SAMPLING__) (((__SAMPLING__) == UART_OVERSAMPLING_16) || \
  1125. ((__SAMPLING__) == UART_OVERSAMPLING_8))
  1126. /**
  1127. * @brief Ensure that UART frame sampling is valid.
  1128. * @param __ONEBIT__ UART frame sampling.
  1129. * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
  1130. */
  1131. #define IS_UART_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == UART_ONE_BIT_SAMPLE_DISABLE) || \
  1132. ((__ONEBIT__) == UART_ONE_BIT_SAMPLE_ENABLE))
  1133. /**
  1134. * @brief Ensure that UART auto Baud rate detection mode is valid.
  1135. * @param __MODE__ UART auto Baud rate detection mode.
  1136. * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
  1137. */
  1138. #define IS_UART_ADVFEATURE_AUTOBAUDRATEMODE(__MODE__) (((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT) || \
  1139. ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE) || \
  1140. ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME) || \
  1141. ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME))
  1142. /**
  1143. * @brief Ensure that UART receiver timeout setting is valid.
  1144. * @param __TIMEOUT__ UART receiver timeout setting.
  1145. * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid)
  1146. */
  1147. #define IS_UART_RECEIVER_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_DISABLE) || \
  1148. ((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_ENABLE))
  1149. /**
  1150. * @brief Ensure that UART LIN state is valid.
  1151. * @param __LIN__ UART LIN state.
  1152. * @retval SET (__LIN__ is valid) or RESET (__LIN__ is invalid)
  1153. */
  1154. #define IS_UART_LIN(__LIN__) (((__LIN__) == UART_LIN_DISABLE) || \
  1155. ((__LIN__) == UART_LIN_ENABLE))
  1156. /**
  1157. * @brief Ensure that UART LIN break detection length is valid.
  1158. * @param __LENGTH__ UART LIN break detection length.
  1159. * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
  1160. */
  1161. #define IS_UART_LIN_BREAK_DETECT_LENGTH(__LENGTH__) (((__LENGTH__) == UART_LINBREAKDETECTLENGTH_10B) || \
  1162. ((__LENGTH__) == UART_LINBREAKDETECTLENGTH_11B))
  1163. /**
  1164. * @brief Ensure that UART DMA TX state is valid.
  1165. * @param __DMATX__ UART DMA TX state.
  1166. * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid)
  1167. */
  1168. #define IS_UART_DMA_TX(__DMATX__) (((__DMATX__) == UART_DMA_TX_DISABLE) || \
  1169. ((__DMATX__) == UART_DMA_TX_ENABLE))
  1170. /**
  1171. * @brief Ensure that UART DMA RX state is valid.
  1172. * @param __DMARX__ UART DMA RX state.
  1173. * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid)
  1174. */
  1175. #define IS_UART_DMA_RX(__DMARX__) (((__DMARX__) == UART_DMA_RX_DISABLE) || \
  1176. ((__DMARX__) == UART_DMA_RX_ENABLE))
  1177. /**
  1178. * @brief Ensure that UART half-duplex state is valid.
  1179. * @param __HDSEL__ UART half-duplex state.
  1180. * @retval SET (__HDSEL__ is valid) or RESET (__HDSEL__ is invalid)
  1181. */
  1182. #define IS_UART_HALF_DUPLEX(__HDSEL__) (((__HDSEL__) == UART_HALF_DUPLEX_DISABLE) || \
  1183. ((__HDSEL__) == UART_HALF_DUPLEX_ENABLE))
  1184. /**
  1185. * @brief Ensure that UART wake-up method is valid.
  1186. * @param __WAKEUP__ UART wake-up method .
  1187. * @retval SET (__WAKEUP__ is valid) or RESET (__WAKEUP__ is invalid)
  1188. */
  1189. #define IS_UART_WAKEUPMETHOD(__WAKEUP__) (((__WAKEUP__) == UART_WAKEUPMETHOD_IDLELINE) || \
  1190. ((__WAKEUP__) == UART_WAKEUPMETHOD_ADDRESSMARK))
  1191. /**
  1192. * @brief Ensure that UART request parameter is valid.
  1193. * @param __PARAM__ UART request parameter.
  1194. * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
  1195. */
  1196. #define IS_UART_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == UART_AUTOBAUD_REQUEST) || \
  1197. ((__PARAM__) == UART_SENDBREAK_REQUEST) || \
  1198. ((__PARAM__) == UART_MUTE_MODE_REQUEST) || \
  1199. ((__PARAM__) == UART_RXDATA_FLUSH_REQUEST) || \
  1200. ((__PARAM__) == UART_TXDATA_FLUSH_REQUEST))
  1201. /**
  1202. * @brief Ensure that UART advanced features initialization is valid.
  1203. * @param __INIT__ UART advanced features initialization.
  1204. * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid)
  1205. */
  1206. #define IS_UART_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (UART_ADVFEATURE_NO_INIT | \
  1207. UART_ADVFEATURE_TXINVERT_INIT | \
  1208. UART_ADVFEATURE_RXINVERT_INIT | \
  1209. UART_ADVFEATURE_DATAINVERT_INIT | \
  1210. UART_ADVFEATURE_SWAP_INIT | \
  1211. UART_ADVFEATURE_RXOVERRUNDISABLE_INIT | \
  1212. UART_ADVFEATURE_DMADISABLEONERROR_INIT | \
  1213. UART_ADVFEATURE_AUTOBAUDRATE_INIT | \
  1214. UART_ADVFEATURE_MSBFIRST_INIT))
  1215. /**
  1216. * @brief Ensure that UART frame TX inversion setting is valid.
  1217. * @param __TXINV__ UART frame TX inversion setting.
  1218. * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid)
  1219. */
  1220. #define IS_UART_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == UART_ADVFEATURE_TXINV_DISABLE) || \
  1221. ((__TXINV__) == UART_ADVFEATURE_TXINV_ENABLE))
  1222. /**
  1223. * @brief Ensure that UART frame RX inversion setting is valid.
  1224. * @param __RXINV__ UART frame RX inversion setting.
  1225. * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid)
  1226. */
  1227. #define IS_UART_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == UART_ADVFEATURE_RXINV_DISABLE) || \
  1228. ((__RXINV__) == UART_ADVFEATURE_RXINV_ENABLE))
  1229. /**
  1230. * @brief Ensure that UART frame data inversion setting is valid.
  1231. * @param __DATAINV__ UART frame data inversion setting.
  1232. * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid)
  1233. */
  1234. #define IS_UART_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == UART_ADVFEATURE_DATAINV_DISABLE) || \
  1235. ((__DATAINV__) == UART_ADVFEATURE_DATAINV_ENABLE))
  1236. /**
  1237. * @brief Ensure that UART frame RX/TX pins swap setting is valid.
  1238. * @param __SWAP__ UART frame RX/TX pins swap setting.
  1239. * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid)
  1240. */
  1241. #define IS_UART_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == UART_ADVFEATURE_SWAP_DISABLE) || \
  1242. ((__SWAP__) == UART_ADVFEATURE_SWAP_ENABLE))
  1243. /**
  1244. * @brief Ensure that UART frame overrun setting is valid.
  1245. * @param __OVERRUN__ UART frame overrun setting.
  1246. * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid)
  1247. */
  1248. #define IS_UART_OVERRUN(__OVERRUN__) (((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_ENABLE) || \
  1249. ((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_DISABLE))
  1250. /**
  1251. * @brief Ensure that UART auto Baud rate state is valid.
  1252. * @param __AUTOBAUDRATE__ UART auto Baud rate state.
  1253. * @retval SET (__AUTOBAUDRATE__ is valid) or RESET (__AUTOBAUDRATE__ is invalid)
  1254. */
  1255. #define IS_UART_ADVFEATURE_AUTOBAUDRATE(__AUTOBAUDRATE__) (((__AUTOBAUDRATE__) == UART_ADVFEATURE_AUTOBAUDRATE_DISABLE) || \
  1256. ((__AUTOBAUDRATE__) == UART_ADVFEATURE_AUTOBAUDRATE_ENABLE))
  1257. /**
  1258. * @brief Ensure that UART DMA enabling or disabling on error setting is valid.
  1259. * @param __DMA__ UART DMA enabling or disabling on error setting.
  1260. * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid)
  1261. */
  1262. #define IS_UART_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == UART_ADVFEATURE_DMA_ENABLEONRXERROR) || \
  1263. ((__DMA__) == UART_ADVFEATURE_DMA_DISABLEONRXERROR))
  1264. /**
  1265. * @brief Ensure that UART frame MSB first setting is valid.
  1266. * @param __MSBFIRST__ UART frame MSB first setting.
  1267. * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid)
  1268. */
  1269. #define IS_UART_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_DISABLE) || \
  1270. ((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_ENABLE))
  1271. /**
  1272. * @brief Ensure that UART stop mode state is valid.
  1273. * @param __STOPMODE__ UART stop mode state.
  1274. * @retval SET (__STOPMODE__ is valid) or RESET (__STOPMODE__ is invalid)
  1275. */
  1276. #define IS_UART_ADVFEATURE_STOPMODE(__STOPMODE__) (((__STOPMODE__) == UART_ADVFEATURE_STOPMODE_DISABLE) || \
  1277. ((__STOPMODE__) == UART_ADVFEATURE_STOPMODE_ENABLE))
  1278. /**
  1279. * @brief Ensure that UART mute mode state is valid.
  1280. * @param __MUTE__ UART mute mode state.
  1281. * @retval SET (__MUTE__ is valid) or RESET (__MUTE__ is invalid)
  1282. */
  1283. #define IS_UART_MUTE_MODE(__MUTE__) (((__MUTE__) == UART_ADVFEATURE_MUTEMODE_DISABLE) || \
  1284. ((__MUTE__) == UART_ADVFEATURE_MUTEMODE_ENABLE))
  1285. /**
  1286. * @brief Ensure that UART wake-up selection is valid.
  1287. * @param __WAKE__ UART wake-up selection.
  1288. * @retval SET (__WAKE__ is valid) or RESET (__WAKE__ is invalid)
  1289. */
  1290. #define IS_UART_WAKEUP_SELECTION(__WAKE__) (((__WAKE__) == UART_WAKEUP_ON_ADDRESS) || \
  1291. ((__WAKE__) == UART_WAKEUP_ON_STARTBIT) || \
  1292. ((__WAKE__) == UART_WAKEUP_ON_READDATA_NONEMPTY))
  1293. /**
  1294. * @brief Ensure that UART driver enable polarity is valid.
  1295. * @param __POLARITY__ UART driver enable polarity.
  1296. * @retval SET (__POLARITY__ is valid) or RESET (__POLARITY__ is invalid)
  1297. */
  1298. #define IS_UART_DE_POLARITY(__POLARITY__) (((__POLARITY__) == UART_DE_POLARITY_HIGH) || \
  1299. ((__POLARITY__) == UART_DE_POLARITY_LOW))
  1300. /**
  1301. * @brief Ensure that UART Prescaler is valid.
  1302. * @param __CLOCKPRESCALER__ UART Prescaler value.
  1303. * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid)
  1304. */
  1305. #define IS_UART_PRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == UART_PRESCALER_DIV1) || \
  1306. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV2) || \
  1307. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV4) || \
  1308. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV6) || \
  1309. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV8) || \
  1310. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV10) || \
  1311. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV12) || \
  1312. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV16) || \
  1313. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV32) || \
  1314. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV64) || \
  1315. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV128) || \
  1316. ((__CLOCKPRESCALER__) == UART_PRESCALER_DIV256))
  1317. /**
  1318. * @}
  1319. */
  1320. /* Include UART HAL Extended module */
  1321. #include "stm32h7xx_hal_uart_ex.h"
  1322. /* Exported functions --------------------------------------------------------*/
  1323. /** @addtogroup UART_Exported_Functions UART Exported Functions
  1324. * @{
  1325. */
  1326. /** @addtogroup UART_Exported_Functions_Group1 Initialization and de-initialization functions
  1327. * @{
  1328. */
  1329. /* Initialization and de-initialization functions ****************************/
  1330. HAL_StatusTypeDef HAL_UART_Init(UART_HandleTypeDef *huart);
  1331. HAL_StatusTypeDef HAL_HalfDuplex_Init(UART_HandleTypeDef *huart);
  1332. HAL_StatusTypeDef HAL_LIN_Init(UART_HandleTypeDef *huart, uint32_t BreakDetectLength);
  1333. HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod);
  1334. HAL_StatusTypeDef HAL_UART_DeInit(UART_HandleTypeDef *huart);
  1335. void HAL_UART_MspInit(UART_HandleTypeDef *huart);
  1336. void HAL_UART_MspDeInit(UART_HandleTypeDef *huart);
  1337. /* Callbacks Register/UnRegister functions ***********************************/
  1338. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  1339. HAL_StatusTypeDef HAL_UART_RegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID, pUART_CallbackTypeDef pCallback);
  1340. HAL_StatusTypeDef HAL_UART_UnRegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID);
  1341. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  1342. /**
  1343. * @}
  1344. */
  1345. /** @addtogroup UART_Exported_Functions_Group2 IO operation functions
  1346. * @{
  1347. */
  1348. /* IO operation functions *****************************************************/
  1349. HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  1350. HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  1351. HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  1352. HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  1353. HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  1354. HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size);
  1355. HAL_StatusTypeDef HAL_UART_DMAPause(UART_HandleTypeDef *huart);
  1356. HAL_StatusTypeDef HAL_UART_DMAResume(UART_HandleTypeDef *huart);
  1357. HAL_StatusTypeDef HAL_UART_DMAStop(UART_HandleTypeDef *huart);
  1358. /* Transfer Abort functions */
  1359. HAL_StatusTypeDef HAL_UART_Abort(UART_HandleTypeDef *huart);
  1360. HAL_StatusTypeDef HAL_UART_AbortTransmit(UART_HandleTypeDef *huart);
  1361. HAL_StatusTypeDef HAL_UART_AbortReceive(UART_HandleTypeDef *huart);
  1362. HAL_StatusTypeDef HAL_UART_Abort_IT(UART_HandleTypeDef *huart);
  1363. HAL_StatusTypeDef HAL_UART_AbortTransmit_IT(UART_HandleTypeDef *huart);
  1364. HAL_StatusTypeDef HAL_UART_AbortReceive_IT(UART_HandleTypeDef *huart);
  1365. void HAL_UART_IRQHandler(UART_HandleTypeDef *huart);
  1366. void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart);
  1367. void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart);
  1368. void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart);
  1369. void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart);
  1370. void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart);
  1371. void HAL_UART_AbortCpltCallback(UART_HandleTypeDef *huart);
  1372. void HAL_UART_AbortTransmitCpltCallback(UART_HandleTypeDef *huart);
  1373. void HAL_UART_AbortReceiveCpltCallback(UART_HandleTypeDef *huart);
  1374. /**
  1375. * @}
  1376. */
  1377. /** @addtogroup UART_Exported_Functions_Group3 Peripheral Control functions
  1378. * @{
  1379. */
  1380. /* Peripheral Control functions ************************************************/
  1381. HAL_StatusTypeDef HAL_LIN_SendBreak(UART_HandleTypeDef *huart);
  1382. HAL_StatusTypeDef HAL_MultiProcessor_EnableMuteMode(UART_HandleTypeDef *huart);
  1383. HAL_StatusTypeDef HAL_MultiProcessor_DisableMuteMode(UART_HandleTypeDef *huart);
  1384. void HAL_MultiProcessor_EnterMuteMode(UART_HandleTypeDef *huart);
  1385. HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter(UART_HandleTypeDef *huart);
  1386. HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver(UART_HandleTypeDef *huart);
  1387. /**
  1388. * @}
  1389. */
  1390. /** @addtogroup UART_Exported_Functions_Group4 Peripheral State and Error functions
  1391. * @{
  1392. */
  1393. /* Peripheral State and Errors functions **************************************************/
  1394. HAL_UART_StateTypeDef HAL_UART_GetState(UART_HandleTypeDef *huart);
  1395. uint32_t HAL_UART_GetError(UART_HandleTypeDef *huart);
  1396. /**
  1397. * @}
  1398. */
  1399. /**
  1400. * @}
  1401. */
  1402. /* Private functions -----------------------------------------------------------*/
  1403. /** @addtogroup UART_Private_Functions UART Private Functions
  1404. * @{
  1405. */
  1406. #if (USE_HAL_UART_REGISTER_CALLBACKS == 1)
  1407. void UART_InitCallbacksToDefault(UART_HandleTypeDef *huart);
  1408. #endif /* USE_HAL_UART_REGISTER_CALLBACKS */
  1409. HAL_StatusTypeDef UART_SetConfig(UART_HandleTypeDef *huart);
  1410. HAL_StatusTypeDef UART_CheckIdleState(UART_HandleTypeDef *huart);
  1411. HAL_StatusTypeDef UART_WaitOnFlagUntilTimeout(UART_HandleTypeDef *huart, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout);
  1412. void UART_AdvFeatureConfig(UART_HandleTypeDef *huart);
  1413. /**
  1414. * @}
  1415. */
  1416. /**
  1417. * @}
  1418. */
  1419. /**
  1420. * @}
  1421. */
  1422. #ifdef __cplusplus
  1423. }
  1424. #endif
  1425. #endif /* STM32H7xx_HAL_UART_H */
  1426. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/