stm32g4xx_hal_lptim.c

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_lptim.c
  * @author  MCD Application Team
  * @brief   LPTIM HAL 模块驱动程序。
  *          此文件提供固件函数，用于管理低功耗定时器 (LPTIM) 外设的以下功能：
  *           + 初始化和反初始化功能。
  *           + 轮询模式下的启动/停止操作功能。
  *           + 中断模式下的启动/停止操作功能。
  *           + 读取操作功能。
  *           + 外设状态功能。
  *
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2019 STMicroelectronics.
  * 保留所有权利。
  *
  * 本软件受可在本软件组件根目录下的 LICENSE 文件中找到的条款约束。
  * 如果本软件未附带 LICENSE 文件，则按原样提供。
  *
  ******************************************************************************
  @verbatim
  ==============================================================================
                     ##### 如何使用此驱动程序 #####
  ==============================================================================
    [..]
      LPTIM HAL 驱动程序可按如下方式使用：

      (#) 通过实现 HAL_LPTIM_MspInit() 来初始化 LPTIM 底层资源：
         (++) 使用 __HAL_RCC_LPTIMx_CLK_ENABLE() 使能 LPTIM 接口时钟。
         (++) 如果使用中断（例如 HAL_LPTIM_PWM_Start_IT()）：
             (+++) 使用 HAL_NVIC_SetPriority() 配置 LPTIM 中断优先级。
             (+++) 使用 HAL_NVIC_EnableIRQ() 使能 LPTIM IRQ 处理程序。
             (+++) 在 LPTIM IRQ 处理程序中，调用 HAL_LPTIM_IRQHandler()。

      (#) 使用 HAL_LPTIM_Init() 初始化 LPTIM HAL。此函数主要配置：
         (++) 实例：LPTIM1。
         (++) 时钟：计数器时钟。
             (+++) 源：可以是 ULPTIM 输入 (IN1) 或内部时钟之一（APB、LSE 或 LSI）。
             (+++) 预分频器：选择时钟分频器。
         (++) UltraLowPowerClock：仅在选择 ULPTIM 作为计数器时钟源时使用。
             (+++) 极性：如果选择 ULPTIM 输入，则为计数器单元的有效边沿极性。
             (+++) 采样时间：用于配置时钟毛刺滤波器的时钟采样时间。
         (++) 触发：计数器如何启动。
             (+++) 源：触发可以是软件或硬件触发之一。
             (+++) 有效边沿：仅适用于硬件触发。
             (+++) 采样时间：用于配置触发毛刺滤波器的触发采样时间。
         (++) 输出极性：可以使用两种相反的极性。
         (++) 更新模式：指定自动重装载值和比较值的更新是立即进行还是在当前周期结束后进行。
         (++) Input1Source：为输入1选择的源（GPIO 或比较器输出）。
         (++) Input2Source：为输入2选择的源（GPIO 或比较器输出）。输入2仅用于编码器功能，因此仅适用于 LPTIM1 实例。

      (#) 提供六种模式：

         (++) PWM 模式：要生成具有指定周期和脉冲的 PWM 信号，请调用 HAL_LPTIM_PWM_Start() 或用于中断模式的 HAL_LPTIM_PWM_Start_IT()。

         (++) 单脉冲模式：要生成响应于激励的具有指定宽度的脉冲，请调用 HAL_LPTIM_OnePulse_Start() 或用于中断模式的 HAL_LPTIM_OnePulse_Start_IT()。

         (++) 单次设置模式：在此模式下，当发生比较匹配时，输出会改变电平（如果输出极性配置为高，则从低电平变为高电平，否则相反）。要启动此模式，请调用 HAL_LPTIM_SetOnce_Start() 或用于中断模式的 HAL_LPTIM_SetOnce_Start_IT()。

         (++) 编码器模式：要使用编码器接口，请调用 HAL_LPTIM_Encoder_Start() 或用于中断模式的 HAL_LPTIM_Encoder_Start_IT()。仅适用于 LPTIM1 实例。

         (++) 超时模式：所选触发输入上的有效边沿会重置计数器。第一个触发事件将启动定时器，任何后续触发事件都将重置计数器，定时器将重新启动。要启动此模式，请调用 HAL_LPTIM_TimeOut_Start_IT() 或用于中断模式的 HAL_LPTIM_TimeOut_Start_IT()。

         (++) 计数器模式：计数器可用于计算 LPTIM Input1 上的外部事件，或用于计算内部时钟周期。要启动此模式，请调用 HAL_LPTIM_Counter_Start() 或用于中断模式的 HAL_LPTIM_Counter_Start_IT()。


      (#) 用户可以通过调用相应的 API 来停止任何进程：HAL_LPTIM_Xxx_Stop() 或如果进程已在中断模式下启动，则调用 HAL_LPTIM_Xxx_Stop_IT()。

      (#) 使用 HAL_LPTIM_DeInit() 反初始化 LPTIM 外设。

    *** 回调注册 ***
  =============================================
  [..]
  编译定义 USE_HAL_LPTIM_REGISTER_CALLBACKS 设置为 1 时，允许用户动态配置驱动程序回调。
  [..]
  使用函数 HAL_LPTIM_RegisterCallback() 注册回调。HAL_LPTIM_RegisterCallback() 的参数为 HAL 外设句柄、回调 ID 和指向用户回调函数的指针。
  [..]
  使用函数 HAL_LPTIM_UnRegisterCallback() 将回调重置为默认弱函数。HAL_LPTIM_UnRegisterCallback 的参数为 HAL 外设句柄和回调 ID。
  [..]
  这些函数允许注册/注销以下回调：

    (+) MspInitCallback         : LPTIM 基础 Msp 初始化回调。
    (+) MspDeInitCallback       : LPTIM 基础 Msp 反初始化回调。
    (+) CompareMatchCallback    : 比较匹配回调。
    (+) AutoReloadMatchCallback : 自动重装载匹配回调。
    (+) TriggerCallback         : 外部触发事件检测回调。
    (+) CompareWriteCallback    : 比较寄存器写入完成回调。
    (+) AutoReloadWriteCallback : 自动重装载寄存器写入完成回调。
    (+) DirectionUpCallback     : 向上计数方向改变回调。
    (+) DirectionDownCallback   : 向下计数方向改变回调。

  [..]
  默认情况下，初始化后且状态为 HAL_LPTIM_STATE_RESET 时，所有中断回调都设置为相应的弱函数：例如 HAL_LPTIM_TriggerCallback()、HAL_LPTIM_CompareMatchCallback()。

  [..]
  MspInit 和 MspDeInit 函数的例外情况是，仅当这些回调为空（未事先注册）时，才会在 Init/DeInit 中重置为传统弱功能。如果 MspInit 或 MspDeInit 不为空，则 Init/DeInit 会保留并使用用户 MspInit/MspDeInit 回调（事先注册）。

  [..]
  回调只能在 HAL_LPTIM_STATE_READY 状态下注册/注销。MspInit/MspDeInit 的例外情况是，可以在 HAL_LPTIM_STATE_READY 或 HAL_LPTIM_STATE_RESET 状态下注册/注销，因此注册的（用户）MspInit/DeInit 回调可在 Init/DeInit 期间使用。在这种情况下，请在调用 DeInit 或 Init 函数之前，先使用 HAL_LPTIM_RegisterCallback() 注册 MspInit/MspDeInit 用户回调。

  [..]
  当编译定义 USE_HAL_LPTIM_REGISTER_CALLBACKS 设置为 0 或未定义时，回调注册功能不可用，所有回调都设置为相应的弱函数。

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

/* 包含 ------------------------------------------------------------------*/
#include "stm32g4xx_hal.h"

/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @defgroup LPTIM LPTIM
  * @brief LPTIM HAL 模块驱动程序。
  * @{
  */

#ifdef HAL_LPTIM_MODULE_ENABLED



/* 私有类型定义 -----------------------------------------------------------*/
/* 私有定义 ------------------------------------------------------------*/
/** @addtogroup LPTIM_Private_Constants
  * @{
  */
#define TIMEOUT                                     1000UL /* 超时时间为 1 秒 */
/**
  * @}
  */

/* 私有宏 -------------------------------------------------------------*/
/* 私有变量 ---------------------------------------------------------*/
/* 私有函数原型 -----------------------------------------------*/
#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
static void LPTIM_ResetCallback(LPTIM_HandleTypeDef *lptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
static HAL_StatusTypeDef LPTIM_WaitForFlag(const LPTIM_HandleTypeDef *hlptim, uint32_t flag);

/* 导出函数 --------------------------------------------------------*/

/** @defgroup LPTIM_Exported_Functions LPTIM 导出函数
  * @{
  */

/** @defgroup LPTIM_Exported_Functions_Group1 初始化/反初始化函数
  *  @brief    初始化和配置函数。
  *
@verbatim
  ==============================================================================
              ##### 初始化和反初始化函数 #####
  ==============================================================================
    [..]  本节提供允许以下操作的函数：
      (+) 根据 LPTIM_InitTypeDef 中指定的参数初始化 LPTIM 并初始化关联的句柄。
      (+) 反初始化 LPTIM 外设。
      (+) 初始化 LPTIM MSP。
      (+) 反初始化 LPTIM MSP。

@endverbatim
  * @{
  */

/**