tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F1/stm32f1xx_hal_smartcard.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f1xx_hal_smartcard.h
   4   * @author  MCD Application Team
   5   * @version V1.0.0
   6   * @date    15-December-2014
   7   * @brief   Header file of SMARTCARD HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  12   *
  13   * Redistribution and use in source and binary forms, with or without modification,
  14   * are permitted provided that the following conditions are met:
  15   *   1. Redistributions of source code must retain the above copyright notice,
  16   *      this list of conditions and the following disclaimer.
  17   *   2. Redistributions in binary form must reproduce the above copyright notice,
  18   *      this list of conditions and the following disclaimer in the documentation
  19   *      and/or other materials provided with the distribution.
  20   *   3. Neither the name of STMicroelectronics nor the names of its contributors
  21   *      may be used to endorse or promote products derived from this software
  22   *      without specific prior written permission.
  23   *
  24   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  25   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  28   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  30   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  31   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  32   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34   *
  35   ******************************************************************************
  36   */
  37
  38 /* Define to prevent recursive inclusion -------------------------------------*/
  39 #ifndef __STM32F1xx_HAL_SMARTCARD_H
  40 #define __STM32F1xx_HAL_SMARTCARD_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f1xx_hal_def.h"
  48
  49 /** @addtogroup STM32F1xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup SMARTCARD
  54   * @{
  55   */
  56
  57 /* Exported types ------------------------------------------------------------*/
  58 /** @defgroup SMARTCARD_Exported_Types SMARTCARD Exported Types
  59   * @{
  60   */
  61
  62
  63 /**
  64   * @brief SMARTCARD Init Structure definition
  65   */
  66 typedef struct
  67 {
  68   uint32_t BaudRate;                  /*!< This member configures the SmartCard communication baud rate.
  69                                            The baud rate is computed using the following formula:
  70                                            - IntegerDivider = ((PCLKx) / (16 * (hsmartcard->Init.BaudRate)))
  71                                            - FractionalDivider = ((IntegerDivider - ((uint32_t) IntegerDivider)) * 16) + 0.5 */
  72
  73   uint32_t WordLength;                /*!< Specifies the number of data bits transmitted or received in a frame.
  74                                            This parameter can be a value of @ref SMARTCARD_Word_Length */
  75
  76   uint32_t StopBits;                  /*!< Specifies the number of stop bits transmitted.
  77                                            This parameter can be a value of @ref SMARTCARD_Stop_Bits */
  78
  79   uint32_t Parity;                    /*!< Specifies the parity mode.
  80                                            This parameter can be a value of @ref SMARTCARD_Parity
  81                                            @note When parity is enabled, the computed parity is inserted
  82                                                  at the MSB position of the transmitted data (9th bit when
  83                                                  the word length is set to 9 data bits; 8th bit when the
  84                                                  word length is set to 8 data bits).*/
  85
  86   uint32_t Mode;                      /*!< Specifies whether the Receive or Transmit mode is enabled or disabled.
  87                                            This parameter can be a value of @ref SMARTCARD_Mode */
  88
  89   uint32_t CLKPolarity;               /*!< Specifies the steady state of the serial clock.
  90                                            This parameter can be a value of @ref SMARTCARD_Clock_Polarity */
  91
  92   uint32_t CLKPhase;                  /*!< Specifies the clock transition on which the bit capture is made.
  93                                            This parameter can be a value of @ref SMARTCARD_Clock_Phase */
  94
  95   uint32_t CLKLastBit;                /*!< Specifies whether the clock pulse corresponding to the last transmitted
  96                                            data bit (MSB) has to be output on the SCLK pin in synchronous mode.
  97                                            This parameter can be a value of @ref SMARTCARD_Last_Bit */
  98
  99   uint32_t Prescaler;                 /*!< Specifies the SmartCard Prescaler value used for dividing the system clock
 100                                            to provide the smartcard clock
 101                                            This parameter can be a value of @ref SMARTCARD_Prescaler */
 102
 103   uint32_t GuardTime;                 /*!< Specifies the SmartCard Guard Time value in terms of number of baud clocks
 104                                            The value given in the register (5 significant bits) is multiplied by 2
 105                                            to give the division factor of the source clock frequency */
 106
 107   uint32_t NACKState;                 /*!< Specifies the SmartCard NACK Transmission state
 108                                            This parameter can be a value of @ref SMARTCARD_NACK_State */
 109 }SMARTCARD_InitTypeDef;
 110
 111 /**
 112   * @brief HAL State structures definition
 113   */
 114 typedef enum
 115 {
 116   HAL_SMARTCARD_STATE_RESET             = 0x00,    /*!< Peripheral is not yet Initialized */
 117   HAL_SMARTCARD_STATE_READY             = 0x01,    /*!< Peripheral Initialized and ready for use */
 118   HAL_SMARTCARD_STATE_BUSY              = 0x02,    /*!< an internal process is ongoing */
 119   HAL_SMARTCARD_STATE_BUSY_TX           = 0x12,    /*!< Data Transmission process is ongoing */
 120   HAL_SMARTCARD_STATE_BUSY_RX           = 0x22,    /*!< Data Reception process is ongoing */
 121   HAL_SMARTCARD_STATE_BUSY_TX_RX        = 0x32,    /*!< Data Transmission and Reception process is ongoing */
 122   HAL_SMARTCARD_STATE_TIMEOUT           = 0x03,    /*!< Timeout state */
 123   HAL_SMARTCARD_STATE_ERROR             = 0x04     /*!< Error */
 124 }HAL_SMARTCARD_StateTypeDef;
 125
 126
 127 /**
 128   * @brief  SMARTCARD handle Structure definition
 129   */
 130 typedef struct
 131 {
 132   USART_TypeDef                    *Instance;        /*!< USART registers base address */
 133
 134   SMARTCARD_InitTypeDef            Init;             /*!< SmartCard communication parameters */
 135
 136   uint8_t                          *pTxBuffPtr;      /*!< Pointer to SmartCard Tx transfer Buffer */
 137
 138   uint16_t                         TxXferSize;       /*!< SmartCard Tx Transfer size */
 139
 140   uint16_t                         TxXferCount;      /*!< SmartCard Tx Transfer Counter */
 141
 142   uint8_t                          *pRxBuffPtr;      /*!< Pointer to SmartCard Rx transfer Buffer */
 143
 144   uint16_t                         RxXferSize;       /*!< SmartCard Rx Transfer size */
 145
 146   uint16_t                         RxXferCount;      /*!< SmartCard Rx Transfer Counter */
 147
 148   DMA_HandleTypeDef                *hdmatx;          /*!< SmartCard Tx DMA Handle parameters */
 149
 150   DMA_HandleTypeDef                *hdmarx;          /*!< SmartCard Rx DMA Handle parameters */
 151
 152   HAL_LockTypeDef                  Lock;             /*!< Locking object */
 153
 154   __IO HAL_SMARTCARD_StateTypeDef  State;            /*!< SmartCard communication state */
 155
 156   __IO uint32_t  ErrorCode;        /*!< SmartCard Error code */
 157 }SMARTCARD_HandleTypeDef;
 158
 159 /**
 160   * @}
 161   */
 162
 163 /* Exported constants --------------------------------------------------------*/
 164 /** @defgroup SMARTCARD_Exported_Constants  SMARTCARD Exported constants
 165   * @{
 166   */
 167
 168 /** @defgroup SMARTCARD_Error_Codes SMARTCARD Error Codes
 169   * @{
 170   */
 171 #define HAL_SMARTCARD_ERROR_NONE      ((uint32_t)0x00)    /*!< No error            */
 172 #define HAL_SMARTCARD_ERROR_PE        ((uint32_t)0x01)    /*!< Parity error        */
 173 #define HAL_SMARTCARD_ERROR_NE        ((uint32_t)0x02)    /*!< Noise error         */
 174 #define HAL_SMARTCARD_ERROR_FE        ((uint32_t)0x04)    /*!< frame error         */
 175 #define HAL_SMARTCARD_ERROR_ORE       ((uint32_t)0x08)    /*!< Overrun error       */
 176 #define HAL_SMARTCARD_ERROR_DMA       ((uint32_t)0x10)     /*!< DMA transfer error  */
 177
 178 /**
 179   * @}
 180   */
 181
 182
 183 /** @defgroup SMARTCARD_Word_Length SMARTCARD Word Length
 184   * @{
 185   */
 186 #define SMARTCARD_WORDLENGTH_9B                  ((uint32_t)USART_CR1_M)
 187
 188 /**
 189   * @}
 190   */
 191
 192 /** @defgroup SMARTCARD_Stop_Bits SMARTCARD Number of Stop Bits
 193   * @{
 194   */
 195 #define SMARTCARD_STOPBITS_0_5                   ((uint32_t)USART_CR2_STOP_0)
 196 #define SMARTCARD_STOPBITS_1_5                   ((uint32_t)(USART_CR2_STOP_0 | USART_CR2_STOP_1))
 197 /**
 198   * @}
 199   */
 200
 201 /** @defgroup SMARTCARD_Parity SMARTCARD Parity
 202   * @{
 203   */
 204 #define SMARTCARD_PARITY_EVEN                    ((uint32_t)USART_CR1_PCE)
 205 #define SMARTCARD_PARITY_ODD                     ((uint32_t)(USART_CR1_PCE | USART_CR1_PS))
 206 /**
 207   * @}
 208   */
 209
 210 /** @defgroup SMARTCARD_Mode SMARTCARD Mode
 211   * @{
 212   */
 213 #define SMARTCARD_MODE_RX                        ((uint32_t)USART_CR1_RE)
 214 #define SMARTCARD_MODE_TX                        ((uint32_t)USART_CR1_TE)
 215 #define SMARTCARD_MODE_TX_RX                     ((uint32_t)(USART_CR1_TE |USART_CR1_RE))
 216 /**
 217   * @}
 218   */
 219
 220 /** @defgroup SMARTCARD_Clock_Polarity  SMARTCARD Clock Polarity
 221   * @{
 222   */
 223 #define SMARTCARD_POLARITY_LOW                   ((uint32_t)0x00000000)
 224 #define SMARTCARD_POLARITY_HIGH                  ((uint32_t)USART_CR2_CPOL)
 225 /**
 226   * @}
 227   */
 228
 229 /** @defgroup SMARTCARD_Clock_Phase SMARTCARD Clock Phase
 230   * @{
 231   */
 232 #define SMARTCARD_PHASE_1EDGE                    ((uint32_t)0x00000000)
 233 #define SMARTCARD_PHASE_2EDGE                    ((uint32_t)USART_CR2_CPHA)
 234 /**
 235   * @}
 236   */
 237
 238 /** @defgroup SMARTCARD_Last_Bit  SMARTCARD Last Bit
 239   * @{
 240   */
 241 #define SMARTCARD_LASTBIT_DISABLE                ((uint32_t)0x00000000)
 242 #define SMARTCARD_LASTBIT_ENABLE                 ((uint32_t)USART_CR2_LBCL)
 243 /**
 244   * @}
 245   */
 246
 247 /** @defgroup SMARTCARD_NACK_State   SMARTCARD NACK State
 248   * @{
 249   */
 250 #define SMARTCARD_NACK_ENABLE                    ((uint32_t)USART_CR3_NACK)
 251 #define SMARTCARD_NACK_DISABLE                   ((uint32_t)0x00000000)
 252 /**
 253   * @}
 254   */
 255
 256 /** @defgroup SMARTCARD_DMA_Requests SMARTCARD DMA requests
 257   * @{
 258   */
 259
 260 #define SMARTCARD_DMAREQ_TX                      ((uint32_t)USART_CR3_DMAT)
 261 #define SMARTCARD_DMAREQ_RX                      ((uint32_t)USART_CR3_DMAR)
 262
 263 /**
 264   * @}
 265   */
 266
 267 /** @defgroup SMARTCARD_Prescaler SMARTCARD Prescaler
 268   * @{
 269   */
 270 #define SMARTCARD_PRESCALER_SYSCLK_DIV2         ((uint32_t)0x00000001)          /*!< SYSCLK divided by 2 */
 271 #define SMARTCARD_PRESCALER_SYSCLK_DIV4         ((uint32_t)0x00000002)          /*!< SYSCLK divided by 4 */
 272 #define SMARTCARD_PRESCALER_SYSCLK_DIV6         ((uint32_t)0x00000003)          /*!< SYSCLK divided by 6 */
 273 #define SMARTCARD_PRESCALER_SYSCLK_DIV8         ((uint32_t)0x00000004)          /*!< SYSCLK divided by 8 */
 274 #define SMARTCARD_PRESCALER_SYSCLK_DIV10        ((uint32_t)0x00000005)          /*!< SYSCLK divided by 10 */
 275 #define SMARTCARD_PRESCALER_SYSCLK_DIV12        ((uint32_t)0x00000006)          /*!< SYSCLK divided by 12 */
 276 #define SMARTCARD_PRESCALER_SYSCLK_DIV14        ((uint32_t)0x00000007)          /*!< SYSCLK divided by 14 */
 277 #define SMARTCARD_PRESCALER_SYSCLK_DIV16        ((uint32_t)0x00000008)          /*!< SYSCLK divided by 16 */
 278 #define SMARTCARD_PRESCALER_SYSCLK_DIV18        ((uint32_t)0x00000009)          /*!< SYSCLK divided by 18 */
 279 #define SMARTCARD_PRESCALER_SYSCLK_DIV20        ((uint32_t)0x0000000A)          /*!< SYSCLK divided by 20 */
 280 #define SMARTCARD_PRESCALER_SYSCLK_DIV22        ((uint32_t)0x0000000B)          /*!< SYSCLK divided by 22 */
 281 #define SMARTCARD_PRESCALER_SYSCLK_DIV24        ((uint32_t)0x0000000C)          /*!< SYSCLK divided by 24 */
 282 #define SMARTCARD_PRESCALER_SYSCLK_DIV26        ((uint32_t)0x0000000D)          /*!< SYSCLK divided by 26 */
 283 #define SMARTCARD_PRESCALER_SYSCLK_DIV28        ((uint32_t)0x0000000E)          /*!< SYSCLK divided by 28 */
 284 #define SMARTCARD_PRESCALER_SYSCLK_DIV30        ((uint32_t)0x0000000F)          /*!< SYSCLK divided by 30 */
 285 #define SMARTCARD_PRESCALER_SYSCLK_DIV32        ((uint32_t)0x00000010)          /*!< SYSCLK divided by 32 */
 286 #define SMARTCARD_PRESCALER_SYSCLK_DIV34        ((uint32_t)0x00000011)          /*!< SYSCLK divided by 34 */
 287 #define SMARTCARD_PRESCALER_SYSCLK_DIV36        ((uint32_t)0x00000012)          /*!< SYSCLK divided by 36 */
 288 #define SMARTCARD_PRESCALER_SYSCLK_DIV38        ((uint32_t)0x00000013)          /*!< SYSCLK divided by 38 */
 289 #define SMARTCARD_PRESCALER_SYSCLK_DIV40        ((uint32_t)0x00000014)          /*!< SYSCLK divided by 40 */
 290 #define SMARTCARD_PRESCALER_SYSCLK_DIV42        ((uint32_t)0x00000015)          /*!< SYSCLK divided by 42 */
 291 #define SMARTCARD_PRESCALER_SYSCLK_DIV44        ((uint32_t)0x00000016)          /*!< SYSCLK divided by 44 */
 292 #define SMARTCARD_PRESCALER_SYSCLK_DIV46        ((uint32_t)0x00000017)          /*!< SYSCLK divided by 46 */
 293 #define SMARTCARD_PRESCALER_SYSCLK_DIV48        ((uint32_t)0x00000018)          /*!< SYSCLK divided by 48 */
 294 #define SMARTCARD_PRESCALER_SYSCLK_DIV50        ((uint32_t)0x00000019)          /*!< SYSCLK divided by 50 */
 295 #define SMARTCARD_PRESCALER_SYSCLK_DIV52        ((uint32_t)0x0000001A)          /*!< SYSCLK divided by 52 */
 296 #define SMARTCARD_PRESCALER_SYSCLK_DIV54        ((uint32_t)0x0000001B)          /*!< SYSCLK divided by 54 */
 297 #define SMARTCARD_PRESCALER_SYSCLK_DIV56        ((uint32_t)0x0000001C)          /*!< SYSCLK divided by 56 */
 298 #define SMARTCARD_PRESCALER_SYSCLK_DIV58        ((uint32_t)0x0000001D)          /*!< SYSCLK divided by 58 */
 299 #define SMARTCARD_PRESCALER_SYSCLK_DIV60        ((uint32_t)0x0000001E)          /*!< SYSCLK divided by 60 */
 300 #define SMARTCARD_PRESCALER_SYSCLK_DIV62        ((uint32_t)0x0000001F)          /*!< SYSCLK divided by 62 */
 301 /**
 302   * @}
 303   */
 304
 305
 306
 307 /** @defgroup SMARTCARD_Flags    SMARTCARD Flags
 308   *        Elements values convention: 0xXXXX
 309   *           - 0xXXXX  : Flag mask in the SR register
 310   * @{
 311   */
 312
 313 #define SMARTCARD_FLAG_TXE                      ((uint32_t)USART_SR_TXE)
 314 #define SMARTCARD_FLAG_TC                       ((uint32_t)USART_SR_TC)
 315 #define SMARTCARD_FLAG_RXNE                     ((uint32_t)USART_SR_RXNE)
 316 #define SMARTCARD_FLAG_IDLE                     ((uint32_t)USART_SR_IDLE)
 317 #define SMARTCARD_FLAG_ORE                      ((uint32_t)USART_SR_ORE)
 318 #define SMARTCARD_FLAG_NE                       ((uint32_t)USART_SR_NE)
 319 #define SMARTCARD_FLAG_FE                       ((uint32_t)USART_SR_FE)
 320 #define SMARTCARD_FLAG_PE                       ((uint32_t)USART_SR_PE)
 321 /**
 322   * @}
 323   */
 324
 325 /** @defgroup SMARTCARD_Interrupt_definition     SMARTCARD Interrupts Definition
 326   *        Elements values convention: 0xY000XXXX
 327   *           - XXXX  : Interrupt mask (16 bits) in the Y register
 328   *           - Y  : Interrupt source register (4 bits)
 329   *                 - 0001: CR1 register
 330   *                 - 0010: CR3 register
 331
 332   *
 333   * @{
 334   */
 335
 336 #define SMARTCARD_IT_PE                         ((uint32_t)(SMARTCARD_CR1_REG_INDEX << 28 | USART_CR1_PEIE))
 337 #define SMARTCARD_IT_TXE                        ((uint32_t)(SMARTCARD_CR1_REG_INDEX << 28 | USART_CR1_TXEIE))
 338 #define SMARTCARD_IT_TC                         ((uint32_t)(SMARTCARD_CR1_REG_INDEX << 28 | USART_CR1_TCIE))
 339 #define SMARTCARD_IT_RXNE                       ((uint32_t)(SMARTCARD_CR1_REG_INDEX << 28 | USART_CR1_RXNEIE))
 340 #define SMARTCARD_IT_IDLE                       ((uint32_t)(SMARTCARD_CR1_REG_INDEX << 28 | USART_CR1_IDLEIE))
 341 #define SMARTCARD_IT_ERR                        ((uint32_t)(SMARTCARD_CR3_REG_INDEX << 28 | USART_CR3_EIE))
 342
 343 /**
 344   * @}
 345   */
 346
 347 /**
 348   * @}
 349   */
 350
 351
 352 /* Exported macro ------------------------------------------------------------*/
 353 /** @defgroup SMARTCARD_Exported_Macros SMARTCARD Exported Macros
 354   * @{
 355   */
 356
 357
 358 /** @brief Reset SMARTCARD handle state
 359   * @param  __HANDLE__: specifies the SMARTCARD Handle.
 360   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 361   * @retval None
 362   */
 363 #define __HAL_SMARTCARD_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_SMARTCARD_STATE_RESET)
 364
 365 /** @brief  Flush the Smartcard DR register
 366   * @param  __HANDLE__: specifies the SMARTCARD Handle.
 367   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 368   * @retval None
 369   */
 370 #define __HAL_SMARTCARD_FLUSH_DRREGISTER(__HANDLE__) ((__HANDLE__)->Instance->DR)
 371
 372 /** @brief  Check whether the specified Smartcard flag is set or not.
 373   * @param  __HANDLE__: specifies the SMARTCARD Handle.
 374   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 375   * @param  __FLAG__: specifies the flag to check.
 376   *         This parameter can be one of the following values:
 377   *            @arg SMARTCARD_FLAG_TXE:  Transmit data register empty flag
 378   *            @arg SMARTCARD_FLAG_TC:   Transmission Complete flag
 379   *            @arg SMARTCARD_FLAG_RXNE: Receive data register not empty flag
 380   *            @arg SMARTCARD_FLAG_IDLE: Idle Line detection flag
 381   *            @arg SMARTCARD_FLAG_ORE:  OverRun Error flag
 382   *            @arg SMARTCARD_FLAG_NE:   Noise Error flag
 383   *            @arg SMARTCARD_FLAG_FE:   Framing Error flag
 384   *            @arg SMARTCARD_FLAG_PE:   Parity Error flag
 385   * @retval The new state of __FLAG__ (TRUE or FALSE).
 386   */
 387 #define __HAL_SMARTCARD_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->SR & (__FLAG__)) == (__FLAG__))
 388
 389 /** @brief  Clear the specified Smartcard pending flags.
 390   * @param  __HANDLE__: specifies the SMARTCARD Handle.
 391   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 392   * @param  __FLAG__: specifies the flag to check.
 393   *         This parameter can be any combination of the following values:
 394   *            @arg SMARTCARD_FLAG_TC:   Transmission Complete flag.
 395   *            @arg SMARTCARD_FLAG_RXNE: Receive data register not empty flag.
 396   * @retval None
 397   *
 398   * @note   PE (Parity error), FE (Framing error), NE (Noise error) and ORE (OverRun
 399   *          error) flags are cleared by software sequence: a read operation to
 400   *          USART_SR register followed by a read operation to USART_DR register.
 401   * @note   RXNE flag can be also cleared by a read to the USART_DR register.
 402   * @note   TC flag can be also cleared by software sequence: a read operation to
 403   *          USART_SR register followed by a write operation to USART_DR register.
 404   * @note   TXE flag is cleared only by a write to the USART_DR register.
 405   *
 406   * @retval None
 407   */
 408 #define __HAL_SMARTCARD_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->SR = ~(__FLAG__))
 409
 410 /** @brief  Clear the SMARTCARD PE pending flag.
 411   * @param  __HANDLE__: specifies the USART Handle.
 412   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 413   * @retval None
 414   */
 415 #define __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__) \
 416 do{                                                        \
 417     __IO uint32_t tmpreg;                                  \
 418     tmpreg = (__HANDLE__)->Instance->SR;                   \
 419     tmpreg = (__HANDLE__)->Instance->DR;                   \
 420     UNUSED(tmpreg);                                        \
 421 }while(0)
 422
 423
 424
 425 /** @brief  Clear the SMARTCARD FE pending flag.
 426   * @param  __HANDLE__: specifies the USART Handle.
 427   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 428   * @retval None
 429   */
 430 #define __HAL_SMARTCARD_CLEAR_FEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
 431
 432 /** @brief  Clear the SMARTCARD NE pending flag.
 433   * @param  __HANDLE__: specifies the USART Handle.
 434   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 435   * @retval None
 436   */
 437 #define __HAL_SMARTCARD_CLEAR_NEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
 438
 439 /** @brief  Clear the SMARTCARD ORE pending flag.
 440   * @param  __HANDLE__: specifies the USART Handle.
 441   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 442   * @retval None
 443   */
 444 #define __HAL_SMARTCARD_CLEAR_OREFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
 445
 446 /** @brief  Clear the SMARTCARD IDLE pending flag.
 447   * @param  __HANDLE__: specifies the USART Handle.
 448   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 449   * @retval None
 450   */
 451 #define __HAL_SMARTCARD_CLEAR_IDLEFLAG(__HANDLE__) __HAL_SMARTCARD_CLEAR_PEFLAG(__HANDLE__)
 452
 453 /** @brief  Enable the specified SmartCard interrupt.
 454   * @param  __HANDLE__: specifies the SMARTCARD Handle.
 455   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 456   * @param  __INTERRUPT__: specifies the SMARTCARD interrupt to enable.
 457   *          This parameter can be one of the following values:
 458   *            @arg SMARTCARD_IT_TXE:  Transmit Data Register empty interrupt
 459   *            @arg SMARTCARD_IT_TC:   Transmission complete interrupt
 460   *            @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt
 461   *            @arg SMARTCARD_IT_IDLE: Idle line detection interrupt
 462   *            @arg SMARTCARD_IT_PE:   Parity Error interrupt
 463   *            @arg SMARTCARD_IT_ERR:  Error interrupt(Frame error, noise error, overrun error)
 464   * @retval None
 465   */
 466 #define __HAL_SMARTCARD_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((((__INTERRUPT__) >> 28) == SMARTCARD_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 |= ((__INTERRUPT__) & SMARTCARD_IT_MASK)): \
 467                                                                ((__HANDLE__)->Instance->CR3 |= ((__INTERRUPT__) & SMARTCARD_IT_MASK)))
 468
 469 /** @brief  Disable the specified SmartCard interrupts.
 470   * @param  __HANDLE__: specifies the SMARTCARD Handle.
 471   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 472   * @param  __INTERRUPT__: specifies the SMARTCARD interrupt to disable.
 473   *          This parameter can be one of the following values:
 474   *            @arg SMARTCARD_IT_TXE:  Transmit Data Register empty interrupt
 475   *            @arg SMARTCARD_IT_TC:   Transmission complete interrupt
 476   *            @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt
 477   *            @arg SMARTCARD_IT_IDLE: Idle line detection interrupt
 478   *            @arg SMARTCARD_IT_PE:   Parity Error interrupt
 479   *            @arg SMARTCARD_IT_ERR:  Error interrupt(Frame error, noise error, overrun error)
 480   */
 481 #define __HAL_SMARTCARD_DISABLE_IT(__HANDLE__, __INTERRUPT__)  ((((__INTERRUPT__) >> 28) == SMARTCARD_CR1_REG_INDEX)? ((__HANDLE__)->Instance->CR1 &= ~((__INTERRUPT__) & SMARTCARD_IT_MASK)): \
 482                                                                ((__HANDLE__)->Instance->CR3 &= ~ ((__INTERRUPT__) & SMARTCARD_IT_MASK)))
 483
 484 /** @brief  Check whether the specified SmartCard interrupt has occurred or not.
 485   * @param  __HANDLE__: specifies the SMARTCARD Handle.
 486   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 487   * @param  __IT__: specifies the SMARTCARD interrupt source to check.
 488   *          This parameter can be one of the following values:
 489   *            @arg SMARTCARD_IT_TXE: Transmit Data Register empty interrupt
 490   *            @arg SMARTCARD_IT_TC:  Transmission complete interrupt
 491   *            @arg SMARTCARD_IT_RXNE: Receive Data register not empty interrupt
 492   *            @arg SMARTCARD_IT_IDLE: Idle line detection interrupt
 493   *            @arg SMARTCARD_IT_ERR: Error interrupt
 494   *            @arg SMARTCARD_IT_PE: Parity Error interrupt
 495   * @retval The new state of __IT__ (TRUE or FALSE).
 496   */
 497 #define __HAL_SMARTCARD_GET_IT_SOURCE(__HANDLE__, __IT__) (((((__IT__) >> 28) == SMARTCARD_CR1_REG_INDEX)? (__HANDLE__)->Instance->CR1: (__HANDLE__)->Instance->CR3) & (((uint32_t)(__IT__)) & SMARTCARD_IT_MASK))
 498
 499 /** @brief  Enable the USART associated to the SMARTCARD Handle
 500   * @param  __HANDLE__: specifies the SMARTCARD Handle.
 501   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 502   * @retval None
 503   */
 504 #define __HAL_SMARTCARD_ENABLE(__HANDLE__)               (SET_BIT((__HANDLE__)->Instance->CR1, USART_CR1_UE))
 505
 506 /** @brief  Disable the USART associated to the SMARTCARD Handle
 507   * @param  __HANDLE__: specifies the SMARTCARD Handle.
 508   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 509   * @retval None
 510   */
 511 #define __HAL_SMARTCARD_DISABLE(__HANDLE__)              (CLEAR_BIT((__HANDLE__)->Instance->CR1, USART_CR1_UE))
 512
 513 /** @brief  Enable the SmartCard DMA request.
 514   * @param  __HANDLE__: specifies the SmartCard Handle.
 515   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 516   * @param  __REQUEST__: specifies the SmartCard DMA request.
 517   *         This parameter can be one of the following values:
 518   *            @arg SMARTCARD_DMAREQ_TX: SmartCard DMA transmit request
 519   *            @arg SMARTCARD_DMAREQ_RX: SmartCard DMA receive request
 520   * @retval None
 521   */
 522 #define __HAL_SMARTCARD_DMA_REQUEST_ENABLE(__HANDLE__, __REQUEST__)    (SET_BIT((__HANDLE__)->Instance->CR3, (__REQUEST__)))
 523
 524 /** @brief  Disable the SmartCard DMA request.
 525   * @param  __HANDLE__: specifies the SmartCard Handle.
 526   *         SMARTCARD Handle selects the USARTx peripheral (USART availability and x value depending on device).
 527   * @param  __REQUEST__: specifies the SmartCard DMA request.
 528   *         This parameter can be one of the following values:
 529   *            @arg SMARTCARD_DMAREQ_TX: SmartCard DMA transmit request
 530   *            @arg SMARTCARD_DMAREQ_RX: SmartCard DMA receive request
 531   * @retval None
 532   */
 533 #define __HAL_SMARTCARD_DMA_REQUEST_DISABLE(__HANDLE__, __REQUEST__)   (CLEAR_BIT((__HANDLE__)->Instance->CR3, (__REQUEST__)))
 534
 535
 536 /**
 537   * @}
 538   */
 539
 540
 541 /* Private macros --------------------------------------------------------*/
 542 /** @defgroup SMARTCARD_Private_Macros   SMARTCARD Private Macros
 543   * @{
 544   */
 545
 546 #define SMARTCARD_CR1_REG_INDEX                 1
 547 #define SMARTCARD_CR3_REG_INDEX                 3
 548
 549 #define SMARTCARD_DIV(__PCLK__, __BAUD__)                (((__PCLK__)*25)/(4*(__BAUD__)))
 550 #define SMARTCARD_DIVMANT(__PCLK__, __BAUD__)            (SMARTCARD_DIV((__PCLK__), (__BAUD__))/100)
 551 #define SMARTCARD_DIVFRAQ(__PCLK__, __BAUD__)            (((SMARTCARD_DIV((__PCLK__), (__BAUD__)) - (SMARTCARD_DIVMANT((__PCLK__), (__BAUD__)) * 100)) * 16 + 50) / 100)
 552 #define SMARTCARD_BRR(__PCLK__, __BAUD__)                ((SMARTCARD_DIVMANT((__PCLK__), (__BAUD__)) << 4)|(SMARTCARD_DIVFRAQ((__PCLK__), (__BAUD__)) & 0x0F))
 553
 554 /** Check the Baud rate range.
 555   *         The maximum Baud Rate is derived from the maximum clock on APB (i.e. 72 MHz)
 556   *         divided by the smallest oversampling used on the USART (i.e. 16)
 557   *         __BAUDRATE__: Baud rate set by the configuration function.
 558   * Return : TRUE or FALSE
 559   */
 560 #define IS_SMARTCARD_BAUDRATE(__BAUDRATE__) ((__BAUDRATE__) < 4500001)
 561
 562 #define IS_SMARTCARD_WORD_LENGTH(LENGTH)    ((LENGTH) == SMARTCARD_WORDLENGTH_9B)
 563
 564 #define IS_SMARTCARD_STOPBITS(STOPBITS)     (((STOPBITS) == SMARTCARD_STOPBITS_0_5) || \
 565                                              ((STOPBITS) == SMARTCARD_STOPBITS_1_5))
 566
 567 #define IS_SMARTCARD_PARITY(PARITY)         (((PARITY) == SMARTCARD_PARITY_EVEN) || \
 568                                              ((PARITY) == SMARTCARD_PARITY_ODD))
 569
 570 #define IS_SMARTCARD_MODE(MODE)             ((((MODE) & (~((uint32_t)SMARTCARD_MODE_TX_RX))) == 0x00) && \
 571                                              ((MODE) != (uint32_t)0x00000000))
 572
 573 #define IS_SMARTCARD_POLARITY(CPOL)         (((CPOL) == SMARTCARD_POLARITY_LOW) || ((CPOL) == SMARTCARD_POLARITY_HIGH))
 574
 575 #define IS_SMARTCARD_PHASE(CPHA)            (((CPHA) == SMARTCARD_PHASE_1EDGE) || ((CPHA) == SMARTCARD_PHASE_2EDGE))
 576
 577 #define IS_SMARTCARD_LASTBIT(LASTBIT)       (((LASTBIT) == SMARTCARD_LASTBIT_DISABLE) || \
 578                                              ((LASTBIT) == SMARTCARD_LASTBIT_ENABLE))
 579
 580 #define IS_SMARTCARD_NACK_STATE(NACK)       (((NACK) == SMARTCARD_NACK_ENABLE) || \
 581                                              ((NACK) == SMARTCARD_NACK_DISABLE))
 582
 583 #define IS_SMARTCARD_PRESCALER(PRESCALER)   (((PRESCALER) >= SMARTCARD_PRESCALER_SYSCLK_DIV2) && \
 584                                              ((PRESCALER) <= SMARTCARD_PRESCALER_SYSCLK_DIV62) )
 585
 586 /** SMARTCARD interruptions flag mask
 587   *
 588   */
 589 #define SMARTCARD_IT_MASK   ((uint32_t) USART_CR1_PEIE | USART_CR1_TXEIE | USART_CR1_TCIE | USART_CR1_RXNEIE | \
 590                                         USART_CR1_IDLEIE | USART_CR3_EIE )
 591
 592
 593 /**
 594   * @}
 595   */
 596
 597
 598 /* Exported functions --------------------------------------------------------*/
 599
 600 /** @addtogroup SMARTCARD_Exported_Functions SMARTCARD Exported Functions
 601   * @{
 602   */
 603
 604 /** @addtogroup SMARTCARD_Exported_Functions_Group1 Initialization and de-initialization functions
 605   * @{
 606   */
 607
 608 /* Initialization/de-initialization functions  **********************************/
 609 HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsc);
 610 HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsc);
 611 void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsc);
 612 void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsc);
 613
 614 /**
 615   * @}
 616   */
 617
 618 /** @addtogroup SMARTCARD_Exported_Functions_Group2 IO operation functions
 619   * @{
 620   */
 621
 622 /* IO operation functions *******************************************************/
 623 HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size, uint32_t Timeout);
 624 HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size, uint32_t Timeout);
 625 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
 626 HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
 627 HAL_StatusTypeDef HAL_SMARTCARD_Transmit_DMA(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
 628 HAL_StatusTypeDef HAL_SMARTCARD_Receive_DMA(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size);
 629 void HAL_SMARTCARD_IRQHandler(SMARTCARD_HandleTypeDef *hsc);
 630 void HAL_SMARTCARD_TxCpltCallback(SMARTCARD_HandleTypeDef *hsc);
 631 void HAL_SMARTCARD_RxCpltCallback(SMARTCARD_HandleTypeDef *hsc);
 632 void HAL_SMARTCARD_ErrorCallback(SMARTCARD_HandleTypeDef *hsc);
 633
 634 /**
 635   * @}
 636   */
 637
 638 /** @addtogroup SMARTCARD_Exported_Functions_Group3 Peripheral State and Errors functions
 639   * @{
 640   */
 641
 642 /* Peripheral State and Errors functions functions  *****************************/
 643 HAL_SMARTCARD_StateTypeDef HAL_SMARTCARD_GetState(SMARTCARD_HandleTypeDef *hsc);
 644 uint32_t                   HAL_SMARTCARD_GetError(SMARTCARD_HandleTypeDef *hsc);
 645
 646 /**
 647   * @}
 648   */
 649
 650 /**
 651   * @}
 652   */
 653
 654 /**
 655   * @}
 656   */
 657
 658 /**
 659   * @}
 660   */
 661
 662 #ifdef __cplusplus
 663 }
 664 #endif
 665
 666 #endif /* __STM32F1xx_HAL_SMARTCARD_H */
 667
 668 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/