stm32l4xx_hal_smartcard_ex.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495
  1. /**
  2. ******************************************************************************
  3. * @file stm32l4xx_hal_smartcard_ex.h
  4. * @author MCD Application Team
  5. * @brief Header file of SMARTCARD HAL Extended module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; COPYRIGHT(c) 2017 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. /* Define to prevent recursive inclusion -------------------------------------*/
  36. #ifndef __STM32L4xx_HAL_SMARTCARD_EX_H
  37. #define __STM32L4xx_HAL_SMARTCARD_EX_H
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. /* Includes ------------------------------------------------------------------*/
  42. #include "stm32l4xx_hal_def.h"
  43. /** @addtogroup STM32L4xx_HAL_Driver
  44. * @{
  45. */
  46. /** @addtogroup SMARTCARDEx
  47. * @{
  48. */
  49. /* Exported types ------------------------------------------------------------*/
  50. /* Exported constants --------------------------------------------------------*/
  51. /** @addtogroup SMARTCARDEx_Exported_Constants SMARTCARD Extended Exported Constants
  52. * @{
  53. */
  54. /** @defgroup SMARTCARDEx_Transmission_Completion_Indication SMARTCARD Transmission Completion Indication
  55. * @{
  56. */
  57. #if defined(USART_TCBGT_SUPPORT)
  58. #define SMARTCARD_TCBGT SMARTCARD_IT_TCBGT /*!< SMARTCARD transmission complete before guard time */
  59. #endif /* USART_TCBGT_SUPPORT */
  60. #define SMARTCARD_TC SMARTCARD_IT_TC /*!< SMARTCARD transmission complete (flag raised when guard time has elapsed) */
  61. /**
  62. * @}
  63. */
  64. /** @defgroup SMARTCARDEx_Advanced_Features_Initialization_Type SMARTCARD advanced feature initialization type
  65. * @{
  66. */
  67. #define SMARTCARD_ADVFEATURE_NO_INIT 0x00000000U /*!< No advanced feature initialization */
  68. #define SMARTCARD_ADVFEATURE_TXINVERT_INIT 0x00000001U /*!< TX pin active level inversion */
  69. #define SMARTCARD_ADVFEATURE_RXINVERT_INIT 0x00000002U /*!< RX pin active level inversion */
  70. #define SMARTCARD_ADVFEATURE_DATAINVERT_INIT 0x00000004U /*!< Binary data inversion */
  71. #define SMARTCARD_ADVFEATURE_SWAP_INIT 0x00000008U /*!< TX/RX pins swap */
  72. #define SMARTCARD_ADVFEATURE_RXOVERRUNDISABLE_INIT 0x00000010U /*!< RX overrun disable */
  73. #define SMARTCARD_ADVFEATURE_DMADISABLEONERROR_INIT 0x00000020U /*!< DMA disable on Reception Error */
  74. #define SMARTCARD_ADVFEATURE_MSBFIRST_INIT 0x00000080U /*!< Most significant bit sent/received first */
  75. #if defined(USART_TCBGT_SUPPORT)
  76. #define SMARTCARD_ADVFEATURE_TXCOMPLETION 0x00000100U /*!< TX completion indication before of after guard time */
  77. #endif /* USART_TCBGT_SUPPORT */
  78. /**
  79. * @}
  80. */
  81. #if defined(USART_CR1_FIFOEN)
  82. /** @defgroup SMARTCARDEx_TXFIFO_threshold_level SMARTCARDEx TXFIFO threshold level
  83. * @brief SMARTCARD TXFIFO level
  84. * @{
  85. */
  86. #define SMARTCARD_TXFIFO_THRESHOLD_1_8 0x00000000U /*!< TXFIFO reaches 1/8 of its depth */
  87. #define SMARTCARD_TXFIFO_THRESHOLD_1_4 USART_CR3_TXFTCFG_0 /*!< TXFIFO reaches 1/4 of its depth */
  88. #define SMARTCARD_TXFIFO_THRESHOLD_1_2 USART_CR3_TXFTCFG_1 /*!< TXFIFO reaches 1/2 of its depth */
  89. #define SMARTCARD_TXFIFO_THRESHOLD_3_4 (USART_CR3_TXFTCFG_0|USART_CR3_TXFTCFG_1) /*!< TXFIFO reaches 3/4 of its depth */
  90. #define SMARTCARD_TXFIFO_THRESHOLD_7_8 USART_CR3_TXFTCFG_2 /*!< TXFIFO reaches 7/8 of its depth */
  91. #define SMARTCARD_TXFIFO_THRESHOLD_8_8 (USART_CR3_TXFTCFG_2|USART_CR3_TXFTCFG_0) /*!< TXFIFO becomes empty */
  92. /**
  93. * @}
  94. */
  95. /** @defgroup SMARTCARDEx_RXFIFO_threshold_level SMARTCARDEx RXFIFO threshold level
  96. * @brief SMARTCARD RXFIFO level
  97. * @{
  98. */
  99. #define SMARTCARD_RXFIFO_THRESHOLD_1_8 0x00000000U /*!< RXFIFO FIFO reaches 1/8 of its depth */
  100. #define SMARTCARD_RXFIFO_THRESHOLD_1_4 USART_CR3_RXFTCFG_0 /*!< RXFIFO FIFO reaches 1/4 of its depth */
  101. #define SMARTCARD_RXFIFO_THRESHOLD_1_2 USART_CR3_RXFTCFG_1 /*!< RXFIFO FIFO reaches 1/2 of its depth */
  102. #define SMARTCARD_RXFIFO_THRESHOLD_3_4 (USART_CR3_RXFTCFG_0|USART_CR3_RXFTCFG_1) /*!< RXFIFO FIFO reaches 3/4 of its depth */
  103. #define SMARTCARD_RXFIFO_THRESHOLD_7_8 USART_CR3_RXFTCFG_2 /*!< RXFIFO FIFO reaches 7/8 of its depth */
  104. #define SMARTCARD_RXFIFO_THRESHOLD_8_8 (USART_CR3_RXFTCFG_2|USART_CR3_RXFTCFG_0) /*!< RXFIFO FIFO becomes full */
  105. /**
  106. * @}
  107. */
  108. #endif
  109. /** @defgroup SMARTCARDEx_Flags SMARTCARD Flags
  110. * Elements values convention: 0xXXXX
  111. * - 0xXXXX : Flag mask in the ISR register
  112. * @{
  113. */
  114. #if defined(USART_TCBGT_SUPPORT)
  115. #define SMARTCARD_FLAG_TCBGT USART_ISR_TCBGT /*!< SMARTCARD transmission complete before guard time completion */
  116. #endif /* USART_TCBGT_SUPPORT */
  117. #define SMARTCARD_FLAG_REACK USART_ISR_REACK /*!< SMARTCARD receive enable acknowledge flag */
  118. #define SMARTCARD_FLAG_TEACK USART_ISR_TEACK /*!< SMARTCARD transmit enable acknowledge flag */
  119. #define SMARTCARD_FLAG_BUSY USART_ISR_BUSY /*!< SMARTCARD busy flag */
  120. #define SMARTCARD_FLAG_EOBF USART_ISR_EOBF /*!< SMARTCARD end of block flag */
  121. #define SMARTCARD_FLAG_RTOF USART_ISR_RTOF /*!< SMARTCARD receiver timeout flag */
  122. #if defined(USART_CR1_FIFOEN)
  123. #define SMARTCARD_FLAG_TXE USART_ISR_TXE_TXFNF /*!< SMARTCARD transmit data register empty */
  124. #define SMARTCARD_FLAG_TXFNF USART_ISR_TXE_TXFNF /*!< SMARTCARD TXFIFO not full */
  125. #else
  126. #define SMARTCARD_FLAG_TXE USART_ISR_TXE /*!< SMARTCARD transmit data register empty */
  127. #endif
  128. #define SMARTCARD_FLAG_TC USART_ISR_TC /*!< SMARTCARD transmission complete */
  129. #if defined(USART_CR1_FIFOEN)
  130. #define SMARTCARD_FLAG_RXNE USART_ISR_RXNE_RXFNE /*!< SMARTCARD read data register not empty */
  131. #define SMARTCARD_FLAG_RXFNE USART_ISR_RXNE_RXFNE /*!< SMARTCARD RXFIFO not empty */
  132. #else
  133. #define SMARTCARD_FLAG_RXNE USART_ISR_RXNE /*!< SMARTCARD read data register not empty */
  134. #endif
  135. #define SMARTCARD_FLAG_IDLE USART_ISR_IDLE /*!< SMARTCARD idle line detection */
  136. #define SMARTCARD_FLAG_ORE USART_ISR_ORE /*!< SMARTCARD overrun error */
  137. #define SMARTCARD_FLAG_NE USART_ISR_NE /*!< SMARTCARD noise error */
  138. #define SMARTCARD_FLAG_FE USART_ISR_FE /*!< SMARTCARD frame error */
  139. #define SMARTCARD_FLAG_PE USART_ISR_PE /*!< SMARTCARD parity error */
  140. #if defined(USART_CR1_FIFOEN)
  141. #define SMARTCARD_FLAG_TXFE USART_ISR_TXFE /*!< SMARTCARD TXFIFO Empty flag */
  142. #define SMARTCARD_FLAG_RXFF USART_ISR_RXFF /*!< SMARTCARD RXFIFO Full flag */
  143. #define SMARTCARD_FLAG_RXFT USART_ISR_RXFT /*!< SMARTCARD RXFIFO threshold flag */
  144. #define SMARTCARD_FLAG_TXFT USART_ISR_TXFT /*!< SMARTCARD TXFIFO threshold flag */
  145. #endif
  146. /**
  147. * @}
  148. */
  149. /** @defgroup SMARTCARDEx_Interrupt_definition SMARTCARD Interrupts Definition
  150. * Elements values convention: 000ZZZZZ0XXYYYYYb
  151. * - YYYYY : Interrupt source position in the XX register (5 bits)
  152. * - XX : Interrupt source register (2 bits)
  153. * - 01: CR1 register
  154. * - 10: CR2 register
  155. * - 11: CR3 register
  156. * - ZZZZZ : Flag position in the ISR register(5 bits)
  157. * @{
  158. */
  159. #define SMARTCARD_IT_PE 0x0028U /*!< SMARTCARD parity error interruption */
  160. #define SMARTCARD_IT_TXE 0x0727U /*!< SMARTCARD transmit data register empty interruption */
  161. #if defined(USART_CR1_FIFOEN)
  162. #define SMARTCARD_IT_TXFNF 0x0727U /*!< SMARTCARD TX FIFO not full interruption */
  163. #endif
  164. #define SMARTCARD_IT_TC 0x0626U /*!< SMARTCARD transmission complete interruption */
  165. #define SMARTCARD_IT_RXNE 0x0525U /*!< SMARTCARD read data register not empty interruption */
  166. #if defined(USART_CR1_FIFOEN)
  167. #define SMARTCARD_IT_RXFNE 0x0525U /*!< SMARTCARD RXFIFO not empty interruption */
  168. #endif
  169. #define SMARTCARD_IT_IDLE 0x0424U /*!< SMARTCARD idle line detection interruption */
  170. #define SMARTCARD_IT_ERR 0x0060U /*!< SMARTCARD error interruption */
  171. #define SMARTCARD_IT_ORE 0x0300U /*!< SMARTCARD overrun error interruption */
  172. #define SMARTCARD_IT_NE 0x0200U /*!< SMARTCARD noise error interruption */
  173. #define SMARTCARD_IT_FE 0x0100U /*!< SMARTCARD frame error interruption */
  174. #define SMARTCARD_IT_EOB 0x0C3BU /*!< SMARTCARD end of block interruption */
  175. #define SMARTCARD_IT_RTO 0x0B3AU /*!< SMARTCARD receiver timeout interruption */
  176. #if defined(USART_TCBGT_SUPPORT)
  177. #define SMARTCARD_IT_TCBGT 0x1978U /*!< SMARTCARD transmission complete before guard time completion interruption */
  178. #endif
  179. #if defined(USART_CR1_FIFOEN)
  180. #define SMARTCARD_IT_RXFF 0x183FU /*!< SMARTCARD RXFIFO full interruption */
  181. #define SMARTCARD_IT_TXFE 0x173EU /*!< SMARTCARD TXFIFO empty interruption */
  182. #define SMARTCARD_IT_RXFT 0x1A7CU /*!< SMARTCARD RXFIFO threshold reached interruption */
  183. #define SMARTCARD_IT_TXFT 0x1B77U /*!< SMARTCARD TXFIFO threshold reached interruption */
  184. #endif
  185. /**
  186. * @}
  187. */
  188. /** @defgroup SMARTCARDEx_IT_CLEAR_Flags SMARTCARD Interruption Clear Flags
  189. * @{
  190. */
  191. #define SMARTCARD_CLEAR_PEF USART_ICR_PECF /*!< SMARTCARD parity error clear flag */
  192. #define SMARTCARD_CLEAR_FEF USART_ICR_FECF /*!< SMARTCARD framing error clear flag */
  193. #define SMARTCARD_CLEAR_NEF USART_ICR_NECF /*!< SMARTCARD noise detected clear flag */
  194. #define SMARTCARD_CLEAR_OREF USART_ICR_ORECF /*!< SMARTCARD overrun error clear flag */
  195. #define SMARTCARD_CLEAR_IDLEF USART_ICR_IDLECF /*!< SMARTCARD idle line detected clear flag */
  196. #if defined(USART_CR1_FIFOEN)
  197. #define SMARTCARD_CLEAR_TXFECF USART_ICR_TXFECF /*!< TXFIFO empty Clear Flag */
  198. #endif
  199. #define SMARTCARD_CLEAR_TCF USART_ICR_TCCF /*!< SMARTCARD transmission complete clear flag */
  200. #if defined(USART_TCBGT_SUPPORT)
  201. #define SMARTCARD_CLEAR_TCBGTF USART_ICR_TCBGTCF /*!< SMARTCARD transmission complete before guard time completion clear flag */
  202. #endif
  203. #define SMARTCARD_CLEAR_RTOF USART_ICR_RTOCF /*!< SMARTCARD receiver time out clear flag */
  204. #define SMARTCARD_CLEAR_EOBF USART_ICR_EOBCF /*!< SMARTCARD end of block clear flag */
  205. /**
  206. * @}
  207. */
  208. /**
  209. * @}
  210. */
  211. /* Exported macros -----------------------------------------------------------*/
  212. /* Private constants ---------------------------------------------------------*/
  213. /** @defgroup SMARTCARDEx_Private_Constants SMARTCARDEx Private Constants
  214. * @{
  215. */
  216. #if defined(USART_CR1_FIFOEN)
  217. /** @defgroup SMARTCARDEx_FIFO_mode SMARTCARDEx FIFO mode
  218. * @{
  219. */
  220. #define SMARTCARD_FIFOMODE_DISABLE 0x00000000U /*!< FIFO mode disable */
  221. #define SMARTCARD_FIFOMODE_ENABLE USART_CR1_FIFOEN /*!< FIFO mode enable */
  222. /**
  223. * @}
  224. */
  225. #endif
  226. /**
  227. * @}
  228. */
  229. /* Private macros ------------------------------------------------------------*/
  230. /** @defgroup SMARTCARDEx_Private_Macros SMARTCARD Extended Private Macros
  231. * @{
  232. */
  233. /** @brief Report the SMARTCARD clock source.
  234. * @param __HANDLE__: specifies the SMARTCARD Handle.
  235. * @param __CLOCKSOURCE__: output variable.
  236. * @retval the SMARTCARD clocking source, written in __CLOCKSOURCE__.
  237. */
  238. #if defined (STM32L432xx) || defined (STM32L442xx)
  239. #define SMARTCARD_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
  240. do { \
  241. if((__HANDLE__)->Instance == USART1) \
  242. { \
  243. switch(__HAL_RCC_GET_USART1_SOURCE()) \
  244. { \
  245. case RCC_USART1CLKSOURCE_PCLK2: \
  246. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK2; \
  247. break; \
  248. case RCC_USART1CLKSOURCE_HSI: \
  249. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
  250. break; \
  251. case RCC_USART1CLKSOURCE_SYSCLK: \
  252. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
  253. break; \
  254. case RCC_USART1CLKSOURCE_LSE: \
  255. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
  256. break; \
  257. default: \
  258. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
  259. break; \
  260. } \
  261. } \
  262. else if((__HANDLE__)->Instance == USART2) \
  263. { \
  264. switch(__HAL_RCC_GET_USART2_SOURCE()) \
  265. { \
  266. case RCC_USART2CLKSOURCE_PCLK1: \
  267. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \
  268. break; \
  269. case RCC_USART2CLKSOURCE_HSI: \
  270. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
  271. break; \
  272. case RCC_USART2CLKSOURCE_SYSCLK: \
  273. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
  274. break; \
  275. case RCC_USART2CLKSOURCE_LSE: \
  276. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
  277. break; \
  278. default: \
  279. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
  280. break; \
  281. } \
  282. } \
  283. } while(0)
  284. #else
  285. #define SMARTCARD_GETCLOCKSOURCE(__HANDLE__,__CLOCKSOURCE__) \
  286. do { \
  287. if((__HANDLE__)->Instance == USART1) \
  288. { \
  289. switch(__HAL_RCC_GET_USART1_SOURCE()) \
  290. { \
  291. case RCC_USART1CLKSOURCE_PCLK2: \
  292. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK2; \
  293. break; \
  294. case RCC_USART1CLKSOURCE_HSI: \
  295. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
  296. break; \
  297. case RCC_USART1CLKSOURCE_SYSCLK: \
  298. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
  299. break; \
  300. case RCC_USART1CLKSOURCE_LSE: \
  301. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
  302. break; \
  303. default: \
  304. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
  305. break; \
  306. } \
  307. } \
  308. else if((__HANDLE__)->Instance == USART2) \
  309. { \
  310. switch(__HAL_RCC_GET_USART2_SOURCE()) \
  311. { \
  312. case RCC_USART2CLKSOURCE_PCLK1: \
  313. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \
  314. break; \
  315. case RCC_USART2CLKSOURCE_HSI: \
  316. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
  317. break; \
  318. case RCC_USART2CLKSOURCE_SYSCLK: \
  319. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
  320. break; \
  321. case RCC_USART2CLKSOURCE_LSE: \
  322. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
  323. break; \
  324. default: \
  325. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
  326. break; \
  327. } \
  328. } \
  329. else if((__HANDLE__)->Instance == USART3) \
  330. { \
  331. switch(__HAL_RCC_GET_USART3_SOURCE()) \
  332. { \
  333. case RCC_USART3CLKSOURCE_PCLK1: \
  334. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_PCLK1; \
  335. break; \
  336. case RCC_USART3CLKSOURCE_HSI: \
  337. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_HSI; \
  338. break; \
  339. case RCC_USART3CLKSOURCE_SYSCLK: \
  340. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_SYSCLK; \
  341. break; \
  342. case RCC_USART3CLKSOURCE_LSE: \
  343. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_LSE; \
  344. break; \
  345. default: \
  346. (__CLOCKSOURCE__) = SMARTCARD_CLOCKSOURCE_UNDEFINED; \
  347. break; \
  348. } \
  349. } \
  350. } while(0)
  351. #endif /* STM32L432xx || STM32L442xx */
  352. /** @brief Set the Transmission Completion flag
  353. * @param __HANDLE__ specifies the SMARTCARD Handle.
  354. * @note If TCBGT (Transmission Complete Before Guard Time) flag is not available or if
  355. * AdvancedInit.TxCompletionIndication is not already filled, the latter is forced
  356. * to SMARTCARD_TC (transmission completion indication when guard time has elapsed).
  357. * @retval None
  358. */
  359. #if defined(USART_TCBGT_SUPPORT)
  360. #define SMARTCARD_TRANSMISSION_COMPLETION_SETTING(__HANDLE__) \
  361. do { \
  362. if (HAL_IS_BIT_CLR((__HANDLE__)->AdvancedInit.AdvFeatureInit, SMARTCARD_ADVFEATURE_TXCOMPLETION)) \
  363. { \
  364. (__HANDLE__)->AdvancedInit.TxCompletionIndication = SMARTCARD_TC; \
  365. } \
  366. else \
  367. { \
  368. assert_param(IS_SMARTCARD_TRANSMISSION_COMPLETION((__HANDLE__)->AdvancedInit.TxCompletionIndication)); \
  369. } \
  370. } while(0)
  371. #else
  372. #define SMARTCARD_TRANSMISSION_COMPLETION_SETTING(__HANDLE__) \
  373. do { \
  374. (__HANDLE__)->AdvancedInit.TxCompletionIndication = SMARTCARD_TC; \
  375. } while(0)
  376. #endif
  377. /** @brief Return the transmission completion flag.
  378. * @param __HANDLE__ specifies the SMARTCARD Handle.
  379. * @note Based on AdvancedInit.TxCompletionIndication setting, return TC or TCBGT flag.
  380. * When TCBGT flag (Transmission Complete Before Guard Time) is not available, TC flag is
  381. * reported.
  382. * @retval Transmission completion flag
  383. */
  384. #if defined(USART_TCBGT_SUPPORT)
  385. #define SMARTCARD_TRANSMISSION_COMPLETION_FLAG(__HANDLE__) \
  386. (((__HANDLE__)->AdvancedInit.TxCompletionIndication == SMARTCARD_TC) ? (SMARTCARD_FLAG_TC) : (SMARTCARD_FLAG_TCBGT))
  387. #else
  388. #define SMARTCARD_TRANSMISSION_COMPLETION_FLAG(__HANDLE__) (SMARTCARD_FLAG_TC)
  389. #endif
  390. /**
  391. * @brief Ensure that SMARTCARD frame transmission completion used flag is valid.
  392. * @param __TXCOMPLETE__ SMARTCARD frame transmission completion used flag.
  393. * @retval SET (__TXCOMPLETE__ is valid) or RESET (__TXCOMPLETE__ is invalid)
  394. */
  395. #if defined(USART_TCBGT_SUPPORT)
  396. #define IS_SMARTCARD_TRANSMISSION_COMPLETION(__TXCOMPLETE__) (((__TXCOMPLETE__) == SMARTCARD_TCBGT) ||\
  397. ((__TXCOMPLETE__) == SMARTCARD_TC))
  398. #else
  399. #define IS_SMARTCARD_TRANSMISSION_COMPLETION(__TXCOMPLETE__) ((__TXCOMPLETE__) == SMARTCARD_TC)
  400. #endif
  401. /**
  402. * @}
  403. */
  404. /* Exported functions --------------------------------------------------------*/
  405. /** @addtogroup SMARTCARDEx_Exported_Functions
  406. * @{
  407. */
  408. /* Initialization and de-initialization functions ****************************/
  409. /** @addtogroup SMARTCARDEx_Exported_Functions_Group2
  410. * @{
  411. */
  412. /* IO operation functions *****************************************************/
  413. #if defined(USART_CR1_FIFOEN)
  414. void HAL_SMARTCARDEx_RxFifoFullCallback(SMARTCARD_HandleTypeDef *hsmartcard);
  415. void HAL_SMARTCARDEx_TxFifoEmptyCallback(SMARTCARD_HandleTypeDef *hsmartcard);
  416. #endif
  417. /**
  418. * @}
  419. */
  420. /** @addtogroup SMARTCARDEx_Exported_Functions_Group3
  421. * @{
  422. */
  423. /* Peripheral Control functions ***********************************************/
  424. void HAL_SMARTCARDEx_BlockLength_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t BlockLength);
  425. void HAL_SMARTCARDEx_TimeOut_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t TimeOutValue);
  426. HAL_StatusTypeDef HAL_SMARTCARDEx_EnableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard);
  427. HAL_StatusTypeDef HAL_SMARTCARDEx_DisableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard);
  428. #if defined(USART_CR1_FIFOEN)
  429. HAL_StatusTypeDef HAL_SMARTCARDEx_EnableFifoMode(SMARTCARD_HandleTypeDef *hsmartcard);
  430. HAL_StatusTypeDef HAL_SMARTCARDEx_DisableFifoMode(SMARTCARD_HandleTypeDef *hsmartcard);
  431. HAL_StatusTypeDef HAL_SMARTCARDEx_SetTxFifoThreshold(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t Threshold);
  432. HAL_StatusTypeDef HAL_SMARTCARDEx_SetRxFifoThreshold(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t Threshold);
  433. #endif
  434. /**
  435. * @}
  436. */
  437. /**
  438. * @}
  439. */
  440. /* Private functions ---------------------------------------------------------*/
  441. /**
  442. * @}
  443. */
  444. /**
  445. * @}
  446. */
  447. #ifdef __cplusplus
  448. }
  449. #endif
  450. #endif /* __STM32L4xx_HAL_SMARTCARD_EX_H */
  451. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/