?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Moved IO_GPIOPortIdx to platform (#14127)
[betaflight.git] / lib / main / STM32F7 / Drivers / STM32F7xx_HAL_Driver / Inc / stm32f7xx_hal_smartcard.h
blob6d0ae017143cda0c23c2f392bfa20f97e4f25db5
1 /**
2 ******************************************************************************
3 * @file stm32f7xx_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 STM32F7xx_HAL_SMARTCARD_H
22 #define STM32F7xx_HAL_SMARTCARD_H
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32f7xx_hal_def.h"
30
31 /** @addtogroup STM32F7xx_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 } SMARTCARD_InitTypeDef;
109
110 /**
111 * @brief SMARTCARD advanced features initalization structure definition
112 */
113 typedef struct
114 {
115 uint32_t AdvFeatureInit; /*!< Specifies which advanced SMARTCARD features is initialized. Several
116 advanced features may be initialized at the same time. This parameter
117 can be a value of @ref SMARTCARDEx_Advanced_Features_Initialization_Type */
118
119 uint32_t TxPinLevelInvert; /*!< Specifies whether the TX pin active level is inverted.
120 This parameter can be a value of @ref SMARTCARD_Tx_Inv */
121
122 uint32_t RxPinLevelInvert; /*!< Specifies whether the RX pin active level is inverted.
123 This parameter can be a value of @ref SMARTCARD_Rx_Inv */
124
125 uint32_t DataInvert; /*!< Specifies whether data are inverted (positive/direct logic
126 vs negative/inverted logic).
127 This parameter can be a value of @ref SMARTCARD_Data_Inv */
128
129 uint32_t Swap; /*!< Specifies whether TX and RX pins are swapped.
130 This parameter can be a value of @ref SMARTCARD_Rx_Tx_Swap */
131
132 uint32_t OverrunDisable; /*!< Specifies whether the reception overrun detection is disabled.
133 This parameter can be a value of @ref SMARTCARD_Overrun_Disable */
134
135 uint32_t DMADisableonRxError; /*!< Specifies whether the DMA is disabled in case of reception error.
136 This parameter can be a value of @ref SMARTCARD_DMA_Disable_on_Rx_Error */
137
138 uint32_t MSBFirst; /*!< Specifies whether MSB is sent first on UART line.
139 This parameter can be a value of @ref SMARTCARD_MSB_First */
140
141 uint16_t TxCompletionIndication; /*!< Specifies which transmission completion indication is used: before (when
142 relevant flag is available) or once guard time period has elapsed.
143 This parameter can be a value of @ref SMARTCARDEx_Transmission_Completion_Indication. */
144 } SMARTCARD_AdvFeatureInitTypeDef;
145
146 /**
147 * @brief HAL SMARTCARD State definition
148 * @note HAL SMARTCARD State value is a combination of 2 different substates: gState and RxState (see @ref SMARTCARD_State_Definition).
149 * - gState contains SMARTCARD state information related to global Handle management
150 * and also information related to Tx operations.
151 * gState value coding follow below described bitmap :
152 * b7-b6 Error information
153 * 00 : No Error
154 * 01 : (Not Used)
155 * 10 : Timeout
156 * 11 : Error
157 * b5 Peripheral initialization status
158 * 0 : Reset (Peripheral not initialized)
159 * 1 : Init done (Peripheral not initialized. HAL SMARTCARD Init function already called)
160 * b4-b3 (not used)
161 * xx : Should be set to 00
162 * b2 Intrinsic process state
163 * 0 : Ready
164 * 1 : Busy (Peripheral busy with some configuration or internal operations)
165 * b1 (not used)
166 * x : Should be set to 0
167 * b0 Tx state
168 * 0 : Ready (no Tx operation ongoing)
169 * 1 : Busy (Tx operation ongoing)
170 * - RxState contains information related to Rx operations.
171 * RxState value coding follow below described bitmap :
172 * b7-b6 (not used)
173 * xx : Should be set to 00
174 * b5 Peripheral initialization status
175 * 0 : Reset (Peripheral not initialized)
176 * 1 : Init done (Peripheral not initialized)
177 * b4-b2 (not used)
178 * xxx : Should be set to 000
179 * b1 Rx state
180 * 0 : Ready (no Rx operation ongoing)
181 * 1 : Busy (Rx operation ongoing)
182 * b0 (not used)
183 * x : Should be set to 0.
184 */
185 typedef uint32_t HAL_SMARTCARD_StateTypeDef;
186
187 /**
188 * @brief SMARTCARD handle Structure definition
189 */
190 typedef struct __SMARTCARD_HandleTypeDef
191 {
192 USART_TypeDef *Instance; /*!< USART registers base address */
193
194 SMARTCARD_InitTypeDef Init; /*!< SmartCard communication parameters */
195
196 SMARTCARD_AdvFeatureInitTypeDef AdvancedInit; /*!< SmartCard advanced features initialization parameters */
197
198 uint8_t *pTxBuffPtr; /*!< Pointer to SmartCard Tx transfer Buffer */
199
200 uint16_t TxXferSize; /*!< SmartCard Tx Transfer size */
201
202 __IO uint16_t TxXferCount; /*!< SmartCard Tx Transfer Counter */
203
204 uint8_t *pRxBuffPtr; /*!< Pointer to SmartCard Rx transfer Buffer */
205
206 uint16_t RxXferSize; /*!< SmartCard Rx Transfer size */
207
208 __IO uint16_t RxXferCount; /*!< SmartCard Rx Transfer Counter */
209
210
211 void (*RxISR)(struct __SMARTCARD_HandleTypeDef *huart); /*!< Function pointer on Rx IRQ handler */
212
213 void (*TxISR)(struct __SMARTCARD_HandleTypeDef *huart); /*!< Function pointer on Tx IRQ handler */
214
215 DMA_HandleTypeDef *hdmatx; /*!< SmartCard Tx DMA Handle parameters */
216
217 DMA_HandleTypeDef *hdmarx; /*!< SmartCard Rx DMA Handle parameters */
218
219 HAL_LockTypeDef Lock; /*!< Locking object */
220
221 __IO HAL_SMARTCARD_StateTypeDef gState; /*!< SmartCard state information related to global Handle management
222 and also related to Tx operations.
223 This parameter can be a value of @ref HAL_SMARTCARD_StateTypeDef */
224
225 __IO HAL_SMARTCARD_StateTypeDef RxState; /*!< SmartCard state information related to Rx operations.
226 This parameter can be a value of @ref HAL_SMARTCARD_StateTypeDef */
227
228 __IO uint32_t ErrorCode; /*!< SmartCard Error code */
229
230 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)
231 void (* TxCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Tx Complete Callback */
232
233 void (* RxCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Rx Complete Callback */
234
235 void (* ErrorCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Error Callback */
236
237 void (* AbortCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Complete Callback */
238
239 void (* AbortTransmitCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Transmit Complete Callback */
240
241 void (* AbortReceiveCpltCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Abort Receive Complete Callback */
242
243 void (* MspInitCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Msp Init callback */
244
245 void (* MspDeInitCallback)(struct __SMARTCARD_HandleTypeDef *hsmartcard); /*!< SMARTCARD Msp DeInit callback */
246 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
247
248 } SMARTCARD_HandleTypeDef;
249
250 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)
251 /**
252 * @brief HAL SMARTCARD Callback ID enumeration definition
253 */
254 typedef enum
255 {
256 HAL_SMARTCARD_TX_COMPLETE_CB_ID = 0x00U, /*!< SMARTCARD Tx Complete Callback ID */
257 HAL_SMARTCARD_RX_COMPLETE_CB_ID = 0x01U, /*!< SMARTCARD Rx Complete Callback ID */
258 HAL_SMARTCARD_ERROR_CB_ID = 0x02U, /*!< SMARTCARD Error Callback ID */
259 HAL_SMARTCARD_ABORT_COMPLETE_CB_ID = 0x03U, /*!< SMARTCARD Abort Complete Callback ID */
260 HAL_SMARTCARD_ABORT_TRANSMIT_COMPLETE_CB_ID = 0x04U, /*!< SMARTCARD Abort Transmit Complete Callback ID */
261 HAL_SMARTCARD_ABORT_RECEIVE_COMPLETE_CB_ID = 0x05U, /*!< SMARTCARD Abort Receive Complete Callback ID */
262
263 HAL_SMARTCARD_MSPINIT_CB_ID = 0x08U, /*!< SMARTCARD MspInit callback ID */
264 HAL_SMARTCARD_MSPDEINIT_CB_ID = 0x09U /*!< SMARTCARD MspDeInit callback ID */
265
266 } HAL_SMARTCARD_CallbackIDTypeDef;
267
268 /**
269 * @brief HAL SMARTCARD Callback pointer definition
270 */
271 typedef void (*pSMARTCARD_CallbackTypeDef)(SMARTCARD_HandleTypeDef *hsmartcard); /*!< pointer to an SMARTCARD callback function */
272
273 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
274
275 /**
276 * @brief SMARTCARD clock sources
277 */
278 typedef enum
279 {
280 SMARTCARD_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */
281 SMARTCARD_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */
282 SMARTCARD_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */
283 SMARTCARD_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */
284 SMARTCARD_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */
285 SMARTCARD_CLOCKSOURCE_UNDEFINED = 0x10U /*!< undefined clock source */
286 } SMARTCARD_ClockSourceTypeDef;
287
288 /**
289 * @}
290 */
291
292 /* Exported constants --------------------------------------------------------*/
293 /** @defgroup SMARTCARD_Exported_Constants SMARTCARD Exported Constants
294 * @{
295 */
296
297 /** @defgroup SMARTCARD_State_Definition SMARTCARD State Code Definition
298 * @{
299 */
300 #define HAL_SMARTCARD_STATE_RESET 0x00000000U /*!< Peripheral is not initialized
301 Value is allowed for gState and RxState */
302 #define HAL_SMARTCARD_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for use
303 Value is allowed for gState and RxState */
304 #define HAL_SMARTCARD_STATE_BUSY 0x00000024U /*!< an internal process is ongoing
305 Value is allowed for gState only */
306 #define HAL_SMARTCARD_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing
307 Value is allowed for gState only */
308 #define HAL_SMARTCARD_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing
309 Value is allowed for RxState only */
310 #define HAL_SMARTCARD_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception process is ongoing
311 Not to be used for neither gState nor RxState.
312 Value is result of combination (Or) between gState and RxState values */
313 #define HAL_SMARTCARD_STATE_TIMEOUT 0x000000A0U /*!< Timeout state
314 Value is allowed for gState only */
315 #define HAL_SMARTCARD_STATE_ERROR 0x000000E0U /*!< Error
316 Value is allowed for gState only */
317 /**
318 * @}
319 */
320
321 /** @defgroup SMARTCARD_Error_Definition SMARTCARD Error Code Definition
322 * @{
323 */
324 #define HAL_SMARTCARD_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
325 #define HAL_SMARTCARD_ERROR_PE ((uint32_t)0x00000001U) /*!< Parity error */
326 #define HAL_SMARTCARD_ERROR_NE ((uint32_t)0x00000002U) /*!< Noise error */
327 #define HAL_SMARTCARD_ERROR_FE ((uint32_t)0x00000004U) /*!< frame error */
328 #define HAL_SMARTCARD_ERROR_ORE ((uint32_t)0x00000008U) /*!< Overrun error */
329 #define HAL_SMARTCARD_ERROR_DMA ((uint32_t)0x00000010U) /*!< DMA transfer error */
330 #define HAL_SMARTCARD_ERROR_RTO ((uint32_t)0x00000020U) /*!< Receiver TimeOut error */
331 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)
332 #define HAL_SMARTCARD_ERROR_INVALID_CALLBACK ((uint32_t)0x00000040U) /*!< Invalid Callback error */
333 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
334 /**
335 * @}
336 */
337
338 /** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length
339 * @{
340 */
341 #define SMARTCARD_WORDLENGTH_9B USART_CR1_M0 /*!< SMARTCARD frame length */
342 /**
343 * @}
344 */
345
346 /** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits
347 * @{
348 */
349 #define SMARTCARD_STOPBITS_0_5 USART_CR2_STOP_0 /*!< SMARTCARD frame with 0.5 stop bit */
350 #define SMARTCARD_STOPBITS_1_5 USART_CR2_STOP /*!< SMARTCARD frame with 1.5 stop bits */
351 /**
352 * @}
353 */
354
355 /** @defgroup SMARTCARD_Parity SMARTCARD Parity
356 * @{
357 */
358 #define SMARTCARD_PARITY_EVEN USART_CR1_PCE /*!< SMARTCARD frame even parity */
359 #define SMARTCARD_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< SMARTCARD frame odd parity */
360 /**
361 * @}
362 */
363
364 /** @defgroup SMARTCARD_Mode SMARTCARD Transfer Mode
365 * @{
366 */
367 #define SMARTCARD_MODE_RX USART_CR1_RE /*!< SMARTCARD RX mode */
368 #define SMARTCARD_MODE_TX USART_CR1_TE /*!< SMARTCARD TX mode */
369 #define SMARTCARD_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< SMARTCARD RX and TX mode */
370 /**
371 * @}
372 */
373
374 /** @defgroup SMARTCARD_Clock_Polarity SMARTCARD Clock Polarity
375 * @{
376 */
377 #define SMARTCARD_POLARITY_LOW 0x00000000U /*!< SMARTCARD frame low polarity */
378 #define SMARTCARD_POLARITY_HIGH USART_CR2_CPOL /*!< SMARTCARD frame high polarity */
379 /**
380 * @}
381 */
382
383 /** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase
384 * @{
385 */
386 #define SMARTCARD_PHASE_1EDGE 0x00000000U /*!< SMARTCARD frame phase on first clock transition */
387 #define SMARTCARD_PHASE_2EDGE USART_CR2_CPHA /*!< SMARTCARD frame phase on second clock transition */
388 /**
389 * @}
390 */
391
392 /** @defgroup SMARTCARD_Last_Bit SMARTCARD Last Bit
393 * @{
394 */
395 #define SMARTCARD_LASTBIT_DISABLE 0x00000000U /*!< SMARTCARD frame last data bit clock pulse not output to SCLK pin */
396 #define SMARTCARD_LASTBIT_ENABLE USART_CR2_LBCL /*!< SMARTCARD frame last data bit clock pulse output to SCLK pin */
397 /**
398 * @}
399 */
400
401 /** @defgroup SMARTCARD_OneBit_Sampling SMARTCARD One Bit Sampling Method
402 * @{
403 */
404 #define SMARTCARD_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< SMARTCARD frame one-bit sample disabled */
405 #define SMARTCARD_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< SMARTCARD frame one-bit sample enabled */
406 /**
407 * @}
408 */
409
410 /** @defgroup SMARTCARD_NACK_Enable SMARTCARD NACK Enable
411 * @{
412 */
413 #define SMARTCARD_NACK_DISABLE 0x00000000U /*!< SMARTCARD NACK transmission disabled */
414 #define SMARTCARD_NACK_ENABLE USART_CR3_NACK /*!< SMARTCARD NACK transmission enabled */
415 /**
416 * @}
417 */
418
419 /** @defgroup SMARTCARD_Timeout_Enable SMARTCARD Timeout Enable
420 * @{
421 */
422 #define SMARTCARD_TIMEOUT_DISABLE 0x00000000U /*!< SMARTCARD receiver timeout disabled */
423 #define SMARTCARD_TIMEOUT_ENABLE USART_CR2_RTOEN /*!< SMARTCARD receiver timeout enabled */
424 /**
425 * @}
426 */
427
428 /** @defgroup SMARTCARD_Tx_Inv SMARTCARD advanced feature TX pin active level inversion
429 * @{
430 */
431 #define SMARTCARD_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */
432 #define SMARTCARD_ADVFEATURE_TXINV_ENABLE USART_CR2_TXINV /*!< TX pin active level inversion enable */
433 /**
434 * @}
435 */
436
437 /** @defgroup SMARTCARD_Rx_Inv SMARTCARD advanced feature RX pin active level inversion
438 * @{
439 */
440 #define SMARTCARD_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */
441 #define SMARTCARD_ADVFEATURE_RXINV_ENABLE USART_CR2_RXINV /*!< RX pin active level inversion enable */
442 /**
443 * @}
444 */
445
446 /** @defgroup SMARTCARD_Data_Inv SMARTCARD advanced feature Binary Data inversion
447 * @{
448 */
449 #define SMARTCARD_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */
450 #define SMARTCARD_ADVFEATURE_DATAINV_ENABLE USART_CR2_DATAINV /*!< Binary data inversion enable */
451 /**
452 * @}
453 */
454
455 /** @defgroup SMARTCARD_Rx_Tx_Swap SMARTCARD advanced feature RX TX pins swap
456 * @{
457 */
458 #define SMARTCARD_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */
459 #define SMARTCARD_ADVFEATURE_SWAP_ENABLE USART_CR2_SWAP /*!< TX/RX pins swap enable */
460 /**
461 * @}
462 */
463
464 /** @defgroup SMARTCARD_Overrun_Disable SMARTCARD advanced feature Overrun Disable
465 * @{
466 */
467 #define SMARTCARD_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */
468 #define SMARTCARD_ADVFEATURE_OVERRUN_DISABLE USART_CR3_OVRDIS /*!< RX overrun disable */
469 /**
470 * @}
471 */
472
473 /** @defgroup SMARTCARD_DMA_Disable_on_Rx_Error SMARTCARD advanced feature DMA Disable on Rx Error
474 * @{
475 */
476 #define SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */
477 #define SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR USART_CR3_DDRE /*!< DMA disable on Reception Error */
478 /**
479 * @}
480 */
481
482 /** @defgroup SMARTCARD_MSB_First SMARTCARD advanced feature MSB first
483 * @{
484 */
485 #define SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received first disable */
486 #define SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE USART_CR2_MSBFIRST /*!< Most significant bit sent/received first enable */
487 /**
488 * @}
489 */
490
491 /** @defgroup SMARTCARD_Request_Parameters SMARTCARD Request Parameters
492 * @{
493 */
494 #define SMARTCARD_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive data flush request */
495 #define SMARTCARD_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush request */
496 /**
497 * @}
498 */
499
500 /** @defgroup SMARTCARD_Interruption_Mask SMARTCARD interruptions flags mask
501 * @{
502 */
503 #define SMARTCARD_IT_MASK 0x001FU /*!< SMARTCARD interruptions flags mask */
504 #define SMARTCARD_CR_MASK 0x00E0U /*!< SMARTCARD control register mask */
505 #define SMARTCARD_CR_POS 5U /*!< SMARTCARD control register position */
506 #define SMARTCARD_ISR_MASK 0x1F00U /*!< SMARTCARD ISR register mask */
507 #define SMARTCARD_ISR_POS 8U /*!< SMARTCARD ISR register position */
508 /**
509 * @}
510 */
511
512 /**
513 * @}
514 */
515
516 /* Exported macros -----------------------------------------------------------*/
517 /** @defgroup SMARTCARD_Exported_Macros SMARTCARD Exported Macros
518 * @{
519 */
520
521 /** @brief Reset SMARTCARD handle states.
522 * @param __HANDLE__ SMARTCARD handle.
523 * @retval None
524 */
525 #if USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1
526 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) do{ \
527 (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET; \
528 (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET; \
529 (__HANDLE__)->MspInitCallback = NULL; \
530 (__HANDLE__)->MspDeInitCallback = NULL; \
531 } while(0U)
532 #else
533 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) do{ \
534 (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET; \
535 (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET; \
536 } while(0U)
537 #endif /*USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
538
539 /** @brief Flush the Smartcard Data registers.
540 * @param __HANDLE__ specifies the SMARTCARD Handle.
541 * @retval None
542 */
543 #define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__) \
544 do{ \
545 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_RXDATA_FLUSH_REQUEST); \
546 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_TXDATA_FLUSH_REQUEST); \
547 } while(0U)
548
549 /** @brief Clear the specified SMARTCARD pending flag.
550 * @param __HANDLE__ specifies the SMARTCARD Handle.
551 * @param __FLAG__ specifies the flag to check.
552 * This parameter can be any combination of the following values:
553 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag
554 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag
555 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag
556 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag
557 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detected clear flag
558 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag
559 * @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag
560 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag
561 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag
562 * @retval None
563 */
564 #define __HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
565
566 /** @brief Clear the SMARTCARD PE pending flag.
567 * @param __HANDLE__ specifies the SMARTCARD Handle.
568 * @retval None
569 */
570 #define __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_PEF)
571
572 /** @brief Clear the SMARTCARD FE pending flag.
573 * @param __HANDLE__ specifies the SMARTCARD Handle.
574 * @retval None
575 */
576 #define __HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_FEF)
577
578 /** @brief Clear the SMARTCARD NE pending flag.
579 * @param __HANDLE__ specifies the SMARTCARD Handle.
580 * @retval None
581 */
582 #define __HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_NEF)
583
584 /** @brief Clear the SMARTCARD ORE pending flag.
585 * @param __HANDLE__ specifies the SMARTCARD Handle.
586 * @retval None
587 */
588 #define __HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_OREF)
589
590 /** @brief Clear the SMARTCARD IDLE pending flag.
591 * @param __HANDLE__ specifies the SMARTCARD Handle.
592 * @retval None
593 */
594 #define __HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_IDLEF)
595
596 /** @brief Check whether the specified Smartcard flag is set or not.
597 * @param __HANDLE__ specifies the SMARTCARD Handle.
598 * @param __FLAG__ specifies the flag to check.
599 * This parameter can be one of the following values:
600 * @arg @ref SMARTCARD_FLAG_TCBGT Transmission complete before guard time flag (when flag available)
601 * @arg @ref SMARTCARD_FLAG_TEACK Transmit enable acknowledge flag
602 * @arg @ref SMARTCARD_FLAG_BUSY Busy flag
603 * @arg @ref SMARTCARD_FLAG_EOBF End of block flag
604 * @arg @ref SMARTCARD_FLAG_RTOF Receiver timeout flag
605 * @arg @ref SMARTCARD_FLAG_TXE Transmit data register empty flag
606 * @arg @ref SMARTCARD_FLAG_TC Transmission complete flag
607 * @arg @ref SMARTCARD_FLAG_RXNE Receive data register not empty flag
608 * @arg @ref SMARTCARD_FLAG_IDLE Idle line detection flag
609 * @arg @ref SMARTCARD_FLAG_ORE Overrun error flag
610 * @arg @ref SMARTCARD_FLAG_NE Noise error flag
611 * @arg @ref SMARTCARD_FLAG_FE Framing error flag
612 * @arg @ref SMARTCARD_FLAG_PE Parity error flag
613 * @retval The new state of __FLAG__ (TRUE or FALSE).
614 */
615 #define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
616
617 /** @brief Enable the specified SmartCard interrupt.
618 * @param __HANDLE__ specifies the SMARTCARD Handle.
619 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to enable.
620 * This parameter can be one of the following values:
621 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
622 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
623 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
624 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
625 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available)
626 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
627 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
628 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
629 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error)
630 * @retval None
631 */
632 #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))): \
633 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >> SMARTCARD_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 |= ((uint32_t)1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
634 ((__HANDLE__)->Instance->CR3 |= ((uint32_t)1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))))
635
636 /** @brief Disable the specified SmartCard interrupt.
637 * @param __HANDLE__ specifies the SMARTCARD Handle.
638 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to disable.
639 * This parameter can be one of the following values:
640 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
641 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
642 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
643 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
644 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available)
645 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
646 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
647 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
648 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error)
649 * @retval None
650 */
651 #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))): \
652 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >> SMARTCARD_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
653 ((__HANDLE__)->Instance->CR3 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))))
654
655 /** @brief Check whether the specified SmartCard interrupt has occurred or not.
656 * @param __HANDLE__ specifies the SMARTCARD Handle.
657 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to check.
658 * This parameter can be one of the following values:
659 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
660 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
661 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
662 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
663 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available)
664 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
665 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
666 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
667 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error)
668 * @retval The new state of __INTERRUPT__ (SET or RESET).
669 */
670 #define __HAL_SMARTCARD_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR & ((uint32_t)0x01U << (((__INTERRUPT__) & SMARTCARD_ISR_MASK)>> SMARTCARD_ISR_POS))) != 0U) ? SET : RESET)
671
672 /** @brief Check whether the specified SmartCard interrupt source is enabled or not.
673 * @param __HANDLE__ specifies the SMARTCARD Handle.
674 * @param __INTERRUPT__ specifies the SMARTCARD interrupt source to check.
675 * This parameter can be one of the following values:
676 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
677 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
678 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
679 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
680 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available)
681 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
682 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
683 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
684 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error)
685 * @retval The new state of __INTERRUPT__ (SET or RESET).
686 */
687 #define __HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((__INTERRUPT__) & SMARTCARD_CR_MASK) >> SMARTCARD_CR_POS) == 0x01U)? (__HANDLE__)->Instance->CR1 : \
688 (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >> SMARTCARD_CR_POS) == 0x02U)? (__HANDLE__)->Instance->CR2 : \
689 (__HANDLE__)->Instance->CR3)) & ((uint32_t)0x01U << (((uint16_t)(__INTERRUPT__)) & SMARTCARD_IT_MASK))) != 0U) ? SET : RESET)
690
691 /** @brief Clear the specified SMARTCARD ISR flag, in setting the proper ICR register flag.
692 * @param __HANDLE__ specifies the SMARTCARD Handle.
693 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
694 * to clear the corresponding interrupt.
695 * This parameter can be one of the following values:
696 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag
697 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag
698 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag
699 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag
700 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detection clear flag
701 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag
702 * @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag (when flag available)
703 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag
704 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag
705 * @retval None
706 */
707 #define __HAL_SMARTCARD_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR |= (uint32_t)(__IT_CLEAR__))
708
709 /** @brief Set a specific SMARTCARD request flag.
710 * @param __HANDLE__ specifies the SMARTCARD Handle.
711 * @param __REQ__ specifies the request flag to set
712 * This parameter can be one of the following values:
713 * @arg @ref SMARTCARD_RXDATA_FLUSH_REQUEST Receive data flush Request
714 * @arg @ref SMARTCARD_TXDATA_FLUSH_REQUEST Transmit data flush Request
715 * @retval None
716 */
717 #define __HAL_SMARTCARD_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
718
719 /** @brief Enable the SMARTCARD one bit sample method.
720 * @param __HANDLE__ specifies the SMARTCARD Handle.
721 * @retval None
722 */
723 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
724
725 /** @brief Disable the SMARTCARD one bit sample method.
726 * @param __HANDLE__ specifies the SMARTCARD Handle.
727 * @retval None
728 */
729 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
730
731 /** @brief Enable the USART associated to the SMARTCARD Handle.
732 * @param __HANDLE__ specifies the SMARTCARD Handle.
733 * @retval None
734 */
735 #define __HAL_SMARTCARD_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
736
737 /** @brief Disable the USART associated to the SMARTCARD Handle
738 * @param __HANDLE__ specifies the SMARTCARD Handle.
739 * @retval None
740 */
741 #define __HAL_SMARTCARD_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
742
743 /**
744 * @}
745 */
746
747 /* Private macros -------------------------------------------------------------*/
748 /** @defgroup SMARTCARD_Private_Macros SMARTCARD Private Macros
749 * @{
750 */
751
752 /** @brief Report the SMARTCARD clock source.
753 * @param __HANDLE__ specifies the SMARTCARD Handle.
754 * @param __CLOCKSOURCE__ output variable.
755 * @retval the SMARTCARD clocking source, written in __CLOCKSOURCE__.
756 */
757 #define SMARTCARD_GETCLOCKSOURCE(__HANDLE__, __CLOCKSOURCE__) \
758 do { \
759 if((__HANDLE__)->Instance == USART1) \
760 { \
761 switch(__HAL_RCC_GET_USART1_SOURCE()) \
762 { \
763 case RCC_USART1CLKSOURCE_PCLK2: \
764 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK2; \
765 break; \
766 case RCC_USART1CLKSOURCE_HSI: \
767 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
768 break; \
769 case RCC_USART1CLKSOURCE_SYSCLK: \
770 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
771 break; \
772 case RCC_USART1CLKSOURCE_LSE: \
773 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
774 break; \
775 default: \
776 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
777 break; \
778 } \
779 } \
780 else if((__HANDLE__)->Instance == USART2) \
781 { \
782 switch(__HAL_RCC_GET_USART2_SOURCE()) \
783 { \
784 case RCC_USART2CLKSOURCE_PCLK1: \
785 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \
786 break; \
787 case RCC_USART2CLKSOURCE_HSI: \
788 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
789 break; \
790 case RCC_USART2CLKSOURCE_SYSCLK: \
791 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
792 break; \
793 case RCC_USART2CLKSOURCE_LSE: \
794 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
795 break; \
796 default: \
797 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
798 break; \
799 } \
800 } \
801 else if((__HANDLE__)->Instance == USART3) \
802 { \
803 switch(__HAL_RCC_GET_USART3_SOURCE()) \
804 { \
805 case RCC_USART3CLKSOURCE_PCLK1: \
806 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \
807 break; \
808 case RCC_USART3CLKSOURCE_HSI: \
809 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
810 break; \
811 case RCC_USART3CLKSOURCE_SYSCLK: \
812 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
813 break; \
814 case RCC_USART3CLKSOURCE_LSE: \
815 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
816 break; \
817 default: \
818 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
819 break; \
820 } \
821 } \
822 else if((__HANDLE__)->Instance == USART6) \
823 { \
824 switch(__HAL_RCC_GET_USART6_SOURCE()) \
825 { \
826 case RCC_USART6CLKSOURCE_PCLK2: \
827 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK2; \
828 break; \
829 case RCC_USART6CLKSOURCE_HSI: \
830 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
831 break; \
832 case RCC_USART6CLKSOURCE_SYSCLK: \
833 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
834 break; \
835 case RCC_USART6CLKSOURCE_LSE: \
836 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
837 break; \
838 default: \
839 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
840 break; \
841 } \
842 } \
843 else \
844 { \
845 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
846 } \
847 } while(0U)
848
849 /** @brief Check the Baud rate range.
850 * @note The maximum Baud Rate is derived from the maximum clock on F7 (216 MHz)
851 * divided by the oversampling used on the SMARTCARD (i.e. 16).
852 * @param __BAUDRATE__ Baud rate set by the configuration function.
853 * @retval Test result (TRUE or FALSE)
854 */
855 #define IS_SMARTCARD_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 13500001U)
856
857 /** @brief Check the block length range.
858 * @note The maximum SMARTCARD block length is 0xFF.
859 * @param __LENGTH__ block length.
860 * @retval Test result (TRUE or FALSE)
861 */
862 #define IS_SMARTCARD_BLOCKLENGTH(__LENGTH__) ((__LENGTH__) <= 0xFFU)
863
864 /** @brief Check the receiver timeout value.
865 * @note The maximum SMARTCARD receiver timeout value is 0xFFFFFF.
866 * @param __TIMEOUTVALUE__ receiver timeout value.
867 * @retval Test result (TRUE or FALSE)
868 */
869 #define IS_SMARTCARD_TIMEOUT_VALUE(__TIMEOUTVALUE__) ((__TIMEOUTVALUE__) <= 0xFFFFFFU)
870
871 /** @brief Check the SMARTCARD autoretry counter value.
872 * @note The maximum number of retransmissions is 0x7.
873 * @param __COUNT__ number of retransmissions.
874 * @retval Test result (TRUE or FALSE)
875 */
876 #define IS_SMARTCARD_AUTORETRY_COUNT(__COUNT__) ((__COUNT__) <= 0x7U)
877
878 /** @brief Ensure that SMARTCARD frame length is valid.
879 * @param __LENGTH__ SMARTCARD frame length.
880 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
881 */
882 #define IS_SMARTCARD_WORD_LENGTH(__LENGTH__) ((__LENGTH__) == SMARTCARD_WORDLENGTH_9B)
883
884 /** @brief Ensure that SMARTCARD frame number of stop bits is valid.
885 * @param __STOPBITS__ SMARTCARD frame number of stop bits.
886 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
887 */
888 #define IS_SMARTCARD_STOPBITS(__STOPBITS__) (((__STOPBITS__) == SMARTCARD_STOPBITS_0_5) ||\
889 ((__STOPBITS__) == SMARTCARD_STOPBITS_1_5))
890
891 /** @brief Ensure that SMARTCARD frame parity is valid.
892 * @param __PARITY__ SMARTCARD frame parity.
893 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
894 */
895 #define IS_SMARTCARD_PARITY(__PARITY__) (((__PARITY__) == SMARTCARD_PARITY_EVEN) || \
896 ((__PARITY__) == SMARTCARD_PARITY_ODD))
897
898 /** @brief Ensure that SMARTCARD communication mode is valid.
899 * @param __MODE__ SMARTCARD communication mode.
900 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
901 */
902 #define IS_SMARTCARD_MODE(__MODE__) ((((__MODE__) & 0xFFF3U) == 0x00U) && ((__MODE__) != 0x00U))
903
904 /** @brief Ensure that SMARTCARD frame polarity is valid.
905 * @param __CPOL__ SMARTCARD frame polarity.
906 * @retval SET (__CPOL__ is valid) or RESET (__CPOL__ is invalid)
907 */
908 #define IS_SMARTCARD_POLARITY(__CPOL__) (((__CPOL__) == SMARTCARD_POLARITY_LOW) || ((__CPOL__) == SMARTCARD_POLARITY_HIGH))
909
910 /** @brief Ensure that SMARTCARD frame phase is valid.
911 * @param __CPHA__ SMARTCARD frame phase.
912 * @retval SET (__CPHA__ is valid) or RESET (__CPHA__ is invalid)
913 */
914 #define IS_SMARTCARD_PHASE(__CPHA__) (((__CPHA__) == SMARTCARD_PHASE_1EDGE) || ((__CPHA__) == SMARTCARD_PHASE_2EDGE))
915
916 /** @brief Ensure that SMARTCARD frame last bit clock pulse setting is valid.
917 * @param __LASTBIT__ SMARTCARD frame last bit clock pulse setting.
918 * @retval SET (__LASTBIT__ is valid) or RESET (__LASTBIT__ is invalid)
919 */
920 #define IS_SMARTCARD_LASTBIT(__LASTBIT__) (((__LASTBIT__) == SMARTCARD_LASTBIT_DISABLE) || \
921 ((__LASTBIT__) == SMARTCARD_LASTBIT_ENABLE))
922
923 /** @brief Ensure that SMARTCARD frame sampling is valid.
924 * @param __ONEBIT__ SMARTCARD frame sampling.
925 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
926 */
927 #define IS_SMARTCARD_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_DISABLE) || \
928 ((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_ENABLE))
929
930 /** @brief Ensure that SMARTCARD NACK transmission setting is valid.
931 * @param __NACK__ SMARTCARD NACK transmission setting.
932 * @retval SET (__NACK__ is valid) or RESET (__NACK__ is invalid)
933 */
934 #define IS_SMARTCARD_NACK(__NACK__) (((__NACK__) == SMARTCARD_NACK_ENABLE) || \
935 ((__NACK__) == SMARTCARD_NACK_DISABLE))
936
937 /** @brief Ensure that SMARTCARD receiver timeout setting is valid.
938 * @param __TIMEOUT__ SMARTCARD receiver timeout setting.
939 * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid)
940 */
941 #define IS_SMARTCARD_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == SMARTCARD_TIMEOUT_DISABLE) || \
942 ((__TIMEOUT__) == SMARTCARD_TIMEOUT_ENABLE))
943
944 /** @brief Ensure that SMARTCARD advanced features initialization is valid.
945 * @param __INIT__ SMARTCARD advanced features initialization.
946 * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid)
947 */
948 #define IS_SMARTCARD_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (SMARTCARD_ADVFEATURE_NO_INIT | \
949 SMARTCARD_ADVFEATURE_TXINVERT_INIT | \
950 SMARTCARD_ADVFEATURE_RXINVERT_INIT | \
951 SMARTCARD_ADVFEATURE_DATAINVERT_INIT | \
952 SMARTCARD_ADVFEATURE_SWAP_INIT | \
953 SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT | \
954 SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT | \
955 SMARTCARD_ADVFEATURE_MSBFIRST_INIT))
956
957 /** @brief Ensure that SMARTCARD frame TX inversion setting is valid.
958 * @param __TXINV__ SMARTCARD frame TX inversion setting.
959 * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid)
960 */
961 #define IS_SMARTCARD_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_DISABLE) || \
962 ((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_ENABLE))
963
964 /** @brief Ensure that SMARTCARD frame RX inversion setting is valid.
965 * @param __RXINV__ SMARTCARD frame RX inversion setting.
966 * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid)
967 */
968 #define IS_SMARTCARD_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_DISABLE) || \
969 ((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_ENABLE))
970
971 /** @brief Ensure that SMARTCARD frame data inversion setting is valid.
972 * @param __DATAINV__ SMARTCARD frame data inversion setting.
973 * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid)
974 */
975 #define IS_SMARTCARD_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_DISABLE) || \
976 ((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_ENABLE))
977
978 /** @brief Ensure that SMARTCARD frame RX/TX pins swap setting is valid.
979 * @param __SWAP__ SMARTCARD frame RX/TX pins swap setting.
980 * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid)
981 */
982 #define IS_SMARTCARD_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_DISABLE) || \
983 ((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_ENABLE))
984
985 /** @brief Ensure that SMARTCARD frame overrun setting is valid.
986 * @param __OVERRUN__ SMARTCARD frame overrun setting.
987 * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid)
988 */
989 #define IS_SMARTCARD_OVERRUN(__OVERRUN__) (((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_ENABLE) || \
990 ((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_DISABLE))
991
992 /** @brief Ensure that SMARTCARD DMA enabling or disabling on error setting is valid.
993 * @param __DMA__ SMARTCARD DMA enabling or disabling on error setting.
994 * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid)
995 */
996 #define IS_SMARTCARD_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR) || \
997 ((__DMA__) == SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR))
998
999 /** @brief Ensure that SMARTCARD frame MSB first setting is valid.
1000 * @param __MSBFIRST__ SMARTCARD frame MSB first setting.
1001 * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid)
1002 */
1003 #define IS_SMARTCARD_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE) || \
1004 ((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE))
1005
1006 /** @brief Ensure that SMARTCARD request parameter is valid.
1007 * @param __PARAM__ SMARTCARD request parameter.
1008 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
1009 */
1010 #define IS_SMARTCARD_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == SMARTCARD_RXDATA_FLUSH_REQUEST) || \
1011 ((__PARAM__) == SMARTCARD_TXDATA_FLUSH_REQUEST))
1012
1013 /**
1014 * @}
1015 */
1016
1017 /* Include SMARTCARD HAL Extended module */
1018 #include "stm32f7xx_hal_smartcard_ex.h"
1019
1020 /* Exported functions --------------------------------------------------------*/
1021 /** @addtogroup SMARTCARD_Exported_Functions
1022 * @{
1023 */
1024
1025 /* Initialization and de-initialization functions ****************************/
1026 /** @addtogroup SMARTCARD_Exported_Functions_Group1
1027 * @{
1028 */
1029
1030 HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsmartcard);
1031 HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsmartcard);
1032 void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsmartcard);
1033 void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsmartcard);
1034
1035 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)
1036 /* Callbacks Register/UnRegister functions ***********************************/
1037 HAL_StatusTypeDef HAL_SMARTCARD_RegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard, HAL_SMARTCARD_CallbackIDTypeDef CallbackID, pSMARTCARD_CallbackTypeDef pCallback);
1038 HAL_StatusTypeDef HAL_SMARTCARD_UnRegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard, HAL_SMARTCARD_CallbackIDTypeDef CallbackID);
1039 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
1040
1041 /**
1042 * @}
1043 */
1044
1045 /* IO operation functions *****************************************************/
1046 /** @addtogroup SMARTCARD_Exported_Functions_Group2
1047 * @{
1048 */
1049
1050 HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size, uint32_t Timeout);
1051 HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size, uint32_t Timeout);
1052 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1053 HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1054 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1055 HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1056 /* Transfer Abort functions */
1057 HAL_StatusTypeDef HAL_SMARTCARD_Abort(SMARTCARD_HandleTypeDef *hsmartcard);
1058 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit(SMARTCARD_HandleTypeDef *hsmartcard);
1059 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive(SMARTCARD_HandleTypeDef *hsmartcard);
1060 HAL_StatusTypeDef HAL_SMARTCARD_Abort_IT(SMARTCARD_HandleTypeDef *hsmartcard);
1061 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit_IT(SMARTCARD_HandleTypeDef *hsmartcard);
1062 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive_IT(SMARTCARD_HandleTypeDef *hsmartcard);
1063
1064 void HAL_SMARTCARD_IRQHandler(SMARTCARD_HandleTypeDef *hsmartcard);
1065 void HAL_SMARTCARD_TxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1066 void HAL_SMARTCARD_RxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1067 void HAL_SMARTCARD_ErrorCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1068 void HAL_SMARTCARD_AbortCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1069 void HAL_SMARTCARD_AbortTransmitCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1070 void HAL_SMARTCARD_AbortReceiveCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1071
1072 /**
1073 * @}
1074 */
1075
1076 /* Peripheral State and Error functions ***************************************/
1077 /** @addtogroup SMARTCARD_Exported_Functions_Group4
1078 * @{
1079 */
1080
1081 HAL_SMARTCARD_StateTypeDef HAL_SMARTCARD_GetState(SMARTCARD_HandleTypeDef *hsmartcard);
1082 uint32_t HAL_SMARTCARD_GetError(SMARTCARD_HandleTypeDef *hsmartcard);
1083
1084 /**
1085 * @}
1086 */
1087
1088 /**
1089 * @}
1090 */
1091
1092 /**
1093 * @}
1094 */
1095
1096 /**
1097 * @}
1098 */
1099
1100 #ifdef __cplusplus
1101 }
1102 #endif
1103
1104 #endif /* STM32F7xx_HAL_SMARTCARD_H */
1105
1106 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/