1 /** 2 ****************************************************************************** 3 * @file stm32wb0x_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) 2024 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 STM32WB0x_HAL_UART_EX_H 21 #define STM32WB0x_HAL_UART_EX_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32wb0x_hal_def.h" 29 30 /** @addtogroup STM32WB0x_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 #if defined(USART_CR1_UESM) 44 /** 45 * @brief UART wake up from stop mode parameters 46 */ 47 typedef struct 48 { 49 uint32_t WakeUpEvent; /*!< Specifies which event will activate the Wakeup from Stop mode flag (WUF). 50 This parameter can be a value of @ref UART_WakeUp_from_Stop_Selection. 51 If set to UART_WAKEUP_ON_ADDRESS, the two other fields below must 52 be filled up. */ 53 54 uint16_t AddressLength; /*!< Specifies whether the address is 4 or 7-bit long. 55 This parameter can be a value of @ref UARTEx_WakeUp_Address_Length. */ 56 57 uint8_t Address; /*!< UART/USART node address (7-bit long max). */ 58 } UART_WakeUpTypeDef; 59 60 #endif /* USART_CR1_UESM */ 61 /** 62 * @} 63 */ 64 65 /* Exported constants --------------------------------------------------------*/ 66 /** @defgroup UARTEx_Exported_Constants UARTEx Exported Constants 67 * @{ 68 */ 69 70 /** @defgroup UARTEx_Word_Length UARTEx Word Length 71 * @{ 72 */ 73 #define UART_WORDLENGTH_7B USART_CR1_M1 /*!< 7-bit long UART frame */ 74 #define UART_WORDLENGTH_8B 0x00000000U /*!< 8-bit long UART frame */ 75 #define UART_WORDLENGTH_9B USART_CR1_M0 /*!< 9-bit long UART frame */ 76 /** 77 * @} 78 */ 79 80 /** @defgroup UARTEx_WakeUp_Address_Length UARTEx WakeUp Address Length 81 * @{ 82 */ 83 #define UART_ADDRESS_DETECT_4B 0x00000000U /*!< 4-bit long wake-up address */ 84 #define UART_ADDRESS_DETECT_7B USART_CR2_ADDM7 /*!< 7-bit long wake-up address */ 85 /** 86 * @} 87 */ 88 89 /** @defgroup UARTEx_FIFO_mode UARTEx FIFO mode 90 * @brief UART FIFO mode 91 * @{ 92 */ 93 #define UART_FIFOMODE_DISABLE 0x00000000U /*!< FIFO mode disable */ 94 #define UART_FIFOMODE_ENABLE USART_CR1_FIFOEN /*!< FIFO mode enable */ 95 /** 96 * @} 97 */ 98 99 /** @defgroup UARTEx_TXFIFO_threshold_level UARTEx TXFIFO threshold level 100 * @brief UART TXFIFO threshold level 101 * @{ 102 */ 103 #define UART_TXFIFO_THRESHOLD_1_8 0x00000000U /*!< TX FIFO reaches 1/8 of its depth */ 104 #define UART_TXFIFO_THRESHOLD_1_4 USART_CR3_TXFTCFG_0 /*!< TX FIFO reaches 1/4 of its depth */ 105 #define UART_TXFIFO_THRESHOLD_1_2 USART_CR3_TXFTCFG_1 /*!< TX FIFO reaches 1/2 of its depth */ 106 #define UART_TXFIFO_THRESHOLD_3_4 (USART_CR3_TXFTCFG_0|USART_CR3_TXFTCFG_1) /*!< TX FIFO reaches 3/4 of its depth */ 107 #define UART_TXFIFO_THRESHOLD_7_8 USART_CR3_TXFTCFG_2 /*!< TX FIFO reaches 7/8 of its depth */ 108 #define UART_TXFIFO_THRESHOLD_8_8 (USART_CR3_TXFTCFG_2|USART_CR3_TXFTCFG_0) /*!< TX FIFO becomes empty */ 109 /** 110 * @} 111 */ 112 113 /** @defgroup UARTEx_RXFIFO_threshold_level UARTEx RXFIFO threshold level 114 * @brief UART RXFIFO threshold level 115 * @{ 116 */ 117 #define UART_RXFIFO_THRESHOLD_1_8 0x00000000U /*!< RX FIFO reaches 1/8 of its depth */ 118 #define UART_RXFIFO_THRESHOLD_1_4 USART_CR3_RXFTCFG_0 /*!< RX FIFO reaches 1/4 of its depth */ 119 #define UART_RXFIFO_THRESHOLD_1_2 USART_CR3_RXFTCFG_1 /*!< RX FIFO reaches 1/2 of its depth */ 120 #define UART_RXFIFO_THRESHOLD_3_4 (USART_CR3_RXFTCFG_0|USART_CR3_RXFTCFG_1) /*!< RX FIFO reaches 3/4 of its depth */ 121 #define UART_RXFIFO_THRESHOLD_7_8 USART_CR3_RXFTCFG_2 /*!< RX FIFO reaches 7/8 of its depth */ 122 #define UART_RXFIFO_THRESHOLD_8_8 (USART_CR3_RXFTCFG_2|USART_CR3_RXFTCFG_0) /*!< RX FIFO becomes full */ 123 /** 124 * @} 125 */ 126 127 /** 128 * @} 129 */ 130 131 /* Exported macros -----------------------------------------------------------*/ 132 /* Exported functions --------------------------------------------------------*/ 133 /** @addtogroup UARTEx_Exported_Functions 134 * @{ 135 */ 136 137 /** @addtogroup UARTEx_Exported_Functions_Group1 138 * @{ 139 */ 140 141 /* Initialization and de-initialization functions ****************************/ 142 HAL_StatusTypeDef HAL_RS485Ex_Init(UART_HandleTypeDef *huart, uint32_t Polarity, uint32_t AssertionTime, 143 uint32_t DeassertionTime); 144 145 /** 146 * @} 147 */ 148 149 /** @addtogroup UARTEx_Exported_Functions_Group2 150 * @{ 151 */ 152 153 #if defined(USART_CR1_UESM) 154 void HAL_UARTEx_WakeupCallback(UART_HandleTypeDef *huart); 155 156 #endif /* USART_CR1_UESM */ 157 void HAL_UARTEx_RxFifoFullCallback(UART_HandleTypeDef *huart); 158 void HAL_UARTEx_TxFifoEmptyCallback(UART_HandleTypeDef *huart); 159 160 /** 161 * @} 162 */ 163 164 /** @addtogroup UARTEx_Exported_Functions_Group3 165 * @{ 166 */ 167 168 /* Peripheral Control functions **********************************************/ 169 #if defined(USART_CR1_UESM) 170 HAL_StatusTypeDef HAL_UARTEx_StopModeWakeUpSourceConfig(UART_HandleTypeDef *huart, UART_WakeUpTypeDef WakeUpSelection); 171 HAL_StatusTypeDef HAL_UARTEx_EnableStopMode(UART_HandleTypeDef *huart); 172 HAL_StatusTypeDef HAL_UARTEx_DisableStopMode(UART_HandleTypeDef *huart); 173 174 #endif /* USART_CR1_UESM */ 175 HAL_StatusTypeDef HAL_MultiProcessorEx_AddressLength_Set(UART_HandleTypeDef *huart, uint32_t AddressLength); 176 177 HAL_StatusTypeDef HAL_UARTEx_EnableFifoMode(UART_HandleTypeDef *huart); 178 HAL_StatusTypeDef HAL_UARTEx_DisableFifoMode(UART_HandleTypeDef *huart); 179 HAL_StatusTypeDef HAL_UARTEx_SetTxFifoThreshold(UART_HandleTypeDef *huart, uint32_t Threshold); 180 HAL_StatusTypeDef HAL_UARTEx_SetRxFifoThreshold(UART_HandleTypeDef *huart, uint32_t Threshold); 181 182 HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size, uint16_t *RxLen, 183 uint32_t Timeout); 184 HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle_IT(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size); 185 #if defined(HAL_DMA_MODULE_ENABLED) 186 HAL_StatusTypeDef HAL_UARTEx_ReceiveToIdle_DMA(UART_HandleTypeDef *huart, uint8_t *pData, uint16_t Size); 187 #endif /* HAL_DMA_MODULE_ENABLED */ 188 189 HAL_UART_RxEventTypeTypeDef HAL_UARTEx_GetRxEventType(const UART_HandleTypeDef *huart); 190 191 192 /** 193 * @} 194 */ 195 196 /** 197 * @} 198 */ 199 200 /* Private macros ------------------------------------------------------------*/ 201 /** @defgroup UARTEx_Private_Macros UARTEx Private Macros 202 * @{ 203 */ 204 205 /* An always 16 MHz is requested by UART to maintain fixed baud rate while 206 * system clock is switching from a frequency to another) 207 */ 208 #define UART_PERIPHCLK (16000000U) 209 210 /** @brief Report the UART mask to apply to retrieve the received data 211 * according to the word length and to the parity bits activation. 212 * @note If PCE = 1, the parity bit is not included in the data extracted 213 * by the reception API(). 214 * This masking operation is not carried out in the case of 215 * DMA transfers. 216 * @param __HANDLE__ specifies the UART Handle. 217 * @retval None, the mask to apply to UART RDR register is stored in (__HANDLE__)->Mask field. 218 */ 219 #define UART_MASK_COMPUTATION(__HANDLE__) \ 220 do { \ 221 if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_9B) \ 222 { \ 223 if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \ 224 { \ 225 (__HANDLE__)->Mask = 0x01FFU ; \ 226 } \ 227 else \ 228 { \ 229 (__HANDLE__)->Mask = 0x00FFU ; \ 230 } \ 231 } \ 232 else if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_8B) \ 233 { \ 234 if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \ 235 { \ 236 (__HANDLE__)->Mask = 0x00FFU ; \ 237 } \ 238 else \ 239 { \ 240 (__HANDLE__)->Mask = 0x007FU ; \ 241 } \ 242 } \ 243 else if ((__HANDLE__)->Init.WordLength == UART_WORDLENGTH_7B) \ 244 { \ 245 if ((__HANDLE__)->Init.Parity == UART_PARITY_NONE) \ 246 { \ 247 (__HANDLE__)->Mask = 0x007FU ; \ 248 } \ 249 else \ 250 { \ 251 (__HANDLE__)->Mask = 0x003FU ; \ 252 } \ 253 } \ 254 else \ 255 { \ 256 (__HANDLE__)->Mask = 0x0000U; \ 257 } \ 258 } while(0U) 259 260 /** 261 * @brief Ensure that UART frame length is valid. 262 * @param __LENGTH__ UART frame length. 263 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid) 264 */ 265 #define IS_UART_WORD_LENGTH(__LENGTH__) (((__LENGTH__) == UART_WORDLENGTH_7B) || \ 266 ((__LENGTH__) == UART_WORDLENGTH_8B) || \ 267 ((__LENGTH__) == UART_WORDLENGTH_9B)) 268 269 /** 270 * @brief Ensure that UART wake-up address length is valid. 271 * @param __ADDRESS__ UART wake-up address length. 272 * @retval SET (__ADDRESS__ is valid) or RESET (__ADDRESS__ is invalid) 273 */ 274 #define IS_UART_ADDRESSLENGTH_DETECT(__ADDRESS__) (((__ADDRESS__) == UART_ADDRESS_DETECT_4B) || \ 275 ((__ADDRESS__) == UART_ADDRESS_DETECT_7B)) 276 277 /** 278 * @brief Ensure that UART TXFIFO threshold level is valid. 279 * @param __THRESHOLD__ UART TXFIFO threshold level. 280 * @retval SET (__THRESHOLD__ is valid) or RESET (__THRESHOLD__ is invalid) 281 */ 282 #define IS_UART_TXFIFO_THRESHOLD(__THRESHOLD__) (((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_1_8) || \ 283 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_1_4) || \ 284 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_1_2) || \ 285 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_3_4) || \ 286 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_7_8) || \ 287 ((__THRESHOLD__) == UART_TXFIFO_THRESHOLD_8_8)) 288 289 /** 290 * @brief Ensure that UART RXFIFO threshold level is valid. 291 * @param __THRESHOLD__ UART RXFIFO threshold level. 292 * @retval SET (__THRESHOLD__ is valid) or RESET (__THRESHOLD__ is invalid) 293 */ 294 #define IS_UART_RXFIFO_THRESHOLD(__THRESHOLD__) (((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_1_8) || \ 295 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_1_4) || \ 296 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_1_2) || \ 297 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_3_4) || \ 298 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_7_8) || \ 299 ((__THRESHOLD__) == UART_RXFIFO_THRESHOLD_8_8)) 300 301 /** 302 * @} 303 */ 304 305 /* Private functions ---------------------------------------------------------*/ 306 307 /** 308 * @} 309 */ 310 311 /** 312 * @} 313 */ 314 315 #ifdef __cplusplus 316 } 317 #endif 318 319 #endif /* STM32WB0x_HAL_UART_EX_H */ 320
