]> git.gir.st - tmk_keyboard.git/blob - tmk_core/tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32L1/stm32l1xx_hal_smartcard.h
Merge commit 'f6d56675f9f981c5464f0ca7a1fbb0162154e8c5'
[tmk_keyboard.git] / tmk_core / tool / mbed / mbed-sdk / libraries / mbed / targets / cmsis / TARGET_STM / TARGET_STM32L1 / stm32l1xx_hal_smartcard.h
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
39 /* Define to prevent recursive inclusion -------------------------------------*/
40 #ifndef __STM32L1xx_HAL_SMARTCARD_H
41 #define __STM32L1xx_HAL_SMARTCARD_H
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 /* Includes ------------------------------------------------------------------*/
48 #include "stm32l1xx_hal_def.h"
49
50 /** @addtogroup STM32L1xx_HAL_Driver
51 * @{
52 */
53
54 /** @addtogroup SMARTCARD
55 * @{
56 */
57
58 /* Exported types ------------------------------------------------------------*/
59 /** @defgroup SMARTCARD_Exported_Types SMARTCARD Exported Types
60 * @{
61 */
62
63
64 /**
65 * @brief SMARTCARD Init Structure definition
66 */
67 typedef struct
68 {
69 uint32_t BaudRate; /*!< This member configures the SmartCard communication baud rate.
70 The baud rate is computed using the following formula:
71 - IntegerDivider = ((PCLKx) / (8 * (hsc->Init.BaudRate)))
72 - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 8) + 0.5 */
73
74 uint32_t WordLength; /*!< Specifies the number of data bits transmitted or received in a frame.
75 This parameter can be a value of @ref SMARTCARD_Word_Length */
76
77 uint32_t StopBits; /*!< Specifies the number of stop bits transmitted.
78 This parameter can be a value of @ref SMARTCARD_Stop_Bits */
79
80 uint32_t Parity; /*!< Specifies the parity mode.
81 This parameter can be a value of @ref SMARTCARD_Parity
82 @note When parity is enabled, the computed parity is inserted
83 at the MSB position of the transmitted data (9th bit when
84 the word length is set to 9 data bits; 8th bit when the
85 word length is set to 8 data bits).*/
86
87 uint32_t Mode; /*!< Specifies wether the Receive or Transmit mode is enabled or disabled.
88 This parameter can be a value of @ref SMARTCARD_Mode */
89
90 uint32_t CLKPolarity; /*!< Specifies the steady state of the serial clock.
91 This parameter can be a value of @ref SMARTCARD_Clock_Polarity */
92
93 uint32_t CLKPhase; /*!< Specifies the clock transition on which the bit capture is made.
94 This parameter can be a value of @ref SMARTCARD_Clock_Phase */
95
96 uint32_t CLKLastBit; /*!< Specifies whether the clock pulse corresponding to the last transmitted
97 data bit (MSB) has to be output on the SCLK pin in synchronous mode.
98 This parameter can be a value of @ref SMARTCARD_Last_Bit */
99
100 uint32_t Prescaler; /*!< Specifies the SmartCard Prescaler
101 This parameter must be a number between Min_Data = 0 and Max_Data = 255 */
102
103 uint32_t GuardTime; /*!< Specifies the SmartCard Guard Time
104 This parameter must be a number between Min_Data = 0 and Max_Data = 255 */
105
106 uint32_t NACKState; /*!< Specifies the SmartCard NACK Transmission state
107 This parameter can be a value of @ref SMARTCARD_NACK_State */
108 }SMARTCARD_InitTypeDef;
109
110 /**
111 * @brief HAL State structures definition
112 */
113 typedef enum
114 {
115 HAL_SMARTCARD_STATE_RESET = 0x00, /*!< Peripheral is not yet Initialized */
116 HAL_SMARTCARD_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
117 HAL_SMARTCARD_STATE_BUSY = 0x02, /*!< an internal process is ongoing */
118 HAL_SMARTCARD_STATE_BUSY_TX = 0x12, /*!< Data Transmission process is ongoing */
119 HAL_SMARTCARD_STATE_BUSY_RX = 0x22, /*!< Data Reception process is ongoing */
120 HAL_SMARTCARD_STATE_BUSY_TX_RX = 0x32, /*!< Data Transmission and Reception process is ongoing */
121 HAL_SMARTCARD_STATE_TIMEOUT = 0x03, /*!< Timeout state */
122 HAL_SMARTCARD_STATE_ERROR = 0x04 /*!< Error */
123 }HAL_SMARTCARD_StateTypeDef;
124
125 /**
126 * @brief HAL SMARTCARD Error Code structure definition
127 */
128 typedef enum
129 {
130 HAL_SMARTCARD_ERROR_NONE = 0x00, /*!< No error */
131 HAL_SMARTCARD_ERROR_PE = 0x01, /*!< Parity error */
132 HAL_SMARTCARD_ERROR_NE = 0x02, /*!< Noise error */
133 HAL_SMARTCARD_ERROR_FE = 0x04, /*!< frame error */
134 HAL_SMARTCARD_ERROR_ORE = 0x08, /*!< Overrun error */
135 HAL_SMARTCARD_ERROR_DMA = 0x10 /*!< DMA transfer error */
136 }HAL_SMARTCARD_ErrorTypeDef;
137
138 /**
139 * @brief SMARTCARD handle Structure definition
140 */
141 typedef struct
142 {
143 USART_TypeDef *Instance; /* USART registers base address */
144
145 SMARTCARD_InitTypeDef Init; /* SmartCard communication parameters */
146
147 uint8_t *pTxBuffPtr; /* Pointer to SmartCard Tx transfer Buffer */
148
149 uint16_t TxXferSize; /* SmartCard Tx Transfer size */
150
151 uint16_t TxXferCount; /* SmartCard Tx Transfer Counter */
152
153 uint8_t *pRxBuffPtr; /* Pointer to SmartCard Rx transfer Buffer */
154
155 uint16_t RxXferSize; /* SmartCard Rx Transfer size */
156
157 uint16_t RxXferCount; /* SmartCard Rx Transfer Counter */
158
159 DMA_HandleTypeDef *hdmatx; /* SmartCard Tx DMA Handle parameters */
160
161 DMA_HandleTypeDef *hdmarx; /* SmartCard Rx DMA Handle parameters */
162
163 HAL_LockTypeDef Lock; /* Locking object */
164
165 __IO HAL_SMARTCARD_StateTypeDef State; /* SmartCard communication state */
166
167 __IO HAL_SMARTCARD_ErrorTypeDef ErrorCode; /* SmartCard Error code */
168 }SMARTCARD_HandleTypeDef;
169
170 /**
171 * @}
172 */
173
174 /* Exported constants --------------------------------------------------------*/
175 /** @defgroup SMARTCARD_Exported_Constants SMARTCARD Exported constants
176 * @{
177 */
178
179 /** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length
180 * @{
181 */
182 #define SMARTCARD_WORDLENGTH_8B ((uint32_t)0x00000000)
183 #define SMARTCARD_WORDLENGTH_9B ((uint32_t)USART_CR1_M)
184 #define IS_SMARTCARD_WORD_LENGTH(LENGTH) ((LENGTH) == SMARTCARD_WORDLENGTH_9B)
185 /**
186 * @}
187 */
188
189 /** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits
190 * @{
191 */
192 #define SMARTCARD_STOPBITS_1 ((uint32_t)0x00000000)
193 #define SMARTCARD_STOPBITS_0_5 ((uint32_t)USART_CR2_STOP_0)
194 #define SMARTCARD_STOPBITS_2 ((uint32_t)USART_CR2_STOP_1)
195 #define SMARTCARD_STOPBITS_1_5 ((uint32_t)(USART_CR2_STOP_0 | USART_CR2_STOP_1))
196 #define IS_SMARTCARD_STOPBITS(STOPBITS) (((STOPBITS) == SMARTCARD_STOPBITS_0_5) || \
197 ((STOPBITS) == SMARTCARD_STOPBITS_1_5))
198 /**
199 * @}
200 */
201
202 /** @defgroup SMARTCARD_Parity SMARTCARD Parity
203 * @{
204 */
205 #define SMARTCARD_PARITY_NONE ((uint32_t)0x00000000)
206 #define SMARTCARD_PARITY_EVEN ((uint32_t)USART_CR1_PCE)
207 #define SMARTCARD_PARITY_ODD ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
208 #define IS_SMARTCARD_PARITY(PARITY) (((PARITY) == SMARTCARD_PARITY_EVEN) || \
209 ((PARITY) == SMARTCARD_PARITY_ODD))
210 /**
211 * @}
212 */
213
214 /** @defgroup SMARTCARD_Mode SMARTCARD Mode
215 * @{
216 */
217 #define SMARTCARD_MODE_RX ((uint32_t)USART_CR1_RE)
218 #define SMARTCARD_MODE_TX ((uint32_t)USART_CR1_TE)
219 #define SMARTCARD_MODE_TX_RX ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
220 #define IS_SMARTCARD_MODE(MODE) ((((MODE) & (uint32_t)0x0000FFF3) == 0x00) && ((MODE) != (uint32_t)0x00000000))
221 /**
222 * @}
223 */
224
225 /** @defgroup SMARTCARD_Clock_Polarity SMARTCARD Clock Polarity
226 * @{
227 */
228 #define SMARTCARD_POLARITY_LOW ((uint32_t)0x00000000)
229 #define SMARTCARD_POLARITY_HIGH ((uint32_t)USART_CR2_CPOL)
230 #define IS_SMARTCARD_POLARITY(CPOL) (((CPOL) == SMARTCARD_POLARITY_LOW) || ((CPOL) == SMARTCARD_POLARITY_HIGH))
231 /**
232 * @}
233 */
234
235 /** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase
236 * @{
237 */
238 #define SMARTCARD_PHASE_1EDGE ((uint32_t)0x00000000)
239 #define SMARTCARD_PHASE_2EDGE ((uint32_t)USART_CR2_CPHA)
240 #define IS_SMARTCARD_PHASE(CPHA) (((CPHA) == SMARTCARD_PHASE_1EDGE) || ((CPHA) == SMARTCARD_PHASE_2EDGE))
241 /**
242 * @}
243 */
244
245 /** @defgroup SMARTCARD_Last_Bit SMARTCARD Last Bit
246 * @{
247 */
248 #define SMARTCARD_LASTBIT_DISABLE ((uint32_t)0x00000000)
249 #define SMARTCARD_LASTBIT_ENABLE ((uint32_t)USART_CR2_LBCL)
250 #define IS_SMARTCARD_LASTBIT(LASTBIT) (((LASTBIT) == SMARTCARD_LASTBIT_DISABLE) || \
251 ((LASTBIT) == SMARTCARD_LASTBIT_ENABLE))
252 /**
253 * @}
254 */
255
256 /** @defgroup SMARTCARD_NACK_State SMARTCARD NACK State
257 * @{
258 */
259 #define SMARTCARD_NACK_ENABLED ((uint32_t)USART_CR3_NACK)
260 #define SMARTCARD_NACK_DISABLED ((uint32_t)0x00000000)
261 #define IS_SMARTCARD_NACK_STATE(NACK) (((NACK) == SMARTCARD_NACK_ENABLED) || \
262 ((NACK) == SMARTCARD_NACK_DISABLED))
263 /**
264 * @}
265 */
266
267 /** @defgroup SMARTCARD_DMA_Requests SMARTCARD DMA requests
268 * @{
269 */
270
271 #define SMARTCARD_DMAREQ_TX ((uint32_t)USART_CR3_DMAT)
272 #define SMARTCARD_DMAREQ_RX ((uint32_t)USART_CR3_DMAR)
273
274 /**
275 * @}
276 */
277
278 /** @defgroup SMARTCARD_Flags SMARTCARD Flags
279 * Elements values convention: 0xXXXX
280 * - 0xXXXX : Flag mask in the SR register
281 * @{
282 */
283
284 #define SMARTCARD_FLAG_TXE ((uint32_t)USART_SR_TXE)
285 #define SMARTCARD_FLAG_TC ((uint32_t)USART_SR_TC)
286 #define SMARTCARD_FLAG_RXNE ((uint32_t)USART_SR_RXNE)
287 #define SMARTCARD_FLAG_IDLE ((uint32_t)USART_SR_IDLE)
288 #define SMARTCARD_FLAG_ORE ((uint32_t)USART_SR_ORE)
289 #define SMARTCARD_FLAG_NE ((uint32_t)USART_SR_NE)
290 #define SMARTCARD_FLAG_FE ((uint32_t)USART_SR_FE)
291 #define SMARTCARD_FLAG_PE ((uint32_t)USART_SR_PE)
292 /**
293 * @}
294 */
295
296 /** @defgroup SMARTCARD_Interrupt_definition SMARTCARD Interrupts Definition
297 * Elements values convention: 0xY000XXXX
298 * - XXXX : Interrupt mask in the XX register
299 * - Y : Interrupt source register (4 bits)
300 * - 01: CR1 register
301 * - 10: CR3 register
302
303 *
304 * @{
305 */
306 #define SMARTCARD_IT_PE ((uint32_t)0x10000100)
307 #define SMARTCARD_IT_TXE ((uint32_t)0x10000080)
308 #define SMARTCARD_IT_TC ((uint32_t)0x10000040)
309 #define SMARTCARD_IT_RXNE ((uint32_t)0x10000020)
310 #define SMARTCARD_IT_IDLE ((uint32_t)0x10000010)
311 #define SMARTCARD_IT_ERR ((uint32_t)0x20000001)
312
313 /**
314 * @}
315 */
316
317 /** @defgroup SMARTCARD_Interruption_Mask SMARTCARD interruptions flag mask
318 * @{
319 */
320 #define SMARTCARD_IT_MASK ((uint32_t)0x0000FFFF)
321 /**
322 * @}
323 */
324
325 /**
326 * @}
327 */
328
329 /* Exported macro ------------------------------------------------------------*/
330 /** @defgroup SMARTCARD_Exported_Macros SMARTCARD Exported Macros
331 * @{
332 */
333
334
335 /** @brief Reset SMARTCARD handle state
336 * @param __HANDLE__: specifies the SMARTCARD Handle.
337 * This parameter can be USARTx with x: 1, 2 or 3.
338 * @retval None
339 */
340 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SMARTCARD_STATE_RESET)
341
342 /** @brief Flushs the Smartcard DR register
343 * @param __HANDLE__: specifies the SMARTCARD Handle.
344 * This parameter can be USARTx with x: 1, 2 or 3.
345 */
346 #define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
347
348 /** @brief Checks whether the specified Smartcard flag is set or not.
349 * @param __HANDLE__: specifies the SMARTCARD Handle.
350 * This parameter can be USARTx with x: 1, 2 or 3.
351 * @param __FLAG__: specifies the flag to check.
352 * This parameter can be one of the following values:
353 * @arg SMARTCARD_FLAG_TXE: Transmit data register empty flag
354 * @arg SMARTCARD_FLAG_TC: Transmission Complete flag
355 * @arg SMARTCARD_FLAG_RXNE: Receive data register not empty flag
356 * @arg SMARTCARD_FLAG_IDLE: Idle Line detection flag
357 * @arg SMARTCARD_FLAG_ORE: OverRun Error flag
358 * @arg SMARTCARD_FLAG_NE: Noise Error flag
359 * @arg SMARTCARD_FLAG_FE: Framing Error flag
360 * @arg SMARTCARD_FLAG_PE: Parity Error flag
361 * @retval The new state of __FLAG__ (TRUE or FALSE).
362 */
363 #define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
364
365 /** @brief Clears the specified Smartcard pending flags.
366 * @param __HANDLE__: specifies the SMARTCARD Handle.
367 * This parameter can be USARTx with x: 1, 2 or 3.
368 * @param __FLAG__: specifies the flag to check.
369 * This parameter can be any combination of the following values:
370 * @arg SMARTCARD_FLAG_TC: Transmission Complete flag.
371 * @arg SMARTCARD_FLAG_RXNE: Receive data register not empty flag.
372 *
373 * @note PE (Parity error), FE (Framing error), NE (Noise error) and ORE (OverRun
374 * error) flags are cleared by software sequence: a read operation to
375 * USART_SR register followed by a read operation to USART_DR register.
376 * @note RXNE flag can be also cleared by a read to the USART_DR register.
377 * @note TC flag can be also cleared by software sequence: a read operation to
378 * USART_SR register followed by a write operation to USART_DR register.
379 * @note TXE flag is cleared only by a write to the USART_DR register.
380 *
381 * @retval None
382 */
383 #define __HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
384
385 /** @brief Clear the SMARTCARD PE pending flag.
386 * @param __HANDLE__: specifies the USART Handle.
387 * This parameter can be USARTx with x: 1, 2 or 3.
388 * @retval None
389 */
390 #define __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__) do{(__HANDLE__)->Instance->SR;\
391 (__HANDLE__)->Instance->DR;}while(0)
392 /** @brief Clear the SMARTCARD FE pending flag.
393 * @param __HANDLE__: specifies the USART Handle.
394 * This parameter can be USARTx with x: 1, 2 or 3.
395 * @retval None
396 */
397 #define __HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
398
399 /** @brief Clear the SMARTCARD NE pending flag.
400 * @param __HANDLE__: specifies the USART Handle.
401 * This parameter can be USARTx with x: 1, 2 or 3.
402 * @retval None
403 */
404 #define __HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
405
406 /** @brief Clear the SMARTCARD ORE pending flag.
407 * @param __HANDLE__: specifies the USART Handle.
408 * This parameter can be USARTx with x: 1, 2 or 3.
409 * @retval None
410 */
411 #define __HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
412
413 /** @brief Clear the SMARTCARD IDLE pending flag.
414 * @param __HANDLE__: specifies the USART Handle.
415 * This parameter can be USARTx with x: 1, 2 or 3.
416 * @retval None
417 */
418 #define __HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
419
420 /** @brief Enables the specified SmartCard interrupt.
421 * @param __HANDLE__: specifies the SMARTCARD Handle.
422 * This parameter can be USARTx with x: 1, 2 or 3.
423 * @param __INTERRUPT__: specifies the SMARTCARD interrupt to enable.
424 * This parameter can be one of the following values:
425 * @arg SMARTCARD_IT_TXE: Transmit Data Register empty interrupt
426 * @arg SMARTCARD_IT_TC: Transmission complete interrupt
427 * @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt
428 * @arg SMARTCARD_IT_IDLE: Idle line detection interrupt
429 * @arg SMARTCARD_IT_PE: Parity Error interrupt
430 * @arg SMARTCARD_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
431 */
432 #define __HAL_SMARTCARD_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & SMARTCARD_IT_MASK)): \
433 ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & SMARTCARD_IT_MASK)))
434
435 /** @brief Disables the specified SmartCard interrupts.
436 * @param __HANDLE__: specifies the SMARTCARD Handle.
437 * This parameter can be USARTx with x: 1, 2 or 3.
438 * @param __INTERRUPT__: specifies the SMARTCARD interrupt to disable.
439 * This parameter can be one of the following values:
440 * @arg SMARTCARD_IT_TXE: Transmit Data Register empty interrupt
441 * @arg SMARTCARD_IT_TC: Transmission complete interrupt
442 * @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt
443 * @arg SMARTCARD_IT_IDLE: Idle line detection interrupt
444 * @arg SMARTCARD_IT_PE: Parity Error interrupt
445 * @arg SMARTCARD_IT_ERR: Error interrupt(Frame error, noise error, overrun error)
446 */
447 #define __HAL_SMARTCARD_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((((__INTERRUPT__) >> 28) == 1)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & SMARTCARD_IT_MASK)): \
448 ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & SMARTCARD_IT_MASK)))
449
450 /** @brief Checks whether the specified SmartCard interrupt has occurred or not.
451 * @param __HANDLE__: specifies the SMARTCARD Handle.
452 * This parameter can be USARTx with x: 1, 2 or 3.
453 * @param __IT__: specifies the SMARTCARD interrupt source to check.
454 * This parameter can be one of the following values:
455 * @arg SMARTCARD_IT_TXE: Transmit Data Register empty interrupt
456 * @arg SMARTCARD_IT_TC: Transmission complete interrupt
457 * @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt
458 * @arg SMARTCARD_IT_IDLE: Idle line detection interrupt
459 * @arg SMARTCARD_IT_ERR: Error interrupt
460 * @arg SMARTCARD_IT_PE: Parity Error interrupt
461 * @retval The new state of __IT__ (TRUE or FALSE).
462 */
463 #define __HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28) == 1)? (__HANDLE__)->Instance->CR1: (__HANDLE__)->Instance->CR3) & (((uint32_t)(__IT__)) & SMARTCARD_IT_MASK))
464
465 /** @brief Enable the USART associated to the SMARTCARD Handle
466 * @param __HANDLE__: specifies the SMARTCARD Handle.
467 * This parameter can be USARTx with x: 1, 2 or 3.
468 * @retval None
469 */
470 #define __HAL_SMARTCARD_ENABLE(__HANDLE__) (SET_BIT((__HANDLE__)->Instance->CR1, USART_CR1_UE))
471
472 /** @brief Disable the USART associated to the SMARTCARD Handle
473 * @param __HANDLE__: specifies the SMARTCARD Handle.
474 * This parameter can be USARTx with x: 1, 2 or 3.
475 * @retval None
476 */
477 #define __HAL_SMARTCARD_DISABLE(__HANDLE__) (CLEAR_BIT((__HANDLE__)->Instance->CR1, USART_CR1_UE))
478
479
480 /**
481 * @}
482 */
483
484 /* Private macros --------------------------------------------------------*/
485 /** @defgroup SMARTCARD_Private_Macros SMARTCARD Private Macros
486 * @{
487 */
488
489 /** @brief Macros to enable or disable the SmartCard DMA request.
490 * @param __HANDLE__: specifies the SmartCard Handle.
491 * @param __REQUEST__: specifies the SmartCard DMA request.
492 * This parameter can be one of the following values:
493 * @arg SMARTCARD_DMAREQ_TX: SmartCard DMA transmit request
494 * @arg SMARTCARD_DMAREQ_RX: SmartCard DMA receive request
495 */
496 #define SMARTCARD_DMA_REQUEST_ENABLE(__HANDLE__, __REQUEST__) (SET_BIT((__HANDLE__)->Instance->CR3, (__REQUEST__)))
497 #define SMARTCARD_DMA_REQUEST_DISABLE(__HANDLE__, __REQUEST__) (CLEAR_BIT((__HANDLE__)->Instance->CR3, (__REQUEST__)))
498
499 #define SMARTCARD_DIV(__PCLK__, __BAUD__) (((__PCLK__)*25)/(4*(__BAUD__)))
500 #define SMARTCARD_DIVMANT(__PCLK__, __BAUD__) (SMARTCARD_DIV((__PCLK__), (__BAUD__))/100)
501 #define SMARTCARD_DIVFRAQ(__PCLK__, __BAUD__) (((SMARTCARD_DIV((__PCLK__), (__BAUD__)) - (SMARTCARD_DIVMANT((__PCLK__), (__BAUD__)) * 100)) * 16 + 50) / 100)
502 #define SMARTCARD_BRR(__PCLK__, __BAUD__) ((SMARTCARD_DIVMANT((__PCLK__), (__BAUD__)) << 4)|(SMARTCARD_DIVFRAQ((__PCLK__), (__BAUD__)) & 0x0F))
503
504 /** @brief Check the Baud rate range. The maximum Baud Rate is derived from the
505 * maximum clock on L1 (i.e. 32 MHz) divided by the oversampling used
506 * on the SMARTCARD (i.e. 16). No overSampling by 16 on Smartcard.
507 * @param __BAUDRATE__: Baud rate set by the configuration function.
508 * @retval Test result (TRUE or FALSE)
509 */
510 #define IS_SMARTCARD_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 2000001)
511 /**
512 * @}
513 */
514
515
516 /* Exported functions --------------------------------------------------------*/
517
518 /** @addtogroup SMARTCARD_Exported_Functions SMARTCARD Exported Functions
519 * @{
520 */
521
522 /** @addtogroup SMARTCARD_Exported_Functions_Group1 SmartCard Initialization and de-initialization functions
523 * @{
524 */
525
526 /* Initialization/de-initialization functions **********************************/
527 HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsc);
528 HAL_StatusTypeDef HAL_SMARTCARD_ReInit(SMARTCARD_HandleTypeDef *hsc);
529 HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsc);
530 void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsc);
531 void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsc);
532
533 /**
534 * @}
535 */
536
537 /** @addtogroup SMARTCARD_Exported_Functions_Group2 IO operation functions
538 * @{
539 */
540
541 /* IO operation functions *******************************************************/
542 HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size, uint32_t Timeout);
543 HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size, uint32_t Timeout);
544 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
545 HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
546 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
547 HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
548 void HAL_SMARTCARD_IRQHandler(SMARTCARD_HandleTypeDef *hsc);
549 void HAL_SMARTCARD_TxCpltCallback(SMARTCARD_HandleTypeDef *hsc);
550 void HAL_SMARTCARD_RxCpltCallback(SMARTCARD_HandleTypeDef *hsc);
551 void HAL_SMARTCARD_ErrorCallback(SMARTCARD_HandleTypeDef *hsc);
552
553 /**
554 * @}
555 */
556
557 /** @addtogroup SMARTCARD_Exported_Functions_Group3 Peripheral State and Errors functions
558 * @{
559 */
560
561 /* Peripheral State and Errors functions functions *****************************/
562 HAL_SMARTCARD_StateTypeDef HAL_SMARTCARD_GetState(SMARTCARD_HandleTypeDef *hsc);
563 uint32_t HAL_SMARTCARD_GetError(SMARTCARD_HandleTypeDef *hsc);
564
565 /**
566 * @}
567 */
568
569 /**
570 * @}
571 */
572
573 /**
574 * @}
575 */
576
577 /**
578 * @}
579 */
580
581 #ifdef __cplusplus
582 }
583 #endif
584
585 #endif /* __STM32L1xx_HAL_SMARTCARD_H */
586
587 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
Imprint / Impressum