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