1 /** 2 ****************************************************************************** 3 * @file stm32f7xx_hal_smartcard.h 4 * @author MCD Application Team 5 * @version V1.0.1 6 * @date 25-June-2015 7 * @brief Header file of SMARTCARD HAL module. 8 ****************************************************************************** 9 * @attention 10 * 11 * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> 12 * 13 * Redistribution and use in source and binary forms, with or without modification, 14 * are permitted provided that the following conditions are met: 15 * 1. Redistributions of source code must retain the above copyright notice, 16 * this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright notice, 18 * this list of conditions and the following disclaimer in the documentation 19 * and/or other materials provided with the distribution. 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34 * 35 ****************************************************************************** 36 */ 37 38 /* Define to prevent recursive inclusion -------------------------------------*/ 39 #ifndef __STM32F7xx_HAL_SMARTCARD_H 40 #define __STM32F7xx_HAL_SMARTCARD_H 41 42 #ifdef __cplusplus 43 extern "C" { 44 #endif 45 46 /* Includes ------------------------------------------------------------------*/ 47 #include "stm32f7xx_hal_def.h" 48 49 /** @addtogroup STM32F7xx_HAL_Driver 50 * @{ 51 */ 52 53 /** @addtogroup SMARTCARD 54 * @{ 55 */ 56 57 /* Exported types ------------------------------------------------------------*/ 58 /** @defgroup SMARTCARD_Exported_Types SMARTCARD Exported Types 59 * @{ 60 */ 61 62 /** 63 * @brief SMARTCARD Init Structure definition 64 */ 65 typedef struct { 66 uint32_t BaudRate; /*!< Configures the SmartCard communication baud rate. 67 The baud rate register is computed using the following formula: 68 Baud Rate Register = ((PCLKx) / ((hsc->Init.BaudRate))) */ 69 70 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame. 71 This parameter @ref SMARTCARD_Word_Length can only be set to 9 (8 data + 1 parity bits). */ 72 73 uint32_t StopBits; /*!< Specifies the number of stop bits @ref SMARTCARD_Stop_Bits. 74 Only 1.5 stop bits are authorized in SmartCard mode. */ 75 76 uint32_t Parity; /*!< Specifies the parity mode. 77 This parameter can be a value of @ref SMARTCARD_Parity 78 @note The parity is enabled by default (PCE is forced to 1). 79 Since the WordLength is forced to 8 bits + parity, M is 80 forced to 1 and the parity bit is the 9th bit. */ 81 82 uint32_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled. 83 This parameter can be a value of @ref SMARTCARD_Mode */ 84 85 uint32_t CLKPolarity; /*!< Specifies the steady state of the serial clock. 86 This parameter can be a value of @ref SMARTCARD_Clock_Polarity */ 87 88 uint32_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made. 89 This parameter can be a value of @ref SMARTCARD_Clock_Phase */ 90 91 uint32_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted 92 data bit (MSB) has to be output on the SCLK pin in synchronous mode. 93 This parameter can be a value of @ref SMARTCARD_Last_Bit */ 94 95 uint32_t OneBitSampling; /*!< Specifies whether a single sample or three samples' majority vote is selected. 96 Selecting the single sample method increases the receiver tolerance to clock 97 deviations. This parameter can be a value of @ref SMARTCARD_OneBit_Sampling */ 98 99 uint32_t Prescaler; /*!< Specifies the SmartCard Prescaler */ 100 101 uint32_t GuardTime; /*!< Specifies the SmartCard Guard Time */ 102 103 uint32_t NACKState; /*!< Specifies whether the SmartCard NACK transmission is enabled 104 in case of parity error. 105 This parameter can be a value of @ref SMARTCARD_NACK_State */ 106 107 uint32_t TimeOutEnable; /*!< Specifies whether the receiver timeout is enabled. 108 This parameter can be a value of @ref SMARTCARD_Timeout_Enable*/ 109 110 uint32_t TimeOutValue; /*!< Specifies the receiver time out value in number of baud blocks: 111 it is used to implement the Character Wait Time (CWT) and 112 Block Wait Time (BWT). It is coded over 24 bits. */ 113 114 uint32_t BlockLength; /*!< Specifies the SmartCard Block Length in T=1 Reception mode. 115 This parameter can be any value from 0x0 to 0xFF */ 116 117 uint32_t AutoRetryCount; /*!< Specifies the SmartCard auto-retry count (number of retries in 118 receive and transmit mode). When set to 0, retransmission is 119 disabled. Otherwise, its maximum value is 7 (before signalling 120 an error) */ 121 122 } SMARTCARD_InitTypeDef; 123 124 /** 125 * @brief SMARTCARD advanced features initalization structure definition 126 */ 127 typedef struct { 128 uint32_t AdvFeatureInit; /*!< Specifies which advanced SMARTCARD features is initialized. Several 129 advanced features may be initialized at the same time. This parameter 130 can be a value of @ref SMARTCARD_Advanced_Features_Initialization_Type */ 131 132 uint32_t TxPinLevelInvert; /*!< Specifies whether the TX pin active level is inverted. 133 This parameter can be a value of @ref SMARTCARD_Tx_Inv */ 134 135 uint32_t RxPinLevelInvert; /*!< Specifies whether the RX pin active level is inverted. 136 This parameter can be a value of @ref SMARTCARD_Rx_Inv */ 137 138 uint32_t DataInvert; /*!< Specifies whether data are inverted (positive/direct logic 139 vs negative/inverted logic). 140 This parameter can be a value of @ref SMARTCARD_Data_Inv */ 141 142 uint32_t Swap; /*!< Specifies whether TX and RX pins are swapped. 143 This parameter can be a value of @ref SMARTCARD_Rx_Tx_Swap */ 144 145 uint32_t OverrunDisable; /*!< Specifies whether the reception overrun detection is disabled. 146 This parameter can be a value of @ref SMARTCARD_Overrun_Disable */ 147 148 uint32_t DMADisableonRxError; /*!< Specifies whether the DMA is disabled in case of reception error. 149 This parameter can be a value of @ref SMARTCARD_DMA_Disable_on_Rx_Error */ 150 151 uint32_t MSBFirst; /*!< Specifies whether MSB is sent first on UART line. 152 This parameter can be a value of @ref SMARTCARD_MSB_First */ 153 } SMARTCARD_AdvFeatureInitTypeDef; 154 155 /** 156 * @brief HAL State structures definition 157 */ 158 typedef enum { 159 HAL_SMARTCARD_STATE_RESET = 0x00, /*!< Peripheral is not yet Initialized */ 160 HAL_SMARTCARD_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */ 161 HAL_SMARTCARD_STATE_BUSY = 0x02, /*!< an internal process is ongoing */ 162 HAL_SMARTCARD_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */ 163 HAL_SMARTCARD_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */ 164 HAL_SMARTCARD_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */ 165 HAL_SMARTCARD_STATE_TIMEOUT = 0x03, /*!< Timeout state */ 166 HAL_SMARTCARD_STATE_ERROR = 0x04 /*!< Error */ 167 } HAL_SMARTCARD_StateTypeDef; 168 169 170 /** 171 * @brief SMARTCARD clock sources definition 172 */ 173 typedef enum { 174 SMARTCARD_CLOCKSOURCE_PCLK1 = 0x00, /*!< PCLK1 clock source */ 175 SMARTCARD_CLOCKSOURCE_PCLK2 = 0x01, /*!< PCLK2 clock source */ 176 SMARTCARD_CLOCKSOURCE_HSI = 0x02, /*!< HSI clock source */ 177 SMARTCARD_CLOCKSOURCE_SYSCLK = 0x04, /*!< SYSCLK clock source */ 178 SMARTCARD_CLOCKSOURCE_LSE = 0x08 /*!< LSE clock source */ 179 } SMARTCARD_ClockSourceTypeDef; 180 181 /** 182 * @brief SMARTCARD handle Structure definition 183 */ 184 typedef struct { 185 USART_TypeDef *Instance; /* USART registers base address */ 186 187 SMARTCARD_InitTypeDef Init; /* SmartCard communication parameters */ 188 189 SMARTCARD_AdvFeatureInitTypeDef AdvancedInit; /* SmartCard advanced features initialization parameters */ 190 191 uint8_t *pTxBuffPtr; /* Pointer to SmartCard Tx transfer Buffer */ 192 193 uint16_t TxXferSize; /* SmartCard Tx Transfer size */ 194 195 uint16_t TxXferCount; /* SmartCard Tx Transfer Counter */ 196 197 uint8_t *pRxBuffPtr; /* Pointer to SmartCard Rx transfer Buffer */ 198 199 uint16_t RxXferSize; /* SmartCard Rx Transfer size */ 200 201 uint16_t RxXferCount; /* SmartCard Rx Transfer Counter */ 202 203 DMA_HandleTypeDef *hdmatx; /* SmartCard Tx DMA Handle parameters */ 204 205 DMA_HandleTypeDef *hdmarx; /* SmartCard Rx DMA Handle parameters */ 206 207 HAL_LockTypeDef Lock; /* Locking object */ 208 209 __IO HAL_SMARTCARD_StateTypeDef State; /* SmartCard communication state */ 210 211 __IO uint32_t ErrorCode; /* SmartCard Error code */ 212 213 } SMARTCARD_HandleTypeDef; 214 215 /** 216 * @} 217 */ 218 /* Exported constants --------------------------------------------------------*/ 219 /** @defgroup SMARTCARD_Exported_Constants SMARTCARD Exported constants 220 * @{ 221 */ 222 /** @defgroup SMARTCARD_Error_Code SMARTCARD Error Code 223 * @brief SMARTCARD Error Code 224 * @{ 225 */ 226 #define HAL_SMARTCARD_ERROR_NONE ((uint32_t)0x00) /*!< No error */ 227 #define HAL_SMARTCARD_ERROR_PE ((uint32_t)0x01) /*!< Parity error */ 228 #define HAL_SMARTCARD_ERROR_NE ((uint32_t)0x02) /*!< Noise error */ 229 #define HAL_SMARTCARD_ERROR_FE ((uint32_t)0x04) /*!< frame error */ 230 #define HAL_SMARTCARD_ERROR_ORE ((uint32_t)0x08) /*!< Overrun error */ 231 #define HAL_SMARTCARD_ERROR_DMA ((uint32_t)0x10) /*!< DMA transfer error */ 232 #define HAL_SMARTCARD_ERROR_RTO ((uint32_t)0x20) /*!< Receiver TimeOut error */ 233 /** 234 * @} 235 */ 236 237 /** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length 238 * @{ 239 */ 240 #define SMARTCARD_WORDLENGTH_9B ((uint32_t)USART_CR1_M_0) 241 /** 242 * @} 243 */ 244 245 /** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits 246 * @{ 247 */ 248 #define SMARTCARD_STOPBITS_1_5 ((uint32_t)(USART_CR2_STOP)) 249 /** 250 * @} 251 */ 252 253 /** @defgroup SMARTCARD_Parity SMARTCARD Parity 254 * @{ 255 */ 256 #define SMARTCARD_PARITY_EVEN ((uint32_t)USART_CR1_PCE) 257 #define SMARTCARD_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS)) 258 /** 259 * @} 260 */ 261 262 /** @defgroup SMARTCARD_Mode SMARTCARD Mode 263 * @{ 264 */ 265 #define SMARTCARD_MODE_RX ((uint32_t)USART_CR1_RE) 266 #define SMARTCARD_MODE_TX ((uint32_t)USART_CR1_TE) 267 #define SMARTCARD_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE)) 268 /** 269 * @} 270 */ 271 272 /** @defgroup SMARTCARD_Clock_Polarity SMARTCARD Clock Polarity 273 * @{ 274 */ 275 #define SMARTCARD_POLARITY_LOW ((uint32_t)0x0000) 276 #define SMARTCARD_POLARITY_HIGH ((uint32_t)USART_CR2_CPOL) 277 /** 278 * @} 279 */ 280 281 /** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase 282 * @{ 283 */ 284 #define SMARTCARD_PHASE_1EDGE ((uint32_t)0x0000) 285 #define SMARTCARD_PHASE_2EDGE ((uint32_t)USART_CR2_CPHA) 286 /** 287 * @} 288 */ 289 290 /** @defgroup SMARTCARD_Last_Bit SMARTCARD Last Bit 291 * @{ 292 */ 293 #define SMARTCARD_LASTBIT_DISABLE ((uint32_t)0x0000) 294 #define SMARTCARD_LASTBIT_ENABLE ((uint32_t)USART_CR2_LBCL) 295 /** 296 * @} 297 */ 298 299 /** @defgroup SMARTCARD_OneBit_Sampling SMARTCARD OneBit Sampling 300 * @{ 301 */ 302 #define SMARTCARD_ONE_BIT_SAMPLE_DISABLE ((uint32_t)0x0000) 303 #define SMARTCARD_ONE_BIT_SAMPLE_ENABLE ((uint32_t)USART_CR3_ONEBIT) 304 /** 305 * @} 306 */ 307 308 309 /** @defgroup SMARTCARD_NACK_State SMARTCARD NACK State 310 * @{ 311 */ 312 #define SMARTCARD_NACK_ENABLE ((uint32_t)USART_CR3_NACK) 313 #define SMARTCARD_NACK_DISABLE ((uint32_t)0x0000) 314 /** 315 * @} 316 */ 317 318 /** @defgroup SMARTCARD_Timeout_Enable SMARTCARD Timeout Enable 319 * @{ 320 */ 321 #define SMARTCARD_TIMEOUT_DISABLE ((uint32_t)0x00000000) 322 #define SMARTCARD_TIMEOUT_ENABLE ((uint32_t)USART_CR2_RTOEN) 323 /** 324 * @} 325 */ 326 327 /** @defgroup SMARTCARD_DMA_Requests SMARTCARD DMA requests 328 * @{ 329 */ 330 331 #define SMARTCARD_DMAREQ_TX ((uint32_t)USART_CR3_DMAT) 332 #define SMARTCARD_DMAREQ_RX ((uint32_t)USART_CR3_DMAR) 333 334 /** 335 * @} 336 */ 337 338 /** @defgroup SMARTCARD_Advanced_Features_Initialization_Type SMARTCARD Advanced Features Initialization Type 339 * @{ 340 */ 341 #define SMARTCARD_ADVFEATURE_NO_INIT ((uint32_t)0x00000000) 342 #define SMARTCARD_ADVFEATURE_TXINVERT_INIT ((uint32_t)0x00000001) 343 #define SMARTCARD_ADVFEATURE_RXINVERT_INIT ((uint32_t)0x00000002) 344 #define SMARTCARD_ADVFEATURE_DATAINVERT_INIT ((uint32_t)0x00000004) 345 #define SMARTCARD_ADVFEATURE_SWAP_INIT ((uint32_t)0x00000008) 346 #define SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT ((uint32_t)0x00000010) 347 #define SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT ((uint32_t)0x00000020) 348 #define SMARTCARD_ADVFEATURE_MSBFIRST_INIT ((uint32_t)0x00000080) 349 /** 350 * @} 351 */ 352 353 /** @defgroup SMARTCARD_Tx_Inv SMARTCARD Tx Inv 354 * @{ 355 */ 356 #define SMARTCARD_ADVFEATURE_TXINV_DISABLE ((uint32_t)0x00000000) 357 #define SMARTCARD_ADVFEATURE_TXINV_ENABLE ((uint32_t)USART_CR2_TXINV) 358 /** 359 * @} 360 */ 361 362 /** @defgroup SMARTCARD_Rx_Inv SMARTCARD Rx Inv 363 * @{ 364 */ 365 #define SMARTCARD_ADVFEATURE_RXINV_DISABLE ((uint32_t)0x00000000) 366 #define SMARTCARD_ADVFEATURE_RXINV_ENABLE ((uint32_t)USART_CR2_RXINV) 367 /** 368 * @} 369 */ 370 371 /** @defgroup SMARTCARD_Data_Inv SMARTCARD Data Inv 372 * @{ 373 */ 374 #define SMARTCARD_ADVFEATURE_DATAINV_DISABLE ((uint32_t)0x00000000) 375 #define SMARTCARD_ADVFEATURE_DATAINV_ENABLE ((uint32_t)USART_CR2_DATAINV) 376 /** 377 * @} 378 */ 379 380 /** @defgroup SMARTCARD_Rx_Tx_Swap SMARTCARD Rx Tx Swap 381 * @{ 382 */ 383 #define SMARTCARD_ADVFEATURE_SWAP_DISABLE ((uint32_t)0x00000000) 384 #define SMARTCARD_ADVFEATURE_SWAP_ENABLE ((uint32_t)USART_CR2_SWAP) 385 /** 386 * @} 387 */ 388 389 /** @defgroup SMARTCARD_Overrun_Disable SMARTCARD Overrun Disable 390 * @{ 391 */ 392 #define SMARTCARD_ADVFEATURE_OVERRUN_ENABLE ((uint32_t)0x00000000) 393 #define SMARTCARD_ADVFEATURE_OVERRUN_DISABLE ((uint32_t)USART_CR3_OVRDIS) 394 /** 395 * @} 396 */ 397 398 /** @defgroup SMARTCARD_DMA_Disable_on_Rx_Error SMARTCARD DMA Disable on Rx Error 399 * @{ 400 */ 401 #define SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR ((uint32_t)0x00000000) 402 #define SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR ((uint32_t)USART_CR3_DDRE) 403 /** 404 * @} 405 */ 406 407 /** @defgroup SMARTCARD_MSB_First SMARTCARD MSB First 408 * @{ 409 */ 410 #define SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE ((uint32_t)0x00000000) 411 #define SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE ((uint32_t)USART_CR2_MSBFIRST) 412 /** 413 * @} 414 */ 415 416 /** @defgroup SmartCard_Flags SMARTCARD Flags 417 * Elements values convention: 0xXXXX 418 * - 0xXXXX : Flag mask in the ISR register 419 * @{ 420 */ 421 #define SMARTCARD_FLAG_REACK ((uint32_t)0x00400000) 422 #define SMARTCARD_FLAG_TEACK ((uint32_t)0x00200000) 423 #define SMARTCARD_FLAG_BUSY ((uint32_t)0x00010000) 424 #define SMARTCARD_FLAG_EOBF ((uint32_t)0x00001000) 425 #define SMARTCARD_FLAG_RTOF ((uint32_t)0x00000800) 426 #define SMARTCARD_FLAG_TXE ((uint32_t)0x00000080) 427 #define SMARTCARD_FLAG_TC ((uint32_t)0x00000040) 428 #define SMARTCARD_FLAG_RXNE ((uint32_t)0x00000020) 429 #define SMARTCARD_FLAG_IDLE ((uint32_t)0x00000010) 430 #define SMARTCARD_FLAG_ORE ((uint32_t)0x00000008) 431 #define SMARTCARD_FLAG_NE ((uint32_t)0x00000004) 432 #define SMARTCARD_FLAG_FE ((uint32_t)0x00000002) 433 #define SMARTCARD_FLAG_PE ((uint32_t)0x00000001) 434 /** 435 * @} 436 */ 437 438 /** @defgroup SMARTCARD_Interrupt_definition SMARTCARD Interrupt definition 439 * Elements values convention: 0000ZZZZ0XXYYYYYb 440 * - YYYYY : Interrupt source position in the XX register (5bits) 441 * - XX : Interrupt source register (2bits) 442 * - 01: CR1 register 443 * - 10: CR2 register 444 * - 11: CR3 register 445 * - ZZZZ : Flag position in the ISR register(4bits) 446 * @{ 447 */ 448 449 #define SMARTCARD_IT_PE ((uint16_t)0x0028) 450 #define SMARTCARD_IT_TXE ((uint16_t)0x0727) 451 #define SMARTCARD_IT_TC ((uint16_t)0x0626) 452 #define SMARTCARD_IT_RXNE ((uint16_t)0x0525) 453 #define SMARTCARD_IT_IDLE ((uint16_t)0x0424) 454 #define SMARTCARD_IT_ERR ((uint16_t)0x0060) 455 #define SMARTCARD_IT_ORE ((uint16_t)0x0300) 456 #define SMARTCARD_IT_NE ((uint16_t)0x0200) 457 #define SMARTCARD_IT_FE ((uint16_t)0x0100) 458 459 #define SMARTCARD_IT_EOB ((uint16_t)0x0C3B) 460 #define SMARTCARD_IT_RTO ((uint16_t)0x0B3A) 461 /** 462 * @} 463 */ 464 465 466 /** @defgroup SMARTCARD_IT_CLEAR_Flags SMARTCARD IT CLEAR Flags 467 * @{ 468 */ 469 #define SMARTCARD_CLEAR_PEF USART_ICR_PECF /*!< Parity Error Clear Flag */ 470 #define SMARTCARD_CLEAR_FEF USART_ICR_FECF /*!< Framing Error Clear Flag */ 471 #define SMARTCARD_CLEAR_NEF USART_ICR_NCF /*!< Noise detected Clear Flag */ 472 #define SMARTCARD_CLEAR_OREF USART_ICR_ORECF /*!< OverRun Error Clear Flag */ 473 #define SMARTCARD_CLEAR_IDLEF USART_ICR_IDLECF /*!< Idle line detected clear Flag */ 474 #define SMARTCARD_CLEAR_TCF USART_ICR_TCCF /*!< Transmission Complete Clear Flag */ 475 #define SMARTCARD_CLEAR_RTOF USART_ICR_RTOCF /*!< Receiver Time Out Clear Flag */ 476 #define SMARTCARD_CLEAR_EOBF USART_ICR_EOBCF /*!< End Of Block Clear Flag */ 477 /** 478 * @} 479 */ 480 481 /** @defgroup SMARTCARD_Request_Parameters SMARTCARD Request Parameters 482 * @{ 483 */ 484 #define SMARTCARD_RXDATA_FLUSH_REQUEST ((uint32_t)USART_RQR_RXFRQ) /*!< Receive Data flush Request */ 485 #define SMARTCARD_TXDATA_FLUSH_REQUEST ((uint32_t)USART_RQR_TXFRQ) /*!< Transmit data flush Request */ 486 /** 487 * @} 488 */ 489 490 491 /** @defgroup SMARTCARD_CR3_SCAR_CNT_LSB_POS SMARTCARD CR3 SCAR CNT LSB POS 492 * @{ 493 */ 494 #define SMARTCARD_CR3_SCARCNT_LSB_POS ((uint32_t) 17) 495 /** 496 * @} 497 */ 498 499 /** @defgroup SMARTCARD_GTPR_GT_LSBPOS SMARTCARD GTPR GT LSBPOS 500 * @{ 501 */ 502 #define SMARTCARD_GTPR_GT_LSB_POS ((uint32_t) 8) 503 /** 504 * @} 505 */ 506 507 /** @defgroup SMARTCARD_RTOR_BLEN_LSBPOS SMARTCARD RTOR BLEN LSBPOS 508 * @{ 509 */ 510 #define SMARTCARD_RTOR_BLEN_LSB_POS ((uint32_t) 24) 511 /** 512 * @} 513 */ 514 515 /** @defgroup SMARTCARD_Interruption_Mask SMARTCARD Interruption Mask 516 * @{ 517 */ 518 #define SMARTCARD_IT_MASK ((uint16_t)0x001F) 519 /** 520 * @} 521 */ 522 523 /** 524 * @} 525 */ 526 527 /* Exported macro ------------------------------------------------------------*/ 528 /** @defgroup SMARTCARD_Exported_Macros SMARTCARD Exported Macros 529 * @{ 530 */ 531 532 /** @brief Reset SMARTCARD handle state 533 * @param __HANDLE__: specifies the SMARTCARD Handle. 534 * The Handle Instance which can be USART1 or USART2 535 * @retval None 536 */ 537 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SMARTCARD_STATE_RESET) 538 539 /** @brief Flush the Smartcard DR register 540 * @param __HANDLE__: specifies the SMARTCARD Handle. 541 * The Handle Instance which can be USART1 or USART2. 542 * @retval None 543 */ 544 #define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__) (__HAL_SMARTCARD_SEND_REQ((__HANDLE__), SMARTCARD_RXDATA_FLUSH_REQUEST)) 545 546 /** @brief Checks whether the specified Smartcard flag is set or not. 547 * @param __HANDLE__: specifies the SMARTCARD Handle. 548 * The Handle Instance which can be USART1 or USART2. 549 * @param __FLAG__: specifies the flag to check. 550 * This parameter can be one of the following values: 551 * @arg SMARTCARD_FLAG_REACK: Receive enable acknowledge flag 552 * @arg SMARTCARD_FLAG_TEACK: Transmit enable acknowledge flag 553 * @arg SMARTCARD_FLAG_BUSY: Busy flag 554 * @arg SMARTCARD_FLAG_EOBF: End of block flag 555 * @arg SMARTCARD_FLAG_RTOF: Receiver timeout flag 556 * @arg SMARTCARD_FLAG_TXE: Transmit data register empty flag 557 * @arg SMARTCARD_FLAG_TC: Transmission Complete flag 558 * @arg SMARTCARD_FLAG_RXNE: Receive data register not empty flag 559 * @arg SMARTCARD_FLAG_ORE: OverRun Error flag 560 * @arg SMARTCARD_FLAG_NE: Noise Error flag 561 * @arg SMARTCARD_FLAG_FE: Framing Error flag 562 * @arg SMARTCARD_FLAG_PE: Parity Error flag 563 * @retval The new state of __FLAG__ (TRUE or FALSE). 564 */ 565 #define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__)) 566 567 /** @brief Enables the specified SmartCard interrupt. 568 * @param __HANDLE__: specifies the SMARTCARD Handle. 569 * The Handle Instance which can be USART1 or USART2. 570 * @param __INTERRUPT__: specifies the SMARTCARD interrupt to enable. 571 * This parameter can be one of the following values: 572 * @arg SMARTCARD_IT_EOBF: End Of Block interrupt 573 * @arg SMARTCARD_IT_RTOF: Receive TimeOut interrupt 574 * @arg SMARTCARD_IT_TXE: Transmit Data Register empty interrupt 575 * @arg SMARTCARD_IT_TC: Transmission complete interrupt 576 * @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt 577 * @arg SMARTCARD_IT_PE: Parity Error interrupt 578 * @arg SMARTCARD_IT_ERR: Error interrupt(Frame error, noise error, overrun error) 579 * @retval None 580 */ 581 #define __HAL_SMARTCARD_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5) == 1)? ((__HANDLE__)->Instance->CR1 |= (1 << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 582 ((((uint8_t)(__INTERRUPT__)) >> 5) == 2)? ((__HANDLE__)->Instance->CR2 |= (1 << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 583 ((__HANDLE__)->Instance->CR3 |= (1 << ((__INTERRUPT__) & SMARTCARD_IT_MASK)))) 584 /** @brief Disables the specified SmartCard interrupt. 585 * @param __HANDLE__: specifies the SMARTCARD Handle. 586 * The Handle Instance which can be USART1 or USART2. 587 * @param __INTERRUPT__: specifies the SMARTCARD interrupt to enable. 588 * This parameter can be one of the following values: 589 * @arg SMARTCARD_IT_EOBF: End Of Block interrupt 590 * @arg SMARTCARD_IT_RTOF: Receive TimeOut interrupt 591 * @arg SMARTCARD_IT_TXE: Transmit Data Register empty interrupt 592 * @arg SMARTCARD_IT_TC: Transmission complete interrupt 593 * @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt 594 * @arg SMARTCARD_IT_PE: Parity Error interrupt 595 * @arg SMARTCARD_IT_ERR: Error interrupt(Frame error, noise error, overrun error) 596 * @retval None 597 */ 598 #define __HAL_SMARTCARD_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((uint8_t)(__INTERRUPT__)) >> 5) == 1)? ((__HANDLE__)->Instance->CR1 &= ~ ((uint32_t)1 << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 599 ((((uint8_t)(__INTERRUPT__)) >> 5) == 2)? ((__HANDLE__)->Instance->CR2 &= ~ ((uint32_t)1 << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \ 600 ((__HANDLE__)->Instance->CR3 &= ~ ((uint32_t)1 << ((__INTERRUPT__) & SMARTCARD_IT_MASK)))) 601 602 /** @brief Checks whether the specified SmartCard interrupt has occurred or not. 603 * @param __HANDLE__: specifies the SMARTCARD Handle. 604 * The Handle Instance which can be USART1 or USART2. 605 * @param __IT__: specifies the SMARTCARD interrupt to check. 606 * This parameter can be one of the following values: 607 * @arg SMARTCARD_IT_EOBF: End Of Block interrupt 608 * @arg SMARTCARD_IT_RTOF: Receive TimeOut interrupt 609 * @arg SMARTCARD_IT_TXE: Transmit Data Register empty interrupt 610 * @arg SMARTCARD_IT_TC: Transmission complete interrupt 611 * @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt 612 * @arg SMARTCARD_IT_ORE: OverRun Error interrupt 613 * @arg SMARTCARD_IT_NE: Noise Error interrupt 614 * @arg SMARTCARD_IT_FE: Framing Error interrupt 615 * @arg SMARTCARD_IT_PE: Parity Error interrupt 616 * @retval The new state of __IT__ (TRUE or FALSE). 617 */ 618 #define __HAL_SMARTCARD_GET_IT(__HANDLE__, __IT__) ((__HANDLE__)->Instance->ISR & ((uint32_t)1 << ((__IT__)>> 0x08))) 619 620 /** @brief Checks whether the specified SmartCard interrupt interrupt source is enabled. 621 * @param __HANDLE__: specifies the SMARTCARD Handle. 622 * The Handle Instance which can be USART1 or USART2. 623 * @param __IT__: specifies the SMARTCARD interrupt source to check. 624 * This parameter can be one of the following values: 625 * @arg SMARTCARD_IT_EOBF: End Of Block interrupt 626 * @arg SMARTCARD_IT_RTOF: Receive TimeOut interrupt 627 * @arg SMARTCARD_IT_TXE: Transmit Data Register empty interrupt 628 * @arg SMARTCARD_IT_TC: Transmission complete interrupt 629 * @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt 630 * @arg SMARTCARD_IT_ORE: OverRun Error interrupt 631 * @arg SMARTCARD_IT_NE: Noise Error interrupt 632 * @arg SMARTCARD_IT_FE: Framing Error interrupt 633 * @arg SMARTCARD_IT_PE: Parity Error interrupt 634 * @retval The new state of __IT__ (TRUE or FALSE). 635 */ 636 #define __HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __IT__) ((((((uint8_t)(__IT__)) >> 5) == 1)? (__HANDLE__)->Instance->CR1:(((((uint8_t)(__IT__)) >> 5) == 2)? \ 637 (__HANDLE__)->Instance->CR2 : (__HANDLE__)->Instance->CR3)) & ((uint32_t)1 << \ 638 (((uint16_t)(__IT__)) & SMARTCARD_IT_MASK))) 639 640 641 /** @brief Clears the specified SMARTCARD ISR flag, in setting the proper ICR register flag. 642 * @param __HANDLE__: specifies the SMARTCARD Handle. 643 * The Handle Instance which can be USART1 or USART2. 644 * @param __IT_CLEAR__: specifies the interrupt clear register flag that needs to be set 645 * to clear the corresponding interrupt 646 * This parameter can be one of the following values: 647 * @arg USART_CLEAR_PEF: Parity Error Clear Flag 648 * @arg USART_CLEAR_FEF: Framing Error Clear Flag 649 * @arg USART_CLEAR_NEF: Noise detected Clear Flag 650 * @arg USART_CLEAR_OREF: OverRun Error Clear Flag 651 * @arg USART_CLEAR_TCF: Transmission Complete Clear Flag 652 * @arg USART_CLEAR_RTOF: Receiver Time Out Clear Flag 653 * @arg USART_CLEAR_EOBF: End Of Block Clear Flag 654 * @retval None 655 */ 656 #define __HAL_SMARTCARD_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__)) 657 658 /** @brief Set a specific SMARTCARD request flag. 659 * @param __HANDLE__: specifies the SMARTCARD Handle. 660 * The Handle Instance which can be USART1 or USART2. 661 * @param __REQ__: specifies the request flag to set 662 * This parameter can be one of the following values: 663 * @arg SMARTCARD_RXDATA_FLUSH_REQUEST: Receive Data flush Request 664 * @arg SMARTCARD_TXDATA_FLUSH_REQUEST: Transmit data flush Request 665 * 666 * @retval None 667 */ 668 #define __HAL_SMARTCARD_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint32_t)(__REQ__)) 669 670 /** @brief Enable the USART associated to the SMARTCARD Handle 671 * @param __HANDLE__: specifies the SMARTCARD Handle. 672 * The Handle Instance which can be USART1 or USART2. 673 * @retval None 674 */ 675 #define __HAL_SMARTCARD_ENABLE(__HANDLE__) ( (__HANDLE__)->Instance->CR1 |= USART_CR1_UE) 676 677 /** @brief Disable the USART associated to the SMARTCARD Handle 678 * @param __HANDLE__: specifies the SMARTCARD Handle. 679 * The Handle Instance which can be USART1 or USART2. 680 * @retval None 681 */ 682 #define __HAL_SMARTCARD_DISABLE(__HANDLE__) ( (__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE) 683 684 /** @brief Macros to enable or disable the SmartCard DMA request. 685 * @param __HANDLE__: specifies the SMARTCARD Handle. 686 * The Handle Instance which can be USART1 or USART2. 687 * @param __REQUEST__: specifies the SmartCard DMA request. 688 * This parameter can be one of the following values: 689 * @arg SMARTCARD_DMAREQ_TX: SmartCard DMA transmit request 690 * @arg SMARTCARD_DMAREQ_RX: SmartCard DMA receive request 691 */ 692 #define __HAL_SMARTCARD_DMA_REQUEST_ENABLE(__HANDLE__, __REQUEST__) ((__HANDLE__)->Instance->CR3 |= (__REQUEST__)) 693 #define __HAL_SMARTCARD_DMA_REQUEST_DISABLE(__HANDLE__, __REQUEST__) ((__HANDLE__)->Instance->CR3 &= ~(__REQUEST__)) 694 /** 695 * @} 696 */ 697 698 /* Include SMARTCARD HAL Extension module */ 699 #include "stm32f7xx_hal_smartcard_ex.h" 700 /* Exported functions --------------------------------------------------------*/ 701 /** @addtogroup SMARTCARD_Exported_Functions 702 * @{ 703 */ 704 705 /** @addtogroup SMARTCARD_Exported_Functions_Group1 706 * @{ 707 */ 708 /* Initialization/de-initialization functions **********************************/ 709 HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsc); 710 HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsc); 711 void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsc); 712 void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsc); 713 /** 714 * @} 715 */ 716 717 /** @addtogroup SMARTCARD_Exported_Functions_Group2 718 * @{ 719 */ 720 /* IO operation functions *******************************************************/ 721 HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size, uint32_t Timeout); 722 HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size, uint32_t Timeout); 723 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size); 724 HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size); 725 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size); 726 HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size); 727 void HAL_SMARTCARD_IRQHandler(SMARTCARD_HandleTypeDef *hsc); 728 void HAL_SMARTCARD_TxCpltCallback(SMARTCARD_HandleTypeDef *hsc); 729 void HAL_SMARTCARD_RxCpltCallback(SMARTCARD_HandleTypeDef *hsc); 730 void HAL_SMARTCARD_ErrorCallback(SMARTCARD_HandleTypeDef *hsc); 731 /** 732 * @} 733 */ 734 735 /** @addtogroup SMARTCARD_Exported_Functions_Group3 736 * @{ 737 */ 738 /* Peripheral State functions **************************************************/ 739 HAL_SMARTCARD_StateTypeDef HAL_SMARTCARD_GetState(SMARTCARD_HandleTypeDef *hsc); 740 uint32_t HAL_SMARTCARD_GetError(SMARTCARD_HandleTypeDef *hsc); 741 742 /** 743 * @} 744 */ 745 746 /** 747 * @} 748 */ 749 /* Private types -------------------------------------------------------------*/ 750 /* Private variables ---------------------------------------------------------*/ 751 /* Private constants ---------------------------------------------------------*/ 752 /** @defgroup SMARTCARD_Private_Constants SMARTCARD Private Constants 753 * @{ 754 */ 755 756 #define IS_SMARTCARD_WORD_LENGTH(__LENGTH__) ((__LENGTH__) == SMARTCARD_WORDLENGTH_9B) 757 #define IS_SMARTCARD_STOPBITS(__STOPBITS__) ((__STOPBITS__) == SMARTCARD_STOPBITS_1_5) 758 #define IS_SMARTCARD_PARITY(__PARITY__) (((__PARITY__) == SMARTCARD_PARITY_EVEN) || \ 759 ((__PARITY__) == SMARTCARD_PARITY_ODD)) 760 #define IS_SMARTCARD_MODE(__MODE__) ((((__MODE__) & (uint32_t)0xFFF3) == 0x00) && ((__MODE__) != (uint32_t)0x00)) 761 #define IS_SMARTCARD_POLARITY(__CPOL__) (((__CPOL__) == SMARTCARD_POLARITY_LOW) || ((__CPOL__) == SMARTCARD_POLARITY_HIGH)) 762 #define IS_SMARTCARD_PHASE(__CPHA__) (((__CPHA__) == SMARTCARD_PHASE_1EDGE) || ((__CPHA__) == SMARTCARD_PHASE_2EDGE)) 763 #define IS_SMARTCARD_LASTBIT(__LASTBIT__) (((__LASTBIT__) == SMARTCARD_LASTBIT_DISABLE) || \ 764 ((__LASTBIT__) == SMARTCARD_LASTBIT_ENABLE)) 765 #define IS_SMARTCARD_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_DISABLE) || \ 766 ((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_ENABLE)) 767 #define IS_SMARTCARD_NACK(__NACK__) (((__NACK__) == SMARTCARD_NACK_ENABLE) || \ 768 ((__NACK__) == SMARTCARD_NACK_DISABLE)) 769 #define IS_SMARTCARD_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == SMARTCARD_TIMEOUT_DISABLE) || \ 770 ((__TIMEOUT__) == SMARTCARD_TIMEOUT_ENABLE)) 771 #define IS_SMARTCARD_ADVFEATURE_INIT(INIT) ((INIT) <= (SMARTCARD_ADVFEATURE_NO_INIT | \ 772 SMARTCARD_ADVFEATURE_TXINVERT_INIT | \ 773 SMARTCARD_ADVFEATURE_RXINVERT_INIT | \ 774 SMARTCARD_ADVFEATURE_DATAINVERT_INIT | \ 775 SMARTCARD_ADVFEATURE_SWAP_INIT | \ 776 SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT | \ 777 SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT | \ 778 SMARTCARD_ADVFEATURE_MSBFIRST_INIT)) 779 #define IS_SMARTCARD_ADVFEATURE_TXINV(TXINV) (((TXINV) == SMARTCARD_ADVFEATURE_TXINV_DISABLE) || \ 780 ((TXINV) == SMARTCARD_ADVFEATURE_TXINV_ENABLE)) 781 #define IS_SMARTCARD_ADVFEATURE_RXINV(RXINV) (((RXINV) == SMARTCARD_ADVFEATURE_RXINV_DISABLE) || \ 782 ((RXINV) == SMARTCARD_ADVFEATURE_RXINV_ENABLE)) 783 #define IS_SMARTCARD_ADVFEATURE_DATAINV(DATAINV) (((DATAINV) == SMARTCARD_ADVFEATURE_DATAINV_DISABLE) || \ 784 ((DATAINV) == SMARTCARD_ADVFEATURE_DATAINV_ENABLE)) 785 #define IS_SMARTCARD_ADVFEATURE_SWAP(SWAP) (((SWAP) == SMARTCARD_ADVFEATURE_SWAP_DISABLE) || \ 786 ((SWAP) == SMARTCARD_ADVFEATURE_SWAP_ENABLE)) 787 #define IS_SMARTCARD_OVERRUN(OVERRUN) (((OVERRUN) == SMARTCARD_ADVFEATURE_OVERRUN_ENABLE) || \ 788 ((OVERRUN) == SMARTCARD_ADVFEATURE_OVERRUN_DISABLE)) 789 #define IS_SMARTCARD_ADVFEATURE_DMAONRXERROR(DMA) (((DMA) == SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR) || \ 790 ((DMA) == SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR)) 791 #define IS_SMARTCARD_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 4500001) 792 #define IS_SMARTCARD_BLOCKLENGTH(__LENGTH__) ((__LENGTH__) <= 0xFF) 793 #define IS_SMARTCARD_TIMEOUT_VALUE(__TIMEOUTVALUE__) ((__TIMEOUTVALUE__) <= 0xFFFFFF) 794 #define IS_SMARTCARD_AUTORETRY_COUNT(__COUNT__) ((__COUNT__) <= 0x7) 795 #define IS_SMARTCARD_ADVFEATURE_MSBFIRST(MSBFIRST) (((MSBFIRST) == SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE) || \ 796 ((MSBFIRST) == SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE)) 797 #define IS_SMARTCARD_REQUEST_PARAMETER(PARAM) (((PARAM) == SMARTCARD_RXDATA_FLUSH_REQUEST) || \ 798 ((PARAM) == SMARTCARD_TXDATA_FLUSH_REQUEST)) 799 800 801 /** 802 * @} 803 */ 804 805 /* Private functions ---------------------------------------------------------*/ 806 /** @defgroup SMARTCARD_Private_Functions SMARTCARD Private Functions 807 * @{ 808 */ 809 810 /** 811 * @} 812 */ 813 814 /** 815 * @} 816 */ 817 818 /** 819 * @} 820 */ 821 822 #ifdef __cplusplus 823 } 824 #endif 825 826 #endif /* __STM32F7xx_HAL_SMARTCARD_H */ 827 828 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 829