1 /** 2 ****************************************************************************** 3 * @file stm32h5xx_hal_uart_ex.h 4 * @author MCD Application Team 5 * @brief Header file of UART HAL Extended module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2023 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 STM32H5xx_HAL_UART_EX_H 21 #define STM32H5xx_HAL_UART_EX_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32h5xx_hal_def.h" 29 30 /** @addtogroup STM32H5xx_HAL_Driver 31 * @{ 32 */ 33 34 /** @addtogroup UARTEx 35 * @{ 36 */ 37 38 /* Exported types ------------------------------------------------------------*/ 39 /** @defgroup UARTEx_Exported_Types UARTEx Exported Types 40 * @{ 41 */ 42 43 /** 44 * @brief UART wake up from stop mode parameters 45 */ 46 typedef struct 47 { 48 uint32_t WakeUpEvent; /*!< Specifies which event will activate the Wakeup from Stop mode flag (WUF). 49 This parameter can be a value of @ref UART_WakeUp_from_Stop_Selection. 50 If set to UART_WAKEUP_ON_ADDRESS, the two other fields below must 51 be filled up. */ 52 53 uint16_t AddressLength; /*!< Specifies whether the address is 4 or 7-bit long. 54 This parameter can be a value of @ref UARTEx_WakeUp_Address_Length. */ 55 56 uint8_t Address; /*!< UART/USART node address (7-bit long max). */ 57 } UART_WakeUpTypeDef; 58 59 /** 60 * @} 61 */ 62 63 /* Exported constants --------------------------------------------------------*/ 64 /** @defgroup UARTEx_Exported_Constants UARTEx Exported Constants 65 * @{ 66 */ 67 68 /** @defgroup UARTEx_Word_Length UARTEx Word Length 69 * @{ 70 */ 71 #define UART_WORDLENGTH_7B USART_CR1_M1 /*!< 7-bit long UART frame */ 72 #define UART_WORDLENGTH_8B 0x00000000U /*!< 8-bit long UART frame */ 73 #define UART_WORDLENGTH_9B USART_CR1_M0 /*!< 9-bit long UART frame */ 74 /** 75 * @} 76 */ 77 78 /** @defgroup UARTEx_WakeUp_Address_Length UARTEx WakeUp Address Length 79 * @{ 80 */ 81 #define UART_ADDRESS_DETECT_4B 0x00000000U /*!< 4-bit long wake-up address */ 82 #define UART_ADDRESS_DETECT_7B USART_CR2_ADDM7 /*!< 7-bit long wake-up address */ 83 /** 84 * @} 85 */ 86 87 /** @defgroup UARTEx_FIFO_mode UARTEx FIFO mode 88 * @brief UART FIFO mode 89 * @{ 90 */ 91 #define UART_FIFOMODE_DISABLE 0x00000000U /*!< FIFO mode disable */ 92 #define UART_FIFOMODE_ENABLE USART_CR1_FIFOEN /*!< FIFO mode enable */ 93 /** 94 * @} 95 */ 96 97 /** @defgroup UARTEx_TXFIFO_threshold_level UARTEx TXFIFO threshold level 98 * @brief UART TXFIFO threshold level 99 * @{ 100 */ 101 #define UART_TXFIFO_THRESHOLD_1_8 0x00000000U /*!< TX FIFO reaches 1/8 of its depth */ 102 #define UART_TXFIFO_THRESHOLD_1_4 USART_CR3_TXFTCFG_0 /*!< TX FIFO reaches 1/4 of its depth */ 103 #define UART_TXFIFO_THRESHOLD_1_2 USART_CR3_TXFTCFG_1 /*!< TX FIFO reaches 1/2 of its depth */ 104 #define UART_TXFIFO_THRESHOLD_3_4 (USART_CR3_TXFTCFG_0|USART_CR3_TXFTCFG_1) /*!< TX FIFO reaches 3/4 of its depth */ 105 #define UART_TXFIFO_THRESHOLD_7_8 USART_CR3_TXFTCFG_2 /*!< TX FIFO reaches 7/8 of its depth */ 106 #define UART_TXFIFO_THRESHOLD_8_8 (USART_CR3_TXFTCFG_2|USART_CR3_TXFTCFG_0) /*!< TX FIFO becomes empty */ 107 /** 108 * @} 109 */ 110 111 /** @defgroup UARTEx_RXFIFO_threshold_level UARTEx RXFIFO threshold level 112 * @brief UART RXFIFO threshold level 113 * @{ 114 */ 115 #define UART_RXFIFO_THRESHOLD_1_8 0x00000000U /*!< RX FIFO reaches 1/8 of its depth */ 116 #define UART_RXFIFO_THRESHOLD_1_4 USART_CR3_RXFTCFG_0 /*!< RX FIFO reaches 1/4 of its depth */ 117 #define UART_RXFIFO_THRESHOLD_1_2 USART_CR3_RXFTCFG_1 /*!< RX FIFO reaches 1/2 of its depth */ 118 #define UART_RXFIFO_THRESHOLD_3_4 (USART_CR3_RXFTCFG_0|USART_CR3_RXFTCFG_1) /*!< RX FIFO reaches 3/4 of its depth */ 119 #define UART_RXFIFO_THRESHOLD_7_8 USART_CR3_RXFTCFG_2 /*!< RX FIFO reaches 7/8 of its depth */ 120 #define UART_RXFIFO_THRESHOLD_8_8 (USART_CR3_RXFTCFG_2|USART_CR3_RXFTCFG_0) /*!< RX FIFO becomes full */ 121 /** 122 * @} 123 */ 124 125 /** 126 * @} 127 */ 128 129 /* Exported macros -----------------------------------------------------------*/ 130 /* Exported functions --------------------------------------------------------*/ 131 /** @addtogroup UARTEx_Exported_Functions 132 * @{ 133 */ 134 135 /** @addtogroup UARTEx_Exported_Functions_Group1 136 * @{ 137 */ 138 139 /* Initialization and de-initialization functions ****************************/ 140 HAL_StatusTypeDef HAL_RS485Ex_Init(UART_HandleTypeDef *huart, uint32_t Polarity, uint32_t AssertionTime, 141 uint32_t DeassertionTime); 142 143 /** 144 * @} 145 */ 146 147 /** @addtogroup UARTEx_Exported_Functions_Group2 148 * @{ 149 */ 150 151 void HAL_UARTEx_WakeupCallback(UART_HandleTypeDef *huart); 152 153 void HAL_UARTEx_RxFifoFullCallback(UART_HandleTypeDef *huart); 154 void HAL_UARTEx_TxFifoEmptyCallback(UART_HandleTypeDef *huart); 155 156 /** 157 * @} 158 */ 159 160 /** @addtogroup UARTEx_Exported_Functions_Group3 161 * @{ 162 */ 163 164 /* Peripheral Control functions **********************************************/ 165 HAL_StatusTypeDef HAL_UARTEx_StopModeWakeUpSourceConfig(UART_HandleTypeDef *huart, UART_WakeUpTypeDef WakeUpSelection); 166 HAL_StatusTypeDef HAL_UARTEx_EnableStopMode(UART_HandleTypeDef *huart); 167 HAL_StatusTypeDef HAL_UARTEx_DisableStopMode(UART_HandleTypeDef *huart); 168 169 HAL_StatusTypeDef HAL_MultiProcessorEx_AddressLength_Set(UART_HandleTypeDef *huart, uint32_t AddressLength); 170 171 HAL_StatusTypeDef HAL_UARTEx_EnableFifoMode(UART_HandleTypeDef *huart); 172 HAL_StatusTypeDef HAL_UARTEx_DisableFifoMode(UART_HandleTypeDef *huart); 173 HAL_StatusTypeDef HAL_UARTEx_SetTxFifoThreshold(UART_HandleTypeDef *huart, uint32_t Threshold); 174 HAL_StatusTypeDef HAL_UARTEx_SetRxFifoThreshold(UART_HandleTypeDef *huart, uint32_t Threshold); 175 176 HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint16_t *RxLen, 177 uint32_t Timeout); 178 HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size); 179 #if defined(HAL_DMA_MODULE_ENABLED) 180 HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size); 181 #endif /* HAL_DMA_MODULE_ENABLED */ 182 183 HAL_UART_RxEventTypeTypeDef HAL_UARTEx_GetRxEventType(const UART_HandleTypeDef *huart); 184 185 186 /** 187 * @} 188 */ 189 190 /** 191 * @} 192 */ 193 194 /* Private macros ------------------------------------------------------------*/ 195 /** @defgroup UARTEx_Private_Macros UARTEx Private Macros 196 * @{ 197 */ 198 199 /** @brief Report the UART clock source. 200 * @param __HANDLE__ specifies the UART Handle. 201 * @param __CLOCKSOURCE__ output variable. 202 * @retval UART clocking source, written in __CLOCKSOURCE__. 203 */ 204 #if (defined(STM32H573xx) || defined(STM32H563xx) || defined(STM32H562xx)) 205 #define UART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ 206 do { \ 207 if((__HANDLE__)->Instance == USART1) \ 208 { \ 209 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART1; \ 210 } \ 211 else if((__HANDLE__)->Instance == USART2) \ 212 { \ 213 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART2; \ 214 } \ 215 else if((__HANDLE__)->Instance == USART3) \ 216 { \ 217 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART3; \ 218 } \ 219 else if((__HANDLE__)->Instance == UART4) \ 220 { \ 221 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_UART4; \ 222 } \ 223 else if((__HANDLE__)->Instance == UART5) \ 224 { \ 225 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_UART5; \ 226 } \ 227 else if((__HANDLE__)->Instance == USART6) \ 228 { \ 229 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART6; \ 230 } \ 231 else if((__HANDLE__)->Instance == UART7) \ 232 { \ 233 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_UART7; \ 234 } \ 235 else if((__HANDLE__)->Instance == UART8) \ 236 { \ 237 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_UART8; \ 238 } \ 239 else if((__HANDLE__)->Instance == UART9) \ 240 { \ 241 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_UART9; \ 242 } \ 243 else if((__HANDLE__)->Instance == USART10) \ 244 { \ 245 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART10; \ 246 } \ 247 else if((__HANDLE__)->Instance == USART11) \ 248 { \ 249 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART11; \ 250 } \ 251 else if((__HANDLE__)->Instance == UART12) \ 252 { \ 253 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_UART12; \ 254 } \ 255 else if((__HANDLE__)->Instance == LPUART1) \ 256 { \ 257 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_LPUART1; \ 258 } \ 259 else \ 260 { \ 261 (__CLOCKSOURCE__) = 0U; \ 262 } \ 263 } while(0U) 264 #elif (defined(STM32H523xx) || defined(STM32H533xx)) 265 #define UART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ 266 do { \ 267 if((__HANDLE__)->Instance == USART1) \ 268 { \ 269 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART1; \ 270 } \ 271 else if((__HANDLE__)->Instance == USART2) \ 272 { \ 273 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART2; \ 274 } \ 275 else if((__HANDLE__)->Instance == USART3) \ 276 { \ 277 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART3; \ 278 } \ 279 else if((__HANDLE__)->Instance == UART4) \ 280 { \ 281 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_UART4; \ 282 } \ 283 else if((__HANDLE__)->Instance == UART5) \ 284 { \ 285 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_UART5; \ 286 } \ 287 else if((__HANDLE__)->Instance == USART6) \ 288 { \ 289 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART6; \ 290 } \ 291 else if((__HANDLE__)->Instance == LPUART1) \ 292 { \ 293 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_LPUART1; \ 294 } \ 295 else \ 296 { \ 297 (__CLOCKSOURCE__) = 0U; \ 298 } \ 299 } while(0U) 300 #else 301 #define UART_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ 302 do { \ 303 if((__HANDLE__)->Instance == USART1) \ 304 { \ 305 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART1; \ 306 } \ 307 else if((__HANDLE__)->Instance == USART2) \ 308 { \ 309 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART2; \ 310 } \ 311 else if((__HANDLE__)->Instance == USART3) \ 312 { \ 313 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_USART3; \ 314 } \ 315 else if((__HANDLE__)->Instance == LPUART1) \ 316 { \ 317 (__CLOCKSOURCE__) = (uint32_t)RCC_PERIPHCLK_LPUART1; \ 318 } \ 319 else \ 320 { \ 321 (__CLOCKSOURCE__) = 0U; \ 322 } \ 323 } while(0U) 324 #endif /* (defined(STM32H573xx) || defined(STM32H563xx) || defined(STM32H562xx) */ 325 326 327 /** @brief Report the UART mask to apply to retrieve the received data 328 * according to the word length and to the parity bits activation. 329 * @note If PCE = 1, the parity bit is not included in the data extracted 330 * by the reception API(). 331 * This masking operation is not carried out in the case of 332 * DMA transfers. 333 * @param __HANDLE__ specifies the UART Handle. 334 * @retval None, the mask to apply to UART RDR register is stored in (__HANDLE__)->Mask field. 335 */ 336 #define UART_MASK_COMPUTATION(__HANDLE__) \ 337 do { \ 338 if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_9B) \ 339 { \ 340 if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \ 341 { \ 342 (__HANDLE__)->Mask = 0x01FFU ; \ 343 } \ 344 else \ 345 { \ 346 (__HANDLE__)->Mask = 0x00FFU ; \ 347 } \ 348 } \ 349 else if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_8B) \ 350 { \ 351 if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \ 352 { \ 353 (__HANDLE__)->Mask = 0x00FFU ; \ 354 } \ 355 else \ 356 { \ 357 (__HANDLE__)->Mask = 0x007FU ; \ 358 } \ 359 } \ 360 else if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_7B) \ 361 { \ 362 if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \ 363 { \ 364 (__HANDLE__)->Mask = 0x007FU ; \ 365 } \ 366 else \ 367 { \ 368 (__HANDLE__)->Mask = 0x003FU ; \ 369 } \ 370 } \ 371 else \ 372 { \ 373 (__HANDLE__)->Mask = 0x0000U; \ 374 } \ 375 } while(0U) 376 377 /** 378 * @brief Ensure that UART frame length is valid. 379 * @param __LENGTH__ UART frame length. 380 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid) 381 */ 382 #define IS_UART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == UART_WORDLENGTH_7B) || \ 383 ((__LENGTH__) == UART_WORDLENGTH_8B) || \ 384 ((__LENGTH__) == UART_WORDLENGTH_9B)) 385 386 /** 387 * @brief Ensure that UART wake-up address length is valid. 388 * @param __ADDRESS__ UART wake-up address length. 389 * @retval SET (__ADDRESS__ is valid) or RESET (__ADDRESS__ is invalid) 390 */ 391 #define IS_UART_ADDRESSLENGTH_DETECT(__ADDRESS__) (((__ADDRESS__) == UART_ADDRESS_DETECT_4B) || \ 392 ((__ADDRESS__) == UART_ADDRESS_DETECT_7B)) 393 394 /** 395 * @brief Ensure that UART TXFIFO threshold level is valid. 396 * @param __THRESHOLD__ UART TXFIFO threshold level. 397 * @retval SET (__THRESHOLD__ is valid) or RESET (__THRESHOLD__ is invalid) 398 */ 399 #define IS_UART_TXFIFO_THRESHOLD(__THRESHOLD__) (((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_1_8) || \ 400 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_1_4) || \ 401 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_1_2) || \ 402 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_3_4) || \ 403 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_7_8) || \ 404 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_8_8)) 405 406 /** 407 * @brief Ensure that UART RXFIFO threshold level is valid. 408 * @param __THRESHOLD__ UART RXFIFO threshold level. 409 * @retval SET (__THRESHOLD__ is valid) or RESET (__THRESHOLD__ is invalid) 410 */ 411 #define IS_UART_RXFIFO_THRESHOLD(__THRESHOLD__) (((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_1_8) || \ 412 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_1_4) || \ 413 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_1_2) || \ 414 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_3_4) || \ 415 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_7_8) || \ 416 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_8_8)) 417 418 /** 419 * @} 420 */ 421 422 /* Private functions ---------------------------------------------------------*/ 423 424 /** 425 * @} 426 */ 427 428 /** 429 * @} 430 */ 431 432 #ifdef __cplusplus 433 } 434 #endif 435 436 #endif /* STM32H5xx_HAL_UART_EX_H */ 437
