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