stm32g4xx_hal_smartcard_ex.c

转到本文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_smartcard_ex.c
  * @author  MCD Application Team
  * @brief   SMARTCARD HAL模块驱动程序。
  *          本文件提供扩展固件功能，用于管理智能卡的以下功能：
  *           + 初始化和去初始化函数
  *           + 外设控制函数
  *
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2019 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.
  *
  ******************************************************************************
  @verbatim
  =============================================================================
               ##### SMARTCARD外设扩展功能  #####
  =============================================================================
  [..]
  扩展SMARTCARD HAL驱动程序的使用方法如下：

    (#) 使用HAL_SMARTCARD_Init()配置SMARTCARD基本功能后，
        可在hsmartcard AdvancedInit结构中编程SMARTCARD高级功能（TX/RX引脚交换、超时、
        自动重试计数器等）。

    (#) FIFO模式使能/禁用以及RX/TX FIFO阈值编程。

        -@- 当SMARTCARD在FIFO模式下工作时，必须在开始RX/TX传输之前使能FIFO模式。
            同时必须在开始RX/TX传输之前配置RX/TX FIFO阈值。

  @endverbatim
  ******************************************************************************
  */
 ******************************************************************************
  */

/* Includes ------------------------------------------------------------------*/
#include "stm32g4xx_hal.h"

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @defgroup SMARTCARDEx SMARTCARDEx
  * @brief SMARTCARD扩展HAL模块驱动程序
  * @{
  */
#ifdef HAL_SMARTCARD_MODULE_ENABLED

/* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/** @defgroup SMARTCARDEx_Private_Constants SMARTCARD Extended Private Constants
  * @{
  */
/* UART RX FIFO depth */
#define RX_FIFO_DEPTH 8U

/* UART TX FIFO depth */
#define TX_FIFO_DEPTH 8U
/**
  * @}
  */

/* Private macros ------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
static void SMARTCARDEx_SetNbDataToProcess(SMARTCARD_HandleTypeDef *hsmartcard);

/* Exported functions --------------------------------------------------------*/
/** @defgroup SMARTCARDEx_Exported_Functions  SMARTCARD Extended Exported Functions
  * @{
  */

/** @defgroup SMARTCARDEx_Exported_Functions_Group1 Extended Peripheral Control functions
  * @brief    扩展控制函数
  *
@verbatim
  ===============================================================================
                      ##### 外设控制函数 #####
  ===============================================================================
  [..]
  本节提供一组用于初始化SMARTCARD的函数。
     (+) HAL_SMARTCARDEx_BlockLength_Config() API允许动态配置块长度
     (+) HAL_SMARTCARDEx_TimeOut_Config() API允许动态配置接收器超时值
     (+) HAL_SMARTCARDEx_EnableReceiverTimeOut() API使能接收器超时功能
     (+) HAL_SMARTCARDEx_DisableReceiverTimeOut() API禁用接收器超时功能

@endverbatim
  * @{
  */

/** @brief 动态更新RTOR寄存器中的SMARTCARD块长度。
  * @param hsmartcard 指向SMARTCARD_HandleTypeDef结构的指针，包含
  *                    指定SMARTCARD模块的配置信息。
  * @param BlockLength SMARTCARD块长度（最多8位）
  * @retval None
  */
void HAL_SMARTCARDEx_BlockLength_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint8_t BlockLength)
{
  MODIFY_REG(hsmartcard->Instance->RTOR, USART_RTOR_BLEN, ((uint32_t)BlockLength << USART_RTOR_BLEN_Pos));
}

/** @brief 动态更新RTOR寄存器中的接收器超时值。
  * @param hsmartcard 指向SMARTCARD_HandleTypeDef结构的指针，包含
  *                    指定SMARTCARD模块的配置信息。
  * @param TimeOutValue 接收器超时值，以波特块数为单位。超时
  *                     值必须小于或等于0x0FFFFFFFF。
  * @retval None
  */
void HAL_SMARTCARDEx_TimeOut_Config(SMARTCARD_HandleTypeDef *hsmartcard, uint32_t TimeOutValue)
{
  assert_param(IS_SMARTCARD_TIMEOUT_VALUE(hsmartcard->Init.TimeOutValue));
  MODIFY_REG(hsmartcard->Instance->RTOR, USART_RTOR_RTO, TimeOutValue);
}

/** @brief 使能SMARTCARD接收器超时功能。
  * @param hsmartcard 指向SMARTCARD_HandleTypeDef结构的指针，包含
  *                    指定SMARTCARD模块的配置信息。
  * @retval HAL状态
  */
HAL_StatusTypeDef HAL_SMARTCARDEx_EnableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard)
{
  if (hsmartcard->gState == HAL_SMARTCARD_STATE_READY)
  {
/* Process Locked */
    __HAL_LOCK(hsmartcard);

    hsmartcard->gState = HAL_SMARTCARD_STATE_BUSY;

/* Set the USART RTOEN bit */
    SET_BIT(hsmartcard->Instance->CR2, USART_CR2_RTOEN);

    hsmartcard->gState = HAL_SMARTCARD_STATE_READY;

/* Process Unlocked */
    __HAL_UNLOCK(hsmartcard);

    return HAL_OK;
  }
  else
  {
    return HAL_BUSY;
  }
}

/** @brief 禁用SMARTCARD接收器超时功能。
  * @param hsmartcard 指向SMARTCARD_HandleTypeDef结构的指针，包含
  *                    指定SMARTCARD模块的配置信息。
  * @retval HAL状态
  */
HAL_StatusTypeDef HAL_SMARTCARDEx_DisableReceiverTimeOut(SMARTCARD_HandleTypeDef *hsmartcard)
{
  if (hsmartcard->gState == HAL_SMARTCARD_STATE_READY)
  {
/* Process Locked */
    __HAL_LOCK(hsmartcard);

    hsmartcard->gState = HAL_SMARTCARD_STATE_BUSY;

/* Clear the USART RTOEN bit */
    CLEAR_BIT(hsmartcard->Instance->CR2, USART_CR2_RTOEN);

    hsmartcard->gState = HAL_SMARTCARD_STATE_READY;

/* Process Unlocked */
    __HAL_UNLOCK(hsmartcard);

    return HAL_OK;
  }
  else
  {
    return HAL_BUSY;
  }
}

/**
  * @}
  */

/** @defgroup SMARTCARDEx_Exported_Functions_Group2 Extended Peripheral IO operation functions
  * @brief   SMARTCARD传输和接收函数
  *
@verbatim
 ===============================================================================
                      ##### IO操作函数 #####
 ===============================================================================
    [..]
    本节提供一组与FIFO模式相关的回调函数。

    (#) TX/RX FIFO回调：
        (++) HAL_SMARTCARDEx_RxFifoFullCallback()
        (++) HAL_SMARTCARDEx_TxFifoEmptyCallback()

@endverbatim
  * @{
  */

/**
  * @brief  SMARTCARD RX FIFO满回调。
  * @param  hsmartcard 指向SMARTCARD_HandleTypeDef结构的指针，包含
  *                   指定SMARTCARD模块的配置信息。
  * @retval None
  */