Egor Rumjantsev / mbed

The official mbed C/C SDK provides the software platform and libraries to build your applications.

Fork of mbed by mbed official

TARGET_ARCH_MAX/stm32f4xx_hal_smartcard.h@92:4fc01daae5a5, 2014-11-27 (annotated)

Committer:
bogdanm
Date:
Thu Nov 27 13:33:22 2014 +0000
Revision:
92:4fc01daae5a5
Parent:
89:552587b429a1 
Release 92 of the mbed libray



Main changes:



- nRF51822: fixed pin assignment issues

- ST targets moving to the STM32Cube driver

- LPC1439: fixed serial interrupt issue

- first Cortex-A platform supported in mbed (RZ_A1H)

Who changed what in which revision?

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