1 /** 2 ****************************************************************************** 3 * @file stm32l0xx_hal_uart.h 4 * @author MCD Application Team 5 * @brief Header file of UART 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 STM32L0xx_HAL_UART_H 21 #define STM32L0xx_HAL_UART_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32l0xx_hal_def.h" 29 30 /** @addtogroup STM32L0xx_HAL_Driver 31 * @{ 32 */ 33 34 /** @addtogroup UART 35 * @{ 36 */ 37 38 /* Exported types ------------------------------------------------------------*/ 39 /** @defgroup UART_Exported_Types UART Exported Types 40 * @{ 41 */ 42 43 /** 44 * @brief UART Init Structure definition 45 */ 46 typedef struct 47 { 48 uint32_t BaudRate; /*!< This member configures the UART communication baud rate. 49 The baud rate register is computed using the following formula: 50 LPUART: 51 ======= 52 Baud Rate Register = ((256 * lpuart_ker_ck) / ((huart->Init.BaudRate))) 53 where lpuart_ker_ck is the UART input clock 54 UART: 55 ===== 56 - If oversampling is 16 or in LIN mode, 57 Baud Rate Register = ((uart_ker_ck) / ((huart->Init.BaudRate))) 58 - If oversampling is 8, 59 Baud Rate Register[15:4] = ((2 * uart_ker_ck) / 60 ((huart->Init.BaudRate)))[15:4] 61 Baud Rate Register[3] = 0 62 Baud Rate Register[2:0] = (((2 * uart_ker_ck) / 63 ((huart->Init.BaudRate)))[3:0]) >> 1 64 where uart_ker_ck is the UART input clock */ 65 66 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame. 67 This parameter can be a value of @ref UARTEx_Word_Length. */ 68 69 uint32_t StopBits; /*!< Specifies the number of stop bits transmitted. 70 This parameter can be a value of @ref UART_Stop_Bits. */ 71 72 uint32_t Parity; /*!< Specifies the parity mode. 73 This parameter can be a value of @ref UART_Parity 74 @note When parity is enabled, the computed parity is inserted 75 at the MSB position of the transmitted data (9th bit when 76 the word length is set to 9 data bits; 8th bit when the 77 word length is set to 8 data bits). */ 78 79 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled. 80 This parameter can be a value of @ref UART_Mode. */ 81 82 uint32_t HwFlowCtl; /*!< Specifies whether the hardware flow control mode is enabled 83 or disabled. 84 This parameter can be a value of @ref UART_Hardware_Flow_Control. */ 85 86 uint32_t OverSampling; /*!< Specifies whether the Over sampling 8 is enabled or disabled, 87 to achieve higher speed (up to f_PCLK/8). 88 This parameter can be a value of @ref UART_Over_Sampling. */ 89 90 uint32_t OneBitSampling; /*!< Specifies whether a single sample or three samples' majority vote is selected. 91 Selecting the single sample method increases the receiver tolerance to clock 92 deviations. This parameter can be a value of @ref UART_OneBit_Sampling. */ 93 94 95 } UART_InitTypeDef; 96 97 /** 98 * @brief UART Advanced Features initialization structure definition 99 */ 100 typedef struct 101 { 102 uint32_t AdvFeatureInit; /*!< Specifies which advanced UART features is initialized. Several 103 Advanced Features may be initialized at the same time . 104 This parameter can be a value of 105 @ref UART_Advanced_Features_Initialization_Type. */ 106 107 uint32_t TxPinLevelInvert; /*!< Specifies whether the TX pin active level is inverted. 108 This parameter can be a value of @ref UART_Tx_Inv. */ 109 110 uint32_t RxPinLevelInvert; /*!< Specifies whether the RX pin active level is inverted. 111 This parameter can be a value of @ref UART_Rx_Inv. */ 112 113 uint32_t DataInvert; /*!< Specifies whether data are inverted (positive/direct logic 114 vs negative/inverted logic). 115 This parameter can be a value of @ref UART_Data_Inv. */ 116 117 uint32_t Swap; /*!< Specifies whether TX and RX pins are swapped. 118 This parameter can be a value of @ref UART_Rx_Tx_Swap. */ 119 120 uint32_t OverrunDisable; /*!< Specifies whether the reception overrun detection is disabled. 121 This parameter can be a value of @ref UART_Overrun_Disable. */ 122 123 uint32_t DMADisableonRxError; /*!< Specifies whether the DMA is disabled in case of reception error. 124 This parameter can be a value of @ref UART_DMA_Disable_on_Rx_Error. */ 125 126 uint32_t AutoBaudRateEnable; /*!< Specifies whether auto Baud rate detection is enabled. 127 This parameter can be a value of @ref UART_AutoBaudRate_Enable. */ 128 129 uint32_t AutoBaudRateMode; /*!< If auto Baud rate detection is enabled, specifies how the rate 130 detection is carried out. 131 This parameter can be a value of @ref UART_AutoBaud_Rate_Mode. */ 132 133 uint32_t MSBFirst; /*!< Specifies whether MSB is sent first on UART line. 134 This parameter can be a value of @ref UART_MSB_First. */ 135 } UART_AdvFeatureInitTypeDef; 136 137 /** 138 * @brief HAL UART State definition 139 * @note HAL UART State value is a combination of 2 different substates: 140 * gState and RxState (see @ref UART_State_Definition). 141 * - gState contains UART state information related to global Handle management 142 * and also information related to Tx operations. 143 * gState value coding follow below described bitmap : 144 * b7-b6 Error information 145 * 00 : No Error 146 * 01 : (Not Used) 147 * 10 : Timeout 148 * 11 : Error 149 * b5 Peripheral initialization status 150 * 0 : Reset (Peripheral not initialized) 151 * 1 : Init done (Peripheral initialized. HAL UART Init function already called) 152 * b4-b3 (not used) 153 * xx : Should be set to 00 154 * b2 Intrinsic process state 155 * 0 : Ready 156 * 1 : Busy (Peripheral busy with some configuration or internal operations) 157 * b1 (not used) 158 * x : Should be set to 0 159 * b0 Tx state 160 * 0 : Ready (no Tx operation ongoing) 161 * 1 : Busy (Tx operation ongoing) 162 * - RxState contains information related to Rx operations. 163 * RxState value coding follow below described bitmap : 164 * b7-b6 (not used) 165 * xx : Should be set to 00 166 * b5 Peripheral initialization status 167 * 0 : Reset (Peripheral not initialized) 168 * 1 : Init done (Peripheral initialized) 169 * b4-b2 (not used) 170 * xxx : Should be set to 000 171 * b1 Rx state 172 * 0 : Ready (no Rx operation ongoing) 173 * 1 : Busy (Rx operation ongoing) 174 * b0 (not used) 175 * x : Should be set to 0. 176 */ 177 typedef uint32_t HAL_UART_StateTypeDef; 178 179 /** 180 * @brief UART clock sources definition 181 */ 182 typedef enum 183 { 184 UART_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */ 185 UART_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */ 186 UART_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */ 187 UART_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */ 188 UART_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */ 189 UART_CLOCKSOURCE_UNDEFINED = 0x10U /*!< Undefined clock source */ 190 } UART_ClockSourceTypeDef; 191 192 /** 193 * @brief HAL UART Reception type definition 194 * @note HAL UART Reception type value aims to identify which type of Reception is ongoing. 195 * This parameter can be a value of @ref UART_Reception_Type_Values : 196 * HAL_UART_RECEPTION_STANDARD = 0x00U, 197 * HAL_UART_RECEPTION_TOIDLE = 0x01U, 198 * HAL_UART_RECEPTION_TORTO = 0x02U, 199 * HAL_UART_RECEPTION_TOCHARMATCH = 0x03U, 200 */ 201 typedef uint32_t HAL_UART_RxTypeTypeDef; 202 203 /** 204 * @brief HAL UART Rx Event type definition 205 * @note HAL UART Rx Event type value aims to identify which type of Event has occurred 206 * leading to call of the RxEvent callback. 207 * This parameter can be a value of @ref UART_RxEvent_Type_Values : 208 * HAL_UART_RXEVENT_TC = 0x00U, 209 * HAL_UART_RXEVENT_HT = 0x01U, 210 * HAL_UART_RXEVENT_IDLE = 0x02U, 211 */ 212 typedef uint32_t HAL_UART_RxEventTypeTypeDef; 213 214 /** 215 * @brief UART handle Structure definition 216 */ 217 typedef struct __UART_HandleTypeDef 218 { 219 USART_TypeDef *Instance; /*!< UART registers base address */ 220 221 UART_InitTypeDef Init; /*!< UART communication parameters */ 222 223 UART_AdvFeatureInitTypeDef AdvancedInit; /*!< UART Advanced Features initialization parameters */ 224 225 const uint8_t *pTxBuffPtr; /*!< Pointer to UART Tx transfer Buffer */ 226 227 uint16_t TxXferSize; /*!< UART Tx Transfer size */ 228 229 __IO uint16_t TxXferCount; /*!< UART Tx Transfer Counter */ 230 231 uint8_t *pRxBuffPtr; /*!< Pointer to UART Rx transfer Buffer */ 232 233 uint16_t RxXferSize; /*!< UART Rx Transfer size */ 234 235 __IO uint16_t RxXferCount; /*!< UART Rx Transfer Counter */ 236 237 uint16_t Mask; /*!< UART Rx RDR register mask */ 238 239 __IO HAL_UART_RxTypeTypeDef ReceptionType; /*!< Type of ongoing reception */ 240 241 __IO HAL_UART_RxEventTypeTypeDef RxEventType; /*!< Type of Rx Event */ 242 243 void (*RxISR)(struct __UART_HandleTypeDef *huart); /*!< Function pointer on Rx IRQ handler */ 244 245 void (*TxISR)(struct __UART_HandleTypeDef *huart); /*!< Function pointer on Tx IRQ handler */ 246 247 DMA_HandleTypeDef *hdmatx; /*!< UART Tx DMA Handle parameters */ 248 249 DMA_HandleTypeDef *hdmarx; /*!< UART Rx DMA Handle parameters */ 250 251 HAL_LockTypeDef Lock; /*!< Locking object */ 252 253 __IO HAL_UART_StateTypeDef gState; /*!< UART state information related to global Handle management 254 and also related to Tx operations. This parameter 255 can be a value of @ref HAL_UART_StateTypeDef */ 256 257 __IO HAL_UART_StateTypeDef RxState; /*!< UART state information related to Rx operations. This 258 parameter can be a value of @ref HAL_UART_StateTypeDef */ 259 260 __IO uint32_t ErrorCode; /*!< UART Error code */ 261 262 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1) 263 void (* TxHalfCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Tx Half Complete Callback */ 264 void (* TxCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Tx Complete Callback */ 265 void (* RxHalfCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Rx Half Complete Callback */ 266 void (* RxCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Rx Complete Callback */ 267 void (* ErrorCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Error Callback */ 268 void (* AbortCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Complete Callback */ 269 void (* AbortTransmitCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Transmit Complete Callback */ 270 void (* AbortReceiveCpltCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Abort Receive Complete Callback */ 271 void (* WakeupCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Wakeup Callback */ 272 void (* RxEventCallback)(struct __UART_HandleTypeDef *huart, uint16_t Pos); /*!< UART Reception Event Callback */ 273 274 void (* MspInitCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Msp Init callback */ 275 void (* MspDeInitCallback)(struct __UART_HandleTypeDef *huart); /*!< UART Msp DeInit callback */ 276 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */ 277 278 } UART_HandleTypeDef; 279 280 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1) 281 /** 282 * @brief HAL UART Callback ID enumeration definition 283 */ 284 typedef enum 285 { 286 HAL_UART_TX_HALFCOMPLETE_CB_ID = 0x00U, /*!< UART Tx Half Complete Callback ID */ 287 HAL_UART_TX_COMPLETE_CB_ID = 0x01U, /*!< UART Tx Complete Callback ID */ 288 HAL_UART_RX_HALFCOMPLETE_CB_ID = 0x02U, /*!< UART Rx Half Complete Callback ID */ 289 HAL_UART_RX_COMPLETE_CB_ID = 0x03U, /*!< UART Rx Complete Callback ID */ 290 HAL_UART_ERROR_CB_ID = 0x04U, /*!< UART Error Callback ID */ 291 HAL_UART_ABORT_COMPLETE_CB_ID = 0x05U, /*!< UART Abort Complete Callback ID */ 292 HAL_UART_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x06U, /*!< UART Abort Transmit Complete Callback ID */ 293 HAL_UART_ABORT_RECEIVE_COMPLETE_CB_ID = 0x07U, /*!< UART Abort Receive Complete Callback ID */ 294 HAL_UART_WAKEUP_CB_ID = 0x08U, /*!< UART Wakeup Callback ID */ 295 296 HAL_UART_MSPINIT_CB_ID = 0x0BU, /*!< UART MspInit callback ID */ 297 HAL_UART_MSPDEINIT_CB_ID = 0x0CU /*!< UART MspDeInit callback ID */ 298 299 } HAL_UART_CallbackIDTypeDef; 300 301 /** 302 * @brief HAL UART Callback pointer definition 303 */ 304 typedef void (*pUART_CallbackTypeDef)(UART_HandleTypeDef *huart); /*!< pointer to an UART callback function */ 305 typedef void (*pUART_RxEventCallbackTypeDef) 306 (struct __UART_HandleTypeDef *huart, uint16_t Pos); /*!< pointer to a UART Rx Event specific callback function */ 307 308 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */ 309 310 /** 311 * @} 312 */ 313 314 /* Exported constants --------------------------------------------------------*/ 315 /** @defgroup UART_Exported_Constants UART Exported Constants 316 * @{ 317 */ 318 319 /** @defgroup UART_State_Definition UART State Code Definition 320 * @{ 321 */ 322 #define HAL_UART_STATE_RESET 0x00000000U /*!< Peripheral is not initialized 323 Value is allowed for gState and RxState */ 324 #define HAL_UART_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for use 325 Value is allowed for gState and RxState */ 326 #define HAL_UART_STATE_BUSY 0x00000024U /*!< an internal process is ongoing 327 Value is allowed for gState only */ 328 #define HAL_UART_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing 329 Value is allowed for gState only */ 330 #define HAL_UART_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing 331 Value is allowed for RxState only */ 332 #define HAL_UART_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception process is ongoing 333 Not to be used for neither gState nor RxState.Value is result 334 of combination (Or) between gState and RxState values */ 335 #define HAL_UART_STATE_TIMEOUT 0x000000A0U /*!< Timeout state 336 Value is allowed for gState only */ 337 #define HAL_UART_STATE_ERROR 0x000000E0U /*!< Error 338 Value is allowed for gState only */ 339 /** 340 * @} 341 */ 342 343 /** @defgroup UART_Error_Definition UART Error Definition 344 * @{ 345 */ 346 #define HAL_UART_ERROR_NONE (0x00000000U) /*!< No error */ 347 #define HAL_UART_ERROR_PE (0x00000001U) /*!< Parity error */ 348 #define HAL_UART_ERROR_NE (0x00000002U) /*!< Noise error */ 349 #define HAL_UART_ERROR_FE (0x00000004U) /*!< Frame error */ 350 #define HAL_UART_ERROR_ORE (0x00000008U) /*!< Overrun error */ 351 #define HAL_UART_ERROR_DMA (0x00000010U) /*!< DMA transfer error */ 352 #define HAL_UART_ERROR_RTO (0x00000020U) /*!< Receiver Timeout error */ 353 354 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1) 355 #define HAL_UART_ERROR_INVALID_CALLBACK (0x00000040U) /*!< Invalid Callback error */ 356 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */ 357 /** 358 * @} 359 */ 360 361 /** @defgroup UART_Stop_Bits UART Number of Stop Bits 362 * @{ 363 */ 364 #define UART_STOPBITS_0_5 USART_CR2_STOP_0 /*!< UART frame with 0.5 stop bit */ 365 #define UART_STOPBITS_1 0x00000000U /*!< UART frame with 1 stop bit */ 366 #define UART_STOPBITS_1_5 (USART_CR2_STOP_0 | USART_CR2_STOP_1) /*!< UART frame with 1.5 stop bits */ 367 #define UART_STOPBITS_2 USART_CR2_STOP_1 /*!< UART frame with 2 stop bits */ 368 /** 369 * @} 370 */ 371 372 /** @defgroup UART_Parity UART Parity 373 * @{ 374 */ 375 #define UART_PARITY_NONE 0x00000000U /*!< No parity */ 376 #define UART_PARITY_EVEN USART_CR1_PCE /*!< Even parity */ 377 #define UART_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< Odd parity */ 378 /** 379 * @} 380 */ 381 382 /** @defgroup UART_Hardware_Flow_Control UART Hardware Flow Control 383 * @{ 384 */ 385 #define UART_HWCONTROL_NONE 0x00000000U /*!< No hardware control */ 386 #define UART_HWCONTROL_RTS USART_CR3_RTSE /*!< Request To Send */ 387 #define UART_HWCONTROL_CTS USART_CR3_CTSE /*!< Clear To Send */ 388 #define UART_HWCONTROL_RTS_CTS (USART_CR3_RTSE | USART_CR3_CTSE) /*!< Request and Clear To Send */ 389 /** 390 * @} 391 */ 392 393 /** @defgroup UART_Mode UART Transfer Mode 394 * @{ 395 */ 396 #define UART_MODE_RX USART_CR1_RE /*!< RX mode */ 397 #define UART_MODE_TX USART_CR1_TE /*!< TX mode */ 398 #define UART_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< RX and TX mode */ 399 /** 400 * @} 401 */ 402 403 /** @defgroup UART_State UART State 404 * @{ 405 */ 406 #define UART_STATE_DISABLE 0x00000000U /*!< UART disabled */ 407 #define UART_STATE_ENABLE USART_CR1_UE /*!< UART enabled */ 408 /** 409 * @} 410 */ 411 412 /** @defgroup UART_Over_Sampling UART Over Sampling 413 * @{ 414 */ 415 #define UART_OVERSAMPLING_16 0x00000000U /*!< Oversampling by 16 */ 416 #define UART_OVERSAMPLING_8 USART_CR1_OVER8 /*!< Oversampling by 8 */ 417 /** 418 * @} 419 */ 420 421 /** @defgroup UART_OneBit_Sampling UART One Bit Sampling Method 422 * @{ 423 */ 424 #define UART_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< One-bit sampling disable */ 425 #define UART_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< One-bit sampling enable */ 426 /** 427 * @} 428 */ 429 430 /** @defgroup UART_AutoBaud_Rate_Mode UART Advanced Feature AutoBaud Rate Mode 431 * @{ 432 */ 433 #define UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT 0x00000000U /*!< Auto Baud rate detection 434 on start bit */ 435 #define UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE USART_CR2_ABRMODE_0 /*!< Auto Baud rate detection 436 on falling edge */ 437 #define UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME USART_CR2_ABRMODE_1 /*!< Auto Baud rate detection 438 on 0x7F frame detection */ 439 #define UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME USART_CR2_ABRMODE /*!< Auto Baud rate detection 440 on 0x55 frame detection */ 441 /** 442 * @} 443 */ 444 445 /** @defgroup UART_Receiver_Timeout UART Receiver Timeout 446 * @{ 447 */ 448 #define UART_RECEIVER_TIMEOUT_DISABLE 0x00000000U /*!< UART Receiver Timeout disable */ 449 #define UART_RECEIVER_TIMEOUT_ENABLE USART_CR2_RTOEN /*!< UART Receiver Timeout enable */ 450 /** 451 * @} 452 */ 453 454 /** @defgroup UART_LIN UART Local Interconnection Network mode 455 * @{ 456 */ 457 #define UART_LIN_DISABLE 0x00000000U /*!< Local Interconnect Network disable */ 458 #define UART_LIN_ENABLE USART_CR2_LINEN /*!< Local Interconnect Network enable */ 459 /** 460 * @} 461 */ 462 463 /** @defgroup UART_LIN_Break_Detection UART LIN Break Detection 464 * @{ 465 */ 466 #define UART_LINBREAKDETECTLENGTH_10B 0x00000000U /*!< LIN 10-bit break detection length */ 467 #define UART_LINBREAKDETECTLENGTH_11B USART_CR2_LBDL /*!< LIN 11-bit break detection length */ 468 /** 469 * @} 470 */ 471 472 /** @defgroup UART_DMA_Tx UART DMA Tx 473 * @{ 474 */ 475 #define UART_DMA_TX_DISABLE 0x00000000U /*!< UART DMA TX disabled */ 476 #define UART_DMA_TX_ENABLE USART_CR3_DMAT /*!< UART DMA TX enabled */ 477 /** 478 * @} 479 */ 480 481 /** @defgroup UART_DMA_Rx UART DMA Rx 482 * @{ 483 */ 484 #define UART_DMA_RX_DISABLE 0x00000000U /*!< UART DMA RX disabled */ 485 #define UART_DMA_RX_ENABLE USART_CR3_DMAR /*!< UART DMA RX enabled */ 486 /** 487 * @} 488 */ 489 490 /** @defgroup UART_Half_Duplex_Selection UART Half Duplex Selection 491 * @{ 492 */ 493 #define UART_HALF_DUPLEX_DISABLE 0x00000000U /*!< UART half-duplex disabled */ 494 #define UART_HALF_DUPLEX_ENABLE USART_CR3_HDSEL /*!< UART half-duplex enabled */ 495 /** 496 * @} 497 */ 498 499 /** @defgroup UART_WakeUp_Methods UART WakeUp Methods 500 * @{ 501 */ 502 #define UART_WAKEUPMETHOD_IDLELINE 0x00000000U /*!< UART wake-up on idle line */ 503 #define UART_WAKEUPMETHOD_ADDRESSMARK USART_CR1_WAKE /*!< UART wake-up on address mark */ 504 /** 505 * @} 506 */ 507 508 /** @defgroup UART_Request_Parameters UART Request Parameters 509 * @{ 510 */ 511 #define UART_AUTOBAUD_REQUEST USART_RQR_ABRRQ /*!< Auto-Baud Rate Request */ 512 #define UART_SENDBREAK_REQUEST USART_RQR_SBKRQ /*!< Send Break Request */ 513 #define UART_MUTE_MODE_REQUEST USART_RQR_MMRQ /*!< Mute Mode Request */ 514 #define UART_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive Data flush Request */ 515 #define UART_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush Request */ 516 /** 517 * @} 518 */ 519 520 /** @defgroup UART_Advanced_Features_Initialization_Type UART Advanced Feature Initialization Type 521 * @{ 522 */ 523 #define UART_ADVFEATURE_NO_INIT 0x00000000U /*!< No advanced feature initialization */ 524 #define UART_ADVFEATURE_TXINVERT_INIT 0x00000001U /*!< TX pin active level inversion */ 525 #define UART_ADVFEATURE_RXINVERT_INIT 0x00000002U /*!< RX pin active level inversion */ 526 #define UART_ADVFEATURE_DATAINVERT_INIT 0x00000004U /*!< Binary data inversion */ 527 #define UART_ADVFEATURE_SWAP_INIT 0x00000008U /*!< TX/RX pins swap */ 528 #define UART_ADVFEATURE_RXOVERRUNDISABLE_INIT 0x00000010U /*!< RX overrun disable */ 529 #define UART_ADVFEATURE_DMADISABLEONERROR_INIT 0x00000020U /*!< DMA disable on Reception Error */ 530 #define UART_ADVFEATURE_AUTOBAUDRATE_INIT 0x00000040U /*!< Auto Baud rate detection initialization */ 531 #define UART_ADVFEATURE_MSBFIRST_INIT 0x00000080U /*!< Most significant bit sent/received first */ 532 /** 533 * @} 534 */ 535 536 /** @defgroup UART_Tx_Inv UART Advanced Feature TX Pin Active Level Inversion 537 * @{ 538 */ 539 #define UART_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */ 540 #define UART_ADVFEATURE_TXINV_ENABLE USART_CR2_TXINV /*!< TX pin active level inversion enable */ 541 /** 542 * @} 543 */ 544 545 /** @defgroup UART_Rx_Inv UART Advanced Feature RX Pin Active Level Inversion 546 * @{ 547 */ 548 #define UART_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */ 549 #define UART_ADVFEATURE_RXINV_ENABLE USART_CR2_RXINV /*!< RX pin active level inversion enable */ 550 /** 551 * @} 552 */ 553 554 /** @defgroup UART_Data_Inv UART Advanced Feature Binary Data Inversion 555 * @{ 556 */ 557 #define UART_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */ 558 #define UART_ADVFEATURE_DATAINV_ENABLE USART_CR2_DATAINV /*!< Binary data inversion enable */ 559 /** 560 * @} 561 */ 562 563 /** @defgroup UART_Rx_Tx_Swap UART Advanced Feature RX TX Pins Swap 564 * @{ 565 */ 566 #define UART_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */ 567 #define UART_ADVFEATURE_SWAP_ENABLE USART_CR2_SWAP /*!< TX/RX pins swap enable */ 568 /** 569 * @} 570 */ 571 572 /** @defgroup UART_Overrun_Disable UART Advanced Feature Overrun Disable 573 * @{ 574 */ 575 #define UART_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */ 576 #define UART_ADVFEATURE_OVERRUN_DISABLE USART_CR3_OVRDIS /*!< RX overrun disable */ 577 /** 578 * @} 579 */ 580 581 /** @defgroup UART_AutoBaudRate_Enable UART Advanced Feature Auto BaudRate Enable 582 * @{ 583 */ 584 #define UART_ADVFEATURE_AUTOBAUDRATE_DISABLE 0x00000000U /*!< RX Auto Baud rate detection enable */ 585 #define UART_ADVFEATURE_AUTOBAUDRATE_ENABLE USART_CR2_ABREN /*!< RX Auto Baud rate detection disable */ 586 /** 587 * @} 588 */ 589 590 /** @defgroup UART_DMA_Disable_on_Rx_Error UART Advanced Feature DMA Disable On Rx Error 591 * @{ 592 */ 593 #define UART_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */ 594 #define UART_ADVFEATURE_DMA_DISABLEONRXERROR USART_CR3_DDRE /*!< DMA disable on Reception Error */ 595 /** 596 * @} 597 */ 598 599 /** @defgroup UART_MSB_First UART Advanced Feature MSB First 600 * @{ 601 */ 602 #define UART_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received 603 first disable */ 604 #define UART_ADVFEATURE_MSBFIRST_ENABLE USART_CR2_MSBFIRST /*!< Most significant bit sent/received 605 first enable */ 606 /** 607 * @} 608 */ 609 610 /** @defgroup UART_Stop_Mode_Enable UART Advanced Feature Stop Mode Enable 611 * @{ 612 */ 613 #define UART_ADVFEATURE_STOPMODE_DISABLE 0x00000000U /*!< UART stop mode disable */ 614 #define UART_ADVFEATURE_STOPMODE_ENABLE USART_CR1_UESM /*!< UART stop mode enable */ 615 /** 616 * @} 617 */ 618 619 /** @defgroup UART_Mute_Mode UART Advanced Feature Mute Mode Enable 620 * @{ 621 */ 622 #define UART_ADVFEATURE_MUTEMODE_DISABLE 0x00000000U /*!< UART mute mode disable */ 623 #define UART_ADVFEATURE_MUTEMODE_ENABLE USART_CR1_MME /*!< UART mute mode enable */ 624 /** 625 * @} 626 */ 627 628 /** @defgroup UART_CR2_ADDRESS_LSB_POS UART Address-matching LSB Position In CR2 Register 629 * @{ 630 */ 631 #define UART_CR2_ADDRESS_LSB_POS 24U /*!< UART address-matching LSB position in CR2 register */ 632 /** 633 * @} 634 */ 635 636 /** @defgroup UART_WakeUp_from_Stop_Selection UART WakeUp From Stop Selection 637 * @{ 638 */ 639 #define UART_WAKEUP_ON_ADDRESS 0x00000000U /*!< UART wake-up on address */ 640 #define UART_WAKEUP_ON_STARTBIT USART_CR3_WUS_1 /*!< UART wake-up on start bit */ 641 #define UART_WAKEUP_ON_READDATA_NONEMPTY USART_CR3_WUS /*!< UART wake-up on receive data register 642 not empty or RXFIFO is not empty */ 643 /** 644 * @} 645 */ 646 647 /** @defgroup UART_DriverEnable_Polarity UART DriverEnable Polarity 648 * @{ 649 */ 650 #define UART_DE_POLARITY_HIGH 0x00000000U /*!< Driver enable signal is active high */ 651 #define UART_DE_POLARITY_LOW USART_CR3_DEP /*!< Driver enable signal is active low */ 652 /** 653 * @} 654 */ 655 656 /** @defgroup UART_CR1_DEAT_ADDRESS_LSB_POS UART Driver Enable Assertion Time LSB Position In CR1 Register 657 * @{ 658 */ 659 #define UART_CR1_DEAT_ADDRESS_LSB_POS 21U /*!< UART Driver Enable assertion time LSB 660 position in CR1 register */ 661 /** 662 * @} 663 */ 664 665 /** @defgroup UART_CR1_DEDT_ADDRESS_LSB_POS UART Driver Enable DeAssertion Time LSB Position In CR1 Register 666 * @{ 667 */ 668 #define UART_CR1_DEDT_ADDRESS_LSB_POS 16U /*!< UART Driver Enable de-assertion time LSB 669 position in CR1 register */ 670 /** 671 * @} 672 */ 673 674 /** @defgroup UART_Interruption_Mask UART Interruptions Flag Mask 675 * @{ 676 */ 677 #define UART_IT_MASK 0x001FU /*!< UART interruptions flags mask */ 678 /** 679 * @} 680 */ 681 682 /** @defgroup UART_TimeOut_Value UART polling-based communications time-out value 683 * @{ 684 */ 685 #define HAL_UART_TIMEOUT_VALUE 0x1FFFFFFU /*!< UART polling-based communications time-out value */ 686 /** 687 * @} 688 */ 689 690 /** @defgroup UART_Flags UART Status Flags 691 * Elements values convention: 0xXXXX 692 * - 0xXXXX : Flag mask in the ISR register 693 * @{ 694 */ 695 #define UART_FLAG_REACK USART_ISR_REACK /*!< UART receive enable acknowledge flag */ 696 #define UART_FLAG_TEACK USART_ISR_TEACK /*!< UART transmit enable acknowledge flag */ 697 #define UART_FLAG_WUF USART_ISR_WUF /*!< UART wake-up from stop mode flag */ 698 #define UART_FLAG_RWU USART_ISR_RWU /*!< UART receiver wake-up from mute mode flag */ 699 #define UART_FLAG_SBKF USART_ISR_SBKF /*!< UART send break flag */ 700 #define UART_FLAG_CMF USART_ISR_CMF /*!< UART character match flag */ 701 #define UART_FLAG_BUSY USART_ISR_BUSY /*!< UART busy flag */ 702 #define UART_FLAG_ABRF USART_ISR_ABRF /*!< UART auto Baud rate flag */ 703 #define UART_FLAG_ABRE USART_ISR_ABRE /*!< UART auto Baud rate error */ 704 #define UART_FLAG_RTOF USART_ISR_RTOF /*!< UART receiver timeout flag */ 705 #define UART_FLAG_CTS USART_ISR_CTS /*!< UART clear to send flag */ 706 #define UART_FLAG_CTSIF USART_ISR_CTSIF /*!< UART clear to send interrupt flag */ 707 #define UART_FLAG_LBDF USART_ISR_LBDF /*!< UART LIN break detection flag */ 708 #define UART_FLAG_TXE USART_ISR_TXE /*!< UART transmit data register empty */ 709 #define UART_FLAG_TC USART_ISR_TC /*!< UART transmission complete */ 710 #define UART_FLAG_RXNE USART_ISR_RXNE /*!< UART read data register not empty */ 711 #define UART_FLAG_IDLE USART_ISR_IDLE /*!< UART idle flag */ 712 #define UART_FLAG_ORE USART_ISR_ORE /*!< UART overrun error */ 713 #define UART_FLAG_NE USART_ISR_NE /*!< UART noise error */ 714 #define UART_FLAG_FE USART_ISR_FE /*!< UART frame error */ 715 #define UART_FLAG_PE USART_ISR_PE /*!< UART parity error */ 716 /** 717 * @} 718 */ 719 720 /** @defgroup UART_Interrupt_definition UART Interrupts Definition 721 * Elements values convention: 000ZZZZZ0XXYYYYYb 722 * - YYYYY : Interrupt source position in the XX register (5bits) 723 * - XX : Interrupt source register (2bits) 724 * - 01: CR1 register 725 * - 10: CR2 register 726 * - 11: CR3 register 727 * - ZZZZZ : Flag position in the ISR register(5bits) 728 * Elements values convention: 000000000XXYYYYYb 729 * - YYYYY : Interrupt source position in the XX register (5bits) 730 * - XX : Interrupt source register (2bits) 731 * - 01: CR1 register 732 * - 10: CR2 register 733 * - 11: CR3 register 734 * Elements values convention: 0000ZZZZ00000000b 735 * - ZZZZ : Flag position in the ISR register(4bits) 736 * @{ 737 */ 738 #define UART_IT_PE 0x0028U /*!< UART parity error interruption */ 739 #define UART_IT_TXE 0x0727U /*!< UART transmit data register empty interruption */ 740 #define UART_IT_TC 0x0626U /*!< UART transmission complete interruption */ 741 #define UART_IT_RXNE 0x0525U /*!< UART read data register not empty interruption */ 742 #define UART_IT_IDLE 0x0424U /*!< UART idle interruption */ 743 #define UART_IT_LBD 0x0846U /*!< UART LIN break detection interruption */ 744 #define UART_IT_CTS 0x096AU /*!< UART CTS interruption */ 745 #define UART_IT_CM 0x112EU /*!< UART character match interruption */ 746 #define UART_IT_WUF 0x1476U /*!< UART wake-up from stop mode interruption */ 747 #define UART_IT_RTO 0x0B3AU /*!< UART receiver timeout interruption */ 748 749 #define UART_IT_ERR 0x0060U /*!< UART error interruption */ 750 751 #define UART_IT_ORE 0x0300U /*!< UART overrun error interruption */ 752 #define UART_IT_NE 0x0200U /*!< UART noise error interruption */ 753 #define UART_IT_FE 0x0100U /*!< UART frame error interruption */ 754 /** 755 * @} 756 */ 757 758 /** @defgroup UART_IT_CLEAR_Flags UART Interruption Clear Flags 759 * @{ 760 */ 761 #define UART_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */ 762 #define UART_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */ 763 #define UART_CLEAR_NEF USART_ICR_NCF /*!< Noise Error detected Clear Flag */ 764 #define UART_CLEAR_OREF USART_ICR_ORECF /*!< Overrun Error Clear Flag */ 765 #define UART_CLEAR_IDLEF USART_ICR_IDLECF /*!< IDLE line detected Clear Flag */ 766 #define UART_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */ 767 #define UART_CLEAR_LBDF USART_ICR_LBDCF /*!< LIN Break Detection Clear Flag */ 768 #define UART_CLEAR_CTSF USART_ICR_CTSCF /*!< CTS Interrupt Clear Flag */ 769 #define UART_CLEAR_CMF USART_ICR_CMCF /*!< Character Match Clear Flag */ 770 #define UART_CLEAR_WUF USART_ICR_WUCF /*!< Wake Up from stop mode Clear Flag */ 771 #define UART_CLEAR_RTOF USART_ICR_RTOCF /*!< UART receiver timeout clear flag */ 772 /** 773 * @} 774 */ 775 776 /** @defgroup UART_Reception_Type_Values UART Reception type values 777 * @{ 778 */ 779 #define HAL_UART_RECEPTION_STANDARD (0x00000000U) /*!< Standard reception */ 780 #define HAL_UART_RECEPTION_TOIDLE (0x00000001U) /*!< Reception till completion or IDLE event */ 781 #define HAL_UART_RECEPTION_TORTO (0x00000002U) /*!< Reception till completion or RTO event */ 782 #define HAL_UART_RECEPTION_TOCHARMATCH (0x00000003U) /*!< Reception till completion or CM event */ 783 /** 784 * @} 785 */ 786 787 /** @defgroup UART_RxEvent_Type_Values UART RxEvent type values 788 * @{ 789 */ 790 #define HAL_UART_RXEVENT_TC (0x00000000U) /*!< RxEvent linked to Transfer Complete event */ 791 #define HAL_UART_RXEVENT_HT (0x00000001U) /*!< RxEvent linked to Half Transfer event */ 792 #define HAL_UART_RXEVENT_IDLE (0x00000002U) /*!< RxEvent linked to IDLE event */ 793 /** 794 * @} 795 */ 796 797 /** 798 * @} 799 */ 800 801 /* Exported macros -----------------------------------------------------------*/ 802 /** @defgroup UART_Exported_Macros UART Exported Macros 803 * @{ 804 */ 805 806 /** @brief Reset UART handle states. 807 * @param __HANDLE__ UART handle. 808 * @retval None 809 */ 810 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1) 811 #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \ 812 (__HANDLE__)->gState = HAL_UART_STATE_RESET; \ 813 (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \ 814 (__HANDLE__)->MspInitCallback = NULL; \ 815 (__HANDLE__)->MspDeInitCallback = NULL; \ 816 } while(0U) 817 #else 818 #define __HAL_UART_RESET_HANDLE_STATE(__HANDLE__) do{ \ 819 (__HANDLE__)->gState = HAL_UART_STATE_RESET; \ 820 (__HANDLE__)->RxState = HAL_UART_STATE_RESET; \ 821 } while(0U) 822 #endif /*USE_HAL_UART_REGISTER_CALLBACKS */ 823 824 /** @brief Flush the UART Data registers. 825 * @param __HANDLE__ specifies the UART Handle. 826 * @retval None 827 */ 828 #define __HAL_UART_FLUSH_DRREGISTER(__HANDLE__) \ 829 do{ \ 830 SET_BIT((__HANDLE__)->Instance->RQR, UART_RXDATA_FLUSH_REQUEST); \ 831 SET_BIT((__HANDLE__)->Instance->RQR, UART_TXDATA_FLUSH_REQUEST); \ 832 } while(0U) 833 834 /** @brief Clear the specified UART pending flag. 835 * @param __HANDLE__ specifies the UART Handle. 836 * @param __FLAG__ specifies the flag to check. 837 * This parameter can be any combination of the following values: 838 * @arg @ref UART_CLEAR_PEF Parity Error Clear Flag 839 * @arg @ref UART_CLEAR_FEF Framing Error Clear Flag 840 * @arg @ref UART_CLEAR_NEF Noise detected Clear Flag 841 * @arg @ref UART_CLEAR_OREF Overrun Error Clear Flag 842 * @arg @ref UART_CLEAR_IDLEF IDLE line detected Clear Flag 843 * @arg @ref UART_CLEAR_TCF Transmission Complete Clear Flag 844 * @arg @ref UART_CLEAR_RTOF Receiver Timeout clear flag 845 * @arg @ref UART_CLEAR_LBDF LIN Break Detection Clear Flag 846 * @arg @ref UART_CLEAR_CTSF CTS Interrupt Clear Flag 847 * @arg @ref UART_CLEAR_CMF Character Match Clear Flag 848 * @arg @ref UART_CLEAR_WUF Wake Up from stop mode Clear Flag 849 * @retval None 850 */ 851 #define __HAL_UART_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) 852 853 /** @brief Clear the UART PE pending flag. 854 * @param __HANDLE__ specifies the UART Handle. 855 * @retval None 856 */ 857 #define __HAL_UART_CLEAR_PEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_PEF) 858 859 /** @brief Clear the UART FE pending flag. 860 * @param __HANDLE__ specifies the UART Handle. 861 * @retval None 862 */ 863 #define __HAL_UART_CLEAR_FEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_FEF) 864 865 /** @brief Clear the UART NE pending flag. 866 * @param __HANDLE__ specifies the UART Handle. 867 * @retval None 868 */ 869 #define __HAL_UART_CLEAR_NEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_NEF) 870 871 /** @brief Clear the UART ORE pending flag. 872 * @param __HANDLE__ specifies the UART Handle. 873 * @retval None 874 */ 875 #define __HAL_UART_CLEAR_OREFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_OREF) 876 877 /** @brief Clear the UART IDLE pending flag. 878 * @param __HANDLE__ specifies the UART Handle. 879 * @retval None 880 */ 881 #define __HAL_UART_CLEAR_IDLEFLAG(__HANDLE__) __HAL_UART_CLEAR_FLAG((__HANDLE__), UART_CLEAR_IDLEF) 882 883 884 /** @brief Check whether the specified UART flag is set or not. 885 * @param __HANDLE__ specifies the UART Handle. 886 * @param __FLAG__ specifies the flag to check. 887 * This parameter can be one of the following values: 888 * @arg @ref UART_FLAG_REACK Receive enable acknowledge flag 889 * @arg @ref UART_FLAG_TEACK Transmit enable acknowledge flag 890 * @arg @ref UART_FLAG_WUF Wake up from stop mode flag 891 * @arg @ref UART_FLAG_RWU Receiver wake up flag (if the UART in mute mode) 892 * @arg @ref UART_FLAG_SBKF Send Break flag 893 * @arg @ref UART_FLAG_CMF Character match flag 894 * @arg @ref UART_FLAG_BUSY Busy flag 895 * @arg @ref UART_FLAG_ABRF Auto Baud rate detection flag 896 * @arg @ref UART_FLAG_ABRE Auto Baud rate detection error flag 897 * @arg @ref UART_FLAG_CTS CTS Change flag 898 * @arg @ref UART_FLAG_LBDF LIN Break detection flag 899 * @arg @ref UART_FLAG_TXE Transmit data register empty flag 900 * @arg @ref UART_FLAG_TC Transmission Complete flag 901 * @arg @ref UART_FLAG_RXNE Receive data register not empty flag 902 * @arg @ref UART_FLAG_RTOF Receiver Timeout flag 903 * @arg @ref UART_FLAG_IDLE Idle Line detection flag 904 * @arg @ref UART_FLAG_ORE Overrun Error flag 905 * @arg @ref UART_FLAG_NE Noise Error flag 906 * @arg @ref UART_FLAG_FE Framing Error flag 907 * @arg @ref UART_FLAG_PE Parity Error flag 908 * @retval The new state of __FLAG__ (TRUE or FALSE). 909 */ 910 #define __HAL_UART_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__)) 911 912 /** @brief Enable the specified UART interrupt. 913 * @param __HANDLE__ specifies the UART Handle. 914 * @param __INTERRUPT__ specifies the UART interrupt source to enable. 915 * This parameter can be one of the following values: 916 * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt 917 * @arg @ref UART_IT_CM Character match interrupt 918 * @arg @ref UART_IT_CTS CTS change interrupt 919 * @arg @ref UART_IT_LBD LIN Break detection interrupt 920 * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt 921 * @arg @ref UART_IT_TC Transmission complete interrupt 922 * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt 923 * @arg @ref UART_IT_RTO Receive Timeout interrupt 924 * @arg @ref UART_IT_IDLE Idle line detection interrupt 925 * @arg @ref UART_IT_PE Parity Error interrupt 926 * @arg @ref UART_IT_ERR Error interrupt (frame error, noise error, overrun error) 927 * @retval None 928 */ 929 #define __HAL_UART_ENABLE_IT(__HANDLE__, __INTERRUPT__) (\ 930 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)?\ 931 ((__HANDLE__)->Instance->CR1 |= (1U <<\ 932 ((__INTERRUPT__) & UART_IT_MASK))): \ 933 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)?\ 934 ((__HANDLE__)->Instance->CR2 |= (1U <<\ 935 ((__INTERRUPT__) & UART_IT_MASK))): \ 936 ((__HANDLE__)->Instance->CR3 |= (1U <<\ 937 ((__INTERRUPT__) & UART_IT_MASK)))) 938 939 /** @brief Disable the specified UART interrupt. 940 * @param __HANDLE__ specifies the UART Handle. 941 * @param __INTERRUPT__ specifies the UART interrupt source to disable. 942 * This parameter can be one of the following values: 943 * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt 944 * @arg @ref UART_IT_CM Character match interrupt 945 * @arg @ref UART_IT_CTS CTS change interrupt 946 * @arg @ref UART_IT_LBD LIN Break detection interrupt 947 * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt 948 * @arg @ref UART_IT_TC Transmission complete interrupt 949 * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt 950 * @arg @ref UART_IT_RTO Receive Timeout interrupt 951 * @arg @ref UART_IT_IDLE Idle line detection interrupt 952 * @arg @ref UART_IT_PE Parity Error interrupt 953 * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error) 954 * @retval None 955 */ 956 #define __HAL_UART_DISABLE_IT(__HANDLE__, __INTERRUPT__) (\ 957 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U)?\ 958 ((__HANDLE__)->Instance->CR1 &= ~ (1U <<\ 959 ((__INTERRUPT__) & UART_IT_MASK))): \ 960 ((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U)?\ 961 ((__HANDLE__)->Instance->CR2 &= ~ (1U <<\ 962 ((__INTERRUPT__) & UART_IT_MASK))): \ 963 ((__HANDLE__)->Instance->CR3 &= ~ (1U <<\ 964 ((__INTERRUPT__) & UART_IT_MASK)))) 965 966 /** @brief Check whether the specified UART interrupt has occurred or not. 967 * @param __HANDLE__ specifies the UART Handle. 968 * @param __INTERRUPT__ specifies the UART interrupt to check. 969 * This parameter can be one of the following values: 970 * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt 971 * @arg @ref UART_IT_CM Character match interrupt 972 * @arg @ref UART_IT_CTS CTS change interrupt 973 * @arg @ref UART_IT_LBD LIN Break detection interrupt 974 * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt 975 * @arg @ref UART_IT_TC Transmission complete interrupt 976 * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt 977 * @arg @ref UART_IT_RTO Receive Timeout interrupt 978 * @arg @ref UART_IT_IDLE Idle line detection interrupt 979 * @arg @ref UART_IT_PE Parity Error interrupt 980 * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error) 981 * @retval The new state of __INTERRUPT__ (SET or RESET). 982 */ 983 #define __HAL_UART_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR\ 984 & (1U << ((__INTERRUPT__)>> 8U))) != RESET) ? SET : RESET) 985 986 /** @brief Check whether the specified UART interrupt source is enabled or not. 987 * @param __HANDLE__ specifies the UART Handle. 988 * @param __INTERRUPT__ specifies the UART interrupt source to check. 989 * This parameter can be one of the following values: 990 * @arg @ref UART_IT_WUF Wakeup from stop mode interrupt 991 * @arg @ref UART_IT_CM Character match interrupt 992 * @arg @ref UART_IT_CTS CTS change interrupt 993 * @arg @ref UART_IT_LBD LIN Break detection interrupt 994 * @arg @ref UART_IT_TXE Transmit Data Register empty interrupt 995 * @arg @ref UART_IT_TC Transmission complete interrupt 996 * @arg @ref UART_IT_RXNE Receive Data register not empty interrupt 997 * @arg @ref UART_IT_RTO Receive Timeout interrupt 998 * @arg @ref UART_IT_IDLE Idle line detection interrupt 999 * @arg @ref UART_IT_PE Parity Error interrupt 1000 * @arg @ref UART_IT_ERR Error interrupt (Frame error, noise error, overrun error) 1001 * @retval The new state of __INTERRUPT__ (SET or RESET). 1002 */ 1003 #define __HAL_UART_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((uint8_t)(__INTERRUPT__)) >> 5U) == 1U) ?\ 1004 (__HANDLE__)->Instance->CR1 : \ 1005 (((((uint8_t)(__INTERRUPT__)) >> 5U) == 2U) ?\ 1006 (__HANDLE__)->Instance->CR2 : \ 1007 (__HANDLE__)->Instance->CR3)) & (1U <<\ 1008 (((uint16_t)(__INTERRUPT__)) &\ 1009 UART_IT_MASK))) != RESET) ? SET : RESET) 1010 1011 /** @brief Clear the specified UART ISR flag, in setting the proper ICR register flag. 1012 * @param __HANDLE__ specifies the UART Handle. 1013 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set 1014 * to clear the corresponding interrupt 1015 * This parameter can be one of the following values: 1016 * @arg @ref UART_CLEAR_PEF Parity Error Clear Flag 1017 * @arg @ref UART_CLEAR_FEF Framing Error Clear Flag 1018 * @arg @ref UART_CLEAR_NEF Noise detected Clear Flag 1019 * @arg @ref UART_CLEAR_OREF Overrun Error Clear Flag 1020 * @arg @ref UART_CLEAR_IDLEF IDLE line detected Clear Flag 1021 * @arg @ref UART_CLEAR_RTOF Receiver timeout clear flag 1022 * @arg @ref UART_CLEAR_TCF Transmission Complete Clear Flag 1023 * @arg @ref UART_CLEAR_LBDF LIN Break Detection Clear Flag 1024 * @arg @ref UART_CLEAR_CTSF CTS Interrupt Clear Flag 1025 * @arg @ref UART_CLEAR_CMF Character Match Clear Flag 1026 * @arg @ref UART_CLEAR_WUF Wake Up from stop mode Clear Flag 1027 * @retval None 1028 */ 1029 #define __HAL_UART_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__)) 1030 1031 /** @brief Set a specific UART request flag. 1032 * @param __HANDLE__ specifies the UART Handle. 1033 * @param __REQ__ specifies the request flag to set 1034 * This parameter can be one of the following values: 1035 * @arg @ref UART_AUTOBAUD_REQUEST Auto-Baud Rate Request 1036 * @arg @ref UART_SENDBREAK_REQUEST Send Break Request 1037 * @arg @ref UART_MUTE_MODE_REQUEST Mute Mode Request 1038 * @arg @ref UART_RXDATA_FLUSH_REQUEST Receive Data flush Request 1039 * @arg @ref UART_TXDATA_FLUSH_REQUEST Transmit data flush Request 1040 * @retval None 1041 */ 1042 #define __HAL_UART_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__)) 1043 1044 /** @brief Enable the UART one bit sample method. 1045 * @param __HANDLE__ specifies the UART Handle. 1046 * @retval None 1047 */ 1048 #define __HAL_UART_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT) 1049 1050 /** @brief Disable the UART one bit sample method. 1051 * @param __HANDLE__ specifies the UART Handle. 1052 * @retval None 1053 */ 1054 #define __HAL_UART_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= ~USART_CR3_ONEBIT) 1055 1056 /** @brief Enable UART. 1057 * @param __HANDLE__ specifies the UART Handle. 1058 * @retval None 1059 */ 1060 #define __HAL_UART_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE) 1061 1062 /** @brief Disable UART. 1063 * @param __HANDLE__ specifies the UART Handle. 1064 * @retval None 1065 */ 1066 #define __HAL_UART_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE) 1067 1068 /** @brief Enable CTS flow control. 1069 * @note This macro allows to enable CTS hardware flow control for a given UART instance, 1070 * without need to call HAL_UART_Init() function. 1071 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user. 1072 * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need 1073 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled : 1074 * - UART instance should have already been initialised (through call of HAL_UART_Init() ) 1075 * - macro could only be called when corresponding UART instance is disabled 1076 * (i.e. __HAL_UART_DISABLE(__HANDLE__)) and should be followed by an Enable 1077 * macro (i.e. __HAL_UART_ENABLE(__HANDLE__)). 1078 * @param __HANDLE__ specifies the UART Handle. 1079 * @retval None 1080 */ 1081 #define __HAL_UART_HWCONTROL_CTS_ENABLE(__HANDLE__) \ 1082 do{ \ 1083 ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \ 1084 (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_CTSE; \ 1085 } while(0U) 1086 1087 /** @brief Disable CTS flow control. 1088 * @note This macro allows to disable CTS hardware flow control for a given UART instance, 1089 * without need to call HAL_UART_Init() function. 1090 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user. 1091 * @note As macro is expected to be used for modifying CTS Hw flow control feature activation, without need 1092 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled : 1093 * - UART instance should have already been initialised (through call of HAL_UART_Init() ) 1094 * - macro could only be called when corresponding UART instance is disabled 1095 * (i.e. __HAL_UART_DISABLE(__HANDLE__)) and should be followed by an Enable 1096 * macro (i.e. __HAL_UART_ENABLE(__HANDLE__)). 1097 * @param __HANDLE__ specifies the UART Handle. 1098 * @retval None 1099 */ 1100 #define __HAL_UART_HWCONTROL_CTS_DISABLE(__HANDLE__) \ 1101 do{ \ 1102 ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_CTSE); \ 1103 (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_CTSE); \ 1104 } while(0U) 1105 1106 /** @brief Enable RTS flow control. 1107 * @note This macro allows to enable RTS hardware flow control for a given UART instance, 1108 * without need to call HAL_UART_Init() function. 1109 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user. 1110 * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need 1111 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled : 1112 * - UART instance should have already been initialised (through call of HAL_UART_Init() ) 1113 * - macro could only be called when corresponding UART instance is disabled 1114 * (i.e. __HAL_UART_DISABLE(__HANDLE__)) and should be followed by an Enable 1115 * macro (i.e. __HAL_UART_ENABLE(__HANDLE__)). 1116 * @param __HANDLE__ specifies the UART Handle. 1117 * @retval None 1118 */ 1119 #define __HAL_UART_HWCONTROL_RTS_ENABLE(__HANDLE__) \ 1120 do{ \ 1121 ATOMIC_SET_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE); \ 1122 (__HANDLE__)->Init.HwFlowCtl |= USART_CR3_RTSE; \ 1123 } while(0U) 1124 1125 /** @brief Disable RTS flow control. 1126 * @note This macro allows to disable RTS hardware flow control for a given UART instance, 1127 * without need to call HAL_UART_Init() function. 1128 * As involving direct access to UART registers, usage of this macro should be fully endorsed by user. 1129 * @note As macro is expected to be used for modifying RTS Hw flow control feature activation, without need 1130 * for USART instance Deinit/Init, following conditions for macro call should be fulfilled : 1131 * - UART instance should have already been initialised (through call of HAL_UART_Init() ) 1132 * - macro could only be called when corresponding UART instance is disabled 1133 * (i.e. __HAL_UART_DISABLE(__HANDLE__)) and should be followed by an Enable 1134 * macro (i.e. __HAL_UART_ENABLE(__HANDLE__)). 1135 * @param __HANDLE__ specifies the UART Handle. 1136 * @retval None 1137 */ 1138 #define __HAL_UART_HWCONTROL_RTS_DISABLE(__HANDLE__) \ 1139 do{ \ 1140 ATOMIC_CLEAR_BIT((__HANDLE__)->Instance->CR3, USART_CR3_RTSE);\ 1141 (__HANDLE__)->Init.HwFlowCtl &= ~(USART_CR3_RTSE); \ 1142 } while(0U) 1143 /** 1144 * @} 1145 */ 1146 1147 /* Private macros --------------------------------------------------------*/ 1148 /** @defgroup UART_Private_Macros UART Private Macros 1149 * @{ 1150 */ 1151 1152 /** @brief BRR division operation to set BRR register with LPUART. 1153 * @param __PCLK__ LPUART clock. 1154 * @param __BAUD__ Baud rate set by the user. 1155 * @retval Division result 1156 */ 1157 #define UART_DIV_LPUART(__PCLK__, __BAUD__) (((((uint64_t)(__PCLK__)*256U)) + ((__BAUD__)/2U)) / (__BAUD__)) 1158 1159 /** @brief BRR division operation to set BRR register in 8-bit oversampling mode. 1160 * @param __PCLK__ UART clock. 1161 * @param __BAUD__ Baud rate set by the user. 1162 * @retval Division result 1163 */ 1164 #define UART_DIV_SAMPLING8(__PCLK__, __BAUD__) ((((__PCLK__)*2U) + ((__BAUD__)/2U)) / (__BAUD__)) 1165 1166 /** @brief BRR division operation to set BRR register in 16-bit oversampling mode. 1167 * @param __PCLK__ UART clock. 1168 * @param __BAUD__ Baud rate set by the user. 1169 * @retval Division result 1170 */ 1171 #define UART_DIV_SAMPLING16(__PCLK__, __BAUD__) (((__PCLK__) + ((__BAUD__)/2U)) / (__BAUD__)) 1172 1173 /** @brief Check whether or not UART instance is Low Power UART. 1174 * @param __HANDLE__ specifies the UART Handle. 1175 * @retval SET (instance is LPUART) or RESET (instance isn't LPUART) 1176 */ 1177 #define UART_INSTANCE_LOWPOWER(__HANDLE__) (IS_LPUART_INSTANCE((__HANDLE__)->Instance)) 1178 1179 /** @brief Check UART Baud rate. 1180 * @param __BAUDRATE__ Baudrate specified by the user. 1181 * The maximum Baud Rate is derived from the maximum clock on L0 (i.e. 32 MHz) 1182 * divided by the smallest oversampling used on the USART (i.e. 8) 1183 * @retval SET (__BAUDRATE__ is valid) or RESET (__BAUDRATE__ is invalid) 1184 */ 1185 #define IS_UART_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 4000001U) 1186 1187 /** @brief Check UART assertion time. 1188 * @param __TIME__ 5-bit value assertion time. 1189 * @retval Test result (TRUE or FALSE). 1190 */ 1191 #define IS_UART_ASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1FU) 1192 1193 /** @brief Check UART deassertion time. 1194 * @param __TIME__ 5-bit value deassertion time. 1195 * @retval Test result (TRUE or FALSE). 1196 */ 1197 #define IS_UART_DEASSERTIONTIME(__TIME__) ((__TIME__) <= 0x1FU) 1198 1199 /** 1200 * @brief Ensure that UART frame number of stop bits is valid. 1201 * @param __STOPBITS__ UART frame number of stop bits. 1202 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid) 1203 */ 1204 #define IS_UART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == UART_STOPBITS_0_5) || \ 1205 ((__STOPBITS__) == UART_STOPBITS_1) || \ 1206 ((__STOPBITS__) == UART_STOPBITS_1_5) || \ 1207 ((__STOPBITS__) == UART_STOPBITS_2)) 1208 1209 /** 1210 * @brief Ensure that LPUART frame number of stop bits is valid. 1211 * @param __STOPBITS__ LPUART frame number of stop bits. 1212 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid) 1213 */ 1214 #define IS_LPUART_STOPBITS(__STOPBITS__) (((__STOPBITS__) == UART_STOPBITS_1) || \ 1215 ((__STOPBITS__) == UART_STOPBITS_2)) 1216 1217 /** 1218 * @brief Ensure that UART frame parity is valid. 1219 * @param __PARITY__ UART frame parity. 1220 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid) 1221 */ 1222 #define IS_UART_PARITY(__PARITY__) (((__PARITY__) == UART_PARITY_NONE) || \ 1223 ((__PARITY__) == UART_PARITY_EVEN) || \ 1224 ((__PARITY__) == UART_PARITY_ODD)) 1225 1226 /** 1227 * @brief Ensure that UART hardware flow control is valid. 1228 * @param __CONTROL__ UART hardware flow control. 1229 * @retval SET (__CONTROL__ is valid) or RESET (__CONTROL__ is invalid) 1230 */ 1231 #define IS_UART_HARDWARE_FLOW_CONTROL(__CONTROL__)\ 1232 (((__CONTROL__) == UART_HWCONTROL_NONE) || \ 1233 ((__CONTROL__) == UART_HWCONTROL_RTS) || \ 1234 ((__CONTROL__) == UART_HWCONTROL_CTS) || \ 1235 ((__CONTROL__) == UART_HWCONTROL_RTS_CTS)) 1236 1237 /** 1238 * @brief Ensure that UART communication mode is valid. 1239 * @param __MODE__ UART communication mode. 1240 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 1241 */ 1242 #define IS_UART_MODE(__MODE__) ((((__MODE__) & (~((uint32_t)(UART_MODE_TX_RX)))) == 0x00U) && ((__MODE__) != 0x00U)) 1243 1244 /** 1245 * @brief Ensure that UART state is valid. 1246 * @param __STATE__ UART state. 1247 * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid) 1248 */ 1249 #define IS_UART_STATE(__STATE__) (((__STATE__) == UART_STATE_DISABLE) || \ 1250 ((__STATE__) == UART_STATE_ENABLE)) 1251 1252 /** 1253 * @brief Ensure that UART oversampling is valid. 1254 * @param __SAMPLING__ UART oversampling. 1255 * @retval SET (__SAMPLING__ is valid) or RESET (__SAMPLING__ is invalid) 1256 */ 1257 #define IS_UART_OVERSAMPLING(__SAMPLING__) (((__SAMPLING__) == UART_OVERSAMPLING_16) || \ 1258 ((__SAMPLING__) == UART_OVERSAMPLING_8)) 1259 1260 /** 1261 * @brief Ensure that UART frame sampling is valid. 1262 * @param __ONEBIT__ UART frame sampling. 1263 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid) 1264 */ 1265 #define IS_UART_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == UART_ONE_BIT_SAMPLE_DISABLE) || \ 1266 ((__ONEBIT__) == UART_ONE_BIT_SAMPLE_ENABLE)) 1267 1268 /** 1269 * @brief Ensure that UART auto Baud rate detection mode is valid. 1270 * @param __MODE__ UART auto Baud rate detection mode. 1271 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 1272 */ 1273 #define IS_UART_ADVFEATURE_AUTOBAUDRATEMODE(__MODE__) (((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ONSTARTBIT) || \ 1274 ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ONFALLINGEDGE) || \ 1275 ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ON0X7FFRAME) || \ 1276 ((__MODE__) == UART_ADVFEATURE_AUTOBAUDRATE_ON0X55FRAME)) 1277 1278 /** 1279 * @brief Ensure that UART receiver timeout setting is valid. 1280 * @param __TIMEOUT__ UART receiver timeout setting. 1281 * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid) 1282 */ 1283 #define IS_UART_RECEIVER_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_DISABLE) || \ 1284 ((__TIMEOUT__) == UART_RECEIVER_TIMEOUT_ENABLE)) 1285 1286 /** @brief Check the receiver timeout value. 1287 * @note The maximum UART receiver timeout value is 0xFFFFFF. 1288 * @param __TIMEOUTVALUE__ receiver timeout value. 1289 * @retval Test result (TRUE or FALSE) 1290 */ 1291 #define IS_UART_RECEIVER_TIMEOUT_VALUE(__TIMEOUTVALUE__) ((__TIMEOUTVALUE__) <= 0xFFFFFFU) 1292 1293 /** 1294 * @brief Ensure that UART LIN state is valid. 1295 * @param __LIN__ UART LIN state. 1296 * @retval SET (__LIN__ is valid) or RESET (__LIN__ is invalid) 1297 */ 1298 #define IS_UART_LIN(__LIN__) (((__LIN__) == UART_LIN_DISABLE) || \ 1299 ((__LIN__) == UART_LIN_ENABLE)) 1300 1301 /** 1302 * @brief Ensure that UART LIN break detection length is valid. 1303 * @param __LENGTH__ UART LIN break detection length. 1304 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid) 1305 */ 1306 #define IS_UART_LIN_BREAK_DETECT_LENGTH(__LENGTH__) (((__LENGTH__) == UART_LINBREAKDETECTLENGTH_10B) || \ 1307 ((__LENGTH__) == UART_LINBREAKDETECTLENGTH_11B)) 1308 1309 /** 1310 * @brief Ensure that UART DMA TX state is valid. 1311 * @param __DMATX__ UART DMA TX state. 1312 * @retval SET (__DMATX__ is valid) or RESET (__DMATX__ is invalid) 1313 */ 1314 #define IS_UART_DMA_TX(__DMATX__) (((__DMATX__) == UART_DMA_TX_DISABLE) || \ 1315 ((__DMATX__) == UART_DMA_TX_ENABLE)) 1316 1317 /** 1318 * @brief Ensure that UART DMA RX state is valid. 1319 * @param __DMARX__ UART DMA RX state. 1320 * @retval SET (__DMARX__ is valid) or RESET (__DMARX__ is invalid) 1321 */ 1322 #define IS_UART_DMA_RX(__DMARX__) (((__DMARX__) == UART_DMA_RX_DISABLE) || \ 1323 ((__DMARX__) == UART_DMA_RX_ENABLE)) 1324 1325 /** 1326 * @brief Ensure that UART half-duplex state is valid. 1327 * @param __HDSEL__ UART half-duplex state. 1328 * @retval SET (__HDSEL__ is valid) or RESET (__HDSEL__ is invalid) 1329 */ 1330 #define IS_UART_HALF_DUPLEX(__HDSEL__) (((__HDSEL__) == UART_HALF_DUPLEX_DISABLE) || \ 1331 ((__HDSEL__) == UART_HALF_DUPLEX_ENABLE)) 1332 1333 /** 1334 * @brief Ensure that UART wake-up method is valid. 1335 * @param __WAKEUP__ UART wake-up method . 1336 * @retval SET (__WAKEUP__ is valid) or RESET (__WAKEUP__ is invalid) 1337 */ 1338 #define IS_UART_WAKEUPMETHOD(__WAKEUP__) (((__WAKEUP__) == UART_WAKEUPMETHOD_IDLELINE) || \ 1339 ((__WAKEUP__) == UART_WAKEUPMETHOD_ADDRESSMARK)) 1340 1341 /** 1342 * @brief Ensure that UART request parameter is valid. 1343 * @param __PARAM__ UART request parameter. 1344 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid) 1345 */ 1346 #define IS_UART_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == UART_AUTOBAUD_REQUEST) || \ 1347 ((__PARAM__) == UART_SENDBREAK_REQUEST) || \ 1348 ((__PARAM__) == UART_MUTE_MODE_REQUEST) || \ 1349 ((__PARAM__) == UART_RXDATA_FLUSH_REQUEST) || \ 1350 ((__PARAM__) == UART_TXDATA_FLUSH_REQUEST)) 1351 1352 /** 1353 * @brief Ensure that UART advanced features initialization is valid. 1354 * @param __INIT__ UART advanced features initialization. 1355 * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid) 1356 */ 1357 #define IS_UART_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (UART_ADVFEATURE_NO_INIT | \ 1358 UART_ADVFEATURE_TXINVERT_INIT | \ 1359 UART_ADVFEATURE_RXINVERT_INIT | \ 1360 UART_ADVFEATURE_DATAINVERT_INIT | \ 1361 UART_ADVFEATURE_SWAP_INIT | \ 1362 UART_ADVFEATURE_RXOVERRUNDISABLE_INIT | \ 1363 UART_ADVFEATURE_DMADISABLEONERROR_INIT | \ 1364 UART_ADVFEATURE_AUTOBAUDRATE_INIT | \ 1365 UART_ADVFEATURE_MSBFIRST_INIT)) 1366 1367 /** 1368 * @brief Ensure that UART frame TX inversion setting is valid. 1369 * @param __TXINV__ UART frame TX inversion setting. 1370 * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid) 1371 */ 1372 #define IS_UART_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == UART_ADVFEATURE_TXINV_DISABLE) || \ 1373 ((__TXINV__) == UART_ADVFEATURE_TXINV_ENABLE)) 1374 1375 /** 1376 * @brief Ensure that UART frame RX inversion setting is valid. 1377 * @param __RXINV__ UART frame RX inversion setting. 1378 * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid) 1379 */ 1380 #define IS_UART_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == UART_ADVFEATURE_RXINV_DISABLE) || \ 1381 ((__RXINV__) == UART_ADVFEATURE_RXINV_ENABLE)) 1382 1383 /** 1384 * @brief Ensure that UART frame data inversion setting is valid. 1385 * @param __DATAINV__ UART frame data inversion setting. 1386 * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid) 1387 */ 1388 #define IS_UART_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == UART_ADVFEATURE_DATAINV_DISABLE) || \ 1389 ((__DATAINV__) == UART_ADVFEATURE_DATAINV_ENABLE)) 1390 1391 /** 1392 * @brief Ensure that UART frame RX/TX pins swap setting is valid. 1393 * @param __SWAP__ UART frame RX/TX pins swap setting. 1394 * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid) 1395 */ 1396 #define IS_UART_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == UART_ADVFEATURE_SWAP_DISABLE) || \ 1397 ((__SWAP__) == UART_ADVFEATURE_SWAP_ENABLE)) 1398 1399 /** 1400 * @brief Ensure that UART frame overrun setting is valid. 1401 * @param __OVERRUN__ UART frame overrun setting. 1402 * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid) 1403 */ 1404 #define IS_UART_OVERRUN(__OVERRUN__) (((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_ENABLE) || \ 1405 ((__OVERRUN__) == UART_ADVFEATURE_OVERRUN_DISABLE)) 1406 1407 /** 1408 * @brief Ensure that UART auto Baud rate state is valid. 1409 * @param __AUTOBAUDRATE__ UART auto Baud rate state. 1410 * @retval SET (__AUTOBAUDRATE__ is valid) or RESET (__AUTOBAUDRATE__ is invalid) 1411 */ 1412 #define IS_UART_ADVFEATURE_AUTOBAUDRATE(__AUTOBAUDRATE__) (((__AUTOBAUDRATE__) == \ 1413 UART_ADVFEATURE_AUTOBAUDRATE_DISABLE) || \ 1414 ((__AUTOBAUDRATE__) == UART_ADVFEATURE_AUTOBAUDRATE_ENABLE)) 1415 1416 /** 1417 * @brief Ensure that UART DMA enabling or disabling on error setting is valid. 1418 * @param __DMA__ UART DMA enabling or disabling on error setting. 1419 * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid) 1420 */ 1421 #define IS_UART_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == UART_ADVFEATURE_DMA_ENABLEONRXERROR) || \ 1422 ((__DMA__) == UART_ADVFEATURE_DMA_DISABLEONRXERROR)) 1423 1424 /** 1425 * @brief Ensure that UART frame MSB first setting is valid. 1426 * @param __MSBFIRST__ UART frame MSB first setting. 1427 * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid) 1428 */ 1429 #define IS_UART_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_DISABLE) || \ 1430 ((__MSBFIRST__) == UART_ADVFEATURE_MSBFIRST_ENABLE)) 1431 1432 /** 1433 * @brief Ensure that UART stop mode state is valid. 1434 * @param __STOPMODE__ UART stop mode state. 1435 * @retval SET (__STOPMODE__ is valid) or RESET (__STOPMODE__ is invalid) 1436 */ 1437 #define IS_UART_ADVFEATURE_STOPMODE(__STOPMODE__) (((__STOPMODE__) == UART_ADVFEATURE_STOPMODE_DISABLE) || \ 1438 ((__STOPMODE__) == UART_ADVFEATURE_STOPMODE_ENABLE)) 1439 1440 /** 1441 * @brief Ensure that UART mute mode state is valid. 1442 * @param __MUTE__ UART mute mode state. 1443 * @retval SET (__MUTE__ is valid) or RESET (__MUTE__ is invalid) 1444 */ 1445 #define IS_UART_MUTE_MODE(__MUTE__) (((__MUTE__) == UART_ADVFEATURE_MUTEMODE_DISABLE) || \ 1446 ((__MUTE__) == UART_ADVFEATURE_MUTEMODE_ENABLE)) 1447 1448 /** 1449 * @brief Ensure that UART wake-up selection is valid. 1450 * @param __WAKE__ UART wake-up selection. 1451 * @retval SET (__WAKE__ is valid) or RESET (__WAKE__ is invalid) 1452 */ 1453 #define IS_UART_WAKEUP_SELECTION(__WAKE__) (((__WAKE__) == UART_WAKEUP_ON_ADDRESS) || \ 1454 ((__WAKE__) == UART_WAKEUP_ON_STARTBIT) || \ 1455 ((__WAKE__) == UART_WAKEUP_ON_READDATA_NONEMPTY)) 1456 1457 /** 1458 * @brief Ensure that UART driver enable polarity is valid. 1459 * @param __POLARITY__ UART driver enable polarity. 1460 * @retval SET (__POLARITY__ is valid) or RESET (__POLARITY__ is invalid) 1461 */ 1462 #define IS_UART_DE_POLARITY(__POLARITY__) (((__POLARITY__) == UART_DE_POLARITY_HIGH) || \ 1463 ((__POLARITY__) == UART_DE_POLARITY_LOW)) 1464 1465 1466 /** 1467 * @} 1468 */ 1469 1470 /* Include UART HAL Extended module */ 1471 #include "stm32l0xx_hal_uart_ex.h" 1472 1473 /* Exported functions --------------------------------------------------------*/ 1474 /** @addtogroup UART_Exported_Functions UART Exported Functions 1475 * @{ 1476 */ 1477 1478 /** @addtogroup UART_Exported_Functions_Group1 Initialization and de-initialization functions 1479 * @{ 1480 */ 1481 1482 /* Initialization and de-initialization functions ****************************/ 1483 HAL_StatusTypeDef HAL_UART_Init(UART_HandleTypeDef *huart); 1484 HAL_StatusTypeDef HAL_HalfDuplex_Init(UART_HandleTypeDef *huart); 1485 HAL_StatusTypeDef HAL_LIN_Init(UART_HandleTypeDef *huart, uint32_t BreakDetectLength); 1486 HAL_StatusTypeDef HAL_MultiProcessor_Init(UART_HandleTypeDef *huart, uint8_t Address, uint32_t WakeUpMethod); 1487 HAL_StatusTypeDef HAL_UART_DeInit(UART_HandleTypeDef *huart); 1488 void HAL_UART_MspInit(UART_HandleTypeDef *huart); 1489 void HAL_UART_MspDeInit(UART_HandleTypeDef *huart); 1490 1491 /* Callbacks Register/UnRegister functions ***********************************/ 1492 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1) 1493 HAL_StatusTypeDef HAL_UART_RegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID, 1494 pUART_CallbackTypeDef pCallback); 1495 HAL_StatusTypeDef HAL_UART_UnRegisterCallback(UART_HandleTypeDef *huart, HAL_UART_CallbackIDTypeDef CallbackID); 1496 1497 HAL_StatusTypeDef HAL_UART_RegisterRxEventCallback(UART_HandleTypeDef *huart, pUART_RxEventCallbackTypeDef pCallback); 1498 HAL_StatusTypeDef HAL_UART_UnRegisterRxEventCallback(UART_HandleTypeDef *huart); 1499 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */ 1500 1501 /** 1502 * @} 1503 */ 1504 1505 /** @addtogroup UART_Exported_Functions_Group2 IO operation functions 1506 * @{ 1507 */ 1508 1509 /* IO operation functions *****************************************************/ 1510 HAL_StatusTypeDef HAL_UART_Transmit(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size, uint32_t Timeout); 1511 HAL_StatusTypeDef HAL_UART_Receive(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint32_t Timeout); 1512 HAL_StatusTypeDef HAL_UART_Transmit_IT(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size); 1513 HAL_StatusTypeDef HAL_UART_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size); 1514 HAL_StatusTypeDef HAL_UART_Transmit_DMA(UART_HandleTypeDef *huart, const uint8_t *pData, uint16_t Size); 1515 HAL_StatusTypeDef HAL_UART_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size); 1516 HAL_StatusTypeDef HAL_UART_DMAPause(UART_HandleTypeDef *huart); 1517 HAL_StatusTypeDef HAL_UART_DMAResume(UART_HandleTypeDef *huart); 1518 HAL_StatusTypeDef HAL_UART_DMAStop(UART_HandleTypeDef *huart); 1519 /* Transfer Abort functions */ 1520 HAL_StatusTypeDef HAL_UART_Abort(UART_HandleTypeDef *huart); 1521 HAL_StatusTypeDef HAL_UART_AbortTransmit(UART_HandleTypeDef *huart); 1522 HAL_StatusTypeDef HAL_UART_AbortReceive(UART_HandleTypeDef *huart); 1523 HAL_StatusTypeDef HAL_UART_Abort_IT(UART_HandleTypeDef *huart); 1524 HAL_StatusTypeDef HAL_UART_AbortTransmit_IT(UART_HandleTypeDef *huart); 1525 HAL_StatusTypeDef HAL_UART_AbortReceive_IT(UART_HandleTypeDef *huart); 1526 1527 void HAL_UART_IRQHandler(UART_HandleTypeDef *huart); 1528 void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart); 1529 void HAL_UART_TxCpltCallback(UART_HandleTypeDef *huart); 1530 void HAL_UART_RxHalfCpltCallback(UART_HandleTypeDef *huart); 1531 void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart); 1532 void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart); 1533 void HAL_UART_AbortCpltCallback(UART_HandleTypeDef *huart); 1534 void HAL_UART_AbortTransmitCpltCallback(UART_HandleTypeDef *huart); 1535 void HAL_UART_AbortReceiveCpltCallback(UART_HandleTypeDef *huart); 1536 1537 void HAL_UARTEx_RxEventCallback(UART_HandleTypeDef *huart, uint16_t Size); 1538 1539 /** 1540 * @} 1541 */ 1542 1543 /** @addtogroup UART_Exported_Functions_Group3 Peripheral Control functions 1544 * @{ 1545 */ 1546 1547 /* Peripheral Control functions ************************************************/ 1548 void HAL_UART_ReceiverTimeout_Config(UART_HandleTypeDef *huart, uint32_t TimeoutValue); 1549 HAL_StatusTypeDef HAL_UART_EnableReceiverTimeout(UART_HandleTypeDef *huart); 1550 HAL_StatusTypeDef HAL_UART_DisableReceiverTimeout(UART_HandleTypeDef *huart); 1551 1552 HAL_StatusTypeDef HAL_LIN_SendBreak(UART_HandleTypeDef *huart); 1553 HAL_StatusTypeDef HAL_MultiProcessor_EnableMuteMode(UART_HandleTypeDef *huart); 1554 HAL_StatusTypeDef HAL_MultiProcessor_DisableMuteMode(UART_HandleTypeDef *huart); 1555 void HAL_MultiProcessor_EnterMuteMode(UART_HandleTypeDef *huart); 1556 HAL_StatusTypeDef HAL_HalfDuplex_EnableTransmitter(UART_HandleTypeDef *huart); 1557 HAL_StatusTypeDef HAL_HalfDuplex_EnableReceiver(UART_HandleTypeDef *huart); 1558 1559 /** 1560 * @} 1561 */ 1562 1563 /** @addtogroup UART_Exported_Functions_Group4 Peripheral State and Error functions 1564 * @{ 1565 */ 1566 1567 /* Peripheral State and Errors functions **************************************************/ 1568 HAL_UART_StateTypeDef HAL_UART_GetState(const UART_HandleTypeDef *huart); 1569 uint32_t HAL_UART_GetError(const UART_HandleTypeDef *huart); 1570 1571 /** 1572 * @} 1573 */ 1574 1575 /** 1576 * @} 1577 */ 1578 1579 /* Private functions -----------------------------------------------------------*/ 1580 /** @addtogroup UART_Private_Functions UART Private Functions 1581 * @{ 1582 */ 1583 #if (USE_HAL_UART_REGISTER_CALLBACKS == 1) 1584 void UART_InitCallbacksToDefault(UART_HandleTypeDef *huart); 1585 #endif /* USE_HAL_UART_REGISTER_CALLBACKS */ 1586 HAL_StatusTypeDef UART_SetConfig(UART_HandleTypeDef *huart); 1587 HAL_StatusTypeDef UART_CheckIdleState(UART_HandleTypeDef *huart); 1588 HAL_StatusTypeDef UART_WaitOnFlagUntilTimeout(UART_HandleTypeDef *huart, uint32_t Flag, FlagStatus Status, 1589 uint32_t Tickstart, uint32_t Timeout); 1590 void UART_AdvFeatureConfig(UART_HandleTypeDef *huart); 1591 HAL_StatusTypeDef UART_Start_Receive_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size); 1592 HAL_StatusTypeDef UART_Start_Receive_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size); 1593 1594 /** 1595 * @} 1596 */ 1597 1598 /* Private variables -----------------------------------------------------------*/ 1599 /** 1600 * @} 1601 */ 1602 1603 /** 1604 * @} 1605 */ 1606 1607 #ifdef __cplusplus 1608 } 1609 #endif 1610 1611 #endif /* STM32L0xx_HAL_UART_H */ 1612 1613
