ledc.c 69 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539
  1. /*
  2. * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD
  3. *
  4. * SPDX-License-Identifier: Apache-2.0
  5. */
  6. #include <string.h>
  7. #include "esp_types.h"
  8. #include "freertos/FreeRTOS.h"
  9. #include "freertos/semphr.h"
  10. #include "esp_log.h"
  11. #include "esp_check.h"
  12. #include "soc/gpio_periph.h"
  13. #include "soc/ledc_periph.h"
  14. #include "esp_clk_tree.h"
  15. #include "soc/soc_caps.h"
  16. #include "hal/ledc_hal.h"
  17. #include "hal/gpio_hal.h"
  18. #include "driver/ledc.h"
  19. #include "esp_rom_gpio.h"
  20. #include "esp_rom_sys.h"
  21. #include "clk_ctrl_os.h"
  22. #include "esp_private/periph_ctrl.h"
  23. #include "esp_memory_utils.h"
  24. static __attribute__((unused)) const char *LEDC_TAG = "ledc";
  25. #define LEDC_CHECK(a, str, ret_val) ESP_RETURN_ON_FALSE(a, ret_val, LEDC_TAG, "%s", str)
  26. #define LEDC_ARG_CHECK(a, param) ESP_RETURN_ON_FALSE(a, ESP_ERR_INVALID_ARG, LEDC_TAG, param " argument is invalid")
  27. #define LEDC_CHECK_ISR(a, str, ret_val) ESP_RETURN_ON_FALSE_ISR(a, ret_val, LEDC_TAG, "%s", str)
  28. #define LEDC_ARG_CHECK_ISR(a, param) ESP_RETURN_ON_FALSE_ISR(a, ESP_ERR_INVALID_ARG, LEDC_TAG, param " argument is invalid")
  29. #define LEDC_CLK_NOT_FOUND 0
  30. #define LEDC_SLOW_CLK_UNINIT -1
  31. #define LEDC_TIMER_SPECIFIC_CLK_UNINIT -1
  32. // Precision degree only affects RC_FAST, other clock sources' frequences are fixed values
  33. // For targets that do not support RC_FAST calibration, can only use its approx. value. Precision degree other than
  34. // APPROX will trigger LOGW during the call to `esp_clk_tree_src_get_freq_hz`.
  35. #if SOC_CLK_RC_FAST_SUPPORT_CALIBRATION
  36. #define LEDC_CLK_SRC_FREQ_PRECISION ESP_CLK_TREE_SRC_FREQ_PRECISION_CACHED
  37. #else
  38. #define LEDC_CLK_SRC_FREQ_PRECISION ESP_CLK_TREE_SRC_FREQ_PRECISION_APPROX
  39. #endif
  40. typedef enum {
  41. LEDC_FSM_IDLE,
  42. LEDC_FSM_HW_FADE,
  43. LEDC_FSM_ISR_CAL,
  44. LEDC_FSM_KILLED_PENDING,
  45. } ledc_fade_fsm_t;
  46. typedef struct {
  47. ledc_mode_t speed_mode;
  48. ledc_duty_direction_t direction;
  49. uint32_t target_duty;
  50. int cycle_num;
  51. int scale;
  52. ledc_fade_mode_t mode;
  53. SemaphoreHandle_t ledc_fade_sem;
  54. SemaphoreHandle_t ledc_fade_mux;
  55. #if CONFIG_SPIRAM_USE_MALLOC
  56. StaticQueue_t ledc_fade_sem_storage;
  57. #endif
  58. ledc_cb_t ledc_fade_callback;
  59. void *cb_user_arg;
  60. volatile ledc_fade_fsm_t fsm;
  61. } ledc_fade_t;
  62. typedef struct {
  63. ledc_hal_context_t ledc_hal; /*!< LEDC hal context */
  64. ledc_slow_clk_sel_t glb_clk; /*!< LEDC global clock selection */
  65. bool timer_is_stopped[LEDC_TIMER_MAX]; /*!< Indicates whether each timer has been stopped */
  66. bool glb_clk_is_acquired[LEDC_TIMER_MAX]; /*!< Tracks whether the global clock is being acquired by each timer */
  67. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  68. ledc_clk_src_t timer_specific_clk[LEDC_TIMER_MAX]; /*!< Tracks the timer-specific clock selection for each timer */
  69. #endif
  70. } ledc_obj_t;
  71. static ledc_obj_t *p_ledc_obj[LEDC_SPEED_MODE_MAX] = {0};
  72. static ledc_fade_t *s_ledc_fade_rec[LEDC_SPEED_MODE_MAX][LEDC_CHANNEL_MAX];
  73. static ledc_isr_handle_t s_ledc_fade_isr_handle = NULL;
  74. static portMUX_TYPE ledc_spinlock = portMUX_INITIALIZER_UNLOCKED;
  75. static _lock_t s_ledc_mutex[LEDC_SPEED_MODE_MAX];
  76. #define LEDC_VAL_NO_CHANGE (-1)
  77. #define LEDC_DUTY_NUM_MAX LEDC_LL_DUTY_NUM_MAX // Maximum steps per hardware fade
  78. #define LEDC_DUTY_DECIMAL_BIT_NUM (4)
  79. #define LEDC_TIMER_DIV_NUM_MAX (0x3FFFF)
  80. #define LEDC_FADE_TOO_SLOW_STR "LEDC FADE TOO SLOW"
  81. #define LEDC_FADE_TOO_FAST_STR "LEDC FADE TOO FAST"
  82. #define DIM(array) (sizeof(array)/sizeof(*array))
  83. #define LEDC_IS_DIV_INVALID(div) ((div) <= LEDC_LL_FRACTIONAL_MAX || (div) > LEDC_TIMER_DIV_NUM_MAX)
  84. static __attribute__((unused)) const char *LEDC_NOT_INIT = "LEDC is not initialized";
  85. static __attribute__((unused)) const char *LEDC_FADE_SERVICE_ERR_STR = "LEDC fade service not installed";
  86. static __attribute__((unused)) const char *LEDC_FADE_INIT_ERROR_STR = "LEDC fade channel init error, not enough memory or service not installed";
  87. //This value will be calibrated when in use.
  88. static uint32_t s_ledc_slow_clk_rc_fast_freq = 0;
  89. static const ledc_slow_clk_sel_t s_glb_clks[] = LEDC_LL_GLOBAL_CLOCKS;
  90. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  91. static const ledc_clk_src_t s_timer_specific_clks[] = LEDC_LL_TIMER_SPECIFIC_CLOCKS;
  92. #endif
  93. static void ledc_ls_timer_update(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
  94. {
  95. if (speed_mode == LEDC_LOW_SPEED_MODE) {
  96. ledc_hal_ls_timer_update(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
  97. }
  98. }
  99. static IRAM_ATTR void ledc_ls_channel_update(ledc_mode_t speed_mode, ledc_channel_t channel)
  100. {
  101. if (speed_mode == LEDC_LOW_SPEED_MODE) {
  102. ledc_hal_ls_channel_update(&(p_ledc_obj[speed_mode]->ledc_hal), channel);
  103. }
  104. }
  105. //We know that RC_FAST is about 8M/20M, but don't know the actual value. So we need to do a calibration.
  106. static bool ledc_slow_clk_calibrate(void)
  107. {
  108. if (periph_rtc_dig_clk8m_enable()) {
  109. s_ledc_slow_clk_rc_fast_freq = periph_rtc_dig_clk8m_get_freq();
  110. #if !SOC_CLK_RC_FAST_SUPPORT_CALIBRATION
  111. /* Workaround: RC_FAST calibration cannot be performed, we can only use its theoretic freq */
  112. ESP_LOGD(LEDC_TAG, "Calibration cannot be performed, approximate RC_FAST_CLK : %"PRIu32" Hz", s_ledc_slow_clk_rc_fast_freq);
  113. #else
  114. ESP_LOGD(LEDC_TAG, "Calibrate RC_FAST_CLK : %"PRIu32" Hz", s_ledc_slow_clk_rc_fast_freq);
  115. #endif
  116. return true;
  117. }
  118. ESP_LOGE(LEDC_TAG, "Calibrate RC_FAST_CLK failed");
  119. return false;
  120. }
  121. static esp_err_t ledc_enable_intr_type(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_intr_type_t type)
  122. {
  123. if (type == LEDC_INTR_FADE_END) {
  124. ledc_hal_set_fade_end_intr(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
  125. } else {
  126. ledc_hal_set_fade_end_intr(&(p_ledc_obj[speed_mode]->ledc_hal), channel, false);
  127. }
  128. return ESP_OK;
  129. }
  130. static void _ledc_fade_hw_acquire(ledc_mode_t mode, ledc_channel_t channel)
  131. {
  132. ledc_fade_t *fade = s_ledc_fade_rec[mode][channel];
  133. if (fade) {
  134. xSemaphoreTake(fade->ledc_fade_sem, portMAX_DELAY);
  135. portENTER_CRITICAL(&ledc_spinlock);
  136. ledc_enable_intr_type(mode, channel, LEDC_INTR_DISABLE);
  137. portEXIT_CRITICAL(&ledc_spinlock);
  138. }
  139. }
  140. static void _ledc_fade_hw_release(ledc_mode_t mode, ledc_channel_t channel)
  141. {
  142. ledc_fade_t *fade = s_ledc_fade_rec[mode][channel];
  143. if (fade) {
  144. xSemaphoreGive(fade->ledc_fade_sem);
  145. }
  146. }
  147. static void _ledc_op_lock_acquire(ledc_mode_t mode, ledc_channel_t channel)
  148. {
  149. ledc_fade_t *fade = s_ledc_fade_rec[mode][channel];
  150. if (fade) {
  151. xSemaphoreTake(fade->ledc_fade_mux, portMAX_DELAY);
  152. }
  153. }
  154. static void _ledc_op_lock_release(ledc_mode_t mode, ledc_channel_t channel)
  155. {
  156. ledc_fade_t *fade = s_ledc_fade_rec[mode][channel];
  157. if (fade) {
  158. xSemaphoreGive(fade->ledc_fade_mux);
  159. }
  160. }
  161. static uint32_t ledc_get_max_duty(ledc_mode_t speed_mode, ledc_channel_t channel)
  162. {
  163. // The arguments are checked before internally calling this function.
  164. ledc_timer_t timer_sel;
  165. ledc_hal_get_channel_timer(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &timer_sel);
  166. uint32_t max_duty;
  167. ledc_hal_get_max_duty(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel, &max_duty);
  168. return max_duty;
  169. }
  170. esp_err_t ledc_timer_set(ledc_mode_t speed_mode, ledc_timer_t timer_sel, uint32_t clock_divider, uint32_t duty_resolution,
  171. ledc_clk_src_t clk_src)
  172. {
  173. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  174. LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
  175. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  176. portENTER_CRITICAL(&ledc_spinlock);
  177. ledc_hal_set_clock_divider(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel, clock_divider);
  178. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  179. /* Clock source can only be configured on targets which support timer-specific source clock. */
  180. ledc_hal_set_clock_source(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel, clk_src);
  181. // TODO: acquire clk_src, and release old clk_src if initialized and different than new one [clk_tree]
  182. p_ledc_obj[speed_mode]->timer_specific_clk[timer_sel] = clk_src;
  183. #endif
  184. ledc_hal_set_duty_resolution(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel, duty_resolution);
  185. ledc_ls_timer_update(speed_mode, timer_sel);
  186. portEXIT_CRITICAL(&ledc_spinlock);
  187. return ESP_OK;
  188. }
  189. static IRAM_ATTR esp_err_t ledc_duty_config(ledc_mode_t speed_mode, ledc_channel_t channel, int hpoint_val,
  190. int duty_val, ledc_duty_direction_t duty_direction, uint32_t duty_num, uint32_t duty_cycle, uint32_t duty_scale)
  191. {
  192. if (hpoint_val >= 0) {
  193. ledc_hal_set_hpoint(&(p_ledc_obj[speed_mode]->ledc_hal), channel, hpoint_val);
  194. }
  195. if (duty_val >= 0) {
  196. ledc_hal_set_duty_int_part(&(p_ledc_obj[speed_mode]->ledc_hal), channel, duty_val);
  197. }
  198. ledc_hal_set_fade_param(&(p_ledc_obj[speed_mode]->ledc_hal), channel, 0, duty_direction, duty_cycle, duty_scale, duty_num);
  199. #if SOC_LEDC_GAMMA_CURVE_FADE_SUPPORTED
  200. ledc_hal_set_range_number(&(p_ledc_obj[speed_mode]->ledc_hal), channel, 1);
  201. #endif
  202. return ESP_OK;
  203. }
  204. esp_err_t ledc_bind_channel_timer(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_timer_t timer_sel)
  205. {
  206. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  207. LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
  208. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  209. portENTER_CRITICAL(&ledc_spinlock);
  210. ledc_hal_bind_channel_timer(&(p_ledc_obj[speed_mode]->ledc_hal), channel, timer_sel);
  211. ledc_ls_channel_update(speed_mode, channel);
  212. portEXIT_CRITICAL(&ledc_spinlock);
  213. return ESP_OK;
  214. }
  215. esp_err_t ledc_timer_rst(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
  216. {
  217. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  218. LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
  219. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  220. portENTER_CRITICAL(&ledc_spinlock);
  221. ledc_hal_timer_rst(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
  222. portEXIT_CRITICAL(&ledc_spinlock);
  223. return ESP_OK;
  224. }
  225. esp_err_t ledc_timer_pause(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
  226. {
  227. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  228. LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
  229. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  230. portENTER_CRITICAL(&ledc_spinlock);
  231. p_ledc_obj[speed_mode]->timer_is_stopped[timer_sel] = true;
  232. ledc_hal_timer_pause(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
  233. portEXIT_CRITICAL(&ledc_spinlock);
  234. return ESP_OK;
  235. }
  236. esp_err_t ledc_timer_resume(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. p_ledc_obj[speed_mode]->timer_is_stopped[timer_sel] = false;
  243. ledc_hal_timer_resume(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
  244. portEXIT_CRITICAL(&ledc_spinlock);
  245. return ESP_OK;
  246. }
  247. esp_err_t ledc_isr_register(void (*fn)(void *), void *arg, int intr_alloc_flags, ledc_isr_handle_t *handle)
  248. {
  249. esp_err_t ret;
  250. LEDC_ARG_CHECK(fn, "fn");
  251. portENTER_CRITICAL(&ledc_spinlock);
  252. ret = esp_intr_alloc(ETS_LEDC_INTR_SOURCE, intr_alloc_flags, fn, arg, handle);
  253. portEXIT_CRITICAL(&ledc_spinlock);
  254. return ret;
  255. }
  256. static bool ledc_speed_mode_ctx_create(ledc_mode_t speed_mode)
  257. {
  258. bool new_ctx = false;
  259. // Prevent p_ledc_obj malloc concurrently
  260. _lock_acquire(&s_ledc_mutex[speed_mode]);
  261. if (!p_ledc_obj[speed_mode]) {
  262. ledc_obj_t *ledc_new_mode_obj = (ledc_obj_t *) heap_caps_calloc(1, sizeof(ledc_obj_t), MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
  263. if (ledc_new_mode_obj) {
  264. new_ctx = true;
  265. ledc_hal_init(&(ledc_new_mode_obj->ledc_hal), speed_mode);
  266. ledc_new_mode_obj->glb_clk = LEDC_SLOW_CLK_UNINIT;
  267. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  268. memset(ledc_new_mode_obj->timer_specific_clk, LEDC_TIMER_SPECIFIC_CLK_UNINIT, sizeof(ledc_clk_src_t) * LEDC_TIMER_MAX);
  269. #endif
  270. p_ledc_obj[speed_mode] = ledc_new_mode_obj;
  271. // Enable APB access to LEDC registers
  272. periph_module_enable(PERIPH_LEDC_MODULE);
  273. }
  274. }
  275. _lock_release(&s_ledc_mutex[speed_mode]);
  276. return new_ctx;
  277. }
  278. static inline uint32_t ledc_calculate_divisor(uint32_t src_clk_freq, int freq_hz, uint32_t precision)
  279. {
  280. /**
  281. * In order to find the right divisor, we need to divide the source clock
  282. * frequency by the desired frequency. However, two things to note here:
  283. * - The lowest LEDC_LL_FRACTIONAL_BITS bits of the result are the FRACTIONAL
  284. * part. The higher bits represent the integer part, this is why we need
  285. * to right shift the source frequency.
  286. * - The `precision` parameter represents the granularity of the clock. It
  287. * **must** be a power of 2. It means that the resulted divisor is
  288. * a multiplier of `precision`.
  289. *
  290. * Let's take a concrete example, we need to generate a 5KHz clock out of
  291. * a 80MHz clock (APB).
  292. * If the precision is 1024 (10 bits), the resulted multiplier is:
  293. * (80000000 << 8) / (5000 * 1024) = 4000 (0xfa0)
  294. * Let's ignore the fractional part to simplify the explanation, so we get
  295. * a result of 15 (0xf).
  296. * This can be interpreted as: every 15 "precision" ticks, the resulted
  297. * clock will go high, where one precision tick is made out of 1024 source
  298. * clock ticks.
  299. * Thus, every `15 * 1024` source clock ticks, the resulted clock will go
  300. * high.
  301. *
  302. * NOTE: We are also going to round up the value when necessary, thanks to:
  303. * (freq_hz * precision) / 2
  304. */
  305. return ( ( (uint64_t) src_clk_freq << LEDC_LL_FRACTIONAL_BITS ) + ((freq_hz * precision) / 2 ) )
  306. / (freq_hz * precision);
  307. }
  308. static inline uint32_t ledc_auto_global_clk_divisor(int freq_hz, uint32_t precision, ledc_slow_clk_sel_t *clk_target)
  309. {
  310. uint32_t ret = LEDC_CLK_NOT_FOUND;
  311. uint32_t clk_freq = 0;
  312. /* This function will go through all the following clock sources to look
  313. * for a valid divisor which generates the requested frequency. */
  314. for (int i = 0; i < DIM(s_glb_clks); i++) {
  315. /* Before calculating the divisor, we need to have the RC_FAST frequency.
  316. * If it hasn't been measured yet, try calibrating it now. */
  317. if (s_glb_clks[i] == LEDC_SLOW_CLK_RC_FAST && s_ledc_slow_clk_rc_fast_freq == 0 && !ledc_slow_clk_calibrate()) {
  318. ESP_LOGD(LEDC_TAG, "Unable to retrieve RC_FAST clock frequency, skipping it");
  319. continue;
  320. }
  321. esp_clk_tree_src_get_freq_hz((soc_module_clk_t)s_glb_clks[i], LEDC_CLK_SRC_FREQ_PRECISION, &clk_freq);
  322. uint32_t div_param = ledc_calculate_divisor(clk_freq, freq_hz, precision);
  323. /* If the divisor is valid, we can return this value. */
  324. if (!LEDC_IS_DIV_INVALID(div_param)) {
  325. *clk_target = s_glb_clks[i];
  326. ret = div_param;
  327. break;
  328. }
  329. }
  330. return ret;
  331. }
  332. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  333. static inline uint32_t ledc_auto_timer_specific_clk_divisor(ledc_mode_t speed_mode, int freq_hz, uint32_t precision,
  334. ledc_clk_src_t *clk_source)
  335. {
  336. uint32_t ret = LEDC_CLK_NOT_FOUND;
  337. uint32_t clk_freq = 0;
  338. for (int i = 0; i < DIM(s_timer_specific_clks); i++) {
  339. esp_clk_tree_src_get_freq_hz((soc_module_clk_t)s_timer_specific_clks[i], LEDC_CLK_SRC_FREQ_PRECISION, &clk_freq);
  340. uint32_t div_param = ledc_calculate_divisor(clk_freq, freq_hz, precision);
  341. /* If the divisor is valid, we can return this value. */
  342. if (!LEDC_IS_DIV_INVALID(div_param)) {
  343. *clk_source = s_timer_specific_clks[i];
  344. ret = div_param;
  345. break;
  346. }
  347. }
  348. #if SOC_LEDC_SUPPORT_HS_MODE
  349. /* On board that support LEDC high-speed mode, APB clock becomes a timer-
  350. * specific clock when in high speed mode. Check if it is necessary here
  351. * to test APB. */
  352. if (speed_mode == LEDC_HIGH_SPEED_MODE && ret == LEDC_CLK_NOT_FOUND) {
  353. /* No divider was found yet, try with APB! */
  354. esp_clk_tree_src_get_freq_hz((soc_module_clk_t)LEDC_APB_CLK, LEDC_CLK_SRC_FREQ_PRECISION, &clk_freq);
  355. uint32_t div_param = ledc_calculate_divisor(clk_freq, freq_hz, precision);
  356. if (!LEDC_IS_DIV_INVALID(div_param)) {
  357. *clk_source = LEDC_APB_CLK;
  358. ret = div_param;
  359. }
  360. }
  361. #endif
  362. return ret;
  363. }
  364. #endif
  365. /**
  366. * @brief Try to find the clock with its divisor giving the frequency requested
  367. * by the caller.
  368. */
  369. static uint32_t ledc_auto_clk_divisor(ledc_mode_t speed_mode, int freq_hz, uint32_t precision,
  370. ledc_clk_src_t *clk_source, ledc_slow_clk_sel_t *clk_target)
  371. {
  372. uint32_t ret = LEDC_CLK_NOT_FOUND;
  373. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  374. /* If the SoC presents timer-specific clock(s), try to achieve the given frequency
  375. * thanks to it/them.
  376. * clk_source parameter will returned by this function. */
  377. uint32_t div_param_timer = ledc_auto_timer_specific_clk_divisor(speed_mode, freq_hz, precision, clk_source);
  378. if (div_param_timer != LEDC_CLK_NOT_FOUND) {
  379. /* The dividor is valid, no need try any other clock, return directly. */
  380. ret = div_param_timer;
  381. }
  382. #endif
  383. /* On ESP32, only low speed channel can use the global clocks. For other
  384. * chips, there are no high speed channels. */
  385. if (ret == LEDC_CLK_NOT_FOUND && speed_mode == LEDC_LOW_SPEED_MODE) {
  386. uint32_t div_param_global = ledc_auto_global_clk_divisor(freq_hz, precision, clk_target);
  387. if (div_param_global != LEDC_CLK_NOT_FOUND) {
  388. *clk_source = LEDC_SCLK;
  389. ret = div_param_global;
  390. }
  391. }
  392. return ret;
  393. }
  394. extern void esp_sleep_periph_use_8m(bool use_or_not);
  395. /**
  396. * @brief Function setting the LEDC timer divisor with the given source clock,
  397. * frequency and resolution. If the clock configuration passed is
  398. * LEDC_AUTO_CLK, the clock will be determined automatically (if possible).
  399. */
  400. 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)
  401. {
  402. uint32_t div_param = 0;
  403. const uint32_t precision = ( 0x1 << duty_resolution );
  404. /* The clock sources are not initialized on purpose. To produce compiler warning if used but the selector functions
  405. * don't set them properly. */
  406. /* Timer-specific mux. Set to timer-specific clock or LEDC_SCLK if a global clock is used. */
  407. ledc_clk_src_t timer_clk_src;
  408. /* Global clock mux. Should be set when LEDC_SCLK is used in LOW_SPEED_MODE. Otherwise left uninitialized. */
  409. ledc_slow_clk_sel_t glb_clk = LEDC_SLOW_CLK_UNINIT;
  410. if (clk_cfg == LEDC_AUTO_CLK) {
  411. /* User hasn't specified the speed, we should try to guess it. */
  412. div_param = ledc_auto_clk_divisor(speed_mode, freq_hz, precision, &timer_clk_src, &glb_clk);
  413. } else if (clk_cfg == LEDC_USE_RC_FAST_CLK) {
  414. /* User specified source clock(RC_FAST_CLK) for low speed channel.
  415. * Make sure the speed mode is correct. */
  416. ESP_RETURN_ON_FALSE((speed_mode == LEDC_LOW_SPEED_MODE), ESP_ERR_INVALID_ARG, LEDC_TAG, "RC_FAST clock can only be used in low speed mode");
  417. /* Before calculating the divisor, we need to have the RC_FAST frequency.
  418. * If it hasn't been measured yet, try calibrating it now. */
  419. if(s_ledc_slow_clk_rc_fast_freq == 0 && ledc_slow_clk_calibrate() == false) {
  420. goto error;
  421. }
  422. /* Set the global clock source */
  423. timer_clk_src = LEDC_SCLK;
  424. glb_clk = LEDC_SLOW_CLK_RC_FAST;
  425. /* We have the RC_FAST clock frequency now. */
  426. div_param = ledc_calculate_divisor(s_ledc_slow_clk_rc_fast_freq, freq_hz, precision);
  427. if (LEDC_IS_DIV_INVALID(div_param)) {
  428. div_param = LEDC_CLK_NOT_FOUND;
  429. }
  430. } else {
  431. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  432. if (LEDC_LL_IS_TIMER_SPECIFIC_CLOCK(speed_mode, clk_cfg)) {
  433. /* Currently we can convert a timer-specific clock to a source clock that
  434. * easily because their values are identical in the enumerations (on purpose)
  435. * If we decide to change the values in the future, we should consider defining
  436. * a macro/function to convert timer-specific clock to clock source .*/
  437. timer_clk_src = (ledc_clk_src_t) clk_cfg;
  438. } else
  439. #endif
  440. {
  441. timer_clk_src = LEDC_SCLK;
  442. #if SOC_LEDC_SUPPORT_REF_TICK
  443. assert(clk_cfg != LEDC_USE_REF_TICK); // REF_TICK is NOT a global clock, it is a timer-specific clock
  444. #endif
  445. glb_clk = (ledc_slow_clk_sel_t)clk_cfg;
  446. }
  447. uint32_t src_clk_freq = 0;
  448. esp_clk_tree_src_get_freq_hz((soc_module_clk_t)clk_cfg, LEDC_CLK_SRC_FREQ_PRECISION, &src_clk_freq);
  449. div_param = ledc_calculate_divisor(src_clk_freq, freq_hz, precision);
  450. if (LEDC_IS_DIV_INVALID(div_param)) {
  451. div_param = LEDC_CLK_NOT_FOUND;
  452. }
  453. }
  454. if (div_param == LEDC_CLK_NOT_FOUND) {
  455. goto error;
  456. }
  457. /* The following debug message makes more sense for AUTO mode. */
  458. ESP_LOGD(LEDC_TAG, "Using clock source %d (in %s mode), divisor: 0x%"PRIx32,
  459. timer_clk_src, (speed_mode == LEDC_LOW_SPEED_MODE ? "slow" : "fast"), div_param);
  460. /* The following block configures the global clock.
  461. * Thus, in theory, this only makes sense when configuring the LOW_SPEED timer and the source clock is LEDC_SCLK (as
  462. * HIGH_SPEED timers won't be clocked by the global clock). However, there are some limitations due to HW design.
  463. */
  464. if (speed_mode == LEDC_LOW_SPEED_MODE) {
  465. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  466. /* On ESP32 and ESP32-S2, when the source clock of LOW_SPEED timer is a timer-specific one (i.e. REF_TICK), the
  467. * global clock MUST be set to APB_CLK. For HIGH_SPEED timers, this is not necessary.
  468. */
  469. if (timer_clk_src != LEDC_SCLK) {
  470. glb_clk = LEDC_SLOW_CLK_APB;
  471. }
  472. #else
  473. /* On later chips, there is only one type of timer/channel (referred as LOW_SPEED in the code), which can only be
  474. * clocked by the global clock. So there's no limitation on the global clock, except that it must be set.
  475. */
  476. assert(timer_clk_src == LEDC_SCLK);
  477. #endif
  478. // Arriving here, variable glb_clk must have been assigned to one of the ledc_slow_clk_sel_t enum values
  479. assert(glb_clk != LEDC_SLOW_CLK_UNINIT);
  480. portENTER_CRITICAL(&ledc_spinlock);
  481. if (p_ledc_obj[speed_mode]->glb_clk != LEDC_SLOW_CLK_UNINIT && p_ledc_obj[speed_mode]->glb_clk != glb_clk) {
  482. for (int i = 0; i < LEDC_TIMER_MAX; i++) {
  483. if (i != timer_num && p_ledc_obj[speed_mode]->glb_clk_is_acquired[i]) {
  484. portEXIT_CRITICAL(&ledc_spinlock);
  485. ESP_RETURN_ON_FALSE(false, ESP_FAIL, LEDC_TAG,
  486. "timer clock conflict, already is %d but attempt to %d", p_ledc_obj[speed_mode]->glb_clk, glb_clk);
  487. }
  488. }
  489. }
  490. p_ledc_obj[speed_mode]->glb_clk_is_acquired[timer_num] = true;
  491. if (p_ledc_obj[speed_mode]->glb_clk != glb_clk) {
  492. // TODO: release old glb_clk (if not UNINIT), and acquire new glb_clk [clk_tree]
  493. p_ledc_obj[speed_mode]->glb_clk = glb_clk;
  494. ledc_hal_set_slow_clk_sel(&(p_ledc_obj[speed_mode]->ledc_hal), glb_clk);
  495. }
  496. portEXIT_CRITICAL(&ledc_spinlock);
  497. ESP_LOGD(LEDC_TAG, "In slow speed mode, global clk set: %d", glb_clk);
  498. /* keep ESP_PD_DOMAIN_RC_FAST on during light sleep */
  499. esp_sleep_periph_use_8m(glb_clk == LEDC_SLOW_CLK_RC_FAST);
  500. }
  501. /* The divisor is correct, we can write in the hardware. */
  502. ledc_timer_set(speed_mode, timer_num, div_param, duty_resolution, timer_clk_src);
  503. return ESP_OK;
  504. error:
  505. ESP_LOGE(LEDC_TAG, "requested frequency and duty resolution can not be achieved, try reducing freq_hz or duty_resolution. div_param=%"PRIu32, div_param);
  506. return ESP_FAIL;
  507. }
  508. static esp_err_t ledc_timer_del(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
  509. {
  510. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  511. bool is_configured = true;
  512. bool is_deleted = false;
  513. portENTER_CRITICAL(&ledc_spinlock);
  514. if (p_ledc_obj[speed_mode]->glb_clk_is_acquired[timer_sel] == false
  515. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  516. && p_ledc_obj[speed_mode]->timer_specific_clk[timer_sel] == LEDC_TIMER_SPECIFIC_CLK_UNINIT
  517. #endif
  518. ) {
  519. is_configured = false;
  520. } else if (p_ledc_obj[speed_mode]->timer_is_stopped[timer_sel] == true) {
  521. is_deleted = true;
  522. p_ledc_obj[speed_mode]->glb_clk_is_acquired[timer_sel] = false;
  523. // TODO: release timer specific clk and global clk if possible [clk_tree]
  524. }
  525. portEXIT_CRITICAL(&ledc_spinlock);
  526. ESP_RETURN_ON_FALSE(is_configured && is_deleted, ESP_ERR_INVALID_STATE, LEDC_TAG, "timer hasn't been configured, or it is still running, please stop it with ledc_timer_pause first");
  527. return ESP_OK;
  528. }
  529. esp_err_t ledc_timer_config(const ledc_timer_config_t *timer_conf)
  530. {
  531. LEDC_ARG_CHECK(timer_conf != NULL, "timer_conf");
  532. uint32_t freq_hz = timer_conf->freq_hz;
  533. uint32_t duty_resolution = timer_conf->duty_resolution;
  534. uint32_t timer_num = timer_conf->timer_num;
  535. uint32_t speed_mode = timer_conf->speed_mode;
  536. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  537. LEDC_ARG_CHECK(timer_num < LEDC_TIMER_MAX, "timer_num");
  538. if (timer_conf->deconfigure) {
  539. return ledc_timer_del(speed_mode, timer_num);
  540. }
  541. LEDC_ARG_CHECK(!((timer_conf->clk_cfg == LEDC_USE_RC_FAST_CLK) && (speed_mode != LEDC_LOW_SPEED_MODE)), "Only low speed channel support RC_FAST_CLK");
  542. if (freq_hz == 0 || duty_resolution == 0 || duty_resolution >= LEDC_TIMER_BIT_MAX) {
  543. ESP_LOGE(LEDC_TAG, "freq_hz=%"PRIu32" duty_resolution=%"PRIu32, freq_hz, duty_resolution);
  544. return ESP_ERR_INVALID_ARG;
  545. }
  546. if (!ledc_speed_mode_ctx_create(speed_mode) && !p_ledc_obj[speed_mode]) {
  547. return ESP_ERR_NO_MEM;
  548. }
  549. esp_err_t ret = ledc_set_timer_div(speed_mode, timer_num, timer_conf->clk_cfg, freq_hz, duty_resolution);
  550. if (ret == ESP_OK) {
  551. /* Make sure timer is running and reset the timer. */
  552. ledc_timer_resume(speed_mode, timer_num);
  553. ledc_timer_rst(speed_mode, timer_num);
  554. }
  555. return ret;
  556. }
  557. esp_err_t ledc_set_pin(int gpio_num, ledc_mode_t speed_mode, ledc_channel_t ledc_channel)
  558. {
  559. LEDC_ARG_CHECK(ledc_channel < LEDC_CHANNEL_MAX, "ledc_channel");
  560. LEDC_ARG_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(gpio_num), "gpio_num");
  561. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  562. gpio_hal_iomux_func_sel(GPIO_PIN_MUX_REG[gpio_num], PIN_FUNC_GPIO);
  563. gpio_set_direction(gpio_num, GPIO_MODE_OUTPUT);
  564. esp_rom_gpio_connect_out_signal(gpio_num, ledc_periph_signal[speed_mode].sig_out0_idx + ledc_channel, 0, 0);
  565. return ESP_OK;
  566. }
  567. esp_err_t ledc_channel_config(const ledc_channel_config_t *ledc_conf)
  568. {
  569. LEDC_ARG_CHECK(ledc_conf, "ledc_conf");
  570. uint32_t speed_mode = ledc_conf->speed_mode;
  571. int gpio_num = ledc_conf->gpio_num;
  572. uint32_t ledc_channel = ledc_conf->channel;
  573. uint32_t timer_select = ledc_conf->timer_sel;
  574. uint32_t intr_type = ledc_conf->intr_type;
  575. uint32_t duty = ledc_conf->duty;
  576. uint32_t hpoint = ledc_conf->hpoint;
  577. bool output_invert = ledc_conf->flags.output_invert;
  578. LEDC_ARG_CHECK(ledc_channel < LEDC_CHANNEL_MAX, "ledc_channel");
  579. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  580. LEDC_ARG_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(gpio_num), "gpio_num");
  581. LEDC_ARG_CHECK(timer_select < LEDC_TIMER_MAX, "timer_select");
  582. LEDC_ARG_CHECK(intr_type < LEDC_INTR_MAX, "intr_type");
  583. esp_err_t ret = ESP_OK;
  584. bool new_speed_mode_ctx_created = ledc_speed_mode_ctx_create(speed_mode);
  585. if (!new_speed_mode_ctx_created && !p_ledc_obj[speed_mode]) {
  586. return ESP_ERR_NO_MEM;
  587. }
  588. #if !(CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32H2)
  589. // On such targets, the default ledc core(global) clock does not connect to any clock source
  590. // Set channel configurations and update bits before core clock is on could lead to error
  591. // Therefore, we should connect the core clock to a real clock source to make it on before any ledc register operation
  592. // It can be switched to the other desired clock sources to meet the output pwm freq requirement later at timer configuration
  593. // So we consider the glb_clk still as LEDC_SLOW_CLK_UNINIT
  594. else if (new_speed_mode_ctx_created) {
  595. portENTER_CRITICAL(&ledc_spinlock);
  596. if (p_ledc_obj[speed_mode]->glb_clk == LEDC_SLOW_CLK_UNINIT) {
  597. ledc_hal_set_slow_clk_sel(&(p_ledc_obj[speed_mode]->ledc_hal), LEDC_LL_GLOBAL_CLK_DEFAULT);
  598. }
  599. portEXIT_CRITICAL(&ledc_spinlock);
  600. }
  601. #endif
  602. /*set channel parameters*/
  603. /* channel parameters decide how the waveform looks like in one period*/
  604. /* set channel duty and hpoint value, duty range is (0 ~ ((2 ** duty_resolution) - 1)), max hpoint value is 0xfffff*/
  605. ledc_set_duty_with_hpoint(speed_mode, ledc_channel, duty, hpoint);
  606. /*update duty settings*/
  607. ledc_update_duty(speed_mode, ledc_channel);
  608. /*bind the channel with the timer*/
  609. ledc_bind_channel_timer(speed_mode, ledc_channel, timer_select);
  610. /*set interrupt type*/
  611. portENTER_CRITICAL(&ledc_spinlock);
  612. ledc_enable_intr_type(speed_mode, ledc_channel, intr_type);
  613. portEXIT_CRITICAL(&ledc_spinlock);
  614. ESP_LOGD(LEDC_TAG, "LEDC_PWM CHANNEL %"PRIu32"|GPIO %02u|Duty %04"PRIu32"|Time %"PRIu32,
  615. ledc_channel, gpio_num, duty, timer_select);
  616. /*set LEDC signal in gpio matrix*/
  617. gpio_hal_iomux_func_sel(GPIO_PIN_MUX_REG[gpio_num], PIN_FUNC_GPIO);
  618. gpio_set_level(gpio_num, output_invert);
  619. gpio_set_direction(gpio_num, GPIO_MODE_OUTPUT);
  620. esp_rom_gpio_connect_out_signal(gpio_num, ledc_periph_signal[speed_mode].sig_out0_idx + ledc_channel, output_invert, 0);
  621. return ret;
  622. }
  623. static void _ledc_update_duty(ledc_mode_t speed_mode, ledc_channel_t channel)
  624. {
  625. ledc_hal_set_sig_out_en(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
  626. ledc_hal_set_duty_start(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
  627. ledc_ls_channel_update(speed_mode, channel);
  628. }
  629. esp_err_t ledc_update_duty(ledc_mode_t speed_mode, ledc_channel_t channel)
  630. {
  631. LEDC_ARG_CHECK_ISR(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  632. LEDC_ARG_CHECK_ISR(channel < LEDC_CHANNEL_MAX, "channel");
  633. LEDC_CHECK_ISR(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  634. portENTER_CRITICAL_SAFE(&ledc_spinlock);
  635. _ledc_update_duty(speed_mode, channel);
  636. portEXIT_CRITICAL_SAFE(&ledc_spinlock);
  637. return ESP_OK;
  638. }
  639. esp_err_t ledc_stop(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t idle_level)
  640. {
  641. LEDC_ARG_CHECK_ISR(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  642. LEDC_ARG_CHECK_ISR(channel < LEDC_CHANNEL_MAX, "channel");
  643. LEDC_CHECK_ISR(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  644. portENTER_CRITICAL_SAFE(&ledc_spinlock);
  645. ledc_hal_set_idle_level(&(p_ledc_obj[speed_mode]->ledc_hal), channel, idle_level);
  646. ledc_hal_set_sig_out_en(&(p_ledc_obj[speed_mode]->ledc_hal), channel, false);
  647. ledc_hal_set_duty_start(&(p_ledc_obj[speed_mode]->ledc_hal), channel, false);
  648. ledc_ls_channel_update(speed_mode, channel);
  649. portEXIT_CRITICAL_SAFE(&ledc_spinlock);
  650. return ESP_OK;
  651. }
  652. esp_err_t ledc_set_fade(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, ledc_duty_direction_t fade_direction,
  653. uint32_t step_num, uint32_t duty_cyle_num, uint32_t duty_scale)
  654. {
  655. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  656. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  657. LEDC_ARG_CHECK(fade_direction < LEDC_DUTY_DIR_MAX, "fade_direction");
  658. LEDC_ARG_CHECK(step_num <= LEDC_LL_DUTY_NUM_MAX, "step_num");
  659. LEDC_ARG_CHECK(duty_cyle_num <= LEDC_LL_DUTY_CYCLE_MAX, "duty_cycle_num");
  660. LEDC_ARG_CHECK(duty_scale <= LEDC_LL_DUTY_SCALE_MAX, "duty_scale");
  661. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  662. _ledc_fade_hw_acquire(speed_mode, channel);
  663. portENTER_CRITICAL(&ledc_spinlock);
  664. ledc_duty_config(speed_mode,
  665. channel, //uint32_t chan_num,
  666. LEDC_VAL_NO_CHANGE,
  667. duty, //uint32_t duty_val,
  668. fade_direction, //uint32_t increase,
  669. step_num, //uint32_t duty_num,
  670. duty_cyle_num, //uint32_t duty_cycle,
  671. duty_scale //uint32_t duty_scale
  672. );
  673. portEXIT_CRITICAL(&ledc_spinlock);
  674. _ledc_fade_hw_release(speed_mode, channel);
  675. return ESP_OK;
  676. }
  677. esp_err_t ledc_set_duty_with_hpoint(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, uint32_t hpoint)
  678. {
  679. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  680. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  681. LEDC_ARG_CHECK(hpoint <= LEDC_LL_HPOINT_VAL_MAX, "hpoint");
  682. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  683. /* The channel configuration should not be changed before the fade operation is done. */
  684. _ledc_fade_hw_acquire(speed_mode, channel);
  685. portENTER_CRITICAL(&ledc_spinlock);
  686. ledc_duty_config(speed_mode,
  687. channel, //uint32_t chan_num,
  688. hpoint, //uint32_t hpoint_val,
  689. duty, //uint32_t duty_val,
  690. 1, //uint32_t increase,
  691. 1, //uint32_t duty_num,
  692. 1, //uint32_t duty_cycle,
  693. 0 //uint32_t duty_scale
  694. );
  695. portEXIT_CRITICAL(&ledc_spinlock);
  696. _ledc_fade_hw_release(speed_mode, channel);
  697. return ESP_OK;
  698. }
  699. esp_err_t ledc_set_duty(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty)
  700. {
  701. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  702. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  703. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  704. /* The channel configuration should not be changed before the fade operation is done. */
  705. _ledc_fade_hw_acquire(speed_mode, channel);
  706. portENTER_CRITICAL(&ledc_spinlock);
  707. ledc_duty_config(speed_mode,
  708. channel, //uint32_t chan_num,
  709. LEDC_VAL_NO_CHANGE,
  710. duty, //uint32_t duty_val,
  711. 1, //uint32_t increase,
  712. 1, //uint32_t duty_num,
  713. 1, //uint32_t duty_cycle,
  714. 0 //uint32_t duty_scale
  715. );
  716. portEXIT_CRITICAL(&ledc_spinlock);
  717. _ledc_fade_hw_release(speed_mode, channel);
  718. return ESP_OK;
  719. }
  720. uint32_t ledc_get_duty(ledc_mode_t speed_mode, ledc_channel_t channel)
  721. {
  722. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  723. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  724. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  725. uint32_t duty = 0;
  726. ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty);
  727. return duty;
  728. }
  729. int ledc_get_hpoint(ledc_mode_t speed_mode, ledc_channel_t channel)
  730. {
  731. LEDC_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode argument is invalid", LEDC_ERR_VAL);
  732. LEDC_CHECK(channel < LEDC_CHANNEL_MAX, "channel argument is invalid", LEDC_ERR_VAL);
  733. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  734. uint32_t hpoint = 0;
  735. ledc_hal_get_hpoint(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &hpoint);
  736. return hpoint;
  737. }
  738. esp_err_t ledc_set_freq(ledc_mode_t speed_mode, ledc_timer_t timer_num, uint32_t freq_hz)
  739. {
  740. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  741. LEDC_ARG_CHECK(timer_num < LEDC_TIMER_MAX, "timer_num");
  742. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  743. ledc_clk_cfg_t clk_cfg = LEDC_AUTO_CLK;
  744. uint32_t duty_resolution = 0;
  745. ledc_hal_get_clk_cfg(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &clk_cfg);
  746. ledc_hal_get_duty_resolution(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &duty_resolution);
  747. return ledc_set_timer_div(speed_mode, timer_num, clk_cfg, freq_hz, duty_resolution);
  748. }
  749. uint32_t ledc_get_freq(ledc_mode_t speed_mode, ledc_timer_t timer_num)
  750. {
  751. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  752. LEDC_ARG_CHECK(timer_num < LEDC_TIMER_MAX, "timer_num");
  753. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  754. portENTER_CRITICAL(&ledc_spinlock);
  755. uint32_t clock_divider = 0;
  756. uint32_t duty_resolution = 0;
  757. ledc_clk_cfg_t clk_cfg = LEDC_AUTO_CLK;
  758. ledc_hal_get_clock_divider(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &clock_divider);
  759. ledc_hal_get_duty_resolution(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &duty_resolution);
  760. ledc_hal_get_clk_cfg(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &clk_cfg);
  761. uint32_t precision = (0x1 << duty_resolution);
  762. uint32_t src_clk_freq = 0;
  763. esp_clk_tree_src_get_freq_hz((soc_module_clk_t)clk_cfg, LEDC_CLK_SRC_FREQ_PRECISION, &src_clk_freq);
  764. portEXIT_CRITICAL(&ledc_spinlock);
  765. if (clock_divider == 0) {
  766. ESP_LOGW(LEDC_TAG, "LEDC timer not configured, call ledc_timer_config to set timer frequency");
  767. return 0;
  768. }
  769. return (((uint64_t) src_clk_freq << LEDC_LL_FRACTIONAL_BITS) + (uint64_t) precision * clock_divider / 2) / precision / clock_divider;
  770. }
  771. static inline void IRAM_ATTR ledc_calc_fade_end_channel(uint32_t *fade_end_status, uint32_t *channel)
  772. {
  773. uint32_t i = __builtin_ffs((*fade_end_status)) - 1;
  774. (*fade_end_status) &= ~(1 << i);
  775. *channel = i;
  776. }
  777. void IRAM_ATTR ledc_fade_isr(void *arg)
  778. {
  779. bool cb_yield = false;
  780. BaseType_t HPTaskAwoken = pdFALSE;
  781. uint32_t speed_mode = 0;
  782. uint32_t channel = 0;
  783. uint32_t intr_status = 0;
  784. ledc_fade_fsm_t state;
  785. for (speed_mode = 0; speed_mode < LEDC_SPEED_MODE_MAX; speed_mode++) {
  786. if (p_ledc_obj[speed_mode] == NULL) {
  787. continue;
  788. }
  789. ledc_hal_get_fade_end_intr_status(&(p_ledc_obj[speed_mode]->ledc_hal), &intr_status);
  790. while (intr_status) {
  791. ledc_calc_fade_end_channel(&intr_status, &channel);
  792. // clear interrupt
  793. ledc_hal_clear_fade_end_intr_status(&(p_ledc_obj[speed_mode]->ledc_hal), channel);
  794. if (s_ledc_fade_rec[speed_mode][channel] == NULL) {
  795. //fade object not initialized yet.
  796. continue;
  797. }
  798. // Switch fade state to ISR_CAL if current state is HW_FADE
  799. bool already_stopped = false;
  800. portENTER_CRITICAL_ISR(&ledc_spinlock);
  801. state = s_ledc_fade_rec[speed_mode][channel]->fsm;
  802. assert(state != LEDC_FSM_ISR_CAL && state != LEDC_FSM_KILLED_PENDING);
  803. if (state == LEDC_FSM_HW_FADE) {
  804. s_ledc_fade_rec[speed_mode][channel]->fsm = LEDC_FSM_ISR_CAL;
  805. } else if (state == LEDC_FSM_IDLE) {
  806. // interrupt seen, but has already been stopped by task
  807. already_stopped = true;
  808. }
  809. portEXIT_CRITICAL_ISR(&ledc_spinlock);
  810. if (already_stopped) {
  811. continue;
  812. }
  813. bool set_to_idle = false;
  814. int cycle = 0;
  815. int delta = 0;
  816. int step = 0;
  817. int next_duty = 0;
  818. uint32_t duty_cur = 0;
  819. ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty_cur);
  820. uint32_t duty_tar = s_ledc_fade_rec[speed_mode][channel]->target_duty;
  821. #if SOC_LEDC_GAMMA_CURVE_FADE_SUPPORTED
  822. // If a multi-fade is done, check that target duty computed in sw is equal to the duty at the end of the fade
  823. uint32_t range_num;
  824. ledc_hal_get_range_number(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &range_num);
  825. if (range_num > 1) {
  826. assert(duty_cur == duty_tar);
  827. }
  828. #endif
  829. int scale = s_ledc_fade_rec[speed_mode][channel]->scale;
  830. if (duty_cur == duty_tar || scale == 0) {
  831. // Target duty has reached
  832. set_to_idle = true;
  833. } else {
  834. // Calculate new duty config parameters
  835. delta = (s_ledc_fade_rec[speed_mode][channel]->direction == LEDC_DUTY_DIR_DECREASE) ?
  836. (duty_cur - duty_tar) : (duty_tar - duty_cur);
  837. if (delta > scale) {
  838. next_duty = duty_cur;
  839. step = (delta / scale > LEDC_DUTY_NUM_MAX) ? LEDC_DUTY_NUM_MAX : (delta / scale);
  840. cycle = s_ledc_fade_rec[speed_mode][channel]->cycle_num;
  841. } else {
  842. next_duty = duty_tar;
  843. step = 1;
  844. cycle = 1;
  845. scale = 0;
  846. }
  847. }
  848. bool finished = false;
  849. portENTER_CRITICAL_ISR(&ledc_spinlock);
  850. state = s_ledc_fade_rec[speed_mode][channel]->fsm;
  851. assert(state != LEDC_FSM_IDLE && state != LEDC_FSM_HW_FADE);
  852. if (set_to_idle || state == LEDC_FSM_KILLED_PENDING) {
  853. // Either fade has completed or has been killed, skip HW duty config
  854. finished = true;
  855. s_ledc_fade_rec[speed_mode][channel]->fsm = LEDC_FSM_IDLE;
  856. } else if (state == LEDC_FSM_ISR_CAL) {
  857. // Loading new fade to start
  858. ledc_duty_config(speed_mode,
  859. channel,
  860. LEDC_VAL_NO_CHANGE,
  861. next_duty,
  862. s_ledc_fade_rec[speed_mode][channel]->direction,
  863. step,
  864. cycle,
  865. scale);
  866. s_ledc_fade_rec[speed_mode][channel]->fsm = LEDC_FSM_HW_FADE;
  867. ledc_hal_set_duty_start(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
  868. ledc_ls_channel_update(speed_mode, channel);
  869. }
  870. portEXIT_CRITICAL_ISR(&ledc_spinlock);
  871. if (finished) {
  872. xSemaphoreGiveFromISR(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem, &HPTaskAwoken);
  873. ledc_cb_t fade_cb = s_ledc_fade_rec[speed_mode][channel]->ledc_fade_callback;
  874. if (fade_cb) {
  875. ledc_cb_param_t param = {
  876. .event = LEDC_FADE_END_EVT,
  877. .speed_mode = speed_mode,
  878. .channel = channel,
  879. .duty = duty_cur
  880. };
  881. cb_yield |= fade_cb(&param, s_ledc_fade_rec[speed_mode][channel]->cb_user_arg);
  882. }
  883. }
  884. }
  885. }
  886. if (HPTaskAwoken == pdTRUE || cb_yield) {
  887. portYIELD_FROM_ISR();
  888. }
  889. }
  890. static esp_err_t ledc_fade_channel_deinit(ledc_mode_t speed_mode, ledc_channel_t channel)
  891. {
  892. if (s_ledc_fade_rec[speed_mode][channel]) {
  893. if (s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux) {
  894. vSemaphoreDelete(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux);
  895. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux = NULL;
  896. }
  897. if (s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem) {
  898. vSemaphoreDelete(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem);
  899. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem = NULL;
  900. }
  901. free(s_ledc_fade_rec[speed_mode][channel]);
  902. s_ledc_fade_rec[speed_mode][channel] = NULL;
  903. }
  904. return ESP_OK;
  905. }
  906. static esp_err_t ledc_fade_channel_init_check(ledc_mode_t speed_mode, ledc_channel_t channel)
  907. {
  908. if (s_ledc_fade_isr_handle == NULL) {
  909. ESP_LOGE(LEDC_TAG, "Fade service not installed, call ledc_fade_func_install");
  910. return ESP_FAIL;
  911. }
  912. if (s_ledc_fade_rec[speed_mode][channel] == NULL) {
  913. #if CONFIG_SPIRAM_USE_MALLOC
  914. s_ledc_fade_rec[speed_mode][channel] = (ledc_fade_t *) heap_caps_calloc(1, sizeof(ledc_fade_t), MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
  915. if (s_ledc_fade_rec[speed_mode][channel] == NULL) {
  916. ledc_fade_channel_deinit(speed_mode, channel);
  917. return ESP_ERR_NO_MEM;
  918. }
  919. memset(&s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem_storage, 0, sizeof(StaticQueue_t));
  920. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem = xSemaphoreCreateBinaryStatic(&s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem_storage);
  921. #else
  922. s_ledc_fade_rec[speed_mode][channel] = (ledc_fade_t *) calloc(1, sizeof(ledc_fade_t));
  923. if (s_ledc_fade_rec[speed_mode][channel] == NULL) {
  924. ledc_fade_channel_deinit(speed_mode, channel);
  925. return ESP_ERR_NO_MEM;
  926. }
  927. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem = xSemaphoreCreateBinary();
  928. #endif
  929. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux = xSemaphoreCreateMutex();
  930. xSemaphoreGive(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem);
  931. s_ledc_fade_rec[speed_mode][channel]->fsm = LEDC_FSM_IDLE;
  932. }
  933. if (s_ledc_fade_rec[speed_mode][channel]
  934. && s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux
  935. && s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem) {
  936. return ESP_OK;
  937. } else {
  938. ledc_fade_channel_deinit(speed_mode, channel);
  939. return ESP_FAIL;
  940. }
  941. }
  942. 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)
  943. {
  944. portENTER_CRITICAL(&ledc_spinlock);
  945. uint32_t duty_cur = 0;
  946. ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty_cur);
  947. // When duty == max_duty, meanwhile, if scale == 1 and fade_down == 1, counter would overflow.
  948. if (duty_cur == ledc_get_max_duty(speed_mode, channel)) {
  949. duty_cur -= 1;
  950. }
  951. s_ledc_fade_rec[speed_mode][channel]->speed_mode = speed_mode;
  952. s_ledc_fade_rec[speed_mode][channel]->target_duty = target_duty;
  953. s_ledc_fade_rec[speed_mode][channel]->cycle_num = cycle_num;
  954. s_ledc_fade_rec[speed_mode][channel]->scale = scale;
  955. int step_num = 0;
  956. int dir = LEDC_DUTY_DIR_DECREASE;
  957. if (scale > 0) {
  958. if (duty_cur > target_duty) {
  959. s_ledc_fade_rec[speed_mode][channel]->direction = LEDC_DUTY_DIR_DECREASE;
  960. step_num = (duty_cur - target_duty) / scale;
  961. step_num = step_num > LEDC_DUTY_NUM_MAX ? LEDC_DUTY_NUM_MAX : step_num;
  962. } else {
  963. s_ledc_fade_rec[speed_mode][channel]->direction = LEDC_DUTY_DIR_INCREASE;
  964. dir = LEDC_DUTY_DIR_INCREASE;
  965. step_num = (target_duty - duty_cur) / scale;
  966. step_num = step_num > LEDC_DUTY_NUM_MAX ? LEDC_DUTY_NUM_MAX : step_num;
  967. }
  968. }
  969. portEXIT_CRITICAL(&ledc_spinlock);
  970. if (scale > 0 && step_num > 0) {
  971. portENTER_CRITICAL(&ledc_spinlock);
  972. ledc_duty_config(speed_mode, channel, LEDC_VAL_NO_CHANGE, duty_cur, dir, step_num, cycle_num, scale);
  973. portEXIT_CRITICAL(&ledc_spinlock);
  974. ESP_LOGD(LEDC_TAG, "cur duty: %"PRIu32"; target: %"PRIu32", step: %d, cycle: %d; scale: %d; dir: %d",
  975. duty_cur, target_duty, step_num, cycle_num, scale, dir);
  976. } else {
  977. portENTER_CRITICAL(&ledc_spinlock);
  978. ledc_duty_config(speed_mode, channel, LEDC_VAL_NO_CHANGE, target_duty, dir, 1, 1, 0);
  979. portEXIT_CRITICAL(&ledc_spinlock);
  980. ESP_LOGD(LEDC_TAG, "Set to target duty: %"PRIu32, target_duty);
  981. }
  982. return ESP_OK;
  983. }
  984. 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)
  985. {
  986. ledc_timer_t timer_sel;
  987. uint32_t duty_cur = 0;
  988. ledc_hal_get_channel_timer(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &timer_sel);
  989. ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty_cur);
  990. uint32_t freq = ledc_get_freq(speed_mode, timer_sel);
  991. uint32_t duty_delta = target_duty > duty_cur ? target_duty - duty_cur : duty_cur - target_duty;
  992. if (duty_delta == 0) {
  993. return _ledc_set_fade_with_step(speed_mode, channel, target_duty, 0, 0);
  994. }
  995. uint32_t total_cycles = max_fade_time_ms * freq / 1000;
  996. if (total_cycles == 0) {
  997. ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_FAST_STR);
  998. return _ledc_set_fade_with_step(speed_mode, channel, target_duty, 0, 0);
  999. }
  1000. int scale, cycle_num;
  1001. if (total_cycles > duty_delta) {
  1002. scale = 1;
  1003. cycle_num = total_cycles / duty_delta;
  1004. if (cycle_num > LEDC_LL_DUTY_CYCLE_MAX) {
  1005. ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_SLOW_STR);
  1006. cycle_num = LEDC_LL_DUTY_CYCLE_MAX;
  1007. }
  1008. } else {
  1009. cycle_num = 1;
  1010. scale = duty_delta / total_cycles;
  1011. if (scale > LEDC_LL_DUTY_SCALE_MAX) {
  1012. ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_FAST_STR);
  1013. scale = LEDC_LL_DUTY_SCALE_MAX;
  1014. }
  1015. }
  1016. return _ledc_set_fade_with_step(speed_mode, channel, target_duty, scale, cycle_num);
  1017. }
  1018. static void _ledc_fade_start(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_fade_mode_t fade_mode)
  1019. {
  1020. ledc_fade_t *fade = s_ledc_fade_rec[speed_mode][channel];
  1021. fade->mode = fade_mode;
  1022. // Clear interrupt status of channel
  1023. ledc_hal_clear_fade_end_intr_status(&(p_ledc_obj[speed_mode]->ledc_hal), channel);
  1024. // Enable interrupt for channel
  1025. portENTER_CRITICAL(&ledc_spinlock);
  1026. ledc_enable_intr_type(speed_mode, channel, LEDC_INTR_FADE_END);
  1027. // Set fade state to HW_FADE state for starting the fade
  1028. assert(fade->fsm == LEDC_FSM_IDLE);
  1029. fade->fsm = LEDC_FSM_HW_FADE;
  1030. portEXIT_CRITICAL(&ledc_spinlock);
  1031. // Trigger the fade
  1032. ledc_update_duty(speed_mode, channel);
  1033. if (fade_mode == LEDC_FADE_WAIT_DONE) {
  1034. // Waiting for fade done
  1035. _ledc_fade_hw_acquire(speed_mode, channel);
  1036. // Release hardware to support next time fade configure
  1037. _ledc_fade_hw_release(speed_mode, channel);
  1038. }
  1039. }
  1040. 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)
  1041. {
  1042. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1043. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1044. LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
  1045. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1046. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1047. _ledc_fade_hw_acquire(speed_mode, channel);
  1048. _ledc_set_fade_with_time(speed_mode, channel, target_duty, max_fade_time_ms);
  1049. _ledc_fade_hw_release(speed_mode, channel);
  1050. return ESP_OK;
  1051. }
  1052. 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)
  1053. {
  1054. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1055. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1056. LEDC_ARG_CHECK((scale > 0) && (scale <= LEDC_LL_DUTY_SCALE_MAX), "fade scale");
  1057. LEDC_ARG_CHECK((cycle_num > 0) && (cycle_num <= LEDC_LL_DUTY_CYCLE_MAX), "cycle_num");
  1058. LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
  1059. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1060. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1061. _ledc_fade_hw_acquire(speed_mode, channel);
  1062. _ledc_set_fade_with_step(speed_mode, channel, target_duty, scale, cycle_num);
  1063. _ledc_fade_hw_release(speed_mode, channel);
  1064. return ESP_OK;
  1065. }
  1066. esp_err_t ledc_fade_start(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_fade_mode_t fade_mode)
  1067. {
  1068. LEDC_CHECK(s_ledc_fade_rec[speed_mode][channel] != NULL, LEDC_FADE_SERVICE_ERR_STR, ESP_ERR_INVALID_STATE);
  1069. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1070. LEDC_ARG_CHECK(fade_mode < LEDC_FADE_MAX, "fade_mode");
  1071. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1072. _ledc_fade_hw_acquire(speed_mode, channel);
  1073. _ledc_fade_start(speed_mode, channel, fade_mode);
  1074. return ESP_OK;
  1075. }
  1076. // ESP32 does not support this functionality, fade cannot be overwritten with new duty config
  1077. #if SOC_LEDC_SUPPORT_FADE_STOP
  1078. esp_err_t ledc_fade_stop(ledc_mode_t speed_mode, ledc_channel_t channel)
  1079. {
  1080. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1081. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1082. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1083. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK , LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1084. ledc_fade_t *fade = s_ledc_fade_rec[speed_mode][channel];
  1085. ledc_fade_fsm_t state = fade->fsm;
  1086. bool wait_for_idle = false;
  1087. assert(state != LEDC_FSM_KILLED_PENDING);
  1088. if (state == LEDC_FSM_IDLE) {
  1089. // if there is no fade going on, do nothing
  1090. return ESP_OK;
  1091. }
  1092. // Fade state is either HW_FADE or ISR_CAL (there is a fade in process)
  1093. portENTER_CRITICAL(&ledc_spinlock);
  1094. // Disable ledc channel interrupt first
  1095. ledc_enable_intr_type(speed_mode, channel, LEDC_INTR_DISABLE);
  1096. // Config duty to the duty cycle at this moment
  1097. uint32_t duty_cur = ledc_get_duty(speed_mode, channel);
  1098. ledc_duty_config(speed_mode,
  1099. channel, //uint32_t chan_num,
  1100. LEDC_VAL_NO_CHANGE,
  1101. duty_cur, //uint32_t duty_val,
  1102. 1, //uint32_t increase,
  1103. 1, //uint32_t duty_num,
  1104. 1, //uint32_t duty_cycle,
  1105. 0 //uint32_t duty_scale
  1106. );
  1107. _ledc_update_duty(speed_mode, channel);
  1108. state = fade->fsm;
  1109. assert(state != LEDC_FSM_IDLE && state != LEDC_FSM_KILLED_PENDING);
  1110. if (state == LEDC_FSM_HW_FADE) {
  1111. fade->fsm = LEDC_FSM_IDLE;
  1112. } else if (state == LEDC_FSM_ISR_CAL) {
  1113. fade->fsm = LEDC_FSM_KILLED_PENDING;
  1114. wait_for_idle = true;
  1115. }
  1116. portEXIT_CRITICAL(&ledc_spinlock);
  1117. if (wait_for_idle) {
  1118. // Wait for ISR return, which gives the semaphore and switchs state to IDLE
  1119. _ledc_fade_hw_acquire(speed_mode, channel);
  1120. assert(fade->fsm == LEDC_FSM_IDLE);
  1121. }
  1122. _ledc_fade_hw_release(speed_mode, channel);
  1123. return ESP_OK;
  1124. }
  1125. #endif
  1126. esp_err_t ledc_fade_func_install(int intr_alloc_flags)
  1127. {
  1128. //OR intr_alloc_flags with ESP_INTR_FLAG_IRAM because the fade isr is in IRAM
  1129. return ledc_isr_register(ledc_fade_isr, NULL, intr_alloc_flags | ESP_INTR_FLAG_IRAM, &s_ledc_fade_isr_handle);
  1130. }
  1131. void ledc_fade_func_uninstall(void)
  1132. {
  1133. if (s_ledc_fade_isr_handle) {
  1134. esp_intr_free(s_ledc_fade_isr_handle);
  1135. s_ledc_fade_isr_handle = NULL;
  1136. }
  1137. int channel, mode;
  1138. for (mode = 0; mode < LEDC_SPEED_MODE_MAX; mode++) {
  1139. for (channel = 0; channel < LEDC_CHANNEL_MAX; channel++) {
  1140. ledc_fade_channel_deinit(mode, channel);
  1141. }
  1142. }
  1143. return;
  1144. }
  1145. esp_err_t ledc_cb_register(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_cbs_t *cbs, void *user_arg)
  1146. {
  1147. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1148. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1149. LEDC_ARG_CHECK(cbs, "callback");
  1150. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1151. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1152. if (cbs->fade_cb && !esp_ptr_in_iram(cbs->fade_cb)) {
  1153. ESP_LOGW(LEDC_TAG, "fade callback not in IRAM");
  1154. }
  1155. if (user_arg && !esp_ptr_internal(user_arg)) {
  1156. ESP_LOGW(LEDC_TAG, "user context not in internal RAM");
  1157. }
  1158. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_callback = cbs->fade_cb;
  1159. s_ledc_fade_rec[speed_mode][channel]->cb_user_arg = user_arg;
  1160. return ESP_OK;
  1161. }
  1162. /*
  1163. * The functions below are thread-safe version of APIs for duty and fade control.
  1164. * These APIs can be called from different tasks.
  1165. */
  1166. esp_err_t ledc_set_duty_and_update(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, uint32_t hpoint)
  1167. {
  1168. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1169. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1170. LEDC_ARG_CHECK(duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
  1171. LEDC_ARG_CHECK(hpoint <= LEDC_LL_HPOINT_VAL_MAX, "hpoint");
  1172. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1173. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1174. _ledc_fade_hw_acquire(speed_mode, channel);
  1175. portENTER_CRITICAL(&ledc_spinlock);
  1176. ledc_duty_config(speed_mode, channel, hpoint, duty, 1, 1, 1, 0);
  1177. _ledc_update_duty(speed_mode, channel);
  1178. portEXIT_CRITICAL(&ledc_spinlock);
  1179. _ledc_fade_hw_release(speed_mode, channel);
  1180. return ESP_OK;
  1181. }
  1182. 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)
  1183. {
  1184. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1185. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1186. LEDC_ARG_CHECK(fade_mode < LEDC_FADE_MAX, "fade_mode");
  1187. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1188. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1189. LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
  1190. _ledc_op_lock_acquire(speed_mode, channel);
  1191. _ledc_fade_hw_acquire(speed_mode, channel);
  1192. _ledc_set_fade_with_time(speed_mode, channel, target_duty, max_fade_time_ms);
  1193. _ledc_fade_start(speed_mode, channel, fade_mode);
  1194. _ledc_op_lock_release(speed_mode, channel);
  1195. return ESP_OK;
  1196. }
  1197. 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)
  1198. {
  1199. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1200. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1201. LEDC_ARG_CHECK(fade_mode < LEDC_FADE_MAX, "fade_mode");
  1202. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1203. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1204. LEDC_ARG_CHECK((scale > 0) && (scale <= LEDC_LL_DUTY_SCALE_MAX), "fade scale");
  1205. LEDC_ARG_CHECK((cycle_num > 0) && (cycle_num <= LEDC_LL_DUTY_CYCLE_MAX), "cycle_num");
  1206. LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
  1207. _ledc_op_lock_acquire(speed_mode, channel);
  1208. _ledc_fade_hw_acquire(speed_mode, channel);
  1209. _ledc_set_fade_with_step(speed_mode, channel, target_duty, scale, cycle_num);
  1210. _ledc_fade_start(speed_mode, channel, fade_mode);
  1211. _ledc_op_lock_release(speed_mode, channel);
  1212. return ESP_OK;
  1213. }
  1214. #if SOC_LEDC_GAMMA_CURVE_FADE_SUPPORTED
  1215. static esp_err_t _ledc_set_multi_fade(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t start_duty, const ledc_fade_param_config_t *fade_params_list, uint32_t list_len)
  1216. {
  1217. uint32_t max_duty = ledc_get_max_duty(speed_mode, channel);
  1218. LEDC_ARG_CHECK(start_duty <= max_duty, "start_duty");
  1219. portENTER_CRITICAL(&ledc_spinlock);
  1220. ledc_hal_set_duty_int_part(&(p_ledc_obj[speed_mode]->ledc_hal), channel, start_duty);
  1221. for (int i = 0; i < list_len; i++) {
  1222. ledc_fade_param_config_t fade_param = fade_params_list[i];
  1223. ledc_hal_set_fade_param(&(p_ledc_obj[speed_mode]->ledc_hal), channel, i, fade_param.dir, fade_param.cycle_num, fade_param.scale, fade_param.step_num);
  1224. }
  1225. ledc_hal_set_range_number(&(p_ledc_obj[speed_mode]->ledc_hal), channel, list_len);
  1226. portEXIT_CRITICAL(&ledc_spinlock);
  1227. // Calculate target duty, and take account for overflow
  1228. uint32_t target_duty = start_duty;
  1229. for (int i = 0; i < list_len; i++) {
  1230. uint32_t delta_duty = (fade_params_list[i].step_num * fade_params_list[i].scale) % (max_duty + 1);
  1231. if (fade_params_list[i].dir == LEDC_DUTY_DIR_INCREASE) {
  1232. target_duty += delta_duty;
  1233. if (target_duty > max_duty) {
  1234. target_duty -= max_duty + 1;
  1235. }
  1236. } else {
  1237. if (delta_duty > target_duty) {
  1238. target_duty += max_duty + 1;
  1239. }
  1240. target_duty -= delta_duty;
  1241. }
  1242. }
  1243. // Set interrupt exit criteria
  1244. s_ledc_fade_rec[speed_mode][channel]->target_duty = target_duty;
  1245. s_ledc_fade_rec[speed_mode][channel]->scale = fade_params_list[list_len - 1].scale;
  1246. return ESP_OK;
  1247. }
  1248. esp_err_t ledc_set_multi_fade(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t start_duty, const ledc_fade_param_config_t *fade_params_list, uint32_t list_len)
  1249. {
  1250. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1251. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1252. LEDC_ARG_CHECK(list_len <= SOC_LEDC_GAMMA_CURVE_FADE_RANGE_MAX, "list_len");
  1253. LEDC_ARG_CHECK(fade_params_list, "fade_params_list");
  1254. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1255. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1256. _ledc_fade_hw_acquire(speed_mode, channel);
  1257. esp_err_t ret = _ledc_set_multi_fade(speed_mode, channel, start_duty, fade_params_list, list_len);
  1258. _ledc_fade_hw_release(speed_mode, channel);
  1259. return ret;
  1260. }
  1261. esp_err_t ledc_set_multi_fade_and_start(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t start_duty, const ledc_fade_param_config_t *fade_params_list, uint32_t list_len, ledc_fade_mode_t fade_mode)
  1262. {
  1263. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1264. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1265. LEDC_ARG_CHECK(list_len <= SOC_LEDC_GAMMA_CURVE_FADE_RANGE_MAX, "list_len");
  1266. LEDC_ARG_CHECK(fade_params_list, "fade_params_list");
  1267. LEDC_ARG_CHECK(fade_mode < LEDC_FADE_MAX, "fade_mode");
  1268. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1269. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1270. _ledc_op_lock_acquire(speed_mode, channel);
  1271. _ledc_fade_hw_acquire(speed_mode, channel);
  1272. esp_err_t ret = _ledc_set_multi_fade(speed_mode, channel, start_duty, fade_params_list, list_len);
  1273. if (ret != ESP_OK) {
  1274. _ledc_fade_hw_release(speed_mode, channel);
  1275. } else {
  1276. _ledc_fade_start(speed_mode, channel, fade_mode);
  1277. }
  1278. _ledc_op_lock_release(speed_mode, channel);
  1279. return ret;
  1280. }
  1281. esp_err_t ledc_fill_multi_fade_param_list(ledc_mode_t speed_mode, ledc_channel_t channel,
  1282. uint32_t start_duty, uint32_t end_duty,
  1283. uint32_t linear_phase_num, uint32_t max_fade_time_ms,
  1284. uint32_t (* gamma_correction_operator)(uint32_t),
  1285. uint32_t fade_params_list_size,
  1286. ledc_fade_param_config_t *fade_params_list, uint32_t *hw_fade_range_num)
  1287. {
  1288. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1289. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1290. LEDC_ARG_CHECK(linear_phase_num > 0 && linear_phase_num <= SOC_LEDC_GAMMA_CURVE_FADE_RANGE_MAX, "linear_phase_num");
  1291. LEDC_ARG_CHECK(gamma_correction_operator, "gamma_correction_operator");
  1292. LEDC_ARG_CHECK(fade_params_list_size <= SOC_LEDC_GAMMA_CURVE_FADE_RANGE_MAX, "fade_params_list_size");
  1293. LEDC_ARG_CHECK(fade_params_list, "fade_params_list");
  1294. LEDC_ARG_CHECK(hw_fade_range_num, "hw_fade_range_num");
  1295. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1296. uint32_t max_duty = ledc_get_max_duty(speed_mode, channel);
  1297. LEDC_ARG_CHECK(start_duty <= max_duty && end_duty <= max_duty, "duty");
  1298. esp_err_t ret = ESP_OK;
  1299. ledc_timer_t timer_sel;
  1300. ledc_hal_get_channel_timer(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &timer_sel);
  1301. uint32_t freq = ledc_get_freq(speed_mode, timer_sel);
  1302. uint32_t dir = (end_duty > start_duty) ? LEDC_DUTY_DIR_INCREASE : LEDC_DUTY_DIR_DECREASE;
  1303. uint32_t total_cycles = max_fade_time_ms * freq / 1000;
  1304. // If no duty change is need, then simplify the case
  1305. if (start_duty == end_duty) {
  1306. total_cycles = 1;
  1307. linear_phase_num = 1;
  1308. }
  1309. uint32_t avg_cycles_per_phase = total_cycles / linear_phase_num;
  1310. if (avg_cycles_per_phase == 0) {
  1311. ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_FAST_STR);
  1312. avg_cycles_per_phase = 1;
  1313. }
  1314. int sgn = (dir == LEDC_DUTY_DIR_INCREASE) ? 1 : (-1);
  1315. int32_t delta_brightness_per_phase = sgn * ((sgn * (end_duty - start_duty)) / linear_phase_num);
  1316. // First phase start and end values
  1317. uint32_t gamma_corrected_phase_head = gamma_correction_operator(start_duty);
  1318. uint32_t gamma_corrected_phase_tail = 0;
  1319. int32_t phase_tail = start_duty + delta_brightness_per_phase;
  1320. // Compute raw fade parameters for each linear phase
  1321. uint32_t total_fade_range = 0; // To record the required hw fade ranges
  1322. uint32_t surplus_cycles_last_phase = 0;
  1323. for (int i = 0; i < linear_phase_num; i++) {
  1324. uint32_t cycle, scale, step;
  1325. gamma_corrected_phase_tail = gamma_correction_operator(phase_tail);
  1326. uint32_t duty_delta = (dir == LEDC_DUTY_DIR_INCREASE) ? (gamma_corrected_phase_tail - gamma_corrected_phase_head) :
  1327. (gamma_corrected_phase_head - gamma_corrected_phase_tail);
  1328. uint32_t cycles_per_phase = avg_cycles_per_phase + surplus_cycles_last_phase;
  1329. if (duty_delta == 0) {
  1330. scale = 0;
  1331. cycle = (cycles_per_phase > LEDC_LL_DUTY_CYCLE_MAX) ? LEDC_LL_DUTY_CYCLE_MAX : cycles_per_phase;
  1332. step = 1;
  1333. } else if (cycles_per_phase > duty_delta) {
  1334. scale = 1;
  1335. step = duty_delta;
  1336. cycle = cycles_per_phase / duty_delta;
  1337. if (cycle > LEDC_LL_DUTY_CYCLE_MAX) {
  1338. ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_SLOW_STR);
  1339. cycle = LEDC_LL_DUTY_CYCLE_MAX;
  1340. }
  1341. } else {
  1342. cycle = 1;
  1343. scale = duty_delta / cycles_per_phase;
  1344. if (scale > LEDC_LL_DUTY_SCALE_MAX) {
  1345. ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_FAST_STR);
  1346. scale = LEDC_LL_DUTY_SCALE_MAX;
  1347. }
  1348. step = duty_delta / scale;
  1349. }
  1350. // Prepare for next phase calculation
  1351. phase_tail = phase_tail + delta_brightness_per_phase;
  1352. if (dir == LEDC_DUTY_DIR_INCREASE) {
  1353. gamma_corrected_phase_head += step * scale;
  1354. } else {
  1355. gamma_corrected_phase_head -= step * scale;
  1356. }
  1357. surplus_cycles_last_phase = cycles_per_phase - step * cycle;
  1358. // If next phase is the last one, then account for all remaining duty and cycles
  1359. if (i == linear_phase_num - 2) {
  1360. phase_tail = end_duty;
  1361. surplus_cycles_last_phase += total_cycles - avg_cycles_per_phase * linear_phase_num;
  1362. }
  1363. // Fill into the fade parameter list
  1364. // One linear phase might need multiple hardware fade ranges
  1365. do {
  1366. if (total_fade_range >= fade_params_list_size) {
  1367. ret = ESP_FAIL;
  1368. break;
  1369. }
  1370. fade_params_list[total_fade_range].dir = dir;
  1371. fade_params_list[total_fade_range].cycle_num = cycle;
  1372. fade_params_list[total_fade_range].scale = scale;
  1373. fade_params_list[total_fade_range].step_num = (step > LEDC_LL_DUTY_NUM_MAX) ? LEDC_LL_DUTY_NUM_MAX : step;
  1374. step -= fade_params_list[total_fade_range].step_num;
  1375. total_fade_range += 1;
  1376. } while (step > 0);
  1377. if (ret != ESP_OK) {
  1378. break;
  1379. }
  1380. }
  1381. uint32_t remaining_duty_delta = (dir == LEDC_DUTY_DIR_INCREASE) ? (gamma_corrected_phase_tail - gamma_corrected_phase_head) :
  1382. (gamma_corrected_phase_head - gamma_corrected_phase_tail);
  1383. if (remaining_duty_delta) {
  1384. total_fade_range += 1;
  1385. }
  1386. ESP_RETURN_ON_FALSE(total_fade_range <= fade_params_list_size, ESP_FAIL, LEDC_TAG,
  1387. "hw fade ranges required exceeds the space offered to fill the fade params."
  1388. " Please allocate more space, or split into smaller multi-fades, or reduce linear_phase_num");
  1389. if (remaining_duty_delta) {
  1390. fade_params_list[total_fade_range].dir = dir;
  1391. fade_params_list[total_fade_range].step_num = 1;
  1392. fade_params_list[total_fade_range].cycle_num = 1;
  1393. fade_params_list[total_fade_range].scale = remaining_duty_delta;
  1394. }
  1395. *hw_fade_range_num = total_fade_range;
  1396. return ret;
  1397. }
  1398. esp_err_t ledc_read_fade_param(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t range, uint32_t *dir, uint32_t *cycle, uint32_t *scale, uint32_t *step)
  1399. {
  1400. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1401. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1402. LEDC_ARG_CHECK(range < SOC_LEDC_GAMMA_CURVE_FADE_RANGE_MAX, "range");
  1403. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1404. ledc_hal_get_fade_param(&(p_ledc_obj[speed_mode]->ledc_hal), channel, range, dir, cycle, scale, step);
  1405. return ESP_OK;
  1406. }
  1407. #endif // SOC_LEDC_GAMMA_CURVE_FADE_SUPPORTED