CN / EN

全部 创新产品 应用与设计 文档中心 工具与软件 开发者社区 关于汇顶
文档反馈
感谢关注汇顶文档，期待您的宝贵建议！
感谢您的反馈，祝您愉快！
无匹配项 共计114个匹配页面
文档中心 > GR551x HAL及LL驱动用户手册/ HAL驱动/ HAL PWM通用驱动/ PWM驱动API描述 Copy URL

PWM驱动API描述

PWM驱动的API主要包括：

表 325 PWM驱动的APIs
API类别 API名称 描述
初始化 hal_pwm_init() 初始化PWM外设，配置输出参数。
hal_pwm_deinit() 反初始化PWM外设。
hal_pwm_msp_init() 初始化PWM外设所使用的GPIO。
hal_pwm_msp_deinit() 反初始化PWM外设所使用的GPIO。
IO操作 hal_pwm_start() 使能PWM输出。
hal_pwm_stop() 停止PWM输出。
hal_pwm_update_freq() 更新PWM输出频率。
hal_pwm_config_channel() 配置PWM通道参数。
状态及错误 hal_pwm_get_state() 获取驱动运行状态。
睡眠相关 hal_pwm_suspend_reg() 睡眠时挂起PWM配置相关的寄存器。
hal_pwm_resume_reg() 唤醒时恢复PWM配置相关的寄存器。

下面章节将对各API进行详细描述。

hal_pwm_init

表 326 hal_pwm_init接口
函数原型

hal_status_t hal_pwm_init(pwm_handle_t *p_pwm)
功能说明

根据pwm_init_t里的参数初始化PWM外设和初始化关联句柄。
输入参数

p_pwm：指向pwm_handle_t结构体变量的指针，该结构体变量包含指定的PWM的配置信息。
返回值

HAL状态。
备注

hal_pwm_deinit

表 327 hal_pwm_deinit接口
函数原型

hal_status_t hal_pwm_deinit(pwm_handle_t *p_pwm)
功能说明

反初始化PWM外设。
输入参数

p_pwm：指向pwm_handle_t结构体变量的指针，该结构体变量包含指定的PWM的配置信息。
返回值

HAL状态。
备注

hal_pwm_msp_init

表 328 hal_pwm_msp_init接口
函数原型

void hal_pwm_msp_init(pwm_handle_t *p_pwm)
功能说明

初始化PWM外设所使用的GPIO等配置。
输入参数

p_pwm：指向pwm_handle_t结构体变量的指针。
返回值

无
备注

该函数为weak类型的空函数，开发者需重写该API完成GPIO的初始化。

hal_pwm_msp_deinit

表 329 hal_pwm_msp_deinit接口
函数原型

void hal_pwm_msp_deinit(pwm_handle_t *p_pwm)
功能说明

反初始化PWM外设所使用的GPIO等配置。
输入参数

p_pwm：指向pwm_handle_t结构体变量的指针。
返回值

无
备注

该函数为weak类型的空函数，开发者需重写该API完成GPIO的反初始化。

hal_pwm_start

表 330 hal_pwm_start接口
函数原型

hal_status_t hal_pwm_start(pwm_handle_t *p_pwm)
功能说明

使能PWM输出。
输入参数

p_pwm：指向pwm_handle_t结构体变量的指针，该结构体变量包含指定的PWM的配置信息。
返回值

HAL状态。
备注

当输出通道的参数配置好后调用该接口，PWM通道输出波形。

hal_pwm_stop

表 331 hal_pwm_stop接口
函数原型

hal_status_t hal_pwm_stop(pwm_handle_t *p_pwm)
功能说明

停止PWM输出
输入参数

p_pwm：指向pwm_handle_t结构体变量的指针，该结构体变量包含指定的PWM的配置信息。
返回值

HAL状态。
备注

PWM输出波形时，调用该接口可以停止PWM波形输出。

hal_pwm_update_freq

表 332 hal_pwm_update_freq接口
函数原型

hal_status_t hal_pwm_update_freq(pwm_handle_t *p_pwm, uint32_t freq)
功能说明

更新PWM输出频率
输入参数

p_pwm：指向pwm_handle_t结构体变量的指针，该结构体变量包含指定的PWM的配置信息。

freq：输出频率。取值范围：1 ～ 32000000，建议小于500000。
返回值

HAL状态。
备注

PWM输出波形时，调用该接口可以改变PWM波形输出频率。

hal_pwm_config_channel

表 333 hal_pwm_config_channel接口
函数原型

hal_status_t hal_pwm_config_channel(pwm_handle_t *p_pwm, pwm_channel_init_t *p_config, hal_pwm_active_channel_t channel)
功能说明

配置PWM输出通道。
输入参数

p_pwm：指向pwm_handle_t结构体变量的指针，该结构体变量包含指定的PWM的配置信息。

p_config：指向pwm_channel_init_t结构体变量的指针，该结构体变量包含PWM通道的配置信息。

channel：待配置的通道。
返回值

HAL状态。
备注

PWM输出停止时，调用该接口可以重新配置通道参数。

hal_pwm_get_state

表 334 hal_pwm_get_state接口
函数原型

hal_pwm_state_t hal_pwm_get_state(pwm_handle_t *p_pwm)
功能说明

获取PWM运行状态。
输入参数

p_pwm：指向pwm_handle_t结构体变量的指针，该结构体变量包含指定的PWM的配置信息。
返回值

PWM运行状态，参数的取值可以是下列值中的任意一个：

  • HAL_PWM_STATE_RESET（未初始化）
  • HAL_PWM_STATE_READY（已初始化且空闲）
  • HAL_PWM_STATE_BUSY（忙）
  • HAL_PWM_STATE_ERROR（错误）
备注

hal_pwm_suspend_reg

表 335 hal_pwm_suspend_reg接口
函数原型 hal_status_t hal_pwm_suspend_reg(pwm_handle_t *p_pwm)
功能说明 睡眠时挂起PWM配置相关的寄存器。
输入参数 p_pwm：指向pwm_handle_t结构体变量的指针，该结构体变量包含指定的PWM的配置信息。
返回值

PWM运行状态，参数的取值可以是下列值中的任意一个：

  • HAL_PWM_STATE_RESET（未初始化）
  • HAL_PWM_STATE_READY（已初始化且空闲）
  • HAL_PWM_STATE_BUSY（忙）
  • HAL_PWM_STATE_ERROR（错误）
备注

hal_pwm_resume_reg

表 336 hal_pwm_resume_reg接口
函数原型 hal_status_t hal_pwm_resume_reg(pwm_handle_t *p_pwm)
功能说明 唤醒时恢复PWM配置相关的寄存器。
输入参数 p_pwm：指向pwm_handle_t结构体变量的指针，该结构体变量包含指定的PWM的配置信息。
返回值

PWM运行状态，参数的取值可以是下列值中的任意一个：

  • HAL_PWM_STATE_RESET（未初始化）
  • HAL_PWM_STATE_READY（已初始化且空闲）
  • HAL_PWM_STATE_BUSY（忙）
  • HAL_PWM_STATE_ERROR（错误）
备注

扫描关注

打开微信，使用“扫一扫”即可关注。