STM32L4xx_HAL_Driver  1.14.0
stm32l4xx_hal_smartcard_ex.h
Go to the documentation of this file.
1 
20 /* Define to prevent recursive inclusion -------------------------------------*/
21 #ifndef STM32L4xx_HAL_SMARTCARD_EX_H
22 #define STM32L4xx_HAL_SMARTCARD_EX_H
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
28 /* Includes ------------------------------------------------------------------*/
29 #include "stm32l4xx_hal_def.h"
30 
39 /* Exported types ------------------------------------------------------------*/
40 /* Exported constants --------------------------------------------------------*/
41 
49 #if defined(USART_TCBGT_SUPPORT)
50 #define SMARTCARD_TCBGT SMARTCARD_IT_TCBGT
51 #endif /* USART_TCBGT_SUPPORT */
52 #define SMARTCARD_TC SMARTCARD_IT_TC
60 #define SMARTCARD_ADVFEATURE_NO_INIT 0x00000000U
61 #define SMARTCARD_ADVFEATURE_TXINVERT_INIT 0x00000001U
62 #define SMARTCARD_ADVFEATURE_RXINVERT_INIT 0x00000002U
63 #define SMARTCARD_ADVFEATURE_DATAINVERT_INIT 0x00000004U
64 #define SMARTCARD_ADVFEATURE_SWAP_INIT 0x00000008U
65 #define SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT 0x00000010U
66 #define SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT 0x00000020U
67 #define SMARTCARD_ADVFEATURE_MSBFIRST_INIT 0x00000080U
68 #if defined(USART_TCBGT_SUPPORT)
69 #define SMARTCARD_ADVFEATURE_TXCOMPLETION 0x00000100U
70 #endif /* USART_TCBGT_SUPPORT */
71 
75 #if defined(USART_CR1_FIFOEN)
76 
80 #define SMARTCARD_FIFOMODE_DISABLE 0x00000000U
81 #define SMARTCARD_FIFOMODE_ENABLE USART_CR1_FIFOEN
90 #define SMARTCARD_TXFIFO_THRESHOLD_1_8 0x00000000U
91 #define SMARTCARD_TXFIFO_THRESHOLD_1_4 USART_CR3_TXFTCFG_0
92 #define SMARTCARD_TXFIFO_THRESHOLD_1_2 USART_CR3_TXFTCFG_1
93 #define SMARTCARD_TXFIFO_THRESHOLD_3_4 (USART_CR3_TXFTCFG_0|USART_CR3_TXFTCFG_1)
94 #define SMARTCARD_TXFIFO_THRESHOLD_7_8 USART_CR3_TXFTCFG_2
95 #define SMARTCARD_TXFIFO_THRESHOLD_8_8 (USART_CR3_TXFTCFG_2|USART_CR3_TXFTCFG_0)
104 #define SMARTCARD_RXFIFO_THRESHOLD_1_8 0x00000000U
105 #define SMARTCARD_RXFIFO_THRESHOLD_1_4 USART_CR3_RXFTCFG_0
106 #define SMARTCARD_RXFIFO_THRESHOLD_1_2 USART_CR3_RXFTCFG_1
107 #define SMARTCARD_RXFIFO_THRESHOLD_3_4 (USART_CR3_RXFTCFG_0|USART_CR3_RXFTCFG_1)
108 #define SMARTCARD_RXFIFO_THRESHOLD_7_8 USART_CR3_RXFTCFG_2
109 #define SMARTCARD_RXFIFO_THRESHOLD_8_8 (USART_CR3_RXFTCFG_2|USART_CR3_RXFTCFG_0)
114 #endif /* USART_CR1_FIFOEN */
115 
120 #if defined(USART_TCBGT_SUPPORT)
121 #define SMARTCARD_FLAG_TCBGT USART_ISR_TCBGT
122 #endif /* USART_TCBGT_SUPPORT */
123 #define SMARTCARD_FLAG_REACK USART_ISR_REACK
124 #define SMARTCARD_FLAG_TEACK USART_ISR_TEACK
125 #define SMARTCARD_FLAG_BUSY USART_ISR_BUSY
126 #define SMARTCARD_FLAG_EOBF USART_ISR_EOBF
127 #define SMARTCARD_FLAG_RTOF USART_ISR_RTOF
128 #if defined(USART_CR1_FIFOEN)
129 #define SMARTCARD_FLAG_TXE USART_ISR_TXE_TXFNF
130 #define SMARTCARD_FLAG_TXFNF USART_ISR_TXE_TXFNF
131 #else
132 #define SMARTCARD_FLAG_TXE USART_ISR_TXE
133 #endif /* USART_CR1_FIFOEN */
134 #define SMARTCARD_FLAG_TC USART_ISR_TC
135 #if defined(USART_CR1_FIFOEN)
136 #define SMARTCARD_FLAG_RXNE USART_ISR_RXNE_RXFNE
137 #define SMARTCARD_FLAG_RXFNE USART_ISR_RXNE_RXFNE
138 #else
139 #define SMARTCARD_FLAG_RXNE USART_ISR_RXNE
140 #endif /* USART_CR1_FIFOEN */
141 #define SMARTCARD_FLAG_IDLE USART_ISR_IDLE
142 #define SMARTCARD_FLAG_ORE USART_ISR_ORE
143 #define SMARTCARD_FLAG_NE USART_ISR_NE
144 #define SMARTCARD_FLAG_FE USART_ISR_FE
145 #define SMARTCARD_FLAG_PE USART_ISR_PE
146 #if defined(USART_CR1_FIFOEN)
147 #define SMARTCARD_FLAG_TXFE USART_ISR_TXFE
148 #define SMARTCARD_FLAG_RXFF USART_ISR_RXFF
149 #define SMARTCARD_FLAG_RXFT USART_ISR_RXFT
150 #define SMARTCARD_FLAG_TXFT USART_ISR_TXFT
151 #endif /* USART_CR1_FIFOEN */
152 
166 #define SMARTCARD_IT_PE 0x0028U
167 #define SMARTCARD_IT_TXE 0x0727U
168 #if defined(USART_CR1_FIFOEN)
169 #define SMARTCARD_IT_TXFNF 0x0727U
170 #endif /* USART_CR1_FIFOEN */
171 #define SMARTCARD_IT_TC 0x0626U
172 #define SMARTCARD_IT_RXNE 0x0525U
173 #if defined(USART_CR1_FIFOEN)
174 #define SMARTCARD_IT_RXFNE 0x0525U
175 #endif /* USART_CR1_FIFOEN */
176 #define SMARTCARD_IT_IDLE 0x0424U
178 #define SMARTCARD_IT_ERR 0x0060U
179 #define SMARTCARD_IT_ORE 0x0300U
180 #define SMARTCARD_IT_NE 0x0200U
181 #define SMARTCARD_IT_FE 0x0100U
183 #define SMARTCARD_IT_EOB 0x0C3BU
184 #define SMARTCARD_IT_RTO 0x0B3AU
185 #if defined(USART_TCBGT_SUPPORT)
186 #define SMARTCARD_IT_TCBGT 0x1978U
187 #endif /* USART_TCBGT_SUPPORT */
188 
189 #if defined(USART_CR1_FIFOEN)
190 #define SMARTCARD_IT_RXFF 0x183FU
191 #define SMARTCARD_IT_TXFE 0x173EU
192 #define SMARTCARD_IT_RXFT 0x1A7CU
193 #define SMARTCARD_IT_TXFT 0x1B77U
194 #endif /* USART_CR1_FIFOEN */
195 
202 #define SMARTCARD_CLEAR_PEF USART_ICR_PECF
203 #define SMARTCARD_CLEAR_FEF USART_ICR_FECF
204 #define SMARTCARD_CLEAR_NEF USART_ICR_NECF
205 #define SMARTCARD_CLEAR_OREF USART_ICR_ORECF
206 #define SMARTCARD_CLEAR_IDLEF USART_ICR_IDLECF
207 #if defined(USART_CR1_FIFOEN)
208 #define SMARTCARD_CLEAR_TXFECF USART_ICR_TXFECF
209 #endif /* USART_CR1_FIFOEN */
210 #define SMARTCARD_CLEAR_TCF USART_ICR_TCCF
211 #if defined(USART_TCBGT_SUPPORT)
212 #define SMARTCARD_CLEAR_TCBGTF USART_ICR_TCBGTCF
213 #endif /* USART_TCBGT_SUPPORT */
214 #define SMARTCARD_CLEAR_RTOF USART_ICR_RTOCF
215 #define SMARTCARD_CLEAR_EOBF USART_ICR_EOBCF
223 /* Exported macros -----------------------------------------------------------*/
224 /* Private macros ------------------------------------------------------------*/
236 #if defined(USART_TCBGT_SUPPORT)
237 #define SMARTCARD_TRANSMISSION_COMPLETION_SETTING(__HANDLE__) \
238  do { \
239  if (HAL_IS_BIT_CLR((__HANDLE__)->AdvancedInit.AdvFeatureInit, SMARTCARD_ADVFEATURE_TXCOMPLETION)) \
240  { \
241  (__HANDLE__)->AdvancedInit.TxCompletionIndication = SMARTCARD_TC; \
242  } \
243  else \
244  { \
245  assert_param(IS_SMARTCARD_TRANSMISSION_COMPLETION((__HANDLE__)->AdvancedInit.TxCompletionIndication)); \
246  } \
247  } while(0U)
248 #else
249 #define SMARTCARD_TRANSMISSION_COMPLETION_SETTING(__HANDLE__) \
250  do { \
251  (__HANDLE__)->AdvancedInit.TxCompletionIndication = SMARTCARD_TC; \
252  } while(0U)
253 #endif /* USART_TCBGT_SUPPORT */
254 
262 #if defined(USART_TCBGT_SUPPORT)
263 #define SMARTCARD_TRANSMISSION_COMPLETION_FLAG(__HANDLE__) \
264  (((__HANDLE__)->AdvancedInit.TxCompletionIndication == SMARTCARD_TC) ? (SMARTCARD_FLAG_TC) : (SMARTCARD_FLAG_TCBGT))
265 #else
266 #define SMARTCARD_TRANSMISSION_COMPLETION_FLAG(__HANDLE__) (SMARTCARD_FLAG_TC)
267 #endif /* USART_TCBGT_SUPPORT */
268 
269 
274 #if defined(USART_TCBGT_SUPPORT)
275 #define IS_SMARTCARD_TRANSMISSION_COMPLETION(__TXCOMPLETE__) (((__TXCOMPLETE__) == SMARTCARD_TCBGT) || \
276  ((__TXCOMPLETE__) == SMARTCARD_TC))
277 #else
278 #define IS_SMARTCARD_TRANSMISSION_COMPLETION(__TXCOMPLETE__) ((__TXCOMPLETE__) == SMARTCARD_TC)
279 #endif /* USART_TCBGT_SUPPORT */
280 
281 #if defined(USART_CR1_FIFOEN)
282 
286 #define IS_SMARTCARD_FIFOMODE_STATE(__STATE__) (((__STATE__) == SMARTCARD_FIFOMODE_DISABLE ) || \
287  ((__STATE__) == SMARTCARD_FIFOMODE_ENABLE))
288 
293 #define IS_SMARTCARD_TXFIFO_THRESHOLD(__THRESHOLD__) (((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_1_8) || \
294  ((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_1_4) || \
295  ((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_1_2) || \
296  ((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_3_4) || \
297  ((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_7_8) || \
298  ((__THRESHOLD__) == SMARTCARD_TXFIFO_THRESHOLD_8_8))
299 
304 #define IS_SMARTCARD_RXFIFO_THRESHOLD(__THRESHOLD__) (((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_1_8) || \
305  ((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_1_4) || \
306  ((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_1_2) || \
307  ((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_3_4) || \
308  ((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_7_8) || \
309  ((__THRESHOLD__) == SMARTCARD_RXFIFO_THRESHOLD_8_8))
310 
311 #endif /* USART_CR1_FIFOEN */
312 
316 /* Exported functions --------------------------------------------------------*/
321 /* Initialization and de-initialization functions ****************************/
322 /* IO operation methods *******************************************************/
323 
328 /* Peripheral Control functions ***********************************************/
329 void HAL_SMARTCARDEx_BlockLength_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t BlockLength);
330 void HAL_SMARTCARDEx_TimeOut_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t TimeOutValue);
331 HAL_StatusTypeDef HAL_SMARTCARDEx_EnableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard);
332 HAL_StatusTypeDef HAL_SMARTCARDEx_DisableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard);
333 
338 /* Exported functions --------------------------------------------------------*/
343 /* IO operation functions *****************************************************/
344 #if defined(USART_CR1_FIFOEN)
345 void HAL_SMARTCARDEx_RxFifoFullCallback(SMARTCARD_HandleTypeDef *hsmartcard);
346 void HAL_SMARTCARDEx_TxFifoEmptyCallback(SMARTCARD_HandleTypeDef *hsmartcard);
347 #endif /* USART_CR1_FIFOEN */
348 
357 /* Peripheral Control functions ***********************************************/
358 #if defined(USART_CR1_FIFOEN)
359 HAL_StatusTypeDef HAL_SMARTCARDEx_EnableFifoMode(SMARTCARD_HandleTypeDef *hsmartcard);
360 HAL_StatusTypeDef HAL_SMARTCARDEx_DisableFifoMode(SMARTCARD_HandleTypeDef *hsmartcard);
361 HAL_StatusTypeDef HAL_SMARTCARDEx_SetTxFifoThreshold(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t Threshold);
362 HAL_StatusTypeDef HAL_SMARTCARDEx_SetRxFifoThreshold(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t Threshold);
363 #endif /* USART_CR1_FIFOEN */
364 
373 /* Private functions ---------------------------------------------------------*/
374 
383 #ifdef __cplusplus
384 }
385 #endif
386 
387 #endif /* STM32L4xx_HAL_SMARTCARD_EX_H */
388 
389 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
HAL_SMARTCARDEx_DisableFifoMode
HAL_StatusTypeDef HAL_SMARTCARDEx_DisableFifoMode(SMARTCARD_HandleTypeDef *hsmartcard)
Disable the FIFO mode.
Definition: stm32l4xx_hal_smartcard_ex.c:302
HAL_SMARTCARDEx_TxFifoEmptyCallback
void HAL_SMARTCARDEx_TxFifoEmptyCallback(SMARTCARD_HandleTypeDef *hsmartcard)
SMARTCARD TX Fifo empty callback.
Definition: stm32l4xx_hal_smartcard_ex.c:223
HAL_SMARTCARDEx_BlockLength_Config
void HAL_SMARTCARDEx_BlockLength_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t BlockLength)
Update on the fly the SMARTCARD block length in RTOR register.
Definition: stm32l4xx_hal_smartcard_ex.c:100
stm32l4xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_SMARTCARDEx_SetTxFifoThreshold
HAL_StatusTypeDef HAL_SMARTCARDEx_SetTxFifoThreshold(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t Threshold)
Set the TXFIFO threshold.
Definition: stm32l4xx_hal_smartcard_ex.c:348
HAL_SMARTCARDEx_RxFifoFullCallback
void HAL_SMARTCARDEx_RxFifoFullCallback(SMARTCARD_HandleTypeDef *hsmartcard)
SMARTCARD RX Fifo full callback.
Definition: stm32l4xx_hal_smartcard_ex.c:207
HAL_SMARTCARDEx_EnableFifoMode
HAL_StatusTypeDef HAL_SMARTCARDEx_EnableFifoMode(SMARTCARD_HandleTypeDef *hsmartcard)
Enable the FIFO mode.
Definition: stm32l4xx_hal_smartcard_ex.c:261
HAL_SMARTCARDEx_SetRxFifoThreshold
HAL_StatusTypeDef HAL_SMARTCARDEx_SetRxFifoThreshold(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t Threshold)
Set the RXFIFO threshold.
Definition: stm32l4xx_hal_smartcard_ex.c:397
__SMARTCARD_HandleTypeDef
SMARTCARD handle Structure definition.
Definition: stm32l4xx_hal_smartcard.h:195
HAL_SMARTCARDEx_DisableReceiverTimeOut
HAL_StatusTypeDef HAL_SMARTCARDEx_DisableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard)
Disable the SMARTCARD receiver timeout feature.
Definition: stm32l4xx_hal_smartcard_ex.c:153
HAL_SMARTCARDEx_EnableReceiverTimeOut
HAL_StatusTypeDef HAL_SMARTCARDEx_EnableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard)
Enable the SMARTCARD receiver timeout feature.
Definition: stm32l4xx_hal_smartcard_ex.c:123
HAL_SMARTCARDEx_TimeOut_Config
void HAL_SMARTCARDEx_TimeOut_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t TimeOutValue)
Update on the fly the receiver timeout value in RTOR register.
Definition: stm32l4xx_hal_smartcard_ex.c:112