?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Merge pull request #11189 from klutvott123/move-telemetry-displayport-init
[betaflight.git] / lib / main / STM32G4 / Drivers / STM32G4xx_HAL_Driver / Inc / stm32g4xx_hal_smartcard.h
blob25b7818e0cd3697225dd6841630b07bdadeb5dc0
1 /**
2 ******************************************************************************
3 * @file stm32g4xx_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 STM32G4xx_HAL_SMARTCARD_H
22 #define STM32G4xx_HAL_SMARTCARD_H
23
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32g4xx_hal_def.h"
30
31 /** @addtogroup STM32G4xx_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_PCLK1 = 0x00U, /*!< PCLK1 clock source */
296 SMARTCARD_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */
297 SMARTCARD_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */
298 SMARTCARD_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */
299 SMARTCARD_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */
300 SMARTCARD_CLOCKSOURCE_UNDEFINED = 0x10U /*!< undefined clock source */
301 } SMARTCARD_ClockSourceTypeDef;
302
303 /**
304 * @}
305 */
306
307 /* Exported constants --------------------------------------------------------*/
308 /** @defgroup SMARTCARD_Exported_Constants SMARTCARD Exported Constants
309 * @{
310 */
311
312 /** @defgroup SMARTCARD_State_Definition SMARTCARD State Code Definition
313 * @{
314 */
315 #define HAL_SMARTCARD_STATE_RESET 0x00000000U /*!< Peripheral is not initialized
316 Value is allowed for gState and RxState */
317 #define HAL_SMARTCARD_STATE_READY 0x00000020U /*!< Peripheral Initialized and ready for use
318 Value is allowed for gState and RxState */
319 #define HAL_SMARTCARD_STATE_BUSY 0x00000024U /*!< an internal process is ongoing
320 Value is allowed for gState only */
321 #define HAL_SMARTCARD_STATE_BUSY_TX 0x00000021U /*!< Data Transmission process is ongoing
322 Value is allowed for gState only */
323 #define HAL_SMARTCARD_STATE_BUSY_RX 0x00000022U /*!< Data Reception process is ongoing
324 Value is allowed for RxState only */
325 #define HAL_SMARTCARD_STATE_BUSY_TX_RX 0x00000023U /*!< Data Transmission and Reception process is ongoing
326 Not to be used for neither gState nor RxState.
327 Value is result of combination (Or) between gState and RxState values */
328 #define HAL_SMARTCARD_STATE_TIMEOUT 0x000000A0U /*!< Timeout state
329 Value is allowed for gState only */
330 #define HAL_SMARTCARD_STATE_ERROR 0x000000E0U /*!< Error
331 Value is allowed for gState only */
332 /**
333 * @}
334 */
335
336 /** @defgroup SMARTCARD_Error_Definition SMARTCARD Error Code Definition
337 * @{
338 */
339 #define HAL_SMARTCARD_ERROR_NONE ((uint32_t)0x00000000U) /*!< No error */
340 #define HAL_SMARTCARD_ERROR_PE ((uint32_t)0x00000001U) /*!< Parity error */
341 #define HAL_SMARTCARD_ERROR_NE ((uint32_t)0x00000002U) /*!< Noise error */
342 #define HAL_SMARTCARD_ERROR_FE ((uint32_t)0x00000004U) /*!< frame error */
343 #define HAL_SMARTCARD_ERROR_ORE ((uint32_t)0x00000008U) /*!< Overrun error */
344 #define HAL_SMARTCARD_ERROR_DMA ((uint32_t)0x00000010U) /*!< DMA transfer error */
345 #define HAL_SMARTCARD_ERROR_RTO ((uint32_t)0x00000020U) /*!< Receiver TimeOut error */
346 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)
347 #define HAL_SMARTCARD_ERROR_INVALID_CALLBACK ((uint32_t)0x00000040U) /*!< Invalid Callback error */
348 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
349 /**
350 * @}
351 */
352
353 /** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length
354 * @{
355 */
356 #define SMARTCARD_WORDLENGTH_9B USART_CR1_M0 /*!< SMARTCARD frame length */
357 /**
358 * @}
359 */
360
361 /** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits
362 * @{
363 */
364 #define SMARTCARD_STOPBITS_0_5 USART_CR2_STOP_0 /*!< SMARTCARD frame with 0.5 stop bit */
365 #define SMARTCARD_STOPBITS_1_5 USART_CR2_STOP /*!< SMARTCARD frame with 1.5 stop bits */
366 /**
367 * @}
368 */
369
370 /** @defgroup SMARTCARD_Parity SMARTCARD Parity
371 * @{
372 */
373 #define SMARTCARD_PARITY_EVEN USART_CR1_PCE /*!< SMARTCARD frame even parity */
374 #define SMARTCARD_PARITY_ODD (USART_CR1_PCE | USART_CR1_PS) /*!< SMARTCARD frame odd parity */
375 /**
376 * @}
377 */
378
379 /** @defgroup SMARTCARD_Mode SMARTCARD Transfer Mode
380 * @{
381 */
382 #define SMARTCARD_MODE_RX USART_CR1_RE /*!< SMARTCARD RX mode */
383 #define SMARTCARD_MODE_TX USART_CR1_TE /*!< SMARTCARD TX mode */
384 #define SMARTCARD_MODE_TX_RX (USART_CR1_TE |USART_CR1_RE) /*!< SMARTCARD RX and TX mode */
385 /**
386 * @}
387 */
388
389 /** @defgroup SMARTCARD_Clock_Polarity SMARTCARD Clock Polarity
390 * @{
391 */
392 #define SMARTCARD_POLARITY_LOW 0x00000000U /*!< SMARTCARD frame low polarity */
393 #define SMARTCARD_POLARITY_HIGH USART_CR2_CPOL /*!< SMARTCARD frame high polarity */
394 /**
395 * @}
396 */
397
398 /** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase
399 * @{
400 */
401 #define SMARTCARD_PHASE_1EDGE 0x00000000U /*!< SMARTCARD frame phase on first clock transition */
402 #define SMARTCARD_PHASE_2EDGE USART_CR2_CPHA /*!< SMARTCARD frame phase on second clock transition */
403 /**
404 * @}
405 */
406
407 /** @defgroup SMARTCARD_Last_Bit SMARTCARD Last Bit
408 * @{
409 */
410 #define SMARTCARD_LASTBIT_DISABLE 0x00000000U /*!< SMARTCARD frame last data bit clock pulse not output to SCLK pin */
411 #define SMARTCARD_LASTBIT_ENABLE USART_CR2_LBCL /*!< SMARTCARD frame last data bit clock pulse output to SCLK pin */
412 /**
413 * @}
414 */
415
416 /** @defgroup SMARTCARD_OneBit_Sampling SMARTCARD One Bit Sampling Method
417 * @{
418 */
419 #define SMARTCARD_ONE_BIT_SAMPLE_DISABLE 0x00000000U /*!< SMARTCARD frame one-bit sample disabled */
420 #define SMARTCARD_ONE_BIT_SAMPLE_ENABLE USART_CR3_ONEBIT /*!< SMARTCARD frame one-bit sample enabled */
421 /**
422 * @}
423 */
424
425 /** @defgroup SMARTCARD_NACK_Enable SMARTCARD NACK Enable
426 * @{
427 */
428 #define SMARTCARD_NACK_DISABLE 0x00000000U /*!< SMARTCARD NACK transmission disabled */
429 #define SMARTCARD_NACK_ENABLE USART_CR3_NACK /*!< SMARTCARD NACK transmission enabled */
430 /**
431 * @}
432 */
433
434 /** @defgroup SMARTCARD_Timeout_Enable SMARTCARD Timeout Enable
435 * @{
436 */
437 #define SMARTCARD_TIMEOUT_DISABLE 0x00000000U /*!< SMARTCARD receiver timeout disabled */
438 #define SMARTCARD_TIMEOUT_ENABLE USART_CR2_RTOEN /*!< SMARTCARD receiver timeout enabled */
439 /**
440 * @}
441 */
442
443 /** @defgroup SMARTCARD_ClockPrescaler Clock Prescaler
444 * @{
445 */
446 #define SMARTCARD_PRESCALER_DIV1 0x00000000U /*!< fclk_pres = fclk */
447 #define SMARTCARD_PRESCALER_DIV2 0x00000001U /*!< fclk_pres = fclk/2 */
448 #define SMARTCARD_PRESCALER_DIV4 0x00000002U /*!< fclk_pres = fclk/4 */
449 #define SMARTCARD_PRESCALER_DIV6 0x00000003U /*!< fclk_pres = fclk/6 */
450 #define SMARTCARD_PRESCALER_DIV8 0x00000004U /*!< fclk_pres = fclk/8 */
451 #define SMARTCARD_PRESCALER_DIV10 0x00000005U /*!< fclk_pres = fclk/10 */
452 #define SMARTCARD_PRESCALER_DIV12 0x00000006U /*!< fclk_pres = fclk/12 */
453 #define SMARTCARD_PRESCALER_DIV16 0x00000007U /*!< fclk_pres = fclk/16 */
454 #define SMARTCARD_PRESCALER_DIV32 0x00000008U /*!< fclk_pres = fclk/32 */
455 #define SMARTCARD_PRESCALER_DIV64 0x00000009U /*!< fclk_pres = fclk/64 */
456 #define SMARTCARD_PRESCALER_DIV128 0x0000000AU /*!< fclk_pres = fclk/128 */
457 #define SMARTCARD_PRESCALER_DIV256 0x0000000BU /*!< fclk_pres = fclk/256 */
458 /**
459 * @}
460 */
461
462 /** @defgroup SMARTCARD_Tx_Inv SMARTCARD advanced feature TX pin active level inversion
463 * @{
464 */
465 #define SMARTCARD_ADVFEATURE_TXINV_DISABLE 0x00000000U /*!< TX pin active level inversion disable */
466 #define SMARTCARD_ADVFEATURE_TXINV_ENABLE USART_CR2_TXINV /*!< TX pin active level inversion enable */
467 /**
468 * @}
469 */
470
471 /** @defgroup SMARTCARD_Rx_Inv SMARTCARD advanced feature RX pin active level inversion
472 * @{
473 */
474 #define SMARTCARD_ADVFEATURE_RXINV_DISABLE 0x00000000U /*!< RX pin active level inversion disable */
475 #define SMARTCARD_ADVFEATURE_RXINV_ENABLE USART_CR2_RXINV /*!< RX pin active level inversion enable */
476 /**
477 * @}
478 */
479
480 /** @defgroup SMARTCARD_Data_Inv SMARTCARD advanced feature Binary Data inversion
481 * @{
482 */
483 #define SMARTCARD_ADVFEATURE_DATAINV_DISABLE 0x00000000U /*!< Binary data inversion disable */
484 #define SMARTCARD_ADVFEATURE_DATAINV_ENABLE USART_CR2_DATAINV /*!< Binary data inversion enable */
485 /**
486 * @}
487 */
488
489 /** @defgroup SMARTCARD_Rx_Tx_Swap SMARTCARD advanced feature RX TX pins swap
490 * @{
491 */
492 #define SMARTCARD_ADVFEATURE_SWAP_DISABLE 0x00000000U /*!< TX/RX pins swap disable */
493 #define SMARTCARD_ADVFEATURE_SWAP_ENABLE USART_CR2_SWAP /*!< TX/RX pins swap enable */
494 /**
495 * @}
496 */
497
498 /** @defgroup SMARTCARD_Overrun_Disable SMARTCARD advanced feature Overrun Disable
499 * @{
500 */
501 #define SMARTCARD_ADVFEATURE_OVERRUN_ENABLE 0x00000000U /*!< RX overrun enable */
502 #define SMARTCARD_ADVFEATURE_OVERRUN_DISABLE USART_CR3_OVRDIS /*!< RX overrun disable */
503 /**
504 * @}
505 */
506
507 /** @defgroup SMARTCARD_DMA_Disable_on_Rx_Error SMARTCARD advanced feature DMA Disable on Rx Error
508 * @{
509 */
510 #define SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR 0x00000000U /*!< DMA enable on Reception Error */
511 #define SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR USART_CR3_DDRE /*!< DMA disable on Reception Error */
512 /**
513 * @}
514 */
515
516 /** @defgroup SMARTCARD_MSB_First SMARTCARD advanced feature MSB first
517 * @{
518 */
519 #define SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE 0x00000000U /*!< Most significant bit sent/received first disable */
520 #define SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE USART_CR2_MSBFIRST /*!< Most significant bit sent/received first enable */
521 /**
522 * @}
523 */
524
525 /** @defgroup SMARTCARD_Request_Parameters SMARTCARD Request Parameters
526 * @{
527 */
528 #define SMARTCARD_RXDATA_FLUSH_REQUEST USART_RQR_RXFRQ /*!< Receive data flush request */
529 #define SMARTCARD_TXDATA_FLUSH_REQUEST USART_RQR_TXFRQ /*!< Transmit data flush request */
530 /**
531 * @}
532 */
533
534 /** @defgroup SMARTCARD_Interruption_Mask SMARTCARD interruptions flags mask
535 * @{
536 */
537 #define SMARTCARD_IT_MASK 0x001FU /*!< SMARTCARD interruptions flags mask */
538 #define SMARTCARD_CR_MASK 0x00E0U /*!< SMARTCARD control register mask */
539 #define SMARTCARD_CR_POS 5U /*!< SMARTCARD control register position */
540 #define SMARTCARD_ISR_MASK 0x1F00U /*!< SMARTCARD ISR register mask */
541 #define SMARTCARD_ISR_POS 8U /*!< SMARTCARD ISR register position */
542 /**
543 * @}
544 */
545
546 /**
547 * @}
548 */
549
550 /* Exported macros -----------------------------------------------------------*/
551 /** @defgroup SMARTCARD_Exported_Macros SMARTCARD Exported Macros
552 * @{
553 */
554
555 /** @brief Reset SMARTCARD handle states.
556 * @param __HANDLE__ SMARTCARD handle.
557 * @retval None
558 */
559 #if USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1
560 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) do{ \
561 (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET; \
562 (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET; \
563 (__HANDLE__)->MspInitCallback = NULL; \
564 (__HANDLE__)->MspDeInitCallback = NULL; \
565 } while(0U)
566 #else
567 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) do{ \
568 (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET; \
569 (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET; \
570 } while(0U)
571 #endif /*USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
572
573 /** @brief Flush the Smartcard Data registers.
574 * @param __HANDLE__ specifies the SMARTCARD Handle.
575 * @retval None
576 */
577 #define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__) \
578 do{ \
579 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_RXDATA_FLUSH_REQUEST); \
580 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_TXDATA_FLUSH_REQUEST); \
581 } while(0U)
582
583 /** @brief Clear the specified SMARTCARD pending flag.
584 * @param __HANDLE__ specifies the SMARTCARD Handle.
585 * @param __FLAG__ specifies the flag to check.
586 * This parameter can be any combination of the following values:
587 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag
588 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag
589 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag
590 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag
591 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detected clear flag
592 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag
593 * @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag
594 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag
595 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag
596 * @arg @ref SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear flag
597 * @retval None
598 */
599 #define __HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
600
601 /** @brief Clear the SMARTCARD PE pending flag.
602 * @param __HANDLE__ specifies the SMARTCARD Handle.
603 * @retval None
604 */
605 #define __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_PEF)
606
607 /** @brief Clear the SMARTCARD FE pending flag.
608 * @param __HANDLE__ specifies the SMARTCARD Handle.
609 * @retval None
610 */
611 #define __HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_FEF)
612
613 /** @brief Clear the SMARTCARD NE pending flag.
614 * @param __HANDLE__ specifies the SMARTCARD Handle.
615 * @retval None
616 */
617 #define __HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_NEF)
618
619 /** @brief Clear the SMARTCARD ORE pending flag.
620 * @param __HANDLE__ specifies the SMARTCARD Handle.
621 * @retval None
622 */
623 #define __HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_OREF)
624
625 /** @brief Clear the SMARTCARD IDLE pending flag.
626 * @param __HANDLE__ specifies the SMARTCARD Handle.
627 * @retval None
628 */
629 #define __HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_IDLEF)
630
631 /** @brief Check whether the specified Smartcard flag is set or not.
632 * @param __HANDLE__ specifies the SMARTCARD Handle.
633 * @param __FLAG__ specifies the flag to check.
634 * This parameter can be one of the following values:
635 * @arg @ref SMARTCARD_FLAG_TCBGT Transmission complete before guard time flag (when flag available)
636 * @arg @ref SMARTCARD_FLAG_REACK Receive enable acknowledge flag
637 * @arg @ref SMARTCARD_FLAG_TEACK Transmit enable acknowledge flag
638 * @arg @ref SMARTCARD_FLAG_BUSY Busy flag
639 * @arg @ref SMARTCARD_FLAG_EOBF End of block flag
640 * @arg @ref SMARTCARD_FLAG_RTOF Receiver timeout flag
641 * @arg @ref SMARTCARD_FLAG_TXE Transmit data register empty flag
642 * @arg @ref SMARTCARD_FLAG_TC Transmission complete flag
643 * @arg @ref SMARTCARD_FLAG_RXNE Receive data register not empty flag
644 * @arg @ref SMARTCARD_FLAG_IDLE Idle line detection flag
645 * @arg @ref SMARTCARD_FLAG_ORE Overrun error flag
646 * @arg @ref SMARTCARD_FLAG_NE Noise error flag
647 * @arg @ref SMARTCARD_FLAG_FE Framing error flag
648 * @arg @ref SMARTCARD_FLAG_PE Parity error flag
649 * @arg @ref SMARTCARD_FLAG_TXFNF TXFIFO not full flag
650 * @arg @ref SMARTCARD_FLAG_RXFNE RXFIFO not empty flag
651 * @arg @ref SMARTCARD_FLAG_TXFE TXFIFO Empty flag
652 * @arg @ref SMARTCARD_FLAG_RXFF RXFIFO Full flag
653 * @arg @ref SMARTCARD_FLAG_RXFT SMARTCARD RXFIFO threshold flag
654 * @arg @ref SMARTCARD_FLAG_TXFT SMARTCARD TXFIFO threshold flag
655 * @retval The new state of __FLAG__ (TRUE or FALSE).
656 */
657 #define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
658
659 /** @brief Enable the specified SmartCard interrupt.
660 * @param __HANDLE__ specifies the SMARTCARD Handle.
661 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to enable.
662 * This parameter can be one of the following values:
663 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
664 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
665 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
666 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
667 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available)
668 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
669 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
670 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
671 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error)
672 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption
673 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption
674 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption
675 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption
676 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption
677 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption
678 * @retval None
679 */
680 #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))): \
681 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >> SMARTCARD_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 |= ((uint32_t)1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
682 ((__HANDLE__)->Instance->CR3 |= ((uint32_t)1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))))
683
684 /** @brief Disable the specified SmartCard interrupt.
685 * @param __HANDLE__ specifies the SMARTCARD Handle.
686 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to disable.
687 * This parameter can be one of the following values:
688 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
689 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
690 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
691 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
692 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available)
693 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
694 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
695 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
696 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error)
697 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption
698 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption
699 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption
700 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption
701 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption
702 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption
703 * @retval None
704 */
705 #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))): \
706 ((((__INTERRUPT__) & SMARTCARD_CR_MASK) >> SMARTCARD_CR_POS) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
707 ((__HANDLE__)->Instance->CR3 &= ~ ((uint32_t)1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))))
708
709 /** @brief Check whether the specified SmartCard interrupt has occurred or not.
710 * @param __HANDLE__ specifies the SMARTCARD Handle.
711 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to check.
712 * This parameter can be one of the following values:
713 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
714 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
715 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
716 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
717 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available)
718 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
719 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
720 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
721 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error)
722 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption
723 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption
724 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption
725 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption
726 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption
727 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption
728 * @retval The new state of __INTERRUPT__ (SET or RESET).
729 */
730 #define __HAL_SMARTCARD_GET_IT(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->ISR\
731 & ((uint32_t)0x01U << (((__INTERRUPT__) & SMARTCARD_ISR_MASK)>> SMARTCARD_ISR_POS))) != 0U) ? SET : RESET)
732
733 /** @brief Check whether the specified SmartCard interrupt source is enabled or not.
734 * @param __HANDLE__ specifies the SMARTCARD Handle.
735 * @param __INTERRUPT__ specifies the SMARTCARD interrupt source to check.
736 * This parameter can be one of the following values:
737 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
738 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
739 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
740 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
741 * @arg @ref SMARTCARD_IT_TCBGT Transmission complete before guard time interrupt (when interruption available)
742 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
743 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
744 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
745 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error)
746 * @arg @ref SMARTCARD_IT_TXFNF TX FIFO not full interruption
747 * @arg @ref SMARTCARD_IT_RXFNE RXFIFO not empty interruption
748 * @arg @ref SMARTCARD_IT_RXFF RXFIFO full interruption
749 * @arg @ref SMARTCARD_IT_TXFE TXFIFO empty interruption
750 * @arg @ref SMARTCARD_IT_RXFT RXFIFO threshold reached interruption
751 * @arg @ref SMARTCARD_IT_TXFT TXFIFO threshold reached interruption
752 * @retval The new state of __INTERRUPT__ (SET or RESET).
753 */
754 #define __HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((((((__INTERRUPT__) & SMARTCARD_CR_MASK) >> SMARTCARD_CR_POS) == 0x01U)? (__HANDLE__)->Instance->CR1 : \
755 (((((__INTERRUPT__) & SMARTCARD_CR_MASK) >> SMARTCARD_CR_POS) == 0x02U)? (__HANDLE__)->Instance->CR2 : \
756 (__HANDLE__)->Instance->CR3)) & ((uint32_t)0x01U << (((uint16_t)(__INTERRUPT__)) & SMARTCARD_IT_MASK))) != 0U) ? SET : RESET)
757
758 /** @brief Clear the specified SMARTCARD ISR flag, in setting the proper ICR register flag.
759 * @param __HANDLE__ specifies the SMARTCARD Handle.
760 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
761 * to clear the corresponding interrupt.
762 * This parameter can be one of the following values:
763 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag
764 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag
765 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag
766 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag
767 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detection clear flag
768 * @arg @ref SMARTCARD_CLEAR_TXFECF TXFIFO empty Clear Flag
769 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag
770 * @arg @ref SMARTCARD_CLEAR_TCBGTF Transmission complete before guard time clear flag (when flag available)
771 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag
772 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag
773 * @retval None
774 */
775 #define __HAL_SMARTCARD_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR |= (uint32_t)(__IT_CLEAR__))
776
777 /** @brief Set a specific SMARTCARD request flag.
778 * @param __HANDLE__ specifies the SMARTCARD Handle.
779 * @param __REQ__ specifies the request flag to set
780 * This parameter can be one of the following values:
781 * @arg @ref SMARTCARD_RXDATA_FLUSH_REQUEST Receive data flush Request
782 * @arg @ref SMARTCARD_TXDATA_FLUSH_REQUEST Transmit data flush Request
783 * @retval None
784 */
785 #define __HAL_SMARTCARD_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
786
787 /** @brief Enable the SMARTCARD one bit sample method.
788 * @param __HANDLE__ specifies the SMARTCARD Handle.
789 * @retval None
790 */
791 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
792
793 /** @brief Disable the SMARTCARD one bit sample method.
794 * @param __HANDLE__ specifies the SMARTCARD Handle.
795 * @retval None
796 */
797 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3\
798 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
799
800 /** @brief Enable the USART associated to the SMARTCARD Handle.
801 * @param __HANDLE__ specifies the SMARTCARD Handle.
802 * @retval None
803 */
804 #define __HAL_SMARTCARD_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
805
806 /** @brief Disable the USART associated to the SMARTCARD Handle
807 * @param __HANDLE__ specifies the SMARTCARD Handle.
808 * @retval None
809 */
810 #define __HAL_SMARTCARD_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
811
812 /**
813 * @}
814 */
815
816 /* Private macros -------------------------------------------------------------*/
817 /** @defgroup SMARTCARD_Private_Macros SMARTCARD Private Macros
818 * @{
819 */
820
821 /** @brief Report the SMARTCARD clock source.
822 * @param __HANDLE__ specifies the SMARTCARD Handle.
823 * @param __CLOCKSOURCE__ output variable.
824 * @retval the SMARTCARD clocking source, written in __CLOCKSOURCE__.
825 */
826 #define SMARTCARD_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
827 do { \
828 if((__HANDLE__)->Instance == USART1) \
829 { \
830 switch(__HAL_RCC_GET_USART1_SOURCE()) \
831 { \
832 case RCC_USART1CLKSOURCE_PCLK2: \
833 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK2; \
834 break; \
835 case RCC_USART1CLKSOURCE_HSI: \
836 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
837 break; \
838 case RCC_USART1CLKSOURCE_SYSCLK: \
839 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
840 break; \
841 case RCC_USART1CLKSOURCE_LSE: \
842 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
843 break; \
844 default: \
845 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
846 break; \
847 } \
848 } \
849 else if((__HANDLE__)->Instance == USART2) \
850 { \
851 switch(__HAL_RCC_GET_USART2_SOURCE()) \
852 { \
853 case RCC_USART2CLKSOURCE_PCLK1: \
854 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \
855 break; \
856 case RCC_USART2CLKSOURCE_HSI: \
857 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
858 break; \
859 case RCC_USART2CLKSOURCE_SYSCLK: \
860 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
861 break; \
862 case RCC_USART2CLKSOURCE_LSE: \
863 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
864 break; \
865 default: \
866 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
867 break; \
868 } \
869 } \
870 else if((__HANDLE__)->Instance == USART3) \
871 { \
872 switch(__HAL_RCC_GET_USART3_SOURCE()) \
873 { \
874 case RCC_USART3CLKSOURCE_PCLK1: \
875 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \
876 break; \
877 case RCC_USART3CLKSOURCE_HSI: \
878 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
879 break; \
880 case RCC_USART3CLKSOURCE_SYSCLK: \
881 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
882 break; \
883 case RCC_USART3CLKSOURCE_LSE: \
884 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
885 break; \
886 default: \
887 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
888 break; \
889 } \
890 } \
891 else \
892 { \
893 (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
894 } \
895 } while(0U)
896
897 /** @brief Check the Baud rate range.
898 * @note The maximum Baud Rate is derived from the maximum clock on G4 (150 MHz)
899 * divided by the oversampling used on the SMARTCARD (i.e. 16).
900 * @param __BAUDRATE__ Baud rate set by the configuration function.
901 * @retval Test result (TRUE or FALSE)
902 */
903 #define IS_SMARTCARD_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 9375001U)
904
905 /** @brief Check the block length range.
906 * @note The maximum SMARTCARD block length is 0xFF.
907 * @param __LENGTH__ block length.
908 * @retval Test result (TRUE or FALSE)
909 */
910 #define IS_SMARTCARD_BLOCKLENGTH(__LENGTH__) ((__LENGTH__) <= 0xFFU)
911
912 /** @brief Check the receiver timeout value.
913 * @note The maximum SMARTCARD receiver timeout value is 0xFFFFFF.
914 * @param __TIMEOUTVALUE__ receiver timeout value.
915 * @retval Test result (TRUE or FALSE)
916 */
917 #define IS_SMARTCARD_TIMEOUT_VALUE(__TIMEOUTVALUE__) ((__TIMEOUTVALUE__) <= 0xFFFFFFU)
918
919 /** @brief Check the SMARTCARD autoretry counter value.
920 * @note The maximum number of retransmissions is 0x7.
921 * @param __COUNT__ number of retransmissions.
922 * @retval Test result (TRUE or FALSE)
923 */
924 #define IS_SMARTCARD_AUTORETRY_COUNT(__COUNT__) ((__COUNT__) <= 0x7U)
925
926 /** @brief Ensure that SMARTCARD frame length is valid.
927 * @param __LENGTH__ SMARTCARD frame length.
928 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
929 */
930 #define IS_SMARTCARD_WORD_LENGTH(__LENGTH__) ((__LENGTH__) == SMARTCARD_WORDLENGTH_9B)
931
932 /** @brief Ensure that SMARTCARD frame number of stop bits is valid.
933 * @param __STOPBITS__ SMARTCARD frame number of stop bits.
934 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
935 */
936 #define IS_SMARTCARD_STOPBITS(__STOPBITS__) (((__STOPBITS__) == SMARTCARD_STOPBITS_0_5) ||\
937 ((__STOPBITS__) == SMARTCARD_STOPBITS_1_5))
938
939 /** @brief Ensure that SMARTCARD frame parity is valid.
940 * @param __PARITY__ SMARTCARD frame parity.
941 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
942 */
943 #define IS_SMARTCARD_PARITY(__PARITY__) (((__PARITY__) == SMARTCARD_PARITY_EVEN) || \
944 ((__PARITY__) == SMARTCARD_PARITY_ODD))
945
946 /** @brief Ensure that SMARTCARD communication mode is valid.
947 * @param __MODE__ SMARTCARD communication mode.
948 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
949 */
950 #define IS_SMARTCARD_MODE(__MODE__) ((((__MODE__) & 0xFFF3U) == 0x00U) && ((__MODE__) != 0x00U))
951
952 /** @brief Ensure that SMARTCARD frame polarity is valid.
953 * @param __CPOL__ SMARTCARD frame polarity.
954 * @retval SET (__CPOL__ is valid) or RESET (__CPOL__ is invalid)
955 */
956 #define IS_SMARTCARD_POLARITY(__CPOL__) (((__CPOL__) == SMARTCARD_POLARITY_LOW)\
957 || ((__CPOL__) == SMARTCARD_POLARITY_HIGH))
958
959 /** @brief Ensure that SMARTCARD frame phase is valid.
960 * @param __CPHA__ SMARTCARD frame phase.
961 * @retval SET (__CPHA__ is valid) or RESET (__CPHA__ is invalid)
962 */
963 #define IS_SMARTCARD_PHASE(__CPHA__) (((__CPHA__) == SMARTCARD_PHASE_1EDGE) || ((__CPHA__) == SMARTCARD_PHASE_2EDGE))
964
965 /** @brief Ensure that SMARTCARD frame last bit clock pulse setting is valid.
966 * @param __LASTBIT__ SMARTCARD frame last bit clock pulse setting.
967 * @retval SET (__LASTBIT__ is valid) or RESET (__LASTBIT__ is invalid)
968 */
969 #define IS_SMARTCARD_LASTBIT(__LASTBIT__) (((__LASTBIT__) == SMARTCARD_LASTBIT_DISABLE) || \
970 ((__LASTBIT__) == SMARTCARD_LASTBIT_ENABLE))
971
972 /** @brief Ensure that SMARTCARD frame sampling is valid.
973 * @param __ONEBIT__ SMARTCARD frame sampling.
974 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
975 */
976 #define IS_SMARTCARD_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_DISABLE) || \
977 ((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_ENABLE))
978
979 /** @brief Ensure that SMARTCARD NACK transmission setting is valid.
980 * @param __NACK__ SMARTCARD NACK transmission setting.
981 * @retval SET (__NACK__ is valid) or RESET (__NACK__ is invalid)
982 */
983 #define IS_SMARTCARD_NACK(__NACK__) (((__NACK__) == SMARTCARD_NACK_ENABLE) || \
984 ((__NACK__) == SMARTCARD_NACK_DISABLE))
985
986 /** @brief Ensure that SMARTCARD receiver timeout setting is valid.
987 * @param __TIMEOUT__ SMARTCARD receiver timeout setting.
988 * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid)
989 */
990 #define IS_SMARTCARD_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == SMARTCARD_TIMEOUT_DISABLE) || \
991 ((__TIMEOUT__) == SMARTCARD_TIMEOUT_ENABLE))
992
993 /** @brief Ensure that SMARTCARD clock Prescaler is valid.
994 * @param __CLOCKPRESCALER__ SMARTCARD clock Prescaler value.
995 * @retval SET (__CLOCKPRESCALER__ is valid) or RESET (__CLOCKPRESCALER__ is invalid)
996 */
997 #define IS_SMARTCARD_CLOCKPRESCALER(__CLOCKPRESCALER__) (((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV1) || \
998 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV2) || \
999 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV4) || \
1000 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV6) || \
1001 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV8) || \
1002 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV10) || \
1003 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV12) || \
1004 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV16) || \
1005 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV32) || \
1006 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV64) || \
1007 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV128) || \
1008 ((__CLOCKPRESCALER__) == SMARTCARD_PRESCALER_DIV256))
1009
1010 /** @brief Ensure that SMARTCARD advanced features initialization is valid.
1011 * @param __INIT__ SMARTCARD advanced features initialization.
1012 * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid)
1013 */
1014 #define IS_SMARTCARD_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (SMARTCARD_ADVFEATURE_NO_INIT | \
1015 SMARTCARD_ADVFEATURE_TXINVERT_INIT | \
1016 SMARTCARD_ADVFEATURE_RXINVERT_INIT | \
1017 SMARTCARD_ADVFEATURE_DATAINVERT_INIT | \
1018 SMARTCARD_ADVFEATURE_SWAP_INIT | \
1019 SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT | \
1020 SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT | \
1021 SMARTCARD_ADVFEATURE_MSBFIRST_INIT))
1022
1023 /** @brief Ensure that SMARTCARD frame TX inversion setting is valid.
1024 * @param __TXINV__ SMARTCARD frame TX inversion setting.
1025 * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid)
1026 */
1027 #define IS_SMARTCARD_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_DISABLE) || \
1028 ((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_ENABLE))
1029
1030 /** @brief Ensure that SMARTCARD frame RX inversion setting is valid.
1031 * @param __RXINV__ SMARTCARD frame RX inversion setting.
1032 * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid)
1033 */
1034 #define IS_SMARTCARD_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_DISABLE) || \
1035 ((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_ENABLE))
1036
1037 /** @brief Ensure that SMARTCARD frame data inversion setting is valid.
1038 * @param __DATAINV__ SMARTCARD frame data inversion setting.
1039 * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid)
1040 */
1041 #define IS_SMARTCARD_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_DISABLE) || \
1042 ((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_ENABLE))
1043
1044 /** @brief Ensure that SMARTCARD frame RX/TX pins swap setting is valid.
1045 * @param __SWAP__ SMARTCARD frame RX/TX pins swap setting.
1046 * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid)
1047 */
1048 #define IS_SMARTCARD_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_DISABLE) || \
1049 ((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_ENABLE))
1050
1051 /** @brief Ensure that SMARTCARD frame overrun setting is valid.
1052 * @param __OVERRUN__ SMARTCARD frame overrun setting.
1053 * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid)
1054 */
1055 #define IS_SMARTCARD_OVERRUN(__OVERRUN__) (((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_ENABLE) || \
1056 ((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_DISABLE))
1057
1058 /** @brief Ensure that SMARTCARD DMA enabling or disabling on error setting is valid.
1059 * @param __DMA__ SMARTCARD DMA enabling or disabling on error setting.
1060 * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid)
1061 */
1062 #define IS_SMARTCARD_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR) || \
1063 ((__DMA__) == SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR))
1064
1065 /** @brief Ensure that SMARTCARD frame MSB first setting is valid.
1066 * @param __MSBFIRST__ SMARTCARD frame MSB first setting.
1067 * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid)
1068 */
1069 #define IS_SMARTCARD_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE) || \
1070 ((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE))
1071
1072 /** @brief Ensure that SMARTCARD request parameter is valid.
1073 * @param __PARAM__ SMARTCARD request parameter.
1074 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
1075 */
1076 #define IS_SMARTCARD_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == SMARTCARD_RXDATA_FLUSH_REQUEST) || \
1077 ((__PARAM__) == SMARTCARD_TXDATA_FLUSH_REQUEST))
1078
1079 /**
1080 * @}
1081 */
1082
1083 /* Include SMARTCARD HAL Extended module */
1084 #include "stm32g4xx_hal_smartcard_ex.h"
1085
1086 /* Exported functions --------------------------------------------------------*/
1087 /** @addtogroup SMARTCARD_Exported_Functions
1088 * @{
1089 */
1090
1091 /* Initialization and de-initialization functions ****************************/
1092 /** @addtogroup SMARTCARD_Exported_Functions_Group1
1093 * @{
1094 */
1095
1096 HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsmartcard);
1097 HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsmartcard);
1098 void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsmartcard);
1099 void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsmartcard);
1100
1101 #if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)
1102 /* Callbacks Register/UnRegister functions ***********************************/
1103 HAL_StatusTypeDef HAL_SMARTCARD_RegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard,
1104 HAL_SMARTCARD_CallbackIDTypeDef CallbackID, pSMARTCARD_CallbackTypeDef pCallback);
1105 HAL_StatusTypeDef HAL_SMARTCARD_UnRegisterCallback(SMARTCARD_HandleTypeDef *hsmartcard,
1106 HAL_SMARTCARD_CallbackIDTypeDef CallbackID);
1107 #endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */
1108
1109 /**
1110 * @}
1111 */
1112
1113 /* IO operation functions *****************************************************/
1114 /** @addtogroup SMARTCARD_Exported_Functions_Group2
1115 * @{
1116 */
1117
1118 HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size,
1119 uint32_t Timeout);
1120 HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size,
1121 uint32_t Timeout);
1122 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1123 HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1124 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1125 HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1126 /* Transfer Abort functions */
1127 HAL_StatusTypeDef HAL_SMARTCARD_Abort(SMARTCARD_HandleTypeDef *hsmartcard);
1128 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit(SMARTCARD_HandleTypeDef *hsmartcard);
1129 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive(SMARTCARD_HandleTypeDef *hsmartcard);
1130 HAL_StatusTypeDef HAL_SMARTCARD_Abort_IT(SMARTCARD_HandleTypeDef *hsmartcard);
1131 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit_IT(SMARTCARD_HandleTypeDef *hsmartcard);
1132 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive_IT(SMARTCARD_HandleTypeDef *hsmartcard);
1133
1134 void HAL_SMARTCARD_IRQHandler(SMARTCARD_HandleTypeDef *hsmartcard);
1135 void HAL_SMARTCARD_TxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1136 void HAL_SMARTCARD_RxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1137 void HAL_SMARTCARD_ErrorCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1138 void HAL_SMARTCARD_AbortCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1139 void HAL_SMARTCARD_AbortTransmitCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1140 void HAL_SMARTCARD_AbortReceiveCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1141
1142 /**
1143 * @}
1144 */
1145
1146 /* Peripheral State and Error functions ***************************************/
1147 /** @addtogroup SMARTCARD_Exported_Functions_Group4
1148 * @{
1149 */
1150
1151 HAL_SMARTCARD_StateTypeDef HAL_SMARTCARD_GetState(SMARTCARD_HandleTypeDef *hsmartcard);
1152 uint32_t HAL_SMARTCARD_GetError(SMARTCARD_HandleTypeDef *hsmartcard);
1153
1154 /**
1155 * @}
1156 */
1157
1158 /**
1159 * @}
1160 */
1161
1162 /**
1163 * @}
1164 */
1165
1166 /**
1167 * @}
1168 */
1169
1170 #ifdef __cplusplus
1171 }
1172 #endif
1173
1174 #endif /* STM32G4xx_HAL_SMARTCARD_H */
1175
1176 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/