添加一些ledc注释

This commit is contained in:
2025-03-27 19:09:12 +08:00
parent 80cc752148
commit 4315af5d2c
3 changed files with 31 additions and 10 deletions

View File

@@ -116,7 +116,7 @@ void ledc_timer_ctrl(LEDC_PORT port, uint8_t status);
void ledc_cnt_ena(LEDC_PORT port, uint8_t status);
/**
* @brief ledc_polarity_sel() - ledc输出极性选择
* @brief ledc_polarity_sel() - ledc输出极性选择
* @param port: ledc 通道
* @param polarity: OUT_POL_ORIGINAL 不反相
* OUT_POL_INVERT 反相
@@ -124,7 +124,8 @@ void ledc_cnt_ena(LEDC_PORT port, uint8_t status);
void ledc_polarity_sel(LEDC_PORT port, uint8_t polarity);
/**
* @brief ledc_idle_level_sel() - ledc空闲时电平状态选择
* @brief ledc_idle_level_sel() - ledc空闲时电平状态选择
* 空闲是指关闭占空比的情况
* @param port: ledc 通道
* @param level: IDLE_LEVEL_HIGH 空闲时为高电平
* IDLE_LEVEL_LOW 空闲时为低电平
@@ -168,7 +169,7 @@ void ledc_l2h_point_set(LEDC_PORT port, uint16_t point);
void ledc_duty_cnt_sel(LEDC_PORT port, uint8_t duty_cnt);
/**
* @brief ledc_thrs_set() - 计数器阈值设置
* @brief ledc_thrs_set() - 计数器阈值设置,计数器大于这个值之后会重新开始计数
* @param port: ledc 通道
* @param thrs: 阈值范围0-0xffff
*/
@@ -211,35 +212,36 @@ void ledc_phase1_mode_sel(LEDC_PORT port, uint8_t mode);
void ledc_phase2_mode_sel(LEDC_PORT port, uint8_t mode);
/**
* @brief ledc_phase1_scale_set() - phase1的渐变幅度设置
* @brief ledc_phase1_scale_set() - phase1的渐变幅度设置scale为一次计数器周期中变化的count数
* @param port: ledc 通道
* @param scale: 范围 0-0xff
*/
void ledc_phase1_scale_set(LEDC_PORT port, uint8_t scale);
/**
* @brief ledc_phase2_scale_set() - phase2的渐变幅度设置
* @brief ledc_phase2_scale_set() - phase2的渐变幅度设置scale为一次计数器周期中变化的count数
* @param port: ledc 通道
* @param scale: 范围 0-0xff
*/
void ledc_phase2_scale_set(LEDC_PORT port, uint8_t scale);
/**
* @brief ledc_cycle_times_set() - 设置一个loop里有多少个cycle
* @brief ledc_cycle_times_set() - 设置一个loop里有多少个cycle,
* phase1 blink加上phase2 blink所使用的时间为一个cycle
* @param port: ledc 通道
* @param times: 范围 0-0xff
*/
void ledc_cycle_times_set(LEDC_PORT port, uint8_t times);
/**
* @brief ledc_cycle_times_set() - 设置一共多少个loop
* @brief ledc_loop_times_set() - 设置一共多少个loop
* @param port: ledc 通道
* @param times: 范围 0-0xff
*/
void ledc_loop_times_set(LEDC_PORT port, uint8_t times);
/**
* @brief ledc_nop_num_set() - 设置一共多少个loop
* @brief ledc_nop_num_set() - 设置一个loop里有多少个nop计数器周期,这个时候处于空闲状态
* @param port: ledc 通道
* @param times: 范围 0-0xff
*/
@@ -253,7 +255,7 @@ void ledc_nop_num_set(LEDC_PORT port, uint16_t num);
void ledc_common_cnt_ena(uint8_t en);
/**
* @brief ledc_common_thrs_set() - 共用计数器阈值设置
* @brief ledc_common_thrs_set() - 共用计数器阈值设置,计数器大于这个值之后会重新开始计数
* @param thrs: 阈值范围0-0xffff
*/
void ledc_common_thrs_set(uint16_t thrs);