stm32g4xx_hal_i2c_ex.c

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_i2c_ex.c
  * @author  MCD Application Team
  * @brief   I2C 扩展 HAL 模块驱动程序。
  *          此文件提供固件函数，用于管理 I2C 扩展外设的以下功能：
  *           + 滤波器模式功能
  *           + 唤醒模式功能
  *           + 快速模式增强功能
  *
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2019 STMicroelectronics.
  * 保留所有权利。
  *
  * 本软件根据可在本软件组件根目录中找到的 LICENSE 文件中的条款进行许可。
  * 如果本软件未附带 LICENSE 文件，则按原样提供。
  *
  ******************************************************************************
  @verbatim
  ==============================================================================
               ##### I2C 外设扩展功能 #####
  ==============================================================================

  [..] 与之前的其他器件相比，STM32G4xx 器件的 I2C 接口包含以下附加功能

       (+) 可禁用或启用模拟噪声滤波器
       (+) 使用已配置的数字噪声滤波器
       (+) 禁用或启用从 Stop 模式唤醒
       (+) 禁用或启用快速模式增强

                     ##### 如何使用此驱动程序 #####
  ==============================================================================
  [..] 此驱动程序提供用于配置噪声滤波器和唤醒功能的函数
    (#) 使用函数 HAL_I2CEx_ConfigAnalogFilter() 配置 I2C 模拟噪声滤波器
    (#) 使用函数 HAL_I2CEx_ConfigDigitalFilter() 配置 I2C 数字噪声滤波器
    (#) 使用以下函数配置 I2C 唤醒模式的启用或禁用：
          (++) HAL_I2CEx_EnableWakeUp()
          (++) HAL_I2CEx_DisableWakeUp()
    (#) 使用以下函数配置快速模式增强驱动能力的启用或禁用：
          (++) HAL_I2CEx_EnableFastModePlus()
          (++) HAL_I2CEx_DisableFastModePlus()
  @endverbatim
  */

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

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @defgroup I2CEx I2CEx
  * @brief I2C 扩展 HAL 模块驱动程序
  * @{
  */

#ifdef HAL_I2C_MODULE_ENABLED

/* Private typedef -----------------------------------------------------------*/
/* Private define ------------------------------------------------------------*/
/* Private macro -------------------------------------------------------------*/
/* Private variables ---------------------------------------------------------*/
/* Private function prototypes -----------------------------------------------*/
/* Private functions ---------------------------------------------------------*/

/** @defgroup I2CEx_Exported_Functions I2C 扩展导出函数
  * @{
  */

/** @defgroup I2CEx_Exported_Functions_Group1 滤波器模式函数
  * @brief    滤波器模式函数
  *
@verbatim
 ===============================================================================
                      ##### 滤波器模式函数 #####
 ===============================================================================
    [..] 本节提供允许以下操作的函数：
      (+) 配置噪声滤波器

@endverbatim
  * @{
  */

/**
  * @brief  配置 I2C 模拟噪声滤波器。
  * @param  hi2c 指向包含指定 I2Cx 外设配置信息的 I2C_HandleTypeDef 结构的指针。
  * @param  AnalogFilter 模拟滤波器的新状态。
  * @retval HAL 状态
  */
HAL_StatusTypeDef HAL_I2CEx_ConfigAnalogFilter(I2C_HandleTypeDef *hi2c, uint32_t AnalogFilter)
{
  /* 检查参数 */
  assert_param(IS_I2C_ALL_INSTANCE(hi2c->Instance));
  assert_param(IS_I2C_ANALOG_FILTER(AnalogFilter));

  if (hi2c->State == HAL_I2C_STATE_READY)
  {
    /* 进程已锁定 */
    __HAL_LOCK(hi2c);

    hi2c->State = HAL_I2C_STATE_BUSY;

    /* 禁用所选的 I2C 外设 */
    __HAL_I2C_DISABLE(hi2c);

    /* 复位 I2Cx ANOFF 位 */
    hi2c->Instance->CR1 &= ~(I2C_CR1_ANFOFF);

    /* 设置模拟滤波器位*/
    hi2c->Instance->CR1 |= AnalogFilter;

    __HAL_I2C_ENABLE(hi2c);

    hi2c->State = HAL_I2C_STATE_READY;

    /* 进程已解锁 */
    __HAL_UNLOCK(hi2c);

    return HAL_OK;
  }
  else
  {
    return HAL_BUSY;
  }
}

/**
  * @brief  配置 I2C 数字噪声滤波器。
  * @param  hi2c 指向包含指定 I2Cx 外设配置信息的 I2C_HandleTypeDef 结构的指针。
  * @param  DigitalFilter 数字噪声滤波器的系数，范围在 Min_Data=0x00 和 Max_Data=0x0F 之间。
  * @retval HAL 状态
  */
HAL_StatusTypeDef HAL_I2CEx_ConfigDigitalFilter(I2C_HandleTypeDef *hi2c, uint32_t DigitalFilter)
{
  uint32_t tmpreg;

  /* 检查参数 */
  assert_param(IS_I2C_ALL_INSTANCE(hi2c->Instance));
  assert_param(IS_I2C_DIGITAL_FILTER(DigitalFilter));

  if (hi2c->State == HAL_I2C_STATE_READY)
  {
    /* 进程已锁定 */
    __HAL_LOCK(hi2c);

    hi2c->State = HAL_I2C_STATE_BUSY;

    /* 禁用所选的 I2C 外设 */
    __HAL_I2C_DISABLE(hi2c);

    /* 获取旧的寄存器值 */
    tmpreg = hi2c->Instance->CR1;

    /* 复位 I2Cx DNF 位 [11:8] */
    tmpreg &= ~(I2C_CR1_DNF);

    /* 设置 I2Cx DNF 系数 */
    tmpreg |= DigitalFilter << 8U;

    /* 存储新的寄存器值 */
    hi2c->