stm32g4xx_hal_hrtim.h

转到此文件的文档。

/**
  ******************************************************************************
  * @file    stm32g4xx_hal_hrtim.h
  * @author  MCD Application Team
  * @brief   Header file of HRTIM HAL module.
  ******************************************************************************
  * @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.
  *
  ******************************************************************************
  */

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef STM32G4xx_HAL_HRTIM_H
#define STM32G4xx_HAL_HRTIM_H

#ifdef __cplusplus
extern "C" {
#endif

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

#if defined(HRTIM1)
/** @addtogroup STM32G4xx_HAL_Driver
  * @{
  */

/** @addtogroup HRTIM HRTIM
  * @{
  */

/* Exported types ------------------------------------------------------------*/
/** @addtogroup HRTIM_Exported_Constants HRTIM 导出的常量
  * @{
  */
/** @defgroup HRTIM_Max_Timer HRTIM 最大定时器
  * @{
  */
#define MAX_HRTIM_TIMER 7U
/**
  * @}
  */
/**
  * @}
  */

/** @defgroup HRTIM_Exported_Types HRTIM 导出的类型
  * @{
  */

/**
  * @brief  HRTIM 配置结构体定义 - 时基相关参数
  */
typedef struct
{
  uint32_t HRTIMInterruptRequests;  /*!< 指定必须为 HRTIM 实例启用的中断请求。
                                          此参数可以是 @ref HRTIM_Common_Interrupt_Enable 的任意组合 */
  uint32_t SyncOptions;              /*!< 指定 HRTIM 实例如何处理外部同步信号。
                                          HRTIM 实例可以配置为从设备（等待触发以同步）或主设备（生成同步信号）或两者。
                                          此参数可以是 @ref HRTIM_Synchronization_Options 的组合。*/
  uint32_t SyncInputSource;          /*!< 指定外部同步输入源（仅在 HRTIM 实例配置为从设备时有效）。
                                          此参数可以是 @ref HRTIM_Synchronization_Input_Source 中的一个值。 */
  uint32_t SyncOutputSource;         /*!< 指定要在外部同步输出上发送的源和事件
                                          （仅在 HRTIM 实例配置为主设备时有效）。
                                          此参数可以是 @ref HRTIM_Synchronization_Output_Source 中的一个值 */
  uint32_t SyncOutputPolarity;       /*!< 指定要在外部同步输出上发送的信号的调理
                                          （仅在 HRTIM 实例配置为主设备时有效）。
                                          此参数可以是 @ref HRTIM_Synchronization_Output_Polarity 中的一个值 */
} HRTIM_InitTypeDef;

/**
  * @brief  HAL 状态结构体定义
  */
typedef enum
{
  HAL_HRTIM_STATE_RESET            = 0x00U,    /*!< 外设尚未初始化                  */
  HAL_HRTIM_STATE_READY            = 0x01U,    /*!< 外设已初始化并准备好使用           */
  HAL_HRTIM_STATE_BUSY             = 0x02U,    /*!< 内部处理正在进行中                     */
  HAL_HRTIM_STATE_TIMEOUT          = 0x06U,    /*!< 超时状态                                      */
  HAL_HRTIM_STATE_ERROR            = 0x07U,    /*!< 错误状态                                        */
#if (USE_HAL_HRTIM_REGISTER_CALLBACKS == 1)
  HAL_HRTIM_STATE_INVALID_CALLBACK = 0x08U    /*!< 无效的回调错误 */
#endif /* USE_HAL_HRTIM_REGISTER_CALLBACKS */
} HAL_HRTIM_StateTypeDef;

/**
  * @brief HRTIM 定时器结构体定义
  */
typedef struct
{
  uint32_t CaptureTrigger1;       /*!< 触发捕获单元 1 的事件。
                                       当定时器在简单模式下运行时，此参数可以是 @ref HRTIM_External_Event_Channels 中的一个值。
                                       当定时器在波形模式下运行时，此参数可以是 @ref HRTIM_Capture_Unit_Trigger 的组合。 */
  uint32_t CaptureTrigger2;       /*!< 触发捕获单元 2 的事件。
                                       当定时器在简单模式下运行时，此参数可以是 @ref HRTIM_External_Event_Channels 中的一个值。
                                       当定时器在波形模式下运行时，此参数可以是 @ref HRTIM_Capture_Unit_Trigger 的组合。 */
  uint32_t InterruptRequests;     /*!< 为定时器启用的中断请求。 */
  uint32_t DMARequests;           /*!< 为定时器启用的 DMA 请求。 */
  uint32_t DMASrcAddress;          /*!< DMA 传输的源地址。 */
  uint32_t DMADstAddress;          /*!< DMA 传输的目的地址。 */
  uint32_t DMASize;                /*!< DMA 传输的大小 */
} HRTIM_TimerParamTypeDef;

/**
  * @brief  HRTIM 句柄结构体定义
  */
#if (USE_HAL_HRTIM_REGISTER_CALLBACKS == 1)
typedef struct __HRTIM_HandleTypeDef
#else
typedef struct
#endif /* USE_HAL_HRTIM_REGISTER_CALLBACKS */
{
  HRTIM_TypeDef               *Instance;                     /*!< 寄存器基地址 */

  HRTIM_InitTypeDef            Init;                         /*!< HRTIM 所需参数 */

  HRTIM_TimerParamTypeDef      TimerParam[MAX_HRTIM_TIMER];  /*!< HRTIM 定时器 - 包括主定时器 - 参数 */

  HAL_LockTypeDef              Lock;                         /*!< 锁定对象          */

  __IO HAL_HRTIM_StateTypeDef  State;                        /*!< HRTIM 通信状态 */

  DMA_HandleTypeDef           *hdmaMaster;                   /*!< 主定时器 DMA 句柄参数 */
  DMA_HandleTypeDef           *hdmaTimerA;                   /*!< 定时器 A DMA 句柄参数 */
  DMA_HandleTypeDef