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