stm32f4xx_hal_smartcard.c File Reference

SMARTCARD HAL module driver. This file provides firmware functions to manage the following functionalities of the SMARTCARD peripheral: More...

#include "stm32f4xx_hal.h"

Include dependency graph for stm32f4xx_hal_smartcard.c:

Go to the source code of this file.

Functions
static void	SMARTCARD_EndTxTransfer (SMARTCARD_HandleTypeDef *hsc)
	End ongoing Tx transfer on SMARTCARD peripheral (following error detection or Transmit completion).
static void	SMARTCARD_EndRxTransfer (SMARTCARD_HandleTypeDef *hsc)
	End ongoing Rx transfer on SMARTCARD peripheral (following error detection or Reception completion).
static void	SMARTCARD_SetConfig (SMARTCARD_HandleTypeDef *hsc)
	Configure the SMARTCARD peripheral.
static HAL_StatusTypeDef	SMARTCARD_Transmit_IT (SMARTCARD_HandleTypeDef *hsc)
	Send an amount of data in non blocking mode.
static HAL_StatusTypeDef	SMARTCARD_EndTransmit_IT (SMARTCARD_HandleTypeDef *hsc)
	Wraps up transmission in non blocking mode.
static HAL_StatusTypeDef	SMARTCARD_Receive_IT (SMARTCARD_HandleTypeDef *hsc)
	Receive an amount of data in non blocking mode.
static void	SMARTCARD_DMATransmitCplt (DMA_HandleTypeDef *hdma)
	DMA SMARTCARD transmit process complete callback.
static void	SMARTCARD_DMAReceiveCplt (DMA_HandleTypeDef *hdma)
	DMA SMARTCARD receive process complete callback.
static void	SMARTCARD_DMAError (DMA_HandleTypeDef *hdma)
	DMA SMARTCARD communication error callback.
static void	SMARTCARD_DMAAbortOnError (DMA_HandleTypeDef *hdma)
	DMA SMARTCARD communication abort callback, when initiated by HAL services on Error (To be called at end of DMA Abort procedure following error occurrence).
static void	SMARTCARD_DMATxAbortCallback (DMA_HandleTypeDef *hdma)
	DMA SMARTCARD Tx communication abort callback, when initiated by user (To be called at end of DMA Tx Abort procedure following user abort request).
static void	SMARTCARD_DMARxAbortCallback (DMA_HandleTypeDef *hdma)
	DMA SMARTCARD Rx communication abort callback, when initiated by user (To be called at end of DMA Rx Abort procedure following user abort request).
static void	SMARTCARD_DMATxOnlyAbortCallback (DMA_HandleTypeDef *hdma)
	DMA SMARTCARD Tx communication abort callback, when initiated by user by a call to HAL_SMARTCARD_AbortTransmit_IT API (Abort only Tx transfer) (This callback is executed at end of DMA Tx Abort procedure following user abort request, and leads to user Tx Abort Complete callback execution).
static void	SMARTCARD_DMARxOnlyAbortCallback (DMA_HandleTypeDef *hdma)
	DMA SMARTCARD Rx communication abort callback, when initiated by user by a call to HAL_SMARTCARD_AbortReceive_IT API (Abort only Rx transfer) (This callback is executed at end of DMA Rx Abort procedure following user abort request, and leads to user Rx Abort Complete callback execution).
static HAL_StatusTypeDef	SMARTCARD_WaitOnFlagUntilTimeout (SMARTCARD_HandleTypeDef *hsc, uint32_t Flag, FlagStatus Status, uint32_t Tickstart, uint32_t Timeout)
	This function handles SMARTCARD Communication Timeout. It waits until a flag is no longer in the specified status.
HAL_StatusTypeDef	HAL_SMARTCARD_Init (SMARTCARD_HandleTypeDef *hsc)
	Initializes the SmartCard mode according to the specified parameters in the SMARTCARD_InitTypeDef and create the associated handle.
HAL_StatusTypeDef	HAL_SMARTCARD_DeInit (SMARTCARD_HandleTypeDef *hsc)
	DeInitializes the USART SmartCard peripheral.
void	HAL_SMARTCARD_MspInit (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD MSP Init.
void	HAL_SMARTCARD_MspDeInit (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD MSP DeInit.
HAL_StatusTypeDef	HAL_SMARTCARD_Transmit (SMARTCARD_HandleTypeDef *hsc, const uint8_t *pData, uint16_t Size, uint32_t Timeout)
	Send an amount of data in blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Receive (SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size, uint32_t Timeout)
	Receive an amount of data in blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Transmit_IT (SMARTCARD_HandleTypeDef *hsc, const uint8_t *pData, uint16_t Size)
	Send an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Receive_IT (SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size)
	Receive an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Transmit_DMA (SMARTCARD_HandleTypeDef *hsc, const uint8_t *pData, uint16_t Size)
	Send an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Receive_DMA (SMARTCARD_HandleTypeDef *hsc, uint8_t *pData, uint16_t Size)
	Receive an amount of data in non blocking mode.
HAL_StatusTypeDef	HAL_SMARTCARD_Abort (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing transfers (blocking mode).
HAL_StatusTypeDef	HAL_SMARTCARD_AbortTransmit (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing Transmit transfer (blocking mode).
HAL_StatusTypeDef	HAL_SMARTCARD_AbortReceive (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing Receive transfer (blocking mode).
HAL_StatusTypeDef	HAL_SMARTCARD_Abort_IT (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing transfers (Interrupt mode).
HAL_StatusTypeDef	HAL_SMARTCARD_AbortTransmit_IT (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing Transmit transfer (Interrupt mode).
HAL_StatusTypeDef	HAL_SMARTCARD_AbortReceive_IT (SMARTCARD_HandleTypeDef *hsc)
	Abort ongoing Receive transfer (Interrupt mode).
void	HAL_SMARTCARD_IRQHandler (SMARTCARD_HandleTypeDef *hsc)
	This function handles SMARTCARD interrupt request.
void	HAL_SMARTCARD_TxCpltCallback (SMARTCARD_HandleTypeDef *hsc)
	Tx Transfer completed callbacks.
void	HAL_SMARTCARD_RxCpltCallback (SMARTCARD_HandleTypeDef *hsc)
	Rx Transfer completed callback.
void	HAL_SMARTCARD_ErrorCallback (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD error callback.
void	HAL_SMARTCARD_AbortCpltCallback (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD Abort Complete callback.
void	HAL_SMARTCARD_AbortTransmitCpltCallback (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD Abort Transmit Complete callback.
void	HAL_SMARTCARD_AbortReceiveCpltCallback (SMARTCARD_HandleTypeDef *hsc)
	SMARTCARD Abort Receive Complete callback.
HAL_SMARTCARD_StateTypeDef	HAL_SMARTCARD_GetState (const SMARTCARD_HandleTypeDef *hsc)
	Return the SMARTCARD handle state.
uint32_t	HAL_SMARTCARD_GetError (const SMARTCARD_HandleTypeDef *hsc)
	Return the SMARTCARD error code.

Detailed Description

SMARTCARD HAL module driver. This file provides firmware functions to manage the following functionalities of the SMARTCARD peripheral:

Author

MCD Application Team

• Initialization and de-initialization functions
• IO operation functions
• Peripheral Control functions
• Peripheral State and Error functions

Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

==============================================================================
                   ##### 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 stream.
          (+++) Enable the DMAx interface clock.
          (+++) Configure the declared DMA handle structure with the required Tx/Rx parameters.
          (+++) Configure the DMA Tx/Rx stream.
          (+++) 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 stream.
          (+++) 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 HAL_SMARTCARD_RegisterCallback() to register a user callback.
  Function 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 HAL_SMARTCARD_UnRegisterCallback() to reset a callback to the default
  weak (surcharged) function.
  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 HAL_SMARTCARD_Init() and when the state is HAL_SMARTCARD_STATE_RESET
  all callbacks are set to the corresponding weak (surcharged) functions:
  examples HAL_SMARTCARD_TxCpltCallback(), HAL_SMARTCARD_RxCpltCallback().
  Exception done for MspInit and MspDeInit functions that are respectively
  reset to the legacy weak (surcharged) functions in the HAL_SMARTCARD_Init()
  and HAL_SMARTCARD_DeInit() only when these callbacks are null (not registered beforehand).
  If not, MspInit or MspDeInit are not null, the HAL_SMARTCARD_Init() and 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 HAL_SMARTCARD_RegisterCallback() before calling HAL_SMARTCARD_DeInit()
  or 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.

Definition in file stm32f4xx_hal_smartcard.c.