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