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