stm32g4xx_hal_tim.c

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_tim.c
  * @author  MCD Application Team
  * @brief   TIM HAL 模块驱动程序。
  *          此文件提供固件函数，用于管理定时器 (TIM) 外设的以下功能：
  *           + TIM 时间基准初始化
  *           + TIM 时间基准启动
  *           + TIM 时间基准启动中断
  *           + TIM 时间基准启动 DMA
  *           + TIM 输出比较/PWM 初始化
  *           + TIM 输出比较/PWM 通道配置
  *           + TIM 输出比较/PWM  启动
  *           + TIM 输出比较/PWM  启动中断
  *           + TIM 输出比较/PWM 启动 DMA
  *           + TIM 输入捕获初始化
  *           + TIM 输入捕获通道配置
  *           + TIM 输入捕获启动
  *           + TIM 输入捕获启动中断
  *           + TIM 输入捕获启动 DMA
  *           + TIM 单脉冲初始化
  *           + TIM 单脉冲通道配置
  *           + TIM 单脉冲启动
  *           + TIM 编码器接口初始化
  *           + TIM 编码器接口启动
  *           + TIM 编码器接口启动中断
  *           + TIM 编码器接口启动 DMA
  *           + 使用中断和 DMA 进行换向事件配置
  *           + TIM OCRef 清除配置
  *           + TIM 外部时钟配置
  ******************************************************************************
  * @attention
  *
  * Copyright (c) 2019 STMicroelectronics.
  * 保留所有权利。
  *
  * 本软件的许可条款可在本软件组件根目录下的 LICENSE 文件中找到。
  * 如果本软件未附带 LICENSE 文件，则按原样提供。
  *
  ******************************************************************************
  @verbatim
  ==============================================================================
                      ##### 定时器通用功能 #####
  ==============================================================================
  [..] 定时器功能包括：
       (#) 16位向上、向下、向上/向下自动重载计数器。
       (#) 16位可编程预分频器，允许将计数器时钟频率分频（也可在运行时进行），
           分频系数为1到65536之间的任意值。
       (#) 最多4个独立通道，用于：
           (++) 输入捕获
           (++) 输出比较
           (++) PWM生成（边沿和中心对齐模式）
           (++) 单脉冲模式输出
       (#) 同步电路，用于使用外部信号控制定时器以及将多个定时器互连。
       (#) 支持用于定位目的的增量编码器

            ##### 如何使用此驱动程序 #####
  ==============================================================================
    [..]
     (#) 通过实现以下函数来初始化 TIM 底层资源，具体取决于所选功能：
           (++) 时间基准 : HAL_TIM_Base_MspInit()
           (++) 输入捕获 : HAL_TIM_IC_MspInit()
           (++) 输出比较 : HAL_TIM_OC_MspInit()
           (++) PWM生成 : HAL_TIM_PWM_MspInit()
           (++) 单脉冲模式输出 : HAL_TIM_OnePulse_MspInit()
           (++) 编码器模式输出 : HAL_TIM_Encoder_MspInit()

     (#) 初始化 TIM 底层资源：
        (##) 使用 __HAL_RCC_TIMx_CLK_ENABLE(); 启用 TIM 接口时钟。
        (##) TIM 引脚配置
            (+++) 使用以下函数启用 TIM GPIO 的时钟：
             __HAL_RCC_GPIOx_CLK_ENABLE();
            (+++) 使用 HAL_GPIO_Init() 将这些 TIM 引脚配置为复用功能模式；

     (#) 如果需要，可以配置外部时钟（默认时钟为来自 APBx 的内部时钟），
         使用以下函数：HAL_TIM_ConfigClockSource，时钟配置应在任何启动函数之前完成。

     (#) 使用此驱动程序的初始化函数之一，将 TIM 配置为所需的工作模式：
       (++) HAL_TIM_Base_Init：使用定时器生成简单的时间基准
       (++) HAL_TIM_OC_Init、HAL_TIM_OC_ConfigChannel 以及可选的 HAL_TIMEx_OC_ConfigPulseOnCompare：
            使用定时器生成输出比较信号。
       (++) HAL_TIM_PWM_Init 和 HAL_TIM_PWM_ConfigChannel：使用定时器生成 PWM 信号。
       (++) HAL_TIM_IC_Init 和 HAL_TIM_IC_ConfigChannel：使用定时器测量外部信号。
       (++) HAL_TIM_OnePulse_Init 和 HAL_TIM_OnePulse_ConfigChannel：使用定时器在单脉冲模式下工作。
       (++) HAL_TIM_Encoder_Init：使用定时器编码器接口。

     (#) 根据所使用的功能，使用以下启动函数之一激活 TIM 外设：
           (++) 时间基准 : HAL_TIM_Base_Start(), HAL_TIM_Base_Start_DMA(), HAL_TIM_Base_Start_IT()
           (++) 输入捕获 :  HAL_TIM_IC_Start(), HAL_TIM_IC_Start_DMA(), HAL_TIM_IC_Start_IT()
           (++) 输出比较 : HAL_TIM_OC_Start(), HAL_TIM_OC_Start_DMA(), HAL_TIM_OC_Start_IT()
           (++) PWM生成 : HAL_TIM_PWM_Start(), HAL_TIM_PWM_Start_DMA(), HAL_TIM_PWM_Start_IT()
           (++) 单脉冲模式输出 : HAL_TIM_OnePulse_Start(), HAL_TIM_OnePulse_Start_IT()
           (++) 编码器模式输出 : HAL_TIM_Encoder_Start(), HAL_TIM_Encoder_Start_DMA(), HAL_TIM_Encoder_Start_IT().

     (#) DMA 突发传输由以下两个函数管理：
         HAL_TIM_DMABurst_WriteStart()
         HAL_TIM_DMABurst_ReadStart()

    *** 回调注册 ***
  =============================================

  [..]
  编译定义 USE_HAL_TIM_REGISTER_CALLBACKS 设置为 1 时，
  允许用户动态配置驱动程序回调。

  [..]
  使用函数 HAL_TIM_RegisterCallback() 注册回调。
  HAL_TIM_RegisterCallback() 的参数为 HAL 外设句柄、
  回调 ID 和指向用户回调函数的指针。

  [..]
  使用函数 HAL_TIM_UnRegisterCallback() 将回调重置为默认的弱函数。
  HAL_TIM_UnRegisterCallback 的参数为 HAL 外设句柄和回调 ID。

  [..]
  这些函数允许注册/注销以下回调：
    (+) Base_MspInitCallback              : TIM 基础 Msp 初始化回调。
    (+) Base_MspDeInitCallback            : TIM 基础 Msp 反初始化回调。
    (+) IC_MspInitCallback                : TIM 输入捕获 Msp 初始化回调。
    (+) IC_MspDeInitCallback              : TIM 输入捕获 Msp 反初始化回调。
    (+) OC_MspInitCallback                : TIM 输出比较 Msp 初始化回调。
    (+) OC_MspDeInitCallback              : TIM 输出比较 Msp 反初始化回调。
    (+) PWM_MspInitCallback               : TIM PWM Msp 初始化回调。
    (+) PWM_MspDeInitCallback             : TIM PWM Msp 反初始化回调。
    (+) OnePulse_MspInitCallback          : TIM 单脉冲 Msp 初始化回调。
    (+) OnePulse_MspDeInitCallback        : TIM 单脉冲 Msp 反初始化回调。
    (+) Encoder_MspInitCallback           : TIM 编码器 Msp 初始化回调。
    (+) Encoder_MspDeInitCallback         : TIM 编码器 Msp 反初始化回调。
    (+) HallSensor_MspInitCallback        : TIM 霍尔传感器 Msp 初始化回调。
    (+) HallSensor_MspDeInitCallback      : TIM 霍尔传感器 Msp 反初始化回调。
    (+) PeriodElapsedCallback             : TIM 周期溢出回调。
    (+) PeriodElapsedHalfCpltCallback     : TIM 周期溢出半完成回调。
    (+) TriggerCallback                   : TIM 触发回调。
    (+) TriggerHalfCpltCallback           : TIM 触发半完成回调。
    (+) IC_CaptureCallback                : TIM 输入捕获回调。
    (+) IC_CaptureHalfCpltCallback        : TIM 输入捕获半完成回调。
    (+) OC_DelayElapsedCallback           : TIM 输出比较延迟溢出回调。
    (+) PWM_PulseFinishedCallback         : TIM PWM 脉冲完成回调。
    (+) PWM_PulseFinishedHalfCpltCallback : TIM PWM 脉冲半完成回调。
    (+) ErrorCallback                     : TIM 错误回调。
    (+) CommutationCallback               : TIM 换向回调。
    (+) CommutationHalfCpltCallback       : TIM 换向半完成回调。
    (+) BreakCallback                     : TIM 刹车回调。
    (+) Break2Callback                    : TIM 刹车2回调。
    (+) EncoderIndexCallback              : TIM 编码器索引回调。
    (+) DirectionChangeCallback           : TIM 方向改变回调
    (+) IndexErrorCallback                : TIM 索引错误回调。
    (+) TransitionErrorCallback           : TIM 转换错误回调

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

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

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

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

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

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

/** @addtogroup STM32G4xx_HAL_Driver