1 /** 2 ****************************************************************************** 3 * @file stm32l5xx_hal_smartcard.h 4 * @author MCD Application Team 5 * @brief Header file of SMARTCARD HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2019 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 STM32L5xx_HAL_SMARTCARD_H 21 #define STM32L5xx_HAL_SMARTCARD_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32l5xx_hal_def.h" 29 30 /** @addtogroup STM32L5xx_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 DMA_HandleTypeDef *hdmatx; /*!< SmartCard Tx DMA Handle parameters */ 229 230 DMA_HandleTypeDef *hdmarx; /*!< SmartCard Rx DMA Handle parameters */ 231 232 HAL_LockTypeDef Lock; /*!< Locking object */ 233 234 __IO HAL_SMARTCARD_StateTypeDef gState; /*!< SmartCard state information related to global 235 Handle management and also related to Tx operations. 236 This parameter can be a value 237 of @ref HAL_SMARTCARD_StateTypeDef */ 238 239 __IO HAL_SMARTCARD_StateTypeDef RxState; /*!< SmartCard state information related to Rx operations. 240 This parameter can be a value 241 of @ref HAL_SMARTCARD_StateTypeDef */ 242 243 __IO uint32_t ErrorCode; /*!< SmartCard Error code */ 244 245 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 246 void (* TxCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Tx Complete Callback */ 247 248 void (* RxCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Rx Complete Callback */ 249 250 void (* ErrorCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Error Callback */ 251 252 void (* AbortCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Complete Callback */ 253 254 void (* AbortTransmitCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Transmit Complete Callback */ 255 256 void (* AbortReceiveCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Receive Complete Callback */ 257 258 void (* RxFifoFullCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Rx Fifo Full Callback */ 259 260 void (* TxFifoEmptyCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Tx Fifo Empty Callback */ 261 262 void (* MspInitCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Msp Init callback */ 263 264 void (* MspDeInitCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Msp DeInit callback */ 265 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 266 267 } SMARTCARD_HandleTypeDef; 268 269 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 270 /** 271 * @brief HAL SMARTCARD Callback ID enumeration definition 272 */ 273 typedef enum 274 { 275 HAL_SMARTCARD_TX_COMPLETE_CB_ID = 0x00U, /*!< SMARTCARD Tx Complete Callback ID */ 276 HAL_SMARTCARD_RX_COMPLETE_CB_ID = 0x01U, /*!< SMARTCARD Rx Complete Callback ID */ 277 HAL_SMARTCARD_ERROR_CB_ID = 0x02U, /*!< SMARTCARD Error Callback ID */ 278 HAL_SMARTCARD_ABORT_COMPLETE_CB_ID = 0x03U, /*!< SMARTCARD Abort Complete Callback ID */ 279 HAL_SMARTCARD_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x04U, /*!< SMARTCARD Abort Transmit Complete Callback ID */ 280 HAL_SMARTCARD_ABORT_RECEIVE_COMPLETE_CB_ID = 0x05U, /*!< SMARTCARD Abort Receive Complete Callback ID */ 281 HAL_SMARTCARD_RX_FIFO_FULL_CB_ID = 0x06U, /*!< SMARTCARD Rx Fifo Full Callback ID */ 282 HAL_SMARTCARD_TX_FIFO_EMPTY_CB_ID = 0x07U, /*!< SMARTCARD Tx Fifo Empty Callback ID */ 283 284 HAL_SMARTCARD_MSPINIT_CB_ID = 0x08U, /*!< SMARTCARD MspInit callback ID */ 285 HAL_SMARTCARD_MSPDEINIT_CB_ID = 0x09U /*!< SMARTCARD MspDeInit callback ID */ 286 287 } HAL_SMARTCARD_CallbackIDTypeDef; 288 289 /** 290 * @brief HAL SMARTCARD Callback pointer definition 291 */ 292 typedef void (*pSMARTCARD_CallbackTypeDef)(SMARTCARD_HandleTypeDef *hsmartcard); /*!< pointer to an SMARTCARD callback function */ 293 294 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 295 296 /** 297 * @brief SMARTCARD clock sources 298 */ 299 typedef enum 300 { 301 SMARTCARD_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */ 302 SMARTCARD_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */ 303 SMARTCARD_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */ 304 SMARTCARD_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */ 305 SMARTCARD_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */ 306 SMARTCARD_CLOCKSOURCE_UNDEFINED = 0x10U /*!< undefined clock source */ 307 } SMARTCARD_ClockSourceTypeDef; 308 309 /** 310 * @} 311 */ 312 313 /* Exported constants --------------------------------------------------------*/ 314 /** @defgroup SMARTCARD_Exported_Constants SMARTCARD Exported Constants 315 * @{ 316 */ 317 318 /** @defgroup SMARTCARD_State_Definition SMARTCARD State Code Definition 319 * @{ 320 */ 321 #define HAL_SMARTCARD_STATE_RESET 0x00000000U /*!< Peripheral is not initialized. Value 322 is allowed for gState and RxState */ 323 #define HAL_SMARTCARD_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for 324 use. Value is allowed for gState 325 and RxState */ 326 #define HAL_SMARTCARD_STATE_BUSY 0x00000024U /*!< an internal process is ongoing 327 Value is allowed for gState only */ 328 #define HAL_SMARTCARD_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing 329 Value is allowed for gState only */ 330 #define HAL_SMARTCARD_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing 331 Value is allowed for RxState only */ 332 #define HAL_SMARTCARD_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception 333 process is ongoing Not to be used for 334 neither gState nor RxState. 335 Value is result of combination (Or) 336 between gState and RxState values */ 337 #define HAL_SMARTCARD_STATE_TIMEOUT 0x000000A0U /*!< Timeout state 338 Value is allowed for gState only */ 339 #define HAL_SMARTCARD_STATE_ERROR 0x000000E0U /*!< Error 340 Value is allowed for gState only */ 341 /** 342 * @} 343 */ 344 345 /** @defgroup SMARTCARD_Error_Definition SMARTCARD Error Code Definition 346 * @{ 347 */ 348 #define HAL_SMARTCARD_ERROR_NONE (0x00000000U) /*!< No error */ 349 #define HAL_SMARTCARD_ERROR_PE (0x00000001U) /*!< Parity error */ 350 #define HAL_SMARTCARD_ERROR_NE (0x00000002U) /*!< Noise error */ 351 #define HAL_SMARTCARD_ERROR_FE (0x00000004U) /*!< frame error */ 352 #define HAL_SMARTCARD_ERROR_ORE (0x00000008U) /*!< Overrun error */ 353 #define HAL_SMARTCARD_ERROR_DMA (0x00000010U) /*!< DMA transfer error */ 354 #define HAL_SMARTCARD_ERROR_RTO (0x00000020U) /*!< Receiver TimeOut error */ 355 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 356 #define HAL_SMARTCARD_ERROR_INVALID_CALLBACK (0x00000040U) /*!< Invalid Callback error */ 357 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 358 /** 359 * @} 360 */ 361 362 /** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length 363 * @{ 364 */ 365 #define SMARTCARD_WORDLENGTH_9B USART_CR1_M0 /*!< SMARTCARD frame length */ 366 /** 367 * @} 368 */ 369 370 /** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits 371 * @{ 372 */ 373 #define SMARTCARD_STOPBITS_0_5 USART_CR2_STOP_0 /*!< SMARTCARD frame with 0.5 stop bit */ 374 #define SMARTCARD_STOPBITS_1_5 USART_CR2_STOP /*!< SMARTCARD frame with 1.5 stop bits */ 375 /** 376 * @} 377 */ 378 379 /** @defgroup SMARTCARD_Parity SMARTCARD Parity 380 * @{ 381 */ 382 #define SMARTCARD_PARITY_EVEN USART_CR1_PCE /*!< SMARTCARD frame even parity */ 383 #define SMARTCARD_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< SMARTCARD frame odd parity */ 384 /** 385 * @} 386 */ 387 388 /** @defgroup SMARTCARD_Mode SMARTCARD Transfer Mode 389 * @{ 390 */ 391 #define SMARTCARD_MODE_RX USART_CR1_RE /*!< SMARTCARD RX mode */ 392 #define SMARTCARD_MODE_TX USART_CR1_TE /*!< SMARTCARD TX mode */ 393 #define SMARTCARD_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< SMARTCARD RX and TX mode */ 394 /** 395 * @} 396 */ 397 398 /** @defgroup SMARTCARD_Clock_Polarity SMARTCARD Clock Polarity 399 * @{ 400 */ 401 #define SMARTCARD_POLARITY_LOW 0x00000000U /*!< SMARTCARD frame low polarity */ 402 #define SMARTCARD_POLARITY_HIGH USART_CR2_CPOL /*!< SMARTCARD frame high polarity */ 403 /** 404 * @} 405 */ 406 407 /** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase 408 * @{ 409 */ 410 #define SMARTCARD_PHASE_1EDGE 0x00000000U /*!< SMARTCARD frame phase on first clock transition */ 411 #define SMARTCARD_PHASE_2EDGE USART_CR2_CPHA /*!< SMARTCARD frame phase on second clock transition */ 412 /** 413 * @} 414 */ 415 416 /** @defgroup SMARTCARD_Last_Bit SMARTCARD Last Bit 417 * @{ 418 */ 419 #define SMARTCARD_LASTBIT_DISABLE 0x00000000U /*!< SMARTCARD frame last data bit clock pulse not output to SCLK pin */ 420 #define SMARTCARD_LASTBIT_ENABLE USART_CR2_LBCL /*!< SMARTCARD frame last data bit clock pulse output to SCLK pin */ 421 /** 422 * @} 423 */ 424 425 /** @defgroup SMARTCARD_OneBit_Sampling SMARTCARD One Bit Sampling Method 426 * @{ 427 */ 428 #define SMARTCARD_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< SMARTCARD frame one-bit sample disabled */ 429 #define SMARTCARD_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< SMARTCARD frame one-bit sample enabled */ 430 /** 431 * @} 432 */ 433 434 /** @defgroup SMARTCARD_NACK_Enable SMARTCARD NACK Enable 435 * @{ 436 */ 437 #define SMARTCARD_NACK_DISABLE 0x00000000U /*!< SMARTCARD NACK transmission disabled */ 438 #define SMARTCARD_NACK_ENABLE USART_CR3_NACK /*!< SMARTCARD NACK transmission enabled */ 439 /** 440 * @} 441 */ 442 443 /** @defgroup SMARTCARD_Timeout_Enable SMARTCARD Timeout Enable 444 * @{ 445 */ 446 #define SMARTCARD_TIMEOUT_DISABLE 0x00000000U /*!< SMARTCARD receiver timeout disabled */ 447 #define SMARTCARD_TIMEOUT_ENABLE USART_CR2_RTOEN /*!< SMARTCARD receiver timeout enabled */ 448 /** 449 * @} 450 */ 451 452 /** @defgroup SMARTCARD_ClockPrescaler SMARTCARD Clock Prescaler 453 * @{ 454 */ 455 #define SMARTCARD_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */ 456 #define SMARTCARD_PRESCALER_DIV2 0x00000001U /*!< fclk_pres = fclk/2 */ 457 #define SMARTCARD_PRESCALER_DIV4 0x00000002U /*!< fclk_pres = fclk/4 */ 458 #define SMARTCARD_PRESCALER_DIV6 0x00000003U /*!< fclk_pres = fclk/6 */ 459 #define SMARTCARD_PRESCALER_DIV8 0x00000004U /*!< fclk_pres = fclk/8 */ 460 #define SMARTCARD_PRESCALER_DIV10 0x00000005U /*!< fclk_pres = fclk/10 */ 461 #define SMARTCARD_PRESCALER_DIV12 0x00000006U /*!< fclk_pres = fclk/12 */ 462 #define SMARTCARD_PRESCALER_DIV16 0x00000007U /*!< fclk_pres = fclk/16 */ 463 #define SMARTCARD_PRESCALER_DIV32 0x00000008U /*!< fclk_pres = fclk/32 */ 464 #define SMARTCARD_PRESCALER_DIV64 0x00000009U /*!< fclk_pres = fclk/64 */ 465 #define SMARTCARD_PRESCALER_DIV128 0x0000000AU /*!< fclk_pres = fclk/128 */ 466 #define SMARTCARD_PRESCALER_DIV256 0x0000000BU /*!< fclk_pres = fclk/256 */ 467 /** 468 * @} 469 */ 470 471 /** @defgroup SMARTCARD_Tx_Inv SMARTCARD advanced feature TX pin active level inversion 472 * @{ 473 */ 474 #define SMARTCARD_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */ 475 #define SMARTCARD_ADVFEATURE_TXINV_ENABLE USART_CR2_TXINV /*!< TX pin active level inversion enable */ 476 /** 477 * @} 478 */ 479 480 /** @defgroup SMARTCARD_Rx_Inv SMARTCARD advanced feature RX pin active level inversion 481 * @{ 482 */ 483 #define SMARTCARD_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */ 484 #define SMARTCARD_ADVFEATURE_RXINV_ENABLE USART_CR2_RXINV /*!< RX pin active level inversion enable */ 485 /** 486 * @} 487 */ 488 489 /** @defgroup SMARTCARD_Data_Inv SMARTCARD advanced feature Binary Data inversion 490 * @{ 491 */ 492 #define SMARTCARD_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */ 493 #define SMARTCARD_ADVFEATURE_DATAINV_ENABLE USART_CR2_DATAINV /*!< Binary data inversion enable */ 494 /** 495 * @} 496 */ 497 498 /** @defgroup SMARTCARD_Rx_Tx_Swap SMARTCARD advanced feature RX TX pins swap 499 * @{ 500 */ 501 #define SMARTCARD_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */ 502 #define SMARTCARD_ADVFEATURE_SWAP_ENABLE USART_CR2_SWAP /*!< TX/RX pins swap enable */ 503 /** 504 * @} 505 */ 506 507 /** @defgroup SMARTCARD_Overrun_Disable SMARTCARD advanced feature Overrun Disable 508 * @{ 509 */ 510 #define SMARTCARD_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */ 511 #define SMARTCARD_ADVFEATURE_OVERRUN_DISABLE USART_CR3_OVRDIS /*!< RX overrun disable */ 512 /** 513 * @} 514 */ 515 516 /** @defgroup SMARTCARD_DMA_Disable_on_Rx_Error SMARTCARD advanced feature DMA Disable on Rx Error 517 * @{ 518 */ 519 #define SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */ 520 #define SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR USART_CR3_DDRE /*!< DMA disable on Reception Error */ 521 /** 522 * @} 523 */ 524 525 /** @defgroup SMARTCARD_MSB_First SMARTCARD advanced feature MSB first 526 * @{ 527 */ 528 #define SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received first disable */ 529 #define SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE USART_CR2_MSBFIRST /*!< Most significant bit sent/received first enable */ 530 /** 531 * @} 532 */ 533 534 /** @defgroup SMARTCARD_Request_Parameters SMARTCARD Request Parameters 535 * @{ 536 */ 537 #define SMARTCARD_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive data flush request */ 538 #define SMARTCARD_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush request */ 539 /** 540 * @} 541 */ 542 543 /** @defgroup SMARTCARD_Interruption_Mask SMARTCARD interruptions flags mask 544 * @{ 545 */ 546 #define SMARTCARD_IT_MASK 0x001FU /*!< SMARTCARD interruptions flags mask */ 547 #define SMARTCARD_CR_MASK 0x00E0U /*!< SMARTCARD control register mask */ 548 #define SMARTCARD_CR_POS 5U /*!< SMARTCARD control register position */ 549 #define SMARTCARD_ISR_MASK 0x1F00U /*!< SMARTCARD ISR register mask */ 550 #define SMARTCARD_ISR_POS 8U /*!< SMARTCARD ISR register position */ 551 /** 552 * @} 553 */ 554 555 /** 556 * @} 557 */ 558 559 /* Exported macros -----------------------------------------------------------*/ 560 /** @defgroup SMARTCARD_Exported_Macros SMARTCARD Exported Macros 561 * @{ 562 */ 563 564 /** @brief Reset SMARTCARD handle states. 565 * @param __HANDLE__ SMARTCARD handle. 566 * @retval None 567 */ 568 #if USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1 569 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) do{ \ 570 (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET; \ 571 (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET; \ 572 (__HANDLE__)->MspInitCallback = NULL; \ 573 (__HANDLE__)->MspDeInitCallback = NULL; \ 574 } while(0U) 575 #else 576 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) do{ \ 577 (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET; \ 578 (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET; \ 579 } while(0U) 580 #endif /*USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 581 582 /** @brief Flush the Smartcard Data registers. 583 * @param __HANDLE__ specifies the SMARTCARD Handle. 584 * @retval None 585 */ 586 #define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__) \ 587 do{ \ 588 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_RXDATA_FLUSH_REQUEST); \ 589 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_TXDATA_FLUSH_REQUEST); \ 590 } while(0U) 591 592 /** @brief Clear the specified SMARTCARD pending flag. 593 * @param __HANDLE__ specifies the SMARTCARD Handle. 594 * @param __FLAG__ specifies the flag to check. 595 * This parameter can be any combination of the following values: 596 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag 597 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag 598 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag 599 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag 600 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detected clear flag 601 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag 602 * @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag 603 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag 604 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag 605 * @arg @ref SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear flag 606 * @retval None 607 */ 608 #define __HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) 609 610 /** @brief Clear the SMARTCARD PE pending flag. 611 * @param __HANDLE__ specifies the SMARTCARD Handle. 612 * @retval None 613 */ 614 #define __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_PEF) 615 616 /** @brief Clear the SMARTCARD FE pending flag. 617 * @param __HANDLE__ specifies the SMARTCARD Handle. 618 * @retval None 619 */ 620 #define __HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_FEF) 621 622 /** @brief Clear the SMARTCARD NE pending flag. 623 * @param __HANDLE__ specifies the SMARTCARD Handle. 624 * @retval None 625 */ 626 #define __HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_NEF) 627 628 /** @brief Clear the SMARTCARD ORE pending flag. 629 * @param __HANDLE__ specifies the SMARTCARD Handle. 630 * @retval None 631 */ 632 #define __HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_OREF) 633 634 /** @brief Clear the SMARTCARD IDLE pending flag. 635 * @param __HANDLE__ specifies the SMARTCARD Handle. 636 * @retval None 637 */ 638 #define __HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_IDLEF) 639 640 /** @brief Check whether the specified Smartcard flag is set or not. 641 * @param __HANDLE__ specifies the SMARTCARD Handle. 642 * @param __FLAG__ specifies the flag to check. 643 * This parameter can be one of the following values: 644 * @arg @ref SMARTCARD_FLAG_TCBGT Transmission complete before guard time flag (when flag available) 645 * @arg @ref SMARTCARD_FLAG_REACK Receive enable acknowledge flag 646 * @arg @ref SMARTCARD_FLAG_TEACK Transmit enable acknowledge flag 647 * @arg @ref SMARTCARD_FLAG_BUSY Busy flag 648 * @arg @ref SMARTCARD_FLAG_EOBF End of block flag 649 * @arg @ref SMARTCARD_FLAG_RTOF Receiver timeout flag 650 * @arg @ref SMARTCARD_FLAG_TXE Transmit data register empty flag 651 * @arg @ref SMARTCARD_FLAG_TC Transmission complete flag 652 * @arg @ref SMARTCARD_FLAG_RXNE Receive data register not empty flag 653 * @arg @ref SMARTCARD_FLAG_IDLE Idle line detection flag 654 * @arg @ref SMARTCARD_FLAG_ORE Overrun error flag 655 * @arg @ref SMARTCARD_FLAG_NE Noise error flag 656 * @arg @ref SMARTCARD_FLAG_FE Framing error flag 657 * @arg @ref SMARTCARD_FLAG_PE Parity error flag 658 * @arg @ref SMARTCARD_FLAG_TXFNF TXFIFO not full flag 659 * @arg @ref SMARTCARD_FLAG_RXFNE RXFIFO not empty flag 660 * @arg @ref SMARTCARD_FLAG_TXFE TXFIFO Empty flag 661 * @arg @ref SMARTCARD_FLAG_RXFF RXFIFO Full flag 662 * @arg @ref SMARTCARD_FLAG_RXFT SMARTCARD RXFIFO threshold flag 663 * @arg @ref SMARTCARD_FLAG_TXFT SMARTCARD TXFIFO threshold flag 664 * @retval The new state of __FLAG__ (TRUE or FALSE). 665 */ 666 #define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__)) 667 668 /** @brief Enable the specified SmartCard interrupt. 669 * @param __HANDLE__ specifies the SMARTCARD Handle. 670 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to enable. 671 * This parameter can be one of the following values: 672 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 673 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 674 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 675 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 676 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before 677 * guard time interrupt (when interruption available) 678 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 679 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 680 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 681 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 682 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 683 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 684 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 685 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 686 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 687 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 688 * @retval None 689 */ 690 #define __HAL_SMARTCARD_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 691 SMARTCARD_CR_POS) == 1U)?\ 692 ((__HANDLE__)->Instance->CR1 |= (1UL <<\ 693 ((__INTERRUPT__) & SMARTCARD_IT_MASK))):\ 694 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 695 SMARTCARD_CR_POS) == 2U)?\ 696 ((__HANDLE__)->Instance->CR2 |= (1UL <<\ 697 ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 698 ((__HANDLE__)->Instance->CR3 |= (1UL <<\ 699 ((__INTERRUPT__) & SMARTCARD_IT_MASK)))) 700 701 /** @brief Disable the specified SmartCard interrupt. 702 * @param __HANDLE__ specifies the SMARTCARD Handle. 703 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to disable. 704 * This parameter can be one of the following values: 705 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 706 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 707 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 708 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 709 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard 710 * time interrupt (when interruption available) 711 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 712 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 713 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 714 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 715 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 716 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 717 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 718 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 719 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 720 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 721 * @retval None 722 */ 723 #define __HAL_SMARTCARD_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 724 SMARTCARD_CR_POS) == 1U)?\ 725 ((__HANDLE__)->Instance->CR1 &= ~ (1U <<\ 726 ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 727 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 728 SMARTCARD_CR_POS) == 2U)?\ 729 ((__HANDLE__)->Instance->CR2 &= ~ (1U <<\ 730 ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 731 ((__HANDLE__)->Instance->CR3 &= ~ (1U <<\ 732 ((__INTERRUPT__) & SMARTCARD_IT_MASK)))) 733 734 /** @brief Check whether the specified SmartCard interrupt has occurred or not. 735 * @param __HANDLE__ specifies the SMARTCARD Handle. 736 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to check. 737 * This parameter can be one of the following values: 738 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 739 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 740 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 741 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 742 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time 743 * interrupt (when interruption available) 744 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 745 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 746 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 747 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 748 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 749 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 750 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 751 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 752 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 753 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 754 * @retval The new state of __INTERRUPT__ (SET or RESET). 755 */ 756 #define __HAL_SMARTCARD_GET_IT(__HANDLE__, __INTERRUPT__) (\ 757 (((__HANDLE__)->Instance->ISR & (0x01UL << (((__INTERRUPT__)\ 758 & SMARTCARD_ISR_MASK)>> SMARTCARD_ISR_POS)))!= 0U)\ 759 ? SET : RESET) 760 761 /** @brief Check whether the specified SmartCard interrupt source is enabled or not. 762 * @param __HANDLE__ specifies the SMARTCARD Handle. 763 * @param __INTERRUPT__ specifies the SMARTCARD interrupt source to check. 764 * This parameter can be one of the following values: 765 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 766 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 767 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 768 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 769 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time 770 * interrupt (when interruption available) 771 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 772 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 773 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 774 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 775 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 776 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 777 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 778 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 779 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 780 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 781 * @retval The new state of __INTERRUPT__ (SET or RESET). 782 */ 783 #define __HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 784 SMARTCARD_CR_POS) == 0x01U)?\ 785 (__HANDLE__)->Instance->CR1 : \ 786 (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 787 SMARTCARD_CR_POS) == 0x02U)?\ 788 (__HANDLE__)->Instance->CR2 : \ 789 (__HANDLE__)->Instance->CR3)) &\ 790 (0x01UL << (((uint16_t)(__INTERRUPT__))\ 791 & SMARTCARD_IT_MASK))) != 0U)\ 792 ? SET : RESET) 793 794 /** @brief Clear the specified SMARTCARD ISR flag, in setting the proper ICR register flag. 795 * @param __HANDLE__ specifies the SMARTCARD Handle. 796 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set 797 * to clear the corresponding interrupt. 798 * This parameter can be one of the following values: 799 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag 800 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag 801 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag 802 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag 803 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detection clear flag 804 * @arg @ref SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear Flag 805 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag 806 * @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag (when flag available) 807 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag 808 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag 809 * @retval None 810 */ 811 #define __HAL_SMARTCARD_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR |= (uint32_t)(__IT_CLEAR__)) 812 813 /** @brief Set a specific SMARTCARD request flag. 814 * @param __HANDLE__ specifies the SMARTCARD Handle. 815 * @param __REQ__ specifies the request flag to set 816 * This parameter can be one of the following values: 817 * @arg @ref SMARTCARD_RXDATA_FLUSH_REQUEST Receive data flush Request 818 * @arg @ref SMARTCARD_TXDATA_FLUSH_REQUEST Transmit data flush Request 819 * @retval None 820 */ 821 #define __HAL_SMARTCARD_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__)) 822 823 /** @brief Enable the SMARTCARD one bit sample method. 824 * @param __HANDLE__ specifies the SMARTCARD Handle. 825 * @retval None 826 */ 827 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT) 828 829 /** @brief Disable the SMARTCARD one bit sample method. 830 * @param __HANDLE__ specifies the SMARTCARD Handle. 831 * @retval None 832 */ 833 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\ 834 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT)) 835 836 /** @brief Enable the USART associated to the SMARTCARD Handle. 837 * @param __HANDLE__ specifies the SMARTCARD Handle. 838 * @retval None 839 */ 840 #define __HAL_SMARTCARD_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE) 841 842 /** @brief Disable the USART associated to the SMARTCARD Handle 843 * @param __HANDLE__ specifies the SMARTCARD Handle. 844 * @retval None 845 */ 846 #define __HAL_SMARTCARD_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE) 847 848 /** 849 * @} 850 */ 851 852 /* Private macros -------------------------------------------------------------*/ 853 /** @defgroup SMARTCARD_Private_Macros SMARTCARD Private Macros 854 * @{ 855 */ 856 857 /** @brief Report the SMARTCARD clock source. 858 * @param __HANDLE__ specifies the SMARTCARD Handle. 859 * @param __CLOCKSOURCE__ output variable. 860 * @retval the SMARTCARD clocking source, written in __CLOCKSOURCE__. 861 */ 862 #define SMARTCARD_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \ 863 do { \ 864 if((__HANDLE__)->Instance == USART1) \ 865 { \ 866 switch(__HAL_RCC_GET_USART1_SOURCE()) \ 867 { \ 868 case RCC_USART1CLKSOURCE_PCLK2: \ 869 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK2; \ 870 break; \ 871 case RCC_USART1CLKSOURCE_HSI: \ 872 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 873 break; \ 874 case RCC_USART1CLKSOURCE_SYSCLK: \ 875 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \ 876 break; \ 877 case RCC_USART1CLKSOURCE_LSE: \ 878 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 879 break; \ 880 default: \ 881 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 882 break; \ 883 } \ 884 } \ 885 else if((__HANDLE__)->Instance == USART2) \ 886 { \ 887 switch(__HAL_RCC_GET_USART2_SOURCE()) \ 888 { \ 889 case RCC_USART2CLKSOURCE_PCLK1: \ 890 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 891 break; \ 892 case RCC_USART2CLKSOURCE_HSI: \ 893 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 894 break; \ 895 case RCC_USART2CLKSOURCE_SYSCLK: \ 896 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \ 897 break; \ 898 case RCC_USART2CLKSOURCE_LSE: \ 899 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 900 break; \ 901 default: \ 902 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 903 break; \ 904 } \ 905 } \ 906 else if((__HANDLE__)->Instance == USART3) \ 907 { \ 908 switch(__HAL_RCC_GET_USART3_SOURCE()) \ 909 { \ 910 case RCC_USART3CLKSOURCE_PCLK1: \ 911 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \ 912 break; \ 913 case RCC_USART3CLKSOURCE_HSI: \ 914 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \ 915 break; \ 916 case RCC_USART3CLKSOURCE_SYSCLK: \ 917 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \ 918 break; \ 919 case RCC_USART3CLKSOURCE_LSE: \ 920 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \ 921 break; \ 922 default: \ 923 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 924 break; \ 925 } \ 926 } \ 927 else \ 928 { \ 929 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \ 930 } \ 931 } while(0U) 932 933 /** @brief Check the Baud rate range. 934 * @note The maximum Baud Rate is derived from the maximum clock on L5 (120 MHz) 935 * divided by the oversampling used on the SMARTCARD (i.e. 16). 936 * @param __BAUDRATE__ Baud rate set by the configuration function. 937 * @retval Test result (TRUE or FALSE) 938 */ 939 #define IS_SMARTCARD_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 7500001U) 940 941 /** @brief Check the block length range. 942 * @note The maximum SMARTCARD block length is 0xFF. 943 * @param __LENGTH__ block length. 944 * @retval Test result (TRUE or FALSE) 945 */ 946 #define IS_SMARTCARD_BLOCKLENGTH(__LENGTH__) ((__LENGTH__) <= 0xFFU) 947 948 /** @brief Check the receiver timeout value. 949 * @note The maximum SMARTCARD receiver timeout value is 0xFFFFFF. 950 * @param __TIMEOUTVALUE__ receiver timeout value. 951 * @retval Test result (TRUE or FALSE) 952 */ 953 #define IS_SMARTCARD_TIMEOUT_VALUE(__TIMEOUTVALUE__) ((__TIMEOUTVALUE__) <= 0xFFFFFFU) 954 955 /** @brief Check the SMARTCARD autoretry counter value. 956 * @note The maximum number of retransmissions is 0x7. 957 * @param __COUNT__ number of retransmissions. 958 * @retval Test result (TRUE or FALSE) 959 */ 960 #define IS_SMARTCARD_AUTORETRY_COUNT(__COUNT__) ((__COUNT__) <= 0x7U) 961 962 /** @brief Ensure that SMARTCARD frame length is valid. 963 * @param __LENGTH__ SMARTCARD frame length. 964 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid) 965 */ 966 #define IS_SMARTCARD_WORD_LENGTH(__LENGTH__) ((__LENGTH__) == SMARTCARD_WORDLENGTH_9B) 967 968 /** @brief Ensure that SMARTCARD frame number of stop bits is valid. 969 * @param __STOPBITS__ SMARTCARD frame number of stop bits. 970 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid) 971 */ 972 #define IS_SMARTCARD_STOPBITS(__STOPBITS__) (((__STOPBITS__) == SMARTCARD_STOPBITS_0_5) ||\ 973 ((__STOPBITS__) == SMARTCARD_STOPBITS_1_5)) 974 975 /** @brief Ensure that SMARTCARD frame parity is valid. 976 * @param __PARITY__ SMARTCARD frame parity. 977 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid) 978 */ 979 #define IS_SMARTCARD_PARITY(__PARITY__) (((__PARITY__) == SMARTCARD_PARITY_EVEN) || \ 980 ((__PARITY__) == SMARTCARD_PARITY_ODD)) 981 982 /** @brief Ensure that SMARTCARD communication mode is valid. 983 * @param __MODE__ SMARTCARD communication mode. 984 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 985 */ 986 #define IS_SMARTCARD_MODE(__MODE__) ((((__MODE__) & 0xFFF3U) == 0x00U) && ((__MODE__) != 0x00U)) 987 988 /** @brief Ensure that SMARTCARD frame polarity is valid. 989 * @param __CPOL__ SMARTCARD frame polarity. 990 * @retval SET (__CPOL__ is valid) or RESET (__CPOL__ is invalid) 991 */ 992 #define IS_SMARTCARD_POLARITY(__CPOL__) (((__CPOL__) == SMARTCARD_POLARITY_LOW)\ 993 || ((__CPOL__) == SMARTCARD_POLARITY_HIGH)) 994 995 /** @brief Ensure that SMARTCARD frame phase is valid. 996 * @param __CPHA__ SMARTCARD frame phase. 997 * @retval SET (__CPHA__ is valid) or RESET (__CPHA__ is invalid) 998 */ 999 #define IS_SMARTCARD_PHASE(__CPHA__) (((__CPHA__) == SMARTCARD_PHASE_1EDGE) || ((__CPHA__) == SMARTCARD_PHASE_2EDGE)) 1000 1001 /** @brief Ensure that SMARTCARD frame last bit clock pulse setting is valid. 1002 * @param __LASTBIT__ SMARTCARD frame last bit clock pulse setting. 1003 * @retval SET (__LASTBIT__ is valid) or RESET (__LASTBIT__ is invalid) 1004 */ 1005 #define IS_SMARTCARD_LASTBIT(__LASTBIT__) (((__LASTBIT__) == SMARTCARD_LASTBIT_DISABLE) || \ 1006 ((__LASTBIT__) == SMARTCARD_LASTBIT_ENABLE)) 1007 1008 /** @brief Ensure that SMARTCARD frame sampling is valid. 1009 * @param __ONEBIT__ SMARTCARD frame sampling. 1010 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid) 1011 */ 1012 #define IS_SMARTCARD_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_DISABLE) || \ 1013 ((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_ENABLE)) 1014 1015 /** @brief Ensure that SMARTCARD NACK transmission setting is valid. 1016 * @param __NACK__ SMARTCARD NACK transmission setting. 1017 * @retval SET (__NACK__ is valid) or RESET (__NACK__ is invalid) 1018 */ 1019 #define IS_SMARTCARD_NACK(__NACK__) (((__NACK__) == SMARTCARD_NACK_ENABLE) || \ 1020 ((__NACK__) == SMARTCARD_NACK_DISABLE)) 1021 1022 /** @brief Ensure that SMARTCARD receiver timeout setting is valid. 1023 * @param __TIMEOUT__ SMARTCARD receiver timeout setting. 1024 * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid) 1025 */ 1026 #define IS_SMARTCARD_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == SMARTCARD_TIMEOUT_DISABLE) || \ 1027 ((__TIMEOUT__) == SMARTCARD_TIMEOUT_ENABLE)) 1028 1029 /** @brief Ensure that SMARTCARD clock Prescaler is valid. 1030 * @param __CLOCKPRESCALER__ SMARTCARD clock Prescaler value. 1031 * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid) 1032 */ 1033 #define IS_SMARTCARD_CLOCKPRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV1) || \ 1034 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV2) || \ 1035 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV4) || \ 1036 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV6) || \ 1037 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV8) || \ 1038 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV10) || \ 1039 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV12) || \ 1040 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV16) || \ 1041 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV32) || \ 1042 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV64) || \ 1043 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV128) || \ 1044 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV256)) 1045 1046 /** @brief Ensure that SMARTCARD advanced features initialization is valid. 1047 * @param __INIT__ SMARTCARD advanced features initialization. 1048 * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid) 1049 */ 1050 #define IS_SMARTCARD_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (SMARTCARD_ADVFEATURE_NO_INIT | \ 1051 SMARTCARD_ADVFEATURE_TXINVERT_INIT | \ 1052 SMARTCARD_ADVFEATURE_RXINVERT_INIT | \ 1053 SMARTCARD_ADVFEATURE_DATAINVERT_INIT | \ 1054 SMARTCARD_ADVFEATURE_SWAP_INIT | \ 1055 SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT | \ 1056 SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT | \ 1057 SMARTCARD_ADVFEATURE_MSBFIRST_INIT)) 1058 1059 /** @brief Ensure that SMARTCARD frame TX inversion setting is valid. 1060 * @param __TXINV__ SMARTCARD frame TX inversion setting. 1061 * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid) 1062 */ 1063 #define IS_SMARTCARD_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_DISABLE) || \ 1064 ((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_ENABLE)) 1065 1066 /** @brief Ensure that SMARTCARD frame RX inversion setting is valid. 1067 * @param __RXINV__ SMARTCARD frame RX inversion setting. 1068 * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid) 1069 */ 1070 #define IS_SMARTCARD_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_DISABLE) || \ 1071 ((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_ENABLE)) 1072 1073 /** @brief Ensure that SMARTCARD frame data inversion setting is valid. 1074 * @param __DATAINV__ SMARTCARD frame data inversion setting. 1075 * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid) 1076 */ 1077 #define IS_SMARTCARD_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_DISABLE) || \ 1078 ((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_ENABLE)) 1079 1080 /** @brief Ensure that SMARTCARD frame RX/TX pins swap setting is valid. 1081 * @param __SWAP__ SMARTCARD frame RX/TX pins swap setting. 1082 * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid) 1083 */ 1084 #define IS_SMARTCARD_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_DISABLE) || \ 1085 ((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_ENABLE)) 1086 1087 /** @brief Ensure that SMARTCARD frame overrun setting is valid. 1088 * @param __OVERRUN__ SMARTCARD frame overrun setting. 1089 * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid) 1090 */ 1091 #define IS_SMARTCARD_OVERRUN(__OVERRUN__) (((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_ENABLE) || \ 1092 ((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_DISABLE)) 1093 1094 /** @brief Ensure that SMARTCARD DMA enabling or disabling on error setting is valid. 1095 * @param __DMA__ SMARTCARD DMA enabling or disabling on error setting. 1096 * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid) 1097 */ 1098 #define IS_SMARTCARD_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR) || \ 1099 ((__DMA__) == SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR)) 1100 1101 /** @brief Ensure that SMARTCARD frame MSB first setting is valid. 1102 * @param __MSBFIRST__ SMARTCARD frame MSB first setting. 1103 * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid) 1104 */ 1105 #define IS_SMARTCARD_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE) || \ 1106 ((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE)) 1107 1108 /** @brief Ensure that SMARTCARD request parameter is valid. 1109 * @param __PARAM__ SMARTCARD request parameter. 1110 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid) 1111 */ 1112 #define IS_SMARTCARD_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == SMARTCARD_RXDATA_FLUSH_REQUEST) || \ 1113 ((__PARAM__) == SMARTCARD_TXDATA_FLUSH_REQUEST)) 1114 1115 /** 1116 * @} 1117 */ 1118 1119 /* Include SMARTCARD HAL Extended module */ 1120 #include "stm32l5xx_hal_smartcard_ex.h" 1121 1122 /* Exported functions --------------------------------------------------------*/ 1123 /** @addtogroup SMARTCARD_Exported_Functions 1124 * @{ 1125 */ 1126 1127 /* Initialization and de-initialization functions ****************************/ 1128 /** @addtogroup SMARTCARD_Exported_Functions_Group1 1129 * @{ 1130 */ 1131 1132 HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsmartcard); 1133 HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsmartcard); 1134 void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsmartcard); 1135 void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsmartcard); 1136 1137 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 1138 /* Callbacks Register/UnRegister functions ***********************************/ 1139 HAL_StatusTypeDef HAL_SMARTCARD_RegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard, 1140 HAL_SMARTCARD_CallbackIDTypeDef CallbackID, 1141 pSMARTCARD_CallbackTypeDef pCallback); 1142 HAL_StatusTypeDef HAL_SMARTCARD_UnRegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard, 1143 HAL_SMARTCARD_CallbackIDTypeDef CallbackID); 1144 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 1145 1146 /** 1147 * @} 1148 */ 1149 1150 /* IO operation functions *****************************************************/ 1151 /** @addtogroup SMARTCARD_Exported_Functions_Group2 1152 * @{ 1153 */ 1154 1155 HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size, 1156 uint32_t Timeout); 1157 HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size, 1158 uint32_t Timeout); 1159 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size); 1160 HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size); 1161 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size); 1162 HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size); 1163 /* Transfer Abort functions */ 1164 HAL_StatusTypeDef HAL_SMARTCARD_Abort(SMARTCARD_HandleTypeDef *hsmartcard); 1165 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit(SMARTCARD_HandleTypeDef *hsmartcard); 1166 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive(SMARTCARD_HandleTypeDef *hsmartcard); 1167 HAL_StatusTypeDef HAL_SMARTCARD_Abort_IT(SMARTCARD_HandleTypeDef *hsmartcard); 1168 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit_IT(SMARTCARD_HandleTypeDef *hsmartcard); 1169 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive_IT(SMARTCARD_HandleTypeDef *hsmartcard); 1170 1171 void HAL_SMARTCARD_IRQHandler(SMARTCARD_HandleTypeDef *hsmartcard); 1172 void HAL_SMARTCARD_TxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1173 void HAL_SMARTCARD_RxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1174 void HAL_SMARTCARD_ErrorCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1175 void HAL_SMARTCARD_AbortCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1176 void HAL_SMARTCARD_AbortTransmitCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1177 void HAL_SMARTCARD_AbortReceiveCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1178 1179 /** 1180 * @} 1181 */ 1182 1183 /* Peripheral State and Error functions ***************************************/ 1184 /** @addtogroup SMARTCARD_Exported_Functions_Group4 1185 * @{ 1186 */ 1187 1188 HAL_SMARTCARD_StateTypeDef HAL_SMARTCARD_GetState(const SMARTCARD_HandleTypeDef *hsmartcard); 1189 uint32_t HAL_SMARTCARD_GetError(const SMARTCARD_HandleTypeDef *hsmartcard); 1190 1191 /** 1192 * @} 1193 */ 1194 1195 /** 1196 * @} 1197 */ 1198 1199 /** 1200 * @} 1201 */ 1202 1203 /** 1204 * @} 1205 */ 1206 1207 #ifdef __cplusplus 1208 } 1209 #endif 1210 1211 #endif /* STM32L5xx_HAL_SMARTCARD_H */ 1212 1213
