stm32l1xx_hal_smartcard.h 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587
  1. /**
  2. ******************************************************************************
  3. * @file stm32l1xx_hal_smartcard.h
  4. * @author MCD Application Team
  5. * @version V1.0.0
  6. * @date 5-September-2014
  7. * @brief This file contains all the functions prototypes for the SMARTCARD
  8. * firmware library.
  9. ******************************************************************************
  10. * @attention
  11. *
  12. * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  13. *
  14. * Redistribution and use in source and binary forms, with or without modification,
  15. * are permitted provided that the following conditions are met:
  16. * 1. Redistributions of source code must retain the above copyright notice,
  17. * this list of conditions and the following disclaimer.
  18. * 2. Redistributions in binary form must reproduce the above copyright notice,
  19. * this list of conditions and the following disclaimer in the documentation
  20. * and/or other materials provided with the distribution.
  21. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  22. * may be used to endorse or promote products derived from this software
  23. * without specific prior written permission.
  24. *
  25. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  26. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  28. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  29. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  31. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  33. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35. *
  36. ******************************************************************************
  37. */
  38. /* Define to prevent recursive inclusion -------------------------------------*/
  39. #ifndef __STM32L1xx_HAL_SMARTCARD_H
  40. #define __STM32L1xx_HAL_SMARTCARD_H
  41. #ifdef __cplusplus
  42. extern "C" {
  43. #endif
  44. /* Includes ------------------------------------------------------------------*/
  45. #include "stm32l1xx_hal_def.h"
  46. /** @addtogroup STM32L1xx_HAL_Driver
  47. * @{
  48. */
  49. /** @addtogroup SMARTCARD
  50. * @{
  51. */
  52. /* Exported types ------------------------------------------------------------*/
  53. /** @defgroup SMARTCARD_Exported_Types SMARTCARD Exported Types
  54. * @{
  55. */
  56. /**
  57. * @brief SMARTCARD Init Structure definition
  58. */
  59. typedef struct
  60. {
  61. uint32_t BaudRate; /*!< This member configures the SmartCard communication baud rate.
  62. The baud rate is computed using the following formula:
  63. - IntegerDivider = ((PCLKx) / (8 * (hsc->Init.BaudRate)))
  64. - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8) + 0.5 */
  65. uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
  66. This parameter can be a value of @ref SMARTCARD_Word_Length */
  67. uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
  68. This parameter can be a value of @ref SMARTCARD_Stop_Bits */
  69. uint32_t Parity; /*!< Specifies the parity mode.
  70. This parameter can be a value of @ref SMARTCARD_Parity
  71. @note When parity is enabled, the computed parity is inserted
  72. at the MSB position of the transmitted data (9th bit when
  73. the word length is set to 9 data bits; 8th bit when the
  74. word length is set to 8 data bits).*/
  75. uint32_t Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.
  76. This parameter can be a value of @ref SMARTCARD_Mode */
  77. uint32_t CLKPolarity; /*!< Specifies the steady state of the serial clock.
  78. This parameter can be a value of @ref SMARTCARD_Clock_Polarity */
  79. uint32_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made.
  80. This parameter can be a value of @ref SMARTCARD_Clock_Phase */
  81. uint32_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted
  82. data bit (MSB) has to be output on the SCLK pin in synchronous mode.
  83. This parameter can be a value of @ref SMARTCARD_Last_Bit */
  84. uint32_t Prescaler; /*!< Specifies the SmartCard Prescaler
  85. This parameter must be a number between Min_Data = 0 and Max_Data = 255 */
  86. uint32_t GuardTime; /*!< Specifies the SmartCard Guard Time
  87. This parameter must be a number between Min_Data = 0 and Max_Data = 255 */
  88. uint32_t NACKState; /*!< Specifies the SmartCard NACK Transmission state
  89. This parameter can be a value of @ref SMARTCARD_NACK_State */
  90. }SMARTCARD_InitTypeDef;
  91. /**
  92. * @brief HAL State structures definition
  93. */
  94. typedef enum
  95. {
  96. HAL_SMARTCARD_STATE_RESET = 0x00, /*!< Peripheral is not yet Initialized */
  97. HAL_SMARTCARD_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
  98. HAL_SMARTCARD_STATE_BUSY = 0x02, /*!< an internal process is ongoing */
  99. HAL_SMARTCARD_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
  100. HAL_SMARTCARD_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
  101. HAL_SMARTCARD_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
  102. HAL_SMARTCARD_STATE_TIMEOUT = 0x03, /*!< Timeout state */
  103. HAL_SMARTCARD_STATE_ERROR = 0x04 /*!< Error */
  104. }HAL_SMARTCARD_StateTypeDef;
  105. /**
  106. * @brief HAL SMARTCARD Error Code structure definition
  107. */
  108. typedef enum
  109. {
  110. HAL_SMARTCARD_ERROR_NONE = 0x00, /*!< No error */
  111. HAL_SMARTCARD_ERROR_PE = 0x01, /*!< Parity error */
  112. HAL_SMARTCARD_ERROR_NE = 0x02, /*!< Noise error */
  113. HAL_SMARTCARD_ERROR_FE = 0x04, /*!< frame error */
  114. HAL_SMARTCARD_ERROR_ORE = 0x08, /*!< Overrun error */
  115. HAL_SMARTCARD_ERROR_DMA = 0x10 /*!< DMA transfer error */
  116. }HAL_SMARTCARD_ErrorTypeDef;
  117. /**
  118. * @brief SMARTCARD handle Structure definition
  119. */
  120. typedef struct
  121. {
  122. USART_TypeDef *Instance; /* USART registers base address */
  123. SMARTCARD_InitTypeDef Init; /* SmartCard communication parameters */
  124. uint8_t *pTxBuffPtr; /* Pointer to SmartCard Tx transfer Buffer */
  125. uint16_t TxXferSize; /* SmartCard Tx Transfer size */
  126. uint16_t TxXferCount; /* SmartCard Tx Transfer Counter */
  127. uint8_t *pRxBuffPtr; /* Pointer to SmartCard Rx transfer Buffer */
  128. uint16_t RxXferSize; /* SmartCard Rx Transfer size */
  129. uint16_t RxXferCount; /* SmartCard Rx Transfer Counter */
  130. DMA_HandleTypeDef *hdmatx; /* SmartCard Tx DMA Handle parameters */
  131. DMA_HandleTypeDef *hdmarx; /* SmartCard Rx DMA Handle parameters */
  132. HAL_LockTypeDef Lock; /* Locking object */
  133. __IO HAL_SMARTCARD_StateTypeDef State; /* SmartCard communication state */
  134. __IO HAL_SMARTCARD_ErrorTypeDef ErrorCode; /* SmartCard Error code */
  135. }SMARTCARD_HandleTypeDef;
  136. /**
  137. * @}
  138. */
  139. /* Exported constants --------------------------------------------------------*/
  140. /** @defgroup SMARTCARD_Exported_Constants SMARTCARD Exported constants
  141. * @{
  142. */
  143. /** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length
  144. * @{
  145. */
  146. #define SMARTCARD_WORDLENGTH_8B ((uint32_t)0x00000000)
  147. #define SMARTCARD_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
  148. #define IS_SMARTCARD_WORD_LENGTH(LENGTH) ((LENGTH) == SMARTCARD_WORDLENGTH_9B)
  149. /**
  150. * @}
  151. */
  152. /** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits
  153. * @{
  154. */
  155. #define SMARTCARD_STOPBITS_1 ((uint32_t)0x00000000)
  156. #define SMARTCARD_STOPBITS_0_5 ((uint32_t)USART_CR2_STOP_0)
  157. #define SMARTCARD_STOPBITS_2 ((uint32_t)USART_CR2_STOP_1)
  158. #define SMARTCARD_STOPBITS_1_5 ((uint32_t)(USART_CR2_STOP_0 | USART_CR2_STOP_1))
  159. #define IS_SMARTCARD_STOPBITS(STOPBITS) (((STOPBITS) == SMARTCARD_STOPBITS_0_5) || \
  160. ((STOPBITS) == SMARTCARD_STOPBITS_1_5))
  161. /**
  162. * @}
  163. */
  164. /** @defgroup SMARTCARD_Parity SMARTCARD Parity
  165. * @{
  166. */
  167. #define SMARTCARD_PARITY_NONE ((uint32_t)0x00000000)
  168. #define SMARTCARD_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
  169. #define SMARTCARD_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
  170. #define IS_SMARTCARD_PARITY(PARITY) (((PARITY) == SMARTCARD_PARITY_EVEN) || \
  171. ((PARITY) == SMARTCARD_PARITY_ODD))
  172. /**
  173. * @}
  174. */
  175. /** @defgroup SMARTCARD_Mode SMARTCARD Mode
  176. * @{
  177. */
  178. #define SMARTCARD_MODE_RX ((uint32_t)USART_CR1_RE)
  179. #define SMARTCARD_MODE_TX ((uint32_t)USART_CR1_TE)
  180. #define SMARTCARD_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
  181. #define IS_SMARTCARD_MODE(MODE) ((((MODE) & (uint32_t)0x0000FFF3) == 0x00) && ((MODE) != (uint32_t)0x00000000))
  182. /**
  183. * @}
  184. */
  185. /** @defgroup SMARTCARD_Clock_Polarity SMARTCARD Clock Polarity
  186. * @{
  187. */
  188. #define SMARTCARD_POLARITY_LOW ((uint32_t)0x00000000)
  189. #define SMARTCARD_POLARITY_HIGH ((uint32_t)USART_CR2_CPOL)
  190. #define IS_SMARTCARD_POLARITY(CPOL) (((CPOL) == SMARTCARD_POLARITY_LOW) || ((CPOL) == SMARTCARD_POLARITY_HIGH))
  191. /**
  192. * @}
  193. */
  194. /** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase
  195. * @{
  196. */
  197. #define SMARTCARD_PHASE_1EDGE ((uint32_t)0x00000000)
  198. #define SMARTCARD_PHASE_2EDGE ((uint32_t)USART_CR2_CPHA)
  199. #define IS_SMARTCARD_PHASE(CPHA) (((CPHA) == SMARTCARD_PHASE_1EDGE) || ((CPHA) == SMARTCARD_PHASE_2EDGE))
  200. /**
  201. * @}
  202. */
  203. /** @defgroup SMARTCARD_Last_Bit SMARTCARD Last Bit
  204. * @{
  205. */
  206. #define SMARTCARD_LASTBIT_DISABLE ((uint32_t)0x00000000)
  207. #define SMARTCARD_LASTBIT_ENABLE ((uint32_t)USART_CR2_LBCL)
  208. #define IS_SMARTCARD_LASTBIT(LASTBIT) (((LASTBIT) == SMARTCARD_LASTBIT_DISABLE) || \
  209. ((LASTBIT) == SMARTCARD_LASTBIT_ENABLE))
  210. /**
  211. * @}
  212. */
  213. /** @defgroup SMARTCARD_NACK_State SMARTCARD NACK State
  214. * @{
  215. */
  216. #define SMARTCARD_NACK_ENABLED ((uint32_t)USART_CR3_NACK)
  217. #define SMARTCARD_NACK_DISABLED ((uint32_t)0x00000000)
  218. #define IS_SMARTCARD_NACK_STATE(NACK) (((NACK) == SMARTCARD_NACK_ENABLED) || \
  219. ((NACK) == SMARTCARD_NACK_DISABLED))
  220. /**
  221. * @}
  222. */
  223. /** @defgroup SMARTCARD_DMA_Requests SMARTCARD DMA requests
  224. * @{
  225. */
  226. #define SMARTCARD_DMAREQ_TX ((uint32_t)USART_CR3_DMAT)
  227. #define SMARTCARD_DMAREQ_RX ((uint32_t)USART_CR3_DMAR)
  228. /**
  229. * @}
  230. */
  231. /** @defgroup SMARTCARD_Flags SMARTCARD Flags
  232. * Elements values convention: 0xXXXX
  233. * - 0xXXXX : Flag mask in the SR register
  234. * @{
  235. */
  236. #define SMARTCARD_FLAG_TXE ((uint32_t)USART_SR_TXE)
  237. #define SMARTCARD_FLAG_TC ((uint32_t)USART_SR_TC)
  238. #define SMARTCARD_FLAG_RXNE ((uint32_t)USART_SR_RXNE)
  239. #define SMARTCARD_FLAG_IDLE ((uint32_t)USART_SR_IDLE)
  240. #define SMARTCARD_FLAG_ORE ((uint32_t)USART_SR_ORE)
  241. #define SMARTCARD_FLAG_NE ((uint32_t)USART_SR_NE)
  242. #define SMARTCARD_FLAG_FE ((uint32_t)USART_SR_FE)
  243. #define SMARTCARD_FLAG_PE ((uint32_t)USART_SR_PE)
  244. /**
  245. * @}
  246. */
  247. /** @defgroup SMARTCARD_Interrupt_definition SMARTCARD Interrupts Definition
  248. * Elements values convention: 0xY000XXXX
  249. * - XXXX : Interrupt mask in the XX register
  250. * - Y : Interrupt source register (4 bits)
  251. * - 01: CR1 register
  252. * - 10: CR3 register
  253. *
  254. * @{
  255. */
  256. #define SMARTCARD_IT_PE ((uint32_t)0x10000100)
  257. #define SMARTCARD_IT_TXE ((uint32_t)0x10000080)
  258. #define SMARTCARD_IT_TC ((uint32_t)0x10000040)
  259. #define SMARTCARD_IT_RXNE ((uint32_t)0x10000020)
  260. #define SMARTCARD_IT_IDLE ((uint32_t)0x10000010)
  261. #define SMARTCARD_IT_ERR ((uint32_t)0x20000001)
  262. /**
  263. * @}
  264. */
  265. /** @defgroup SMARTCARD_Interruption_Mask SMARTCARD interruptions flag mask
  266. * @{
  267. */
  268. #define SMARTCARD_IT_MASK ((uint32_t)0x0000FFFF)
  269. /**
  270. * @}
  271. */
  272. /**
  273. * @}
  274. */
  275. /* Exported macro ------------------------------------------------------------*/
  276. /** @defgroup SMARTCARD_Exported_Macros SMARTCARD Exported Macros
  277. * @{
  278. */
  279. /** @brief Reset SMARTCARD handle state
  280. * @param __HANDLE__: specifies the SMARTCARD Handle.
  281. * This parameter can be USARTx with x: 1, 2 or 3.
  282. * @retval None
  283. */
  284. #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SMARTCARD_STATE_RESET)
  285. /** @brief Flushs the Smartcard DR register
  286. * @param __HANDLE__: specifies the SMARTCARD Handle.
  287. * This parameter can be USARTx with x: 1, 2 or 3.
  288. */
  289. #define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
  290. /** @brief Checks whether the specified Smartcard flag is set or not.
  291. * @param __HANDLE__: specifies the SMARTCARD Handle.
  292. * This parameter can be USARTx with x: 1, 2 or 3.
  293. * @param __FLAG__: specifies the flag to check.
  294. * This parameter can be one of the following values:
  295. * @arg SMARTCARD_FLAG_TXE: Transmit data register empty flag
  296. * @arg SMARTCARD_FLAG_TC: Transmission Complete flag
  297. * @arg SMARTCARD_FLAG_RXNE: Receive data register not empty flag
  298. * @arg SMARTCARD_FLAG_IDLE: Idle Line detection flag
  299. * @arg SMARTCARD_FLAG_ORE: OverRun Error flag
  300. * @arg SMARTCARD_FLAG_NE: Noise Error flag
  301. * @arg SMARTCARD_FLAG_FE: Framing Error flag
  302. * @arg SMARTCARD_FLAG_PE: Parity Error flag
  303. * @retval The new state of __FLAG__ (TRUE or FALSE).
  304. */
  305. #define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
  306. /** @brief Clears the specified Smartcard pending flags.
  307. * @param __HANDLE__: specifies the SMARTCARD Handle.
  308. * This parameter can be USARTx with x: 1, 2 or 3.
  309. * @param __FLAG__: specifies the flag to check.
  310. * This parameter can be any combination of the following values:
  311. * @arg SMARTCARD_FLAG_TC: Transmission Complete flag.
  312. * @arg SMARTCARD_FLAG_RXNE: Receive data register not empty flag.
  313. *
  314. * @note PE (Parity error), FE (Framing error), NE (Noise error) and ORE (OverRun
  315. * error) flags are cleared by software sequence: a read operation to
  316. * USART_SR register followed by a read operation to USART_DR register.
  317. * @note RXNE flag can be also cleared by a read to the USART_DR register.
  318. * @note TC flag can be also cleared by software sequence: a read operation to
  319. * USART_SR register followed by a write operation to USART_DR register.
  320. * @note TXE flag is cleared only by a write to the USART_DR register.
  321. *
  322. * @retval None
  323. */
  324. #define __HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
  325. /** @brief Clear the SMARTCARD PE pending flag.
  326. * @param __HANDLE__: specifies the USART Handle.
  327. * This parameter can be USARTx with x: 1, 2 or 3.
  328. * @retval None
  329. */
  330. #define __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__) do{(__HANDLE__)->Instance->SR;\
  331. (__HANDLE__)->Instance->DR;}while(0)
  332. /** @brief Clear the SMARTCARD FE pending flag.
  333. * @param __HANDLE__: specifies the USART Handle.
  334. * This parameter can be USARTx with x: 1, 2 or 3.
  335. * @retval None
  336. */
  337. #define __HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
  338. /** @brief Clear the SMARTCARD NE pending flag.
  339. * @param __HANDLE__: specifies the USART Handle.
  340. * This parameter can be USARTx with x: 1, 2 or 3.
  341. * @retval None
  342. */
  343. #define __HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
  344. /** @brief Clear the SMARTCARD ORE pending flag.
  345. * @param __HANDLE__: specifies the USART Handle.
  346. * This parameter can be USARTx with x: 1, 2 or 3.
  347. * @retval None
  348. */
  349. #define __HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
  350. /** @brief Clear the SMARTCARD IDLE pending flag.
  351. * @param __HANDLE__: specifies the USART Handle.
  352. * This parameter can be USARTx with x: 1, 2 or 3.
  353. * @retval None
  354. */
  355. #define __HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
  356. /** @brief Enables the specified SmartCard interrupt.
  357. * @param __HANDLE__: specifies the SMARTCARD Handle.
  358. * This parameter can be USARTx with x: 1, 2 or 3.
  359. * @param __INTERRUPT__: specifies the SMARTCARD interrupt to enable.
  360. * This parameter can be one of the following values:
  361. * @arg SMARTCARD_IT_TXE: Transmit Data Register empty interrupt
  362. * @arg SMARTCARD_IT_TC: Transmission complete interrupt
  363. * @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt
  364. * @arg SMARTCARD_IT_IDLE: Idle line detection interrupt
  365. * @arg SMARTCARD_IT_PE: Parity Error interrupt
  366. * @arg SMARTCARD_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
  367. */
  368. #define __HAL_SMARTCARD_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & SMARTCARD_IT_MASK)): \
  369. ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & SMARTCARD_IT_MASK)))
  370. /** @brief Disables the specified SmartCard interrupts.
  371. * @param __HANDLE__: specifies the SMARTCARD Handle.
  372. * This parameter can be USARTx with x: 1, 2 or 3.
  373. * @param __INTERRUPT__: specifies the SMARTCARD interrupt to disable.
  374. * This parameter can be one of the following values:
  375. * @arg SMARTCARD_IT_TXE: Transmit Data Register empty interrupt
  376. * @arg SMARTCARD_IT_TC: Transmission complete interrupt
  377. * @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt
  378. * @arg SMARTCARD_IT_IDLE: Idle line detection interrupt
  379. * @arg SMARTCARD_IT_PE: Parity Error interrupt
  380. * @arg SMARTCARD_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
  381. */
  382. #define __HAL_SMARTCARD_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & SMARTCARD_IT_MASK)): \
  383. ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & SMARTCARD_IT_MASK)))
  384. /** @brief Checks whether the specified SmartCard interrupt has occurred or not.
  385. * @param __HANDLE__: specifies the SMARTCARD Handle.
  386. * This parameter can be USARTx with x: 1, 2 or 3.
  387. * @param __IT__: specifies the SMARTCARD interrupt source to check.
  388. * This parameter can be one of the following values:
  389. * @arg SMARTCARD_IT_TXE: Transmit Data Register empty interrupt
  390. * @arg SMARTCARD_IT_TC: Transmission complete interrupt
  391. * @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt
  392. * @arg SMARTCARD_IT_IDLE: Idle line detection interrupt
  393. * @arg SMARTCARD_IT_ERR: Error interrupt
  394. * @arg SMARTCARD_IT_PE: Parity Error interrupt
  395. * @retval The new state of __IT__ (TRUE or FALSE).
  396. */
  397. #define __HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28) == 1)? (__HANDLE__)->Instance->CR1: (__HANDLE__)->Instance->CR3) & (((uint32_t)(__IT__)) & SMARTCARD_IT_MASK))
  398. /** @brief Enable the USART associated to the SMARTCARD Handle
  399. * @param __HANDLE__: specifies the SMARTCARD Handle.
  400. * This parameter can be USARTx with x: 1, 2 or 3.
  401. * @retval None
  402. */
  403. #define __HAL_SMARTCARD_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR1, USART_CR1_UE))
  404. /** @brief Disable the USART associated to the SMARTCARD Handle
  405. * @param __HANDLE__: specifies the SMARTCARD Handle.
  406. * This parameter can be USARTx with x: 1, 2 or 3.
  407. * @retval None
  408. */
  409. #define __HAL_SMARTCARD_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR1, USART_CR1_UE))
  410. /**
  411. * @}
  412. */
  413. /* Private macros --------------------------------------------------------*/
  414. /** @defgroup SMARTCARD_Private_Macros SMARTCARD Private Macros
  415. * @{
  416. */
  417. /** @brief Macros to enable or disable the SmartCard DMA request.
  418. * @param __HANDLE__: specifies the SmartCard Handle.
  419. * @param __REQUEST__: specifies the SmartCard DMA request.
  420. * This parameter can be one of the following values:
  421. * @arg SMARTCARD_DMAREQ_TX: SmartCard DMA transmit request
  422. * @arg SMARTCARD_DMAREQ_RX: SmartCard DMA receive request
  423. */
  424. #define SMARTCARD_DMA_REQUEST_ENABLE(__HANDLE__, __REQUEST__) (SET_BIT((__HANDLE__)->Instance->CR3, (__REQUEST__)))
  425. #define SMARTCARD_DMA_REQUEST_DISABLE(__HANDLE__, __REQUEST__) (CLEAR_BIT((__HANDLE__)->Instance->CR3, (__REQUEST__)))
  426. #define SMARTCARD_DIV(__PCLK__, __BAUD__) (((__PCLK__)*25)/(4*(__BAUD__)))
  427. #define SMARTCARD_DIVMANT(__PCLK__, __BAUD__) (SMARTCARD_DIV((__PCLK__), (__BAUD__))/100)
  428. #define SMARTCARD_DIVFRAQ(__PCLK__, __BAUD__) (((SMARTCARD_DIV((__PCLK__), (__BAUD__)) - (SMARTCARD_DIVMANT((__PCLK__), (__BAUD__)) * 100)) * 16 + 50) / 100)
  429. #define SMARTCARD_BRR(__PCLK__, __BAUD__) ((SMARTCARD_DIVMANT((__PCLK__), (__BAUD__)) << 4)|(SMARTCARD_DIVFRAQ((__PCLK__), (__BAUD__)) & 0x0F))
  430. /** @brief Check the Baud rate range. The maximum Baud Rate is derived from the
  431. * maximum clock on L1 (i.e. 32 MHz) divided by the oversampling used
  432. * on the SMARTCARD (i.e. 16). No overSampling by 16 on Smartcard.
  433. * @param __BAUDRATE__: Baud rate set by the configuration function.
  434. * @retval Test result (TRUE or FALSE)
  435. */
  436. #define IS_SMARTCARD_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 2000001)
  437. /**
  438. * @}
  439. */
  440. /* Exported functions --------------------------------------------------------*/
  441. /** @addtogroup SMARTCARD_Exported_Functions SMARTCARD Exported Functions
  442. * @{
  443. */
  444. /** @addtogroup SMARTCARD_Exported_Functions_Group1 SmartCard Initialization and de-initialization functions
  445. * @{
  446. */
  447. /* Initialization/de-initialization functions **********************************/
  448. HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsc);
  449. HAL_StatusTypeDef HAL_SMARTCARD_ReInit(SMARTCARD_HandleTypeDef *hsc);
  450. HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsc);
  451. void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsc);
  452. void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsc);
  453. /**
  454. * @}
  455. */
  456. /** @addtogroup SMARTCARD_Exported_Functions_Group2 IO operation functions
  457. * @{
  458. */
  459. /* IO operation functions *******************************************************/
  460. HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  461. HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size, uint32_t Timeout);
  462. HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
  463. HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
  464. HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
  465. HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
  466. void HAL_SMARTCARD_IRQHandler(SMARTCARD_HandleTypeDef *hsc);
  467. void HAL_SMARTCARD_TxCpltCallback(SMARTCARD_HandleTypeDef *hsc);
  468. void HAL_SMARTCARD_RxCpltCallback(SMARTCARD_HandleTypeDef *hsc);
  469. void HAL_SMARTCARD_ErrorCallback(SMARTCARD_HandleTypeDef *hsc);
  470. /**
  471. * @}
  472. */
  473. /** @addtogroup SMARTCARD_Exported_Functions_Group3 Peripheral State and Errors functions
  474. * @{
  475. */
  476. /* Peripheral State and Errors functions functions *****************************/
  477. HAL_SMARTCARD_StateTypeDef HAL_SMARTCARD_GetState(SMARTCARD_HandleTypeDef *hsc);
  478. uint32_t HAL_SMARTCARD_GetError(SMARTCARD_HandleTypeDef *hsc);
  479. /**
  480. * @}
  481. */
  482. /**
  483. * @}
  484. */
  485. /**
  486. * @}
  487. */
  488. /**
  489. * @}
  490. */
  491. #ifdef __cplusplus
  492. }
  493. #endif
  494. #endif /* __STM32L1xx_HAL_SMARTCARD_H */
  495. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/