1 /** 2 ****************************************************************************** 3 * @file stm32wb0x_hal_smartcard.h 4 * @author MCD Application Team 5 * @brief Header file of SMARTCARD HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2024 STMicroelectronics. 10 * All rights reserved. 11 * 12 * This software is licensed under terms that can be found in the LICENSE file 13 * in the root directory of this software component. 14 * If no LICENSE file comes with this software, it is provided AS-IS. 15 * 16 ****************************************************************************** 17 */ 18 19 /* Define to prevent recursive inclusion -------------------------------------*/ 20 #ifndef STM32WB0x_HAL_SMARTCARD_H 21 #define STM32WB0x_HAL_SMARTCARD_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32wb0x_hal_def.h" 29 30 /** @addtogroup STM32WB0x_HAL_Driver 31 * @{ 32 */ 33 34 /** @addtogroup SMARTCARD 35 * @{ 36 */ 37 38 /* Exported types ------------------------------------------------------------*/ 39 /** @defgroup SMARTCARD_Exported_Types SMARTCARD Exported Types 40 * @{ 41 */ 42 43 /** 44 * @brief SMARTCARD Init Structure definition 45 */ 46 typedef struct 47 { 48 uint32_t BaudRate; /*!< Configures the SmartCard communication baud rate. 49 The baud rate register is computed using the following formula: 50 Baud Rate Register = ((usart_ker_ckpres) / ((hsmartcard->Init.BaudRate))) 51 where usart_ker_ckpres is the USART input clock divided by a prescaler */ 52 53 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame. 54 This parameter @ref SMARTCARD_Word_Length can only be 55 set to 9 (8 data + 1 parity bits). */ 56 57 uint32_t StopBits; /*!< Specifies the number of stop bits. 58 This parameter can be a value of @ref SMARTCARD_Stop_Bits. */ 59 60 uint16_t Parity; /*!< Specifies the parity mode. 61 This parameter can be a value of @ref SMARTCARD_Parity 62 @note The parity is enabled by default (PCE is forced to 1). 63 Since the WordLength is forced to 8 bits + parity, M is 64 forced to 1 and the parity bit is the 9th bit. */ 65 66 uint16_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled. 67 This parameter can be a value of @ref SMARTCARD_Mode */ 68 69 uint16_t CLKPolarity; /*!< Specifies the steady state of the serial clock. 70 This parameter can be a value of @ref SMARTCARD_Clock_Polarity */ 71 72 uint16_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made. 73 This parameter can be a value of @ref SMARTCARD_Clock_Phase */ 74 75 uint16_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted 76 data bit (MSB) has to be output on the SCLK pin in synchronous mode. 77 This parameter can be a value of @ref SMARTCARD_Last_Bit */ 78 79 uint16_t OneBitSampling; /*!< Specifies whether a single sample or three samples' majority vote 80 is selected. Selecting the single sample method increases 81 the receiver tolerance to clock deviations. This parameter can be a value 82 of @ref SMARTCARD_OneBit_Sampling. */ 83 84 uint8_t Prescaler; /*!< Specifies the SmartCard Prescaler. 85 This parameter can be any value from 0x01 to 0x1F. Prescaler value is 86 multiplied by 2 to give the division factor of the source clock frequency */ 87 88 uint8_t GuardTime; /*!< Specifies the SmartCard Guard Time applied after stop bits. */ 89 90 uint16_t NACKEnable; /*!< Specifies whether the SmartCard NACK transmission is enabled 91 in case of parity error. 92 This parameter can be a value of @ref SMARTCARD_NACK_Enable */ 93 94 uint32_t TimeOutEnable; /*!< Specifies whether the receiver timeout is enabled. 95 This parameter can be a value of @ref SMARTCARD_Timeout_Enable*/ 96 97 uint32_t TimeOutValue; /*!< Specifies the receiver time out value in number of baud blocks: 98 it is used to implement the Character Wait Time (CWT) and 99 Block Wait Time (BWT). It is coded over 24 bits. */ 100 101 uint8_t BlockLength; /*!< Specifies the SmartCard Block Length in T=1 Reception mode. 102 This parameter can be any value from 0x0 to 0xFF */ 103 104 uint8_t AutoRetryCount; /*!< Specifies the SmartCard auto-retry count (number of retries in 105 receive and transmit mode). When set to 0, retransmission is 106 disabled. Otherwise, its maximum value is 7 (before signalling 107 an error) */ 108 109 uint32_t ClockPrescaler; /*!< Specifies the prescaler value used to divide the USART clock source. 110 This parameter can be a value of @ref SMARTCARD_ClockPrescaler. */ 111 112 } SMARTCARD_InitTypeDef; 113 114 /** 115 * @brief SMARTCARD advanced features initialization structure definition 116 */ 117 typedef struct 118 { 119 uint32_t AdvFeatureInit; /*!< Specifies which advanced SMARTCARD features is initialized. Several 120 advanced features may be initialized at the same time. This parameter 121 can be a value of @ref SMARTCARDEx_Advanced_Features_Initialization_Type */ 122 123 uint32_t TxPinLevelInvert; /*!< Specifies whether the TX pin active level is inverted. 124 This parameter can be a value of @ref SMARTCARD_Tx_Inv */ 125 126 uint32_t RxPinLevelInvert; /*!< Specifies whether the RX pin active level is inverted. 127 This parameter can be a value of @ref SMARTCARD_Rx_Inv */ 128 129 uint32_t DataInvert; /*!< Specifies whether data are inverted (positive/direct logic 130 vs negative/inverted logic). 131 This parameter can be a value of @ref SMARTCARD_Data_Inv */ 132 133 uint32_t Swap; /*!< Specifies whether TX and RX pins are swapped. 134 This parameter can be a value of @ref SMARTCARD_Rx_Tx_Swap */ 135 136 uint32_t OverrunDisable; /*!< Specifies whether the reception overrun detection is disabled. 137 This parameter can be a value of @ref SMARTCARD_Overrun_Disable */ 138 139 uint32_t DMADisableonRxError; /*!< Specifies whether the DMA is disabled in case of reception error. 140 This parameter can be a value of @ref SMARTCARD_DMA_Disable_on_Rx_Error */ 141 142 uint32_t MSBFirst; /*!< Specifies whether MSB is sent first on UART line. 143 This parameter can be a value of @ref SMARTCARD_MSB_First */ 144 145 uint16_t TxCompletionIndication; /*!< Specifies which transmission completion indication is used: before (when 146 relevant flag is available) or once guard time period has elapsed. 147 This parameter can be a value 148 of @ref SMARTCARDEx_Transmission_Completion_Indication. */ 149 } SMARTCARD_AdvFeatureInitTypeDef; 150 151 /** 152 * @brief HAL SMARTCARD State definition 153 * @note HAL SMARTCARD State value is a combination of 2 different substates: 154 * gState and RxState (see @ref SMARTCARD_State_Definition). 155 * - gState contains SMARTCARD state information related to global Handle management 156 * and also information related to Tx operations. 157 * gState value coding follow below described bitmap : 158 * b7-b6 Error information 159 * 00 : No Error 160 * 01 : (Not Used) 161 * 10 : Timeout 162 * 11 : Error 163 * b5 Peripheral initialization status 164 * 0 : Reset (Peripheral not initialized) 165 * 1 : Init done (Peripheral initialized. HAL SMARTCARD Init function already called) 166 * b4-b3 (not used) 167 * xx : Should be set to 00 168 * b2 Intrinsic process state 169 * 0 : Ready 170 * 1 : Busy (Peripheral busy with some configuration or internal operations) 171 * b1 (not used) 172 * x : Should be set to 0 173 * b0 Tx state 174 * 0 : Ready (no Tx operation ongoing) 175 * 1 : Busy (Tx operation ongoing) 176 * - RxState contains information related to Rx operations. 177 * RxState value coding follow below described bitmap : 178 * b7-b6 (not used) 179 * xx : Should be set to 00 180 * b5 Peripheral initialization status 181 * 0 : Reset (Peripheral not initialized) 182 * 1 : Init done (Peripheral initialized) 183 * b4-b2 (not used) 184 * xxx : Should be set to 000 185 * b1 Rx state 186 * 0 : Ready (no Rx operation ongoing) 187 * 1 : Busy (Rx operation ongoing) 188 * b0 (not used) 189 * x : Should be set to 0. 190 */ 191 typedef uint32_t HAL_SMARTCARD_StateTypeDef; 192 193 /** 194 * @brief SMARTCARD handle Structure definition 195 */ 196 typedef struct __SMARTCARD_HandleTypeDef 197 { 198 USART_TypeDef *Instance; /*!< USART registers base address */ 199 200 SMARTCARD_InitTypeDef Init; /*!< SmartCard communication parameters */ 201 202 SMARTCARD_AdvFeatureInitTypeDef AdvancedInit; /*!< SmartCard advanced features initialization parameters */ 203 204 const uint8_t *pTxBuffPtr; /*!< Pointer to SmartCard Tx transfer Buffer */ 205 206 uint16_t TxXferSize; /*!< SmartCard Tx Transfer size */ 207 208 __IO uint16_t TxXferCount; /*!< SmartCard Tx Transfer Counter */ 209 210 uint8_t *pRxBuffPtr; /*!< Pointer to SmartCard Rx transfer Buffer */ 211 212 uint16_t RxXferSize; /*!< SmartCard Rx Transfer size */ 213 214 __IO uint16_t RxXferCount; /*!< SmartCard Rx Transfer Counter */ 215 216 uint16_t NbRxDataToProcess; /*!< Number of data to process during RX ISR execution */ 217 218 uint16_t NbTxDataToProcess; /*!< Number of data to process during TX ISR execution */ 219 220 uint32_t FifoMode; /*!< Specifies if the FIFO mode will be used. 221 This parameter can be a value of 222 @ref SMARTCARDEx_FIFO_mode. */ 223 224 void (*RxISR)(struct __SMARTCARD_HandleTypeDef *huart); /*!< Function pointer on Rx IRQ handler */ 225 226 void (*TxISR)(struct __SMARTCARD_HandleTypeDef *huart); /*!< Function pointer on Tx IRQ handler */ 227 228 #if defined(HAL_DMA_MODULE_ENABLED) 229 DMA_HandleTypeDef *hdmatx; /*!< SmartCard Tx DMA Handle parameters */ 230 231 DMA_HandleTypeDef *hdmarx; /*!< SmartCard Rx DMA Handle parameters */ 232 233 #endif /* HAL_DMA_MODULE_ENABLED */ 234 HAL_LockTypeDef Lock; /*!< Locking object */ 235 236 __IO HAL_SMARTCARD_StateTypeDef gState; /*!< SmartCard state information related to global 237 Handle management and also related to Tx operations. 238 This parameter can be a value 239 of @ref HAL_SMARTCARD_StateTypeDef */ 240 241 __IO HAL_SMARTCARD_StateTypeDef RxState; /*!< SmartCard state information related to Rx operations. 242 This parameter can be a value 243 of @ref HAL_SMARTCARD_StateTypeDef */ 244 245 __IO uint32_t ErrorCode; /*!< SmartCard Error code */ 246 247 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 248 void (* TxCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Tx Complete Callback */ 249 250 void (* RxCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Rx Complete Callback */ 251 252 void (* ErrorCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Error Callback */ 253 254 void (* AbortCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Complete Callback */ 255 256 void (* AbortTransmitCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Transmit Complete Callback */ 257 258 void (* AbortReceiveCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Receive Complete Callback */ 259 260 void (* RxFifoFullCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Rx Fifo Full Callback */ 261 262 void (* TxFifoEmptyCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Tx Fifo Empty Callback */ 263 264 void (* MspInitCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Msp Init callback */ 265 266 void (* MspDeInitCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Msp DeInit callback */ 267 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 268 269 } SMARTCARD_HandleTypeDef; 270 271 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 272 /** 273 * @brief HAL SMARTCARD Callback ID enumeration definition 274 */ 275 typedef enum 276 { 277 HAL_SMARTCARD_TX_COMPLETE_CB_ID = 0x00U, /*!< SMARTCARD Tx Complete Callback ID */ 278 HAL_SMARTCARD_RX_COMPLETE_CB_ID = 0x01U, /*!< SMARTCARD Rx Complete Callback ID */ 279 HAL_SMARTCARD_ERROR_CB_ID = 0x02U, /*!< SMARTCARD Error Callback ID */ 280 HAL_SMARTCARD_ABORT_COMPLETE_CB_ID = 0x03U, /*!< SMARTCARD Abort Complete Callback ID */ 281 HAL_SMARTCARD_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x04U, /*!< SMARTCARD Abort Transmit Complete Callback ID */ 282 HAL_SMARTCARD_ABORT_RECEIVE_COMPLETE_CB_ID = 0x05U, /*!< SMARTCARD Abort Receive Complete Callback ID */ 283 HAL_SMARTCARD_RX_FIFO_FULL_CB_ID = 0x06U, /*!< SMARTCARD Rx Fifo Full Callback ID */ 284 HAL_SMARTCARD_TX_FIFO_EMPTY_CB_ID = 0x07U, /*!< SMARTCARD Tx Fifo Empty Callback ID */ 285 286 HAL_SMARTCARD_MSPINIT_CB_ID = 0x08U, /*!< SMARTCARD MspInit callback ID */ 287 HAL_SMARTCARD_MSPDEINIT_CB_ID = 0x09U /*!< SMARTCARD MspDeInit callback ID */ 288 289 } HAL_SMARTCARD_CallbackIDTypeDef; 290 291 /** 292 * @brief HAL SMARTCARD Callback pointer definition 293 */ 294 typedef void (*pSMARTCARD_CallbackTypeDef)(SMARTCARD_HandleTypeDef *hsmartcard); /*!< pointer to an SMARTCARD callback function */ 295 296 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 297 298 /** 299 * @} 300 */ 301 302 /* Exported constants --------------------------------------------------------*/ 303 /** @defgroup SMARTCARD_Exported_Constants SMARTCARD Exported Constants 304 * @{ 305 */ 306 307 /** @defgroup SMARTCARD_State_Definition SMARTCARD State Code Definition 308 * @{ 309 */ 310 #define HAL_SMARTCARD_STATE_RESET 0x00000000U /*!< Peripheral is not initialized. Value 311 is allowed for gState and RxState */ 312 #define HAL_SMARTCARD_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for 313 use. Value is allowed for gState 314 and RxState */ 315 #define HAL_SMARTCARD_STATE_BUSY 0x00000024U /*!< an internal process is ongoing 316 Value is allowed for gState only */ 317 #define HAL_SMARTCARD_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing 318 Value is allowed for gState only */ 319 #define HAL_SMARTCARD_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing 320 Value is allowed for RxState only */ 321 #define HAL_SMARTCARD_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception 322 process is ongoing Not to be used for 323 neither gState nor RxState. 324 Value is result of combination (Or) 325 between gState and RxState values */ 326 #define HAL_SMARTCARD_STATE_TIMEOUT 0x000000A0U /*!< Timeout state 327 Value is allowed for gState only */ 328 #define HAL_SMARTCARD_STATE_ERROR 0x000000E0U /*!< Error 329 Value is allowed for gState only */ 330 /** 331 * @} 332 */ 333 334 /** @defgroup SMARTCARD_Error_Definition SMARTCARD Error Code Definition 335 * @{ 336 */ 337 #define HAL_SMARTCARD_ERROR_NONE (0x00000000U) /*!< No error */ 338 #define HAL_SMARTCARD_ERROR_PE (0x00000001U) /*!< Parity error */ 339 #define HAL_SMARTCARD_ERROR_NE (0x00000002U) /*!< Noise error */ 340 #define HAL_SMARTCARD_ERROR_FE (0x00000004U) /*!< frame error */ 341 #define HAL_SMARTCARD_ERROR_ORE (0x00000008U) /*!< Overrun error */ 342 #if defined(HAL_DMA_MODULE_ENABLED) 343 #define HAL_SMARTCARD_ERROR_DMA (0x00000010U) /*!< DMA transfer error */ 344 #endif /* HAL_DMA_MODULE_ENABLED */ 345 #define HAL_SMARTCARD_ERROR_RTO (0x00000020U) /*!< Receiver TimeOut error */ 346 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 347 #define HAL_SMARTCARD_ERROR_INVALID_CALLBACK (0x00000040U) /*!< Invalid Callback error */ 348 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 349 /** 350 * @} 351 */ 352 353 /** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length 354 * @{ 355 */ 356 #define SMARTCARD_WORDLENGTH_9B USART_CR1_M0 /*!< SMARTCARD frame length */ 357 /** 358 * @} 359 */ 360 361 /** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits 362 * @{ 363 */ 364 #define SMARTCARD_STOPBITS_0_5 USART_CR2_STOP_0 /*!< SMARTCARD frame with 0.5 stop bit */ 365 #define SMARTCARD_STOPBITS_1_5 USART_CR2_STOP /*!< SMARTCARD frame with 1.5 stop bits */ 366 /** 367 * @} 368 */ 369 370 /** @defgroup SMARTCARD_Parity SMARTCARD Parity 371 * @{ 372 */ 373 #define SMARTCARD_PARITY_EVEN USART_CR1_PCE /*!< SMARTCARD frame even parity */ 374 #define SMARTCARD_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< SMARTCARD frame odd parity */ 375 /** 376 * @} 377 */ 378 379 /** @defgroup SMARTCARD_Mode SMARTCARD Transfer Mode 380 * @{ 381 */ 382 #define SMARTCARD_MODE_RX USART_CR1_RE /*!< SMARTCARD RX mode */ 383 #define SMARTCARD_MODE_TX USART_CR1_TE /*!< SMARTCARD TX mode */ 384 #define SMARTCARD_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< SMARTCARD RX and TX mode */ 385 /** 386 * @} 387 */ 388 389 /** @defgroup SMARTCARD_Clock_Polarity SMARTCARD Clock Polarity 390 * @{ 391 */ 392 #define SMARTCARD_POLARITY_LOW 0x00000000U /*!< SMARTCARD frame low polarity */ 393 #define SMARTCARD_POLARITY_HIGH USART_CR2_CPOL /*!< SMARTCARD frame high polarity */ 394 /** 395 * @} 396 */ 397 398 /** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase 399 * @{ 400 */ 401 #define SMARTCARD_PHASE_1EDGE 0x00000000U /*!< SMARTCARD frame phase on first clock transition */ 402 #define SMARTCARD_PHASE_2EDGE USART_CR2_CPHA /*!< SMARTCARD frame phase on second clock transition */ 403 /** 404 * @} 405 */ 406 407 /** @defgroup SMARTCARD_Last_Bit SMARTCARD Last Bit 408 * @{ 409 */ 410 #define SMARTCARD_LASTBIT_DISABLE 0x00000000U /*!< SMARTCARD frame last data bit clock pulse not output to SCLK pin */ 411 #define SMARTCARD_LASTBIT_ENABLE USART_CR2_LBCL /*!< SMARTCARD frame last data bit clock pulse output to SCLK pin */ 412 /** 413 * @} 414 */ 415 416 /** @defgroup SMARTCARD_OneBit_Sampling SMARTCARD One Bit Sampling Method 417 * @{ 418 */ 419 #define SMARTCARD_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< SMARTCARD frame one-bit sample disabled */ 420 #define SMARTCARD_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< SMARTCARD frame one-bit sample enabled */ 421 /** 422 * @} 423 */ 424 425 /** @defgroup SMARTCARD_NACK_Enable SMARTCARD NACK Enable 426 * @{ 427 */ 428 #define SMARTCARD_NACK_DISABLE 0x00000000U /*!< SMARTCARD NACK transmission disabled */ 429 #define SMARTCARD_NACK_ENABLE USART_CR3_NACK /*!< SMARTCARD NACK transmission enabled */ 430 /** 431 * @} 432 */ 433 434 /** @defgroup SMARTCARD_Timeout_Enable SMARTCARD Timeout Enable 435 * @{ 436 */ 437 #define SMARTCARD_TIMEOUT_DISABLE 0x00000000U /*!< SMARTCARD receiver timeout disabled */ 438 #define SMARTCARD_TIMEOUT_ENABLE USART_CR2_RTOEN /*!< SMARTCARD receiver timeout enabled */ 439 /** 440 * @} 441 */ 442 443 /** @defgroup SMARTCARD_ClockPrescaler SMARTCARD Clock Prescaler 444 * @{ 445 */ 446 #define SMARTCARD_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */ 447 #define SMARTCARD_PRESCALER_DIV2 0x00000001U /*!< fclk_pres = fclk/2 */ 448 #define SMARTCARD_PRESCALER_DIV4 0x00000002U /*!< fclk_pres = fclk/4 */ 449 #define SMARTCARD_PRESCALER_DIV6 0x00000003U /*!< fclk_pres = fclk/6 */ 450 #define SMARTCARD_PRESCALER_DIV8 0x00000004U /*!< fclk_pres = fclk/8 */ 451 #define SMARTCARD_PRESCALER_DIV10 0x00000005U /*!< fclk_pres = fclk/10 */ 452 #define SMARTCARD_PRESCALER_DIV12 0x00000006U /*!< fclk_pres = fclk/12 */ 453 #define SMARTCARD_PRESCALER_DIV16 0x00000007U /*!< fclk_pres = fclk/16 */ 454 #define SMARTCARD_PRESCALER_DIV32 0x00000008U /*!< fclk_pres = fclk/32 */ 455 #define SMARTCARD_PRESCALER_DIV64 0x00000009U /*!< fclk_pres = fclk/64 */ 456 #define SMARTCARD_PRESCALER_DIV128 0x0000000AU /*!< fclk_pres = fclk/128 */ 457 #define SMARTCARD_PRESCALER_DIV256 0x0000000BU /*!< fclk_pres = fclk/256 */ 458 /** 459 * @} 460 */ 461 462 /** @defgroup SMARTCARD_Tx_Inv SMARTCARD advanced feature TX pin active level inversion 463 * @{ 464 */ 465 #define SMARTCARD_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */ 466 #define SMARTCARD_ADVFEATURE_TXINV_ENABLE USART_CR2_TXINV /*!< TX pin active level inversion enable */ 467 /** 468 * @} 469 */ 470 471 /** @defgroup SMARTCARD_Rx_Inv SMARTCARD advanced feature RX pin active level inversion 472 * @{ 473 */ 474 #define SMARTCARD_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */ 475 #define SMARTCARD_ADVFEATURE_RXINV_ENABLE USART_CR2_RXINV /*!< RX pin active level inversion enable */ 476 /** 477 * @} 478 */ 479 480 /** @defgroup SMARTCARD_Data_Inv SMARTCARD advanced feature Binary Data inversion 481 * @{ 482 */ 483 #define SMARTCARD_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */ 484 #define SMARTCARD_ADVFEATURE_DATAINV_ENABLE USART_CR2_DATAINV /*!< Binary data inversion enable */ 485 /** 486 * @} 487 */ 488 489 /** @defgroup SMARTCARD_Rx_Tx_Swap SMARTCARD advanced feature RX TX pins swap 490 * @{ 491 */ 492 #define SMARTCARD_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */ 493 #define SMARTCARD_ADVFEATURE_SWAP_ENABLE USART_CR2_SWAP /*!< TX/RX pins swap enable */ 494 /** 495 * @} 496 */ 497 498 /** @defgroup SMARTCARD_Overrun_Disable SMARTCARD advanced feature Overrun Disable 499 * @{ 500 */ 501 #define SMARTCARD_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */ 502 #define SMARTCARD_ADVFEATURE_OVERRUN_DISABLE USART_CR3_OVRDIS /*!< RX overrun disable */ 503 /** 504 * @} 505 */ 506 507 /** @defgroup SMARTCARD_DMA_Disable_on_Rx_Error SMARTCARD advanced feature DMA Disable on Rx Error 508 * @{ 509 */ 510 #define SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */ 511 #define SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR USART_CR3_DDRE /*!< DMA disable on Reception Error */ 512 /** 513 * @} 514 */ 515 516 /** @defgroup SMARTCARD_MSB_First SMARTCARD advanced feature MSB first 517 * @{ 518 */ 519 #define SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received first disable */ 520 #define SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE USART_CR2_MSBFIRST /*!< Most significant bit sent/received first enable */ 521 /** 522 * @} 523 */ 524 525 /** @defgroup SMARTCARD_Request_Parameters SMARTCARD Request Parameters 526 * @{ 527 */ 528 #define SMARTCARD_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive data flush request */ 529 #define SMARTCARD_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush request */ 530 /** 531 * @} 532 */ 533 534 /** @defgroup SMARTCARD_Interruption_Mask SMARTCARD interruptions flags mask 535 * @{ 536 */ 537 #define SMARTCARD_IT_MASK 0x001FU /*!< SMARTCARD interruptions flags mask */ 538 #define SMARTCARD_CR_MASK 0x00E0U /*!< SMARTCARD control register mask */ 539 #define SMARTCARD_CR_POS 5U /*!< SMARTCARD control register position */ 540 #define SMARTCARD_ISR_MASK 0x1F00U /*!< SMARTCARD ISR register mask */ 541 #define SMARTCARD_ISR_POS 8U /*!< SMARTCARD ISR register position */ 542 /** 543 * @} 544 */ 545 546 /** 547 * @} 548 */ 549 550 /* Exported macros -----------------------------------------------------------*/ 551 /** @defgroup SMARTCARD_Exported_Macros SMARTCARD Exported Macros 552 * @{ 553 */ 554 555 /** @brief Reset SMARTCARD handle states. 556 * @param __HANDLE__ SMARTCARD handle. 557 * @retval None 558 */ 559 #if USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1 560 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) do{ \ 561 (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET; \ 562 (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET; \ 563 (__HANDLE__)->MspInitCallback = NULL; \ 564 (__HANDLE__)->MspDeInitCallback = NULL; \ 565 } while(0U) 566 #else 567 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) do{ \ 568 (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET; \ 569 (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET; \ 570 } while(0U) 571 #endif /*USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 572 573 /** @brief Flush the Smartcard Data registers. 574 * @param __HANDLE__ specifies the SMARTCARD Handle. 575 * @retval None 576 */ 577 #define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__) \ 578 do{ \ 579 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_RXDATA_FLUSH_REQUEST); \ 580 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_TXDATA_FLUSH_REQUEST); \ 581 } while(0U) 582 583 /** @brief Clear the specified SMARTCARD pending flag. 584 * @param __HANDLE__ specifies the SMARTCARD Handle. 585 * @param __FLAG__ specifies the flag to check. 586 * This parameter can be any combination of the following values: 587 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag 588 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag 589 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag 590 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag 591 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detected clear flag 592 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag 593 * @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag 594 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag 595 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag 596 * @arg @ref SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear flag 597 * @retval None 598 */ 599 #define __HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__)) 600 601 /** @brief Clear the SMARTCARD PE pending flag. 602 * @param __HANDLE__ specifies the SMARTCARD Handle. 603 * @retval None 604 */ 605 #define __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_PEF) 606 607 /** @brief Clear the SMARTCARD FE pending flag. 608 * @param __HANDLE__ specifies the SMARTCARD Handle. 609 * @retval None 610 */ 611 #define __HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_FEF) 612 613 /** @brief Clear the SMARTCARD NE pending flag. 614 * @param __HANDLE__ specifies the SMARTCARD Handle. 615 * @retval None 616 */ 617 #define __HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_NEF) 618 619 /** @brief Clear the SMARTCARD ORE pending flag. 620 * @param __HANDLE__ specifies the SMARTCARD Handle. 621 * @retval None 622 */ 623 #define __HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_OREF) 624 625 /** @brief Clear the SMARTCARD IDLE pending flag. 626 * @param __HANDLE__ specifies the SMARTCARD Handle. 627 * @retval None 628 */ 629 #define __HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_IDLEF) 630 631 /** @brief Check whether the specified Smartcard flag is set or not. 632 * @param __HANDLE__ specifies the SMARTCARD Handle. 633 * @param __FLAG__ specifies the flag to check. 634 * This parameter can be one of the following values: 635 * @arg @ref SMARTCARD_FLAG_TCBGT Transmission complete before guard time flag (when flag available) 636 * @arg @ref SMARTCARD_FLAG_REACK Receive enable acknowledge flag 637 * @arg @ref SMARTCARD_FLAG_TEACK Transmit enable acknowledge flag 638 * @arg @ref SMARTCARD_FLAG_BUSY Busy flag 639 * @arg @ref SMARTCARD_FLAG_EOBF End of block flag 640 * @arg @ref SMARTCARD_FLAG_RTOF Receiver timeout flag 641 * @arg @ref SMARTCARD_FLAG_TXE Transmit data register empty flag 642 * @arg @ref SMARTCARD_FLAG_TC Transmission complete flag 643 * @arg @ref SMARTCARD_FLAG_RXNE Receive data register not empty flag 644 * @arg @ref SMARTCARD_FLAG_IDLE Idle line detection flag 645 * @arg @ref SMARTCARD_FLAG_ORE Overrun error flag 646 * @arg @ref SMARTCARD_FLAG_NE Noise error flag 647 * @arg @ref SMARTCARD_FLAG_FE Framing error flag 648 * @arg @ref SMARTCARD_FLAG_PE Parity error flag 649 * @arg @ref SMARTCARD_FLAG_TXFNF TXFIFO not full flag 650 * @arg @ref SMARTCARD_FLAG_RXFNE RXFIFO not empty flag 651 * @arg @ref SMARTCARD_FLAG_TXFE TXFIFO Empty flag 652 * @arg @ref SMARTCARD_FLAG_RXFF RXFIFO Full flag 653 * @arg @ref SMARTCARD_FLAG_RXFT SMARTCARD RXFIFO threshold flag 654 * @arg @ref SMARTCARD_FLAG_TXFT SMARTCARD TXFIFO threshold flag 655 * @retval The new state of __FLAG__ (TRUE or FALSE). 656 */ 657 #define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__)) 658 659 /** @brief Enable the specified SmartCard interrupt. 660 * @param __HANDLE__ specifies the SMARTCARD Handle. 661 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to enable. 662 * This parameter can be one of the following values: 663 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 664 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 665 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 666 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 667 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before 668 * guard time interrupt (when interruption available) 669 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 670 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 671 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 672 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 673 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 674 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 675 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 676 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 677 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 678 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 679 * @retval None 680 */ 681 #define __HAL_SMARTCARD_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 682 SMARTCARD_CR_POS) == 1U)?\ 683 ((__HANDLE__)->Instance->CR1 |= (1UL <<\ 684 ((__INTERRUPT__) & SMARTCARD_IT_MASK))):\ 685 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 686 SMARTCARD_CR_POS) == 2U)?\ 687 ((__HANDLE__)->Instance->CR2 |= (1UL <<\ 688 ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 689 ((__HANDLE__)->Instance->CR3 |= (1UL <<\ 690 ((__INTERRUPT__) & SMARTCARD_IT_MASK)))) 691 692 /** @brief Disable the specified SmartCard interrupt. 693 * @param __HANDLE__ specifies the SMARTCARD Handle. 694 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to disable. 695 * This parameter can be one of the following values: 696 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 697 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 698 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 699 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 700 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard 701 * time interrupt (when interruption available) 702 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 703 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 704 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 705 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 706 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 707 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 708 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 709 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 710 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 711 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 712 * @retval None 713 */ 714 #define __HAL_SMARTCARD_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 715 SMARTCARD_CR_POS) == 1U)?\ 716 ((__HANDLE__)->Instance->CR1 &= ~ (1U <<\ 717 ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 718 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 719 SMARTCARD_CR_POS) == 2U)?\ 720 ((__HANDLE__)->Instance->CR2 &= ~ (1U <<\ 721 ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 722 ((__HANDLE__)->Instance->CR3 &= ~ (1U <<\ 723 ((__INTERRUPT__) & SMARTCARD_IT_MASK)))) 724 725 /** @brief Check whether the specified SmartCard interrupt has occurred or not. 726 * @param __HANDLE__ specifies the SMARTCARD Handle. 727 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to check. 728 * This parameter can be one of the following values: 729 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 730 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 731 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 732 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 733 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time 734 * interrupt (when interruption available) 735 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 736 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 737 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 738 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 739 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 740 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 741 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 742 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 743 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 744 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 745 * @retval The new state of __INTERRUPT__ (SET or RESET). 746 */ 747 #define __HAL_SMARTCARD_GET_IT(__HANDLE__, __INTERRUPT__) (\ 748 (((__HANDLE__)->Instance->ISR & (0x01UL << (((__INTERRUPT__)\ 749 & SMARTCARD_ISR_MASK)>> SMARTCARD_ISR_POS)))!= 0U)\ 750 ? SET : RESET) 751 752 /** @brief Check whether the specified SmartCard interrupt source is enabled or not. 753 * @param __HANDLE__ specifies the SMARTCARD Handle. 754 * @param __INTERRUPT__ specifies the SMARTCARD interrupt source to check. 755 * This parameter can be one of the following values: 756 * @arg @ref SMARTCARD_IT_EOB End of block interrupt 757 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt 758 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt 759 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt 760 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time 761 * interrupt (when interruption available) 762 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt 763 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt 764 * @arg @ref SMARTCARD_IT_PE Parity error interrupt 765 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error) 766 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption 767 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption 768 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption 769 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption 770 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption 771 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption 772 * @retval The new state of __INTERRUPT__ (SET or RESET). 773 */ 774 #define __HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 775 SMARTCARD_CR_POS) == 0x01U)?\ 776 (__HANDLE__)->Instance->CR1 : \ 777 (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\ 778 SMARTCARD_CR_POS) == 0x02U)?\ 779 (__HANDLE__)->Instance->CR2 : \ 780 (__HANDLE__)->Instance->CR3)) &\ 781 (0x01UL << (((uint16_t)(__INTERRUPT__))\ 782 & SMARTCARD_IT_MASK))) != 0U)\ 783 ? SET : RESET) 784 785 /** @brief Clear the specified SMARTCARD ISR flag, in setting the proper ICR register flag. 786 * @param __HANDLE__ specifies the SMARTCARD Handle. 787 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set 788 * to clear the corresponding interrupt. 789 * This parameter can be one of the following values: 790 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag 791 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag 792 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag 793 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag 794 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detection clear flag 795 * @arg @ref SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear Flag 796 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag 797 * @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag (when flag available) 798 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag 799 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag 800 * @retval None 801 */ 802 #define __HAL_SMARTCARD_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR |= (uint32_t)(__IT_CLEAR__)) 803 804 /** @brief Set a specific SMARTCARD request flag. 805 * @param __HANDLE__ specifies the SMARTCARD Handle. 806 * @param __REQ__ specifies the request flag to set 807 * This parameter can be one of the following values: 808 * @arg @ref SMARTCARD_RXDATA_FLUSH_REQUEST Receive data flush Request 809 * @arg @ref SMARTCARD_TXDATA_FLUSH_REQUEST Transmit data flush Request 810 * @retval None 811 */ 812 #define __HAL_SMARTCARD_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__)) 813 814 /** @brief Enable the SMARTCARD one bit sample method. 815 * @param __HANDLE__ specifies the SMARTCARD Handle. 816 * @retval None 817 */ 818 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT) 819 820 /** @brief Disable the SMARTCARD one bit sample method. 821 * @param __HANDLE__ specifies the SMARTCARD Handle. 822 * @retval None 823 */ 824 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\ 825 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT)) 826 827 /** @brief Enable the USART associated to the SMARTCARD Handle. 828 * @param __HANDLE__ specifies the SMARTCARD Handle. 829 * @retval None 830 */ 831 #define __HAL_SMARTCARD_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE) 832 833 /** @brief Disable the USART associated to the SMARTCARD Handle 834 * @param __HANDLE__ specifies the SMARTCARD Handle. 835 * @retval None 836 */ 837 #define __HAL_SMARTCARD_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE) 838 839 /** 840 * @} 841 */ 842 843 /* Private macros -------------------------------------------------------------*/ 844 /** @defgroup SMARTCARD_Private_Macros SMARTCARD Private Macros 845 * @{ 846 */ 847 848 /* An always 16 MHz is requested by USART to maintain fixed baud rate while 849 * system clock is switching from a frequency to another) 850 */ 851 #define SMARTCARD_PERIPHCLK (16000000U) 852 853 /** @brief Check the Baud rate range. 854 * @note The maximum Baud Rate is derived from the maximum clock on WB0 (16 MHz) 855 * divided by the oversampling used on the SMARTCARD (i.e. 16). 856 * @param __BAUDRATE__ Baud rate set by the configuration function. 857 * @retval Test result (TRUE or FALSE) 858 */ 859 #define IS_SMARTCARD_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 1000001U) 860 861 /** @brief Check the block length range. 862 * @note The maximum SMARTCARD block length is 0xFF. 863 * @param __LENGTH__ block length. 864 * @retval Test result (TRUE or FALSE) 865 */ 866 #define IS_SMARTCARD_BLOCKLENGTH(__LENGTH__) ((__LENGTH__) <= 0xFFU) 867 868 /** @brief Check the receiver timeout value. 869 * @note The maximum SMARTCARD receiver timeout value is 0xFFFFFF. 870 * @param __TIMEOUTVALUE__ receiver timeout value. 871 * @retval Test result (TRUE or FALSE) 872 */ 873 #define IS_SMARTCARD_TIMEOUT_VALUE(__TIMEOUTVALUE__) ((__TIMEOUTVALUE__) <= 0xFFFFFFU) 874 875 /** @brief Check the SMARTCARD autoretry counter value. 876 * @note The maximum number of retransmissions is 0x7. 877 * @param __COUNT__ number of retransmissions. 878 * @retval Test result (TRUE or FALSE) 879 */ 880 #define IS_SMARTCARD_AUTORETRY_COUNT(__COUNT__) ((__COUNT__) <= 0x7U) 881 882 /** @brief Ensure that SMARTCARD frame length is valid. 883 * @param __LENGTH__ SMARTCARD frame length. 884 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid) 885 */ 886 #define IS_SMARTCARD_WORD_LENGTH(__LENGTH__) ((__LENGTH__) == SMARTCARD_WORDLENGTH_9B) 887 888 /** @brief Ensure that SMARTCARD frame number of stop bits is valid. 889 * @param __STOPBITS__ SMARTCARD frame number of stop bits. 890 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid) 891 */ 892 #define IS_SMARTCARD_STOPBITS(__STOPBITS__) (((__STOPBITS__) == SMARTCARD_STOPBITS_0_5) ||\ 893 ((__STOPBITS__) == SMARTCARD_STOPBITS_1_5)) 894 895 /** @brief Ensure that SMARTCARD frame parity is valid. 896 * @param __PARITY__ SMARTCARD frame parity. 897 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid) 898 */ 899 #define IS_SMARTCARD_PARITY(__PARITY__) (((__PARITY__) == SMARTCARD_PARITY_EVEN) || \ 900 ((__PARITY__) == SMARTCARD_PARITY_ODD)) 901 902 /** @brief Ensure that SMARTCARD communication mode is valid. 903 * @param __MODE__ SMARTCARD communication mode. 904 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid) 905 */ 906 #define IS_SMARTCARD_MODE(__MODE__) ((((__MODE__) & 0xFFF3U) == 0x00U) && ((__MODE__) != 0x00U)) 907 908 /** @brief Ensure that SMARTCARD frame polarity is valid. 909 * @param __CPOL__ SMARTCARD frame polarity. 910 * @retval SET (__CPOL__ is valid) or RESET (__CPOL__ is invalid) 911 */ 912 #define IS_SMARTCARD_POLARITY(__CPOL__) (((__CPOL__) == SMARTCARD_POLARITY_LOW)\ 913 || ((__CPOL__) == SMARTCARD_POLARITY_HIGH)) 914 915 /** @brief Ensure that SMARTCARD frame phase is valid. 916 * @param __CPHA__ SMARTCARD frame phase. 917 * @retval SET (__CPHA__ is valid) or RESET (__CPHA__ is invalid) 918 */ 919 #define IS_SMARTCARD_PHASE(__CPHA__) (((__CPHA__) == SMARTCARD_PHASE_1EDGE) || ((__CPHA__) == SMARTCARD_PHASE_2EDGE)) 920 921 /** @brief Ensure that SMARTCARD frame last bit clock pulse setting is valid. 922 * @param __LASTBIT__ SMARTCARD frame last bit clock pulse setting. 923 * @retval SET (__LASTBIT__ is valid) or RESET (__LASTBIT__ is invalid) 924 */ 925 #define IS_SMARTCARD_LASTBIT(__LASTBIT__) (((__LASTBIT__) == SMARTCARD_LASTBIT_DISABLE) || \ 926 ((__LASTBIT__) == SMARTCARD_LASTBIT_ENABLE)) 927 928 /** @brief Ensure that SMARTCARD frame sampling is valid. 929 * @param __ONEBIT__ SMARTCARD frame sampling. 930 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid) 931 */ 932 #define IS_SMARTCARD_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_DISABLE) || \ 933 ((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_ENABLE)) 934 935 /** @brief Ensure that SMARTCARD NACK transmission setting is valid. 936 * @param __NACK__ SMARTCARD NACK transmission setting. 937 * @retval SET (__NACK__ is valid) or RESET (__NACK__ is invalid) 938 */ 939 #define IS_SMARTCARD_NACK(__NACK__) (((__NACK__) == SMARTCARD_NACK_ENABLE) || \ 940 ((__NACK__) == SMARTCARD_NACK_DISABLE)) 941 942 /** @brief Ensure that SMARTCARD receiver timeout setting is valid. 943 * @param __TIMEOUT__ SMARTCARD receiver timeout setting. 944 * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid) 945 */ 946 #define IS_SMARTCARD_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == SMARTCARD_TIMEOUT_DISABLE) || \ 947 ((__TIMEOUT__) == SMARTCARD_TIMEOUT_ENABLE)) 948 949 /** @brief Ensure that SMARTCARD clock Prescaler is valid. 950 * @param __CLOCKPRESCALER__ SMARTCARD clock Prescaler value. 951 * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid) 952 */ 953 #define IS_SMARTCARD_CLOCKPRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV1) || \ 954 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV2) || \ 955 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV4) || \ 956 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV6) || \ 957 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV8) || \ 958 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV10) || \ 959 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV12) || \ 960 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV16) || \ 961 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV32) || \ 962 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV64) || \ 963 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV128) || \ 964 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV256)) 965 966 /** @brief Ensure that SMARTCARD advanced features initialization is valid. 967 * @param __INIT__ SMARTCARD advanced features initialization. 968 * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid) 969 */ 970 #define IS_SMARTCARD_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (SMARTCARD_ADVFEATURE_NO_INIT | \ 971 SMARTCARD_ADVFEATURE_TXINVERT_INIT | \ 972 SMARTCARD_ADVFEATURE_RXINVERT_INIT | \ 973 SMARTCARD_ADVFEATURE_DATAINVERT_INIT | \ 974 SMARTCARD_ADVFEATURE_SWAP_INIT | \ 975 SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT | \ 976 SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT | \ 977 SMARTCARD_ADVFEATURE_MSBFIRST_INIT)) 978 979 /** @brief Ensure that SMARTCARD frame TX inversion setting is valid. 980 * @param __TXINV__ SMARTCARD frame TX inversion setting. 981 * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid) 982 */ 983 #define IS_SMARTCARD_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_DISABLE) || \ 984 ((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_ENABLE)) 985 986 /** @brief Ensure that SMARTCARD frame RX inversion setting is valid. 987 * @param __RXINV__ SMARTCARD frame RX inversion setting. 988 * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid) 989 */ 990 #define IS_SMARTCARD_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_DISABLE) || \ 991 ((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_ENABLE)) 992 993 /** @brief Ensure that SMARTCARD frame data inversion setting is valid. 994 * @param __DATAINV__ SMARTCARD frame data inversion setting. 995 * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid) 996 */ 997 #define IS_SMARTCARD_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_DISABLE) || \ 998 ((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_ENABLE)) 999 1000 /** @brief Ensure that SMARTCARD frame RX/TX pins swap setting is valid. 1001 * @param __SWAP__ SMARTCARD frame RX/TX pins swap setting. 1002 * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid) 1003 */ 1004 #define IS_SMARTCARD_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_DISABLE) || \ 1005 ((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_ENABLE)) 1006 1007 /** @brief Ensure that SMARTCARD frame overrun setting is valid. 1008 * @param __OVERRUN__ SMARTCARD frame overrun setting. 1009 * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid) 1010 */ 1011 #define IS_SMARTCARD_OVERRUN(__OVERRUN__) (((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_ENABLE) || \ 1012 ((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_DISABLE)) 1013 1014 /** @brief Ensure that SMARTCARD DMA enabling or disabling on error setting is valid. 1015 * @param __DMA__ SMARTCARD DMA enabling or disabling on error setting. 1016 * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid) 1017 */ 1018 #define IS_SMARTCARD_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR) || \ 1019 ((__DMA__) == SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR)) 1020 1021 /** @brief Ensure that SMARTCARD frame MSB first setting is valid. 1022 * @param __MSBFIRST__ SMARTCARD frame MSB first setting. 1023 * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid) 1024 */ 1025 #define IS_SMARTCARD_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE) || \ 1026 ((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE)) 1027 1028 /** @brief Ensure that SMARTCARD request parameter is valid. 1029 * @param __PARAM__ SMARTCARD request parameter. 1030 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid) 1031 */ 1032 #define IS_SMARTCARD_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == SMARTCARD_RXDATA_FLUSH_REQUEST) || \ 1033 ((__PARAM__) == SMARTCARD_TXDATA_FLUSH_REQUEST)) 1034 1035 /** 1036 * @} 1037 */ 1038 1039 /* Include SMARTCARD HAL Extended module */ 1040 #include "stm32wb0x_hal_smartcard_ex.h" 1041 1042 /* Exported functions --------------------------------------------------------*/ 1043 /** @addtogroup SMARTCARD_Exported_Functions 1044 * @{ 1045 */ 1046 1047 /* Initialization and de-initialization functions ****************************/ 1048 /** @addtogroup SMARTCARD_Exported_Functions_Group1 1049 * @{ 1050 */ 1051 1052 HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsmartcard); 1053 HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsmartcard); 1054 void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsmartcard); 1055 void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsmartcard); 1056 1057 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1) 1058 /* Callbacks Register/UnRegister functions ***********************************/ 1059 HAL_StatusTypeDef HAL_SMARTCARD_RegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard, 1060 HAL_SMARTCARD_CallbackIDTypeDef CallbackID, 1061 pSMARTCARD_CallbackTypeDef pCallback); 1062 HAL_StatusTypeDef HAL_SMARTCARD_UnRegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard, 1063 HAL_SMARTCARD_CallbackIDTypeDef CallbackID); 1064 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */ 1065 1066 /** 1067 * @} 1068 */ 1069 1070 /* IO operation functions *****************************************************/ 1071 /** @addtogroup SMARTCARD_Exported_Functions_Group2 1072 * @{ 1073 */ 1074 1075 HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size, 1076 uint32_t Timeout); 1077 HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size, 1078 uint32_t Timeout); 1079 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size); 1080 HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size); 1081 #if defined(HAL_DMA_MODULE_ENABLED) 1082 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size); 1083 HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size); 1084 #endif /* HAL_DMA_MODULE_ENABLED */ 1085 /* Transfer Abort functions */ 1086 HAL_StatusTypeDef HAL_SMARTCARD_Abort(SMARTCARD_HandleTypeDef *hsmartcard); 1087 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit(SMARTCARD_HandleTypeDef *hsmartcard); 1088 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive(SMARTCARD_HandleTypeDef *hsmartcard); 1089 HAL_StatusTypeDef HAL_SMARTCARD_Abort_IT(SMARTCARD_HandleTypeDef *hsmartcard); 1090 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit_IT(SMARTCARD_HandleTypeDef *hsmartcard); 1091 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive_IT(SMARTCARD_HandleTypeDef *hsmartcard); 1092 1093 void HAL_SMARTCARD_IRQHandler(SMARTCARD_HandleTypeDef *hsmartcard); 1094 void HAL_SMARTCARD_TxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1095 void HAL_SMARTCARD_RxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1096 void HAL_SMARTCARD_ErrorCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1097 void HAL_SMARTCARD_AbortCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1098 void HAL_SMARTCARD_AbortTransmitCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1099 void HAL_SMARTCARD_AbortReceiveCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard); 1100 1101 /** 1102 * @} 1103 */ 1104 1105 /* Peripheral State and Error functions ***************************************/ 1106 /** @addtogroup SMARTCARD_Exported_Functions_Group4 1107 * @{ 1108 */ 1109 1110 HAL_SMARTCARD_StateTypeDef HAL_SMARTCARD_GetState(const SMARTCARD_HandleTypeDef *hsmartcard); 1111 uint32_t HAL_SMARTCARD_GetError(const SMARTCARD_HandleTypeDef *hsmartcard); 1112 1113 /** 1114 * @} 1115 */ 1116 1117 /** 1118 * @} 1119 */ 1120 1121 /** 1122 * @} 1123 */ 1124 1125 /** 1126 * @} 1127 */ 1128 1129 #ifdef __cplusplus 1130 } 1131 #endif 1132 1133 #endif /* STM32WB0x_HAL_SMARTCARD_H */ 1134
