Subversion Repositories DashDisplay

/**

  ******************************************************************************

  * @file    stm32l1xx_hal_smartcard.c

  * @author  MCD Application Team

  * @brief   SMARTCARD HAL module driver.

  *          This file provides firmware functions to manage the following

  *          functionalities of the SMARTCARD peripheral:

  *           + Initialization and de-initialization functions

  *           + IO operation functions

  *           + Peripheral Control functions

  *           + Peripheral State and Error functions

  *

  @verbatim

  ==============================================================================

                     ##### How to use this driver #####

  ==============================================================================

    [..]

      The SMARTCARD HAL driver can be used as follows:

    (#) Declare a SMARTCARD_HandleTypeDef handle structure.

    (#) Initialize the SMARTCARD low level resources by implementing the HAL_SMARTCARD_MspInit() API:

        (##) Enable the interface clock of the USARTx associated to the SMARTCARD.

        (##) SMARTCARD pins configuration:

            (+++) Enable the clock for the SMARTCARD GPIOs.

            (+++) Configure SMARTCARD pins as alternate function pull-up.

        (##) NVIC configuration if you need to use interrupt process (HAL_SMARTCARD_Transmit_IT()

             and HAL_SMARTCARD_Receive_IT() APIs):

            (+++) Configure the USARTx interrupt priority.

            (+++) Enable the NVIC USART IRQ handle.

        (##) DMA Configuration if you need to use DMA process (HAL_SMARTCARD_Transmit_DMA()

             and HAL_SMARTCARD_Receive_DMA() APIs):

            (+++) Declare a DMA handle structure for the Tx/Rx channel.

            (+++) Enable the DMAx interface clock.

            (+++) Configure the declared DMA handle structure with the required Tx/Rx parameters.

            (+++) Configure the DMA Tx/Rx channel.

            (+++) Associate the initialized DMA handle to the SMARTCARD DMA Tx/Rx handle.

            (+++) Configure the priority and enable the NVIC for the transfer complete interrupt on the DMA Tx/Rx channel.

            (+++) Configure the USARTx interrupt priority and enable the NVIC USART IRQ handle

                  (used for last byte sending completion detection in DMA non circular mode)

    (#) Program the Baud Rate, Word Length , Stop Bit, Parity, Hardware

        flow control and Mode(Receiver/Transmitter) in the SMARTCARD Init structure.

    (#) Initialize the SMARTCARD registers by calling the HAL_SMARTCARD_Init() API:

        (++) These APIs configure also the low level Hardware GPIO, CLOCK, CORTEX...etc)

             by calling the customized HAL_SMARTCARD_MspInit() API.

    [..]

    (@) The specific SMARTCARD interrupts (Transmission complete interrupt,

        RXNE interrupt and Error Interrupts) will be managed using the macros

        __HAL_SMARTCARD_ENABLE_IT() and __HAL_SMARTCARD_DISABLE_IT() inside the transmit and receive process.

    [..]

    Three operation modes are available within this driver :

    *** Polling mode IO operation ***

    =================================

    [..]

      (+) Send an amount of data in blocking mode using HAL_SMARTCARD_Transmit()

      (+) Receive an amount of data in blocking mode using HAL_SMARTCARD_Receive()

    *** Interrupt mode IO operation ***

    ===================================

    [..]

      (+) Send an amount of data in non blocking mode using HAL_SMARTCARD_Transmit_IT()

      (+) At transmission end of transfer HAL_SMARTCARD_TxCpltCallback is executed and user can

          add his own code by customization of function pointer HAL_SMARTCARD_TxCpltCallback

      (+) Receive an amount of data in non blocking mode using HAL_SMARTCARD_Receive_IT()

      (+) At reception end of transfer HAL_SMARTCARD_RxCpltCallback is executed and user can

          add his own code by customization of function pointer HAL_SMARTCARD_RxCpltCallback

      (+) In case of transfer Error, HAL_SMARTCARD_ErrorCallback() function is executed and user can

          add his own code by customization of function pointer HAL_SMARTCARD_ErrorCallback

    *** DMA mode IO operation ***

    ==============================

    [..]

      (+) Send an amount of data in non blocking mode (DMA) using HAL_SMARTCARD_Transmit_DMA()

      (+) At transmission end of transfer HAL_SMARTCARD_TxCpltCallback is executed and user can

          add his own code by customization of function pointer HAL_SMARTCARD_TxCpltCallback

      (+) Receive an amount of data in non blocking mode (DMA) using HAL_SMARTCARD_Receive_DMA()

      (+) At reception end of transfer HAL_SMARTCARD_RxCpltCallback is executed and user can

          add his own code by customization of function pointer HAL_SMARTCARD_RxCpltCallback

      (+) In case of transfer Error, HAL_SMARTCARD_ErrorCallback() function is executed and user can

          add his own code by customization of function pointer HAL_SMARTCARD_ErrorCallback

    *** SMARTCARD HAL driver macros list ***

    ========================================

    [..]

      Below the list of most used macros in SMARTCARD HAL driver.

      (+) __HAL_SMARTCARD_ENABLE: Enable the SMARTCARD peripheral

      (+) __HAL_SMARTCARD_DISABLE: Disable the SMARTCARD peripheral

      (+) __HAL_SMARTCARD_GET_FLAG : Check whether the specified SMARTCARD flag is set or not

      (+) __HAL_SMARTCARD_CLEAR_FLAG : Clear the specified SMARTCARD pending flag

      (+) __HAL_SMARTCARD_ENABLE_IT: Enable the specified SMARTCARD interrupt

      (+) __HAL_SMARTCARD_DISABLE_IT: Disable the specified SMARTCARD interrupt

    [..]

      (@) You can refer to the SMARTCARD HAL driver header file for more useful macros

    ##### Callback registration #####

    ==================================

    [..]

    The compilation define USE_HAL_SMARTCARD_REGISTER_CALLBACKS when set to 1

    allows the user to configure dynamically the driver callbacks.

    [..]

    Use Function @ref HAL_SMARTCARD_RegisterCallback() to register a user callback.

    Function @ref HAL_SMARTCARD_RegisterCallback() allows to register following callbacks:

    (+) TxCpltCallback            : Tx Complete Callback.

    (+) RxCpltCallback            : Rx Complete Callback.

    (+) ErrorCallback             : Error Callback.

    (+) AbortCpltCallback         : Abort Complete Callback.

    (+) AbortTransmitCpltCallback : Abort Transmit Complete Callback.

    (+) AbortReceiveCpltCallback  : Abort Receive Complete Callback.

    (+) MspInitCallback           : SMARTCARD MspInit.

    (+) MspDeInitCallback         : SMARTCARD MspDeInit.

    This function takes as parameters the HAL peripheral handle, the Callback ID

    and a pointer to the user callback function.

    [..]

    Use function @ref HAL_SMARTCARD_UnRegisterCallback() to reset a callback to the default

    weak (surcharged) function.

    @ref HAL_SMARTCARD_UnRegisterCallback() takes as parameters the HAL peripheral handle,

    and the Callback ID.

    This function allows to reset following callbacks:

    (+) TxCpltCallback            : Tx Complete Callback.

    (+) RxCpltCallback            : Rx Complete Callback.

    (+) ErrorCallback             : Error Callback.

    (+) AbortCpltCallback         : Abort Complete Callback.

    (+) AbortTransmitCpltCallback : Abort Transmit Complete Callback.

    (+) AbortReceiveCpltCallback  : Abort Receive Complete Callback.

    (+) MspInitCallback           : SMARTCARD MspInit.

    (+) MspDeInitCallback         : SMARTCARD MspDeInit.

    [..]

    By default, after the @ref HAL_SMARTCARD_Init() and when the state is HAL_SMARTCARD_STATE_RESET

    all callbacks are set to the corresponding weak (surcharged) functions:

    examples @ref HAL_SMARTCARD_TxCpltCallback(), @ref HAL_SMARTCARD_RxCpltCallback().

    Exception done for MspInit and MspDeInit functions that are respectively

    reset to the legacy weak (surcharged) functions in the @ref HAL_SMARTCARD_Init()

    and @ref HAL_SMARTCARD_DeInit() only when these callbacks are null (not registered beforehand).

    If not, MspInit or MspDeInit are not null, the @ref HAL_SMARTCARD_Init() and @ref HAL_SMARTCARD_DeInit()

    keep and use the user MspInit/MspDeInit callbacks (registered beforehand).

    [..]

    Callbacks can be registered/unregistered in HAL_SMARTCARD_STATE_READY state only.

    Exception done MspInit/MspDeInit that can be registered/unregistered

    in HAL_SMARTCARD_STATE_READY or HAL_SMARTCARD_STATE_RESET state, thus registered (user)

    MspInit/DeInit callbacks can be used during the Init/DeInit.

    In that case first register the MspInit/MspDeInit user callbacks

    using @ref HAL_SMARTCARD_RegisterCallback() before calling @ref HAL_SMARTCARD_DeInit()

    or @ref HAL_SMARTCARD_Init() function.

    [..]

    When The compilation define USE_HAL_SMARTCARD_REGISTER_CALLBACKS is set to 0 or

    not defined, the callback registration feature is not available

    and weak (surcharged) callbacks are used.

  @endverbatim

  ******************************************************************************

  * @attention

  *

  * <h2><center>&copy; Copyright (c) 2016 STMicroelectronics.

  * All rights reserved.</center></h2>

  *

  * This software component is licensed by ST under BSD 3-Clause license,

  * the "License"; You may not use this file except in compliance with the

  * License. You may obtain a copy of the License at:

  *                        opensource.org/licenses/BSD-3-Clause

  *

  ******************************************************************************

  */

/* Includes ------------------------------------------------------------------*/

#include "stm32l1xx_hal.h"

/** @addtogroup STM32L1xx_HAL_Driver

  * @{

  */

/** @defgroup SMARTCARD SMARTCARD

  * @brief HAL SMARTCARD module driver

  * @{

  */

#ifdef HAL_SMARTCARD_MODULE_ENABLED

/* Private typedef -----------------------------------------------------------*/

/* Private define ------------------------------------------------------------*/

/** @addtogroup SMARTCARD_Private_Constants

  * @{

  */

/**

  * @}

  */

/* Private macro -------------------------------------------------------------*/

/* Private variables ---------------------------------------------------------*/

/* Private function prototypes -----------------------------------------------*/

/** @addtogroup SMARTCARD_Private_Functions

  * @{

  */

#if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)

void SMARTCARD_InitCallbacksToDefault(SMARTCARD_HandleTypeDef *hsc);

#endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */

static void SMARTCARD_EndTxTransfer(SMARTCARD_HandleTypeDef *hsc);

static void SMARTCARD_EndRxTransfer(SMARTCARD_HandleTypeDef *hsc);

static void SMARTCARD_SetConfig (SMARTCARD_HandleTypeDef *hsc);

static HAL_StatusTypeDef SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsc);

static HAL_StatusTypeDef SMARTCARD_EndTransmit_IT(SMARTCARD_HandleTypeDef *hsc);

static HAL_StatusTypeDef SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsc);

static void SMARTCARD_DMATransmitCplt(DMA_HandleTypeDef *hdma);

static void SMARTCARD_DMAReceiveCplt(DMA_HandleTypeDef *hdma);

static void SMARTCARD_DMAError(DMA_HandleTypeDef *hdma);

static void SMARTCARD_DMAAbortOnError(DMA_HandleTypeDef *hdma);

static void SMARTCARD_DMATxAbortCallback(DMA_HandleTypeDef *hdma);

static void SMARTCARD_DMARxAbortCallback(DMA_HandleTypeDef *hdma);

static void SMARTCARD_DMATxOnlyAbortCallback(DMA_HandleTypeDef *hdma);

static void SMARTCARD_DMARxOnlyAbortCallback(DMA_HandleTypeDef *hdma);

static HAL_StatusTypeDef SMARTCARD_WaitOnFlagUntilTimeout(SMARTCARD_HandleTypeDef *hsc, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout);

/**

  * @}

  */

/* Exported functions --------------------------------------------------------*/

/** @defgroup SMARTCARD_Exported_Functions SMARTCARD Exported Functions

  * @{

  */

/** @defgroup SMARTCARD_Exported_Functions_Group1 SmartCard Initialization and de-initialization functions

  *  @brief    Initialization and Configuration functions

  *

@verbatim

  ==============================================================================

              ##### Initialization and Configuration functions #####

  ==============================================================================

  [..]

  This subsection provides a set of functions allowing to initialize the USART

  in Smartcard mode.

  [..]

  The Smartcard interface is designed to support asynchronous protocol Smartcards as

  defined in the ISO 7816-3 standard.

  [..]

  The USART can provide a clock to the smartcard through the SCLK output.

  In smartcard mode, SCLK is not associated to the communication but is simply derived

  from the internal peripheral input clock through a 5-bit prescaler.

  [..]

  (+) For the Smartcard mode only these parameters can be configured:

      (++) Baud Rate

      (++) Word Length => Should be 9 bits (8 bits + parity)

      (++) Stop Bit

      (++) Parity: => Should be enabled

      (++) USART polarity

      (++) USART phase

      (++) USART LastBit

      (++) Receiver/transmitter modes

      (++) Prescaler

      (++) GuardTime

      (++) NACKState: The Smartcard NACK state

     (+) Recommended SmartCard interface configuration to get the Answer to Reset from the Card:

        (++) Word Length = 9 Bits

        (++) 1.5 Stop Bit

        (++) Even parity

        (++) BaudRate = 12096 baud

        (++) Tx and Rx enabled

  [..]

  Please refer to the ISO 7816-3 specification for more details.

  [..]

   (@) It is also possible to choose 0.5 stop bit for receiving but it is recommended

       to use 1.5 stop bits for both transmitting and receiving to avoid switching

       between the two configurations.

  [..]

    The HAL_SMARTCARD_Init() function follows the USART  SmartCard configuration

    procedures (details for the procedures are available in reference manual (RM0038)).

@endverbatim

  The SMARTCARD frame format is given in the following table:

       +-------------------------------------------------------------+

       |   M bit |  PCE bit  |        SMARTCARD frame                |

       |---------------------|---------------------------------------|

       |    1    |    1      |    | SB | 8 bit data | PB | STB |     |

       +-------------------------------------------------------------+

  * @{

  */

/**

  * @brief  Initializes the SmartCard mode according to the specified

  *         parameters in the SMARTCARD_InitTypeDef and create the associated handle.

  * @param  hsc    Pointer to a SMARTCARD_HandleTypeDef structure that contains

  *                the configuration information for SMARTCARD module.

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_SMARTCARD_Init(SMARTCARD_HandleTypeDef *hsc)

{

  /* Check the SMARTCARD handle allocation */

  if(hsc == NULL)

  {

    return HAL_ERROR;

  }

  /* Check the parameters */

  assert_param(IS_SMARTCARD_INSTANCE(hsc->Instance));

  assert_param(IS_SMARTCARD_NACK_STATE(hsc->Init.NACKState));

  if(hsc->gState == HAL_SMARTCARD_STATE_RESET)

  {

    /* Allocate lock resource and initialize it */

    hsc->Lock = HAL_UNLOCKED;

#if USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1

    SMARTCARD_InitCallbacksToDefault(hsc);

    if (hsc->MspInitCallback == NULL)

    {

      hsc->MspInitCallback = HAL_SMARTCARD_MspInit;

    }

    /* Init the low level hardware */

    hsc->MspInitCallback(hsc);

#else

    /* Init the low level hardware : GPIO, CLOCK */

    HAL_SMARTCARD_MspInit(hsc);

#endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */

  }

  hsc->gState = HAL_SMARTCARD_STATE_BUSY;

  /* Set the Prescaler */

  MODIFY_REG(hsc->Instance->GTPR, USART_GTPR_PSC, hsc->Init.Prescaler);

  /* Set the Guard Time */

  MODIFY_REG(hsc->Instance->GTPR, USART_GTPR_GT, ((hsc->Init.GuardTime)<<8U));

  /* Set the Smartcard Communication parameters */

  SMARTCARD_SetConfig(hsc);

  /* In SmartCard mode, the following bits must be kept cleared:

  - LINEN bit in the USART_CR2 register

  - HDSEL and IREN bits in the USART_CR3 register.*/

  CLEAR_BIT(hsc->Instance->CR2, USART_CR2_LINEN);

  CLEAR_BIT(hsc->Instance->CR3, (USART_CR3_IREN | USART_CR3_HDSEL));

  /* Enable the SMARTCARD Parity Error Interrupt */

  SET_BIT(hsc->Instance->CR1, USART_CR1_PEIE);

  /* Enable the SMARTCARD Framing Error Interrupt */

  SET_BIT(hsc->Instance->CR3, USART_CR3_EIE);

  /* Enable the Peripheral */

  __HAL_SMARTCARD_ENABLE(hsc);

  /* Configure the Smartcard NACK state */

  MODIFY_REG(hsc->Instance->CR3, USART_CR3_NACK, hsc->Init.NACKState);

  /* Enable the SC mode by setting the SCEN bit in the CR3 register */

  hsc->Instance->CR3 |= (USART_CR3_SCEN);

  /* Initialize the SMARTCARD state*/

  hsc->ErrorCode = HAL_SMARTCARD_ERROR_NONE;

  hsc->gState= HAL_SMARTCARD_STATE_READY;

  hsc->RxState= HAL_SMARTCARD_STATE_READY;

  return HAL_OK;

}

/**

  * @brief DeInitializes the USART SmartCard peripheral

  * @param  hsc    Pointer to a SMARTCARD_HandleTypeDef structure that contains

  *                the configuration information for SMARTCARD module.

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_SMARTCARD_DeInit(SMARTCARD_HandleTypeDef *hsc)

{

  /* Check the SMARTCARD handle allocation */

  if(hsc == NULL)

  {

    return HAL_ERROR;

  }

  /* Check the parameters */

  assert_param(IS_SMARTCARD_INSTANCE(hsc->Instance));

  hsc->gState = HAL_SMARTCARD_STATE_BUSY;

  /* Disable the Peripheral */

  __HAL_SMARTCARD_DISABLE(hsc);

  /* DeInit the low level hardware */

#if USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1

  if (hsc->MspDeInitCallback == NULL)

  {

    hsc->MspDeInitCallback = HAL_SMARTCARD_MspDeInit;

  }

  /* DeInit the low level hardware */

  hsc->MspDeInitCallback(hsc);

#else

  HAL_SMARTCARD_MspDeInit(hsc);

#endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */

  hsc->ErrorCode = HAL_SMARTCARD_ERROR_NONE;

  hsc->gState = HAL_SMARTCARD_STATE_RESET;

  hsc->RxState = HAL_SMARTCARD_STATE_RESET;

  /* Release Lock */

  __HAL_UNLOCK(hsc);

  return HAL_OK;

}

/**

  * @brief  SMARTCARD MSP Init

  * @param  hsc    Pointer to a SMARTCARD_HandleTypeDef structure that contains

  *                the configuration information for SMARTCARD module.

  * @retval None

  */

__weak void HAL_SMARTCARD_MspInit(SMARTCARD_HandleTypeDef *hsc)

{

  /* Prevent unused argument(s) compilation warning */

  UNUSED(hsc);

  /* NOTE : This function should not be modified, when the callback is needed,

            the HAL_SMARTCARD_MspInit can be implemented in the user file

   */

}

/**

  * @brief SMARTCARD MSP DeInit

  * @param  hsc    Pointer to a SMARTCARD_HandleTypeDef structure that contains

  *                the configuration information for SMARTCARD module.

  * @retval None

  */

__weak void HAL_SMARTCARD_MspDeInit(SMARTCARD_HandleTypeDef *hsc)

{

  /* Prevent unused argument(s) compilation warning */

  UNUSED(hsc);

  /* NOTE : This function should not be modified, when the callback is needed,

            the HAL_SMARTCARD_MspDeInit can be implemented in the user file

   */

}

#if (USE_HAL_SMARTCARD_REGISTER_CALLBACKS == 1)

/**

  * @brief  Register a User SMARTCARD Callback

  *         To be used instead of the weak predefined callback

  * @param  hsc smartcard handle

  * @param  CallbackID ID of the callback to be registered

  *         This parameter can be one of the following values:

  *           @arg @ref HAL_SMARTCARD_TX_COMPLETE_CB_ID Tx Complete Callback ID

  *           @arg @ref HAL_SMARTCARD_RX_COMPLETE_CB_ID Rx Complete Callback ID

  *           @arg @ref HAL_SMARTCARD_ERROR_CB_ID Error Callback ID

  *           @arg @ref HAL_SMARTCARD_ABORT_COMPLETE_CB_ID Abort Complete Callback ID

  *           @arg @ref HAL_SMARTCARD_ABORT_TRANSMIT_COMPLETE_CB_ID Abort Transmit Complete Callback ID

  *           @arg @ref HAL_SMARTCARD_ABORT_RECEIVE_COMPLETE_CB_ID Abort Receive Complete Callback ID

  *           @arg @ref HAL_SMARTCARD_MSPINIT_CB_ID MspInit Callback ID

  *           @arg @ref HAL_SMARTCARD_MSPDEINIT_CB_ID MspDeInit Callback ID

  * @param  pCallback pointer to the Callback function

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_SMARTCARD_RegisterCallback(SMARTCARD_HandleTypeDef *hsc, HAL_SMARTCARD_CallbackIDTypeDef CallbackID, pSMARTCARD_CallbackTypeDef pCallback)

{

  HAL_StatusTypeDef status = HAL_OK;

  if (pCallback == NULL)

  {

    /* Update the error code */

    hsc->ErrorCode |= HAL_SMARTCARD_ERROR_INVALID_CALLBACK;

    return HAL_ERROR;

  }

  /* Process locked */

  __HAL_LOCK(hsc);

  if (hsc->gState == HAL_SMARTCARD_STATE_READY)

  {

    switch (CallbackID)

    {

      case HAL_SMARTCARD_TX_COMPLETE_CB_ID :

        hsc->TxCpltCallback = pCallback;

        break;

      case HAL_SMARTCARD_RX_COMPLETE_CB_ID :

        hsc->RxCpltCallback = pCallback;

        break;

      case HAL_SMARTCARD_ERROR_CB_ID :

        hsc->ErrorCallback = pCallback;

        break;

      case HAL_SMARTCARD_ABORT_COMPLETE_CB_ID :

        hsc->AbortCpltCallback = pCallback;

        break;

      case HAL_SMARTCARD_ABORT_TRANSMIT_COMPLETE_CB_ID :

        hsc->AbortTransmitCpltCallback = pCallback;

        break;

      case HAL_SMARTCARD_ABORT_RECEIVE_COMPLETE_CB_ID :

        hsc->AbortReceiveCpltCallback = pCallback;

        break;

      case HAL_SMARTCARD_MSPINIT_CB_ID :

        hsc->MspInitCallback = pCallback;

        break;

      case HAL_SMARTCARD_MSPDEINIT_CB_ID :

        hsc->MspDeInitCallback = pCallback;

        break;

      default :

        /* Update the error code */

        hsc->ErrorCode |= HAL_SMARTCARD_ERROR_INVALID_CALLBACK;

        /* Return error status */

        status =  HAL_ERROR;

        break;

    }

  }

  else if (hsc->gState == HAL_SMARTCARD_STATE_RESET)

  {

    switch (CallbackID)

    {

      case HAL_SMARTCARD_MSPINIT_CB_ID :

        hsc->MspInitCallback = pCallback;

        break;

      case HAL_SMARTCARD_MSPDEINIT_CB_ID :

        hsc->MspDeInitCallback = pCallback;

        break;

      default :

        /* Update the error code */

        hsc->ErrorCode |= HAL_SMARTCARD_ERROR_INVALID_CALLBACK;

        /* Return error status */

        status =  HAL_ERROR;

        break;

    }

  }

  else

  {

    /* Update the error code */

    hsc->ErrorCode |= HAL_SMARTCARD_ERROR_INVALID_CALLBACK;

    /* Return error status */

    status =  HAL_ERROR;

  }

  /* Release Lock */

  __HAL_UNLOCK(hsc);

  return status;

}

/**

  * @brief  Unregister an SMARTCARD callback

  *         SMARTCARD callback is redirected to the weak predefined callback

  * @param  hsc smartcard handle

  * @param  CallbackID ID of the callback to be unregistered

  *         This parameter can be one of the following values:

  *           @arg @ref HAL_SMARTCARD_TX_COMPLETE_CB_ID Tx Complete Callback ID

  *           @arg @ref HAL_SMARTCARD_RX_COMPLETE_CB_ID Rx Complete Callback ID

  *           @arg @ref HAL_SMARTCARD_ERROR_CB_ID Error Callback ID

  *           @arg @ref HAL_SMARTCARD_ABORT_COMPLETE_CB_ID Abort Complete Callback ID

  *           @arg @ref HAL_SMARTCARD_ABORT_TRANSMIT_COMPLETE_CB_ID Abort Transmit Complete Callback ID

  *           @arg @ref HAL_SMARTCARD_ABORT_RECEIVE_COMPLETE_CB_ID Abort Receive Complete Callback ID

  *           @arg @ref HAL_SMARTCARD_MSPINIT_CB_ID MspInit Callback ID

  *           @arg @ref HAL_SMARTCARD_MSPDEINIT_CB_ID MspDeInit Callback ID

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_SMARTCARD_UnRegisterCallback(SMARTCARD_HandleTypeDef *hsc, HAL_SMARTCARD_CallbackIDTypeDef CallbackID)

{

  HAL_StatusTypeDef status = HAL_OK;

  /* Process locked */

  __HAL_LOCK(hsc);

  if (HAL_SMARTCARD_STATE_READY == hsc->gState)

  {

    switch (CallbackID)

    {

      case HAL_SMARTCARD_TX_COMPLETE_CB_ID :

        hsc->TxCpltCallback = HAL_SMARTCARD_TxCpltCallback;                       /* Legacy weak TxCpltCallback            */

        break;

      case HAL_SMARTCARD_RX_COMPLETE_CB_ID :

        hsc->RxCpltCallback = HAL_SMARTCARD_RxCpltCallback;                       /* Legacy weak RxCpltCallback            */

        break;

      case HAL_SMARTCARD_ERROR_CB_ID :

        hsc->ErrorCallback = HAL_SMARTCARD_ErrorCallback;                         /* Legacy weak ErrorCallback             */

        break;

      case HAL_SMARTCARD_ABORT_COMPLETE_CB_ID :

        hsc->AbortCpltCallback = HAL_SMARTCARD_AbortCpltCallback;                 /* Legacy weak AbortCpltCallback         */

        break;

      case HAL_SMARTCARD_ABORT_TRANSMIT_COMPLETE_CB_ID :

        hsc->AbortTransmitCpltCallback = HAL_SMARTCARD_AbortTransmitCpltCallback; /* Legacy weak AbortTransmitCpltCallback */

        break;

      case HAL_SMARTCARD_ABORT_RECEIVE_COMPLETE_CB_ID :

        hsc->AbortReceiveCpltCallback = HAL_SMARTCARD_AbortReceiveCpltCallback;   /* Legacy weak AbortReceiveCpltCallback  */

        break;

      case HAL_SMARTCARD_MSPINIT_CB_ID :

        hsc->MspInitCallback = HAL_SMARTCARD_MspInit;                             /* Legacy weak MspInitCallback           */

        break;

      case HAL_SMARTCARD_MSPDEINIT_CB_ID :

        hsc->MspDeInitCallback = HAL_SMARTCARD_MspDeInit;                         /* Legacy weak MspDeInitCallback         */

        break;

      default :

        /* Update the error code */

        hsc->ErrorCode |= HAL_SMARTCARD_ERROR_INVALID_CALLBACK;

        /* Return error status */

        status =  HAL_ERROR;

        break;

    }

  }

  else if (HAL_SMARTCARD_STATE_RESET == hsc->gState)

  {

    switch (CallbackID)

    {

      case HAL_SMARTCARD_MSPINIT_CB_ID :

        hsc->MspInitCallback = HAL_SMARTCARD_MspInit;

        break;

      case HAL_SMARTCARD_MSPDEINIT_CB_ID :

        hsc->MspDeInitCallback = HAL_SMARTCARD_MspDeInit;

        break;

      default :

        /* Update the error code */

        hsc->ErrorCode |= HAL_SMARTCARD_ERROR_INVALID_CALLBACK;

        /* Return error status */

        status =  HAL_ERROR;

        break;

    }

  }

  else

  {

    /* Update the error code */

    hsc->ErrorCode |= HAL_SMARTCARD_ERROR_INVALID_CALLBACK;

    /* Return error status */

    status =  HAL_ERROR;

  }

  /* Release Lock */

  __HAL_UNLOCK(hsc);

  return status;

}

#endif /* USE_HAL_SMARTCARD_REGISTER_CALLBACKS */

/**

  * @}

  */

/** @defgroup SMARTCARD_Exported_Functions_Group2 IO operation functions

  * @brief    SMARTCARD Transmit and Receive functions

  *

@verbatim

 ===============================================================================

                      ##### IO operation functions #####

 ===============================================================================

 [..]

   This subsection provides a set of functions allowing to manage the SMARTCARD data transfers.

 [..]

    (#) Smartcard is a single wire half duplex communication protocol.

    The Smartcard interface is designed to support asynchronous protocol Smartcards as

    defined in the ISO 7816-3 standard.

    (#) The USART should be configured as:

       (++) 8 bits plus parity: where M=1 and PCE=1 in the USART_CR1 register

       (++) 1.5 stop bits when transmitting and receiving: where STOP=11 in the USART_CR2 register.

    (#) There are two modes of transfer:

       (++) Blocking mode: The communication is performed in polling mode.

            The HAL status of all data processing is returned by the same function

            after finishing transfer.

       (++) Non Blocking mode: The communication is performed using Interrupts

           or DMA, These APIs return the HAL status.

           The end of the data processing will be indicated through the

           dedicated SMARTCARD IRQ when using Interrupt mode or the DMA IRQ when

           using DMA mode.

           The HAL_SMARTCARD_TxCpltCallback(), HAL_SMARTCARD_RxCpltCallback() user callbacks

           will be executed respectively at the end of the Transmit or Receive process

           The HAL_SMARTCARD_ErrorCallback() user callback will be executed when a communication error is detected

    (#) Blocking mode APIs are :

        (++) HAL_SMARTCARD_Transmit()

        (++) HAL_SMARTCARD_Receive()

    (#) Non Blocking mode APIs with Interrupt are :

        (++) HAL_SMARTCARD_Transmit_IT()

        (++) HAL_SMARTCARD_Receive_IT()

        (++) HAL_SMARTCARD_IRQHandler()

    (#) Non Blocking mode functions with DMA are :

        (++) HAL_SMARTCARD_Transmit_DMA()

        (++) HAL_SMARTCARD_Receive_DMA()

    (#) A set of Transfer Complete Callbacks are provided in non Blocking mode:

        (++) HAL_SMARTCARD_TxCpltCallback()

        (++) HAL_SMARTCARD_RxCpltCallback()

        (++) HAL_SMARTCARD_ErrorCallback()

    (#) Non-Blocking mode transfers could be aborted using Abort API's :

        (+) HAL_SMARTCARD_Abort()

        (+) HAL_SMARTCARD_AbortTransmit()

        (+) HAL_SMARTCARD_AbortReceive()

        (+) HAL_SMARTCARD_Abort_IT()

        (+) HAL_SMARTCARD_AbortTransmit_IT()

        (+) HAL_SMARTCARD_AbortReceive_IT()

    (#) For Abort services based on interrupts (HAL_SMARTCARD_Abortxxx_IT), a set of Abort Complete Callbacks are provided:

        (+) HAL_SMARTCARD_AbortCpltCallback()

        (+) HAL_SMARTCARD_AbortTransmitCpltCallback()

        (+) HAL_SMARTCARD_AbortReceiveCpltCallback()

    (#) In Non-Blocking mode transfers, possible errors are split into 2 categories.

        Errors are handled as follows :

       (+) Error is considered as Recoverable and non blocking : Transfer could go till end, but error severity is

           to be evaluated by user : this concerns Frame Error, Parity Error or Noise Error in Interrupt mode reception .

           Received character is then retrieved and stored in Rx buffer, Error code is set to allow user to identify error type,

           and HAL_SMARTCARD_ErrorCallback() user callback is executed. Transfer is kept ongoing on SMARTCARD side.

           If user wants to abort it, Abort services should be called by user.

       (+) Error is considered as Blocking : Transfer could not be completed properly and is aborted.

           This concerns Frame Error in Interrupt mode transmission, Overrun Error in Interrupt mode reception and all errors in DMA mode.

           Error code is set to allow user to identify error type, and HAL_SMARTCARD_ErrorCallback() user callback is executed.

@endverbatim

  * @{

  */

/**

  * @brief Send an amount of data in blocking mode

  * @param  hsc    Pointer to a SMARTCARD_HandleTypeDef structure that contains

  *                the configuration information for SMARTCARD module.

  * @param  pData  Pointer to data buffer

  * @param  Size   Amount of data to be sent

  * @param  Timeout Timeout duration

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_SMARTCARD_Transmit(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size, uint32_t Timeout)

{

  uint8_t *tmp = pData;

  uint32_t tickstart = 0U;

  if(hsc->gState == HAL_SMARTCARD_STATE_READY)

  {

    if((pData == NULL) || (Size == 0U))

    {

      return  HAL_ERROR;

    }

    /* Process Locked */

    __HAL_LOCK(hsc);

    hsc->ErrorCode = HAL_SMARTCARD_ERROR_NONE;

    hsc->gState = HAL_SMARTCARD_STATE_BUSY_TX;

    /* Init tickstart for timeout management */

    tickstart = HAL_GetTick();

    hsc->TxXferSize = Size;

    hsc->TxXferCount = Size;

    while(hsc->TxXferCount > 0U)

    {

      hsc->TxXferCount--;

      if(SMARTCARD_WaitOnFlagUntilTimeout(hsc, SMARTCARD_FLAG_TXE, RESET, tickstart, Timeout) != HAL_OK)

      {

        return HAL_TIMEOUT;

      }

      hsc->Instance->DR = (uint8_t)(*tmp & 0xFFU);

      tmp++;

    }

    if(SMARTCARD_WaitOnFlagUntilTimeout(hsc, SMARTCARD_FLAG_TC, RESET, tickstart, Timeout) != HAL_OK)

    {

      return HAL_TIMEOUT;

    }

        /* At end of Tx process, restore hsc->gState to Ready */

    hsc->gState = HAL_SMARTCARD_STATE_READY;

    /* Process Unlocked */

    __HAL_UNLOCK(hsc);

    return HAL_OK;

  }

  else

  {

    return HAL_BUSY;

  }

}

/**

  * @brief Receive an amount of data in blocking mode

  * @param  hsc    Pointer to a SMARTCARD_HandleTypeDef structure that contains

  *                the configuration information for SMARTCARD module.

  * @param  pData  Pointer to data buffer

  * @param  Size   Amount of data to be received

  * @param  Timeout Timeout duration

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_SMARTCARD_Receive(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size, uint32_t Timeout)

{

  uint8_t  *tmp = pData;

  uint32_t tickstart = 0U;

  if(hsc->RxState == HAL_SMARTCARD_STATE_READY)

  {

    if((pData == NULL) || (Size == 0U))

    {

      return  HAL_ERROR;

    }

    /* Process Locked */

    __HAL_LOCK(hsc);

    hsc->ErrorCode = HAL_SMARTCARD_ERROR_NONE;

    hsc->RxState = HAL_SMARTCARD_STATE_BUSY_RX;

    /* Init tickstart for timeout management */

    tickstart = HAL_GetTick();

    hsc->RxXferSize = Size;

    hsc->RxXferCount = Size;

    /* Check the remain data to be received */

    while(hsc->RxXferCount > 0U)

    {

      hsc->RxXferCount--;

      if(SMARTCARD_WaitOnFlagUntilTimeout(hsc, SMARTCARD_FLAG_RXNE, RESET, tickstart, Timeout) != HAL_OK)

      {

        return HAL_TIMEOUT;

      }

      *tmp = (uint8_t)(hsc->Instance->DR & (uint8_t)0xFFU);

      tmp++;

    }

    /* At end of Rx process, restore hsc->RxState to Ready */

    hsc->RxState = HAL_SMARTCARD_STATE_READY;

    /* Process Unlocked */

    __HAL_UNLOCK(hsc);

    return HAL_OK;

  }

  else

  {

    return HAL_BUSY;

  }

}

/**

  * @brief Send an amount of data in non blocking mode

  * @param  hsc    Pointer to a SMARTCARD_HandleTypeDef structure that contains

  *                the configuration information for SMARTCARD module.

  * @param  pData  Pointer to data buffer

  * @param  Size   Amount of data to be sent

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_SMARTCARD_Transmit_IT(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size)

{

  /* Check that a Tx process is not already ongoing */

  if(hsc->gState == HAL_SMARTCARD_STATE_READY)

  {

    if((pData == NULL) || (Size == 0U))

    {

      return HAL_ERROR;

    }

    /* Process Locked */

    __HAL_LOCK(hsc);

    hsc->pTxBuffPtr = pData;

    hsc->TxXferSize = Size;

    hsc->TxXferCount = Size;

    hsc->ErrorCode = HAL_SMARTCARD_ERROR_NONE;

    hsc->gState = HAL_SMARTCARD_STATE_BUSY_TX;

    /* Process Unlocked */

    __HAL_UNLOCK(hsc);

    /* Enable the SMARTCARD Parity Error Interrupt */

    SET_BIT(hsc->Instance->CR1, USART_CR1_PEIE);

    /* Disable the SMARTCARD Error Interrupt: (Frame error, noise error, overrun error) */

    CLEAR_BIT(hsc->Instance->CR3, USART_CR3_EIE);

    /* Enable the SMARTCARD Transmit data register empty Interrupt */

    SET_BIT(hsc->Instance->CR1, USART_CR1_TXEIE);

    return HAL_OK;

  }

  else

  {

    return HAL_BUSY;

  }

}

/**

  * @brief Receive an amount of data in non blocking mode

  * @param  hsc    Pointer to a SMARTCARD_HandleTypeDef structure that contains

  *                the configuration information for SMARTCARD module.

  * @param  pData  Pointer to data buffer

  * @param  Size   Amount of data to be received

  * @retval HAL status

  */

HAL_StatusTypeDef HAL_SMARTCARD_Receive_IT(SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size)

{

  /* Check that a Rx process is not already ongoing */