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