STM32H735xx HAL User Manual
stm32h7xx_hal_smartcard.h
Go to the documentation of this file.
00001 /**
00002   ******************************************************************************
00003   * @file    stm32h7xx_hal_smartcard.h
00004   * @author  MCD Application Team
00005   * @brief   Header file of SMARTCARD HAL module.
00006   ******************************************************************************
00007   * @attention
00008   *
00009   * Copyright (c) 2017 STMicroelectronics.
00010   * All rights reserved.
00011   *
00012   * This software is licensed under terms that can be found in the LICENSE file
00013   * in the root directory of this software component.
00014   * If no LICENSE file comes with this software, it is provided AS-IS.
00015   *
00016   ******************************************************************************
00017   */
00018 
00019 /* Define to prevent recursive inclusion -------------------------------------*/
00020 #ifndef STM32H7xx_HAL_SMARTCARD_H
00021 #define STM32H7xx_HAL_SMARTCARD_H
00022 
00023 #ifdef __cplusplus
00024 extern "C" {
00025 #endif
00026 
00027 /* Includes ------------------------------------------------------------------*/
00028 #include "stm32h7xx_hal_def.h"
00029 
00030 /** @addtogroup STM32H7xx_HAL_Driver
00031   * @{
00032   */
00033 
00034 /** @addtogroup SMARTCARD
00035   * @{
00036   */
00037 
00038 /* Exported types ------------------------------------------------------------*/
00039 /** @defgroup SMARTCARD_Exported_Types SMARTCARD Exported Types
00040   * @{
00041   */
00042 
00043 /**
00044   * @brief SMARTCARD Init Structure definition
00045   */
00046 typedef struct
00047 {
00048   uint32_t BaudRate;                  /*!< Configures the SmartCard communication baud rate.
00049                                            The baud rate register is computed using the following formula:
00050                                               Baud Rate Register = ((usart_ker_ckpres) / ((hsmartcard->Init.BaudRate)))
00051                                            where usart_ker_ckpres is the USART input clock divided by a prescaler */
00052 
00053   uint32_t WordLength;                /*!< Specifies the number of data bits transmitted or received in a frame.
00054                                            This parameter @ref SMARTCARD_Word_Length can only be
00055                                            set to 9 (8 data + 1 parity bits). */
00056 
00057   uint32_t StopBits;                  /*!< Specifies the number of stop bits.
00058                                            This parameter can be a value of @ref SMARTCARD_Stop_Bits. */
00059 
00060   uint16_t Parity;                    /*!< Specifies the parity mode.
00061                                            This parameter can be a value of @ref SMARTCARD_Parity
00062                                            @note The parity is enabled by default (PCE is forced to 1).
00063                                                  Since the WordLength is forced to 8 bits + parity, M is
00064                                                  forced to 1 and the parity bit is the 9th bit. */
00065 
00066   uint16_t Mode;                      /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
00067                                            This parameter can be a value of @ref SMARTCARD_Mode */
00068 
00069   uint16_t CLKPolarity;               /*!< Specifies the steady state of the serial clock.
00070                                            This parameter can be a value of @ref SMARTCARD_Clock_Polarity */
00071 
00072   uint16_t CLKPhase;                  /*!< Specifies the clock transition on which the bit capture is made.
00073                                            This parameter can be a value of @ref SMARTCARD_Clock_Phase */
00074 
00075   uint16_t CLKLastBit;                /*!< Specifies whether the clock pulse corresponding to the last transmitted
00076                                            data bit (MSB) has to be output on the SCLK pin in synchronous mode.
00077                                            This parameter can be a value of @ref SMARTCARD_Last_Bit */
00078 
00079   uint16_t OneBitSampling;            /*!< Specifies whether a single sample or three samples' majority vote
00080                                            is selected. Selecting the single sample method increases
00081                                            the receiver tolerance to clock deviations. This parameter can be a value
00082                                            of @ref SMARTCARD_OneBit_Sampling. */
00083 
00084   uint8_t  Prescaler;                 /*!< Specifies the SmartCard Prescaler.
00085                                            This parameter can be any value from 0x01 to 0x1F. Prescaler value is
00086                                            multiplied by 2 to give the division factor of the source clock frequency */
00087 
00088   uint8_t  GuardTime;                 /*!< Specifies the SmartCard Guard Time applied after stop bits. */
00089 
00090   uint16_t NACKEnable;                /*!< Specifies whether the SmartCard NACK transmission is enabled
00091                                            in case of parity error.
00092                                            This parameter can be a value of @ref SMARTCARD_NACK_Enable */
00093 
00094   uint32_t TimeOutEnable;             /*!< Specifies whether the receiver timeout is enabled.
00095                                             This parameter can be a value of @ref SMARTCARD_Timeout_Enable*/
00096 
00097   uint32_t TimeOutValue;              /*!< Specifies the receiver time out value in number of baud blocks:
00098                                            it is used to implement the Character Wait Time (CWT) and
00099                                            Block Wait Time (BWT). It is coded over 24 bits. */
00100 
00101   uint8_t BlockLength;                /*!< Specifies the SmartCard Block Length in T=1 Reception mode.
00102                                            This parameter can be any value from 0x0 to 0xFF */
00103 
00104   uint8_t AutoRetryCount;             /*!< Specifies the SmartCard auto-retry count (number of retries in
00105                                             receive and transmit mode). When set to 0, retransmission is
00106                                             disabled. Otherwise, its maximum value is 7 (before signalling
00107                                             an error) */
00108 
00109   uint32_t ClockPrescaler;            /*!< Specifies the prescaler value used to divide the USART clock source.
00110                                            This parameter can be a value of @ref SMARTCARD_ClockPrescaler. */
00111 
00112 } SMARTCARD_InitTypeDef;
00113 
00114 /**
00115   * @brief  SMARTCARD advanced features initialization structure definition
00116   */
00117 typedef struct
00118 {
00119   uint32_t AdvFeatureInit;            /*!< Specifies which advanced SMARTCARD features is initialized. Several
00120                                            advanced features may be initialized at the same time. This parameter
00121                                            can be a value of @ref SMARTCARDEx_Advanced_Features_Initialization_Type */
00122 
00123   uint32_t TxPinLevelInvert;          /*!< Specifies whether the TX pin active level is inverted.
00124                                            This parameter can be a value of @ref SMARTCARD_Tx_Inv  */
00125 
00126   uint32_t RxPinLevelInvert;          /*!< Specifies whether the RX pin active level is inverted.
00127                                            This parameter can be a value of @ref SMARTCARD_Rx_Inv  */
00128 
00129   uint32_t DataInvert;                /*!< Specifies whether data are inverted (positive/direct logic
00130                                            vs negative/inverted logic).
00131                                            This parameter can be a value of @ref SMARTCARD_Data_Inv */
00132 
00133   uint32_t Swap;                      /*!< Specifies whether TX and RX pins are swapped.
00134                                            This parameter can be a value of @ref SMARTCARD_Rx_Tx_Swap */
00135 
00136   uint32_t OverrunDisable;            /*!< Specifies whether the reception overrun detection is disabled.
00137                                            This parameter can be a value of @ref SMARTCARD_Overrun_Disable */
00138 
00139   uint32_t DMADisableonRxError;       /*!< Specifies whether the DMA is disabled in case of reception error.
00140                                            This parameter can be a value of @ref SMARTCARD_DMA_Disable_on_Rx_Error */
00141 
00142   uint32_t MSBFirst;                  /*!< Specifies whether MSB is sent first on UART line.
00143                                            This parameter can be a value of @ref SMARTCARD_MSB_First */
00144 
00145   uint16_t TxCompletionIndication;    /*!< Specifies which transmission completion indication is used: before (when
00146                                            relevant flag is available) or once guard time period has elapsed.
00147                                            This parameter can be a value
00148                                            of @ref SMARTCARDEx_Transmission_Completion_Indication. */
00149 } SMARTCARD_AdvFeatureInitTypeDef;
00150 
00151 /**
00152   * @brief HAL SMARTCARD State definition
00153   * @note  HAL SMARTCARD State value is a combination of 2 different substates:
00154   *        gState and RxState (see @ref SMARTCARD_State_Definition).
00155   *        - gState contains SMARTCARD state information related to global Handle management
00156   *          and also information related to Tx operations.
00157   *          gState value coding follow below described bitmap :
00158   *          b7-b6  Error information
00159   *             00 : No Error
00160   *             01 : (Not Used)
00161   *             10 : Timeout
00162   *             11 : Error
00163   *          b5     Peripheral initialization status
00164   *             0  : Reset (Peripheral not initialized)
00165   *             1  : Init done (Peripheral initialized. HAL SMARTCARD Init function already called)
00166   *          b4-b3  (not used)
00167   *             xx : Should be set to 00
00168   *          b2     Intrinsic process state
00169   *             0  : Ready
00170   *             1  : Busy (Peripheral busy with some configuration or internal operations)
00171   *          b1     (not used)
00172   *             x  : Should be set to 0
00173   *          b0     Tx state
00174   *             0  : Ready (no Tx operation ongoing)
00175   *             1  : Busy (Tx operation ongoing)
00176   *        - RxState contains information related to Rx operations.
00177   *          RxState value coding follow below described bitmap :
00178   *          b7-b6  (not used)
00179   *             xx : Should be set to 00
00180   *          b5     Peripheral initialization status
00181   *             0  : Reset (Peripheral not initialized)
00182   *             1  : Init done (Peripheral initialized)
00183   *          b4-b2  (not used)
00184   *            xxx : Should be set to 000
00185   *          b1     Rx state
00186   *             0  : Ready (no Rx operation ongoing)
00187   *             1  : Busy (Rx operation ongoing)
00188   *          b0     (not used)
00189   *             x  : Should be set to 0.
00190   */
00191 typedef uint32_t HAL_SMARTCARD_StateTypeDef;
00192 
00193 /**
00194   * @brief  SMARTCARD handle Structure definition
00195   */
00196 typedef struct __SMARTCARD_HandleTypeDef
00197 {
00198   USART_TypeDef                     *Instance;             /*!< USART registers base address                          */
00199 
00200   SMARTCARD_InitTypeDef             Init;                  /*!< SmartCard communication parameters                    */
00201 
00202   SMARTCARD_AdvFeatureInitTypeDef   AdvancedInit;          /*!< SmartCard advanced features initialization parameters */
00203 
00204   const uint8_t                     *pTxBuffPtr;           /*!< Pointer to SmartCard Tx transfer Buffer               */
00205 
00206   uint16_t                          TxXferSize;            /*!< SmartCard Tx Transfer size                            */
00207 
00208   __IO uint16_t                     TxXferCount;           /*!< SmartCard Tx Transfer Counter                         */
00209 
00210   uint8_t                           *pRxBuffPtr;           /*!< Pointer to SmartCard Rx transfer Buffer               */
00211 
00212   uint16_t                          RxXferSize;            /*!< SmartCard Rx Transfer size                            */
00213 
00214   __IO uint16_t                     RxXferCount;           /*!< SmartCard Rx Transfer Counter                         */
00215 
00216   uint16_t                          NbRxDataToProcess;     /*!< Number of data to process during RX ISR execution     */
00217 
00218   uint16_t                          NbTxDataToProcess;     /*!< Number of data to process during TX ISR execution     */
00219 
00220   uint32_t                          FifoMode;              /*!< Specifies if the FIFO mode will be used.
00221                                                                 This parameter can be a value of
00222                                                                 @ref SMARTCARDEx_FIFO_mode.                           */
00223 
00224   void (*RxISR)(struct __SMARTCARD_HandleTypeDef *huart);  /*!< Function pointer on Rx IRQ handler                    */
00225 
00226   void (*TxISR)(struct __SMARTCARD_HandleTypeDef *huart);  /*!< Function pointer on Tx IRQ handler                    */
00227 
00228   DMA_HandleTypeDef                 *hdmatx;               /*!< SmartCard Tx DMA Handle parameters                    */
00229 
00230   DMA_HandleTypeDef                 *hdmarx;               /*!< SmartCard Rx DMA Handle parameters                    */
00231 
00232   HAL_LockTypeDef                   Lock;                  /*!< Locking object                                        */
00233 
00234   __IO HAL_SMARTCARD_StateTypeDef   gState;                /*!< SmartCard state information related to global
00235                                                                 Handle management and also related to Tx operations.
00236                                                                 This parameter can be a value
00237                                                                 of @ref HAL_SMARTCARD_StateTypeDef                    */
00238 
00239   __IO HAL_SMARTCARD_StateTypeDef   RxState;               /*!< SmartCard state information related to Rx operations.
00240                                                                 This parameter can be a value
00241                                                                 of @ref HAL_SMARTCARD_StateTypeDef                    */
00242 
00243   __IO uint32_t                     ErrorCode;             /*!< SmartCard Error code                                  */
00244 
00245 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)
00246   void (* TxCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard);            /*!< SMARTCARD Tx Complete Callback             */
00247 
00248   void (* RxCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard);            /*!< SMARTCARD Rx Complete Callback             */
00249 
00250   void (* ErrorCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard);             /*!< SMARTCARD Error Callback                   */
00251 
00252   void (* AbortCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard);         /*!< SMARTCARD Abort Complete Callback          */
00253 
00254   void (* AbortTransmitCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Transmit Complete Callback */
00255 
00256   void (* AbortReceiveCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard);  /*!< SMARTCARD Abort Receive Complete Callback  */
00257 
00258   void (* RxFifoFullCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard);        /*!< SMARTCARD Rx Fifo Full Callback            */
00259 
00260   void (* TxFifoEmptyCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard);       /*!< SMARTCARD Tx Fifo Empty Callback           */
00261 
00262   void (* MspInitCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard);           /*!< SMARTCARD Msp Init callback                */
00263 
00264   void (* MspDeInitCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard);         /*!< SMARTCARD Msp DeInit callback              */
00265 #endif  /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
00266 
00267 } SMARTCARD_HandleTypeDef;
00268 
00269 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)
00270 /**
00271   * @brief  HAL SMARTCARD Callback ID enumeration definition
00272   */
00273 typedef enum
00274 {
00275   HAL_SMARTCARD_TX_COMPLETE_CB_ID             = 0x00U,    /*!< SMARTCARD Tx Complete Callback ID             */
00276   HAL_SMARTCARD_RX_COMPLETE_CB_ID             = 0x01U,    /*!< SMARTCARD Rx Complete Callback ID             */
00277   HAL_SMARTCARD_ERROR_CB_ID                   = 0x02U,    /*!< SMARTCARD Error Callback ID                   */
00278   HAL_SMARTCARD_ABORT_COMPLETE_CB_ID          = 0x03U,    /*!< SMARTCARD Abort Complete Callback ID          */
00279   HAL_SMARTCARD_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x04U,    /*!< SMARTCARD Abort Transmit Complete Callback ID */
00280   HAL_SMARTCARD_ABORT_RECEIVE_COMPLETE_CB_ID  = 0x05U,    /*!< SMARTCARD Abort Receive Complete Callback ID  */
00281   HAL_SMARTCARD_RX_FIFO_FULL_CB_ID            = 0x06U,    /*!< SMARTCARD Rx Fifo Full Callback ID            */
00282   HAL_SMARTCARD_TX_FIFO_EMPTY_CB_ID           = 0x07U,    /*!< SMARTCARD Tx Fifo Empty Callback ID           */
00283 
00284   HAL_SMARTCARD_MSPINIT_CB_ID                 = 0x08U,    /*!< SMARTCARD MspInit callback ID                 */
00285   HAL_SMARTCARD_MSPDEINIT_CB_ID               = 0x09U     /*!< SMARTCARD MspDeInit callback ID               */
00286 
00287 } HAL_SMARTCARD_CallbackIDTypeDef;
00288 
00289 /**
00290   * @brief  HAL SMARTCARD Callback pointer definition
00291   */
00292 typedef  void (*pSMARTCARD_CallbackTypeDef)(SMARTCARD_HandleTypeDef *hsmartcard);  /*!< pointer to an SMARTCARD callback function */
00293 
00294 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
00295 
00296 /**
00297   * @brief  SMARTCARD clock sources
00298   */
00299 typedef enum
00300 {
00301   SMARTCARD_CLOCKSOURCE_D2PCLK1   = 0x00U, /*!< Domain2 PCLK1 clock source */
00302   SMARTCARD_CLOCKSOURCE_D2PCLK2   = 0x01U, /*!< Domain2 PCLK2 clock source */
00303   SMARTCARD_CLOCKSOURCE_HSI       = 0x04U, /*!< HSI clock source           */
00304   SMARTCARD_CLOCKSOURCE_CSI       = 0x08U, /*!< CSI clock source           */
00305   SMARTCARD_CLOCKSOURCE_LSE       = 0x20U, /*!< LSE clock source           */
00306   SMARTCARD_CLOCKSOURCE_PLL2Q     = 0x40U, /*!< PLL2Q clock source         */
00307   SMARTCARD_CLOCKSOURCE_PLL3Q     = 0x80U, /*!< PLL3Q clock source         */
00308   SMARTCARD_CLOCKSOURCE_UNDEFINED = 0x10U  /*!< undefined clock source     */
00309 } SMARTCARD_ClockSourceTypeDef;
00310 
00311 /**
00312   * @}
00313   */
00314 
00315 /* Exported constants --------------------------------------------------------*/
00316 /** @defgroup SMARTCARD_Exported_Constants  SMARTCARD Exported Constants
00317   * @{
00318   */
00319 
00320 /** @defgroup SMARTCARD_State_Definition SMARTCARD State Code Definition
00321   * @{
00322   */
00323 #define HAL_SMARTCARD_STATE_RESET            0x00000000U                     /*!< Peripheral is not initialized. Value
00324                                                                                   is allowed for gState and RxState */
00325 #define HAL_SMARTCARD_STATE_READY            0x00000020U                     /*!< Peripheral Initialized and ready for
00326                                                                                   use. Value is allowed for gState
00327                                                                                   and RxState                       */
00328 #define HAL_SMARTCARD_STATE_BUSY             0x00000024U                     /*!< an internal process is ongoing
00329                                                                                   Value is allowed for gState only  */
00330 #define HAL_SMARTCARD_STATE_BUSY_TX          0x00000021U                     /*!< Data Transmission process is ongoing
00331                                                                                   Value is allowed for gState only  */
00332 #define HAL_SMARTCARD_STATE_BUSY_RX          0x00000022U                     /*!< Data Reception process is ongoing
00333                                                                                   Value is allowed for RxState only */
00334 #define HAL_SMARTCARD_STATE_BUSY_TX_RX       0x00000023U                     /*!< Data Transmission and Reception
00335                                                                                   process is ongoing Not to be used for
00336                                                                                   neither gState nor RxState.
00337                                                                                   Value is result of combination (Or)
00338                                                                                   between gState and RxState values */
00339 #define HAL_SMARTCARD_STATE_TIMEOUT          0x000000A0U                     /*!< Timeout state
00340                                                                                   Value is allowed for gState only  */
00341 #define HAL_SMARTCARD_STATE_ERROR            0x000000E0U                     /*!< Error
00342                                                                                   Value is allowed for gState only  */
00343 /**
00344   * @}
00345   */
00346 
00347 /** @defgroup SMARTCARD_Error_Definition SMARTCARD Error Code Definition
00348   * @{
00349   */
00350 #define HAL_SMARTCARD_ERROR_NONE             (0x00000000U)         /*!< No error                */
00351 #define HAL_SMARTCARD_ERROR_PE               (0x00000001U)         /*!< Parity error            */
00352 #define HAL_SMARTCARD_ERROR_NE               (0x00000002U)         /*!< Noise error             */
00353 #define HAL_SMARTCARD_ERROR_FE               (0x00000004U)         /*!< frame error             */
00354 #define HAL_SMARTCARD_ERROR_ORE              (0x00000008U)         /*!< Overrun error           */
00355 #define HAL_SMARTCARD_ERROR_DMA              (0x00000010U)         /*!< DMA transfer error      */
00356 #define HAL_SMARTCARD_ERROR_RTO              (0x00000020U)         /*!< Receiver TimeOut error  */
00357 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)
00358 #define HAL_SMARTCARD_ERROR_INVALID_CALLBACK (0x00000040U)         /*!< Invalid Callback error  */
00359 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
00360 /**
00361   * @}
00362   */
00363 
00364 /** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length
00365   * @{
00366   */
00367 #define SMARTCARD_WORDLENGTH_9B             USART_CR1_M0                    /*!< SMARTCARD frame length */
00368 /**
00369   * @}
00370   */
00371 
00372 /** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits
00373   * @{
00374   */
00375 #define SMARTCARD_STOPBITS_0_5              USART_CR2_STOP_0                /*!< SMARTCARD frame with 0.5 stop bit  */
00376 #define SMARTCARD_STOPBITS_1_5              USART_CR2_STOP                  /*!< SMARTCARD frame with 1.5 stop bits */
00377 /**
00378   * @}
00379   */
00380 
00381 /** @defgroup SMARTCARD_Parity SMARTCARD Parity
00382   * @{
00383   */
00384 #define SMARTCARD_PARITY_EVEN               USART_CR1_PCE                   /*!< SMARTCARD frame even parity */
00385 #define SMARTCARD_PARITY_ODD                (USART_CR1_PCE | USART_CR1_PS)  /*!< SMARTCARD frame odd parity  */
00386 /**
00387   * @}
00388   */
00389 
00390 /** @defgroup SMARTCARD_Mode SMARTCARD Transfer Mode
00391   * @{
00392   */
00393 #define SMARTCARD_MODE_RX                   USART_CR1_RE                    /*!< SMARTCARD RX mode        */
00394 #define SMARTCARD_MODE_TX                   USART_CR1_TE                    /*!< SMARTCARD TX mode        */
00395 #define SMARTCARD_MODE_TX_RX                (USART_CR1_TE |USART_CR1_RE)    /*!< SMARTCARD RX and TX mode */
00396 /**
00397   * @}
00398   */
00399 
00400 /** @defgroup SMARTCARD_Clock_Polarity SMARTCARD Clock Polarity
00401   * @{
00402   */
00403 #define SMARTCARD_POLARITY_LOW              0x00000000U                     /*!< SMARTCARD frame low polarity  */
00404 #define SMARTCARD_POLARITY_HIGH             USART_CR2_CPOL                  /*!< SMARTCARD frame high polarity */
00405 /**
00406   * @}
00407   */
00408 
00409 /** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase
00410   * @{
00411   */
00412 #define SMARTCARD_PHASE_1EDGE               0x00000000U                     /*!< SMARTCARD frame phase on first clock transition  */
00413 #define SMARTCARD_PHASE_2EDGE               USART_CR2_CPHA                  /*!< SMARTCARD frame phase on second clock transition */
00414 /**
00415   * @}
00416   */
00417 
00418 /** @defgroup SMARTCARD_Last_Bit SMARTCARD Last Bit
00419   * @{
00420   */
00421 #define SMARTCARD_LASTBIT_DISABLE           0x00000000U                     /*!< SMARTCARD frame last data bit clock pulse not output to SCLK pin */
00422 #define SMARTCARD_LASTBIT_ENABLE            USART_CR2_LBCL                  /*!< SMARTCARD frame last data bit clock pulse output to SCLK pin     */
00423 /**
00424   * @}
00425   */
00426 
00427 /** @defgroup SMARTCARD_OneBit_Sampling SMARTCARD One Bit Sampling Method
00428   * @{
00429   */
00430 #define SMARTCARD_ONE_BIT_SAMPLE_DISABLE    0x00000000U                     /*!< SMARTCARD frame one-bit sample disabled */
00431 #define SMARTCARD_ONE_BIT_SAMPLE_ENABLE     USART_CR3_ONEBIT                /*!< SMARTCARD frame one-bit sample enabled  */
00432 /**
00433   * @}
00434   */
00435 
00436 /** @defgroup SMARTCARD_NACK_Enable SMARTCARD NACK Enable
00437   * @{
00438   */
00439 #define SMARTCARD_NACK_DISABLE              0x00000000U                     /*!< SMARTCARD NACK transmission disabled  */
00440 #define SMARTCARD_NACK_ENABLE               USART_CR3_NACK                  /*!< SMARTCARD NACK transmission enabled */
00441 /**
00442   * @}
00443   */
00444 
00445 /** @defgroup SMARTCARD_Timeout_Enable SMARTCARD Timeout Enable
00446   * @{
00447   */
00448 #define SMARTCARD_TIMEOUT_DISABLE           0x00000000U                     /*!< SMARTCARD receiver timeout disabled */
00449 #define SMARTCARD_TIMEOUT_ENABLE            USART_CR2_RTOEN                 /*!< SMARTCARD receiver timeout enabled  */
00450 /**
00451   * @}
00452   */
00453 
00454 /** @defgroup SMARTCARD_ClockPrescaler  SMARTCARD Clock Prescaler
00455   * @{
00456   */
00457 #define SMARTCARD_PRESCALER_DIV1    0x00000000U  /*!< fclk_pres = fclk     */
00458 #define SMARTCARD_PRESCALER_DIV2    0x00000001U  /*!< fclk_pres = fclk/2   */
00459 #define SMARTCARD_PRESCALER_DIV4    0x00000002U  /*!< fclk_pres = fclk/4   */
00460 #define SMARTCARD_PRESCALER_DIV6    0x00000003U  /*!< fclk_pres = fclk/6   */
00461 #define SMARTCARD_PRESCALER_DIV8    0x00000004U  /*!< fclk_pres = fclk/8   */
00462 #define SMARTCARD_PRESCALER_DIV10   0x00000005U  /*!< fclk_pres = fclk/10  */
00463 #define SMARTCARD_PRESCALER_DIV12   0x00000006U  /*!< fclk_pres = fclk/12  */
00464 #define SMARTCARD_PRESCALER_DIV16   0x00000007U  /*!< fclk_pres = fclk/16  */
00465 #define SMARTCARD_PRESCALER_DIV32   0x00000008U  /*!< fclk_pres = fclk/32  */
00466 #define SMARTCARD_PRESCALER_DIV64   0x00000009U  /*!< fclk_pres = fclk/64  */
00467 #define SMARTCARD_PRESCALER_DIV128  0x0000000AU  /*!< fclk_pres = fclk/128 */
00468 #define SMARTCARD_PRESCALER_DIV256  0x0000000BU  /*!< fclk_pres = fclk/256 */
00469 /**
00470   * @}
00471   */
00472 
00473 /** @defgroup SMARTCARD_Tx_Inv SMARTCARD advanced feature TX pin active level inversion
00474   * @{
00475   */
00476 #define SMARTCARD_ADVFEATURE_TXINV_DISABLE  0x00000000U                  /*!< TX pin active level inversion disable */
00477 #define SMARTCARD_ADVFEATURE_TXINV_ENABLE   USART_CR2_TXINV              /*!< TX pin active level inversion enable  */
00478 /**
00479   * @}
00480   */
00481 
00482 /** @defgroup SMARTCARD_Rx_Inv SMARTCARD advanced feature RX pin active level inversion
00483   * @{
00484   */
00485 #define SMARTCARD_ADVFEATURE_RXINV_DISABLE  0x00000000U                  /*!< RX pin active level inversion disable */
00486 #define SMARTCARD_ADVFEATURE_RXINV_ENABLE   USART_CR2_RXINV              /*!< RX pin active level inversion enable  */
00487 /**
00488   * @}
00489   */
00490 
00491 /** @defgroup SMARTCARD_Data_Inv SMARTCARD advanced feature Binary Data inversion
00492   * @{
00493   */
00494 #define SMARTCARD_ADVFEATURE_DATAINV_DISABLE  0x00000000U                /*!< Binary data inversion disable */
00495 #define SMARTCARD_ADVFEATURE_DATAINV_ENABLE   USART_CR2_DATAINV          /*!< Binary data inversion enable  */
00496 /**
00497   * @}
00498   */
00499 
00500 /** @defgroup SMARTCARD_Rx_Tx_Swap SMARTCARD advanced feature RX TX pins swap
00501   * @{
00502   */
00503 #define SMARTCARD_ADVFEATURE_SWAP_DISABLE   0x00000000U                  /*!< TX/RX pins swap disable */
00504 #define SMARTCARD_ADVFEATURE_SWAP_ENABLE    USART_CR2_SWAP               /*!< TX/RX pins swap enable  */
00505 /**
00506   * @}
00507   */
00508 
00509 /** @defgroup SMARTCARD_Overrun_Disable SMARTCARD advanced feature Overrun Disable
00510   * @{
00511   */
00512 #define SMARTCARD_ADVFEATURE_OVERRUN_ENABLE   0x00000000U                /*!< RX overrun enable  */
00513 #define SMARTCARD_ADVFEATURE_OVERRUN_DISABLE  USART_CR3_OVRDIS           /*!< RX overrun disable */
00514 /**
00515   * @}
00516   */
00517 
00518 /** @defgroup SMARTCARD_DMA_Disable_on_Rx_Error SMARTCARD advanced feature DMA Disable on Rx Error
00519   * @{
00520   */
00521 #define SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR   0x00000000U           /*!< DMA enable on Reception Error  */
00522 #define SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR  USART_CR3_DDRE        /*!< DMA disable on Reception Error */
00523 /**
00524   * @}
00525   */
00526 
00527 /** @defgroup SMARTCARD_MSB_First   SMARTCARD advanced feature MSB first
00528   * @{
00529   */
00530 #define SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE      0x00000000U           /*!< Most significant bit sent/received first disable */
00531 #define SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE       USART_CR2_MSBFIRST    /*!< Most significant bit sent/received first enable  */
00532 /**
00533   * @}
00534   */
00535 
00536 /** @defgroup SMARTCARD_Request_Parameters SMARTCARD Request Parameters
00537   * @{
00538   */
00539 #define SMARTCARD_RXDATA_FLUSH_REQUEST      USART_RQR_RXFRQ              /*!< Receive data flush request */
00540 #define SMARTCARD_TXDATA_FLUSH_REQUEST      USART_RQR_TXFRQ              /*!< Transmit data flush request */
00541 /**
00542   * @}
00543   */
00544 
00545 /** @defgroup SMARTCARD_Interruption_Mask SMARTCARD interruptions flags mask
00546   * @{
00547   */
00548 #define SMARTCARD_IT_MASK                   0x001FU   /*!< SMARTCARD interruptions flags mask  */
00549 #define SMARTCARD_CR_MASK                   0x00E0U   /*!< SMARTCARD control register mask     */
00550 #define SMARTCARD_CR_POS                    5U        /*!< SMARTCARD control register position */
00551 #define SMARTCARD_ISR_MASK                  0x1F00U   /*!< SMARTCARD ISR register mask         */
00552 #define SMARTCARD_ISR_POS                   8U        /*!< SMARTCARD ISR register position     */
00553 /**
00554   * @}
00555   */
00556 
00557 /**
00558   * @}
00559   */
00560 
00561 /* Exported macros -----------------------------------------------------------*/
00562 /** @defgroup SMARTCARD_Exported_Macros  SMARTCARD Exported Macros
00563   * @{
00564   */
00565 
00566 /** @brief  Reset SMARTCARD handle states.
00567   * @param  __HANDLE__ SMARTCARD handle.
00568   * @retval None
00569   */
00570 #if USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1
00571 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__)  do{                                                       \
00572                                                             (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET;     \
00573                                                             (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET;    \
00574                                                             (__HANDLE__)->MspInitCallback = NULL;                 \
00575                                                             (__HANDLE__)->MspDeInitCallback = NULL;               \
00576                                                           } while(0U)
00577 #else
00578 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__)  do{                                                       \
00579                                                             (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET;     \
00580                                                             (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET;    \
00581                                                           } while(0U)
00582 #endif /*USE_HAL_SMARTCARD_REGISTER_CALLBACKS  */
00583 
00584 /** @brief  Flush the Smartcard Data registers.
00585   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00586   * @retval None
00587   */
00588 #define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__)                      \
00589   do{                                                                     \
00590     SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_RXDATA_FLUSH_REQUEST); \
00591     SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_TXDATA_FLUSH_REQUEST); \
00592   } while(0U)
00593 
00594 /** @brief  Clear the specified SMARTCARD pending flag.
00595   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00596   * @param  __FLAG__ specifies the flag to check.
00597   *          This parameter can be any combination of the following values:
00598   *            @arg @ref SMARTCARD_CLEAR_PEF    Parity error clear flag
00599   *            @arg @ref SMARTCARD_CLEAR_FEF    Framing error clear flag
00600   *            @arg @ref SMARTCARD_CLEAR_NEF    Noise detected clear flag
00601   *            @arg @ref SMARTCARD_CLEAR_OREF   OverRun error clear flag
00602   *            @arg @ref SMARTCARD_CLEAR_IDLEF  Idle line detected clear flag
00603   *            @arg @ref SMARTCARD_CLEAR_TCF    Transmission complete clear flag
00604   *            @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag
00605   *            @arg @ref SMARTCARD_CLEAR_RTOF   Receiver timeout clear flag
00606   *            @arg @ref SMARTCARD_CLEAR_EOBF   End of block clear flag
00607   *            @arg @ref SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear flag
00608   * @retval None
00609   */
00610 #define __HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
00611 
00612 /** @brief  Clear the SMARTCARD PE pending flag.
00613   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00614   * @retval None
00615   */
00616 #define __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_PEF)
00617 
00618 /** @brief  Clear the SMARTCARD FE pending flag.
00619   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00620   * @retval None
00621   */
00622 #define __HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_FEF)
00623 
00624 /** @brief  Clear the SMARTCARD NE pending flag.
00625   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00626   * @retval None
00627   */
00628 #define __HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_NEF)
00629 
00630 /** @brief  Clear the SMARTCARD ORE pending flag.
00631   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00632   * @retval None
00633   */
00634 #define __HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_OREF)
00635 
00636 /** @brief  Clear the SMARTCARD IDLE pending flag.
00637   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00638   * @retval None
00639   */
00640 #define __HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__)   __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_IDLEF)
00641 
00642 /** @brief  Check whether the specified Smartcard flag is set or not.
00643   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00644   * @param  __FLAG__ specifies the flag to check.
00645   *        This parameter can be one of the following values:
00646   *            @arg @ref SMARTCARD_FLAG_TCBGT Transmission complete before guard time flag (when flag available)
00647   *            @arg @ref SMARTCARD_FLAG_REACK Receive enable acknowledge flag
00648   *            @arg @ref SMARTCARD_FLAG_TEACK Transmit enable acknowledge flag
00649   *            @arg @ref SMARTCARD_FLAG_BUSY  Busy flag
00650   *            @arg @ref SMARTCARD_FLAG_EOBF  End of block flag
00651   *            @arg @ref SMARTCARD_FLAG_RTOF  Receiver timeout flag
00652   *            @arg @ref SMARTCARD_FLAG_TXE   Transmit data register empty flag
00653   *            @arg @ref SMARTCARD_FLAG_TC    Transmission complete flag
00654   *            @arg @ref SMARTCARD_FLAG_RXNE  Receive data register not empty flag
00655   *            @arg @ref SMARTCARD_FLAG_IDLE  Idle line detection flag
00656   *            @arg @ref SMARTCARD_FLAG_ORE   Overrun error flag
00657   *            @arg @ref SMARTCARD_FLAG_NE    Noise error flag
00658   *            @arg @ref SMARTCARD_FLAG_FE    Framing error flag
00659   *            @arg @ref SMARTCARD_FLAG_PE    Parity error flag
00660   *            @arg @ref SMARTCARD_FLAG_TXFNF TXFIFO not full flag
00661   *            @arg @ref SMARTCARD_FLAG_RXFNE RXFIFO not empty flag
00662   *            @arg @ref SMARTCARD_FLAG_TXFE  TXFIFO Empty flag
00663   *            @arg @ref SMARTCARD_FLAG_RXFF  RXFIFO Full flag
00664   *            @arg @ref SMARTCARD_FLAG_RXFT  SMARTCARD RXFIFO threshold flag
00665   *            @arg @ref SMARTCARD_FLAG_TXFT  SMARTCARD TXFIFO threshold flag
00666   * @retval The new state of __FLAG__ (TRUE or FALSE).
00667   */
00668 #define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
00669 
00670 /** @brief  Enable the specified SmartCard interrupt.
00671   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00672   * @param  __INTERRUPT__ specifies the SMARTCARD interrupt to enable.
00673   *          This parameter can be one of the following values:
00674   *            @arg @ref SMARTCARD_IT_EOB    End of block interrupt
00675   *            @arg @ref SMARTCARD_IT_RTO    Receive timeout interrupt
00676   *            @arg @ref SMARTCARD_IT_TXE    Transmit data register empty interrupt
00677   *            @arg @ref SMARTCARD_IT_TC     Transmission complete interrupt
00678   *            @arg @ref SMARTCARD_IT_TCBGT  Transmission complete before
00679   *                                          guard time interrupt (when interruption available)
00680   *            @arg @ref SMARTCARD_IT_RXNE   Receive data register not empty interrupt
00681   *            @arg @ref SMARTCARD_IT_IDLE   Idle line detection interrupt
00682   *            @arg @ref SMARTCARD_IT_PE     Parity error interrupt
00683   *            @arg @ref SMARTCARD_IT_ERR    Error interrupt(frame error, noise error, overrun error)
00684   *            @arg @ref SMARTCARD_IT_TXFNF  TX FIFO not full interruption
00685   *            @arg @ref SMARTCARD_IT_RXFNE  RXFIFO not empty interruption
00686   *            @arg @ref SMARTCARD_IT_RXFF   RXFIFO full interruption
00687   *            @arg @ref SMARTCARD_IT_TXFE   TXFIFO empty interruption
00688   *            @arg @ref SMARTCARD_IT_RXFT   RXFIFO threshold reached interruption
00689   *            @arg @ref SMARTCARD_IT_TXFT   TXFIFO threshold reached interruption
00690   * @retval None
00691   */
00692 #define __HAL_SMARTCARD_ENABLE_IT(__HANDLE__, __INTERRUPT__)   (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
00693                                                                   SMARTCARD_CR_POS) == 1U)?\
00694                                                                 ((__HANDLE__)->Instance->CR1 |= (1UL <<\
00695                                                                     ((__INTERRUPT__) & SMARTCARD_IT_MASK))):\
00696                                                                 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
00697                                                                   SMARTCARD_CR_POS) == 2U)?\
00698                                                                 ((__HANDLE__)->Instance->CR2 |= (1UL <<\
00699                                                                     ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
00700                                                                 ((__HANDLE__)->Instance->CR3 |= (1UL <<\
00701                                                                     ((__INTERRUPT__) & SMARTCARD_IT_MASK))))
00702 
00703 /** @brief  Disable the specified SmartCard interrupt.
00704   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00705   * @param  __INTERRUPT__ specifies the SMARTCARD interrupt to disable.
00706   *          This parameter can be one of the following values:
00707   *            @arg @ref SMARTCARD_IT_EOB    End of block interrupt
00708   *            @arg @ref SMARTCARD_IT_RTO    Receive timeout interrupt
00709   *            @arg @ref SMARTCARD_IT_TXE    Transmit data register empty interrupt
00710   *            @arg @ref SMARTCARD_IT_TC     Transmission complete interrupt
00711   *            @arg @ref SMARTCARD_IT_TCBGT  Transmission complete before guard
00712   *                                          time interrupt (when interruption available)
00713   *            @arg @ref SMARTCARD_IT_RXNE   Receive data register not empty interrupt
00714   *            @arg @ref SMARTCARD_IT_IDLE   Idle line detection interrupt
00715   *            @arg @ref SMARTCARD_IT_PE     Parity error interrupt
00716   *            @arg @ref SMARTCARD_IT_ERR    Error interrupt(frame error, noise error, overrun error)
00717   *            @arg @ref SMARTCARD_IT_TXFNF  TX FIFO not full interruption
00718   *            @arg @ref SMARTCARD_IT_RXFNE  RXFIFO not empty interruption
00719   *            @arg @ref SMARTCARD_IT_RXFF   RXFIFO full interruption
00720   *            @arg @ref SMARTCARD_IT_TXFE   TXFIFO empty interruption
00721   *            @arg @ref SMARTCARD_IT_RXFT   RXFIFO threshold reached interruption
00722   *            @arg @ref SMARTCARD_IT_TXFT   TXFIFO threshold reached interruption
00723   * @retval None
00724   */
00725 #define __HAL_SMARTCARD_DISABLE_IT(__HANDLE__, __INTERRUPT__)  (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
00726                                                                   SMARTCARD_CR_POS) == 1U)?\
00727                                                                 ((__HANDLE__)->Instance->CR1 &= ~ (1U <<\
00728                                                                     ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
00729                                                                 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
00730                                                                   SMARTCARD_CR_POS) == 2U)?\
00731                                                                 ((__HANDLE__)->Instance->CR2 &= ~ (1U <<\
00732                                                                     ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
00733                                                                 ((__HANDLE__)->Instance->CR3 &= ~ (1U <<\
00734                                                                     ((__INTERRUPT__) & SMARTCARD_IT_MASK))))
00735 
00736 /** @brief  Check whether the specified SmartCard interrupt has occurred or not.
00737   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00738   * @param  __INTERRUPT__ specifies the SMARTCARD interrupt to check.
00739   *          This parameter can be one of the following values:
00740   *            @arg @ref SMARTCARD_IT_EOB    End of block interrupt
00741   *            @arg @ref SMARTCARD_IT_RTO    Receive timeout interrupt
00742   *            @arg @ref SMARTCARD_IT_TXE    Transmit data register empty interrupt
00743   *            @arg @ref SMARTCARD_IT_TC     Transmission complete interrupt
00744   *            @arg @ref SMARTCARD_IT_TCBGT  Transmission complete before guard time
00745   *                                          interrupt (when interruption available)
00746   *            @arg @ref SMARTCARD_IT_RXNE   Receive data register not empty interrupt
00747   *            @arg @ref SMARTCARD_IT_IDLE   Idle line detection interrupt
00748   *            @arg @ref SMARTCARD_IT_PE     Parity error interrupt
00749   *            @arg @ref SMARTCARD_IT_ERR    Error interrupt(frame error, noise error, overrun error)
00750   *            @arg @ref SMARTCARD_IT_TXFNF  TX FIFO not full interruption
00751   *            @arg @ref SMARTCARD_IT_RXFNE  RXFIFO not empty interruption
00752   *            @arg @ref SMARTCARD_IT_RXFF   RXFIFO full interruption
00753   *            @arg @ref SMARTCARD_IT_TXFE   TXFIFO empty interruption
00754   *            @arg @ref SMARTCARD_IT_RXFT   RXFIFO threshold reached interruption
00755   *            @arg @ref SMARTCARD_IT_TXFT   TXFIFO threshold reached interruption
00756   * @retval The new state of __INTERRUPT__ (SET or RESET).
00757   */
00758 #define __HAL_SMARTCARD_GET_IT(__HANDLE__, __INTERRUPT__) (\
00759                                                            (((__HANDLE__)->Instance->ISR & (0x01UL << (((__INTERRUPT__)\
00760                                                                & SMARTCARD_ISR_MASK)>> SMARTCARD_ISR_POS)))!= 0U)\
00761                                                            ? SET : RESET)
00762 
00763 /** @brief  Check whether the specified SmartCard interrupt source is enabled or not.
00764   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00765   * @param  __INTERRUPT__ specifies the SMARTCARD interrupt source to check.
00766   *          This parameter can be one of the following values:
00767   *            @arg @ref SMARTCARD_IT_EOB    End of block interrupt
00768   *            @arg @ref SMARTCARD_IT_RTO    Receive timeout interrupt
00769   *            @arg @ref SMARTCARD_IT_TXE    Transmit data register empty interrupt
00770   *            @arg @ref SMARTCARD_IT_TC     Transmission complete interrupt
00771   *            @arg @ref SMARTCARD_IT_TCBGT  Transmission complete before guard time
00772   *                                          interrupt (when interruption available)
00773   *            @arg @ref SMARTCARD_IT_RXNE   Receive data register not empty interrupt
00774   *            @arg @ref SMARTCARD_IT_IDLE   Idle line detection interrupt
00775   *            @arg @ref SMARTCARD_IT_PE     Parity error interrupt
00776   *            @arg @ref SMARTCARD_IT_ERR    Error interrupt(frame error, noise error, overrun error)
00777   *            @arg @ref SMARTCARD_IT_TXFNF  TX FIFO not full interruption
00778   *            @arg @ref SMARTCARD_IT_RXFNE  RXFIFO not empty interruption
00779   *            @arg @ref SMARTCARD_IT_RXFF   RXFIFO full interruption
00780   *            @arg @ref SMARTCARD_IT_TXFE   TXFIFO empty interruption
00781   *            @arg @ref SMARTCARD_IT_RXFT   RXFIFO threshold reached interruption
00782   *            @arg @ref SMARTCARD_IT_TXFT   TXFIFO threshold reached interruption
00783   * @retval The new state of __INTERRUPT__ (SET or RESET).
00784   */
00785 #define __HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
00786                                                                        SMARTCARD_CR_POS) == 0x01U)?\
00787                                                                      (__HANDLE__)->Instance->CR1 : \
00788                                                                      (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >>\
00789                                                                         SMARTCARD_CR_POS) == 0x02U)?\
00790                                                                       (__HANDLE__)->Instance->CR2 : \
00791                                                                       (__HANDLE__)->Instance->CR3)) &\
00792                                                                     (0x01UL << (((uint16_t)(__INTERRUPT__))\
00793                                                                                 & SMARTCARD_IT_MASK)))  != 0U)\
00794                                                                   ? SET : RESET)
00795 
00796 /** @brief  Clear the specified SMARTCARD ISR flag, in setting the proper ICR register flag.
00797   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00798   * @param  __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
00799   *                       to clear the corresponding interrupt.
00800   *          This parameter can be one of the following values:
00801   *            @arg @ref SMARTCARD_CLEAR_PEF    Parity error clear flag
00802   *            @arg @ref SMARTCARD_CLEAR_FEF    Framing error clear flag
00803   *            @arg @ref SMARTCARD_CLEAR_NEF    Noise detected clear flag
00804   *            @arg @ref SMARTCARD_CLEAR_OREF   OverRun error clear flag
00805   *            @arg @ref SMARTCARD_CLEAR_IDLEF  Idle line detection clear flag
00806   *            @arg @ref SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear Flag
00807   *            @arg @ref SMARTCARD_CLEAR_TCF    Transmission complete clear flag
00808   *            @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag (when flag available)
00809   *            @arg @ref SMARTCARD_CLEAR_RTOF   Receiver timeout clear flag
00810   *            @arg @ref SMARTCARD_CLEAR_EOBF   End of block clear flag
00811   * @retval None
00812   */
00813 #define __HAL_SMARTCARD_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR |= (uint32_t)(__IT_CLEAR__))
00814 
00815 /** @brief  Set a specific SMARTCARD request flag.
00816   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00817   * @param  __REQ__ specifies the request flag to set
00818   *          This parameter can be one of the following values:
00819   *            @arg @ref SMARTCARD_RXDATA_FLUSH_REQUEST Receive data flush Request
00820   *            @arg @ref SMARTCARD_TXDATA_FLUSH_REQUEST Transmit data flush Request
00821   * @retval None
00822   */
00823 #define __HAL_SMARTCARD_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
00824 
00825 /** @brief  Enable the SMARTCARD one bit sample method.
00826   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00827   * @retval None
00828   */
00829 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
00830 
00831 /** @brief  Disable the SMARTCARD one bit sample method.
00832   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00833   * @retval None
00834   */
00835 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\
00836                                                             &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
00837 
00838 /** @brief  Enable the USART associated to the SMARTCARD Handle.
00839   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00840   * @retval None
00841   */
00842 #define __HAL_SMARTCARD_ENABLE(__HANDLE__)               ((__HANDLE__)->Instance->CR1 |=  USART_CR1_UE)
00843 
00844 /** @brief  Disable the USART associated to the SMARTCARD Handle
00845   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00846   * @retval None
00847   */
00848 #define __HAL_SMARTCARD_DISABLE(__HANDLE__)              ((__HANDLE__)->Instance->CR1 &=  ~USART_CR1_UE)
00849 
00850 /**
00851   * @}
00852   */
00853 
00854 /* Private macros -------------------------------------------------------------*/
00855 /** @defgroup SMARTCARD_Private_Macros SMARTCARD Private Macros
00856   * @{
00857   */
00858 
00859 /** @brief  Report the SMARTCARD clock source.
00860   * @param  __HANDLE__ specifies the SMARTCARD Handle.
00861   * @param  __CLOCKSOURCE__ output variable.
00862   * @retval the SMARTCARD clocking source, written in __CLOCKSOURCE__.
00863   */
00864 #if defined(UART9) && defined(USART10)
00865 #define SMARTCARD_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__)   \
00866   do {                                                         \
00867     if ((__HANDLE__)->Instance == USART1)                      \
00868     {                                                          \
00869       switch (__HAL_RCC_GET_USART1_SOURCE())                   \
00870       {                                                        \
00871         case RCC_USART1CLKSOURCE_D2PCLK2:                      \
00872           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_D2PCLK2;   \
00873           break;                                               \
00874         case RCC_USART1CLKSOURCE_PLL2:                         \
00875           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q;     \
00876           break;                                               \
00877         case RCC_USART1CLKSOURCE_PLL3:                         \
00878           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q;     \
00879           break;                                               \
00880         case RCC_USART1CLKSOURCE_HSI:                          \
00881           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI;       \
00882           break;                                               \
00883         case RCC_USART1CLKSOURCE_CSI:                          \
00884           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI;       \
00885           break;                                               \
00886         case RCC_USART1CLKSOURCE_LSE:                          \
00887           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE;       \
00888           break;                                               \
00889         default:                                               \
00890           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
00891           break;                                               \
00892       }                                                        \
00893     }                                                          \
00894     else if ((__HANDLE__)->Instance == USART2)                 \
00895     {                                                          \
00896       switch (__HAL_RCC_GET_USART2_SOURCE())                   \
00897       {                                                        \
00898         case RCC_USART2CLKSOURCE_D2PCLK1:                      \
00899           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_D2PCLK1;   \
00900           break;                                               \
00901         case RCC_USART2CLKSOURCE_PLL2:                         \
00902           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q;     \
00903           break;                                               \
00904         case RCC_USART2CLKSOURCE_PLL3:                         \
00905           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q;     \
00906           break;                                               \
00907         case RCC_USART2CLKSOURCE_HSI:                          \
00908           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI;       \
00909           break;                                               \
00910         case RCC_USART2CLKSOURCE_CSI:                          \
00911           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI;       \
00912           break;                                               \
00913         case RCC_USART2CLKSOURCE_LSE:                          \
00914           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE;       \
00915           break;                                               \
00916         default:                                               \
00917           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
00918           break;                                               \
00919       }                                                        \
00920     }                                                          \
00921     else if ((__HANDLE__)->Instance == USART3)                 \
00922     {                                                          \
00923       switch (__HAL_RCC_GET_USART3_SOURCE())                   \
00924       {                                                        \
00925         case RCC_USART3CLKSOURCE_D2PCLK1:                      \
00926           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_D2PCLK1;   \
00927           break;                                               \
00928         case RCC_USART3CLKSOURCE_PLL2:                         \
00929           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q;     \
00930           break;                                               \
00931         case RCC_USART3CLKSOURCE_PLL3:                         \
00932           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q;     \
00933           break;                                               \
00934         case RCC_USART3CLKSOURCE_HSI:                          \
00935           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI;       \
00936           break;                                               \
00937         case RCC_USART3CLKSOURCE_CSI:                          \
00938           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI;       \
00939           break;                                               \
00940         case RCC_USART3CLKSOURCE_LSE:                          \
00941           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE;       \
00942           break;                                               \
00943         default:                                               \
00944           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
00945           break;                                               \
00946       }                                                        \
00947     }                                                          \
00948     else if ((__HANDLE__)->Instance == USART6)                 \
00949     {                                                          \
00950       switch (__HAL_RCC_GET_USART6_SOURCE())                   \
00951       {                                                        \
00952         case RCC_USART6CLKSOURCE_D2PCLK2:                      \
00953           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_D2PCLK2;   \
00954           break;                                               \
00955         case RCC_USART6CLKSOURCE_PLL2:                         \
00956           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q;     \
00957           break;                                               \
00958         case RCC_USART6CLKSOURCE_PLL3:                         \
00959           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q;     \
00960           break;                                               \
00961         case RCC_USART6CLKSOURCE_HSI:                          \
00962           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI;       \
00963           break;                                               \
00964         case RCC_USART6CLKSOURCE_CSI:                          \
00965           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI;       \
00966           break;                                               \
00967         case RCC_USART6CLKSOURCE_LSE:                          \
00968           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE;       \
00969           break;                                               \
00970         default:                                               \
00971           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
00972           break;                                               \
00973       }                                                        \
00974     }                                                          \
00975     else if ((__HANDLE__)->Instance == USART10)                \
00976     {                                                          \
00977       switch (__HAL_RCC_GET_USART10_SOURCE())                  \
00978       {                                                        \
00979         case RCC_USART10CLKSOURCE_D2PCLK2:                     \
00980           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_D2PCLK2;   \
00981           break;                                               \
00982         case RCC_USART10CLKSOURCE_PLL2:                        \
00983           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q;     \
00984           break;                                               \
00985         case RCC_USART10CLKSOURCE_PLL3:                        \
00986           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q;     \
00987           break;                                               \
00988         case RCC_USART10CLKSOURCE_HSI:                         \
00989           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI;       \
00990           break;                                               \
00991         case RCC_USART10CLKSOURCE_CSI:                         \
00992           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI;       \
00993           break;                                               \
00994         case RCC_USART10CLKSOURCE_LSE:                         \
00995           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE;       \
00996           break;                                               \
00997         default:                                               \
00998           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
00999           break;                                               \
01000       }                                                        \
01001     }                                                          \
01002     else                                                       \
01003     {                                                          \
01004       (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED;     \
01005     }                                                          \
01006   } while(0U)
01007 #else
01008 #define SMARTCARD_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__)   \
01009   do {                                                         \
01010     if ((__HANDLE__)->Instance == USART1)                      \
01011     {                                                          \
01012       switch (__HAL_RCC_GET_USART1_SOURCE())                   \
01013       {                                                        \
01014         case RCC_USART1CLKSOURCE_D2PCLK2:                      \
01015           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_D2PCLK2;   \
01016           break;                                               \
01017         case RCC_USART1CLKSOURCE_PLL2:                         \
01018           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q;     \
01019           break;                                               \
01020         case RCC_USART1CLKSOURCE_PLL3:                         \
01021           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q;     \
01022           break;                                               \
01023         case RCC_USART1CLKSOURCE_HSI:                          \
01024           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI;       \
01025           break;                                               \
01026         case RCC_USART1CLKSOURCE_CSI:                          \
01027           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI;       \
01028           break;                                               \
01029         case RCC_USART1CLKSOURCE_LSE:                          \
01030           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE;       \
01031           break;                                               \
01032         default:                                               \
01033           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
01034           break;                                               \
01035       }                                                        \
01036     }                                                          \
01037     else if ((__HANDLE__)->Instance == USART2)                 \
01038     {                                                          \
01039       switch (__HAL_RCC_GET_USART2_SOURCE())                   \
01040       {                                                        \
01041         case RCC_USART2CLKSOURCE_D2PCLK1:                      \
01042           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_D2PCLK1;   \
01043           break;                                               \
01044         case RCC_USART2CLKSOURCE_PLL2:                         \
01045           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q;    \
01046           break;                                               \
01047         case RCC_USART2CLKSOURCE_PLL3:                         \
01048           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q;     \
01049           break;                                               \
01050         case RCC_USART2CLKSOURCE_HSI:                          \
01051           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI;       \
01052           break;                                               \
01053         case RCC_USART2CLKSOURCE_CSI:                          \
01054           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI;       \
01055           break;                                               \
01056         case RCC_USART2CLKSOURCE_LSE:                          \
01057           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE;       \
01058           break;                                               \
01059         default:                                               \
01060           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
01061           break;                                               \
01062       }                                                        \
01063     }                                                          \
01064     else if ((__HANDLE__)->Instance == USART3)                 \
01065     {                                                          \
01066       switch (__HAL_RCC_GET_USART3_SOURCE())                   \
01067       {                                                        \
01068         case RCC_USART3CLKSOURCE_D2PCLK1:                      \
01069           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_D2PCLK1;   \
01070           break;                                               \
01071         case RCC_USART3CLKSOURCE_PLL2:                         \
01072           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q;     \
01073           break;                                               \
01074         case RCC_USART3CLKSOURCE_PLL3:                         \
01075           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q;     \
01076           break;                                               \
01077         case RCC_USART3CLKSOURCE_HSI:                          \
01078           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI;       \
01079           break;                                               \
01080         case RCC_USART3CLKSOURCE_CSI:                          \
01081           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI;       \
01082           break;                                               \
01083         case RCC_USART3CLKSOURCE_LSE:                          \
01084           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE;       \
01085           break;                                               \
01086         default:                                               \
01087           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
01088           break;                                               \
01089       }                                                        \
01090     }                                                          \
01091     else if ((__HANDLE__)->Instance == USART6)                 \
01092     {                                                          \
01093       switch (__HAL_RCC_GET_USART6_SOURCE())                   \
01094       {                                                        \
01095         case RCC_USART6CLKSOURCE_D2PCLK2:                      \
01096           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_D2PCLK2;   \
01097           break;                                               \
01098         case RCC_USART6CLKSOURCE_PLL2:                         \
01099           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL2Q;     \
01100           break;                                               \
01101         case RCC_USART6CLKSOURCE_PLL3:                         \
01102           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PLL3Q;     \
01103           break;                                               \
01104         case RCC_USART6CLKSOURCE_HSI:                          \
01105           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI;       \
01106           break;                                               \
01107         case RCC_USART6CLKSOURCE_CSI:                          \
01108           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_CSI;       \
01109           break;                                               \
01110         case RCC_USART6CLKSOURCE_LSE:                          \
01111           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE;       \
01112           break;                                               \
01113         default:                                               \
01114           (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
01115           break;                                               \
01116       }                                                        \
01117     }                                                          \
01118     else                                                       \
01119     {                                                          \
01120       (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED;     \
01121     }                                                          \
01122   } while(0U)
01123 #endif /* UART9 && USART10 */
01124 
01125 /** @brief  Check the Baud rate range.
01126   * @note   The maximum Baud Rate is derived from the maximum clock on H7 (100 MHz)
01127   *         divided by the oversampling used on the SMARTCARD (i.e. 16).
01128   * @param  __BAUDRATE__ Baud rate set by the configuration function.
01129   * @retval Test result (TRUE or FALSE)
01130   */
01131 #define IS_SMARTCARD_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 6250001U)
01132 
01133 /** @brief  Check the block length range.
01134   * @note   The maximum SMARTCARD block length is 0xFF.
01135   * @param  __LENGTH__ block length.
01136   * @retval Test result (TRUE or FALSE)
01137   */
01138 #define IS_SMARTCARD_BLOCKLENGTH(__LENGTH__) ((__LENGTH__) <= 0xFFU)
01139 
01140 /** @brief  Check the receiver timeout value.
01141   * @note   The maximum SMARTCARD receiver timeout value is 0xFFFFFF.
01142   * @param  __TIMEOUTVALUE__ receiver timeout value.
01143   * @retval Test result (TRUE or FALSE)
01144   */
01145 #define IS_SMARTCARD_TIMEOUT_VALUE(__TIMEOUTVALUE__)    ((__TIMEOUTVALUE__) <= 0xFFFFFFU)
01146 
01147 /** @brief  Check the SMARTCARD autoretry counter value.
01148   * @note   The maximum number of retransmissions is 0x7.
01149   * @param  __COUNT__ number of retransmissions.
01150   * @retval Test result (TRUE or FALSE)
01151   */
01152 #define IS_SMARTCARD_AUTORETRY_COUNT(__COUNT__)         ((__COUNT__) <= 0x7U)
01153 
01154 /** @brief Ensure that SMARTCARD frame length is valid.
01155   * @param __LENGTH__ SMARTCARD frame length.
01156   * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
01157   */
01158 #define IS_SMARTCARD_WORD_LENGTH(__LENGTH__) ((__LENGTH__) == SMARTCARD_WORDLENGTH_9B)
01159 
01160 /** @brief Ensure that SMARTCARD frame number of stop bits is valid.
01161   * @param __STOPBITS__ SMARTCARD frame number of stop bits.
01162   * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
01163   */
01164 #define IS_SMARTCARD_STOPBITS(__STOPBITS__) (((__STOPBITS__) == SMARTCARD_STOPBITS_0_5) ||\
01165                                              ((__STOPBITS__) == SMARTCARD_STOPBITS_1_5))
01166 
01167 /** @brief Ensure that SMARTCARD frame parity is valid.
01168   * @param __PARITY__ SMARTCARD frame parity.
01169   * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
01170   */
01171 #define IS_SMARTCARD_PARITY(__PARITY__) (((__PARITY__) == SMARTCARD_PARITY_EVEN) || \
01172                                          ((__PARITY__) == SMARTCARD_PARITY_ODD))
01173 
01174 /** @brief Ensure that SMARTCARD communication mode is valid.
01175   * @param __MODE__ SMARTCARD communication mode.
01176   * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
01177   */
01178 #define IS_SMARTCARD_MODE(__MODE__) ((((__MODE__) & 0xFFF3U) == 0x00U) && ((__MODE__) != 0x00U))
01179 
01180 /** @brief Ensure that SMARTCARD frame polarity is valid.
01181   * @param __CPOL__ SMARTCARD frame polarity.
01182   * @retval SET (__CPOL__ is valid) or RESET (__CPOL__ is invalid)
01183   */
01184 #define IS_SMARTCARD_POLARITY(__CPOL__) (((__CPOL__) == SMARTCARD_POLARITY_LOW)\
01185                                          || ((__CPOL__) == SMARTCARD_POLARITY_HIGH))
01186 
01187 /** @brief Ensure that SMARTCARD frame phase is valid.
01188   * @param __CPHA__ SMARTCARD frame phase.
01189   * @retval SET (__CPHA__ is valid) or RESET (__CPHA__ is invalid)
01190   */
01191 #define IS_SMARTCARD_PHASE(__CPHA__) (((__CPHA__) == SMARTCARD_PHASE_1EDGE) || ((__CPHA__) == SMARTCARD_PHASE_2EDGE))
01192 
01193 /** @brief Ensure that SMARTCARD frame last bit clock pulse setting is valid.
01194   * @param __LASTBIT__ SMARTCARD frame last bit clock pulse setting.
01195   * @retval SET (__LASTBIT__ is valid) or RESET (__LASTBIT__ is invalid)
01196   */
01197 #define IS_SMARTCARD_LASTBIT(__LASTBIT__) (((__LASTBIT__) == SMARTCARD_LASTBIT_DISABLE) || \
01198                                            ((__LASTBIT__) == SMARTCARD_LASTBIT_ENABLE))
01199 
01200 /** @brief Ensure that SMARTCARD frame sampling is valid.
01201   * @param __ONEBIT__ SMARTCARD frame sampling.
01202   * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
01203   */
01204 #define IS_SMARTCARD_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_DISABLE) || \
01205                                                  ((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_ENABLE))
01206 
01207 /** @brief Ensure that SMARTCARD NACK transmission setting is valid.
01208   * @param __NACK__ SMARTCARD NACK transmission setting.
01209   * @retval SET (__NACK__ is valid) or RESET (__NACK__ is invalid)
01210   */
01211 #define IS_SMARTCARD_NACK(__NACK__) (((__NACK__) == SMARTCARD_NACK_ENABLE) || \
01212                                      ((__NACK__) == SMARTCARD_NACK_DISABLE))
01213 
01214 /** @brief Ensure that SMARTCARD receiver timeout setting is valid.
01215   * @param __TIMEOUT__ SMARTCARD receiver timeout setting.
01216   * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid)
01217   */
01218 #define IS_SMARTCARD_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == SMARTCARD_TIMEOUT_DISABLE) || \
01219                                            ((__TIMEOUT__) == SMARTCARD_TIMEOUT_ENABLE))
01220 
01221 /** @brief Ensure that SMARTCARD clock Prescaler is valid.
01222   * @param __CLOCKPRESCALER__ SMARTCARD clock Prescaler value.
01223   * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid)
01224   */
01225 #define IS_SMARTCARD_CLOCKPRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV1)   || \
01226                                                          ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV2)   || \
01227                                                          ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV4)   || \
01228                                                          ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV6)   || \
01229                                                          ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV8)   || \
01230                                                          ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV10)  || \
01231                                                          ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV12)  || \
01232                                                          ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV16)  || \
01233                                                          ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV32)  || \
01234                                                          ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV64)  || \
01235                                                          ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV128) || \
01236                                                          ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV256))
01237 
01238 /** @brief Ensure that SMARTCARD advanced features initialization is valid.
01239   * @param __INIT__ SMARTCARD advanced features initialization.
01240   * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid)
01241   */
01242 #define IS_SMARTCARD_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (SMARTCARD_ADVFEATURE_NO_INIT                | \
01243                                                                SMARTCARD_ADVFEATURE_TXINVERT_INIT          | \
01244                                                                SMARTCARD_ADVFEATURE_RXINVERT_INIT          | \
01245                                                                SMARTCARD_ADVFEATURE_DATAINVERT_INIT        | \
01246                                                                SMARTCARD_ADVFEATURE_SWAP_INIT              | \
01247                                                                SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT  | \
01248                                                                SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT | \
01249                                                                SMARTCARD_ADVFEATURE_MSBFIRST_INIT))
01250 
01251 /** @brief Ensure that SMARTCARD frame TX inversion setting is valid.
01252   * @param __TXINV__ SMARTCARD frame TX inversion setting.
01253   * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid)
01254   */
01255 #define IS_SMARTCARD_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_DISABLE) || \
01256                                                   ((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_ENABLE))
01257 
01258 /** @brief Ensure that SMARTCARD frame RX inversion setting is valid.
01259   * @param __RXINV__ SMARTCARD frame RX inversion setting.
01260   * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid)
01261   */
01262 #define IS_SMARTCARD_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_DISABLE) || \
01263                                                   ((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_ENABLE))
01264 
01265 /** @brief Ensure that SMARTCARD frame data inversion setting is valid.
01266   * @param __DATAINV__ SMARTCARD frame data inversion setting.
01267   * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid)
01268   */
01269 #define IS_SMARTCARD_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_DISABLE) || \
01270                                                       ((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_ENABLE))
01271 
01272 /** @brief Ensure that SMARTCARD frame RX/TX pins swap setting is valid.
01273   * @param __SWAP__ SMARTCARD frame RX/TX pins swap setting.
01274   * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid)
01275   */
01276 #define IS_SMARTCARD_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_DISABLE) || \
01277                                                 ((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_ENABLE))
01278 
01279 /** @brief Ensure that SMARTCARD frame overrun setting is valid.
01280   * @param __OVERRUN__ SMARTCARD frame overrun setting.
01281   * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid)
01282   */
01283 #define IS_SMARTCARD_OVERRUN(__OVERRUN__) (((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_ENABLE) || \
01284                                            ((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_DISABLE))
01285 
01286 /** @brief Ensure that SMARTCARD DMA enabling or disabling on error setting is valid.
01287   * @param __DMA__ SMARTCARD DMA enabling or disabling on error setting.
01288   * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid)
01289   */
01290 #define IS_SMARTCARD_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR) || \
01291                                                        ((__DMA__) == SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR))
01292 
01293 /** @brief Ensure that SMARTCARD frame MSB first setting is valid.
01294   * @param __MSBFIRST__ SMARTCARD frame MSB first setting.
01295   * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid)
01296   */
01297 #define IS_SMARTCARD_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE) || \
01298                                                         ((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE))
01299 
01300 /** @brief Ensure that SMARTCARD request parameter is valid.
01301   * @param __PARAM__ SMARTCARD request parameter.
01302   * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
01303   */
01304 #define IS_SMARTCARD_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == SMARTCARD_RXDATA_FLUSH_REQUEST) || \
01305                                                    ((__PARAM__) == SMARTCARD_TXDATA_FLUSH_REQUEST))
01306 
01307 /**
01308   * @}
01309   */
01310 
01311 /* Include SMARTCARD HAL Extended module */
01312 #include "stm32h7xx_hal_smartcard_ex.h"
01313 
01314 /* Exported functions --------------------------------------------------------*/
01315 /** @addtogroup SMARTCARD_Exported_Functions
01316   * @{
01317   */
01318 
01319 /* Initialization and de-initialization functions  ****************************/
01320 /** @addtogroup SMARTCARD_Exported_Functions_Group1
01321   * @{
01322   */
01323 
01324 HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsmartcard);
01325 HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsmartcard);
01326 void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsmartcard);
01327 void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsmartcard);
01328 
01329 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)
01330 /* Callbacks Register/UnRegister functions  ***********************************/
01331 HAL_StatusTypeDef HAL_SMARTCARD_RegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard,
01332                                                  HAL_SMARTCARD_CallbackIDTypeDef CallbackID,
01333                                                  pSMARTCARD_CallbackTypeDef pCallback);
01334 HAL_StatusTypeDef HAL_SMARTCARD_UnRegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard,
01335                                                    HAL_SMARTCARD_CallbackIDTypeDef CallbackID);
01336 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
01337 
01338 /**
01339   * @}
01340   */
01341 
01342 /* IO operation functions *****************************************************/
01343 /** @addtogroup SMARTCARD_Exported_Functions_Group2
01344   * @{
01345   */
01346 
01347 HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size,
01348                                          uint32_t Timeout);
01349 HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size,
01350                                         uint32_t Timeout);
01351 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size);
01352 HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
01353 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA(SMARTCARD_HandleTypeDef *hsmartcard, const uint8_t *pData, uint16_t Size);
01354 HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
01355 /* Transfer Abort functions */
01356 HAL_StatusTypeDef HAL_SMARTCARD_Abort(SMARTCARD_HandleTypeDef *hsmartcard);
01357 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit(SMARTCARD_HandleTypeDef *hsmartcard);
01358 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive(SMARTCARD_HandleTypeDef *hsmartcard);
01359 HAL_StatusTypeDef HAL_SMARTCARD_Abort_IT(SMARTCARD_HandleTypeDef *hsmartcard);
01360 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit_IT(SMARTCARD_HandleTypeDef *hsmartcard);
01361 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive_IT(SMARTCARD_HandleTypeDef *hsmartcard);
01362 
01363 void HAL_SMARTCARD_IRQHandler(SMARTCARD_HandleTypeDef *hsmartcard);
01364 void HAL_SMARTCARD_TxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
01365 void HAL_SMARTCARD_RxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
01366 void HAL_SMARTCARD_ErrorCallback(SMARTCARD_HandleTypeDef *hsmartcard);
01367 void HAL_SMARTCARD_AbortCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
01368 void HAL_SMARTCARD_AbortTransmitCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
01369 void HAL_SMARTCARD_AbortReceiveCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
01370 
01371 /**
01372   * @}
01373   */
01374 
01375 /* Peripheral State and Error functions ***************************************/
01376 /** @addtogroup SMARTCARD_Exported_Functions_Group4
01377   * @{
01378   */
01379 
01380 HAL_SMARTCARD_StateTypeDef HAL_SMARTCARD_GetState(SMARTCARD_HandleTypeDef *hsmartcard);
01381 uint32_t                   HAL_SMARTCARD_GetError(SMARTCARD_HandleTypeDef *hsmartcard);
01382 
01383 /**
01384   * @}
01385   */
01386 
01387 /**
01388   * @}
01389   */
01390 
01391 /**
01392   * @}
01393   */
01394 
01395 /**
01396   * @}
01397   */
01398 
01399 #ifdef __cplusplus
01400 }
01401 #endif
01402 
01403 #endif /* STM32H7xx_HAL_SMARTCARD_H */
01404