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