Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

TARGET_NUCLEO_F401RE/stm32f4xx_hal_smartcard.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
90:cb3d968589d8
Child:
99:dbbf35b96557
dgdgr

Who changed what in which revision?

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