A59 STM32_HAL库函数之 TIM扩展驱动 -- A -- 所有函数的介绍及使用

1 该驱动函数预览
- 1.1 HAL_TIMEx_HallSensor_Init
- 1.2 HAL_TIMEx_HallSensor_DeInit
- 1.3 HAL_TIMEx_HallSensor_MspInit
- 1.4 HAL_TIMEx_HallSensor_MspDeInit
- 1.5 HAL_TIMEx_HallSensor_Start
- 1.6 HAL_TIMEx_HallSensor_Stop
- 1.7 HAL_TIMEx_HallSensor_Start_IT
- 1.8 HAL_TIMEx_HallSensor_Stop_IT
- 1.9 HAL_TIMEx_HallSensor_Start_DMA
- 1.10 HAL_TIMEx_HallSensor_Stop_DMA
- 1.11 HAL_TIMEx_OCN_Start
该文档修改记录：
总结

1 该驱动函数预览

序号	函数名	描述
1	HAL_TIMEx_HallSensor_Init()	初始化定时器霍尔传感器模式。
2	HAL_TIMEx_HallSensor_DeInit()	反初始化定时器霍尔传感器模式。
3	HAL_TIMEx_HallSensor_MspInit()	初始化定时器霍尔传感器模式相关的MCU外设引脚或资源。
4	HAL_TIMEx_HallSensor_MspDeInit()	反初始化定时器霍尔传感器模式相关的MCU外设引脚或资源。
5	HAL_TIMEx_HallSensor_Start()	启动定时器霍尔传感器模式。
6	HAL_TIMEx_HallSensor_Stop()	停止定时器霍尔传感器模式。
7	HAL_TIMEx_HallSensor_Start_IT()	启动定时器霍尔传感器模式中断。
8	HAL_TIMEx_HallSensor_Stop_IT()	停止定时器霍尔传感器模式中断。
9	HAL_TIMEx_HallSensor_Start_DMA()	启动定时器霍尔传感器模式DMA传输。
10	HAL_TIMEx_HallSensor_Stop_DMA()	停止定时器霍尔传感器模式DMA传输。
11	HAL_TIMEx_OCN_Start()	启动定时器OCN功能。
12	HAL_TIMEx_OCN_Stop()	停止定时器OCN功能。
13	HAL_TIMEx_OCN_Start_IT()	启动定时器OCN功能中断。
14	HAL_TIMEx_OCN_Stop_IT()	停止定时器OCN功能中断。
15	HAL_TIMEx_OCN_Start_DMA()	启动定时器OCN功能DMA传输。
16	HAL_TIMEx_OCN_Stop_DMA()	停止定时器OCN功能DMA传输。
17	HAL_TIMEx_PWMN_Start()	启动定时器PWMN功能。
18	HAL_TIMEx_PWMN_Stop()	停止定时器PWMN功能。
19	HAL_TIMEx_PWMN_Start_IT()	启动定时器PWMN功能中断。
20	HAL_TIMEx_PWMN_Stop_IT()	停止定时器PWMN功能中断。
21	HAL_TIMEx_PWMN_Start_DMA()	启动定时器PWMN功能DMA传输。
22	HAL_TIMEx_PWMN_Stop_DMA()	停止定时器PWMN功能DMA传输。
23	HAL_TIMEx_OnePulseN_Start()	启动定时器单脉冲N功能。
24	HAL_TIMEx_OnePulseN_Stop()	停止定时器单脉冲N功能。
25	HAL_TIMEx_OnePulseN_Start_IT()	启动定时器单脉冲N功能中断。
26	HAL_TIMEx_OnePulseN_Stop_IT()	停止定时器单脉冲N功能中断。
27	HAL_TIMEx_ConfigCommutationEvent()	配置定时器换相事件。
28	HAL_TIMEx_ConfigCommutationEvent_IT()	配置定时器换相事件并启用中断。
29	HAL_TIMEx_ConfigCommutationEvent_DMA()	配置定时器换相事件DMA传输。
30	HAL_TIMEx_ConfigBreakDeadTime()	配置定时器死区和断路器。
31	HAL_TIMEx_MasterConfigSynchronization()	配置定时器主模式同步。
32	HAL_TIMEx_CommutationCallback()	定时器换相回调函数。
33	HAL_TIMEx_BreakCallback()	定时器断路器回调函数。
34	TIMEx_DMACommutationCplt()	定时器换相DMA传输完成回调函数。
35	HAL_TIMEx_HallSensor_GetState()	获取定时器霍尔传感器模式状态。

1.1 HAL_TIMEx_HallSensor_Init

函数名	HAL_TIMEx_HallSensor_Init
函数原形	HAL_StatusTypeDef HAL_TIMEx_HallSensor_Init(TIM_HandleTypeDef htim, TIM_HallSensor_InitTypeDef sConfig)
功能描述	初始化TIM外部霍尔传感器模式
输入参数	htim：TIM句柄结构体指针
	sConfig：TIM外部霍尔传感器配置结构体指针
输出参数	无
返回值	HAL_StatusTypeDef：初始化状态
先决条件	无
被调用函数	无
案例	```c
	TIM_HandleTypeDef htim;
	TIM_HallSensor_InitTypeDef sConfig;
	HAL_TIMEx_HallSensor_Init(&htim, &sConfig);
```

1.2 HAL_TIMEx_HallSensor_DeInit

函数名	HAL_TIMEx_HallSensor_DeInit
函数原形	HAL_StatusTypeDef HAL_TIMEx_HallSensor_DeInit(TIM_HandleTypeDef *htim)
功能描述	反初始化TIM外部霍尔传感器模式
输入参数	htim：TIM句柄结构体指针
输出参数	无
返回值	HAL_StatusTypeDef：反初始化状态
先决条件	无
被调用函数	无
案例	```c
	TIM_HandleTypeDef htim;
	HAL_TIMEx_HallSensor_DeInit(&htim);
```

1.3 HAL_TIMEx_HallSensor_MspInit

函数名	HAL_TIMEx_HallSensor_MspInit
函数原形	void HAL_TIMEx_HallSensor_MspInit(TIM_HandleTypeDef *htim)
功能描述	初始化TIM外部霍尔传感器模式的底层外设依赖
输入参数	htim：TIM句柄结构体指针
输出参数	无
返回值	无
先决条件	无
被调用函数	无
案例	```c
	TIM_HandleTypeDef htim;
	HAL_TIMEx_HallSensor_MspInit(&htim);
```

1.4 HAL_TIMEx_HallSensor_MspDeInit

函数名	HAL_TIMEx_HallSensor_MspDeInit
函数原形	void HAL_TIMEx_HallSensor_MspDeInit(TIM_HandleTypeDef *htim)
功能描述	反初始化TIM外部霍尔传感器模式的底层外设依赖
输入参数	htim：TIM句柄结构体指针
输出参数	无
返回值	无
先决条件	无
被调用函数	无
案例	```c
	TIM_HandleTypeDef htim;
	HAL_TIMEx_HallSensor_MspDeInit(&htim);
```

1.5 HAL_TIMEx_HallSensor_Start

函数名	HAL_TIMEx_HallSensor_Start
函数原形	HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start(TIM_HandleTypeDef *htim)
功能描述	启动TIM外部霍尔传感器模式
输入参数	htim：TIM句柄结构体指针
输出参数	无
返回值	HAL_StatusTypeDef：启动状态
先决条件	无
被调用函数	无
案例	```c
	TIM_HandleTypeDef htim;
	HAL_TIMEx_HallSensor_Start(&htim);
```

1.6 HAL_TIMEx_HallSensor_Stop

函数名	HAL_TIMEx_HallSensor_Stop
函数原形	HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop(TIM_HandleTypeDef *htim)
功能描述

停止TIM外部霍尔传感器模式 |
| 输入参数 | htim：TIM句柄结构体指针 |
| 输出参数 | 无 |
| 返回值 | HAL_StatusTypeDef：停止状态 |
| 先决条件 | 无 |
| 被调用函数 | 无 |
| 案例 | c | | | TIM_HandleTypeDef htim; | | | HAL_TIMEx_HallSensor_Stop(&htim); | | |

1.7 HAL_TIMEx_HallSensor_Start_IT

函数名	HAL_TIMEx_HallSensor_Start_IT
函数原形	HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_IT(TIM_HandleTypeDef *htim)
功能描述	以中断方式启动TIM外部霍尔传感器模式
输入参数	htim：TIM句柄结构体指针
输出参数	无
返回值	HAL_StatusTypeDef：启动状态
先决条件	无
被调用函数	无
案例	```c
	TIM_HandleTypeDef htim;
	HAL_TIMEx_HallSensor_Start_IT(&htim);
```

1.8 HAL_TIMEx_HallSensor_Stop_IT

函数名	HAL_TIMEx_HallSensor_Stop_IT
函数原形	HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_IT(TIM_HandleTypeDef *htim)
功能描述	以中断方式停止TIM外部霍尔传感器模式
输入参数	htim：TIM句柄结构体指针
输出参数	无
返回值	HAL_StatusTypeDef：停止状态
先决条件	无
被调用函数	无
案例	```c
	TIM_HandleTypeDef htim;
	HAL_TIMEx_HallSensor_Stop_IT(&htim);
```

1.9 HAL_TIMEx_HallSensor_Start_DMA

函数名	HAL_TIMEx_HallSensor_Start_DMA
函数原形	HAL_StatusTypeDef HAL_TIMEx_HallSensor_Start_DMA(TIM_HandleTypeDef htim, uint32_t pData, uint16_t Length)
功能描述	以DMA方式启动TIM外部霍尔传感器模式
输入参数	htim：TIM句柄结构体指针
	pData：数据缓冲区指针
	Length：数据长度
输出参数	无
返回值	HAL_StatusTypeDef：启动状态
先决条件	无
被调用函数	无
案例	```c
	TIM_HandleTypeDef htim;
	uint32_t pData[10];
	HAL_TIMEx_HallSensor_Start_DMA(&htim, pData, 10);
```

1.10 HAL_TIMEx_HallSensor_Stop_DMA

函数名	HAL_TIMEx_HallSensor_Stop_DMA
函数原形	HAL_StatusTypeDef HAL_TIMEx_HallSensor_Stop_DMA(TIM_HandleTypeDef *htim)
功能描述	以DMA方式停止TIM外部霍尔传感器模式
输入参数	htim：TIM句柄结构体指针
输出参数	无
返回值	HAL_StatusTypeDef：停止状态
先决条件	无
被调用函数	无
案例	```c
	TIM_HandleTypeDef htim;
	HAL_TIMEx_HallSensor_Stop_DMA(&htim);
```

1.11 HAL_TIMEx_OCN_Start

函数名	HAL_TIMEx_OCN_Start
函数原形	HAL_StatusTypeDef HAL_TIMEx_OCN_Start(TIM_HandleTypeDef *htim, uint32_t Channel)
功能描述	启动TIM通道的输出比较通知模式
输入参数	htim：TIM句柄结构体指针
	Channel：通道编号
输出参数	无
返回值	HAL_StatusTypeDef：启动状态
先决条件	无
被调用函数	无
案例	```c
	TIM_HandleTypeDef htim;
	HAL_TIMEx_OCN_Start(&htim, TIM_CHANNEL_1);
```