?  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 / STM32F3 / Drivers / STM32F3xx_HAL_Driver / Inc / stm32f3xx_hal_smartcard.h
blob1b16961b6380577319a62375e9a96651d965beb0
1 /**
2 ******************************************************************************
3 * @file stm32f3xx_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) 2016 STMicroelectronics</center></h2>
10 *
11 * Redistribution and use in source and binary forms, with or without modification,
12 * are permitted provided that the following conditions are met:
13 * 1. Redistributions of source code must retain the above copyright notice,
14 * this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 *
33 ******************************************************************************
34 */
35
36 /* Define to prevent recursive inclusion -------------------------------------*/
37 #ifndef __STM32F3xx_HAL_SMARTCARD_H
38 #define __STM32F3xx_HAL_SMARTCARD_H
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 /* Includes ------------------------------------------------------------------*/
45 #include "stm32f3xx_hal_def.h"
46
47 /** @addtogroup STM32F3xx_HAL_Driver
48 * @{
49 */
50
51 /** @addtogroup SMARTCARD
52 * @{
53 */
54
55 /* Exported types ------------------------------------------------------------*/
56 /** @defgroup SMARTCARD_Exported_Types SMARTCARD Exported Types
57 * @{
58 */
59
60 /**
61 * @brief SMARTCARD Init Structure definition
62 */
63 typedef struct
64 {
65 uint32_t BaudRate; /*!< Configures the SmartCard communication baud rate.
66 The baud rate register is computed using the following formula:
67 Baud Rate Register = ((PCLKx) / ((hsmartcard->Init.BaudRate))) */
68
69 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
70 This parameter @ref SMARTCARD_Word_Length can only be set to 9 (8 data + 1 parity bits). */
71
72 uint32_t StopBits; /*!< Specifies the number of stop bits.
73 This parameter can be a value of @ref SMARTCARD_Stop_Bits. */
74
75 uint16_t Parity; /*!< Specifies the parity mode.
76 This parameter can be a value of @ref SMARTCARD_Parity
77 @note The parity is enabled by default (PCE is forced to 1U).
78 Since the WordLength is forced to 8 bits + parity, M is
79 forced to 1 and the parity bit is the 9th bit. */
80
81 uint16_t Mode; /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
82 This parameter can be a value of @ref SMARTCARD_Mode */
83
84 uint16_t CLKPolarity; /*!< Specifies the steady state of the serial clock.
85 This parameter can be a value of @ref SMARTCARD_Clock_Polarity */
86
87 uint16_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made.
88 This parameter can be a value of @ref SMARTCARD_Clock_Phase */
89
90 uint16_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted
91 data bit (MSB) has to be output on the SCLK pin in synchronous mode.
92 This parameter can be a value of @ref SMARTCARD_Last_Bit */
93
94 uint16_t OneBitSampling; /*!< Specifies whether a single sample or three samples' majority vote is selected.
95 Selecting the single sample method increases the receiver tolerance to clock
96 deviations. This parameter can be a value of @ref SMARTCARD_OneBit_Sampling. */
97
98 uint8_t Prescaler; /*!< Specifies the SmartCard Prescaler. */
99
100 uint8_t GuardTime; /*!< Specifies the SmartCard Guard Time applied after stop bits. */
101
102 uint16_t NACKEnable; /*!< Specifies whether the SmartCard NACK transmission is enabled
103 in case of parity error.
104 This parameter can be a value of @ref SMARTCARD_NACK_Enable */
105
106 uint32_t TimeOutEnable; /*!< Specifies whether the receiver timeout is enabled.
107 This parameter can be a value of @ref SMARTCARD_Timeout_Enable*/
108
109 uint32_t TimeOutValue; /*!< Specifies the receiver time out value in number of baud blocks:
110 it is used to implement the Character Wait Time (CWT) and
111 Block Wait Time (BWT). It is coded over 24 bits. */
112
113 uint8_t BlockLength; /*!< Specifies the SmartCard Block Length in T=1 Reception mode.
114 This parameter can be any value from 0x0 to 0xFFU */
115
116 uint8_t AutoRetryCount; /*!< Specifies the SmartCard auto-retry count (number of retries in
117 receive and transmit mode). When set to 0U, retransmission is
118 disabled. Otherwise, its maximum value is 7 (before signalling
119 an error) */
120
121 }SMARTCARD_InitTypeDef;
122
123 /**
124 * @brief SMARTCARD advanced features initalization structure definition
125 */
126 typedef struct
127 {
128 uint32_t AdvFeatureInit; /*!< Specifies which advanced SMARTCARD features is initialized. Several
129 advanced features may be initialized at the same time. This parameter
130 can be a value of @ref SMARTCARD_Advanced_Features_Initialization_Type */
131
132 uint32_t TxPinLevelInvert; /*!< Specifies whether the TX pin active level is inverted.
133 This parameter can be a value of @ref SMARTCARD_Tx_Inv */
134
135 uint32_t RxPinLevelInvert; /*!< Specifies whether the RX pin active level is inverted.
136 This parameter can be a value of @ref SMARTCARD_Rx_Inv */
137
138 uint32_t DataInvert; /*!< Specifies whether data are inverted (positive/direct logic
139 vs negative/inverted logic).
140 This parameter can be a value of @ref SMARTCARD_Data_Inv */
141
142 uint32_t Swap; /*!< Specifies whether TX and RX pins are swapped.
143 This parameter can be a value of @ref SMARTCARD_Rx_Tx_Swap */
144
145 uint32_t OverrunDisable; /*!< Specifies whether the reception overrun detection is disabled.
146 This parameter can be a value of @ref SMARTCARD_Overrun_Disable */
147
148 uint32_t DMADisableonRxError; /*!< Specifies whether the DMA is disabled in case of reception error.
149 This parameter can be a value of @ref SMARTCARD_DMA_Disable_on_Rx_Error */
150
151 uint32_t MSBFirst; /*!< Specifies whether MSB is sent first on UART line.
152 This parameter can be a value of @ref SMARTCARD_MSB_First */
153 }SMARTCARD_AdvFeatureInitTypeDef;
154
155 /**
156 * @brief HAL SMARTCARD State structures definition
157 * @note HAL SMARTCARD State value is a combination of 2 different substates: gState and RxState.
158 * - gState contains SMARTCARD state information related to global Handle management
159 * and also information related to Tx operations.
160 * gState value coding follow below described bitmap :
161 * b7-b6 Error information
162 * 00 : No Error
163 * 01 : (Not Used)
164 * 10 : Timeout
165 * 11 : Error
166 * b5 IP initilisation status
167 * 0 : Reset (IP not initialized)
168 * 1 : Init done (IP not initialized. HAL SMARTCARD Init function already called)
169 * b4-b3 (not used)
170 * xx : Should be set to 00
171 * b2 Intrinsic process state
172 * 0 : Ready
173 * 1 : Busy (IP busy with some configuration or internal operations)
174 * b1 (not used)
175 * x : Should be set to 0
176 * b0 Tx state
177 * 0 : Ready (no Tx operation ongoing)
178 * 1 : Busy (Tx operation ongoing)
179 * - RxState contains information related to Rx operations.
180 * RxState value coding follow below described bitmap :
181 * b7-b6 (not used)
182 * xx : Should be set to 00
183 * b5 IP initilisation status
184 * 0 : Reset (IP not initialized)
185 * 1 : Init done (IP not initialized)
186 * b4-b2 (not used)
187 * xxx : Should be set to 000
188 * b1 Rx state
189 * 0 : Ready (no Rx operation ongoing)
190 * 1 : Busy (Rx operation ongoing)
191 * b0 (not used)
192 * x : Should be set to 0.
193 */
194 typedef enum
195 {
196 HAL_SMARTCARD_STATE_RESET = 0x00U, /*!< Peripheral is not initialized
197 Value is allowed for gState and RxState */
198 HAL_SMARTCARD_STATE_READY = 0x20U, /*!< Peripheral Initialized and ready for use
199 Value is allowed for gState and RxState */
200 HAL_SMARTCARD_STATE_BUSY = 0x24U, /*!< an internal process is ongoing
201 Value is allowed for gState only */
202 HAL_SMARTCARD_STATE_BUSY_TX = 0x21U, /*!< Data Transmission process is ongoing
203 Value is allowed for gState only */
204 HAL_SMARTCARD_STATE_BUSY_RX = 0x22U, /*!< Data Reception process is ongoing
205 Value is allowed for RxState only */
206 HAL_SMARTCARD_STATE_BUSY_TX_RX = 0x23U, /*!< Data Transmission and Reception process is ongoing
207 Not to be used for neither gState nor RxState.
208 Value is result of combination (Or) between gState and RxState values */
209 HAL_SMARTCARD_STATE_TIMEOUT = 0xA0U, /*!< Timeout state
210 Value is allowed for gState only */
211 HAL_SMARTCARD_STATE_ERROR = 0xE0U /*!< Error
212 Value is allowed for gState only */
213 }HAL_SMARTCARD_StateTypeDef;
214
215 /**
216 * @brief SMARTCARD handle Structure definition
217 */
218 typedef struct
219 {
220 USART_TypeDef *Instance; /*!< USART registers base address */
221
222 SMARTCARD_InitTypeDef Init; /*!< SmartCard communication parameters */
223
224 SMARTCARD_AdvFeatureInitTypeDef AdvancedInit; /*!< SmartCard advanced features initialization parameters */
225
226 uint8_t *pTxBuffPtr; /*!< Pointer to SmartCard Tx transfer Buffer */
227
228 uint16_t TxXferSize; /*!< SmartCard Tx Transfer size */
229
230 __IO uint16_t TxXferCount; /*!< SmartCard Tx Transfer Counter */
231
232 uint8_t *pRxBuffPtr; /*!< Pointer to SmartCard Rx transfer Buffer */
233
234 uint16_t RxXferSize; /*!< SmartCard Rx Transfer size */
235
236 __IO uint16_t RxXferCount; /*!< SmartCard Rx Transfer Counter */
237
238 DMA_HandleTypeDef *hdmatx; /*!< SmartCard Tx DMA Handle parameters */
239
240 DMA_HandleTypeDef *hdmarx; /*!< SmartCard Rx DMA Handle parameters */
241
242 HAL_LockTypeDef Lock; /*!< Locking object */
243
244 __IO HAL_SMARTCARD_StateTypeDef gState; /*!< SmartCard state information related to global Handle management
245 and also related to Tx operations.
246 This parameter can be a value of @ref HAL_SMARTCARD_StateTypeDef */
247
248 __IO HAL_SMARTCARD_StateTypeDef RxState; /*!< SmartCard state information related to Rx operations.
249 This parameter can be a value of @ref HAL_SMARTCARD_StateTypeDef */
250
251 __IO uint32_t ErrorCode; /*!< SmartCard Error code
252 This parameter can be a value of @ref SMARTCARD_Error */
253
254 }SMARTCARD_HandleTypeDef;
255
256 /**
257 * @brief SMARTCARD clock sources
258 */
259 typedef enum
260 {
261 SMARTCARD_CLOCKSOURCE_PCLK1 = 0x00U, /*!< PCLK1 clock source */
262 SMARTCARD_CLOCKSOURCE_PCLK2 = 0x01U, /*!< PCLK2 clock source */
263 SMARTCARD_CLOCKSOURCE_HSI = 0x02U, /*!< HSI clock source */
264 SMARTCARD_CLOCKSOURCE_SYSCLK = 0x04U, /*!< SYSCLK clock source */
265 SMARTCARD_CLOCKSOURCE_LSE = 0x08U, /*!< LSE clock source */
266 SMARTCARD_CLOCKSOURCE_UNDEFINED = 0x10U /*!< undefined clock source */
267 }SMARTCARD_ClockSourceTypeDef;
268
269 /**
270 * @}
271 */
272
273 /* Exported constants --------------------------------------------------------*/
274 /** @defgroup SMARTCARD_Exported_Constants SMARTCARD Exported Constants
275 * @{
276 */
277
278 /** @defgroup SMARTCARD_Error SMARTCARD Error
279 * @{
280 */
281 #define HAL_SMARTCARD_ERROR_NONE (0x00000000U) /*!< No error */
282 #define HAL_SMARTCARD_ERROR_PE (0x00000001U) /*!< Parity error */
283 #define HAL_SMARTCARD_ERROR_NE (0x00000002U) /*!< Noise error */
284 #define HAL_SMARTCARD_ERROR_FE (0x00000004U) /*!< frame error */
285 #define HAL_SMARTCARD_ERROR_ORE (0x00000008U) /*!< Overrun error */
286 #define HAL_SMARTCARD_ERROR_DMA (0x00000010U) /*!< DMA transfer error */
287 #define HAL_SMARTCARD_ERROR_RTO (0x00000020U) /*!< Receiver TimeOut error */
288 /**
289 * @}
290 */
291
292 /** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length
293 * @{
294 */
295 #define SMARTCARD_WORDLENGTH_9B ((uint32_t)USART_CR1_M0) /*!< SMARTCARD frame length */
296 /**
297 * @}
298 */
299
300 /** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits
301 * @{
302 */
303 #define SMARTCARD_STOPBITS_0_5 ((uint32_t)USART_CR2_STOP_0) /*!< SMARTCARD frame with 0.5 stop bit */
304 #define SMARTCARD_STOPBITS_1_5 ((uint32_t)(USART_CR2_STOP_0 | USART_CR2_STOP_1)) /*!< SMARTCARD frame with 1.5 stop bits */
305 /**
306 * @}
307 */
308
309 /** @defgroup SMARTCARD_Parity SMARTCARD Parity
310 * @{
311 */
312 #define SMARTCARD_PARITY_EVEN ((uint32_t)USART_CR1_PCE) /*!< SMARTCARD frame even parity */
313 #define SMARTCARD_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS)) /*!< SMARTCARD frame odd parity */
314 /**
315 * @}
316 */
317
318 /** @defgroup SMARTCARD_Mode SMARTCARD Transfer Mode
319 * @{
320 */
321 #define SMARTCARD_MODE_RX ((uint32_t)USART_CR1_RE) /*!< SMARTCARD RX mode */
322 #define SMARTCARD_MODE_TX ((uint32_t)USART_CR1_TE) /*!< SMARTCARD TX mode */
323 #define SMARTCARD_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE)) /*!< SMARTCARD RX and TX mode */
324 /**
325 * @}
326 */
327
328 /** @defgroup SMARTCARD_Clock_Polarity SMARTCARD Clock Polarity
329 * @{
330 */
331 #define SMARTCARD_POLARITY_LOW (0x00000000U) /*!< SMARTCARD frame low polarity */
332 #define SMARTCARD_POLARITY_HIGH ((uint32_t)USART_CR2_CPOL) /*!< SMARTCARD frame high polarity */
333 /**
334 * @}
335 */
336
337 /** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase
338 * @{
339 */
340 #define SMARTCARD_PHASE_1EDGE (0x00000000U) /*!< SMARTCARD frame phase on first clock transition */
341 #define SMARTCARD_PHASE_2EDGE ((uint32_t)USART_CR2_CPHA) /*!< SMARTCARD frame phase on second clock transition */
342 /**
343 * @}
344 */
345
346 /** @defgroup SMARTCARD_Last_Bit SMARTCARD Last Bit
347 * @{
348 */
349 #define SMARTCARD_LASTBIT_DISABLE (0x00000000U) /*!< SMARTCARD frame last data bit clock pulse not output to SCLK pin */
350 #define SMARTCARD_LASTBIT_ENABLE ((uint32_t)USART_CR2_LBCL) /*!< SMARTCARD frame last data bit clock pulse output to SCLK pin */
351 /**
352 * @}
353 */
354
355 /** @defgroup SMARTCARD_OneBit_Sampling SMARTCARD One Bit Sampling Method
356 * @{
357 */
358 #define SMARTCARD_ONE_BIT_SAMPLE_DISABLE (0x00000000U) /*!< SMARTCARD frame one-bit sample disabled */
359 #define SMARTCARD_ONE_BIT_SAMPLE_ENABLE ((uint32_t)USART_CR3_ONEBIT) /*!< SMARTCARD frame one-bit sample enabled */
360 /**
361 * @}
362 */
363
364
365 /** @defgroup SMARTCARD_NACK_Enable SMARTCARD NACK Enable
366 * @{
367 */
368 #define SMARTCARD_NACK_ENABLE ((uint32_t)USART_CR3_NACK) /*!< SMARTCARD NACK transmission disabled */
369 #define SMARTCARD_NACK_DISABLE (0x00000000U) /*!< SMARTCARD NACK transmission enabled */
370 /**
371 * @}
372 */
373
374 /** @defgroup SMARTCARD_Timeout_Enable SMARTCARD Timeout Enable
375 * @{
376 */
377 #define SMARTCARD_TIMEOUT_DISABLE (0x00000000U) /*!< SMARTCARD receiver timeout disabled */
378 #define SMARTCARD_TIMEOUT_ENABLE ((uint32_t)USART_CR2_RTOEN) /*!< SMARTCARD receiver timeout enabled */
379 /**
380 * @}
381 */
382
383 /** @defgroup SMARTCARD_Advanced_Features_Initialization_Type SMARTCARD advanced feature initialization type
384 * @{
385 */
386 #define SMARTCARD_ADVFEATURE_NO_INIT (0x00000000U) /*!< No advanced feature initialization */
387 #define SMARTCARD_ADVFEATURE_TXINVERT_INIT (0x00000001U) /*!< TX pin active level inversion */
388 #define SMARTCARD_ADVFEATURE_RXINVERT_INIT (0x00000002U) /*!< RX pin active level inversion */
389 #define SMARTCARD_ADVFEATURE_DATAINVERT_INIT (0x00000004U) /*!< Binary data inversion */
390 #define SMARTCARD_ADVFEATURE_SWAP_INIT (0x00000008U) /*!< TX/RX pins swap */
391 #define SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT (0x00000010U) /*!< RX overrun disable */
392 #define SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT (0x00000020U) /*!< DMA disable on Reception Error */
393 #define SMARTCARD_ADVFEATURE_MSBFIRST_INIT (0x00000080U) /*!< Most significant bit sent/received first */
394 /**
395 * @}
396 */
397
398 /** @defgroup SMARTCARD_Tx_Inv SMARTCARD advanced feature TX pin active level inversion
399 * @{
400 */
401 #define SMARTCARD_ADVFEATURE_TXINV_DISABLE (0x00000000U) /*!< TX pin active level inversion disable */
402 #define SMARTCARD_ADVFEATURE_TXINV_ENABLE ((uint32_t)USART_CR2_TXINV) /*!< TX pin active level inversion enable */
403 /**
404 * @}
405 */
406
407 /** @defgroup SMARTCARD_Rx_Inv SMARTCARD advanced feature RX pin active level inversion
408 * @{
409 */
410 #define SMARTCARD_ADVFEATURE_RXINV_DISABLE (0x00000000U) /*!< RX pin active level inversion disable */
411 #define SMARTCARD_ADVFEATURE_RXINV_ENABLE ((uint32_t)USART_CR2_RXINV) /*!< RX pin active level inversion enable */
412 /**
413 * @}
414 */
415
416 /** @defgroup SMARTCARD_Data_Inv SMARTCARD advanced feature Binary Data inversion
417 * @{
418 */
419 #define SMARTCARD_ADVFEATURE_DATAINV_DISABLE (0x00000000U) /*!< Binary data inversion disable */
420 #define SMARTCARD_ADVFEATURE_DATAINV_ENABLE ((uint32_t)USART_CR2_DATAINV) /*!< Binary data inversion enable */
421 /**
422 * @}
423 */
424
425 /** @defgroup SMARTCARD_Rx_Tx_Swap SMARTCARD advanced feature RX TX pins swap
426 * @{
427 */
428 #define SMARTCARD_ADVFEATURE_SWAP_DISABLE (0x00000000U) /*!< TX/RX pins swap disable */
429 #define SMARTCARD_ADVFEATURE_SWAP_ENABLE ((uint32_t)USART_CR2_SWAP) /*!< TX/RX pins swap enable */
430 /**
431 * @}
432 */
433
434 /** @defgroup SMARTCARD_Overrun_Disable SMARTCARD advanced feature Overrun Disable
435 * @{
436 */
437 #define SMARTCARD_ADVFEATURE_OVERRUN_ENABLE (0x00000000U) /*!< RX overrun enable */
438 #define SMARTCARD_ADVFEATURE_OVERRUN_DISABLE ((uint32_t)USART_CR3_OVRDIS) /*!< RX overrun disable */
439 /**
440 * @}
441 */
442
443 /** @defgroup SMARTCARD_DMA_Disable_on_Rx_Error SMARTCARD advanced feature DMA Disable on Rx Error
444 * @{
445 */
446 #define SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR (0x00000000U) /*!< DMA enable on Reception Error */
447 #define SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR ((uint32_t)USART_CR3_DDRE) /*!< DMA disable on Reception Error */
448 /**
449 * @}
450 */
451
452 /** @defgroup SMARTCARD_MSB_First SMARTCARD advanced feature MSB first
453 * @{
454 */
455 #define SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE (0x00000000U) /*!< Most significant bit sent/received first disable */
456 #define SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE ((uint32_t)USART_CR2_MSBFIRST) /*!< Most significant bit sent/received first enable */
457 /**
458 * @}
459 */
460
461 /** @defgroup SMARTCARD_Flags SMARTCARD Flags
462 * Elements values convention: 0xXXXX
463 * - 0xXXXX : Flag mask in the ISR register
464 * @{
465 */
466 #define SMARTCARD_FLAG_REACK USART_ISR_REACK /*!< SMARTCARD receive enable acknowledge flag */
467 #define SMARTCARD_FLAG_TEACK USART_ISR_TEACK /*!< SMARTCARD transmit enable acknowledge flag */
468 #define SMARTCARD_FLAG_BUSY USART_ISR_BUSY /*!< SMARTCARD busy flag */
469 #define SMARTCARD_FLAG_EOBF USART_ISR_EOBF /*!< SMARTCARD end of block flag */
470 #define SMARTCARD_FLAG_RTOF USART_ISR_RTOF /*!< SMARTCARD receiver timeout flag */
471 #define SMARTCARD_FLAG_TXE USART_ISR_TXE /*!< SMARTCARD transmit data register empty */
472 #define SMARTCARD_FLAG_TC USART_ISR_TC /*!< SMARTCARD transmission complete */
473 #define SMARTCARD_FLAG_RXNE USART_ISR_RXNE /*!< SMARTCARD read data register not empty */
474 #define SMARTCARD_FLAG_IDLE USART_ISR_IDLE /*!< SMARTCARD idle line detection */
475 #define SMARTCARD_FLAG_ORE USART_ISR_ORE /*!< SMARTCARD overrun error */
476 #define SMARTCARD_FLAG_NE USART_ISR_NE /*!< SMARTCARD noise error */
477 #define SMARTCARD_FLAG_FE USART_ISR_FE /*!< SMARTCARD frame error */
478 #define SMARTCARD_FLAG_PE USART_ISR_PE /*!< SMARTCARD parity error */
479 /**
480 * @}
481 */
482
483 /** @defgroup SMARTCARD_Interrupt_definition SMARTCARD Interrupts Definition
484 * Elements values convention: 0000ZZZZ0XXYYYYYb
485 * - YYYYY : Interrupt source position in the XX register (5bits)
486 * - XX : Interrupt source register (2bits)
487 * - 01: CR1 register
488 * - 10: CR2 register
489 * - 11: CR3 register
490 * - ZZZZ : Flag position in the ISR register(4bits)
491 * @{
492 */
493
494 #define SMARTCARD_IT_PE ((uint16_t)0x0028U) /*!< SMARTCARD parity error interruption */
495 #define SMARTCARD_IT_TXE ((uint16_t)0x0727U) /*!< SMARTCARD transmit data register empty interruption */
496 #define SMARTCARD_IT_TC ((uint16_t)0x0626U) /*!< SMARTCARD transmission complete interruption */
497 #define SMARTCARD_IT_RXNE ((uint16_t)0x0525U) /*!< SMARTCARD read data register not empty interruption */
498 #define SMARTCARD_IT_IDLE ((uint16_t)0x0424U) /*!< SMARTCARD idle line detection interruption */
499
500 #define SMARTCARD_IT_ERR ((uint16_t)0x0060U) /*!< SMARTCARD error interruption */
501 #define SMARTCARD_IT_ORE ((uint16_t)0x0300U) /*!< SMARTCARD overrun error interruption */
502 #define SMARTCARD_IT_NE ((uint16_t)0x0200U) /*!< SMARTCARD noise error interruption */
503 #define SMARTCARD_IT_FE ((uint16_t)0x0100U) /*!< SMARTCARD frame error interruption */
504
505 #define SMARTCARD_IT_EOB ((uint16_t)0x0C3BU) /*!< SMARTCARD end of block interruption */
506 #define SMARTCARD_IT_RTO ((uint16_t)0x0B3AU) /*!< SMARTCARD receiver timeout interruption */
507 /**
508 * @}
509 */
510
511 /** @defgroup SMARTCARD_IT_CLEAR_Flags SMARTCARD Interruption Clear Flags
512 * @{
513 */
514 #define SMARTCARD_CLEAR_PEF USART_ICR_PECF /*!< SMARTCARD parity error clear flag */
515 #define SMARTCARD_CLEAR_FEF USART_ICR_FECF /*!< SMARTCARD framing error clear flag */
516 #define SMARTCARD_CLEAR_NEF USART_ICR_NCF /*!< SMARTCARD noise detected clear flag */
517 #define SMARTCARD_CLEAR_OREF USART_ICR_ORECF /*!< SMARTCARD overrun error clear flag */
518 #define SMARTCARD_CLEAR_IDLEF USART_ICR_IDLECF /*!< SMARTCARD idle line detected clear flag */
519 #define SMARTCARD_CLEAR_TCF USART_ICR_TCCF /*!< SMARTCARD transmission complete clear flag */
520 #define SMARTCARD_CLEAR_RTOF USART_ICR_RTOCF /*!< SMARTCARD receiver time out clear flag */
521 #define SMARTCARD_CLEAR_EOBF USART_ICR_EOBCF /*!< SMARTCARD end of block clear flag */
522 /**
523 * @}
524 */
525
526 /** @defgroup SMARTCARD_CR3_SCARCNT_LSB_POS SMARTCARD auto retry counter LSB position in CR3 register
527 * @{
528 */
529 #define SMARTCARD_CR3_SCARCNT_LSB_POS ( 17U) /*!< SMARTCARD auto retry counter LSB position in CR3 register */
530 /**
531 * @}
532 */
533
534 /** @defgroup SMARTCARD_GTPR_GT_LSB_POS SMARTCARD guard time value LSB position in GTPR register
535 * @{
536 */
537 #define SMARTCARD_GTPR_GT_LSB_POS ( 8U) /*!< SMARTCARD guard time value LSB position in GTPR register */
538 /**
539 * @}
540 */
541
542 /** @defgroup SMARTCARD_RTOR_BLEN_LSB_POS SMARTCARD block length LSB position in RTOR register
543 * @{
544 */
545 #define SMARTCARD_RTOR_BLEN_LSB_POS ( 24U) /*!< SMARTCARD block length LSB position in RTOR register */
546 /**
547 * @}
548 */
549
550 /** @defgroup SMARTCARD_Interruption_Mask SMARTCARD interruptions flags mask
551 * @{
552 */
553 #define SMARTCARD_IT_MASK ((uint16_t)0x001FU) /*!< SMARTCARD interruptions flags mask */
554 /**
555 * @}
556 */
557
558 /** @defgroup SMARTCARD_Request_Parameters SMARTCARD Request Parameters
559 * @{
560 */
561 #define SMARTCARD_RXDATA_FLUSH_REQUEST ((uint32_t)USART_RQR_RXFRQ) /*!< Receive data flush request */
562 #define SMARTCARD_TXDATA_FLUSH_REQUEST ((uint32_t)USART_RQR_TXFRQ) /*!< Transmit data flush request */
563 /**
564 * @}
565 */
566
567 /**
568 * @}
569 */
570
571 /* Exported macros -----------------------------------------------------------*/
572 /** @defgroup SMARTCARD_Exported_Macros SMARTCARD Exported Macros
573 * @{
574 */
575
576 /** @brief Reset SMARTCARD handle states.
577 * @param __HANDLE__ SMARTCARD handle.
578 * @retval None
579 */
580 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) do{ \
581 (__HANDLE__)->gState = HAL_SMARTCARD_STATE_RESET; \
582 (__HANDLE__)->RxState = HAL_SMARTCARD_STATE_RESET; \
583 } while(0U)
584
585 /** @brief Flush the Smartcard Data registers.
586 * @param __HANDLE__ specifies the SMARTCARD Handle.
587 * @retval None
588 */
589 #define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__) \
590 do{ \
591 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_RXDATA_FLUSH_REQUEST); \
592 SET_BIT((__HANDLE__)->Instance->RQR, SMARTCARD_TXDATA_FLUSH_REQUEST); \
593 } while(0U)
594
595 /** @brief Clear the specified SMARTCARD pending flag.
596 * @param __HANDLE__ specifies the SMARTCARD Handle.
597 * @param __FLAG__ specifies the flag to check.
598 * This parameter can be any combination of the following values:
599 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag
600 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag
601 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag
602 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag
603 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detected clear flag
604 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag
605 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag
606 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag
607 * @retval None
608 */
609 #define __HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
610
611 /** @brief Clear the SMARTCARD PE pending flag.
612 * @param __HANDLE__ specifies the SMARTCARD Handle.
613 * @retval None
614 */
615 #define __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_PEF)
616
617
618 /** @brief Clear the SMARTCARD FE pending flag.
619 * @param __HANDLE__ specifies the SMARTCARD Handle.
620 * @retval None
621 */
622 #define __HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_FEF)
623
624 /** @brief Clear the SMARTCARD NE pending flag.
625 * @param __HANDLE__ specifies the SMARTCARD Handle.
626 * @retval None
627 */
628 #define __HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_NEF)
629
630 /** @brief Clear the SMARTCARD ORE pending flag.
631 * @param __HANDLE__ specifies the SMARTCARD Handle.
632 * @retval None
633 */
634 #define __HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_OREF)
635
636 /** @brief Clear the SMARTCARD IDLE pending flag.
637 * @param __HANDLE__ specifies the SMARTCARD Handle.
638 * @retval None
639 */
640 #define __HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_FLAG((__HANDLE__), SMARTCARD_CLEAR_IDLEF)
641
642 /** @brief Check whether the specified Smartcard flag is set or not.
643 * @param __HANDLE__ specifies the SMARTCARD Handle.
644 * @param __FLAG__ specifies the flag to check.
645 * This parameter can be one of the following values:
646 * @arg @ref SMARTCARD_FLAG_REACK Receive enable acknowledge flag
647 * @arg @ref SMARTCARD_FLAG_TEACK Transmit enable acknowledge flag
648 * @arg @ref SMARTCARD_FLAG_BUSY Busy flag
649 * @arg @ref SMARTCARD_FLAG_EOBF End of block flag
650 * @arg @ref SMARTCARD_FLAG_RTOF Receiver timeout flag
651 * @arg @ref SMARTCARD_FLAG_TXE Transmit data register empty flag
652 * @arg @ref SMARTCARD_FLAG_TC Transmission complete flag
653 * @arg @ref SMARTCARD_FLAG_RXNE Receive data register not empty flag
654 * @arg @ref SMARTCARD_FLAG_IDLE Idle line detection flag
655 * @arg @ref SMARTCARD_FLAG_ORE Overrun error flag
656 * @arg @ref SMARTCARD_FLAG_NE Noise error flag
657 * @arg @ref SMARTCARD_FLAG_FE Framing error flag
658 * @arg @ref SMARTCARD_FLAG_PE Parity error flag
659 * @retval The new state of __FLAG__ (TRUE or FALSE).
660 */
661 #define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR & (__FLAG__)) == (__FLAG__))
662
663
664 /** @brief Enable the specified SmartCard interrupt.
665 * @param __HANDLE__ specifies the SMARTCARD Handle.
666 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to enable.
667 * This parameter can be one of the following values:
668 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
669 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
670 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
671 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
672 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
673 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
674 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
675 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error)
676 * @retval None
677 */
678 #define __HAL_SMARTCARD_ENABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & 0xFFU) >> 5U) == 1U)? ((__HANDLE__)->Instance->CR1 |= (1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
679 ((((__INTERRUPT__) & 0xFFU) >> 5U) == 2U)? ((__HANDLE__)->Instance->CR2 |= (1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
680 ((__HANDLE__)->Instance->CR3 |= (1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))))
681
682 /** @brief Disable the specified SmartCard interrupt.
683 * @param __HANDLE__ specifies the SMARTCARD Handle.
684 * @param __INTERRUPT__ specifies the SMARTCARD interrupt to disable.
685 * This parameter can be one of the following values:
686 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
687 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
688 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
689 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
690 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
691 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
692 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
693 * @arg @ref SMARTCARD_IT_ERR Error interrupt(frame error, noise error, overrun error)
694 * @retval None
695 */
696 #define __HAL_SMARTCARD_DISABLE_IT(__HANDLE__, __INTERRUPT__) (((((__INTERRUPT__) & 0xFFU) >> 5U) == 1U)? ((__HANDLE__)->Instance->CR1 &= ~ (1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
697 ((((__INTERRUPT__) & 0xFFU) >> 5U) == 2U)? ((__HANDLE__)->Instance->CR2 &= ~ (1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))): \
698 ((__HANDLE__)->Instance->CR3 &= ~ (1U << ((__INTERRUPT__) & SMARTCARD_IT_MASK))))
699
700
701 /** @brief Check whether the specified SmartCard interrupt has occurred or not.
702 * @param __HANDLE__ specifies the SMARTCARD Handle.
703 * @param __IT__ specifies the SMARTCARD interrupt to check.
704 * This parameter can be one of the following values:
705 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
706 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
707 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
708 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
709 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
710 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
711 * @arg @ref SMARTCARD_IT_ORE Overrun error interrupt
712 * @arg @ref SMARTCARD_IT_NE Noise error interrupt
713 * @arg @ref SMARTCARD_IT_FE Framing error interrupt
714 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
715 * @retval The new state of __IT__ (TRUE or FALSE).
716 */
717 #define __HAL_SMARTCARD_GET_IT(__HANDLE__, __IT__) ((__HANDLE__)->Instance->ISR & (1U << ((__IT__)>> 0x08U)))
718
719 /** @brief Check whether the specified SmartCard interrupt source is enabled or not.
720 * @param __HANDLE__ specifies the SMARTCARD Handle.
721 * @param __IT__ specifies the SMARTCARD interrupt source to check.
722 * This parameter can be one of the following values:
723 * @arg @ref SMARTCARD_IT_EOB End of block interrupt
724 * @arg @ref SMARTCARD_IT_RTO Receive timeout interrupt
725 * @arg @ref SMARTCARD_IT_TXE Transmit data register empty interrupt
726 * @arg @ref SMARTCARD_IT_TC Transmission complete interrupt
727 * @arg @ref SMARTCARD_IT_RXNE Receive data register not empty interrupt
728 * @arg @ref SMARTCARD_IT_IDLE Idle line detection interrupt
729 * @arg @ref SMARTCARD_IT_ERR Framing, overrun or noise error interrupt
730 * @arg @ref SMARTCARD_IT_PE Parity error interrupt
731 * @retval The new state of __IT__ (TRUE or FALSE).
732 */
733 #define __HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __IT__) ((((((__IT__) & 0xFFU) >> 5U) == 1U)? (__HANDLE__)->Instance->CR1 : \
734 (((((__IT__) & 0xFFU) >> 5U) == 2U)? (__HANDLE__)->Instance->CR2 : \
735 (__HANDLE__)->Instance->CR3)) & (1U << (((uint16_t)(__IT__)) & SMARTCARD_IT_MASK)))
736
737
738 /** @brief Clear the specified SMARTCARD ISR flag, in setting the proper ICR register flag.
739 * @param __HANDLE__ specifies the SMARTCARD Handle.
740 * @param __IT_CLEAR__ specifies the interrupt clear register flag that needs to be set
741 * to clear the corresponding interrupt.
742 * This parameter can be one of the following values:
743 * @arg @ref SMARTCARD_CLEAR_PEF Parity error clear flag
744 * @arg @ref SMARTCARD_CLEAR_FEF Framing error clear flag
745 * @arg @ref SMARTCARD_CLEAR_NEF Noise detected clear flag
746 * @arg @ref SMARTCARD_CLEAR_OREF OverRun error clear flag
747 * @arg @ref SMARTCARD_CLEAR_IDLEF Idle line detection clear flag
748 * @arg @ref SMARTCARD_CLEAR_TCF Transmission complete clear flag
749 * @arg @ref SMARTCARD_CLEAR_RTOF Receiver timeout clear flag
750 * @arg @ref SMARTCARD_CLEAR_EOBF End of block clear flag
751 * @retval None
752 */
753 #define __HAL_SMARTCARD_CLEAR_IT(__HANDLE__, __IT_CLEAR__) ((__HANDLE__)->Instance->ICR = (uint32_t)(__IT_CLEAR__))
754
755 /** @brief Set a specific SMARTCARD request flag.
756 * @param __HANDLE__ specifies the SMARTCARD Handle.
757 * @param __REQ__ specifies the request flag to set
758 * This parameter can be one of the following values:
759 * @arg @ref SMARTCARD_RXDATA_FLUSH_REQUEST Receive data flush Request
760 * @arg @ref SMARTCARD_TXDATA_FLUSH_REQUEST Transmit data flush Request
761 *
762 * @retval None
763 */
764 #define __HAL_SMARTCARD_SEND_REQ(__HANDLE__, __REQ__) ((__HANDLE__)->Instance->RQR |= (uint16_t)(__REQ__))
765
766 /** @brief Enable the SMARTCARD one bit sample method.
767 * @param __HANDLE__ specifies the SMARTCARD Handle.
768 * @retval None
769 */
770 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3|= USART_CR3_ONEBIT)
771
772 /** @brief Disable the SMARTCARD one bit sample method.
773 * @param __HANDLE__ specifies the SMARTCARD Handle.
774 * @retval None
775 */
776 #define __HAL_SMARTCARD_ONE_BIT_SAMPLE_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR3 &= (uint32_t)~((uint32_t)USART_CR3_ONEBIT))
777
778 /** @brief Enable the USART associated to the SMARTCARD Handle.
779 * @param __HANDLE__ specifies the SMARTCARD Handle.
780 * @retval None
781 */
782 #define __HAL_SMARTCARD_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 |= USART_CR1_UE)
783
784 /** @brief Disable the USART associated to the SMARTCARD Handle
785 * @param __HANDLE__ specifies the SMARTCARD Handle.
786 * @retval None
787 */
788 #define __HAL_SMARTCARD_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR1 &= ~USART_CR1_UE)
789
790 /**
791 * @}
792 */
793
794 /* Private macros -------------------------------------------------------------*/
795 /** @defgroup SMARTCARD_Private_Macros SMARTCARD Private Macros
796 * @{
797 */
798
799 /** @brief Check the Baud rate range.
800 * @note The maximum Baud Rate is derived from the maximum clock on F3 (72 MHz)
801 * divided by the oversampling used on the SMARTCARD (i.e. 16).
802 * @param __BAUDRATE__ Baud rate set by the configuration function.
803 * @retval Test result (TRUE or FALSE)
804 */
805 #define IS_SMARTCARD_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 4500001U)
806
807 /** @brief Check the block length range.
808 * @note The maximum SMARTCARD block length is 0xFF.
809 * @param __LENGTH__ block length.
810 * @retval Test result (TRUE or FALSE)
811 */
812 #define IS_SMARTCARD_BLOCKLENGTH(__LENGTH__) ((__LENGTH__) <= 0xFFU)
813
814 /** @brief Check the receiver timeout value.
815 * @note The maximum SMARTCARD receiver timeout value is 0xFFFFFF.
816 * @param __TIMEOUTVALUE__ receiver timeout value.
817 * @retval Test result (TRUE or FALSE)
818 */
819 #define IS_SMARTCARD_TIMEOUT_VALUE(__TIMEOUTVALUE__) ((__TIMEOUTVALUE__) <= 0xFFFFFFU)
820
821 /** @brief Check the SMARTCARD autoretry counter value.
822 * @note The maximum number of retransmissions is 0x7.
823 * @param __COUNT__ number of retransmissions.
824 * @retval Test result (TRUE or FALSE)
825 */
826 #define IS_SMARTCARD_AUTORETRY_COUNT(__COUNT__) ((__COUNT__) <= 0x7U)
827
828 /**
829 * @brief Ensure that SMARTCARD frame length is valid.
830 * @param __LENGTH__ SMARTCARD frame length.
831 * @retval SET (__LENGTH__ is valid) or RESET (__LENGTH__ is invalid)
832 */
833 #define IS_SMARTCARD_WORD_LENGTH(__LENGTH__) ((__LENGTH__) == SMARTCARD_WORDLENGTH_9B)
834
835 /**
836 * @brief Ensure that SMARTCARD frame number of stop bits is valid.
837 * @param __STOPBITS__ SMARTCARD frame number of stop bits.
838 * @retval SET (__STOPBITS__ is valid) or RESET (__STOPBITS__ is invalid)
839 */
840 #define IS_SMARTCARD_STOPBITS(__STOPBITS__) (((__STOPBITS__) == SMARTCARD_STOPBITS_0_5) ||\
841 ((__STOPBITS__) == SMARTCARD_STOPBITS_1_5))
842
843 /**
844 * @brief Ensure that SMARTCARD frame parity is valid.
845 * @param __PARITY__ SMARTCARD frame parity.
846 * @retval SET (__PARITY__ is valid) or RESET (__PARITY__ is invalid)
847 */
848 #define IS_SMARTCARD_PARITY(__PARITY__) (((__PARITY__) == SMARTCARD_PARITY_EVEN) || \
849 ((__PARITY__) == SMARTCARD_PARITY_ODD))
850
851 /**
852 * @brief Ensure that SMARTCARD communication mode is valid.
853 * @param __MODE__ SMARTCARD communication mode.
854 * @retval SET (__MODE__ is valid) or RESET (__MODE__ is invalid)
855 */
856 #define IS_SMARTCARD_MODE(__MODE__) ((((__MODE__) & (uint16_t)0xFFF3U) == 0x00U) && ((__MODE__) != (uint16_t)0x00U))
857
858 /**
859 * @brief Ensure that SMARTCARD frame polarity is valid.
860 * @param __CPOL__ SMARTCARD frame polarity.
861 * @retval SET (__CPOL__ is valid) or RESET (__CPOL__ is invalid)
862 */
863 #define IS_SMARTCARD_POLARITY(__CPOL__) (((__CPOL__) == SMARTCARD_POLARITY_LOW) || ((__CPOL__) == SMARTCARD_POLARITY_HIGH))
864
865 /**
866 * @brief Ensure that SMARTCARD frame phase is valid.
867 * @param __CPHA__ SMARTCARD frame phase.
868 * @retval SET (__CPHA__ is valid) or RESET (__CPHA__ is invalid)
869 */
870 #define IS_SMARTCARD_PHASE(__CPHA__) (((__CPHA__) == SMARTCARD_PHASE_1EDGE) || ((__CPHA__) == SMARTCARD_PHASE_2EDGE))
871
872 /**
873 * @brief Ensure that SMARTCARD frame last bit clock pulse setting is valid.
874 * @param __LASTBIT__ SMARTCARD frame last bit clock pulse setting.
875 * @retval SET (__LASTBIT__ is valid) or RESET (__LASTBIT__ is invalid)
876 */
877 #define IS_SMARTCARD_LASTBIT(__LASTBIT__) (((__LASTBIT__) == SMARTCARD_LASTBIT_DISABLE) || \
878 ((__LASTBIT__) == SMARTCARD_LASTBIT_ENABLE))
879
880 /**
881 * @brief Ensure that SMARTCARD frame sampling is valid.
882 * @param __ONEBIT__ SMARTCARD frame sampling.
883 * @retval SET (__ONEBIT__ is valid) or RESET (__ONEBIT__ is invalid)
884 */
885 #define IS_SMARTCARD_ONE_BIT_SAMPLE(__ONEBIT__) (((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_DISABLE) || \
886 ((__ONEBIT__) == SMARTCARD_ONE_BIT_SAMPLE_ENABLE))
887
888 /**
889 * @brief Ensure that SMARTCARD NACK transmission setting is valid.
890 * @param __NACK__ SMARTCARD NACK transmission setting.
891 * @retval SET (__NACK__ is valid) or RESET (__NACK__ is invalid)
892 */
893 #define IS_SMARTCARD_NACK(__NACK__) (((__NACK__) == SMARTCARD_NACK_ENABLE) || \
894 ((__NACK__) == SMARTCARD_NACK_DISABLE))
895
896 /**
897 * @brief Ensure that SMARTCARD receiver timeout setting is valid.
898 * @param __TIMEOUT__ SMARTCARD receiver timeout setting.
899 * @retval SET (__TIMEOUT__ is valid) or RESET (__TIMEOUT__ is invalid)
900 */
901 #define IS_SMARTCARD_TIMEOUT(__TIMEOUT__) (((__TIMEOUT__) == SMARTCARD_TIMEOUT_DISABLE) || \
902 ((__TIMEOUT__) == SMARTCARD_TIMEOUT_ENABLE))
903
904 /**
905 * @brief Ensure that SMARTCARD advanced features initialization is valid.
906 * @param __INIT__ SMARTCARD advanced features initialization.
907 * @retval SET (__INIT__ is valid) or RESET (__INIT__ is invalid)
908 */
909 #define IS_SMARTCARD_ADVFEATURE_INIT(__INIT__) ((__INIT__) <= (SMARTCARD_ADVFEATURE_NO_INIT | \
910 SMARTCARD_ADVFEATURE_TXINVERT_INIT | \
911 SMARTCARD_ADVFEATURE_RXINVERT_INIT | \
912 SMARTCARD_ADVFEATURE_DATAINVERT_INIT | \
913 SMARTCARD_ADVFEATURE_SWAP_INIT | \
914 SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT | \
915 SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT | \
916 SMARTCARD_ADVFEATURE_MSBFIRST_INIT))
917
918 /**
919 * @brief Ensure that SMARTCARD frame TX inversion setting is valid.
920 * @param __TXINV__ SMARTCARD frame TX inversion setting.
921 * @retval SET (__TXINV__ is valid) or RESET (__TXINV__ is invalid)
922 */
923 #define IS_SMARTCARD_ADVFEATURE_TXINV(__TXINV__) (((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_DISABLE) || \
924 ((__TXINV__) == SMARTCARD_ADVFEATURE_TXINV_ENABLE))
925
926 /**
927 * @brief Ensure that SMARTCARD frame RX inversion setting is valid.
928 * @param __RXINV__ SMARTCARD frame RX inversion setting.
929 * @retval SET (__RXINV__ is valid) or RESET (__RXINV__ is invalid)
930 */
931 #define IS_SMARTCARD_ADVFEATURE_RXINV(__RXINV__) (((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_DISABLE) || \
932 ((__RXINV__) == SMARTCARD_ADVFEATURE_RXINV_ENABLE))
933
934 /**
935 * @brief Ensure that SMARTCARD frame data inversion setting is valid.
936 * @param __DATAINV__ SMARTCARD frame data inversion setting.
937 * @retval SET (__DATAINV__ is valid) or RESET (__DATAINV__ is invalid)
938 */
939 #define IS_SMARTCARD_ADVFEATURE_DATAINV(__DATAINV__) (((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_DISABLE) || \
940 ((__DATAINV__) == SMARTCARD_ADVFEATURE_DATAINV_ENABLE))
941
942 /**
943 * @brief Ensure that SMARTCARD frame RX/TX pins swap setting is valid.
944 * @param __SWAP__ SMARTCARD frame RX/TX pins swap setting.
945 * @retval SET (__SWAP__ is valid) or RESET (__SWAP__ is invalid)
946 */
947 #define IS_SMARTCARD_ADVFEATURE_SWAP(__SWAP__) (((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_DISABLE) || \
948 ((__SWAP__) == SMARTCARD_ADVFEATURE_SWAP_ENABLE))
949
950 /**
951 * @brief Ensure that SMARTCARD frame overrun setting is valid.
952 * @param __OVERRUN__ SMARTCARD frame overrun setting.
953 * @retval SET (__OVERRUN__ is valid) or RESET (__OVERRUN__ is invalid)
954 */
955 #define IS_SMARTCARD_OVERRUN(__OVERRUN__) (((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_ENABLE) || \
956 ((__OVERRUN__) == SMARTCARD_ADVFEATURE_OVERRUN_DISABLE))
957
958 /**
959 * @brief Ensure that SMARTCARD DMA enabling or disabling on error setting is valid.
960 * @param __DMA__ SMARTCARD DMA enabling or disabling on error setting.
961 * @retval SET (__DMA__ is valid) or RESET (__DMA__ is invalid)
962 */
963 #define IS_SMARTCARD_ADVFEATURE_DMAONRXERROR(__DMA__) (((__DMA__) == SMARTCARD_ADVFEATURE_DMA_ENABLEONRXERROR) || \
964 ((__DMA__) == SMARTCARD_ADVFEATURE_DMA_DISABLEONRXERROR))
965
966 /**
967 * @brief Ensure that SMARTCARD frame MSB first setting is valid.
968 * @param __MSBFIRST__ SMARTCARD frame MSB first setting.
969 * @retval SET (__MSBFIRST__ is valid) or RESET (__MSBFIRST__ is invalid)
970 */
971 #define IS_SMARTCARD_ADVFEATURE_MSBFIRST(__MSBFIRST__) (((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_DISABLE) || \
972 ((__MSBFIRST__) == SMARTCARD_ADVFEATURE_MSBFIRST_ENABLE))
973
974 /**
975 * @brief Ensure that SMARTCARD request parameter is valid.
976 * @param __PARAM__ SMARTCARD request parameter.
977 * @retval SET (__PARAM__ is valid) or RESET (__PARAM__ is invalid)
978 */
979 #define IS_SMARTCARD_REQUEST_PARAMETER(__PARAM__) (((__PARAM__) == SMARTCARD_RXDATA_FLUSH_REQUEST) || \
980 ((__PARAM__) == SMARTCARD_TXDATA_FLUSH_REQUEST))
981
982 /**
983 * @}
984 */
985
986 /* Include SMARTCARD HAL Extended module */
987 #include "stm32f3xx_hal_smartcard_ex.h"
988
989 /* Exported functions --------------------------------------------------------*/
990 /** @addtogroup SMARTCARD_Exported_Functions
991 * @{
992 */
993
994 /* Initialization and de-initialization functions ****************************/
995
996 /** @addtogroup SMARTCARD_Exported_Functions_Group1
997 * @{
998 */
999
1000 HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsmartcard);
1001 HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsmartcard);
1002 void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsmartcard);
1003 void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsmartcard);
1004
1005 /**
1006 * @}
1007 */
1008
1009 /* IO operation functions *****************************************************/
1010 /** @addtogroup SMARTCARD_Exported_Functions_Group2
1011 * @{
1012 */
1013
1014 HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size, uint32_t Timeout);
1015 HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size, uint32_t Timeout);
1016 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1017 HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1018 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1019 HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t *pData, uint16_t Size);
1020 /* Transfer Abort functions */
1021 HAL_StatusTypeDef HAL_SMARTCARD_Abort(SMARTCARD_HandleTypeDef *hsmartcard);
1022 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit(SMARTCARD_HandleTypeDef *hsmartcard);
1023 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive(SMARTCARD_HandleTypeDef *hsmartcard);
1024 HAL_StatusTypeDef HAL_SMARTCARD_Abort_IT(SMARTCARD_HandleTypeDef *hsmartcard);
1025 HAL_StatusTypeDef HAL_SMARTCARD_AbortTransmit_IT(SMARTCARD_HandleTypeDef *hsmartcard);
1026 HAL_StatusTypeDef HAL_SMARTCARD_AbortReceive_IT(SMARTCARD_HandleTypeDef *hsmartcard);
1027
1028 void HAL_SMARTCARD_IRQHandler(SMARTCARD_HandleTypeDef *hsmartcard);
1029 void HAL_SMARTCARD_TxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1030 void HAL_SMARTCARD_RxCpltCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1031 void HAL_SMARTCARD_ErrorCallback(SMARTCARD_HandleTypeDef *hsmartcard);
1032 void HAL_SMARTCARD_AbortCpltCallback (SMARTCARD_HandleTypeDef *hsmartcard);
1033 void HAL_SMARTCARD_AbortTransmitCpltCallback (SMARTCARD_HandleTypeDef *hsmartcard);
1034 void HAL_SMARTCARD_AbortReceiveCpltCallback (SMARTCARD_HandleTypeDef *hsmartcard);
1035
1036 /**
1037 * @}
1038 */
1039
1040 /* Peripheral State and Error functions ***************************************/
1041 /** @addtogroup SMARTCARD_Exported_Functions_Group3
1042 * @{
1043 */
1044
1045 HAL_SMARTCARD_StateTypeDef HAL_SMARTCARD_GetState(SMARTCARD_HandleTypeDef *hsmartcard);
1046 uint32_t HAL_SMARTCARD_GetError(SMARTCARD_HandleTypeDef *hsmartcard);
1047
1048 /**
1049 * @}
1050 */
1051
1052 /**
1053 * @}
1054 */
1055
1056 /**
1057 * @}
1058 */
1059
1060 /**
1061 * @}
1062 */
1063
1064 #ifdef __cplusplus
1065 }
1066 #endif
1067
1068 #endif /* __STM32F3xx_HAL_SMARTCARD_H */
1069
1070 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/