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