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.
 
 
 

1102 lines
58 KiB

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