1 /** 2 ****************************************************************************** 3 * @file stm32h5xx_hal_smartcard.h 4 * @author MCD Application Team 5 * @brief Header file of SMARTCARD HAL 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_SMARTCARD_H 21 #define STM32H5xx_HAL_SMARTCARD_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 SMARTCARD 35 * @{ 36 */ 37 38 /* Exported types ------------------------------------------------------------*/ 39 /** @defgroup SMARTCARD_Exported_Types SMARTCARD Exported Types 40 * @{ 41 */ 42 43 /** 44 * @brief SMARTCARD Init Structure definition 45 */ 46 typedef struct 47 { 48 uint32_t BaudRate; /*!< Configures the SmartCard communication baud rate. 49 The baud rate register is computed using the following formula: 50 Baud Rate Register = ((usart_ker_ckpres) / ((hsmartcard->Init.BaudRate))) 51 where usart_ker_ckpres is the USART input clock divided by a prescaler */ 52 53 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame. 54 This parameter @ref SMARTCARD_Word_Length can only be 55 set to 9 (8 data + 1 parity bits). */ 56 57 uint32_t StopBits; /*!< Specifies the number of stop bits. 58 This parameter can be a value of @ref SMARTCARD_Stop_Bits. */ 59 60 uint16_t Parity; /*!< Specifies the parity mode. 61 This parameter can be a value of @ref SMARTCARD_Parity 62 @note The parity is enabled by default (PCE is forced to 1). 63 Since the WordLength is forced to 8 bits + parity, M is 64 forced to 1 and the parity bit is the 9th bit. */ 65 66 uint16_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled. 67 This parameter can be a value of @ref SMARTCARD_Mode */ 68 69 uint16_t CLKPolarity; /*!< Specifies the steady state of the serial clock. 70 This parameter can be a value of @ref SMARTCARD_Clock_Polarity */ 71 72 uint16_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made. 73 This parameter can be a value of @ref SMARTCARD_Clock_Phase */ 74 75 uint16_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted 76 data bit (MSB) has to be output on the SCLK pin in synchronous mode. 77 This parameter can be a value of @ref SMARTCARD_Last_Bit */ 78 79 uint16_t OneBitSampling; /*!< Specifies whether a single sample or three samples' majority vote 80 is selected. Selecting the single sample method increases 81 the receiver tolerance to clock deviations. This parameter can be a value 82 of @ref SMARTCARD_OneBit_Sampling. */ 83 84 uint8_t Prescaler; /*!< Specifies the SmartCard Prescaler. 85 This parameter can be any value from 0x01 to 0x1F. Prescaler value is 86 multiplied by 2 to give the division factor of the source clock frequency */ 87 88 uint8_t GuardTime; /*!< Specifies the SmartCard Guard Time applied after stop bits. */ 89 90 uint16_t NACKEnable; /*!< Specifies whether the SmartCard NACK transmission is enabled 91 in case of parity error. 92 This parameter can be a value of @ref SMARTCARD_NACK_Enable */ 93 94 uint32_t TimeOutEnable; /*!< Specifies whether the receiver timeout is enabled. 95 This parameter can be a value of @ref SMARTCARD_Timeout_Enable*/ 96 97 uint32_t TimeOutValue; /*!< Specifies the receiver time out value in number of baud blocks: 98 it is used to implement the Character Wait Time (CWT) and 99 Block Wait Time (BWT). It is coded over 24 bits. */ 100 101 uint8_t BlockLength; /*!< Specifies the SmartCard Block Length in T=1 Reception mode. 102 This parameter can be any value from 0x0 to 0xFF */ 103 104 uint8_t AutoRetryCount; /*!< Specifies the SmartCard auto-retry count (number of retries in 105 receive and transmit mode). When set to 0, retransmission is 106 disabled. Otherwise, its maximum value is 7 (before signalling 107 an error) */ 108 109 uint32_t ClockPrescaler; /*!< Specifies the prescaler value used to divide the USART clock source. 110 This parameter can be a value of @ref SMARTCARD_ClockPrescaler. */ 111 112 } SMARTCARD_InitTypeDef; 113 114 /** 115 * @brief SMARTCARD advanced features initialization structure definition 116 */ 117 typedef struct 118 { 119 uint32_t AdvFeatureInit; /*!< Specifies which advanced SMARTCARD features is initialized. Several 120 advanced features may be initialized at the same time. This parameter 121 can be a value of @ref SMARTCARDEx_Advanced_Features_Initialization_Type */ 122 123 uint32_t TxPinLevelInvert; /*!< Specifies whether the TX pin active level is inverted. 124 This parameter can be a value of @ref SMARTCARD_Tx_Inv */ 125 126 uint32_t RxPinLevelInvert; /*!< Specifies whether the RX pin active level is inverted. 127 This parameter can be a value of @ref SMARTCARD_Rx_Inv */ 128 129 uint32_t DataInvert; /*!< Specifies whether data are inverted (positive/direct logic 130 vs negative/inverted logic). 131 This parameter can be a value of @ref SMARTCARD_Data_Inv */ 132 133 uint32_t Swap; /*!< Specifies whether TX and RX pins are swapped. 134 This parameter can be a value of @ref SMARTCARD_Rx_Tx_Swap */ 135 136 uint32_t OverrunDisable; /*!< Specifies whether the reception overrun detection is disabled. 137 This parameter can be a value of @ref SMARTCARD_Overrun_Disable */ 138 139 uint32_t DMADisableonRxError; /*!< Specifies whether the DMA is disabled in case of reception error. 140 This parameter can be a value of @ref SMARTCARD_DMA_Disable_on_Rx_Error */ 141 142 uint32_t MSBFirst; /*!< Specifies whether MSB is sent first on UART line. 143 This parameter can be a value of @ref SMARTCARD_MSB_First */ 144 145 uint16_t TxCompletionIndication; /*!< Specifies which transmission completion indication is used: before (when 146 relevant flag is available) or once guard time period has elapsed. 147 This parameter can be a value 148 of @ref SMARTCARDEx_Transmission_Completion_Indication. */ 149 } SMARTCARD_AdvFeatureInitTypeDef; 150 151 /** 152 * @brief HAL SMARTCARD State definition 153 * @note HAL SMARTCARD State value is a combination of 2 different substates: 154 * gState and RxState (see @ref SMARTCARD_State_Definition). 155 * - gState contains SMARTCARD state information related to global Handle management 156 * and also information related to Tx operations. 157 * gState value coding follow below described bitmap : 158 * b7-b6 Error information 159 * 00 : No Error 160 * 01 : (Not Used) 161 * 10 : Timeout 162 * 11 : Error 163 * b5 Peripheral initialization status 164 * 0 : Reset (Peripheral not initialized) 165 * 1 : Init done (Peripheral initialized. HAL SMARTCARD Init function already called) 166 * b4-b3 (not used) 167 * xx : Should be set to 00 168 * b2 Intrinsic process state 169 * 0 : Ready 170 * 1 : Busy (Peripheral busy with some configuration or internal operations) 171 * b1 (not used) 172 * x : Should be set to 0 173 * b0 Tx state 174 * 0 : Ready (no Tx operation ongoing) 175 * 1 : Busy (Tx operation ongoing) 176 * - RxState contains information related to Rx operations. 177 * RxState value coding follow below described bitmap : 178 * b7-b6 (not used) 179 * xx : Should be set to 00 180 * b5 Peripheral initialization status 181 * 0 : Reset (Peripheral not initialized) 182 * 1 : Init done (Peripheral initialized) 183 * b4-b2 (not used) 184 * xxx : Should be set to 000 185 * b1 Rx state 186 * 0 : Ready (no Rx operation ongoing) 187 * 1 : Busy (Rx operation ongoing) 188 * b0 (not used) 189 * x : Should be set to 0. 190 */ 191 typedef uint32_t HAL_SMARTCARD_StateTypeDef; 192 193 /** 194 * @brief SMARTCARD handle Structure definition 195 */ 196 typedef struct __SMARTCARD_HandleTypeDef 197 { 198 USART_TypeDef *Instance; /*!< USART registers base address */ 199 200 SMARTCARD_InitTypeDef Init; /*!< SmartCard communication parameters */ 201 202 SMARTCARD_AdvFeatureInitTypeDef AdvancedInit; /*!< SmartCard advanced features initialization parameters */ 203 204 const uint8_t *pTxBuffPtr; /*!< Pointer to SmartCard Tx transfer Buffer */ 205 206 uint16_t TxXferSize; /*!< SmartCard Tx Transfer size */ 207 208 __IO uint16_t TxXferCount; /*!< SmartCard Tx Transfer Counter */ 209 210 uint8_t *pRxBuffPtr; /*!< Pointer to SmartCard Rx transfer Buffer */ 211 212 uint16_t RxXferSize; /*!< SmartCard Rx Transfer size */ 213 214 __IO uint16_t RxXferCount; /*!< SmartCard Rx Transfer Counter */ 215 216 uint16_t NbRxDataToProcess; /*!< Number of data to process during RX ISR execution */ 217 218 uint16_t NbTxDataToProcess; /*!< Number of data to process during TX ISR execution */ 219 220 uint32_t FifoMode; /*!< Specifies if the FIFO mode will be used. 221 This parameter can be a value of 222 @ref SMARTCARDEx_FIFO_mode. */ 223 224 void (*RxISR)(struct __SMARTCARD_HandleTypeDef *huart); /*!< Function pointer on Rx IRQ handler */ 225 226 void (*TxISR)(struct __SMARTCARD_HandleTypeDef *huart); /*!< Function pointer on Tx IRQ handler */ 227 228 #if defined(HAL_DMA_MODULE_ENABLED) 229 DMA_HandleTypeDef *hdmatx; /*!< SmartCard Tx DMA Handle parameters */ 230 231 DMA_HandleTypeDef *hdmarx; /*!< SmartCard Rx DMA Handle parameters */ 232 233 #endif /* HAL_DMA_MODULE_ENABLED */ 234 HAL_LockTypeDef Lock; /*!< Locking object */ 235 236 __IO HAL_SMARTCARD_StateTypeDef gState; /*!< SmartCard state information related to global 237 Handle management and also related to Tx operations. 238 This parameter can be a value 239 of @ref HAL_SMARTCARD_StateTypeDef */ 240 241 __IO HAL_SMARTCARD_StateTypeDef RxState; /*!< SmartCard state information related to Rx operations. 242 This parameter can be a value 243 of @ref HAL_SMARTCARD_StateTypeDef */ 244 245 __IO uint32_t ErrorCode; /*!< SmartCard Error code */ 246 247 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 248 void (* TxCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Tx Complete Callback */ 249 250 void (* RxCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Rx Complete Callback */ 251 252 void (* ErrorCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Error Callback */ 253 254 void (* AbortCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Complete Callback */ 255 256 void (* AbortTransmitCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Transmit Complete Callback */ 257 258 void (* AbortReceiveCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Receive Complete Callback */ 259 260 void (* RxFifoFullCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Rx Fifo Full Callback */ 261 262 void (* TxFifoEmptyCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Tx Fifo Empty Callback */ 263 264 void (* MspInitCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Msp Init callback */ 265 266 void (* MspDeInitCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Msp DeInit callback */ 267 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 268 269 } SMARTCARD_HandleTypeDef; 270 271 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 272 /** 273 * @brief HAL SMARTCARD Callback ID enumeration definition 274 */ 275 typedef enum 276 { 277 HAL_SMARTCARD_TX_COMPLETE_CB_ID = 0x00U, /*!< SMARTCARD Tx Complete Callback ID */ 278 HAL_SMARTCARD_RX_COMPLETE_CB_ID = 0x01U, /*!< SMARTCARD Rx Complete Callback ID */ 279 HAL_SMARTCARD_ERROR_CB_ID = 0x02U, /*!< SMARTCARD Error Callback ID */ 280 HAL_SMARTCARD_ABORT_COMPLETE_CB_ID = 0x03U, /*!< SMARTCARD Abort Complete Callback ID */ 281 HAL_SMARTCARD_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x04U, /*!< SMARTCARD Abort Transmit Complete Callback ID */ 282 HAL_SMARTCARD_ABORT_RECEIVE_COMPLETE_CB_ID = 0x05U, /*!< SMARTCARD Abort Receive Complete Callback ID */ 283 HAL_SMARTCARD_RX_FIFO_FULL_CB_ID = 0x06U, /*!< SMARTCARD Rx Fifo Full Callback ID */ 284 HAL_SMARTCARD_TX_FIFO_EMPTY_CB_ID = 0x07U, /*!< SMARTCARD Tx Fifo Empty Callback ID */ 285 286 HAL_SMARTCARD_MSPINIT_CB_ID = 0x08U, /*!< SMARTCARD MspInit callback ID */ 287 HAL_SMARTCARD_MSPDEINIT_CB_ID = 0x09U /*!< SMARTCARD MspDeInit callback ID */ 288 289 } HAL_SMARTCARD_CallbackIDTypeDef; 290 291 /** 292 * @brief HAL SMARTCARD Callback pointer definition 293 */ 294 typedef void (*pSMARTCARD_CallbackTypeDef)(SMARTCARD_HandleTypeDef *hsmartcard); /*!< pointer to an SMARTCARD callback function */ 295 296 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 297 298 /** 299 * @brief SMARTCARD clock sources 300 */ 301 typedef enum 302 { 303 SMARTCARD_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */ 304 SMARTCARD_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */ 305 SMARTCARD_CLOCKSOURCE_HSI = 0x04U, /*!< HSI clock source */ 306 SMARTCARD_CLOCKSOURCE_CSI = 0x08U, /*!< CSI clock source */ 307 SMARTCARD_CLOCKSOURCE_LSE = 0x20U, /*!< LSE clock source */ 308 SMARTCARD_CLOCKSOURCE_PLL2Q = 0x40U, /*!< PLL2Q clock source */ 309 #if defined(RCC_CR_PLL3ON) 310 SMARTCARD_CLOCKSOURCE_PLL3Q = 0x80U, /*!< PLL3Q clock source */ 311 #endif /* RCC_CR_PLL3ON */ 312 SMARTCARD_CLOCKSOURCE_UNDEFINED = 0x10U /*!< undefined clock source */ 313 } SMARTCARD_ClockSourceTypeDef; 314 315 /** 316 * @} 317 */ 318 319 /* Exported constants --------------------------------------------------------*/ 320 /** @defgroup SMARTCARD_Exported_Constants SMARTCARD Exported Constants 321 * @{ 322 */ 323 324 /** @defgroup SMARTCARD_State_Definition SMARTCARD State Code Definition 325 * @{ 326 */ 327 #define HAL_SMARTCARD_STATE_RESET 0x00000000U /*!< Peripheral is not initialized. Value 328 is allowed for gState and RxState */ 329 #define HAL_SMARTCARD_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for 330 use. Value is allowed for gState 331 and RxState */ 332 #define HAL_SMARTCARD_STATE_BUSY 0x00000024U /*!< an internal process is ongoing 333 Value is allowed for gState only */ 334 #define HAL_SMARTCARD_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing 335 Value is allowed for gState only */ 336 #define HAL_SMARTCARD_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing 337 Value is allowed for RxState only */ 338 #define HAL_SMARTCARD_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception 339 process is ongoing Not to be used for 340 neither gState nor RxState. 341 Value is result of combination (Or) 342 between gState and RxState values */ 343 #define HAL_SMARTCARD_STATE_TIMEOUT 0x000000A0U /*!< Timeout state 344 Value is allowed for gState only */ 345 #define HAL_SMARTCARD_STATE_ERROR 0x000000E0U /*!< Error 346 Value is allowed for gState only */ 347 /** 348 * @} 349 */ 350 351 /** @defgroup SMARTCARD_Error_Definition SMARTCARD Error Code Definition 352 * @{ 353 */ 354 #define HAL_SMARTCARD_ERROR_NONE (0x00000000U) /*!< No error */ 355 #define HAL_SMARTCARD_ERROR_PE (0x00000001U) /*!< Parity error */ 356 #define HAL_SMARTCARD_ERROR_NE (0x00000002U) /*!< Noise error */ 357 #define HAL_SMARTCARD_ERROR_FE (0x00000004U) /*!< frame error */ 358 #define HAL_SMARTCARD_ERROR_ORE (0x00000008U) /*!< Overrun error */ 359 #if defined(HAL_DMA_MODULE_ENABLED) 360 #define HAL_SMARTCARD_ERROR_DMA (0x00000010U) /*!< DMA transfer error */ 361 #endif /* HAL_DMA_MODULE_ENABLED */ 362 #define HAL_SMARTCARD_ERROR_RTO (0x00000020U) /*!< Receiver TimeOut error */ 363 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 364 #define HAL_SMARTCARD_ERROR_INVALID_CALLBACK (0x00000040U) /*!< Invalid Callback error */ 365 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 366 /** 367 * @} 368 */ 369 370 /** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length 371 * @{ 372 */ 373 #define SMARTCARD_WORDLENGTH_9B USART_CR1_M0 /*!< SMARTCARD frame length */ 374 /** 375 * @} 376 */ 377 378 /** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits 379 * @{ 380 */ 381 #define SMARTCARD_STOPBITS_0_5 USART_CR2_STOP_0 /*!< SMARTCARD frame with 0.5 stop bit */ 382 #define SMARTCARD_STOPBITS_1_5 USART_CR2_STOP /*!< SMARTCARD frame with 1.5 stop bits */ 383 /** 384 * @} 385 */ 386 387 /** @defgroup SMARTCARD_Parity SMARTCARD Parity 388 * @{ 389 */ 390 #define SMARTCARD_PARITY_EVEN USART_CR1_PCE /*!< SMARTCARD frame even parity */ 391 #define SMARTCARD_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< SMARTCARD frame odd parity */ 392 /** 393 * @} 394 */ 395 396 /** @defgroup SMARTCARD_Mode SMARTCARD Transfer Mode 397 * @{ 398 */ 399 #define SMARTCARD_MODE_RX USART_CR1_RE /*!< SMARTCARD RX mode */ 400 #define SMARTCARD_MODE_TX USART_CR1_TE /*!< SMARTCARD TX mode */ 401 #define SMARTCARD_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< SMARTCARD RX and TX mode */ 402 /** 403 * @} 404 */ 405 406 /** @defgroup SMARTCARD_Clock_Polarity SMARTCARD Clock Polarity 407 * @{ 408 */ 409 #define SMARTCARD_POLARITY_LOW 0x00000000U /*!< SMARTCARD frame low polarity */ 410 #define SMARTCARD_POLARITY_HIGH USART_CR2_CPOL /*!< SMARTCARD frame high polarity */ 411 /** 412 * @} 413 */ 414 415 /** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase 416 * @{ 417 */ 418 #define SMARTCARD_PHASE_1EDGE 0x00000000U /*!< SMARTCARD frame phase on first clock transition */ 419 #define SMARTCARD_PHASE_2EDGE USART_CR2_CPHA /*!< SMARTCARD frame phase on second clock transition */ 420 /** 421 * @} 422 */ 423 424 /** @defgroup SMARTCARD_Last_Bit SMARTCARD Last Bit 425 * @{ 426 */ 427 #define SMARTCARD_LASTBIT_DISABLE 0x00000000U /*!< SMARTCARD frame last data bit clock pulse not output to SCLK pin */ 428 #define SMARTCARD_LASTBIT_ENABLE USART_CR2_LBCL /*!< SMARTCARD frame last data bit clock pulse output to SCLK pin */ 429 /** 430 * @} 431 */ 432 433 /** @defgroup SMARTCARD_OneBit_Sampling SMARTCARD One Bit Sampling Method 434 * @{ 435 */ 436 #define SMARTCARD_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< SMARTCARD frame one-bit sample disabled */ 437 #define SMARTCARD_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< SMARTCARD frame one-bit sample enabled */ 438 /** 439 * @} 440 */ 441 442 /** @defgroup SMARTCARD_NACK_Enable SMARTCARD NACK Enable 443 * @{ 444 */ 445 #define SMARTCARD_NACK_DISABLE 0x00000000U /*!< SMARTCARD NACK transmission disabled */ 446 #define SMARTCARD_NACK_ENABLE USART_CR3_NACK /*!< SMARTCARD NACK transmission enabled */ 447 /** 448 * @} 449 */ 450 451 /** @defgroup SMARTCARD_Timeout_Enable SMARTCARD Timeout Enable 452 * @{ 453 */ 454 #define SMARTCARD_TIMEOUT_DISABLE 0x00000000U /*!< SMARTCARD receiver timeout disabled */ 455 #define SMARTCARD_TIMEOUT_ENABLE USART_CR2_RTOEN /*!< SMARTCARD receiver timeout enabled */ 456 /** 457 * @} 458 */ 459 460 /** @defgroup SMARTCARD_ClockPrescaler SMARTCARD Clock Prescaler 461 * @{ 462 */ 463 #define SMARTCARD_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */ 464 #define SMARTCARD_PRESCALER_DIV2 0x00000001U /*!< fclk_pres = fclk/2 */ 465 #define SMARTCARD_PRESCALER_DIV4 0x00000002U /*!< fclk_pres = fclk/4 */ 466 #define SMARTCARD_PRESCALER_DIV6 0x00000003U /*!< fclk_pres = fclk/6 */ 467 #define SMARTCARD_PRESCALER_DIV8 0x00000004U /*!< fclk_pres = fclk/8 */ 468 #define SMARTCARD_PRESCALER_DIV10 0x00000005U /*!< fclk_pres = fclk/10 */ 469 #define SMARTCARD_PRESCALER_DIV12 0x00000006U /*!< fclk_pres = fclk/12 */ 470 #define SMARTCARD_PRESCALER_DIV16 0x00000007U /*!< fclk_pres = fclk/16 */ 471 #define SMARTCARD_PRESCALER_DIV32 0x00000008U /*!< fclk_pres = fclk/32 */ 472 #define SMARTCARD_PRESCALER_DIV64 0x00000009U /*!< fclk_pres = fclk/64 */ 473 #define SMARTCARD_PRESCALER_DIV128 0x0000000AU /*!< fclk_pres = fclk/128 */ 474 #define SMARTCARD_PRESCALER_DIV256 0x0000000BU /*!< fclk_pres = fclk/256 */ 475 /** 476 * @} 477 */ 478 479 /** @defgroup SMARTCARD_Tx_Inv SMARTCARD advanced feature TX pin active level inversion 480 * @{ 481 */ 482 #define SMARTCARD_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */ 483 #define SMARTCARD_ADVFEATURE_TXINV_ENABLE USART_CR2_TXINV /*!< TX pin active level inversion enable */ 484 /** 485 * @} 486 */ 487 488 /** @defgroup SMARTCARD_Rx_Inv SMARTCARD advanced feature RX pin active level inversion 489 * @{ 490 */ 491 #define SMARTCARD_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */ 492 #define SMARTCARD_ADVFEATURE_RXINV_ENABLE USART_CR2_RXINV /*!< RX pin active level inversion enable */ 493 /** 494 * @} 495 */ 496 497 /** @defgroup SMARTCARD_Data_Inv SMARTCARD advanced feature Binary Data inversion 498 * @{ 499 */ 500 #define SMARTCARD_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */ 501 #define SMARTCARD_ADVFEATURE_DATAINV_ENABLE USART_CR2_DATAINV /*!< Binary data inversion enable */ 502 /** 503 * @} 504 */ 505 506 /** @defgroup SMARTCARD_Rx_Tx_Swap SMARTCARD advanced feature RX TX pins swap 507 * @{ 508 */ 509 #define SMARTCARD_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */ 510 #define SMARTCARD_ADVFEATURE_SWAP_ENABLE USART_CR2_SWAP /*!< TX/RX pins swap enable */ 511 /** 512 * @} 513 */ 514 515 /** @defgroup SMARTCARD_Overrun_Disable SMARTCARD advanced feature Overrun Disable 516 * @{ 517 */ 518 #define SMARTCARD_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */ 519 #define SMARTCARD_ADVFEATURE_OVERRUN_DISABLE USART_CR3_OVRDIS /*!< RX overrun disable */ 520 /** 521 * @} 522 */ 523 524 /** @defgroup SMARTCARD_DMA_Disable_on_Rx_Error SMARTCARD advanced feature DMA Disable on Rx Error 525 * @{ 526 */ 527 #define SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */ 528 #define SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR USART_CR3_DDRE /*!< DMA disable on Reception Error */ 529 /** 530 * @} 531 */ 532 533 /** @defgroup SMARTCARD_MSB_First SMARTCARD advanced feature MSB first 534 * @{ 535 */ 536 #define SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received first disable */ 537 #define SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE USART_CR2_MSBFIRST /*!< Most significant bit sent/received first enable */ 538 /** 539 * @} 540 */ 541 542 /** @defgroup SMARTCARD_Request_Parameters SMARTCARD Request Parameters 543 * @{ 544 */ 545 #define SMARTCARD_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive data flush request */ 546 #define SMARTCARD_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush request */ 547 /** 548 * @} 549 */ 550 551 /** @defgroup SMARTCARD_Interruption_Mask SMARTCARD interruptions flags mask 552 * @{ 553 */ 554 #define SMARTCARD_IT_MASK 0x001FU /*!< SMARTCARD interruptions flags mask */ 555 #define SMARTCARD_CR_MASK 0x00E0U /*!< SMARTCARD control register mask */ 556 #define SMARTCARD_CR_POS 5U /*!< SMARTCARD control register position */ 557 #define SMARTCARD_ISR_MASK 0x1F00U /*!< SMARTCARD ISR register mask */ 558 #define SMARTCARD_ISR_POS 8U /*!< SMARTCARD ISR register position */ 559 /** 560 * @} 561 */ 562 563 /** 564 * @} 565 */ 566 567 /* Exported macros -----------------------------------------------------------*/ 568 /** @defgroup SMARTCARD_Exported_Macros SMARTCARD Exported Macros 569 * @{ 570 */ 571 572 /** @brief Reset SMARTCARD handle states. 573 * @param __HANDLE__ SMARTCARD handle. 574 * @retval None 575 */ 576 #if USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1 577 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) do{ \ 578 (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET; \ 579 (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET; \ 580 (__HANDLE__)->MspInitCallback = NULL; \ 581 (__HANDLE__)->MspDeInitCallback = NULL; \ 582 } while(0U) 583 #else 584 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) do{ \ 585 (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET; \ 586 (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET; \ 587 } while(0U) 588 #endif /*USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 589 590 /** @brief Flush the Smartcard Data registers. 591 * @param __HANDLE__ specifies the SMARTCARD Handle. 592 * @retval None 593 */ 594 #define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__) \ 595 do{ \ 596 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_RXDATA_FLUSH_REQUEST); \ 597 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_TXDATA_FLUSH_REQUEST); \ 598 } while(0U) 599 600 /** @brief Clear the specified SMARTCARD pending flag. 601 * @param __HANDLE__ specifies the SMARTCARD Handle. 602 * @param __FLAG__ specifies the flag to check. 603 * This parameter can be any combination of the following values: 604 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag 605 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag 606 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag 607 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag 608 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detected clear flag 609 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag 610 * @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag 611 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag 612 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag 613 * @arg @ref SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear flag 614 * @retval None 615 */ 616 #define __HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) 617 618 /** @brief Clear the SMARTCARD PE pending flag. 619 * @param __HANDLE__ specifies the SMARTCARD Handle. 620 * @retval None 621 */ 622 #define __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_PEF) 623 624 /** @brief Clear the SMARTCARD FE pending flag. 625 * @param __HANDLE__ specifies the SMARTCARD Handle. 626 * @retval None 627 */ 628 #define __HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_FEF) 629 630 /** @brief Clear the SMARTCARD NE pending flag. 631 * @param __HANDLE__ specifies the SMARTCARD Handle. 632 * @retval None 633 */ 634 #define __HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_NEF) 635 636 /** @brief Clear the SMARTCARD ORE pending flag. 637 * @param __HANDLE__ specifies the SMARTCARD Handle. 638 * @retval None 639 */ 640 #define __HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_OREF) 641 642 /** @brief Clear the SMARTCARD IDLE pending flag. 643 * @param __HANDLE__ specifies the SMARTCARD Handle. 644 * @retval None 645 */ 646 #define __HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_IDLEF) 647 648 /** @brief Check whether the specified Smartcard flag is set or not. 649 * @param __HANDLE__ specifies the SMARTCARD Handle. 650 * @param __FLAG__ specifies the flag to check. 651 * This parameter can be one of the following values: 652 * @arg @ref SMARTCARD_FLAG_TCBGT Transmission complete before guard time flag (when flag available) 653 * @arg @ref SMARTCARD_FLAG_REACK Receive enable acknowledge flag 654 * @arg @ref SMARTCARD_FLAG_TEACK Transmit enable acknowledge flag 655 * @arg @ref SMARTCARD_FLAG_BUSY Busy flag 656 * @arg @ref SMARTCARD_FLAG_EOBF End of block flag 657 * @arg @ref SMARTCARD_FLAG_RTOF Receiver timeout flag 658 * @arg @ref SMARTCARD_FLAG_TXE Transmit data register empty flag 659 * @arg @ref SMARTCARD_FLAG_TC Transmission complete flag 660 * @arg @ref SMARTCARD_FLAG_RXNE Receive data register not empty flag 661 * @arg @ref SMARTCARD_FLAG_IDLE Idle line detection flag 662 * @arg @ref SMARTCARD_FLAG_ORE Overrun error flag 663 * @arg @ref SMARTCARD_FLAG_NE Noise error flag 664 * @arg @ref SMARTCARD_FLAG_FE Framing error flag 665 * @arg @ref SMARTCARD_FLAG_PE Parity error flag 666 * @arg @ref SMARTCARD_FLAG_TXFNF TXFIFO not full flag 667 * @arg @ref SMARTCARD_FLAG_RXFNE RXFIFO not empty flag 668 * @arg @ref SMARTCARD_FLAG_TXFE TXFIFO Empty flag 669 * @arg @ref SMARTCARD_FLAG_RXFF RXFIFO Full flag 670 * @arg @ref SMARTCARD_FLAG_RXFT SMARTCARD RXFIFO threshold flag 671 * @arg @ref SMARTCARD_FLAG_TXFT SMARTCARD TXFIFO threshold flag 672 * @retval The new state of __FLAG__ (TRUE or FALSE). 673 */ 674 #define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__)) 675 676 /** @brief Enable the specified SmartCard interrupt. 677 * @param __HANDLE__ specifies the SMARTCARD Handle. 678 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to enable. 679 * This parameter can be one of the following values: 680 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 681 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 682 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 683 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 684 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before 685 * guard time interrupt (when interruption available) 686 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 687 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 688 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 689 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 690 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 691 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 692 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 693 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 694 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 695 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 696 * @retval None 697 */ 698 #define __HAL_SMARTCARD_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 699 SMARTCARD_CR_POS) == 1U)?\ 700 ((__HANDLE__)->Instance->CR1 |= (1UL <<\ 701 ((__INTERRUPT__) & SMARTCARD_IT_MASK))):\ 702 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 703 SMARTCARD_CR_POS) == 2U)?\ 704 ((__HANDLE__)->Instance->CR2 |= (1UL <<\ 705 ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 706 ((__HANDLE__)->Instance->CR3 |= (1UL <<\ 707 ((__INTERRUPT__) & SMARTCARD_IT_MASK)))) 708 709 /** @brief Disable the specified SmartCard interrupt. 710 * @param __HANDLE__ specifies the SMARTCARD Handle. 711 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to disable. 712 * This parameter can be one of the following values: 713 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 714 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 715 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 716 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 717 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard 718 * time interrupt (when interruption available) 719 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 720 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 721 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 722 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 723 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 724 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 725 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 726 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 727 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 728 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 729 * @retval None 730 */ 731 #define __HAL_SMARTCARD_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 732 SMARTCARD_CR_POS) == 1U)?\ 733 ((__HANDLE__)->Instance->CR1 &= ~ (1U <<\ 734 ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 735 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 736 SMARTCARD_CR_POS) == 2U)?\ 737 ((__HANDLE__)->Instance->CR2 &= ~ (1U <<\ 738 ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 739 ((__HANDLE__)->Instance->CR3 &= ~ (1U <<\ 740 ((__INTERRUPT__) & SMARTCARD_IT_MASK)))) 741 742 /** @brief Check whether the specified SmartCard interrupt has occurred or not. 743 * @param __HANDLE__ specifies the SMARTCARD Handle. 744 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to check. 745 * This parameter can be one of the following values: 746 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 747 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 748 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 749 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 750 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time 751 * interrupt (when interruption available) 752 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 753 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 754 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 755 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 756 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 757 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 758 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 759 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 760 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 761 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 762 * @retval The new state of __INTERRUPT__ (SET or RESET). 763 */ 764 #define __HAL_SMARTCARD_GET_IT(__HANDLE__, __INTERRUPT__) (\ 765 (((__HANDLE__)->Instance->ISR & (0x01UL << (((__INTERRUPT__)\ 766 & SMARTCARD_ISR_MASK)>> SMARTCARD_ISR_POS)))!= 0U)\ 767 ? SET : RESET) 768 769 /** @brief Check whether the specified SmartCard interrupt source is enabled or not. 770 * @param __HANDLE__ specifies the SMARTCARD Handle. 771 * @param __INTERRUPT__ specifies the SMARTCARD interrupt source to check. 772 * This parameter can be one of the following values: 773 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 774 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 775 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 776 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 777 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time 778 * interrupt (when interruption available) 779 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 780 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 781 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 782 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 783 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 784 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 785 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 786 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 787 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 788 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 789 * @retval The new state of __INTERRUPT__ (SET or RESET). 790 */ 791 #define __HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 792 SMARTCARD_CR_POS) == 0x01U)?\ 793 (__HANDLE__)->Instance->CR1 : \ 794 (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 795 SMARTCARD_CR_POS) == 0x02U)?\ 796 (__HANDLE__)->Instance->CR2 : \ 797 (__HANDLE__)->Instance->CR3)) &\ 798 (0x01UL << (((uint16_t)(__INTERRUPT__))\ 799 & SMARTCARD_IT_MASK))) != 0U)\ 800 ? SET : RESET) 801 802 /** @brief Clear the specified SMARTCARD ISR flag, in setting the proper ICR register flag. 803 * @param __HANDLE__ specifies the SMARTCARD Handle. 804 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set 805 * to clear the corresponding interrupt. 806 * This parameter can be one of the following values: 807 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag 808 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag 809 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag 810 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag 811 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detection clear flag 812 * @arg @ref SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear Flag 813 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag 814 * @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag (when flag available) 815 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag 816 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag 817 * @retval None 818 */ 819 #define __HAL_SMARTCARD_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR |= (uint32_t)(__IT_CLEAR__)) 820 821 /** @brief Set a specific SMARTCARD request flag. 822 * @param __HANDLE__ specifies the SMARTCARD Handle. 823 * @param __REQ__ specifies the request flag to set 824 * This parameter can be one of the following values: 825 * @arg @ref SMARTCARD_RXDATA_FLUSH_REQUEST Receive data flush Request 826 * @arg @ref SMARTCARD_TXDATA_FLUSH_REQUEST Transmit data flush Request 827 * @retval None 828 */ 829 #define __HAL_SMARTCARD_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__)) 830 831 /** @brief Enable the SMARTCARD one bit sample method. 832 * @param __HANDLE__ specifies the SMARTCARD Handle. 833 * @retval None 834 */ 835 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT) 836 837 /** @brief Disable the SMARTCARD one bit sample method. 838 * @param __HANDLE__ specifies the SMARTCARD Handle. 839 * @retval None 840 */ 841 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\ 842 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT)) 843 844 /** @brief Enable the USART associated to the SMARTCARD Handle. 845 * @param __HANDLE__ specifies the SMARTCARD Handle. 846 * @retval None 847 */ 848 #define __HAL_SMARTCARD_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE) 849 850 /** @brief Disable the USART associated to the SMARTCARD Handle 851 * @param __HANDLE__ specifies the SMARTCARD Handle. 852 * @retval None 853 */ 854 #define __HAL_SMARTCARD_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE) 855 856 /** 857 * @} 858 */ 859 860 /* Private macros -------------------------------------------------------------*/ 861 /** @defgroup SMARTCARD_Private_Macros SMARTCARD Private Macros 862 * @{ 863 */ 864 865 /** @brief Report the SMARTCARD clock source. 866 * @param __HANDLE__ specifies the SMARTCARD Handle. 867 * @param __CLOCKSOURCE__ output variable. 868 * @retval the SMARTCARD clocking source, written in __CLOCKSOURCE__. 869 */ 870 #if (defined(STM32H573xx) || defined(STM32H563xx) || defined(STM32H562xx)) 871 #define SMARTCARD_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ 872 do { \ 873 if((__HANDLE__)->Instance == USART1) \ 874 { \ 875 switch(__HAL_RCC_GET_USART1_SOURCE()) \ 876 { \ 877 case RCC_USART1CLKSOURCE_PCLK2: \ 878 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK2; \ 879 break; \ 880 case RCC_USART1CLKSOURCE_HSI: \ 881 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 882 break; \ 883 case RCC_USART1CLKSOURCE_CSI: \ 884 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 885 break; \ 886 case RCC_USART1CLKSOURCE_LSE: \ 887 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 888 break; \ 889 case RCC_USART1CLKSOURCE_PLL2Q: \ 890 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 891 break; \ 892 case RCC_USART1CLKSOURCE_PLL3Q: \ 893 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q; \ 894 break; \ 895 default: \ 896 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 897 break; \ 898 } \ 899 } \ 900 else if((__HANDLE__)->Instance == USART2) \ 901 { \ 902 switch(__HAL_RCC_GET_USART2_SOURCE()) \ 903 { \ 904 case RCC_USART2CLKSOURCE_PCLK1: \ 905 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 906 break; \ 907 case RCC_USART2CLKSOURCE_HSI: \ 908 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 909 break; \ 910 case RCC_USART2CLKSOURCE_CSI: \ 911 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 912 break; \ 913 case RCC_USART2CLKSOURCE_LSE: \ 914 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 915 break; \ 916 case RCC_USART2CLKSOURCE_PLL2Q: \ 917 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 918 break; \ 919 case RCC_USART2CLKSOURCE_PLL3Q: \ 920 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q; \ 921 break; \ 922 default: \ 923 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 924 break; \ 925 } \ 926 } \ 927 else if((__HANDLE__)->Instance == USART3) \ 928 { \ 929 switch(__HAL_RCC_GET_USART3_SOURCE()) \ 930 { \ 931 case RCC_USART3CLKSOURCE_PCLK1: \ 932 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 933 break; \ 934 case RCC_USART3CLKSOURCE_HSI: \ 935 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 936 break; \ 937 case RCC_USART3CLKSOURCE_CSI: \ 938 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 939 break; \ 940 case RCC_USART3CLKSOURCE_LSE: \ 941 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 942 break; \ 943 case RCC_USART3CLKSOURCE_PLL2Q: \ 944 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 945 break; \ 946 case RCC_USART3CLKSOURCE_PLL3Q: \ 947 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q; \ 948 break; \ 949 default: \ 950 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 951 break; \ 952 } \ 953 } \ 954 else if((__HANDLE__)->Instance == USART6) \ 955 { \ 956 switch(__HAL_RCC_GET_USART6_SOURCE()) \ 957 { \ 958 case RCC_USART6CLKSOURCE_PCLK1: \ 959 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 960 break; \ 961 case RCC_USART6CLKSOURCE_HSI: \ 962 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 963 break; \ 964 case RCC_USART6CLKSOURCE_CSI: \ 965 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 966 break; \ 967 case RCC_USART6CLKSOURCE_LSE: \ 968 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 969 break; \ 970 case RCC_USART6CLKSOURCE_PLL2Q: \ 971 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 972 break; \ 973 case RCC_USART6CLKSOURCE_PLL3Q: \ 974 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q; \ 975 break; \ 976 default: \ 977 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 978 break; \ 979 } \ 980 } \ 981 else if((__HANDLE__)->Instance == USART10) \ 982 { \ 983 switch(__HAL_RCC_GET_USART10_SOURCE()) \ 984 { \ 985 case RCC_USART10CLKSOURCE_PCLK1: \ 986 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 987 break; \ 988 case RCC_USART10CLKSOURCE_HSI: \ 989 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 990 break; \ 991 case RCC_USART10CLKSOURCE_CSI: \ 992 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 993 break; \ 994 case RCC_USART10CLKSOURCE_LSE: \ 995 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 996 break; \ 997 case RCC_USART10CLKSOURCE_PLL2Q: \ 998 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 999 break; \ 1000 case RCC_USART10CLKSOURCE_PLL3Q: \ 1001 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q; \ 1002 break; \ 1003 default: \ 1004 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1005 break; \ 1006 } \ 1007 } \ 1008 else if((__HANDLE__)->Instance == USART11) \ 1009 { \ 1010 switch(__HAL_RCC_GET_USART11_SOURCE()) \ 1011 { \ 1012 case RCC_USART11CLKSOURCE_PCLK1: \ 1013 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 1014 break; \ 1015 case RCC_USART11CLKSOURCE_HSI: \ 1016 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 1017 break; \ 1018 case RCC_USART11CLKSOURCE_CSI: \ 1019 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 1020 break; \ 1021 case RCC_USART11CLKSOURCE_LSE: \ 1022 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 1023 break; \ 1024 case RCC_USART11CLKSOURCE_PLL2Q: \ 1025 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 1026 break; \ 1027 case RCC_USART11CLKSOURCE_PLL3Q: \ 1028 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q; \ 1029 break; \ 1030 default: \ 1031 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1032 break; \ 1033 } \ 1034 } \ 1035 else \ 1036 { \ 1037 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1038 } \ 1039 } while(0U) 1040 #elif (defined(STM32H523xx) || defined(STM32H533xx)) 1041 #define SMARTCARD_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ 1042 do { \ 1043 if((__HANDLE__)->Instance == USART1) \ 1044 { \ 1045 switch(__HAL_RCC_GET_USART1_SOURCE()) \ 1046 { \ 1047 case RCC_USART1CLKSOURCE_PCLK2: \ 1048 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK2; \ 1049 break; \ 1050 case RCC_USART1CLKSOURCE_HSI: \ 1051 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 1052 break; \ 1053 case RCC_USART1CLKSOURCE_CSI: \ 1054 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 1055 break; \ 1056 case RCC_USART1CLKSOURCE_LSE: \ 1057 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 1058 break; \ 1059 case RCC_USART1CLKSOURCE_PLL2Q: \ 1060 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 1061 break; \ 1062 case RCC_USART1CLKSOURCE_PLL3Q: \ 1063 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q; \ 1064 break; \ 1065 default: \ 1066 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1067 break; \ 1068 } \ 1069 } \ 1070 else if((__HANDLE__)->Instance == USART2) \ 1071 { \ 1072 switch(__HAL_RCC_GET_USART2_SOURCE()) \ 1073 { \ 1074 case RCC_USART2CLKSOURCE_PCLK1: \ 1075 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 1076 break; \ 1077 case RCC_USART2CLKSOURCE_HSI: \ 1078 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 1079 break; \ 1080 case RCC_USART2CLKSOURCE_CSI: \ 1081 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 1082 break; \ 1083 case RCC_USART2CLKSOURCE_LSE: \ 1084 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 1085 break; \ 1086 case RCC_USART2CLKSOURCE_PLL2Q: \ 1087 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 1088 break; \ 1089 case RCC_USART2CLKSOURCE_PLL3Q: \ 1090 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q; \ 1091 break; \ 1092 default: \ 1093 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1094 break; \ 1095 } \ 1096 } \ 1097 else if((__HANDLE__)->Instance == USART3) \ 1098 { \ 1099 switch(__HAL_RCC_GET_USART3_SOURCE()) \ 1100 { \ 1101 case RCC_USART3CLKSOURCE_PCLK1: \ 1102 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 1103 break; \ 1104 case RCC_USART3CLKSOURCE_HSI: \ 1105 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 1106 break; \ 1107 case RCC_USART3CLKSOURCE_CSI: \ 1108 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 1109 break; \ 1110 case RCC_USART3CLKSOURCE_LSE: \ 1111 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 1112 break; \ 1113 case RCC_USART3CLKSOURCE_PLL2Q: \ 1114 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 1115 break; \ 1116 case RCC_USART3CLKSOURCE_PLL3Q: \ 1117 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q; \ 1118 break; \ 1119 default: \ 1120 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1121 break; \ 1122 } \ 1123 } \ 1124 else if((__HANDLE__)->Instance == USART6) \ 1125 { \ 1126 switch(__HAL_RCC_GET_USART6_SOURCE()) \ 1127 { \ 1128 case RCC_USART6CLKSOURCE_PCLK1: \ 1129 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 1130 break; \ 1131 case RCC_USART6CLKSOURCE_HSI: \ 1132 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 1133 break; \ 1134 case RCC_USART6CLKSOURCE_CSI: \ 1135 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 1136 break; \ 1137 case RCC_USART6CLKSOURCE_LSE: \ 1138 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 1139 break; \ 1140 case RCC_USART6CLKSOURCE_PLL2Q: \ 1141 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 1142 break; \ 1143 case RCC_USART6CLKSOURCE_PLL3Q: \ 1144 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q; \ 1145 break; \ 1146 default: \ 1147 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1148 break; \ 1149 } \ 1150 } \ 1151 else \ 1152 { \ 1153 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1154 } \ 1155 } while(0U) 1156 #else 1157 #define SMARTCARD_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ 1158 do { \ 1159 if((__HANDLE__)->Instance == USART1) \ 1160 { \ 1161 switch(__HAL_RCC_GET_USART1_SOURCE()) \ 1162 { \ 1163 case RCC_USART1CLKSOURCE_PCLK2: \ 1164 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK2; \ 1165 break; \ 1166 case RCC_USART1CLKSOURCE_HSI: \ 1167 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 1168 break; \ 1169 case RCC_USART1CLKSOURCE_CSI: \ 1170 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 1171 break; \ 1172 case RCC_USART1CLKSOURCE_LSE: \ 1173 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 1174 break; \ 1175 case RCC_USART1CLKSOURCE_PLL2Q: \ 1176 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 1177 break; \ 1178 default: \ 1179 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1180 break; \ 1181 } \ 1182 } \ 1183 else if((__HANDLE__)->Instance == USART2) \ 1184 { \ 1185 switch(__HAL_RCC_GET_USART2_SOURCE()) \ 1186 { \ 1187 case RCC_USART2CLKSOURCE_PCLK1: \ 1188 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 1189 break; \ 1190 case RCC_USART2CLKSOURCE_HSI: \ 1191 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 1192 break; \ 1193 case RCC_USART2CLKSOURCE_CSI: \ 1194 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 1195 break; \ 1196 case RCC_USART2CLKSOURCE_LSE: \ 1197 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 1198 break; \ 1199 case RCC_USART2CLKSOURCE_PLL2Q: \ 1200 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 1201 break; \ 1202 default: \ 1203 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1204 break; \ 1205 } \ 1206 } \ 1207 else if((__HANDLE__)->Instance == USART3) \ 1208 { \ 1209 switch(__HAL_RCC_GET_USART3_SOURCE()) \ 1210 { \ 1211 case RCC_USART3CLKSOURCE_PCLK1: \ 1212 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 1213 break; \ 1214 case RCC_USART3CLKSOURCE_HSI: \ 1215 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 1216 break; \ 1217 case RCC_USART3CLKSOURCE_CSI: \ 1218 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI; \ 1219 break; \ 1220 case RCC_USART3CLKSOURCE_LSE: \ 1221 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 1222 break; \ 1223 case RCC_USART3CLKSOURCE_PLL2Q: \ 1224 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q; \ 1225 break; \ 1226 default: \ 1227 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1228 break; \ 1229 } \ 1230 } \ 1231 else \ 1232 { \ 1233 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 1234 } \ 1235 } while(0U) 1236 #endif /* (defined(STM32H573xx) || defined(STM32H563xx) || defined(STM32H562xx) */ 1237 1238 /** @brief Check the Baud rate range. 1239 * @note The maximum Baud Rate is derived from the maximum clock on H5 (250 MHz) 1240 * divided by the oversampling used on the SMARTCARD (i.e. 16). 1241 * @param __BAUDRATE__ Baud rate set by the configuration function. 1242 * @retval Test result (TRUE or FALSE) 1243 */ 1244 #define IS_SMARTCARD_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 10000000U) 1245 1246 /** @brief Check the block length range. 1247 * @note The maximum SMARTCARD block length is 0xFF. 1248 * @param __LENGTH__ block length. 1249 * @retval Test result (TRUE or FALSE) 1250 */ 1251 #define IS_SMARTCARD_BLOCKLENGTH(__LENGTH__) ((__LENGTH__) <= 0xFFU) 1252 1253 /** @brief Check the receiver timeout value. 1254 * @note The maximum SMARTCARD receiver timeout value is 0xFFFFFF. 1255 * @param __TIMEOUTVALUE__ receiver timeout value. 1256 * @retval Test result (TRUE or FALSE) 1257 */ 1258 #define IS_SMARTCARD_TIMEOUT_VALUE(__TIMEOUTVALUE__) ((__TIMEOUTVALUE__) <= 0xFFFFFFU) 1259 1260 /** @brief Check the SMARTCARD autoretry counter value. 1261 * @note The maximum number of retransmissions is 0x7. 1262 * @param __COUNT__ number of retransmissions. 1263 * @retval Test result (TRUE or FALSE) 1264 */ 1265 #define IS_SMARTCARD_AUTORETRY_COUNT(__COUNT__) ((__COUNT__) <= 0x7U) 1266 1267 /** @brief Ensure that SMARTCARD frame length is valid. 1268 * @param __LENGTH__ SMARTCARD frame length. 1269 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid) 1270 */ 1271 #define IS_SMARTCARD_WORD_LENGTH(__LENGTH__) ((__LENGTH__) == SMARTCARD_WORDLENGTH_9B) 1272 1273 /** @brief Ensure that SMARTCARD frame number of stop bits is valid. 1274 * @param __STOPBITS__ SMARTCARD frame number of stop bits. 1275 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid) 1276 */ 1277 #define IS_SMARTCARD_STOPBITS(__STOPBITS__) (((__STOPBITS__) == SMARTCARD_STOPBITS_0_5) ||\ 1278 ((__STOPBITS__) == SMARTCARD_STOPBITS_1_5)) 1279 1280 /** @brief Ensure that SMARTCARD frame parity is valid. 1281 * @param __PARITY__ SMARTCARD frame parity. 1282 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid) 1283 */ 1284 #define IS_SMARTCARD_PARITY(__PARITY__) (((__PARITY__) == SMARTCARD_PARITY_EVEN) || \ 1285 ((__PARITY__) == SMARTCARD_PARITY_ODD)) 1286 1287 /** @brief Ensure that SMARTCARD communication mode is valid. 1288 * @param __MODE__ SMARTCARD communication mode. 1289 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 1290 */ 1291 #define IS_SMARTCARD_MODE(__MODE__) ((((__MODE__) & 0xFFF3U) == 0x00U) && ((__MODE__) != 0x00U)) 1292 1293 /** @brief Ensure that SMARTCARD frame polarity is valid. 1294 * @param __CPOL__ SMARTCARD frame polarity. 1295 * @retval SET (__CPOL__ is valid) or RESET (__CPOL__ is invalid) 1296 */ 1297 #define IS_SMARTCARD_POLARITY(__CPOL__) (((__CPOL__) == SMARTCARD_POLARITY_LOW)\ 1298 || ((__CPOL__) == SMARTCARD_POLARITY_HIGH)) 1299 1300 /** @brief Ensure that SMARTCARD frame phase is valid. 1301 * @param __CPHA__ SMARTCARD frame phase. 1302 * @retval SET (__CPHA__ is valid) or RESET (__CPHA__ is invalid) 1303 */ 1304 #define IS_SMARTCARD_PHASE(__CPHA__) (((__CPHA__) == SMARTCARD_PHASE_1EDGE) || ((__CPHA__) == SMARTCARD_PHASE_2EDGE)) 1305 1306 /** @brief Ensure that SMARTCARD frame last bit clock pulse setting is valid. 1307 * @param __LASTBIT__ SMARTCARD frame last bit clock pulse setting. 1308 * @retval SET (__LASTBIT__ is valid) or RESET (__LASTBIT__ is invalid) 1309 */ 1310 #define IS_SMARTCARD_LASTBIT(__LASTBIT__) (((__LASTBIT__) == SMARTCARD_LASTBIT_DISABLE) || \ 1311 ((__LASTBIT__) == SMARTCARD_LASTBIT_ENABLE)) 1312 1313 /** @brief Ensure that SMARTCARD frame sampling is valid. 1314 * @param __ONEBIT__ SMARTCARD frame sampling. 1315 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid) 1316 */ 1317 #define IS_SMARTCARD_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_DISABLE) || \ 1318 ((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_ENABLE)) 1319 1320 /** @brief Ensure that SMARTCARD NACK transmission setting is valid. 1321 * @param __NACK__ SMARTCARD NACK transmission setting. 1322 * @retval SET (__NACK__ is valid) or RESET (__NACK__ is invalid) 1323 */ 1324 #define IS_SMARTCARD_NACK(__NACK__) (((__NACK__) == SMARTCARD_NACK_ENABLE) || \ 1325 ((__NACK__) == SMARTCARD_NACK_DISABLE)) 1326 1327 /** @brief Ensure that SMARTCARD receiver timeout setting is valid. 1328 * @param __TIMEOUT__ SMARTCARD receiver timeout setting. 1329 * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid) 1330 */ 1331 #define IS_SMARTCARD_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == SMARTCARD_TIMEOUT_DISABLE) || \ 1332 ((__TIMEOUT__) == SMARTCARD_TIMEOUT_ENABLE)) 1333 1334 /** @brief Ensure that SMARTCARD clock Prescaler is valid. 1335 * @param __CLOCKPRESCALER__ SMARTCARD clock Prescaler value. 1336 * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid) 1337 */ 1338 #define IS_SMARTCARD_CLOCKPRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV1) || \ 1339 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV2) || \ 1340 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV4) || \ 1341 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV6) || \ 1342 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV8) || \ 1343 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV10) || \ 1344 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV12) || \ 1345 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV16) || \ 1346 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV32) || \ 1347 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV64) || \ 1348 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV128) || \ 1349 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV256)) 1350 1351 /** @brief Ensure that SMARTCARD advanced features initialization is valid. 1352 * @param __INIT__ SMARTCARD advanced features initialization. 1353 * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid) 1354 */ 1355 #define IS_SMARTCARD_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (SMARTCARD_ADVFEATURE_NO_INIT | \ 1356 SMARTCARD_ADVFEATURE_TXINVERT_INIT | \ 1357 SMARTCARD_ADVFEATURE_RXINVERT_INIT | \ 1358 SMARTCARD_ADVFEATURE_DATAINVERT_INIT | \ 1359 SMARTCARD_ADVFEATURE_SWAP_INIT | \ 1360 SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT | \ 1361 SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT | \ 1362 SMARTCARD_ADVFEATURE_MSBFIRST_INIT)) 1363 1364 /** @brief Ensure that SMARTCARD frame TX inversion setting is valid. 1365 * @param __TXINV__ SMARTCARD frame TX inversion setting. 1366 * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid) 1367 */ 1368 #define IS_SMARTCARD_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_DISABLE) || \ 1369 ((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_ENABLE)) 1370 1371 /** @brief Ensure that SMARTCARD frame RX inversion setting is valid. 1372 * @param __RXINV__ SMARTCARD frame RX inversion setting. 1373 * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid) 1374 */ 1375 #define IS_SMARTCARD_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_DISABLE) || \ 1376 ((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_ENABLE)) 1377 1378 /** @brief Ensure that SMARTCARD frame data inversion setting is valid. 1379 * @param __DATAINV__ SMARTCARD frame data inversion setting. 1380 * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid) 1381 */ 1382 #define IS_SMARTCARD_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_DISABLE) || \ 1383 ((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_ENABLE)) 1384 1385 /** @brief Ensure that SMARTCARD frame RX/TX pins swap setting is valid. 1386 * @param __SWAP__ SMARTCARD frame RX/TX pins swap setting. 1387 * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid) 1388 */ 1389 #define IS_SMARTCARD_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_DISABLE) || \ 1390 ((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_ENABLE)) 1391 1392 /** @brief Ensure that SMARTCARD frame overrun setting is valid. 1393 * @param __OVERRUN__ SMARTCARD frame overrun setting. 1394 * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid) 1395 */ 1396 #define IS_SMARTCARD_OVERRUN(__OVERRUN__) (((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_ENABLE) || \ 1397 ((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_DISABLE)) 1398 1399 /** @brief Ensure that SMARTCARD DMA enabling or disabling on error setting is valid. 1400 * @param __DMA__ SMARTCARD DMA enabling or disabling on error setting. 1401 * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid) 1402 */ 1403 #define IS_SMARTCARD_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR) || \ 1404 ((__DMA__) == SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR)) 1405 1406 /** @brief Ensure that SMARTCARD frame MSB first setting is valid. 1407 * @param __MSBFIRST__ SMARTCARD frame MSB first setting. 1408 * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid) 1409 */ 1410 #define IS_SMARTCARD_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE) || \ 1411 ((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE)) 1412 1413 /** @brief Ensure that SMARTCARD request parameter is valid. 1414 * @param __PARAM__ SMARTCARD request parameter. 1415 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid) 1416 */ 1417 #define IS_SMARTCARD_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == SMARTCARD_RXDATA_FLUSH_REQUEST) || \ 1418 ((__PARAM__) == SMARTCARD_TXDATA_FLUSH_REQUEST)) 1419 1420 /** 1421 * @} 1422 */ 1423 1424 /* Include SMARTCARD HAL Extended module */ 1425 #include "stm32h5xx_hal_smartcard_ex.h" 1426 1427 /* Exported functions --------------------------------------------------------*/ 1428 /** @addtogroup SMARTCARD_Exported_Functions 1429 * @{ 1430 */ 1431 1432 /* Initialization and de-initialization functions ****************************/ 1433 /** @addtogroup SMARTCARD_Exported_Functions_Group1 1434 * @{ 1435 */ 1436 1437 HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsmartcard); 1438 HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsmartcard); 1439 void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsmartcard); 1440 void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsmartcard); 1441 1442 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 1443 /* Callbacks Register/UnRegister functions ***********************************/ 1444 HAL_StatusTypeDef HAL_SMARTCARD_RegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard, 1445 HAL_SMARTCARD_CallbackIDTypeDef CallbackID, 1446 pSMARTCARD_CallbackTypeDef pCallback); 1447 HAL_StatusTypeDef HAL_SMARTCARD_UnRegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard, 1448 HAL_SMARTCARD_CallbackIDTypeDef CallbackID); 1449 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 1450 1451 /** 1452 * @} 1453 */ 1454 1455 /* IO operation functions *****************************************************/ 1456 /** @addtogroup SMARTCARD_Exported_Functions_Group2 1457 * @{ 1458 */ 1459 1460 HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size, 1461 uint32_t Timeout); 1462 HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size, 1463 uint32_t Timeout); 1464 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size); 1465 HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size); 1466 #if defined(HAL_DMA_MODULE_ENABLED) 1467 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size); 1468 HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size); 1469 #endif /* HAL_DMA_MODULE_ENABLED */ 1470 /* Transfer Abort functions */ 1471 HAL_StatusTypeDef HAL_SMARTCARD_Abort(SMARTCARD_HandleTypeDef *hsmartcard); 1472 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit(SMARTCARD_HandleTypeDef *hsmartcard); 1473 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive(SMARTCARD_HandleTypeDef *hsmartcard); 1474 HAL_StatusTypeDef HAL_SMARTCARD_Abort_IT(SMARTCARD_HandleTypeDef *hsmartcard); 1475 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit_IT(SMARTCARD_HandleTypeDef *hsmartcard); 1476 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive_IT(SMARTCARD_HandleTypeDef *hsmartcard); 1477 1478 void HAL_SMARTCARD_IRQHandler(SMARTCARD_HandleTypeDef *hsmartcard); 1479 void HAL_SMARTCARD_TxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1480 void HAL_SMARTCARD_RxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1481 void HAL_SMARTCARD_ErrorCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1482 void HAL_SMARTCARD_AbortCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1483 void HAL_SMARTCARD_AbortTransmitCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1484 void HAL_SMARTCARD_AbortReceiveCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1485 1486 /** 1487 * @} 1488 */ 1489 1490 /* Peripheral State and Error functions ***************************************/ 1491 /** @addtogroup SMARTCARD_Exported_Functions_Group4 1492 * @{ 1493 */ 1494 1495 HAL_SMARTCARD_StateTypeDef HAL_SMARTCARD_GetState(const SMARTCARD_HandleTypeDef *hsmartcard); 1496 uint32_t HAL_SMARTCARD_GetError(const SMARTCARD_HandleTypeDef *hsmartcard); 1497 1498 /** 1499 * @} 1500 */ 1501 1502 /** 1503 * @} 1504 */ 1505 1506 /** 1507 * @} 1508 */ 1509 1510 /** 1511 * @} 1512 */ 1513 1514 #ifdef __cplusplus 1515 } 1516 #endif 1517 1518 #endif /* STM32H5xx_HAL_SMARTCARD_H */ 1519
