XFusion API v1.3.0
载入中...
搜索中...
未找到
结构体 | 类型定义 | 枚举 | 函数
pwm
xf_hal

脉冲宽度调制。 更多...

pwm 的协作图:

结构体

struct  _xf_hal_pwm_config_t
 用于对接 pwm 设置的参数。 更多...
 

类型定义

typedef uint32_t xf_pwm_num_t
 pwm 序号。
 
typedef enum _xf_hal_pwm_cmd_t xf_hal_pwm_cmd_t
 用于对接 pwm 设置的命令。
 
typedef struct _xf_hal_pwm_config_t xf_hal_pwm_config_t
 用于对接 pwm 设置的参数。
 

枚举

enum  _xf_hal_pwm_cmd_t {
  XF_HAL_PWM_CMD_DEFAULT = 0x0 , XF_HAL_PWM_CMD_ENABLE = 0x1 << 0 , XF_HAL_PWM_CMD_FREQ = 0x1 << 1 , XF_HAL_PWM_CMD_DUTY = 0x1 << 2 ,
  XF_HAL_PWM_CMD_DUTY_RESOLUTION = 0x1 << 3 , XF_HAL_PWM_CMD_IO_NUM = 0x1 << 4 , XF_HAL_PWM_CMD_ALL = 0x7FFFFFFF
}
 用于对接 pwm 设置的命令。 更多...
 

函数

xf_err_t xf_hal_pwm_init (xf_pwm_num_t pwm_num, uint32_t freq, uint32_t duty)
 pwm 初始化函数。使用 pwm 之前必须要进行初始化。
 
xf_err_t xf_hal_pwm_deinit (xf_pwm_num_t pwm_num)
 pwm 反初始化函数。恢复到未初始化状态且回收相关资源。
 
xf_err_t xf_hal_pwm_enable (xf_pwm_num_t pwm_num)
 pwm 启用函数。启用后，pwm 信号开始输出。
 
xf_err_t xf_hal_pwm_disable (xf_pwm_num_t pwm_num)
 pwm 禁用函数。禁用后，pwm 将不会输出。
 
xf_err_t xf_hal_pwm_set_freq (xf_pwm_num_t pwm_num, uint32_t freq)
 pwm 设置输出频率。
 
xf_err_t xf_hal_pwm_set_duty (xf_pwm_num_t pwm_num, uint32_t duty)
 pwm 设置占空比。
 
xf_err_t xf_hal_pwm_set_duty_resolution (xf_pwm_num_t pwm_num, uint32_t duty_resolution)
 pwm 设置占空比分辨率。
 
xf_err_t xf_hal_pwm_set_gpio (xf_pwm_num_t pwm_num, xf_gpio_num_t io_num)
 pwm 设置 gpio 占空比。
 
uint32_t xf_hal_pwm_get_freq (xf_pwm_num_t pwm_num)
 pwm 获取输出频率。
 
uint32_t xf_hal_pwm_get_duty (xf_pwm_num_t pwm_num)
 pwm 获取占空比。
 
bool xf_hal_pwm_is_enable (xf_pwm_num_t pwm_num)
 pwm 是否启用。
 

详细描述

脉冲宽度调制。

类型定义说明

◆ xf_pwm_num_t

typedef uint32_t xf_pwm_num_t

pwm 序号。

在文件 xf_hal_pwm.h 第 43 行定义.

◆ xf_hal_pwm_cmd_t

typedef enum _xf_hal_pwm_cmd_t xf_hal_pwm_cmd_t

用于对接 pwm 设置的命令。

注解
普通用户可忽略，移植者需注意。

◆ xf_hal_pwm_config_t

typedef struct _xf_hal_pwm_config_t xf_hal_pwm_config_t

用于对接 pwm 设置的参数。

注解
普通用户可忽略，移植者需注意。

枚举类型说明

◆ _xf_hal_pwm_cmd_t

enum _xf_hal_pwm_cmd_t

用于对接 pwm 设置的命令。

注解
普通用户可忽略，移植者需注意。
枚举值
XF_HAL_PWM_CMD_DEFAULT 

默认参数命令，在创建设备时优先执行

XF_HAL_PWM_CMD_ENABLE 

启用命令，见 xf_hal_pwm_config_t::enable

XF_HAL_PWM_CMD_FREQ 

频率命令，见 xf_hal_pwm_config_t::freq

XF_HAL_PWM_CMD_DUTY 

占空比命令，见 xf_hal_pwm_config_t::duty

XF_HAL_PWM_CMD_DUTY_RESOLUTION 

占空比分辨率命令，见 xf_hal_pwm_config_t::duty_resolution

XF_HAL_PWM_CMD_IO_NUM 

输出 IO 命令，见 xf_hal_pwm_config_t::io_num

XF_HAL_PWM_CMD_ALL 

默认设置命令，在创建设备时其次执行

在文件 xf_hal_pwm.h 第 50 行定义.

函数说明

◆ xf_hal_pwm_init()

xf_err_t xf_hal_pwm_init ( xf_pwm_num_t  pwm_num,
uint32_t  freq,
uint32_t  duty 
)

pwm 初始化函数。使用 pwm 之前必须要进行初始化。

参数
pwm_numpwm 的序号。
freq设置 pwm 输出的频率。单位为 hz。
duty设置 pwm 的占空比。
返回
xf_err_t
  • XF_OK 成功初始化
  • other 初始化失败

在文件 xf_hal_pwm.c 第 50 行定义.

◆ xf_hal_pwm_deinit()

xf_err_t xf_hal_pwm_deinit ( xf_pwm_num_t  pwm_num)

pwm 反初始化函数。恢复到未初始化状态且回收相关资源。

参数
pwm_numpwm 的序号。
返回
xf_err_t
  • XF_OK 成功反初始化
  • XF_ERR_UNINIT 该 pwm 未初始化
  • other 反初始化失败

在文件 xf_hal_pwm.c 第 76 行定义.

◆ xf_hal_pwm_enable()

xf_err_t xf_hal_pwm_enable ( xf_pwm_num_t  pwm_num)

pwm 启用函数。启用后，pwm 信号开始输出。

参数
pwm_numpwm 的序号。
返回
xf_err_t
  • XF_OK 成功启用
  • XF_ERR_UNINIT 该 pwm 未初始化
  • other 启用失败

在文件 xf_hal_pwm.c 第 91 行定义.

◆ xf_hal_pwm_disable()

xf_err_t xf_hal_pwm_disable ( xf_pwm_num_t  pwm_num)

pwm 禁用函数。禁用后，pwm 将不会输出。

参数
pwm_numpwm 的序号。
返回
xf_err_t
  • XF_OK 成功禁用
  • XF_ERR_UNINIT 该 pwm 未初始化
  • other 禁用失败

在文件 xf_hal_pwm.c 第 116 行定义.

◆ xf_hal_pwm_set_freq()

xf_err_t xf_hal_pwm_set_freq ( xf_pwm_num_t  pwm_num,
uint32_t  freq 
)

pwm 设置输出频率。

参数
pwm_numpwm 的序号。
freqpwm 的频率，单位为 hz，其最大值受到 duty_resolution 影响。
返回
xf_err_t
  • XF_OK 成功设置
  • XF_ERR_UNINIT 该 pwm 未初始化
  • other 设置失败

在文件 xf_hal_pwm.c 第 141 行定义.

◆ xf_hal_pwm_set_duty()

xf_err_t xf_hal_pwm_set_duty ( xf_pwm_num_t  pwm_num,
uint32_t  duty 
)

pwm 设置占空比。

参数
pwm_numpwm 的序号。
dutypwm 占空比的值，最大值为 2^duty_resolution-1。
返回
xf_err_t
  • XF_OK 成功设置
  • XF_ERR_UNINIT 该 pwm 未初始化
  • other 设置失败

在文件 xf_hal_pwm.c 第 166 行定义.

◆ xf_hal_pwm_set_duty_resolution()

xf_err_t xf_hal_pwm_set_duty_resolution ( xf_pwm_num_t  pwm_num,
uint32_t  duty_resolution 
)

pwm 设置占空比分辨率。

参数
pwm_numpwm 的序号。
duty_resolutionpwm 分辨率。分辨率越低，freq 可以设置的越高，占空比设置的就更低。
返回
xf_err_t
  • XF_OK 成功设置
  • XF_ERR_UNINIT 该 pwm 未初始化
  • other 设置失败

在文件 xf_hal_pwm.c 第 191 行定义.

◆ xf_hal_pwm_set_gpio()

xf_err_t xf_hal_pwm_set_gpio ( xf_pwm_num_t  pwm_num,
xf_gpio_num_t  io_num 
)

pwm 设置 gpio 占空比。

参数
pwm_numpwm 的序号。
io_num设置输出的 pwm。
返回
xf_err_t
  • XF_OK 成功设置
  • XF_ERR_UNINIT 该 pwm 未初始化
  • other 设置失败

在文件 xf_hal_pwm.c 第 216 行定义.

◆ xf_hal_pwm_get_freq()

uint32_t xf_hal_pwm_get_freq ( xf_pwm_num_t  pwm_num)

pwm 获取输出频率。

参数
pwm_numpwm 的序号。
返回
uint32_t 频率的数值

在文件 xf_hal_pwm.c 第 241 行定义.

◆ xf_hal_pwm_get_duty()

uint32_t xf_hal_pwm_get_duty ( xf_pwm_num_t  pwm_num)

pwm 获取占空比。

参数
pwm_numpwm 的序号。
返回
uint32_t 占空比的数值

在文件 xf_hal_pwm.c 第 260 行定义.

◆ xf_hal_pwm_is_enable()

bool xf_hal_pwm_is_enable ( xf_pwm_num_t  pwm_num)

pwm 是否启用。

参数
pwm_numpwm 的序号。
返回
true pwm 已启用
false pwm 未启用

在文件 xf_hal_pwm.c 第 279 行定义.