stm32g0xx_hal_usart.h 47 KB

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