You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

1369 lines
75 KiB

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