xf_hal_pwm.h

浏览该文件的文档.

 
#ifndef __XF_HAL_PWM_H__
#define __XF_HAL_PWM_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_hal_device_config.h"
 
#if XF_HAL_PWM_IS_ENABLE
 
#include "xf_hal_gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
typedef uint32_t xf_pwm_num_t;
 
typedef 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,  
} xf_hal_pwm_cmd_t;
 
typedef struct _xf_hal_pwm_config_t {
    bool enable;                
    uint32_t freq;              
    uint32_t duty;              
    uint32_t duty_resolution;   
    xf_gpio_num_t io_num;       
} xf_hal_pwm_config_t;
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_hal_pwm_init(xf_pwm_num_t pwm_num, uint32_t freq, uint32_t duty);
 
xf_err_t xf_hal_pwm_deinit(xf_pwm_num_t pwm_num);
 
xf_err_t xf_hal_pwm_enable(xf_pwm_num_t pwm_num);
 
xf_err_t xf_hal_pwm_disable(xf_pwm_num_t pwm_num);
 
xf_err_t xf_hal_pwm_set_freq(xf_pwm_num_t pwm_num, uint32_t freq);
 
xf_err_t xf_hal_pwm_set_duty(xf_pwm_num_t pwm_num, uint32_t duty);
 
xf_err_t xf_hal_pwm_set_duty_resolution(xf_pwm_num_t pwm_num, uint32_t duty_resolution);
 
xf_err_t xf_hal_pwm_set_gpio(xf_pwm_num_t pwm_num, xf_gpio_num_t io_num);
 
uint32_t xf_hal_pwm_get_freq(xf_pwm_num_t pwm_num);
 
uint32_t xf_hal_pwm_get_duty(xf_pwm_num_t pwm_num);
 
bool xf_hal_pwm_is_enable(xf_pwm_num_t pwm_num);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // XF_HAL_PWM_IS_ENABLE
 
#endif // __XF_HAL_PWM_H__