• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2015-2019 Espressif Systems (Shanghai) PTE LTD
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 
7 //     http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 #include <string.h>
15 #include <esp_types.h>
16 #include "esp_osal/esp_osal.h"
17 #include "esp_osal/semphr.h"
18 #include "esp_log.h"
19 #include "soc/gpio_periph.h"
20 #include "soc/ledc_periph.h"
21 #include "soc/rtc.h"
22 #include "soc/soc_caps.h"
23 #include "hal/ledc_hal.h"
24 #include "hal/gpio_hal.h"
25 #include "driver/ledc.h"
26 #include "esp_rom_gpio.h"
27 #include "esp_rom_sys.h"
28 #include "soc/clk_ctrl_os.h"
29 
30 static const char* LEDC_TAG = "ledc";
31 
32 #define LEDC_CHECK(a, str, ret_val) \
33     if (!(a)) { \
34         ESP_LOGE(LEDC_TAG, "%s(%d): %s", __FUNCTION__, __LINE__, str); \
35         return (ret_val); \
36     }
37 #define LEDC_ARG_CHECK(a, param) LEDC_CHECK(a, param " argument is invalid", ESP_ERR_INVALID_ARG)
38 
39 typedef struct {
40     ledc_mode_t speed_mode;
41     ledc_duty_direction_t direction;
42     uint32_t target_duty;
43     int cycle_num;
44     int scale;
45     ledc_fade_mode_t mode;
46     xSemaphoreHandle ledc_fade_sem;
47     xSemaphoreHandle ledc_fade_mux;
48 #if CONFIG_SPIRAM_USE_MALLOC
49     StaticQueue_t ledc_fade_sem_storage;
50 #endif
51 } ledc_fade_t;
52 
53 typedef struct {
54     ledc_hal_context_t ledc_hal;        /*!< LEDC hal context*/
55 } ledc_obj_t;
56 
57 static ledc_obj_t *p_ledc_obj[LEDC_SPEED_MODE_MAX] = {0};
58 static ledc_fade_t *s_ledc_fade_rec[LEDC_SPEED_MODE_MAX][LEDC_CHANNEL_MAX];
59 static ledc_isr_handle_t s_ledc_fade_isr_handle = NULL;
60 static portMUX_TYPE ledc_spinlock = portMUX_INITIALIZER_UNLOCKED;
61 
62 #define LEDC_VAL_NO_CHANGE        (-1)
63 #define LEDC_STEP_NUM_MAX         (1023)
64 #define LEDC_DUTY_DECIMAL_BIT_NUM (4)
65 #define LEDC_TIMER_DIV_NUM_MAX    (0x3FFFF)
66 #define LEDC_DUTY_NUM_MAX         (LEDC_DUTY_NUM_LSCH0_V)
67 #define LEDC_DUTY_CYCLE_MAX       (LEDC_DUTY_CYCLE_LSCH0_V)
68 #define LEDC_DUTY_SCALE_MAX       (LEDC_DUTY_SCALE_LSCH0_V)
69 #define LEDC_HPOINT_VAL_MAX       (LEDC_HPOINT_LSCH1_V)
70 #define DELAY_CLK8M_CLK_SWITCH    (5)
71 #define SLOW_CLK_CYC_CALIBRATE    (13)
72 #define LEDC_FADE_TOO_SLOW_STR    "LEDC FADE TOO SLOW"
73 #define LEDC_FADE_TOO_FAST_STR    "LEDC FADE TOO FAST"
74 
75 static const char *LEDC_NOT_INIT = "LEDC is not initialized";
76 static const char *LEDC_FADE_SERVICE_ERR_STR = "LEDC fade service not installed";
77 static const char *LEDC_FADE_INIT_ERROR_STR = "LEDC fade channel init error, not enough memory or service not installed";
78 
79 //This value will be calibrated when in use.
80 static uint32_t s_ledc_slow_clk_8M = 0;
81 
ledc_ls_timer_update(ledc_mode_t speed_mode,ledc_timer_t timer_sel)82 static void ledc_ls_timer_update(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
83 {
84     if (speed_mode == LEDC_LOW_SPEED_MODE) {
85         ledc_hal_ls_timer_update(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
86     }
87 }
88 
ledc_ls_channel_update(ledc_mode_t speed_mode,ledc_channel_t channel)89 static IRAM_ATTR void ledc_ls_channel_update(ledc_mode_t speed_mode, ledc_channel_t channel)
90 {
91     if (speed_mode == LEDC_LOW_SPEED_MODE) {
92         ledc_hal_ls_channel_update(&(p_ledc_obj[speed_mode]->ledc_hal), channel);
93     }
94 }
95 
96 //We know that CLK8M is about 8M, but don't know the actual value. So we need to do a calibration.
ledc_slow_clk_calibrate(void)97 static bool ledc_slow_clk_calibrate(void)
98 {
99     if (periph_rtc_dig_clk8m_enable()) {
100         s_ledc_slow_clk_8M = periph_rtc_dig_clk8m_get_freq();
101         ESP_LOGD(LEDC_TAG, "Calibrate CLK8M_CLK : %d Hz", s_ledc_slow_clk_8M);
102         return true;
103     }
104     ESP_LOGE(LEDC_TAG, "Calibrate CLK8M_CLK failed");
105     return false;
106 }
107 
ledc_get_src_clk_freq(ledc_clk_cfg_t clk_cfg)108 static uint32_t ledc_get_src_clk_freq(ledc_clk_cfg_t clk_cfg)
109 {
110     uint32_t src_clk_freq = 0;
111     if (clk_cfg == LEDC_USE_APB_CLK) {
112         src_clk_freq = LEDC_APB_CLK_HZ;
113     } else if (clk_cfg == LEDC_USE_REF_TICK) {
114         src_clk_freq = LEDC_REF_CLK_HZ;
115     } else if (clk_cfg == LEDC_USE_RTC8M_CLK) {
116         src_clk_freq = s_ledc_slow_clk_8M;
117 #if SOC_LEDC_SUPPORT_XTAL_CLOCK
118     } else if (clk_cfg == LEDC_USE_XTAL_CLK) {
119         src_clk_freq = rtc_clk_xtal_freq_get() * 1000000;
120 #endif
121     }
122     return src_clk_freq;
123 }
124 
ledc_enable_intr_type(ledc_mode_t speed_mode,ledc_channel_t channel,ledc_intr_type_t type)125 static esp_err_t ledc_enable_intr_type(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_intr_type_t type)
126 {
127     portENTER_CRITICAL(&ledc_spinlock);
128     if (type == LEDC_INTR_FADE_END) {
129         ledc_hal_set_fade_end_intr(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
130     } else {
131         ledc_hal_set_fade_end_intr(&(p_ledc_obj[speed_mode]->ledc_hal), channel, false);
132     }
133     portEXIT_CRITICAL(&ledc_spinlock);
134     return ESP_OK;
135 }
136 
_ledc_fade_hw_acquire(ledc_mode_t mode,ledc_channel_t channel)137 static void _ledc_fade_hw_acquire(ledc_mode_t mode, ledc_channel_t channel)
138 {
139     ledc_fade_t* fade = s_ledc_fade_rec[mode][channel];
140     if (fade) {
141         xSemaphoreTake(fade->ledc_fade_sem, portMAX_DELAY);
142         ledc_enable_intr_type(mode, channel, LEDC_INTR_DISABLE);
143     }
144 }
145 
_ledc_fade_hw_release(ledc_mode_t mode,ledc_channel_t channel)146 static void _ledc_fade_hw_release(ledc_mode_t mode, ledc_channel_t channel)
147 {
148     ledc_fade_t* fade = s_ledc_fade_rec[mode][channel];
149     if (fade) {
150         xSemaphoreGive(fade->ledc_fade_sem);
151     }
152 }
153 
_ledc_op_lock_acquire(ledc_mode_t mode,ledc_channel_t channel)154 static void _ledc_op_lock_acquire(ledc_mode_t mode, ledc_channel_t channel)
155 {
156     ledc_fade_t* fade = s_ledc_fade_rec[mode][channel];
157     if (fade) {
158         xSemaphoreTake(fade->ledc_fade_mux, portMAX_DELAY);
159     }
160 }
161 
_ledc_op_lock_release(ledc_mode_t mode,ledc_channel_t channel)162 static void _ledc_op_lock_release(ledc_mode_t mode, ledc_channel_t channel)
163 {
164     ledc_fade_t* fade = s_ledc_fade_rec[mode][channel];
165     if (fade) {
166         xSemaphoreGive(fade->ledc_fade_mux);
167     }
168 }
169 
ledc_get_max_duty(ledc_mode_t speed_mode,ledc_channel_t channel)170 static uint32_t ledc_get_max_duty(ledc_mode_t speed_mode, ledc_channel_t channel)
171 {
172     // The arguments are checked before internally calling this function.
173     uint32_t max_duty;
174     ledc_hal_get_max_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &max_duty);
175     return max_duty;
176 }
177 
ledc_timer_set(ledc_mode_t speed_mode,ledc_timer_t timer_sel,uint32_t clock_divider,uint32_t duty_resolution,ledc_clk_src_t clk_src)178 esp_err_t ledc_timer_set(ledc_mode_t speed_mode, ledc_timer_t timer_sel, uint32_t clock_divider, uint32_t duty_resolution,
179         ledc_clk_src_t clk_src)
180 {
181     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
182     LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
183     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
184     portENTER_CRITICAL(&ledc_spinlock);
185     ledc_hal_set_clock_divider(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel, clock_divider);
186     ledc_hal_set_clock_source(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel, clk_src);
187     ledc_hal_set_duty_resolution(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel, duty_resolution);
188     ledc_ls_timer_update(speed_mode, timer_sel);
189     portEXIT_CRITICAL(&ledc_spinlock);
190     return ESP_OK;
191 }
192 
ledc_duty_config(ledc_mode_t speed_mode,ledc_channel_t channel,int hpoint_val,int duty_val,ledc_duty_direction_t duty_direction,uint32_t duty_num,uint32_t duty_cycle,uint32_t duty_scale)193 static IRAM_ATTR esp_err_t ledc_duty_config(ledc_mode_t speed_mode, ledc_channel_t channel, int hpoint_val, int duty_val,
194     ledc_duty_direction_t duty_direction, uint32_t duty_num, uint32_t duty_cycle, uint32_t duty_scale)
195 {
196     portENTER_CRITICAL(&ledc_spinlock);
197     if (hpoint_val >= 0) {
198         ledc_hal_set_hpoint(&(p_ledc_obj[speed_mode]->ledc_hal), channel, hpoint_val);
199     }
200     if (duty_val >= 0) {
201         ledc_hal_set_duty_int_part(&(p_ledc_obj[speed_mode]->ledc_hal), channel, duty_val);
202     }
203     ledc_hal_set_duty_direction(&(p_ledc_obj[speed_mode]->ledc_hal), channel, duty_direction);
204     ledc_hal_set_duty_num(&(p_ledc_obj[speed_mode]->ledc_hal), channel, duty_num);
205     ledc_hal_set_duty_cycle(&(p_ledc_obj[speed_mode]->ledc_hal), channel, duty_cycle);
206     ledc_hal_set_duty_scale(&(p_ledc_obj[speed_mode]->ledc_hal), channel, duty_scale);
207     ledc_ls_channel_update(speed_mode, channel);
208     portEXIT_CRITICAL(&ledc_spinlock);
209     return ESP_OK;
210 }
211 
ledc_bind_channel_timer(ledc_mode_t speed_mode,ledc_channel_t channel,ledc_timer_t timer_sel)212 esp_err_t ledc_bind_channel_timer(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_timer_t timer_sel)
213 {
214     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
215     LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
216     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
217     portENTER_CRITICAL(&ledc_spinlock);
218     ledc_hal_bind_channel_timer(&(p_ledc_obj[speed_mode]->ledc_hal), channel, timer_sel);
219     ledc_ls_channel_update(speed_mode, channel);
220     portEXIT_CRITICAL(&ledc_spinlock);
221     return ESP_OK;
222 }
223 
ledc_timer_rst(ledc_mode_t speed_mode,ledc_timer_t timer_sel)224 esp_err_t ledc_timer_rst(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
225 {
226     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
227     LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
228     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
229     portENTER_CRITICAL(&ledc_spinlock);
230     ledc_hal_timer_rst(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
231     ledc_ls_timer_update(speed_mode, timer_sel);
232     portEXIT_CRITICAL(&ledc_spinlock);
233     return ESP_OK;
234 }
235 
ledc_timer_pause(ledc_mode_t speed_mode,ledc_timer_t timer_sel)236 esp_err_t ledc_timer_pause(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
237 {
238     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
239     LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
240     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
241     portENTER_CRITICAL(&ledc_spinlock);
242     ledc_hal_timer_pause(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
243     ledc_ls_timer_update(speed_mode, timer_sel);
244     portEXIT_CRITICAL(&ledc_spinlock);
245     return ESP_OK;
246 }
247 
ledc_timer_resume(ledc_mode_t speed_mode,ledc_timer_t timer_sel)248 esp_err_t ledc_timer_resume(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
249 {
250     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
251     LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
252     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
253     portENTER_CRITICAL(&ledc_spinlock);
254     ledc_hal_timer_resume(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
255     ledc_ls_timer_update(speed_mode, timer_sel);
256     portEXIT_CRITICAL(&ledc_spinlock);
257     return ESP_OK;
258 }
259 
ledc_isr_register(void (* fn)(void *),void * arg,int intr_alloc_flags,ledc_isr_handle_t * handle)260 esp_err_t ledc_isr_register(void (*fn)(void*), void * arg, int intr_alloc_flags, ledc_isr_handle_t *handle)
261 {
262     esp_err_t ret;
263     LEDC_ARG_CHECK(fn, "fn");
264     portENTER_CRITICAL(&ledc_spinlock);
265     ret = esp_intr_alloc(ETS_LEDC_INTR_SOURCE, intr_alloc_flags, fn, arg, handle);
266     portEXIT_CRITICAL(&ledc_spinlock);
267     return ret;
268 }
269 
270 // Setting the LEDC timer divisor with the given source clock, frequency and resolution.
ledc_set_timer_div(ledc_mode_t speed_mode,ledc_timer_t timer_num,ledc_clk_cfg_t clk_cfg,int freq_hz,int duty_resolution)271 static esp_err_t ledc_set_timer_div(ledc_mode_t speed_mode, ledc_timer_t timer_num, ledc_clk_cfg_t clk_cfg, int freq_hz, int duty_resolution)
272 {
273     uint32_t div_param = 0;
274     uint32_t precision = ( 0x1 << duty_resolution );
275     ledc_clk_src_t timer_clk_src = LEDC_APB_CLK;
276     // Calculate the divisor
277     // User specified source clock(RTC8M_CLK) for low speed channel
278     if ((speed_mode == LEDC_LOW_SPEED_MODE) && (clk_cfg == LEDC_USE_RTC8M_CLK)) {
279         if(s_ledc_slow_clk_8M == 0) {
280             if (ledc_slow_clk_calibrate() == false) {
281                 goto error;
282             }
283         }
284         div_param = ( (uint64_t) s_ledc_slow_clk_8M << 8 ) / freq_hz / precision;
285     } else {
286         // Automatically select APB or REF_TICK as the source clock.
287         if (clk_cfg == LEDC_AUTO_CLK) {
288             // Try calculating divisor based on LEDC_APB_CLK
289             div_param = ( (uint64_t) LEDC_APB_CLK_HZ << 8 ) / freq_hz / precision;
290             if (div_param > LEDC_TIMER_DIV_NUM_MAX) {
291                 // APB_CLK results in divisor which too high. Try using REF_TICK as clock source.
292                 timer_clk_src = LEDC_REF_TICK;
293                 div_param = ((uint64_t) LEDC_REF_CLK_HZ << 8) / freq_hz / precision;
294             } else if (div_param < 256) {
295                 // divisor is too low
296                 goto error;
297             }
298         // User specified source clock(LEDC_APB_CLK_HZ or LEDC_REF_TICK)
299         } else {
300             timer_clk_src = (clk_cfg == LEDC_USE_REF_TICK) ? LEDC_REF_TICK : LEDC_APB_CLK;
301             uint32_t src_clk_freq = ledc_get_src_clk_freq(clk_cfg);
302             div_param = ( (uint64_t) src_clk_freq << 8 ) / freq_hz / precision;
303         }
304     }
305     if (div_param < 256 || div_param > LEDC_TIMER_DIV_NUM_MAX) {
306         goto error;
307     }
308     if (speed_mode == LEDC_LOW_SPEED_MODE) {
309         portENTER_CRITICAL(&ledc_spinlock);
310         ledc_hal_set_slow_clk(&(p_ledc_obj[speed_mode]->ledc_hal), clk_cfg);
311         portEXIT_CRITICAL(&ledc_spinlock);
312     }
313     //Set the divisor
314     ledc_timer_set(speed_mode, timer_num, div_param, duty_resolution, timer_clk_src);
315     // reset the timer
316     ledc_timer_rst(speed_mode, timer_num);
317     return ESP_OK;
318 error:
319     ESP_LOGE(LEDC_TAG, "requested frequency and duty resolution can not be achieved, try reducing freq_hz or duty_resolution. div_param=%d",
320         (uint32_t ) div_param);
321     return ESP_FAIL;
322 }
323 
ledc_timer_config(const ledc_timer_config_t * timer_conf)324 esp_err_t ledc_timer_config(const ledc_timer_config_t* timer_conf)
325 {
326     LEDC_ARG_CHECK(timer_conf != NULL, "timer_conf");
327     uint32_t freq_hz = timer_conf->freq_hz;
328     uint32_t duty_resolution = timer_conf->duty_resolution;
329     uint32_t timer_num = timer_conf->timer_num;
330     uint32_t speed_mode = timer_conf->speed_mode;
331     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
332     LEDC_ARG_CHECK(!((timer_conf->clk_cfg == LEDC_USE_RTC8M_CLK) && (speed_mode != LEDC_LOW_SPEED_MODE)), "Only low speed channel support RTC8M_CLK");
333     periph_module_enable(PERIPH_LEDC_MODULE);
334     if (freq_hz == 0 || duty_resolution == 0 || duty_resolution >= LEDC_TIMER_BIT_MAX) {
335         ESP_LOGE(LEDC_TAG, "freq_hz=%u duty_resolution=%u", freq_hz, duty_resolution);
336         return ESP_ERR_INVALID_ARG;
337     }
338     if (timer_num > LEDC_TIMER_3) {
339         ESP_LOGE(LEDC_TAG, "invalid timer #%u", timer_num);
340         return ESP_ERR_INVALID_ARG;
341     }
342 
343     if(p_ledc_obj[speed_mode] == NULL) {
344         p_ledc_obj[speed_mode] = (ledc_obj_t *) heap_caps_calloc(1, sizeof(ledc_obj_t), MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
345         if (p_ledc_obj[speed_mode] == NULL) {
346             return ESP_ERR_NO_MEM;
347         }
348         ledc_hal_init(&(p_ledc_obj[speed_mode]->ledc_hal), speed_mode);
349     }
350 
351     return ledc_set_timer_div(speed_mode, timer_num, timer_conf->clk_cfg, freq_hz, duty_resolution);
352 }
353 
ledc_set_pin(int gpio_num,ledc_mode_t speed_mode,ledc_channel_t ledc_channel)354 esp_err_t ledc_set_pin(int gpio_num, ledc_mode_t speed_mode, ledc_channel_t ledc_channel)
355 {
356     LEDC_ARG_CHECK(ledc_channel < LEDC_CHANNEL_MAX, "ledc_channel");
357     LEDC_ARG_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(gpio_num), "gpio_num");
358     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
359     gpio_hal_iomux_func_sel(GPIO_PIN_MUX_REG[gpio_num], PIN_FUNC_GPIO);
360     gpio_set_direction(gpio_num, GPIO_MODE_OUTPUT);
361     esp_rom_gpio_connect_out_signal(gpio_num, ledc_periph_signal[speed_mode].sig_out0_idx + ledc_channel, 0, 0);
362     return ESP_OK;
363 }
364 
ledc_channel_config(const ledc_channel_config_t * ledc_conf)365 esp_err_t ledc_channel_config(const ledc_channel_config_t* ledc_conf)
366 {
367     LEDC_ARG_CHECK(ledc_conf, "ledc_conf");
368     uint32_t speed_mode = ledc_conf->speed_mode;
369     uint32_t gpio_num = ledc_conf->gpio_num;
370     uint32_t ledc_channel = ledc_conf->channel;
371     uint32_t timer_select = ledc_conf->timer_sel;
372     uint32_t intr_type = ledc_conf->intr_type;
373     uint32_t duty = ledc_conf->duty;
374     uint32_t hpoint = ledc_conf->hpoint;
375     LEDC_ARG_CHECK(ledc_channel < LEDC_CHANNEL_MAX, "ledc_channel");
376     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
377     LEDC_ARG_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(gpio_num), "gpio_num");
378     LEDC_ARG_CHECK(timer_select < LEDC_TIMER_MAX, "timer_select");
379     LEDC_ARG_CHECK(intr_type < LEDC_INTR_MAX, "intr_type");
380 
381     periph_module_enable(PERIPH_LEDC_MODULE);
382     esp_err_t ret = ESP_OK;
383 
384     if(p_ledc_obj[speed_mode] == NULL) {
385         p_ledc_obj[speed_mode] = (ledc_obj_t *) heap_caps_calloc(1, sizeof(ledc_obj_t), MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
386         if (p_ledc_obj[speed_mode] == NULL) {
387             return ESP_ERR_NO_MEM;
388         }
389         ledc_hal_init(&(p_ledc_obj[speed_mode]->ledc_hal), speed_mode);
390     }
391 
392     /*set channel parameters*/
393     /*   channel parameters decide how the waveform looks like in one period*/
394     /*   set channel duty and hpoint value, duty range is (0 ~ ((2 ** duty_resolution) - 1)), max hpoint value is 0xfffff*/
395     ledc_set_duty_with_hpoint(speed_mode, ledc_channel, duty, hpoint);
396     /*update duty settings*/
397     ledc_update_duty(speed_mode, ledc_channel);
398     /*bind the channel with the timer*/
399     ledc_bind_channel_timer(speed_mode, ledc_channel, timer_select);
400     /*set interrupt type*/
401     ledc_enable_intr_type(speed_mode, ledc_channel, intr_type);
402     ESP_LOGD(LEDC_TAG, "LEDC_PWM CHANNEL %1u|GPIO %02u|Duty %04u|Time %01u",
403         ledc_channel, gpio_num, duty, timer_select
404     );
405     /*set LEDC signal in gpio matrix*/
406     gpio_hal_iomux_func_sel(GPIO_PIN_MUX_REG[gpio_num], PIN_FUNC_GPIO);
407     gpio_set_direction(gpio_num, GPIO_MODE_OUTPUT);
408     esp_rom_gpio_connect_out_signal(gpio_num, ledc_periph_signal[speed_mode].sig_out0_idx + ledc_channel, 0, 0);
409 
410     return ret;
411 }
412 
ledc_update_duty(ledc_mode_t speed_mode,ledc_channel_t channel)413 esp_err_t ledc_update_duty(ledc_mode_t speed_mode, ledc_channel_t channel)
414 {
415     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
416     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
417     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
418     portENTER_CRITICAL(&ledc_spinlock);
419     ledc_hal_set_sig_out_en(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
420     ledc_hal_set_duty_start(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
421     ledc_ls_channel_update(speed_mode, channel);
422     portEXIT_CRITICAL(&ledc_spinlock);
423     return ESP_OK;
424 }
425 
ledc_stop(ledc_mode_t speed_mode,ledc_channel_t channel,uint32_t idle_level)426 esp_err_t ledc_stop(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t idle_level)
427 {
428     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
429     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
430     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
431     portENTER_CRITICAL(&ledc_spinlock);
432     ledc_hal_set_idle_level(&(p_ledc_obj[speed_mode]->ledc_hal), channel, idle_level);
433     ledc_hal_set_sig_out_en(&(p_ledc_obj[speed_mode]->ledc_hal), channel, false);
434     ledc_hal_set_duty_start(&(p_ledc_obj[speed_mode]->ledc_hal), channel, false);
435     ledc_ls_channel_update(speed_mode, channel);
436     portEXIT_CRITICAL(&ledc_spinlock);
437     return ESP_OK;
438 }
439 
ledc_set_fade(ledc_mode_t speed_mode,ledc_channel_t channel,uint32_t duty,ledc_duty_direction_t fade_direction,uint32_t step_num,uint32_t duty_cyle_num,uint32_t duty_scale)440 esp_err_t ledc_set_fade(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, ledc_duty_direction_t fade_direction,
441     uint32_t step_num, uint32_t duty_cyle_num, uint32_t duty_scale)
442 {
443     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
444     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
445     LEDC_ARG_CHECK(fade_direction < LEDC_DUTY_DIR_MAX, "fade_direction");
446     LEDC_ARG_CHECK(step_num <= LEDC_DUTY_NUM_MAX, "step_num");
447     LEDC_ARG_CHECK(duty_cyle_num <= LEDC_DUTY_CYCLE_MAX, "duty_cycle_num");
448     LEDC_ARG_CHECK(duty_scale <= LEDC_DUTY_SCALE_MAX, "duty_scale");
449     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
450     _ledc_fade_hw_acquire(speed_mode, channel);
451     ledc_duty_config(speed_mode,
452                      channel,        //uint32_t chan_num,
453                      LEDC_VAL_NO_CHANGE,
454                      duty,           //uint32_t duty_val,
455                      fade_direction, //uint32_t increase,
456                      step_num,       //uint32_t duty_num,
457                      duty_cyle_num,  //uint32_t duty_cycle,
458                      duty_scale      //uint32_t duty_scale
459                      );
460     _ledc_fade_hw_release(speed_mode, channel);
461     return ESP_OK;
462 }
463 
ledc_set_duty_with_hpoint(ledc_mode_t speed_mode,ledc_channel_t channel,uint32_t duty,uint32_t hpoint)464 esp_err_t ledc_set_duty_with_hpoint(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, uint32_t hpoint)
465 {
466     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
467     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
468     LEDC_ARG_CHECK(hpoint <= LEDC_HPOINT_VAL_MAX, "hpoint");
469     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
470     /* The channel configuration should not be changed before the fade operation is done. */
471     _ledc_fade_hw_acquire(speed_mode, channel);
472     ledc_duty_config(speed_mode,
473                      channel,         //uint32_t chan_num,
474                      hpoint,          //uint32_t hpoint_val,
475                      duty,           //uint32_t duty_val,
476                      1,               //uint32_t increase,
477                      1,               //uint32_t duty_num,
478                      1,               //uint32_t duty_cycle,
479                      0                //uint32_t duty_scale
480                      );
481     _ledc_fade_hw_release(speed_mode, channel);
482     return ESP_OK;
483 }
484 
ledc_set_duty(ledc_mode_t speed_mode,ledc_channel_t channel,uint32_t duty)485 esp_err_t ledc_set_duty(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty)
486 {
487     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
488     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
489     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
490     /* The channel configuration should not be changed before the fade operation is done. */
491     _ledc_fade_hw_acquire(speed_mode, channel);
492     ledc_duty_config(speed_mode,
493                      channel,         //uint32_t chan_num,
494                      LEDC_VAL_NO_CHANGE,
495                      duty,           //uint32_t duty_val,
496                      1,               //uint32_t increase,
497                      1,               //uint32_t duty_num,
498                      1,               //uint32_t duty_cycle,
499                      0                //uint32_t duty_scale
500                      );
501     _ledc_fade_hw_release(speed_mode, channel);
502     return ESP_OK;
503 }
504 
ledc_get_duty(ledc_mode_t speed_mode,ledc_channel_t channel)505 uint32_t ledc_get_duty(ledc_mode_t speed_mode, ledc_channel_t channel)
506 {
507     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
508     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
509     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
510     uint32_t duty = 0;
511     ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty);
512     return duty;
513 }
514 
ledc_get_hpoint(ledc_mode_t speed_mode,ledc_channel_t channel)515 int ledc_get_hpoint(ledc_mode_t speed_mode, ledc_channel_t channel)
516 {
517     LEDC_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode argument is invalid", LEDC_ERR_VAL);
518     LEDC_CHECK(channel < LEDC_CHANNEL_MAX, "channel argument is invalid", LEDC_ERR_VAL);
519     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
520     uint32_t hpoint = 0;
521     ledc_hal_get_hpoint(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &hpoint);
522     return hpoint;
523 }
524 
ledc_set_freq(ledc_mode_t speed_mode,ledc_timer_t timer_num,uint32_t freq_hz)525 esp_err_t ledc_set_freq(ledc_mode_t speed_mode, ledc_timer_t timer_num, uint32_t freq_hz)
526 {
527     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
528     LEDC_ARG_CHECK(timer_num < LEDC_TIMER_MAX, "timer_num");
529     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
530     ledc_clk_cfg_t clk_cfg = LEDC_USE_APB_CLK;
531     uint32_t duty_resolution = 0;
532     ledc_hal_get_clk_cfg(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &clk_cfg);
533     ledc_hal_get_duty_resolution(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &duty_resolution);
534     return ledc_set_timer_div(speed_mode, timer_num, clk_cfg, freq_hz, duty_resolution);
535 }
536 
ledc_get_freq(ledc_mode_t speed_mode,ledc_timer_t timer_num)537 uint32_t ledc_get_freq(ledc_mode_t speed_mode, ledc_timer_t timer_num)
538 {
539     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
540     LEDC_ARG_CHECK(timer_num < LEDC_TIMER_MAX, "timer_num");
541     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
542     portENTER_CRITICAL(&ledc_spinlock);
543     uint32_t clock_divider = 0;
544     uint32_t duty_resolution = 0;
545     ledc_clk_cfg_t clk_cfg = LEDC_USE_APB_CLK;
546     ledc_hal_get_clock_divider(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &clock_divider);
547     ledc_hal_get_duty_resolution(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &duty_resolution);
548     ledc_hal_get_clk_cfg(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &clk_cfg);
549     uint32_t precision = (0x1 << duty_resolution);
550     uint32_t src_clk_freq = ledc_get_src_clk_freq(clk_cfg);
551     portEXIT_CRITICAL(&ledc_spinlock);
552     return ((uint64_t) src_clk_freq << 8) / precision / clock_divider;
553 }
554 
ledc_calc_fade_end_channel(uint32_t * fade_end_status,uint32_t * channel)555 static inline void ledc_calc_fade_end_channel(uint32_t *fade_end_status, uint32_t *channel)
556 {
557     uint32_t i = __builtin_ffs((*fade_end_status)) - 1;
558     (*fade_end_status) &= ~(1 << i);
559     *channel = i;
560 }
561 
ledc_fade_isr(void * arg)562 void IRAM_ATTR ledc_fade_isr(void* arg)
563 {
564     portBASE_TYPE HPTaskAwoken = pdFALSE;
565     uint32_t speed_mode = 0;
566     uint32_t channel = 0;
567     uint32_t intr_status = 0;
568 
569     for (speed_mode = 0; speed_mode < LEDC_SPEED_MODE_MAX; speed_mode++) {
570         if (p_ledc_obj[speed_mode] == NULL) {
571             continue;
572         }
573         ledc_hal_get_fade_end_intr_status(&(p_ledc_obj[speed_mode]->ledc_hal), &intr_status);
574         while(intr_status) {
575             ledc_calc_fade_end_channel(&intr_status, &channel);
576 
577             // clear interrupt
578             portENTER_CRITICAL(&ledc_spinlock);
579             ledc_hal_clear_fade_end_intr_status(&(p_ledc_obj[speed_mode]->ledc_hal), channel);
580             portEXIT_CRITICAL(&ledc_spinlock);
581 
582             if (s_ledc_fade_rec[speed_mode][channel] == NULL) {
583                 //fade object not initialized yet.
584                 continue;
585             }
586 
587             uint32_t duty_cur = 0;
588             ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty_cur);
589             if (duty_cur == s_ledc_fade_rec[speed_mode][channel]->target_duty) {
590                 xSemaphoreGiveFromISR(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem, &HPTaskAwoken);
591                 if (HPTaskAwoken == pdTRUE) {
592                     portYIELD_FROM_ISR();
593                 }
594                 continue;
595             }
596             uint32_t duty_tar = s_ledc_fade_rec[speed_mode][channel]->target_duty;
597             int scale = s_ledc_fade_rec[speed_mode][channel]->scale;
598             if (scale == 0) {
599                 xSemaphoreGiveFromISR(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem, &HPTaskAwoken);
600                 continue;
601             }
602             int cycle = s_ledc_fade_rec[speed_mode][channel]->cycle_num;
603             int delta = s_ledc_fade_rec[speed_mode][channel]->direction == LEDC_DUTY_DIR_DECREASE ? duty_cur - duty_tar : duty_tar - duty_cur;
604             int step = delta / scale > LEDC_STEP_NUM_MAX ? LEDC_STEP_NUM_MAX : delta / scale;
605             if (delta > scale) {
606                 ledc_duty_config(
607                     speed_mode,
608                     channel,
609                     LEDC_VAL_NO_CHANGE,
610                     duty_cur,
611                     s_ledc_fade_rec[speed_mode][channel]->direction,
612                     step,
613                     cycle,
614                     scale);
615             } else {
616                 ledc_duty_config(
617                     speed_mode,
618                     channel,
619                     LEDC_VAL_NO_CHANGE,
620                     duty_tar,
621                     s_ledc_fade_rec[speed_mode][channel]->direction,
622                     1,
623                     1,
624                     0);
625             }
626             portENTER_CRITICAL(&ledc_spinlock);
627             ledc_hal_set_duty_start(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
628             portEXIT_CRITICAL(&ledc_spinlock);
629         }
630     }
631 }
632 
ledc_fade_channel_deinit(ledc_mode_t speed_mode,ledc_channel_t channel)633 static esp_err_t ledc_fade_channel_deinit(ledc_mode_t speed_mode, ledc_channel_t channel)
634 {
635     if (s_ledc_fade_rec[speed_mode][channel]) {
636         if (s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux) {
637             vSemaphoreDelete(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux);
638             s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux = NULL;
639         }
640         if (s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem) {
641             vSemaphoreDelete(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem);
642             s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem = NULL;
643         }
644         free(s_ledc_fade_rec[speed_mode][channel]);
645         s_ledc_fade_rec[speed_mode][channel] = NULL;
646     }
647     return ESP_OK;
648 }
649 
ledc_fade_channel_init_check(ledc_mode_t speed_mode,ledc_channel_t channel)650 static esp_err_t ledc_fade_channel_init_check(ledc_mode_t speed_mode, ledc_channel_t channel)
651 {
652     if (s_ledc_fade_isr_handle == NULL) {
653         ESP_LOGE(LEDC_TAG, "Fade service not installed, call ledc_fade_func_install");
654         return ESP_FAIL;
655     }
656     if (s_ledc_fade_rec[speed_mode][channel] == NULL) {
657 #if CONFIG_SPIRAM_USE_MALLOC
658         s_ledc_fade_rec[speed_mode][channel] = (ledc_fade_t *) heap_caps_calloc(1, sizeof(ledc_fade_t), MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
659         if (!s_ledc_fade_rec[speed_mode][channel]) {
660             ledc_fade_channel_deinit(speed_mode, channel);
661             return ESP_FAIL;
662         }
663 
664         memset(&s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem_storage, 0, sizeof(StaticQueue_t));
665         s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem = xSemaphoreCreateBinaryStatic(&s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem_storage);
666 #else
667         s_ledc_fade_rec[speed_mode][channel] = (ledc_fade_t *) calloc(1, sizeof(ledc_fade_t));
668         s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem = xSemaphoreCreateBinary();
669 #endif
670         s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux = xSemaphoreCreateMutex();
671         xSemaphoreGive(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem);
672     }
673     if (s_ledc_fade_rec[speed_mode][channel]
674         && s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux
675         && s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem) {
676         return ESP_OK;
677     } else {
678         ledc_fade_channel_deinit(speed_mode, channel);
679         return ESP_FAIL;
680     }
681 }
682 
_ledc_set_fade_with_step(ledc_mode_t speed_mode,ledc_channel_t channel,uint32_t target_duty,int scale,int cycle_num)683 static esp_err_t _ledc_set_fade_with_step(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t target_duty, int scale, int cycle_num)
684 {
685     portENTER_CRITICAL(&ledc_spinlock);
686     uint32_t duty_cur = 0;
687     ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty_cur);
688     // When duty == max_duty, meanwhile, if scale == 1 and fade_down == 1, counter would overflow.
689     if (duty_cur == ledc_get_max_duty(speed_mode, channel)) {
690         duty_cur -= 1;
691     }
692     s_ledc_fade_rec[speed_mode][channel]->speed_mode = speed_mode;
693     s_ledc_fade_rec[speed_mode][channel]->target_duty = target_duty;
694     s_ledc_fade_rec[speed_mode][channel]->cycle_num = cycle_num;
695     s_ledc_fade_rec[speed_mode][channel]->scale = scale;
696     int step_num = 0;
697     int dir = LEDC_DUTY_DIR_DECREASE;
698     if (scale > 0) {
699         if (duty_cur > target_duty) {
700             s_ledc_fade_rec[speed_mode][channel]->direction = LEDC_DUTY_DIR_DECREASE;
701             step_num = (duty_cur - target_duty) / scale;
702             step_num = step_num > LEDC_STEP_NUM_MAX ? LEDC_STEP_NUM_MAX : step_num;
703         } else {
704             s_ledc_fade_rec[speed_mode][channel]->direction = LEDC_DUTY_DIR_INCREASE;
705             dir = LEDC_DUTY_DIR_INCREASE;
706             step_num = (target_duty - duty_cur) / scale;
707             step_num = step_num > LEDC_STEP_NUM_MAX ? LEDC_STEP_NUM_MAX : step_num;
708         }
709     }
710 
711     portEXIT_CRITICAL(&ledc_spinlock);
712     if (scale > 0 && step_num > 0) {
713         ledc_duty_config(speed_mode, channel, LEDC_VAL_NO_CHANGE, duty_cur, dir, step_num, cycle_num, scale);
714         ESP_LOGD(LEDC_TAG, "cur duty: %d; target: %d, step: %d, cycle: %d; scale: %d; dir: %d\n",
715                 duty_cur, target_duty, step_num, cycle_num, scale, dir);
716     } else {
717         ledc_duty_config(speed_mode, channel, LEDC_VAL_NO_CHANGE, target_duty, dir, 0, 1, 0);
718         ESP_LOGD(LEDC_TAG, "Set to target duty: %d", target_duty);
719     }
720     return ESP_OK;
721 }
722 
_ledc_set_fade_with_time(ledc_mode_t speed_mode,ledc_channel_t channel,uint32_t target_duty,int max_fade_time_ms)723 static esp_err_t _ledc_set_fade_with_time(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t target_duty, int max_fade_time_ms)
724 {
725     ledc_timer_t timer_sel;
726     uint32_t duty_cur = 0;
727     ledc_hal_get_channel_timer(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &timer_sel);
728     ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty_cur);
729     uint32_t freq = ledc_get_freq(speed_mode, timer_sel);
730     uint32_t duty_delta = target_duty > duty_cur ? target_duty - duty_cur : duty_cur - target_duty;
731 
732     if (duty_delta == 0) {
733         return _ledc_set_fade_with_step(speed_mode, channel, target_duty, 0, 0);
734     }
735     uint32_t total_cycles = max_fade_time_ms * freq / 1000;
736     if (total_cycles == 0) {
737         ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_FAST_STR);
738         return _ledc_set_fade_with_step(speed_mode, channel, target_duty, 0, 0);
739     }
740     int scale, cycle_num;
741     if (total_cycles > duty_delta) {
742         scale = 1;
743         cycle_num = total_cycles / duty_delta;
744         if (cycle_num > LEDC_DUTY_NUM_MAX) {
745             ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_SLOW_STR);
746             cycle_num = LEDC_DUTY_NUM_MAX;
747         }
748     } else {
749         cycle_num = 1;
750         scale = duty_delta / total_cycles;
751         if (scale > LEDC_DUTY_SCALE_MAX) {
752             ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_FAST_STR);
753             scale = LEDC_DUTY_SCALE_MAX;
754         }
755     }
756     return _ledc_set_fade_with_step(speed_mode, channel, target_duty, scale, cycle_num);
757 }
758 
_ledc_fade_start(ledc_mode_t speed_mode,ledc_channel_t channel,ledc_fade_mode_t fade_mode)759 static void _ledc_fade_start(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_fade_mode_t fade_mode)
760 {
761     s_ledc_fade_rec[speed_mode][channel]->mode = fade_mode;
762     // Clear interrupt status of channel
763     ledc_hal_clear_fade_end_intr_status(&(p_ledc_obj[speed_mode]->ledc_hal), channel);
764     // Enable interrupt for channel
765     ledc_enable_intr_type(speed_mode, channel, LEDC_INTR_FADE_END);
766     ledc_update_duty(speed_mode, channel);
767     if (fade_mode == LEDC_FADE_WAIT_DONE) {
768         xSemaphoreTake(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem, portMAX_DELAY);
769     }
770 }
771 
ledc_set_fade_with_time(ledc_mode_t speed_mode,ledc_channel_t channel,uint32_t target_duty,int max_fade_time_ms)772 esp_err_t ledc_set_fade_with_time(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t target_duty, int max_fade_time_ms)
773 {
774     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
775     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
776     LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
777     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
778     LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK , LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
779 
780     _ledc_fade_hw_acquire(speed_mode, channel);
781     _ledc_set_fade_with_time(speed_mode, channel, target_duty, max_fade_time_ms);
782     _ledc_fade_hw_release(speed_mode, channel);
783     return ESP_OK;
784 }
785 
ledc_set_fade_with_step(ledc_mode_t speed_mode,ledc_channel_t channel,uint32_t target_duty,uint32_t scale,uint32_t cycle_num)786 esp_err_t ledc_set_fade_with_step(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t target_duty, uint32_t scale, uint32_t cycle_num)
787 {
788     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
789     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
790     LEDC_ARG_CHECK((scale > 0) && (scale <= LEDC_DUTY_SCALE_MAX), "fade scale");
791     LEDC_ARG_CHECK((cycle_num > 0) && (cycle_num <= LEDC_DUTY_CYCLE_MAX), "cycle_num");
792     LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
793     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
794     LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK , LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
795 
796     _ledc_fade_hw_acquire(speed_mode, channel);
797     _ledc_set_fade_with_step(speed_mode, channel, target_duty, scale, cycle_num);
798     _ledc_fade_hw_release(speed_mode, channel);
799     return ESP_OK;
800 }
801 
ledc_fade_start(ledc_mode_t speed_mode,ledc_channel_t channel,ledc_fade_mode_t fade_mode)802 esp_err_t ledc_fade_start(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_fade_mode_t fade_mode)
803 {
804     LEDC_CHECK(s_ledc_fade_rec != NULL, LEDC_FADE_SERVICE_ERR_STR, ESP_ERR_INVALID_STATE);
805     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
806     LEDC_ARG_CHECK(fade_mode < LEDC_FADE_MAX, "fade_mode");
807     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
808     _ledc_fade_hw_acquire(speed_mode, channel);
809     _ledc_fade_start(speed_mode, channel, fade_mode);
810     _ledc_fade_hw_release(speed_mode, channel);
811     return ESP_OK;
812 }
813 
ledc_fade_func_install(int intr_alloc_flags)814 esp_err_t ledc_fade_func_install(int intr_alloc_flags)
815 {
816     //OR intr_alloc_flags with ESP_INTR_FLAG_IRAM because the fade isr is in IRAM
817     return ledc_isr_register(ledc_fade_isr, NULL, intr_alloc_flags | ESP_INTR_FLAG_IRAM, &s_ledc_fade_isr_handle);
818 }
819 
ledc_fade_func_uninstall(void)820 void ledc_fade_func_uninstall(void)
821 {
822     if (s_ledc_fade_rec == NULL) {
823         return;
824     }
825     if (s_ledc_fade_isr_handle) {
826         esp_intr_free(s_ledc_fade_isr_handle);
827         s_ledc_fade_isr_handle = NULL;
828     }
829     int channel, mode;
830     for (mode = 0; mode < LEDC_SPEED_MODE_MAX; mode++) {
831         for (channel = 0; channel < LEDC_CHANNEL_MAX; channel++) {
832             ledc_fade_channel_deinit(mode, channel);
833         }
834     }
835     return;
836 }
837 
838 /*
839  * The functions below are thread-safe version of APIs for duty and fade control.
840  * These APIs can be called from different tasks.
841  */
ledc_set_duty_and_update(ledc_mode_t speed_mode,ledc_channel_t channel,uint32_t duty,uint32_t hpoint)842 esp_err_t ledc_set_duty_and_update(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, uint32_t hpoint)
843 {
844     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
845     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
846     LEDC_ARG_CHECK(duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
847     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
848     LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK , LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
849     _ledc_op_lock_acquire(speed_mode, channel);
850     _ledc_fade_hw_acquire(speed_mode, channel);
851     _ledc_set_fade_with_step(speed_mode, channel, duty, 0, 1);
852     _ledc_fade_start(speed_mode, channel, LEDC_FADE_WAIT_DONE);
853     _ledc_fade_hw_release(speed_mode, channel);
854     _ledc_op_lock_release(speed_mode, channel);
855     return ESP_OK;
856 }
857 
ledc_set_fade_time_and_start(ledc_mode_t speed_mode,ledc_channel_t channel,uint32_t target_duty,uint32_t max_fade_time_ms,ledc_fade_mode_t fade_mode)858 esp_err_t ledc_set_fade_time_and_start(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t target_duty, uint32_t max_fade_time_ms, ledc_fade_mode_t fade_mode)
859 {
860     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
861     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
862     LEDC_ARG_CHECK(fade_mode < LEDC_FADE_MAX, "fade_mode");
863     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
864     LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK , LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
865     LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
866     _ledc_op_lock_acquire(speed_mode, channel);
867     _ledc_fade_hw_acquire(speed_mode, channel);
868     _ledc_set_fade_with_time(speed_mode, channel, target_duty, max_fade_time_ms);
869     _ledc_fade_start(speed_mode, channel, fade_mode);
870     if (fade_mode == LEDC_FADE_WAIT_DONE) {
871         _ledc_fade_hw_release(speed_mode, channel);
872     }
873     _ledc_op_lock_release(speed_mode, channel);
874     return ESP_OK;
875 }
876 
ledc_set_fade_step_and_start(ledc_mode_t speed_mode,ledc_channel_t channel,uint32_t target_duty,uint32_t scale,uint32_t cycle_num,ledc_fade_mode_t fade_mode)877 esp_err_t ledc_set_fade_step_and_start(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t target_duty, uint32_t scale, uint32_t cycle_num, ledc_fade_mode_t fade_mode)
878 {
879     LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
880     LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
881     LEDC_ARG_CHECK(fade_mode < LEDC_FADE_MAX, "fade_mode");
882     LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
883     LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK , LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
884     LEDC_ARG_CHECK((scale > 0) && (scale <= LEDC_DUTY_SCALE_MAX), "fade scale");
885     LEDC_ARG_CHECK((cycle_num > 0) && (cycle_num <= LEDC_DUTY_CYCLE_MAX), "cycle_num");
886     LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
887     _ledc_op_lock_acquire(speed_mode, channel);
888     _ledc_fade_hw_acquire(speed_mode, channel);
889     _ledc_set_fade_with_step(speed_mode, channel, target_duty, scale, cycle_num);
890     _ledc_fade_start(speed_mode, channel, fade_mode);
891     if (fade_mode == LEDC_FADE_WAIT_DONE) {
892         _ledc_fade_hw_release(speed_mode, channel);
893     }
894     _ledc_op_lock_release(speed_mode, channel);
895     return ESP_OK;
896 }
897