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.
 
 
 

933 lines
47 KiB

  1. /**
  2. ******************************************************************************
  3. * @file stm32wbxx_hal_usart.h
  4. * @author MCD Application Team
  5. * @brief Header file of USART HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; Copyright (c) 2019 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 STM32WBxx_HAL_USART_H
  21. #define STM32WBxx_HAL_USART_H
  22. #ifdef __cplusplus
  23. extern "C" {
  24. #endif
  25. /* Includes ------------------------------------------------------------------*/
  26. #include "stm32wbxx_hal_def.h"
  27. /** @addtogroup STM32WBxx_HAL_Driver
  28. * @{
  29. */
  30. /** @addtogroup USART
  31. * @{
  32. */
  33. /* Exported types ------------------------------------------------------------*/
  34. /** @defgroup USART_Exported_Types USART Exported Types
  35. * @{
  36. */
  37. /**
  38. * @brief USART Init Structure definition
  39. */
  40. typedef struct
  41. {
  42. uint32_t BaudRate; /*!< This member configures the Usart communication baud rate.
  43. The baud rate is computed using the following formula:
  44. Baud Rate Register[15:4] = ((2 * fclk_pres) / ((huart->Init.BaudRate)))[15:4]
  45. Baud Rate Register[3] = 0
  46. Baud Rate Register[2:0] = (((2 * fclk_pres) / ((huart->Init.BaudRate)))[3:0]) >> 1
  47. where fclk_pres is the USART input clock frequency (fclk) divided by a prescaler.
  48. @note Oversampling by 8 is systematically applied to achieve high baud rates. */
  49. uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
  50. This parameter can be a value of @ref USARTEx_Word_Length. */
  51. uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
  52. This parameter can be a value of @ref USART_Stop_Bits. */
  53. uint32_t Parity; /*!< Specifies the parity mode.
  54. This parameter can be a value of @ref USART_Parity
  55. @note When parity is enabled, the computed parity is inserted
  56. at the MSB position of the transmitted data (9th bit when
  57. the word length is set to 9 data bits; 8th bit when the
  58. word length is set to 8 data bits). */
  59. uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
  60. This parameter can be a value of @ref USART_Mode. */
  61. uint32_t CLKPolarity; /*!< Specifies the steady state of the serial clock.
  62. This parameter can be a value of @ref USART_Clock_Polarity. */
  63. uint32_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made.
  64. This parameter can be a value of @ref USART_Clock_Phase. */
  65. uint32_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted
  66. data bit (MSB) has to be output on the SCLK pin in synchronous mode.
  67. This parameter can be a value of @ref USART_Last_Bit. */
  68. uint32_t ClockPrescaler; /*!< Specifies the prescaler value used to divide the USART clock source.
  69. This parameter can be a value of @ref USART_ClockPrescaler. */
  70. } USART_InitTypeDef;
  71. /**
  72. * @brief HAL USART State structures definition
  73. */
  74. typedef enum
  75. {
  76. HAL_USART_STATE_RESET = 0x00U, /*!< Peripheral is not initialized */
  77. HAL_USART_STATE_READY = 0x01U, /*!< Peripheral Initialized and ready for use */
  78. HAL_USART_STATE_BUSY = 0x02U, /*!< an internal process is ongoing */
  79. HAL_USART_STATE_BUSY_TX = 0x12U, /*!< Data Transmission process is ongoing */
  80. HAL_USART_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing */
  81. HAL_USART_STATE_BUSY_TX_RX = 0x32U, /*!< Data Transmission Reception process is ongoing */
  82. HAL_USART_STATE_TIMEOUT = 0x03U, /*!< Timeout state */
  83. HAL_USART_STATE_ERROR = 0x04U /*!< Error */
  84. } HAL_USART_StateTypeDef;
  85. /**
  86. * @brief USART clock sources definitions
  87. */
  88. typedef enum
  89. {
  90. USART_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */
  91. USART_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */
  92. USART_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */
  93. USART_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */
  94. USART_CLOCKSOURCE_UNDEFINED = 0x10U /*!< Undefined clock source */
  95. } USART_ClockSourceTypeDef;
  96. /**
  97. * @brief USART handle Structure definition
  98. */
  99. typedef struct __USART_HandleTypeDef
  100. {
  101. USART_TypeDef *Instance; /*!< USART registers base address */
  102. USART_InitTypeDef Init; /*!< USART communication parameters */
  103. uint8_t *pTxBuffPtr; /*!< Pointer to USART Tx transfer Buffer */
  104. uint16_t TxXferSize; /*!< USART Tx Transfer size */
  105. __IO uint16_t TxXferCount; /*!< USART Tx Transfer Counter */
  106. uint8_t *pRxBuffPtr; /*!< Pointer to USART Rx transfer Buffer */
  107. uint16_t RxXferSize; /*!< USART Rx Transfer size */
  108. __IO uint16_t RxXferCount; /*!< USART Rx Transfer Counter */
  109. uint16_t Mask; /*!< USART Rx RDR register mask */
  110. uint16_t NbRxDataToProcess; /*!< Number of data to process during RX ISR execution */
  111. uint16_t NbTxDataToProcess; /*!< Number of data to process during TX ISR execution */
  112. uint32_t SlaveMode; /*!< Enable/Disable USART SPI Slave Mode. This parameter can be a value
  113. of @ref USARTEx_Slave_Mode */
  114. uint32_t FifoMode; /*!< Specifies if the FIFO mode will be used. This parameter can be a value
  115. of @ref USARTEx_FIFO_mode. */
  116. void (*RxISR)(struct __USART_HandleTypeDef *husart); /*!< Function pointer on Rx IRQ handler */
  117. void (*TxISR)(struct __USART_HandleTypeDef *husart); /*!< Function pointer on Tx IRQ handler */
  118. DMA_HandleTypeDef *hdmatx; /*!< USART Tx DMA Handle parameters */
  119. DMA_HandleTypeDef *hdmarx; /*!< USART Rx DMA Handle parameters */
  120. HAL_LockTypeDef Lock; /*!< Locking object */
  121. __IO HAL_USART_StateTypeDef State; /*!< USART communication state */
  122. __IO uint32_t ErrorCode; /*!< USART Error code */
  123. #if (USE_HAL_USART_REGISTER_CALLBACKS == 1)
  124. void (* TxHalfCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Tx Half Complete Callback */
  125. void (* TxCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Tx Complete Callback */
  126. void (* RxHalfCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Rx Half Complete Callback */
  127. void (* RxCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Rx Complete Callback */
  128. void (* TxRxCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Tx Rx Complete Callback */
  129. void (* ErrorCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Error Callback */
  130. void (* AbortCpltCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Abort Complete Callback */
  131. void (* RxFifoFullCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Rx Fifo Full Callback */
  132. void (* TxFifoEmptyCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Tx Fifo Empty Callback */
  133. void (* MspInitCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Msp Init callback */
  134. void (* MspDeInitCallback)(struct __USART_HandleTypeDef *husart); /*!< USART Msp DeInit callback */
  135. #endif /* USE_HAL_USART_REGISTER_CALLBACKS */
  136. } USART_HandleTypeDef;
  137. #if (USE_HAL_USART_REGISTER_CALLBACKS == 1)
  138. /**
  139. * @brief HAL USART Callback ID enumeration definition
  140. */
  141. typedef enum
  142. {
  143. HAL_USART_TX_HALFCOMPLETE_CB_ID = 0x00U, /*!< USART Tx Half Complete Callback ID */
  144. HAL_USART_TX_COMPLETE_CB_ID = 0x01U, /*!< USART Tx Complete Callback ID */
  145. HAL_USART_RX_HALFCOMPLETE_CB_ID = 0x02U, /*!< USART Rx Half Complete Callback ID */
  146. HAL_USART_RX_COMPLETE_CB_ID = 0x03U, /*!< USART Rx Complete Callback ID */
  147. HAL_USART_TX_RX_COMPLETE_CB_ID = 0x04U, /*!< USART Tx Rx Complete Callback ID */
  148. HAL_USART_ERROR_CB_ID = 0x05U, /*!< USART Error Callback ID */
  149. HAL_USART_ABORT_COMPLETE_CB_ID = 0x06U, /*!< USART Abort Complete Callback ID */
  150. HAL_USART_RX_FIFO_FULL_CB_ID = 0x07U, /*!< USART Rx Fifo Full Callback ID */
  151. HAL_USART_TX_FIFO_EMPTY_CB_ID = 0x08U, /*!< USART Tx Fifo Empty Callback ID */
  152. HAL_USART_MSPINIT_CB_ID = 0x09U, /*!< USART MspInit callback ID */
  153. HAL_USART_MSPDEINIT_CB_ID = 0x0AU /*!< USART MspDeInit callback ID */
  154. } HAL_USART_CallbackIDTypeDef;
  155. /**
  156. * @brief HAL USART Callback pointer definition
  157. */
  158. typedef void (*pUSART_CallbackTypeDef)(USART_HandleTypeDef *husart); /*!< pointer to an USART callback function */
  159. #endif /* USE_HAL_USART_REGISTER_CALLBACKS */
  160. /**
  161. * @}
  162. */
  163. /* Exported constants --------------------------------------------------------*/
  164. /** @defgroup USART_Exported_Constants USART Exported Constants
  165. * @{
  166. */
  167. /** @defgroup USART_Error_Definition USART Error Definition
  168. * @{
  169. */
  170. #define HAL_USART_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
  171. #define HAL_USART_ERROR_PE ((uint32_t)0x00000001U) /*!< Parity error */
  172. #define HAL_USART_ERROR_NE ((uint32_t)0x00000002U) /*!< Noise error */
  173. #define HAL_USART_ERROR_FE ((uint32_t)0x00000004U) /*!< frame error */
  174. #define HAL_USART_ERROR_ORE ((uint32_t)0x00000008U) /*!< Overrun error */
  175. #define HAL_USART_ERROR_DMA ((uint32_t)0x00000010U) /*!< DMA transfer error */
  176. #define HAL_USART_ERROR_UDR ((uint32_t)0x00000020U) /*!< SPI slave underrun error */
  177. #if (USE_HAL_USART_REGISTER_CALLBACKS == 1)
  178. #define HAL_USART_ERROR_INVALID_CALLBACK ((uint32_t)0x00000040U) /*!< Invalid Callback error */
  179. #endif /* USE_HAL_USART_REGISTER_CALLBACKS */
  180. /**
  181. * @}
  182. */
  183. /** @defgroup USART_Stop_Bits USART Number of Stop Bits
  184. * @{
  185. */
  186. #define USART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< USART frame with 0.5 stop bit */
  187. #define USART_STOPBITS_1 0x00000000U /*!< USART frame with 1 stop bit */
  188. #define USART_STOPBITS_1_5 (USART_CR2_STOP_0 | USART_CR2_STOP_1) /*!< USART frame with 1.5 stop bits */
  189. #define USART_STOPBITS_2 USART_CR2_STOP_1 /*!< USART frame with 2 stop bits */
  190. /**
  191. * @}
  192. */
  193. /** @defgroup USART_Parity USART Parity
  194. * @{
  195. */
  196. #define USART_PARITY_NONE 0x00000000U /*!< No parity */
  197. #define USART_PARITY_EVEN USART_CR1_PCE /*!< Even parity */
  198. #define USART_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< Odd parity */
  199. /**
  200. * @}
  201. */
  202. /** @defgroup USART_Mode USART Mode
  203. * @{
  204. */
  205. #define USART_MODE_RX USART_CR1_RE /*!< RX mode */
  206. #define USART_MODE_TX USART_CR1_TE /*!< TX mode */
  207. #define USART_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< RX and TX mode */
  208. /**
  209. * @}
  210. */
  211. /** @defgroup USART_Over_Sampling USART Over Sampling
  212. * @{
  213. */
  214. #define USART_OVERSAMPLING_16 0x00000000U /*!< Oversampling by 16 */
  215. #define USART_OVERSAMPLING_8 USART_CR1_OVER8 /*!< Oversampling by 8 */
  216. /**
  217. * @}
  218. */
  219. /** @defgroup USART_Clock USART Clock
  220. * @{
  221. */
  222. #define USART_CLOCK_DISABLE 0x00000000U /*!< USART clock disable */
  223. #define USART_CLOCK_ENABLE USART_CR2_CLKEN /*!< USART clock enable */
  224. /**
  225. * @}
  226. */
  227. /** @defgroup USART_Clock_Polarity USART Clock Polarity
  228. * @{
  229. */
  230. #define USART_POLARITY_LOW 0x00000000U /*!< Driver enable signal is active high */
  231. #define USART_POLARITY_HIGH USART_CR2_CPOL /*!< Driver enable signal is active low */
  232. /**
  233. * @}
  234. */
  235. /** @defgroup USART_Clock_Phase USART Clock Phase
  236. * @{
  237. */
  238. #define USART_PHASE_1EDGE 0x00000000U /*!< USART frame phase on first clock transition */
  239. #define USART_PHASE_2EDGE USART_CR2_CPHA /*!< USART frame phase on second clock transition */
  240. /**
  241. * @}
  242. */
  243. /** @defgroup USART_Last_Bit USART Last Bit
  244. * @{
  245. */
  246. #define USART_LASTBIT_DISABLE 0x00000000U /*!< USART frame last data bit clock pulse not output to SCLK pin */
  247. #define USART_LASTBIT_ENABLE USART_CR2_LBCL /*!< USART frame last data bit clock pulse output to SCLK pin */
  248. /**
  249. * @}
  250. */
  251. /** @defgroup USART_ClockPrescaler USART Clock Prescaler
  252. * @{
  253. */
  254. #define USART_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */
  255. #define USART_PRESCALER_DIV2 0x00000001U /*!< fclk_pres = fclk/2 */
  256. #define USART_PRESCALER_DIV4 0x00000002U /*!< fclk_pres = fclk/4 */
  257. #define USART_PRESCALER_DIV6 0x00000003U /*!< fclk_pres = fclk/6 */
  258. #define USART_PRESCALER_DIV8 0x00000004U /*!< fclk_pres = fclk/8 */
  259. #define USART_PRESCALER_DIV10 0x00000005U /*!< fclk_pres = fclk/10 */
  260. #define USART_PRESCALER_DIV12 0x00000006U /*!< fclk_pres = fclk/12 */
  261. #define USART_PRESCALER_DIV16 0x00000007U /*!< fclk_pres = fclk/16 */
  262. #define USART_PRESCALER_DIV32 0x00000008U /*!< fclk_pres = fclk/32 */
  263. #define USART_PRESCALER_DIV64 0x00000009U /*!< fclk_pres = fclk/64 */
  264. #define USART_PRESCALER_DIV128 0x0000000AU /*!< fclk_pres = fclk/128 */
  265. #define USART_PRESCALER_DIV256 0x0000000BU /*!< fclk_pres = fclk/256 */
  266. /**
  267. * @}
  268. */
  269. /** @defgroup USART_Request_Parameters USART Request Parameters
  270. * @{
  271. */
  272. #define USART_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */
  273. #define USART_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush Request */
  274. /**
  275. * @}
  276. */
  277. /** @defgroup USART_Flags USART Flags
  278. * Elements values convention: 0xXXXX
  279. * - 0xXXXX : Flag mask in the ISR register
  280. * @{
  281. */
  282. #define USART_FLAG_TXFT USART_ISR_TXFT /*!< USART TXFIFO threshold flag */
  283. #define USART_FLAG_RXFT USART_ISR_RXFT /*!< USART RXFIFO threshold flag */
  284. #define USART_FLAG_RXFF USART_ISR_RXFF /*!< USART RXFIFO Full flag */
  285. #define USART_FLAG_TXFE USART_ISR_TXFE /*!< USART TXFIFO Empty flag */
  286. #define USART_FLAG_REACK USART_ISR_REACK /*!< USART receive enable acknowledge flag */
  287. #define USART_FLAG_TEACK USART_ISR_TEACK /*!< USART transmit enable acknowledge flag */
  288. #define USART_FLAG_BUSY USART_ISR_BUSY /*!< USART busy flag */
  289. #define USART_FLAG_UDR USART_ISR_UDR /*!< SPI slave underrun error flag */
  290. #define USART_FLAG_TXE USART_ISR_TXE_TXFNF /*!< USART transmit data register empty */
  291. #define USART_FLAG_TXFNF USART_ISR_TXE_TXFNF /*!< USART TXFIFO not full */
  292. #define USART_FLAG_TC USART_ISR_TC /*!< USART transmission complete */
  293. #define USART_FLAG_RXNE USART_ISR_RXNE_RXFNE /*!< USART read data register not empty */
  294. #define USART_FLAG_RXFNE USART_ISR_RXNE_RXFNE /*!< USART RXFIFO not empty */
  295. #define USART_FLAG_IDLE USART_ISR_IDLE /*!< USART idle flag */
  296. #define USART_FLAG_ORE USART_ISR_ORE /*!< USART overrun error */
  297. #define USART_FLAG_NE USART_ISR_NE /*!< USART noise error */
  298. #define USART_FLAG_FE USART_ISR_FE /*!< USART frame error */
  299. #define USART_FLAG_PE USART_ISR_PE /*!< USART parity error */
  300. /**
  301. * @}
  302. */
  303. /** @defgroup USART_Interrupt_definition USART Interrupts Definition
  304. * Elements values convention: 0000ZZZZ0XXYYYYYb
  305. * - YYYYY : Interrupt source position in the XX register (5bits)
  306. * - XX : Interrupt source register (2bits)
  307. * - 01: CR1 register
  308. * - 10: CR2 register
  309. * - 11: CR3 register
  310. * - ZZZZ : Flag position in the ISR register(4bits)
  311. * @{
  312. */
  313. #define USART_IT_PE 0x0028U /*!< USART parity error interruption */
  314. #define USART_IT_TXE 0x0727U /*!< USART transmit data register empty interruption */
  315. #define USART_IT_TXFNF 0x0727U /*!< USART TX FIFO not full interruption */
  316. #define USART_IT_TC 0x0626U /*!< USART transmission complete interruption */
  317. #define USART_IT_RXNE 0x0525U /*!< USART read data register not empty interruption */
  318. #define USART_IT_RXFNE 0x0525U /*!< USART RXFIFO not empty interruption */
  319. #define USART_IT_IDLE 0x0424U /*!< USART idle interruption */
  320. #define USART_IT_ERR 0x0060U /*!< USART error interruption */
  321. #define USART_IT_ORE 0x0300U /*!< USART overrun error interruption */
  322. #define USART_IT_NE 0x0200U /*!< USART noise error interruption */
  323. #define USART_IT_FE 0x0100U /*!< USART frame error interruption */
  324. #define USART_IT_RXFF 0x183FU /*!< USART RXFIFO full interruption */
  325. #define USART_IT_TXFE 0x173EU /*!< USART TXFIFO empty interruption */
  326. #define USART_IT_RXFT 0x1A7CU /*!< USART RXFIFO threshold reached interruption */
  327. #define USART_IT_TXFT 0x1B77U /*!< USART TXFIFO threshold reached interruption */
  328. /**
  329. * @}
  330. */
  331. /** @defgroup USART_IT_CLEAR_Flags USART Interruption Clear Flags
  332. * @{
  333. */
  334. #define USART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */
  335. #define USART_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */
  336. #define USART_CLEAR_NEF USART_ICR_NECF /*!< Noise Error detected Clear Flag */
  337. #define USART_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */
  338. #define USART_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */
  339. #define USART_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */
  340. #define USART_CLEAR_UDRF USART_ICR_UDRCF /*!< SPI slave underrun error Clear Flag */
  341. #define USART_CLEAR_TXFECF USART_ICR_TXFECF /*!< TXFIFO Empty Clear Flag */
  342. /**
  343. * @}
  344. */
  345. /** @defgroup USART_Interruption_Mask USART Interruption Flags Mask
  346. * @{
  347. */
  348. #define USART_IT_MASK 0x001FU /*!< USART interruptions flags mask */
  349. #define USART_CR_MASK 0x00E0U /*!< USART control register mask */
  350. #define USART_CR_POS 5U /*!< USART control register position */
  351. /**
  352. * @}
  353. */
  354. /**
  355. * @}
  356. */
  357. /* Exported macros -----------------------------------------------------------*/
  358. /** @defgroup USART_Exported_Macros USART Exported Macros
  359. * @{
  360. */
  361. /** @brief Reset USART handle state.
  362. * @param __HANDLE__ USART handle.
  363. * @retval None
  364. */
  365. #if (USE_HAL_USART_REGISTER_CALLBACKS == 1)
  366. #define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__) do{ \
  367. (__HANDLE__)->State = HAL_USART_STATE_RESET; \
  368. (__HANDLE__)->MspInitCallback = NULL; \
  369. (__HANDLE__)->MspDeInitCallback = NULL; \
  370. } while(0U)
  371. #else
  372. #define __HAL_USART_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_USART_STATE_RESET)
  373. #endif /* USE_HAL_USART_REGISTER_CALLBACKS */
  374. /** @brief Check whether the specified USART flag is set or not.
  375. * @param __HANDLE__ specifies the USART Handle
  376. * @param __FLAG__ specifies the flag to check.
  377. * This parameter can be one of the following values:
  378. * @arg @ref USART_FLAG_TXFT TXFIFO threshold flag
  379. * @arg @ref USART_FLAG_RXFT RXFIFO threshold flag
  380. * @arg @ref USART_FLAG_RXFF RXFIFO Full flag
  381. * @arg @ref USART_FLAG_TXFE TXFIFO Empty flag
  382. * @arg @ref USART_FLAG_REACK Receive enable acknowledge flag
  383. * @arg @ref USART_FLAG_TEACK Transmit enable acknowledge flag
  384. * @arg @ref USART_FLAG_BUSY Busy flag
  385. * @arg @ref USART_FLAG_UDR SPI slave underrun error flag
  386. * @arg @ref USART_FLAG_TXE Transmit data register empty flag
  387. * @arg @ref USART_FLAG_TXFNF TXFIFO not full flag
  388. * @arg @ref USART_FLAG_TC Transmission Complete flag
  389. * @arg @ref USART_FLAG_RXNE Receive data register not empty flag
  390. * @arg @ref USART_FLAG_RXFNE RXFIFO not empty flag
  391. * @arg @ref USART_FLAG_IDLE Idle Line detection flag
  392. * @arg @ref USART_FLAG_ORE OverRun Error flag
  393. * @arg @ref USART_FLAG_NE Noise Error flag
  394. * @arg @ref USART_FLAG_FE Framing Error flag
  395. * @arg @ref USART_FLAG_PE Parity Error flag
  396. * @retval The new state of __FLAG__ (TRUE or FALSE).
  397. */
  398. #define __HAL_USART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
  399. /** @brief Clear the specified USART pending flag.
  400. * @param __HANDLE__ specifies the USART Handle.
  401. * @param __FLAG__ specifies the flag to check.
  402. * This parameter can be any combination of the following values:
  403. * @arg @ref USART_CLEAR_PEF Parity Error Clear Flag
  404. * @arg @ref USART_CLEAR_FEF Framing Error Clear Flag
  405. * @arg @ref USART_CLEAR_NEF Noise detected Clear Flag
  406. * @arg @ref USART_CLEAR_OREF Overrun Error Clear Flag
  407. * @arg @ref USART_CLEAR_IDLEF IDLE line detected Clear Flag
  408. * @arg @ref USART_CLEAR_TXFECF TXFIFO empty clear Flag
  409. * @arg @ref USART_CLEAR_TCF Transmission Complete Clear Flag
  410. * @arg @ref USART_CLEAR_UDRF SPI slave underrun error Clear Flag
  411. * @retval None
  412. */
  413. #define __HAL_USART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  414. /** @brief Clear the USART PE pending flag.
  415. * @param __HANDLE__ specifies the USART Handle.
  416. * @retval None
  417. */
  418. #define __HAL_USART_CLEAR_PEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_PEF)
  419. /** @brief Clear the USART FE pending flag.
  420. * @param __HANDLE__ specifies the USART Handle.
  421. * @retval None
  422. */
  423. #define __HAL_USART_CLEAR_FEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_FEF)
  424. /** @brief Clear the USART NE pending flag.
  425. * @param __HANDLE__ specifies the USART Handle.
  426. * @retval None
  427. */
  428. #define __HAL_USART_CLEAR_NEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_NEF)
  429. /** @brief Clear the USART ORE pending flag.
  430. * @param __HANDLE__ specifies the USART Handle.
  431. * @retval None
  432. */
  433. #define __HAL_USART_CLEAR_OREFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_OREF)
  434. /** @brief Clear the USART IDLE pending flag.
  435. * @param __HANDLE__ specifies the USART Handle.
  436. * @retval None
  437. */
  438. #define __HAL_USART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_IDLEF)
  439. /** @brief Clear the USART TX FIFO empty clear flag.
  440. * @param __HANDLE__ specifies the USART Handle.
  441. * @retval None
  442. */
  443. #define __HAL_USART_CLEAR_TXFECF(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_TXFECF)
  444. /** @brief Clear SPI slave underrun error flag.
  445. * @param __HANDLE__ specifies the USART Handle.
  446. * @retval None
  447. */
  448. #define __HAL_USART_CLEAR_UDRFLAG(__HANDLE__) __HAL_USART_CLEAR_FLAG((__HANDLE__), USART_CLEAR_UDRF)
  449. /** @brief Enable the specified USART interrupt.
  450. * @param __HANDLE__ specifies the USART Handle.
  451. * @param __INTERRUPT__ specifies the USART interrupt source to enable.
  452. * This parameter can be one of the following values:
  453. * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
  454. * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
  455. * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
  456. * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
  457. * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
  458. * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
  459. * @arg @ref USART_IT_TC Transmission complete interrupt
  460. * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
  461. * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
  462. * @arg @ref USART_IT_IDLE Idle line detection interrupt
  463. * @arg @ref USART_IT_PE Parity Error interrupt
  464. * @arg @ref USART_IT_ERR Error interrupt(Frame error, noise error, overrun error)
  465. * @retval None
  466. */
  467. #define __HAL_USART_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 1U)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
  468. ((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
  469. ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & USART_IT_MASK))))
  470. /** @brief Disable the specified USART interrupt.
  471. * @param __HANDLE__ specifies the USART Handle.
  472. * @param __INTERRUPT__ specifies the USART interrupt source to disable.
  473. * This parameter can be one of the following values:
  474. * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
  475. * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
  476. * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
  477. * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
  478. * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
  479. * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
  480. * @arg @ref USART_IT_TC Transmission complete interrupt
  481. * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
  482. * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
  483. * @arg @ref USART_IT_IDLE Idle line detection interrupt
  484. * @arg @ref USART_IT_PE Parity Error interrupt
  485. * @arg @ref USART_IT_ERR Error interrupt(Frame error, noise error, overrun error)
  486. * @retval None
  487. */
  488. #define __HAL_USART_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
  489. ((((__INTERRUPT__) & USART_CR_MASK) >> USART_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))): \
  490. ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & USART_IT_MASK))))
  491. /** @brief Check whether the specified USART interrupt has occurred or not.
  492. * @param __HANDLE__ specifies the USART Handle.
  493. * @param __INTERRUPT__ specifies the USART interrupt source to check.
  494. * This parameter can be one of the following values:
  495. * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
  496. * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
  497. * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
  498. * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
  499. * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
  500. * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
  501. * @arg @ref USART_IT_TC Transmission complete interrupt
  502. * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
  503. * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
  504. * @arg @ref USART_IT_IDLE Idle line detection interrupt
  505. * @arg @ref USART_IT_ORE OverRun Error interrupt
  506. * @arg @ref USART_IT_NE Noise Error interrupt
  507. * @arg @ref USART_IT_FE Framing Error interrupt
  508. * @arg @ref USART_IT_PE Parity Error interrupt
  509. * @retval The new state of __INTERRUPT__ (SET or RESET).
  510. */
  511. #define __HAL_USART_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR & ((uint32_t)1 << ((__INTERRUPT__)>> 0x08))) != RESET) ? SET : RESET)
  512. /** @brief Check whether the specified USART interrupt source is enabled or not.
  513. * @param __HANDLE__ specifies the USART Handle.
  514. * @param __INTERRUPT__ specifies the USART interrupt source to check.
  515. * This parameter can be one of the following values:
  516. * @arg @ref USART_IT_RXFF RXFIFO Full interrupt
  517. * @arg @ref USART_IT_TXFE TXFIFO Empty interrupt
  518. * @arg @ref USART_IT_RXFT RXFIFO threshold interrupt
  519. * @arg @ref USART_IT_TXFT TXFIFO threshold interrupt
  520. * @arg @ref USART_IT_TXE Transmit Data Register empty interrupt
  521. * @arg @ref USART_IT_TXFNF TX FIFO not full interrupt
  522. * @arg @ref USART_IT_TC Transmission complete interrupt
  523. * @arg @ref USART_IT_RXNE Receive Data register not empty interrupt
  524. * @arg @ref USART_IT_RXFNE RXFIFO not empty interrupt
  525. * @arg @ref USART_IT_IDLE Idle line detection interrupt
  526. * @arg @ref USART_IT_ORE OverRun Error interrupt
  527. * @arg @ref USART_IT_NE Noise Error interrupt
  528. * @arg @ref USART_IT_FE Framing Error interrupt
  529. * @arg @ref USART_IT_PE Parity Error interrupt
  530. * @retval The new state of __INTERRUPT__ (SET or RESET).
  531. */
  532. #define __HAL_USART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((uint8_t)(__INTERRUPT__)) >> 0x05U) == 0x01U) ? (__HANDLE__)->Instance->CR1 : \
  533. (((((uint8_t)(__INTERRUPT__)) >> 0x05U) == 0x02U) ? (__HANDLE__)->Instance->CR2 : \
  534. (__HANDLE__)->Instance->CR3)) & (0x01U << (((uint16_t)(__INTERRUPT__)) & USART_IT_MASK))) != RESET) ? SET : RESET)
  535. /** @brief Clear the specified USART ISR flag, in setting the proper ICR register flag.
  536. * @param __HANDLE__ specifies the USART Handle.
  537. * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
  538. * to clear the corresponding interrupt.
  539. * This parameter can be one of the following values:
  540. * @arg @ref USART_CLEAR_PEF Parity Error Clear Flag
  541. * @arg @ref USART_CLEAR_FEF Framing Error Clear Flag
  542. * @arg @ref USART_CLEAR_NEF Noise detected Clear Flag
  543. * @arg @ref USART_CLEAR_OREF Overrun Error Clear Flag
  544. * @arg @ref USART_CLEAR_IDLEF IDLE line detected Clear Flag
  545. * @arg @ref USART_CLEAR_TXFECF TXFIFO empty clear Flag
  546. * @arg @ref USART_CLEAR_TCF Transmission Complete Clear Flag
  547. * @retval None
  548. */
  549. #define __HAL_USART_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
  550. /** @brief Set a specific USART request flag.
  551. * @param __HANDLE__ specifies the USART Handle.
  552. * @param __REQ__ specifies the request flag to set.
  553. * This parameter can be one of the following values:
  554. * @arg @ref USART_RXDATA_FLUSH_REQUEST Receive Data flush Request
  555. * @arg @ref USART_TXDATA_FLUSH_REQUEST Transmit data flush Request
  556. *
  557. * @retval None
  558. */
  559. #define __HAL_USART_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (__REQ__))
  560. /** @brief Enable the USART one bit sample method.
  561. * @param __HANDLE__ specifies the USART Handle.
  562. * @retval None
  563. */
  564. #define __HAL_USART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
  565. /** @brief Disable the USART one bit sample method.
  566. * @param __HANDLE__ specifies the USART Handle.
  567. * @retval None
  568. */
  569. #define __HAL_USART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT)
  570. /** @brief Enable USART.
  571. * @param __HANDLE__ specifies the USART Handle.
  572. * @retval None
  573. */
  574. #define __HAL_USART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
  575. /** @brief Disable USART.
  576. * @param __HANDLE__ specifies the USART Handle.
  577. * @retval None
  578. */
  579. #define __HAL_USART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
  580. /**
  581. * @}
  582. */
  583. /* Private macros --------------------------------------------------------*/
  584. /** @defgroup USART_Private_Macros USART Private Macros
  585. * @{
  586. */
  587. /** @brief Get USART clock division factor from clock prescaler value.
  588. * @param __CLOCKPRESCALER__ USART prescaler value.
  589. * @retval USART clock division factor
  590. */
  591. #define USART_GET_DIV_FACTOR(__CLOCKPRESCALER__) \
  592. (((__CLOCKPRESCALER__) == USART_PRESCALER_DIV1) ? 1U : \
  593. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV2) ? 2U : \
  594. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV4) ? 4U : \
  595. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV6) ? 6U : \
  596. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV8) ? 8U : \
  597. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV10) ? 10U : \
  598. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV12) ? 12U : \
  599. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV16) ? 16U : \
  600. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV32) ? 32U : \
  601. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV64) ? 64U : \
  602. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV128) ? 128U : \
  603. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV256) ? 256U : 1U)
  604. /** @brief BRR division operation to set BRR register in 8-bit oversampling mode.
  605. * @param __PCLK__ USART clock.
  606. * @param __BAUD__ Baud rate set by the user.
  607. * @param __CLOCKPRESCALER__ USART prescaler value.
  608. * @retval Division result
  609. */
  610. #define USART_DIV_SAMPLING8(__PCLK__, __BAUD__, __CLOCKPRESCALER__) (((((__PCLK__)/USART_GET_DIV_FACTOR(__CLOCKPRESCALER__))*2U) + ((__BAUD__)/2U)) / (__BAUD__))
  611. /** @brief Report the USART clock source.
  612. * @param __HANDLE__ specifies the USART Handle.
  613. * @param __CLOCKSOURCE__ output variable.
  614. * @retval the USART clocking source, written in __CLOCKSOURCE__.
  615. */
  616. #define USART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
  617. do { \
  618. if((__HANDLE__)->Instance == USART1) \
  619. { \
  620. switch(__HAL_RCC_GET_USART1_SOURCE()) \
  621. { \
  622. case RCC_USART1CLKSOURCE_PCLK2: \
  623. (__CLOCKSOURCE__) = USART_CLOCKSOURCE_PCLK2; \
  624. break; \
  625. case RCC_USART1CLKSOURCE_HSI: \
  626. (__CLOCKSOURCE__) = USART_CLOCKSOURCE_HSI; \
  627. break; \
  628. case RCC_USART1CLKSOURCE_SYSCLK: \
  629. (__CLOCKSOURCE__) = USART_CLOCKSOURCE_SYSCLK; \
  630. break; \
  631. case RCC_USART1CLKSOURCE_LSE: \
  632. (__CLOCKSOURCE__) = USART_CLOCKSOURCE_LSE; \
  633. break; \
  634. default: \
  635. (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
  636. break; \
  637. } \
  638. } \
  639. else \
  640. { \
  641. (__CLOCKSOURCE__) = USART_CLOCKSOURCE_UNDEFINED; \
  642. } \
  643. } while(0U)
  644. /** @brief Check USART Baud rate.
  645. * @param __BAUDRATE__ Baudrate specified by the user.
  646. * The maximum Baud Rate is derived from the maximum clock on WB (i.e. 64 MHz)
  647. * divided by the smallest oversampling used on the USART (i.e. 8)
  648. * @retval SET (__BAUDRATE__ is valid) or RESET (__BAUDRATE__ is invalid) */
  649. #define IS_USART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) <= 8000000U)
  650. /**
  651. * @brief Ensure that USART frame number of stop bits is valid.
  652. * @param __STOPBITS__ USART frame number of stop bits.
  653. * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
  654. */
  655. #define IS_USART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == USART_STOPBITS_0_5) || \
  656. ((__STOPBITS__) == USART_STOPBITS_1) || \
  657. ((__STOPBITS__) == USART_STOPBITS_1_5) || \
  658. ((__STOPBITS__) == USART_STOPBITS_2))
  659. /**
  660. * @brief Ensure that USART frame parity is valid.
  661. * @param __PARITY__ USART frame parity.
  662. * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
  663. */
  664. #define IS_USART_PARITY(__PARITY__) (((__PARITY__) == USART_PARITY_NONE) || \
  665. ((__PARITY__) == USART_PARITY_EVEN) || \
  666. ((__PARITY__) == USART_PARITY_ODD))
  667. /**
  668. * @brief Ensure that USART communication mode is valid.
  669. * @param __MODE__ USART communication mode.
  670. * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
  671. */
  672. #define IS_USART_MODE(__MODE__) ((((__MODE__) & 0xFFFFFFF3U) == 0x00U) && ((__MODE__) != 0x00U))
  673. /**
  674. * @brief Ensure that USART oversampling is valid.
  675. * @param __SAMPLING__ USART oversampling.
  676. * @retval SET (__SAMPLING__ is valid) or RESET (__SAMPLING__ is invalid)
  677. */
  678. #define IS_USART_OVERSAMPLING(__SAMPLING__) (((__SAMPLING__) == USART_OVERSAMPLING_16) || \
  679. ((__SAMPLING__) == USART_OVERSAMPLING_8))
  680. /**
  681. * @brief Ensure that USART clock state is valid.
  682. * @param __CLOCK__ USART clock state.
  683. * @retval SET (__CLOCK__ is valid) or RESET (__CLOCK__ is invalid)
  684. */
  685. #define IS_USART_CLOCK(__CLOCK__) (((__CLOCK__) == USART_CLOCK_DISABLE) || \
  686. ((__CLOCK__) == USART_CLOCK_ENABLE))
  687. /**
  688. * @brief Ensure that USART frame polarity is valid.
  689. * @param __CPOL__ USART frame polarity.
  690. * @retval SET (__CPOL__ is valid) or RESET (__CPOL__ is invalid)
  691. */
  692. #define IS_USART_POLARITY(__CPOL__) (((__CPOL__) == USART_POLARITY_LOW) || ((__CPOL__) == USART_POLARITY_HIGH))
  693. /**
  694. * @brief Ensure that USART frame phase is valid.
  695. * @param __CPHA__ USART frame phase.
  696. * @retval SET (__CPHA__ is valid) or RESET (__CPHA__ is invalid)
  697. */
  698. #define IS_USART_PHASE(__CPHA__) (((__CPHA__) == USART_PHASE_1EDGE) || ((__CPHA__) == USART_PHASE_2EDGE))
  699. /**
  700. * @brief Ensure that USART frame last bit clock pulse setting is valid.
  701. * @param __LASTBIT__ USART frame last bit clock pulse setting.
  702. * @retval SET (__LASTBIT__ is valid) or RESET (__LASTBIT__ is invalid)
  703. */
  704. #define IS_USART_LASTBIT(__LASTBIT__) (((__LASTBIT__) == USART_LASTBIT_DISABLE) || \
  705. ((__LASTBIT__) == USART_LASTBIT_ENABLE))
  706. /**
  707. * @brief Ensure that USART request parameter is valid.
  708. * @param __PARAM__ USART request parameter.
  709. * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
  710. */
  711. #define IS_USART_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == USART_RXDATA_FLUSH_REQUEST) || \
  712. ((__PARAM__) == USART_TXDATA_FLUSH_REQUEST))
  713. /**
  714. * @brief Ensure that USART Prescaler is valid.
  715. * @param __CLOCKPRESCALER__ USART Prescaler value.
  716. * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid)
  717. */
  718. #define IS_USART_PRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == USART_PRESCALER_DIV1) || \
  719. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV2) || \
  720. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV4) || \
  721. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV6) || \
  722. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV8) || \
  723. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV10) || \
  724. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV12) || \
  725. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV16) || \
  726. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV32) || \
  727. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV64) || \
  728. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV128) || \
  729. ((__CLOCKPRESCALER__) == USART_PRESCALER_DIV256))
  730. /**
  731. * @}
  732. */
  733. /* Include USART HAL Extended module */
  734. #include "stm32wbxx_hal_usart_ex.h"
  735. /* Exported functions --------------------------------------------------------*/
  736. /** @addtogroup USART_Exported_Functions USART Exported Functions
  737. * @{
  738. */
  739. /** @addtogroup USART_Exported_Functions_Group1 Initialization and de-initialization functions
  740. * @{
  741. */
  742. /* Initialization and de-initialization functions ****************************/
  743. HAL_StatusTypeDef HAL_USART_Init(USART_HandleTypeDef *husart);
  744. HAL_StatusTypeDef HAL_USART_DeInit(USART_HandleTypeDef *husart);
  745. void HAL_USART_MspInit(USART_HandleTypeDef *husart);
  746. void HAL_USART_MspDeInit(USART_HandleTypeDef *husart);
  747. /* Callbacks Register/UnRegister functions ***********************************/
  748. #if (USE_HAL_USART_REGISTER_CALLBACKS == 1)
  749. HAL_StatusTypeDef HAL_USART_RegisterCallback(USART_HandleTypeDef *husart, HAL_USART_CallbackIDTypeDef CallbackID, pUSART_CallbackTypeDef pCallback);
  750. HAL_StatusTypeDef HAL_USART_UnRegisterCallback(USART_HandleTypeDef *husart, HAL_USART_CallbackIDTypeDef CallbackID);
  751. #endif /* USE_HAL_USART_REGISTER_CALLBACKS */
  752. /**
  753. * @}
  754. */
  755. /** @addtogroup USART_Exported_Functions_Group2 IO operation functions
  756. * @{
  757. */
  758. /* IO operation functions *****************************************************/
  759. HAL_StatusTypeDef HAL_USART_Transmit(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size, uint32_t Timeout);
  760. HAL_StatusTypeDef HAL_USART_Receive(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
  761. HAL_StatusTypeDef HAL_USART_TransmitReceive(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size, uint32_t Timeout);
  762. HAL_StatusTypeDef HAL_USART_Transmit_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
  763. HAL_StatusTypeDef HAL_USART_Receive_IT(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
  764. HAL_StatusTypeDef HAL_USART_TransmitReceive_IT(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
  765. HAL_StatusTypeDef HAL_USART_Transmit_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint16_t Size);
  766. HAL_StatusTypeDef HAL_USART_Receive_DMA(USART_HandleTypeDef *husart, uint8_t *pRxData, uint16_t Size);
  767. HAL_StatusTypeDef HAL_USART_TransmitReceive_DMA(USART_HandleTypeDef *husart, uint8_t *pTxData, uint8_t *pRxData, uint16_t Size);
  768. HAL_StatusTypeDef HAL_USART_DMAPause(USART_HandleTypeDef *husart);
  769. HAL_StatusTypeDef HAL_USART_DMAResume(USART_HandleTypeDef *husart);
  770. HAL_StatusTypeDef HAL_USART_DMAStop(USART_HandleTypeDef *husart);
  771. /* Transfer Abort functions */
  772. HAL_StatusTypeDef HAL_USART_Abort(USART_HandleTypeDef *husart);
  773. HAL_StatusTypeDef HAL_USART_Abort_IT(USART_HandleTypeDef *husart);
  774. void HAL_USART_IRQHandler(USART_HandleTypeDef *husart);
  775. void HAL_USART_TxHalfCpltCallback(USART_HandleTypeDef *husart);
  776. void HAL_USART_TxCpltCallback(USART_HandleTypeDef *husart);
  777. void HAL_USART_RxCpltCallback(USART_HandleTypeDef *husart);
  778. void HAL_USART_RxHalfCpltCallback(USART_HandleTypeDef *husart);
  779. void HAL_USART_TxRxCpltCallback(USART_HandleTypeDef *husart);
  780. void HAL_USART_ErrorCallback(USART_HandleTypeDef *husart);
  781. void HAL_USART_AbortCpltCallback(USART_HandleTypeDef *husart);
  782. /**
  783. * @}
  784. */
  785. /** @addtogroup USART_Exported_Functions_Group4 Peripheral State and Error functions
  786. * @{
  787. */
  788. /* Peripheral State and Error functions ***************************************/
  789. HAL_USART_StateTypeDef HAL_USART_GetState(USART_HandleTypeDef *husart);
  790. uint32_t HAL_USART_GetError(USART_HandleTypeDef *husart);
  791. /**
  792. * @}
  793. */
  794. /**
  795. * @}
  796. */
  797. /**
  798. * @}
  799. */
  800. /**
  801. * @}
  802. */
  803. #ifdef __cplusplus
  804. }
  805. #endif
  806. #endif /* STM32WBxx_HAL_USART_H */
  807. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/