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