1 /** 2 ****************************************************************************** 3 * @file stm32u5xx_hal_smartcard_ex.h 4 * @author MCD Application Team 5 * @brief Header file of SMARTCARD HAL Extended module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2021 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 STM32U5xx_HAL_SMARTCARD_EX_H 21 #define STM32U5xx_HAL_SMARTCARD_EX_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32u5xx_hal_def.h" 29 30 /** @addtogroup STM32U5xx_HAL_Driver 31 * @{ 32 */ 33 34 /** @addtogroup SMARTCARDEx 35 * @{ 36 */ 37 38 /* Exported types ------------------------------------------------------------*/ 39 /* Exported constants --------------------------------------------------------*/ 40 41 /** @addtogroup SMARTCARDEx_Exported_Constants SMARTCARD Extended Exported Constants 42 * @{ 43 */ 44 45 /** @defgroup SMARTCARDEx_Transmission_Completion_Indication SMARTCARD Transmission Completion Indication 46 * @{ 47 */ 48 #define SMARTCARD_TCBGT SMARTCARD_IT_TCBGT /*!< SMARTCARD transmission complete before guard time */ 49 #define SMARTCARD_TC SMARTCARD_IT_TC /*!< SMARTCARD transmission complete (flag raised when guard time has elapsed) */ 50 /** 51 * @} 52 */ 53 54 /** @defgroup SMARTCARDEx_Advanced_Features_Initialization_Type SMARTCARD advanced feature initialization type 55 * @{ 56 */ 57 #define SMARTCARD_ADVFEATURE_NO_INIT 0x00000000U /*!< No advanced feature initialization */ 58 #define SMARTCARD_ADVFEATURE_TXINVERT_INIT 0x00000001U /*!< TX pin active level inversion */ 59 #define SMARTCARD_ADVFEATURE_RXINVERT_INIT 0x00000002U /*!< RX pin active level inversion */ 60 #define SMARTCARD_ADVFEATURE_DATAINVERT_INIT 0x00000004U /*!< Binary data inversion */ 61 #define SMARTCARD_ADVFEATURE_SWAP_INIT 0x00000008U /*!< TX/RX pins swap */ 62 #define SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT 0x00000010U /*!< RX overrun disable */ 63 #define SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT 0x00000020U /*!< DMA disable on Reception Error */ 64 #define SMARTCARD_ADVFEATURE_MSBFIRST_INIT 0x00000080U /*!< Most significant bit sent/received first */ 65 #define SMARTCARD_ADVFEATURE_TXCOMPLETION 0x00000100U /*!< TX completion indication before of after guard time */ 66 /** 67 * @} 68 */ 69 70 /** @defgroup SMARTCARDEx_FIFO_mode SMARTCARD FIFO mode 71 * @brief SMARTCARD FIFO mode 72 * @{ 73 */ 74 #define SMARTCARD_FIFOMODE_DISABLE 0x00000000U /*!< FIFO mode disable */ 75 #define SMARTCARD_FIFOMODE_ENABLE USART_CR1_FIFOEN /*!< FIFO mode enable */ 76 /** 77 * @} 78 */ 79 80 /** @defgroup SMARTCARDEx_TXFIFO_threshold_level SMARTCARD TXFIFO threshold level 81 * @brief SMARTCARD TXFIFO level 82 * @{ 83 */ 84 #define SMARTCARD_TXFIFO_THRESHOLD_1_8 0x00000000U /*!< TXFIFO reaches 1/8 of its depth */ 85 #define SMARTCARD_TXFIFO_THRESHOLD_1_4 USART_CR3_TXFTCFG_0 /*!< TXFIFO reaches 1/4 of its depth */ 86 #define SMARTCARD_TXFIFO_THRESHOLD_1_2 USART_CR3_TXFTCFG_1 /*!< TXFIFO reaches 1/2 of its depth */ 87 #define SMARTCARD_TXFIFO_THRESHOLD_3_4 (USART_CR3_TXFTCFG_0|USART_CR3_TXFTCFG_1) /*!< TXFIFO reaches 3/4 of its depth */ 88 #define SMARTCARD_TXFIFO_THRESHOLD_7_8 USART_CR3_TXFTCFG_2 /*!< TXFIFO reaches 7/8 of its depth */ 89 #define SMARTCARD_TXFIFO_THRESHOLD_8_8 (USART_CR3_TXFTCFG_2|USART_CR3_TXFTCFG_0) /*!< TXFIFO becomes empty */ 90 /** 91 * @} 92 */ 93 94 /** @defgroup SMARTCARDEx_RXFIFO_threshold_level SMARTCARD RXFIFO threshold level 95 * @brief SMARTCARD RXFIFO level 96 * @{ 97 */ 98 #define SMARTCARD_RXFIFO_THRESHOLD_1_8 0x00000000U /*!< RXFIFO FIFO reaches 1/8 of its depth */ 99 #define SMARTCARD_RXFIFO_THRESHOLD_1_4 USART_CR3_RXFTCFG_0 /*!< RXFIFO FIFO reaches 1/4 of its depth */ 100 #define SMARTCARD_RXFIFO_THRESHOLD_1_2 USART_CR3_RXFTCFG_1 /*!< RXFIFO FIFO reaches 1/2 of its depth */ 101 #define SMARTCARD_RXFIFO_THRESHOLD_3_4 (USART_CR3_RXFTCFG_0|USART_CR3_RXFTCFG_1) /*!< RXFIFO FIFO reaches 3/4 of its depth */ 102 #define SMARTCARD_RXFIFO_THRESHOLD_7_8 USART_CR3_RXFTCFG_2 /*!< RXFIFO FIFO reaches 7/8 of its depth */ 103 #define SMARTCARD_RXFIFO_THRESHOLD_8_8 (USART_CR3_RXFTCFG_2|USART_CR3_RXFTCFG_0) /*!< RXFIFO FIFO becomes full */ 104 /** 105 * @} 106 */ 107 108 /** @defgroup SMARTCARDEx_Flags SMARTCARD Flags 109 * Elements values convention: 0xXXXX 110 * - 0xXXXX : Flag mask in the ISR register 111 * @{ 112 */ 113 #define SMARTCARD_FLAG_TCBGT USART_ISR_TCBGT /*!< SMARTCARD transmission complete before guard time completion */ 114 #define SMARTCARD_FLAG_REACK USART_ISR_REACK /*!< SMARTCARD receive enable acknowledge flag */ 115 #define SMARTCARD_FLAG_TEACK USART_ISR_TEACK /*!< SMARTCARD transmit enable acknowledge flag */ 116 #define SMARTCARD_FLAG_BUSY USART_ISR_BUSY /*!< SMARTCARD busy flag */ 117 #define SMARTCARD_FLAG_EOBF USART_ISR_EOBF /*!< SMARTCARD end of block flag */ 118 #define SMARTCARD_FLAG_RTOF USART_ISR_RTOF /*!< SMARTCARD receiver timeout flag */ 119 #define SMARTCARD_FLAG_TXE USART_ISR_TXE_TXFNF /*!< SMARTCARD transmit data register empty */ 120 #define SMARTCARD_FLAG_TXFNF USART_ISR_TXE_TXFNF /*!< SMARTCARD TXFIFO not full */ 121 #define SMARTCARD_FLAG_TC USART_ISR_TC /*!< SMARTCARD transmission complete */ 122 #define SMARTCARD_FLAG_RXNE USART_ISR_RXNE_RXFNE /*!< SMARTCARD read data register not empty */ 123 #define SMARTCARD_FLAG_RXFNE USART_ISR_RXNE_RXFNE /*!< SMARTCARD RXFIFO not empty */ 124 #define SMARTCARD_FLAG_IDLE USART_ISR_IDLE /*!< SMARTCARD idle line detection */ 125 #define SMARTCARD_FLAG_ORE USART_ISR_ORE /*!< SMARTCARD overrun error */ 126 #define SMARTCARD_FLAG_NE USART_ISR_NE /*!< SMARTCARD noise error */ 127 #define SMARTCARD_FLAG_FE USART_ISR_FE /*!< SMARTCARD frame error */ 128 #define SMARTCARD_FLAG_PE USART_ISR_PE /*!< SMARTCARD parity error */ 129 #define SMARTCARD_FLAG_TXFE USART_ISR_TXFE /*!< SMARTCARD TXFIFO Empty flag */ 130 #define SMARTCARD_FLAG_RXFF USART_ISR_RXFF /*!< SMARTCARD RXFIFO Full flag */ 131 #define SMARTCARD_FLAG_RXFT USART_ISR_RXFT /*!< SMARTCARD RXFIFO threshold flag */ 132 #define SMARTCARD_FLAG_TXFT USART_ISR_TXFT /*!< SMARTCARD TXFIFO threshold flag */ 133 /** 134 * @} 135 */ 136 137 /** @defgroup SMARTCARDEx_Interrupt_definition SMARTCARD Interrupts Definition 138 * Elements values convention: 000ZZZZZ0XXYYYYYb 139 * - YYYYY : Interrupt source position in the XX register (5 bits) 140 * - XX : Interrupt source register (2 bits) 141 * - 01: CR1 register 142 * - 10: CR2 register 143 * - 11: CR3 register 144 * - ZZZZZ : Flag position in the ISR register(5 bits) 145 * @{ 146 */ 147 #define SMARTCARD_IT_PE 0x0028U /*!< SMARTCARD parity error interruption */ 148 #define SMARTCARD_IT_TXE 0x0727U /*!< SMARTCARD transmit data register empty interruption */ 149 #define SMARTCARD_IT_TXFNF 0x0727U /*!< SMARTCARD TX FIFO not full interruption */ 150 #define SMARTCARD_IT_TC 0x0626U /*!< SMARTCARD transmission complete interruption */ 151 #define SMARTCARD_IT_RXNE 0x0525U /*!< SMARTCARD read data register not empty interruption */ 152 #define SMARTCARD_IT_RXFNE 0x0525U /*!< SMARTCARD RXFIFO not empty interruption */ 153 #define SMARTCARD_IT_IDLE 0x0424U /*!< SMARTCARD idle line detection interruption */ 154 155 #define SMARTCARD_IT_ERR 0x0060U /*!< SMARTCARD error interruption */ 156 #define SMARTCARD_IT_ORE 0x0300U /*!< SMARTCARD overrun error interruption */ 157 #define SMARTCARD_IT_NE 0x0200U /*!< SMARTCARD noise error interruption */ 158 #define SMARTCARD_IT_FE 0x0100U /*!< SMARTCARD frame error interruption */ 159 160 #define SMARTCARD_IT_EOB 0x0C3BU /*!< SMARTCARD end of block interruption */ 161 #define SMARTCARD_IT_RTO 0x0B3AU /*!< SMARTCARD receiver timeout interruption */ 162 #define SMARTCARD_IT_TCBGT 0x1978U /*!< SMARTCARD transmission complete before guard time completion interruption */ 163 164 #define SMARTCARD_IT_RXFF 0x183FU /*!< SMARTCARD RXFIFO full interruption */ 165 #define SMARTCARD_IT_TXFE 0x173EU /*!< SMARTCARD TXFIFO empty interruption */ 166 #define SMARTCARD_IT_RXFT 0x1A7CU /*!< SMARTCARD RXFIFO threshold reached interruption */ 167 #define SMARTCARD_IT_TXFT 0x1B77U /*!< SMARTCARD TXFIFO threshold reached interruption */ 168 /** 169 * @} 170 */ 171 172 /** @defgroup SMARTCARDEx_IT_CLEAR_Flags SMARTCARD Interruption Clear Flags 173 * @{ 174 */ 175 #define SMARTCARD_CLEAR_PEF USART_ICR_PECF /*!< SMARTCARD parity error clear flag */ 176 #define SMARTCARD_CLEAR_FEF USART_ICR_FECF /*!< SMARTCARD framing error clear flag */ 177 #define SMARTCARD_CLEAR_NEF USART_ICR_NECF /*!< SMARTCARD noise error detected clear flag */ 178 #define SMARTCARD_CLEAR_OREF USART_ICR_ORECF /*!< SMARTCARD overrun error clear flag */ 179 #define SMARTCARD_CLEAR_IDLEF USART_ICR_IDLECF /*!< SMARTCARD idle line detected clear flag */ 180 #define SMARTCARD_CLEAR_TXFECF USART_ICR_TXFECF /*!< TXFIFO empty Clear Flag */ 181 #define SMARTCARD_CLEAR_TCF USART_ICR_TCCF /*!< SMARTCARD transmission complete clear flag */ 182 #define SMARTCARD_CLEAR_TCBGTF USART_ICR_TCBGTCF /*!< SMARTCARD transmission complete before guard time completion clear flag */ 183 #define SMARTCARD_CLEAR_RTOF USART_ICR_RTOCF /*!< SMARTCARD receiver time out clear flag */ 184 #define SMARTCARD_CLEAR_EOBF USART_ICR_EOBCF /*!< SMARTCARD end of block clear flag */ 185 /** 186 * @} 187 */ 188 189 /** 190 * @} 191 */ 192 /* Exported macros -----------------------------------------------------------*/ 193 /* Private macros ------------------------------------------------------------*/ 194 /** @defgroup SMARTCARDEx_Private_Macros SMARTCARD Extended Private Macros 195 * @{ 196 */ 197 198 /** @brief Set the Transmission Completion flag 199 * @param __HANDLE__ specifies the SMARTCARD Handle. 200 * @note If TCBGT (Transmission Complete Before Guard Time) flag is not available or if 201 * AdvancedInit.TxCompletionIndication is not already filled, the latter is forced 202 * to SMARTCARD_TC (transmission completion indication when guard time has elapsed). 203 * @retval None 204 */ 205 #define SMARTCARD_TRANSMISSION_COMPLETION_SETTING(__HANDLE__) \ 206 do { \ 207 if (HAL_IS_BIT_CLR((__HANDLE__)->AdvancedInit.AdvFeatureInit, SMARTCARD_ADVFEATURE_TXCOMPLETION)) \ 208 { \ 209 (__HANDLE__)->AdvancedInit.TxCompletionIndication = SMARTCARD_TC; \ 210 } \ 211 else \ 212 { \ 213 assert_param(IS_SMARTCARD_TRANSMISSION_COMPLETION((__HANDLE__)->AdvancedInit.TxCompletionIndication)); \ 214 } \ 215 } while(0U) 216 217 /** @brief Return the transmission completion flag. 218 * @param __HANDLE__ specifies the SMARTCARD Handle. 219 * @note Based on AdvancedInit.TxCompletionIndication setting, return TC or TCBGT flag. 220 * When TCBGT flag (Transmission Complete Before Guard Time) is not available, TC flag is 221 * reported. 222 * @retval Transmission completion flag 223 */ 224 #define SMARTCARD_TRANSMISSION_COMPLETION_FLAG(__HANDLE__) \ 225 (((__HANDLE__)->AdvancedInit.TxCompletionIndication == SMARTCARD_TC) ? (SMARTCARD_FLAG_TC) : (SMARTCARD_FLAG_TCBGT)) 226 227 228 /** @brief Ensure that SMARTCARD frame transmission completion used flag is valid. 229 * @param __TXCOMPLETE__ SMARTCARD frame transmission completion used flag. 230 * @retval SET (__TXCOMPLETE__ is valid) or RESET (__TXCOMPLETE__ is invalid) 231 */ 232 #define IS_SMARTCARD_TRANSMISSION_COMPLETION(__TXCOMPLETE__) (((__TXCOMPLETE__) == SMARTCARD_TCBGT) || \ 233 ((__TXCOMPLETE__) == SMARTCARD_TC)) 234 235 /** @brief Ensure that SMARTCARD FIFO mode is valid. 236 * @param __STATE__ SMARTCARD FIFO mode. 237 * @retval SET (__STATE__ is valid) or RESET (__STATE__ is invalid) 238 */ 239 #define IS_SMARTCARD_FIFOMODE_STATE(__STATE__) (((__STATE__) == SMARTCARD_FIFOMODE_DISABLE ) || \ 240 ((__STATE__) == SMARTCARD_FIFOMODE_ENABLE)) 241 242 /** @brief Ensure that SMARTCARD TXFIFO threshold level is valid. 243 * @param __THRESHOLD__ SMARTCARD TXFIFO threshold level. 244 * @retval SET (__THRESHOLD__ is valid) or RESET (__THRESHOLD__ is invalid) 245 */ 246 #define IS_SMARTCARD_TXFIFO_THRESHOLD(__THRESHOLD__) (((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_1_8) || \ 247 ((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_1_4) || \ 248 ((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_1_2) || \ 249 ((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_3_4) || \ 250 ((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_7_8) || \ 251 ((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_8_8)) 252 253 /** @brief Ensure that SMARTCARD RXFIFO threshold level is valid. 254 * @param __THRESHOLD__ SMARTCARD RXFIFO threshold level. 255 * @retval SET (__THRESHOLD__ is valid) or RESET (__THRESHOLD__ is invalid) 256 */ 257 #define IS_SMARTCARD_RXFIFO_THRESHOLD(__THRESHOLD__) (((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_1_8) || \ 258 ((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_1_4) || \ 259 ((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_1_2) || \ 260 ((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_3_4) || \ 261 ((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_7_8) || \ 262 ((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_8_8)) 263 264 /** 265 * @} 266 */ 267 268 /* Exported functions --------------------------------------------------------*/ 269 /** @addtogroup SMARTCARDEx_Exported_Functions 270 * @{ 271 */ 272 273 /* Initialization and de-initialization functions ****************************/ 274 /* IO operation methods *******************************************************/ 275 276 /** @addtogroup SMARTCARDEx_Exported_Functions_Group1 277 * @{ 278 */ 279 280 /* Peripheral Control functions ***********************************************/ 281 void HAL_SMARTCARDEx_BlockLength_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t BlockLength); 282 void HAL_SMARTCARDEx_TimeOut_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t TimeOutValue); 283 HAL_StatusTypeDef HAL_SMARTCARDEx_EnableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard); 284 HAL_StatusTypeDef HAL_SMARTCARDEx_DisableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard); 285 286 /** 287 * @} 288 */ 289 290 /* Exported functions --------------------------------------------------------*/ 291 /** @addtogroup SMARTCARDEx_Exported_Functions_Group2 292 * @{ 293 */ 294 295 /* IO operation functions *****************************************************/ 296 void HAL_SMARTCARDEx_RxFifoFullCallback(SMARTCARD_HandleTypeDef *hsmartcard); 297 void HAL_SMARTCARDEx_TxFifoEmptyCallback(SMARTCARD_HandleTypeDef *hsmartcard); 298 299 /** 300 * @} 301 */ 302 303 /** @addtogroup SMARTCARDEx_Exported_Functions_Group3 304 * @{ 305 */ 306 307 /* Peripheral Control functions ***********************************************/ 308 HAL_StatusTypeDef HAL_SMARTCARDEx_EnableFifoMode(SMARTCARD_HandleTypeDef *hsmartcard); 309 HAL_StatusTypeDef HAL_SMARTCARDEx_DisableFifoMode(SMARTCARD_HandleTypeDef *hsmartcard); 310 HAL_StatusTypeDef HAL_SMARTCARDEx_SetTxFifoThreshold(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t Threshold); 311 HAL_StatusTypeDef HAL_SMARTCARDEx_SetRxFifoThreshold(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t Threshold); 312 313 /** 314 * @} 315 */ 316 317 /** 318 * @} 319 */ 320 321 /* Private functions ---------------------------------------------------------*/ 322 323 /** 324 * @} 325 */ 326 327 /** 328 * @} 329 */ 330 331 #ifdef __cplusplus 332 } 333 #endif 334 335 #endif /* STM32U5xx_HAL_SMARTCARD_EX_H */ 336
