ledc.c 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293
  1. /*
  2. * SPDX-FileCopyrightText: 2015-2022 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_private/esp_clk.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. static __attribute__((unused)) const char *LEDC_TAG = "ledc";
  24. #define LEDC_CHECK(a, str, ret_val) ESP_RETURN_ON_FALSE(a, ret_val, LEDC_TAG, "%s", str)
  25. #define LEDC_ARG_CHECK(a, param) ESP_RETURN_ON_FALSE(a, ESP_ERR_INVALID_ARG, LEDC_TAG, param " argument is invalid")
  26. #define LEDC_CLK_NOT_FOUND 0
  27. typedef enum {
  28. LEDC_FSM_IDLE,
  29. LEDC_FSM_HW_FADE,
  30. LEDC_FSM_ISR_CAL,
  31. LEDC_FSM_KILLED_PENDING,
  32. } ledc_fade_fsm_t;
  33. typedef struct {
  34. ledc_mode_t speed_mode;
  35. ledc_duty_direction_t direction;
  36. uint32_t target_duty;
  37. int cycle_num;
  38. int scale;
  39. ledc_fade_mode_t mode;
  40. SemaphoreHandle_t ledc_fade_sem;
  41. SemaphoreHandle_t ledc_fade_mux;
  42. #if CONFIG_SPIRAM_USE_MALLOC
  43. StaticQueue_t ledc_fade_sem_storage;
  44. #endif
  45. ledc_cb_t ledc_fade_callback;
  46. void *cb_user_arg;
  47. volatile ledc_fade_fsm_t fsm;
  48. } ledc_fade_t;
  49. typedef struct {
  50. ledc_hal_context_t ledc_hal; /*!< LEDC hal context*/
  51. } ledc_obj_t;
  52. static ledc_obj_t *p_ledc_obj[LEDC_SPEED_MODE_MAX] = {0};
  53. static ledc_fade_t *s_ledc_fade_rec[LEDC_SPEED_MODE_MAX][LEDC_CHANNEL_MAX];
  54. static ledc_isr_handle_t s_ledc_fade_isr_handle = NULL;
  55. static portMUX_TYPE ledc_spinlock = portMUX_INITIALIZER_UNLOCKED;
  56. #define LEDC_VAL_NO_CHANGE (-1)
  57. #define LEDC_DUTY_NUM_MAX LEDC_LL_DUTY_NUM_MAX // Maximum steps per hardware fade
  58. #define LEDC_DUTY_DECIMAL_BIT_NUM (4)
  59. #define LEDC_TIMER_DIV_NUM_MAX (0x3FFFF)
  60. #define LEDC_FADE_TOO_SLOW_STR "LEDC FADE TOO SLOW"
  61. #define LEDC_FADE_TOO_FAST_STR "LEDC FADE TOO FAST"
  62. #define DIM(array) (sizeof(array)/sizeof(*array))
  63. #define LEDC_IS_DIV_INVALID(div) ((div) <= LEDC_LL_FRACTIONAL_MAX || (div) > LEDC_TIMER_DIV_NUM_MAX)
  64. static __attribute__((unused)) const char *LEDC_NOT_INIT = "LEDC is not initialized";
  65. static __attribute__((unused)) const char *LEDC_FADE_SERVICE_ERR_STR = "LEDC fade service not installed";
  66. static __attribute__((unused)) const char *LEDC_FADE_INIT_ERROR_STR = "LEDC fade channel init error, not enough memory or service not installed";
  67. //This value will be calibrated when in use.
  68. static uint32_t s_ledc_slow_clk_8M = 0;
  69. static const ledc_slow_clk_sel_t s_glb_clks[] = LEDC_LL_GLOBAL_CLOCKS;
  70. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  71. static const struct { ledc_clk_src_t clk; uint32_t freq; } s_timer_specific_clks[] = LEDC_LL_TIMER_SPECIFIC_CLOCKS;
  72. #endif
  73. static void ledc_ls_timer_update(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
  74. {
  75. if (speed_mode == LEDC_LOW_SPEED_MODE) {
  76. ledc_hal_ls_timer_update(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
  77. }
  78. }
  79. static IRAM_ATTR void ledc_ls_channel_update(ledc_mode_t speed_mode, ledc_channel_t channel)
  80. {
  81. if (speed_mode == LEDC_LOW_SPEED_MODE) {
  82. ledc_hal_ls_channel_update(&(p_ledc_obj[speed_mode]->ledc_hal), channel);
  83. }
  84. }
  85. //We know that CLK8M is about 8M, but don't know the actual value. So we need to do a calibration.
  86. static bool ledc_slow_clk_calibrate(void)
  87. {
  88. if (periph_rtc_dig_clk8m_enable()) {
  89. s_ledc_slow_clk_8M = periph_rtc_dig_clk8m_get_freq();
  90. #if CONFIG_IDF_TARGET_ESP32H2
  91. /* Workaround: Calibration cannot be done for CLK8M on H2, we just use its theoretic frequency */
  92. ESP_LOGD(LEDC_TAG, "Calibration cannot be performed, approximate CLK8M_CLK : %d Hz", s_ledc_slow_clk_8M);
  93. #else
  94. ESP_LOGD(LEDC_TAG, "Calibrate CLK8M_CLK : %d Hz", s_ledc_slow_clk_8M);
  95. #endif
  96. return true;
  97. }
  98. ESP_LOGE(LEDC_TAG, "Calibrate CLK8M_CLK failed");
  99. return false;
  100. }
  101. static uint32_t ledc_get_src_clk_freq(ledc_clk_cfg_t clk_cfg)
  102. {
  103. uint32_t src_clk_freq = 0;
  104. if (clk_cfg == LEDC_USE_RTC8M_CLK) {
  105. src_clk_freq = s_ledc_slow_clk_8M;
  106. #if SOC_LEDC_SUPPORT_APB_CLOCK
  107. } else if (clk_cfg == LEDC_USE_APB_CLK) {
  108. src_clk_freq = esp_clk_apb_freq();
  109. #endif
  110. #if SOC_LEDC_SUPPORT_PLL_DIV_CLOCK
  111. } else if (clk_cfg == LEDC_USE_PLL_DIV_CLK) {
  112. src_clk_freq = LEDC_LL_PLL_DIV_CLK_FREQ;
  113. #endif
  114. #if SOC_LEDC_SUPPORT_REF_TICK
  115. } else if (clk_cfg == LEDC_USE_REF_TICK) {
  116. src_clk_freq = REF_CLK_FREQ;
  117. #endif
  118. #if SOC_LEDC_SUPPORT_XTAL_CLOCK
  119. } else if (clk_cfg == LEDC_USE_XTAL_CLK) {
  120. src_clk_freq = esp_clk_xtal_freq();
  121. #endif
  122. }
  123. return src_clk_freq;
  124. }
  125. /* Retrieve the clock frequency for global clocks only */
  126. static uint32_t ledc_get_glb_clk_freq(ledc_slow_clk_sel_t clk_cfg)
  127. {
  128. uint32_t src_clk_freq = 0;
  129. switch (clk_cfg) {
  130. #if SOC_LEDC_SUPPORT_APB_CLOCK
  131. case LEDC_SLOW_CLK_APB:
  132. src_clk_freq = esp_clk_apb_freq();
  133. break;
  134. #endif
  135. #if SOC_LEDC_SUPPORT_PLL_DIV_CLOCK
  136. case LEDC_SLOW_CLK_PLL_DIV:
  137. src_clk_freq = LEDC_LL_PLL_DIV_CLK_FREQ;
  138. break;
  139. #endif
  140. case LEDC_SLOW_CLK_RTC8M:
  141. src_clk_freq = s_ledc_slow_clk_8M;
  142. break;
  143. #if SOC_LEDC_SUPPORT_XTAL_CLOCK
  144. case LEDC_SLOW_CLK_XTAL:
  145. src_clk_freq = esp_clk_xtal_freq();
  146. break;
  147. #endif
  148. }
  149. return src_clk_freq;
  150. }
  151. static esp_err_t ledc_enable_intr_type(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_intr_type_t type)
  152. {
  153. if (type == LEDC_INTR_FADE_END) {
  154. ledc_hal_set_fade_end_intr(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
  155. } else {
  156. ledc_hal_set_fade_end_intr(&(p_ledc_obj[speed_mode]->ledc_hal), channel, false);
  157. }
  158. return ESP_OK;
  159. }
  160. static void _ledc_fade_hw_acquire(ledc_mode_t mode, ledc_channel_t channel)
  161. {
  162. ledc_fade_t *fade = s_ledc_fade_rec[mode][channel];
  163. if (fade) {
  164. xSemaphoreTake(fade->ledc_fade_sem, portMAX_DELAY);
  165. portENTER_CRITICAL(&ledc_spinlock);
  166. ledc_enable_intr_type(mode, channel, LEDC_INTR_DISABLE);
  167. portEXIT_CRITICAL(&ledc_spinlock);
  168. }
  169. }
  170. static void _ledc_fade_hw_release(ledc_mode_t mode, ledc_channel_t channel)
  171. {
  172. ledc_fade_t *fade = s_ledc_fade_rec[mode][channel];
  173. if (fade) {
  174. xSemaphoreGive(fade->ledc_fade_sem);
  175. }
  176. }
  177. static void _ledc_op_lock_acquire(ledc_mode_t mode, ledc_channel_t channel)
  178. {
  179. ledc_fade_t *fade = s_ledc_fade_rec[mode][channel];
  180. if (fade) {
  181. xSemaphoreTake(fade->ledc_fade_mux, portMAX_DELAY);
  182. }
  183. }
  184. static void _ledc_op_lock_release(ledc_mode_t mode, ledc_channel_t channel)
  185. {
  186. ledc_fade_t *fade = s_ledc_fade_rec[mode][channel];
  187. if (fade) {
  188. xSemaphoreGive(fade->ledc_fade_mux);
  189. }
  190. }
  191. static uint32_t ledc_get_max_duty(ledc_mode_t speed_mode, ledc_channel_t channel)
  192. {
  193. // The arguments are checked before internally calling this function.
  194. uint32_t max_duty;
  195. ledc_hal_get_max_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &max_duty);
  196. return max_duty;
  197. }
  198. esp_err_t ledc_timer_set(ledc_mode_t speed_mode, ledc_timer_t timer_sel, uint32_t clock_divider, uint32_t duty_resolution,
  199. ledc_clk_src_t clk_src)
  200. {
  201. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  202. LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
  203. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  204. portENTER_CRITICAL(&ledc_spinlock);
  205. ledc_hal_set_clock_divider(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel, clock_divider);
  206. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  207. /* Clock source can only be configured on boards which support timer-specific
  208. * source clock. */
  209. ledc_hal_set_clock_source(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel, clk_src);
  210. #endif
  211. ledc_hal_set_duty_resolution(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel, duty_resolution);
  212. ledc_ls_timer_update(speed_mode, timer_sel);
  213. portEXIT_CRITICAL(&ledc_spinlock);
  214. return ESP_OK;
  215. }
  216. static IRAM_ATTR esp_err_t ledc_duty_config(ledc_mode_t speed_mode, ledc_channel_t channel, int hpoint_val,
  217. int duty_val, ledc_duty_direction_t duty_direction, uint32_t duty_num, uint32_t duty_cycle, uint32_t duty_scale)
  218. {
  219. if (hpoint_val >= 0) {
  220. ledc_hal_set_hpoint(&(p_ledc_obj[speed_mode]->ledc_hal), channel, hpoint_val);
  221. }
  222. if (duty_val >= 0) {
  223. ledc_hal_set_duty_int_part(&(p_ledc_obj[speed_mode]->ledc_hal), channel, duty_val);
  224. }
  225. ledc_hal_set_duty_direction(&(p_ledc_obj[speed_mode]->ledc_hal), channel, duty_direction);
  226. ledc_hal_set_duty_num(&(p_ledc_obj[speed_mode]->ledc_hal), channel, duty_num);
  227. ledc_hal_set_duty_cycle(&(p_ledc_obj[speed_mode]->ledc_hal), channel, duty_cycle);
  228. ledc_hal_set_duty_scale(&(p_ledc_obj[speed_mode]->ledc_hal), channel, duty_scale);
  229. ledc_ls_channel_update(speed_mode, channel);
  230. return ESP_OK;
  231. }
  232. esp_err_t ledc_bind_channel_timer(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_timer_t timer_sel)
  233. {
  234. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  235. LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
  236. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  237. portENTER_CRITICAL(&ledc_spinlock);
  238. ledc_hal_bind_channel_timer(&(p_ledc_obj[speed_mode]->ledc_hal), channel, timer_sel);
  239. ledc_ls_channel_update(speed_mode, channel);
  240. portEXIT_CRITICAL(&ledc_spinlock);
  241. return ESP_OK;
  242. }
  243. esp_err_t ledc_timer_rst(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
  244. {
  245. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  246. LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
  247. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  248. portENTER_CRITICAL(&ledc_spinlock);
  249. ledc_hal_timer_rst(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
  250. ledc_ls_timer_update(speed_mode, timer_sel);
  251. portEXIT_CRITICAL(&ledc_spinlock);
  252. return ESP_OK;
  253. }
  254. esp_err_t ledc_timer_pause(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
  255. {
  256. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  257. LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
  258. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  259. portENTER_CRITICAL(&ledc_spinlock);
  260. ledc_hal_timer_pause(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
  261. ledc_ls_timer_update(speed_mode, timer_sel);
  262. portEXIT_CRITICAL(&ledc_spinlock);
  263. return ESP_OK;
  264. }
  265. esp_err_t ledc_timer_resume(ledc_mode_t speed_mode, ledc_timer_t timer_sel)
  266. {
  267. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  268. LEDC_ARG_CHECK(timer_sel < LEDC_TIMER_MAX, "timer_select");
  269. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  270. portENTER_CRITICAL(&ledc_spinlock);
  271. ledc_hal_timer_resume(&(p_ledc_obj[speed_mode]->ledc_hal), timer_sel);
  272. ledc_ls_timer_update(speed_mode, timer_sel);
  273. portEXIT_CRITICAL(&ledc_spinlock);
  274. return ESP_OK;
  275. }
  276. esp_err_t ledc_isr_register(void (*fn)(void *), void *arg, int intr_alloc_flags, ledc_isr_handle_t *handle)
  277. {
  278. esp_err_t ret;
  279. LEDC_ARG_CHECK(fn, "fn");
  280. portENTER_CRITICAL(&ledc_spinlock);
  281. ret = esp_intr_alloc(ETS_LEDC_INTR_SOURCE, intr_alloc_flags, fn, arg, handle);
  282. portEXIT_CRITICAL(&ledc_spinlock);
  283. return ret;
  284. }
  285. static inline uint32_t ledc_calculate_divisor(uint32_t src_clk_freq, int freq_hz, uint32_t precision)
  286. {
  287. /**
  288. * In order to find the right divisor, we need to divide the source clock
  289. * frequency by the desired frequency. However, two things to note here:
  290. * - The lowest LEDC_LL_FRACTIONAL_BITS bits of the result are the FRACTIONAL
  291. * part. The higher bits represent the integer part, this is why we need
  292. * to right shift the source frequency.
  293. * - The `precision` parameter represents the granularity of the clock. It
  294. * **must** be a power of 2. It means that the resulted divisor is
  295. * a multiplier of `precision`.
  296. *
  297. * Let's take a concrete example, we need to generate a 5KHz clock out of
  298. * a 80MHz clock (APB).
  299. * If the precision is 1024 (10 bits), the resulted multiplier is:
  300. * (80000000 << 8) / (5000 * 1024) = 4000 (0xfa0)
  301. * Let's ignore the fractional part to simplify the explanation, so we get
  302. * a result of 15 (0xf).
  303. * This can be interpreted as: every 15 "precision" ticks, the resulted
  304. * clock will go high, where one precision tick is made out of 1024 source
  305. * clock ticks.
  306. * Thus, every `15 * 1024` source clock ticks, the resulted clock will go
  307. * high.
  308. *
  309. * NOTE: We are also going to round up the value when necessary, thanks to:
  310. * (freq_hz * precision) / 2
  311. */
  312. return ( ( (uint64_t) src_clk_freq << LEDC_LL_FRACTIONAL_BITS ) + ((freq_hz * precision) / 2 ) )
  313. / (freq_hz * precision);
  314. }
  315. static inline uint32_t ledc_auto_global_clk_divisor(int freq_hz, uint32_t precision, ledc_slow_clk_sel_t* clk_target)
  316. {
  317. uint32_t ret = LEDC_CLK_NOT_FOUND;
  318. uint32_t clk_freq = 0;
  319. /* This function will go through all the following clock sources to look
  320. * for a valid divisor which generates the requested frequency. */
  321. for (int i = 0; i < DIM(s_glb_clks); i++) {
  322. /* Before calculating the divisor, we need to have the RTC frequency.
  323. * If it hasn't been measured yet, try calibrating it now. */
  324. if (s_glb_clks[i] == LEDC_SLOW_CLK_RTC8M && s_ledc_slow_clk_8M == 0 && !ledc_slow_clk_calibrate()) {
  325. ESP_LOGD(LEDC_TAG, "Unable to retrieve RTC clock frequency, skipping it\n");
  326. continue;
  327. }
  328. clk_freq = ledc_get_glb_clk_freq(s_glb_clks[i]);
  329. uint32_t div_param = ledc_calculate_divisor(clk_freq, freq_hz, precision);
  330. /* If the divisor is valid, we can return this value. */
  331. if (!LEDC_IS_DIV_INVALID(div_param)) {
  332. *clk_target = s_glb_clks[i];
  333. ret = div_param;
  334. break;
  335. }
  336. }
  337. return ret;
  338. }
  339. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  340. static inline uint32_t ledc_auto_timer_specific_clk_divisor(ledc_mode_t speed_mode, int freq_hz, uint32_t precision,
  341. ledc_clk_src_t* clk_source)
  342. {
  343. uint32_t ret = LEDC_CLK_NOT_FOUND;
  344. for (int i = 0; i < DIM(s_timer_specific_clks); i++) {
  345. uint32_t div_param = ledc_calculate_divisor(s_timer_specific_clks[i].freq, freq_hz, precision);
  346. /* If the divisor is valid, we can return this value. */
  347. if (!LEDC_IS_DIV_INVALID(div_param)) {
  348. *clk_source = s_timer_specific_clks[i].clk;
  349. ret = div_param;
  350. break;
  351. }
  352. }
  353. #if SOC_LEDC_SUPPORT_HS_MODE
  354. /* On board that support LEDC high-speed mode, APB clock becomes a timer-
  355. * specific clock when in high speed mode. Check if it is necessary here
  356. * to test APB. */
  357. if (speed_mode == LEDC_HIGH_SPEED_MODE && ret == LEDC_CLK_NOT_FOUND) {
  358. /* No divider was found yet, try with APB! */
  359. uint32_t div_param = ledc_calculate_divisor(esp_clk_apb_freq(), freq_hz, precision);
  360. if (!LEDC_IS_DIV_INVALID(div_param)) {
  361. *clk_source = LEDC_APB_CLK;
  362. ret = div_param;
  363. }
  364. }
  365. #endif
  366. return ret;
  367. }
  368. #endif
  369. /**
  370. * @brief Try to find the clock with its divisor giving the frequency requested
  371. * by the caller.
  372. */
  373. static uint32_t ledc_auto_clk_divisor(ledc_mode_t speed_mode, int freq_hz, uint32_t precision,
  374. ledc_clk_src_t* clk_source, ledc_slow_clk_sel_t* clk_target)
  375. {
  376. uint32_t ret = LEDC_CLK_NOT_FOUND;
  377. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  378. /* If the SoC presents timer-specific clock(s), try to achieve the given frequency
  379. * thanks to it/them.
  380. * clk_source parameter will returned by this function. */
  381. uint32_t div_param_timer = ledc_auto_timer_specific_clk_divisor(speed_mode, freq_hz, precision, clk_source);
  382. if (div_param_timer != LEDC_CLK_NOT_FOUND) {
  383. /* The dividor is valid, no need try any other clock, return directly. */
  384. ret = div_param_timer;
  385. }
  386. #endif
  387. /* On ESP32, only low speed channel can use the global clocks. For other
  388. * chips, there are no high speed channels. */
  389. if (ret == LEDC_CLK_NOT_FOUND && speed_mode == LEDC_LOW_SPEED_MODE) {
  390. uint32_t div_param_global = ledc_auto_global_clk_divisor(freq_hz, precision, clk_target);
  391. if (div_param_global != LEDC_CLK_NOT_FOUND) {
  392. *clk_source = LEDC_SCLK;
  393. ret = div_param_global;
  394. }
  395. }
  396. return ret;
  397. }
  398. static ledc_slow_clk_sel_t ledc_clk_cfg_to_global_clk(const ledc_clk_cfg_t clk_cfg)
  399. {
  400. ledc_slow_clk_sel_t glb_clk;
  401. switch (clk_cfg) {
  402. #if SOC_LEDC_SUPPORT_APB_CLOCK
  403. case LEDC_USE_APB_CLK:
  404. glb_clk = LEDC_SLOW_CLK_APB;
  405. break;
  406. #endif
  407. #if SOC_LEDC_SUPPORT_PLL_DIV_CLOCK
  408. case LEDC_USE_PLL_DIV_CLK:
  409. glb_clk = LEDC_SLOW_CLK_PLL_DIV;
  410. break;
  411. #endif
  412. case LEDC_USE_RTC8M_CLK:
  413. glb_clk = LEDC_SLOW_CLK_RTC8M;
  414. break;
  415. #if SOC_LEDC_SUPPORT_XTAL_CLOCK
  416. case LEDC_USE_XTAL_CLK:
  417. glb_clk = LEDC_SLOW_CLK_XTAL;
  418. break;
  419. #endif
  420. #if SOC_LEDC_SUPPORT_REF_TICK
  421. case LEDC_USE_REF_TICK:
  422. #endif
  423. default:
  424. /* We should not get here, REF_TICK is NOT a global clock,
  425. * it is a timer-specific clock. */
  426. abort();
  427. }
  428. return glb_clk;
  429. }
  430. /**
  431. * @brief Function setting the LEDC timer divisor with the given source clock,
  432. * frequency and resolution. If the clock configuration passed is
  433. * LEDC_AUTO_CLK, the clock will be determined automatically (if possible).
  434. */
  435. 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)
  436. {
  437. uint32_t div_param = 0;
  438. const uint32_t precision = ( 0x1 << duty_resolution );
  439. /* The clock sources are not initialized on purpose. To produce compiler warning if used but the selector functions
  440. * don't set them properly. */
  441. /* Timer-specific mux. Set to timer-specific clock or LEDC_SCLK if a global clock is used. */
  442. ledc_clk_src_t timer_clk_src;
  443. /* Global clock mux. Should be set when LEDC_SCLK is used in LOW_SPEED_MODE. Otherwise left uninitialized. */
  444. ledc_slow_clk_sel_t glb_clk;
  445. if (clk_cfg == LEDC_AUTO_CLK) {
  446. /* User hasn't specified the speed, we should try to guess it. */
  447. div_param = ledc_auto_clk_divisor(speed_mode, freq_hz, precision, &timer_clk_src, &glb_clk);
  448. } else if (clk_cfg == LEDC_USE_RTC8M_CLK) {
  449. /* User specified source clock(RTC8M_CLK) for low speed channel.
  450. * Make sure the speed mode is correct. */
  451. ESP_RETURN_ON_FALSE((speed_mode == LEDC_LOW_SPEED_MODE), ESP_ERR_INVALID_ARG, LEDC_TAG, "RTC clock can only be used in low speed mode");
  452. /* Before calculating the divisor, we need to have the RTC frequency.
  453. * If it hasn't been measured yet, try calibrating it now. */
  454. if(s_ledc_slow_clk_8M == 0 && ledc_slow_clk_calibrate() == false) {
  455. goto error;
  456. }
  457. /* Set the global clock source */
  458. timer_clk_src = LEDC_SCLK;
  459. glb_clk = LEDC_SLOW_CLK_RTC8M;
  460. /* We have the RTC clock frequency now. */
  461. div_param = ledc_calculate_divisor(s_ledc_slow_clk_8M, freq_hz, precision);
  462. if (LEDC_IS_DIV_INVALID(div_param)) {
  463. div_param = LEDC_CLK_NOT_FOUND;
  464. }
  465. } else {
  466. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  467. if (LEDC_LL_IS_TIMER_SPECIFIC_CLOCK(speed_mode, clk_cfg)) {
  468. /* Currently we can convert a timer-specific clock to a source clock that
  469. * easily because their values are identical in the enumerations (on purpose)
  470. * If we decide to change the values in the future, we should consider defining
  471. * a macro/function to convert timer-specific clock to clock source .*/
  472. timer_clk_src = (ledc_clk_src_t) clk_cfg;
  473. } else
  474. #endif
  475. {
  476. timer_clk_src = LEDC_SCLK;
  477. glb_clk = ledc_clk_cfg_to_global_clk(clk_cfg);
  478. }
  479. uint32_t src_clk_freq = ledc_get_src_clk_freq(clk_cfg);
  480. div_param = ledc_calculate_divisor(src_clk_freq, freq_hz, precision);
  481. if (LEDC_IS_DIV_INVALID(div_param)) {
  482. div_param = LEDC_CLK_NOT_FOUND;
  483. }
  484. }
  485. if (div_param == LEDC_CLK_NOT_FOUND) {
  486. goto error;
  487. }
  488. /* The following debug message makes more sense for AUTO mode. */
  489. ESP_LOGD(LEDC_TAG, "Using clock source %d (in %s mode), divisor: 0x%x\n",
  490. timer_clk_src, (speed_mode == LEDC_LOW_SPEED_MODE ? "slow" : "fast"), div_param);
  491. /* The following block configures the global clock.
  492. * Thus, in theory, this only makes sense when configuring the LOW_SPEED timer and the source clock is LEDC_SCLK (as
  493. * HIGH_SPEED timers won't be clocked by the global clock). However, there are some limitations due to HW design.
  494. */
  495. if (speed_mode == LEDC_LOW_SPEED_MODE) {
  496. #if SOC_LEDC_HAS_TIMER_SPECIFIC_MUX
  497. /* On ESP32 and ESP32-S2, when the source clock of LOW_SPEED timer is a timer-specific one (i.e. REF_TICK), the
  498. * global clock MUST be set to APB_CLK. For HIGH_SPEED timers, this is not necessary.
  499. */
  500. if (timer_clk_src != LEDC_SCLK) {
  501. glb_clk = LEDC_SLOW_CLK_APB;
  502. }
  503. #else
  504. /* On later chips, there is only one type of timer/channel (referred as LOW_SPEED in the code), which can only be
  505. * clocked by the global clock. So there's no limitation on the global clock, except that it must be set.
  506. */
  507. assert(timer_clk_src == LEDC_SCLK);
  508. #endif
  509. ESP_LOGD(LEDC_TAG, "In slow speed mode, global clk set: %d", glb_clk);
  510. portENTER_CRITICAL(&ledc_spinlock);
  511. ledc_hal_set_slow_clk_sel(&(p_ledc_obj[speed_mode]->ledc_hal), glb_clk);
  512. portEXIT_CRITICAL(&ledc_spinlock);
  513. }
  514. /* The divisor is correct, we can write in the hardware. */
  515. ledc_timer_set(speed_mode, timer_num, div_param, duty_resolution, timer_clk_src);
  516. /* Reset the timer. */
  517. ledc_timer_rst(speed_mode, timer_num);
  518. return ESP_OK;
  519. error:
  520. ESP_LOGE(LEDC_TAG, "requested frequency and duty resolution can not be achieved, try reducing freq_hz or duty_resolution. div_param=%d",
  521. (uint32_t ) div_param);
  522. return ESP_FAIL;
  523. }
  524. esp_err_t ledc_timer_config(const ledc_timer_config_t *timer_conf)
  525. {
  526. LEDC_ARG_CHECK(timer_conf != NULL, "timer_conf");
  527. uint32_t freq_hz = timer_conf->freq_hz;
  528. uint32_t duty_resolution = timer_conf->duty_resolution;
  529. uint32_t timer_num = timer_conf->timer_num;
  530. uint32_t speed_mode = timer_conf->speed_mode;
  531. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  532. LEDC_ARG_CHECK(!((timer_conf->clk_cfg == LEDC_USE_RTC8M_CLK) && (speed_mode != LEDC_LOW_SPEED_MODE)), "Only low speed channel support RTC8M_CLK");
  533. periph_module_enable(PERIPH_LEDC_MODULE);
  534. if (freq_hz == 0 || duty_resolution == 0 || duty_resolution >= LEDC_TIMER_BIT_MAX) {
  535. ESP_LOGE(LEDC_TAG, "freq_hz=%u duty_resolution=%u", freq_hz, duty_resolution);
  536. return ESP_ERR_INVALID_ARG;
  537. }
  538. if (timer_num > LEDC_TIMER_3) {
  539. ESP_LOGE(LEDC_TAG, "invalid timer #%u", timer_num);
  540. return ESP_ERR_INVALID_ARG;
  541. }
  542. if (p_ledc_obj[speed_mode] == NULL) {
  543. p_ledc_obj[speed_mode] = (ledc_obj_t *) heap_caps_calloc(1, sizeof(ledc_obj_t), MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
  544. if (p_ledc_obj[speed_mode] == NULL) {
  545. return ESP_ERR_NO_MEM;
  546. }
  547. ledc_hal_init(&(p_ledc_obj[speed_mode]->ledc_hal), speed_mode);
  548. }
  549. return ledc_set_timer_div(speed_mode, timer_num, timer_conf->clk_cfg, freq_hz, duty_resolution);
  550. }
  551. esp_err_t ledc_set_pin(int gpio_num, ledc_mode_t speed_mode, ledc_channel_t ledc_channel)
  552. {
  553. LEDC_ARG_CHECK(ledc_channel < LEDC_CHANNEL_MAX, "ledc_channel");
  554. LEDC_ARG_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(gpio_num), "gpio_num");
  555. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  556. gpio_hal_iomux_func_sel(GPIO_PIN_MUX_REG[gpio_num], PIN_FUNC_GPIO);
  557. gpio_set_direction(gpio_num, GPIO_MODE_OUTPUT);
  558. esp_rom_gpio_connect_out_signal(gpio_num, ledc_periph_signal[speed_mode].sig_out0_idx + ledc_channel, 0, 0);
  559. return ESP_OK;
  560. }
  561. esp_err_t ledc_channel_config(const ledc_channel_config_t *ledc_conf)
  562. {
  563. LEDC_ARG_CHECK(ledc_conf, "ledc_conf");
  564. uint32_t speed_mode = ledc_conf->speed_mode;
  565. int gpio_num = ledc_conf->gpio_num;
  566. uint32_t ledc_channel = ledc_conf->channel;
  567. uint32_t timer_select = ledc_conf->timer_sel;
  568. uint32_t intr_type = ledc_conf->intr_type;
  569. uint32_t duty = ledc_conf->duty;
  570. uint32_t hpoint = ledc_conf->hpoint;
  571. bool output_invert = ledc_conf->flags.output_invert;
  572. LEDC_ARG_CHECK(ledc_channel < LEDC_CHANNEL_MAX, "ledc_channel");
  573. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  574. LEDC_ARG_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(gpio_num), "gpio_num");
  575. LEDC_ARG_CHECK(timer_select < LEDC_TIMER_MAX, "timer_select");
  576. LEDC_ARG_CHECK(intr_type < LEDC_INTR_MAX, "intr_type");
  577. periph_module_enable(PERIPH_LEDC_MODULE);
  578. esp_err_t ret = ESP_OK;
  579. if (p_ledc_obj[speed_mode] == NULL) {
  580. p_ledc_obj[speed_mode] = (ledc_obj_t *) heap_caps_calloc(1, sizeof(ledc_obj_t), MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
  581. if (p_ledc_obj[speed_mode] == NULL) {
  582. return ESP_ERR_NO_MEM;
  583. }
  584. ledc_hal_init(&(p_ledc_obj[speed_mode]->ledc_hal), speed_mode);
  585. }
  586. /*set channel parameters*/
  587. /* channel parameters decide how the waveform looks like in one period*/
  588. /* set channel duty and hpoint value, duty range is (0 ~ ((2 ** duty_resolution) - 1)), max hpoint value is 0xfffff*/
  589. ledc_set_duty_with_hpoint(speed_mode, ledc_channel, duty, hpoint);
  590. /*update duty settings*/
  591. ledc_update_duty(speed_mode, ledc_channel);
  592. /*bind the channel with the timer*/
  593. ledc_bind_channel_timer(speed_mode, ledc_channel, timer_select);
  594. /*set interrupt type*/
  595. portENTER_CRITICAL(&ledc_spinlock);
  596. ledc_enable_intr_type(speed_mode, ledc_channel, intr_type);
  597. portEXIT_CRITICAL(&ledc_spinlock);
  598. ESP_LOGD(LEDC_TAG, "LEDC_PWM CHANNEL %1u|GPIO %02u|Duty %04u|Time %01u",
  599. ledc_channel, gpio_num, duty, timer_select
  600. );
  601. /*set LEDC signal in gpio matrix*/
  602. gpio_hal_iomux_func_sel(GPIO_PIN_MUX_REG[gpio_num], PIN_FUNC_GPIO);
  603. gpio_set_level(gpio_num, output_invert);
  604. gpio_set_direction(gpio_num, GPIO_MODE_OUTPUT);
  605. esp_rom_gpio_connect_out_signal(gpio_num, ledc_periph_signal[speed_mode].sig_out0_idx + ledc_channel, output_invert, 0);
  606. return ret;
  607. }
  608. static void _ledc_update_duty(ledc_mode_t speed_mode, ledc_channel_t channel)
  609. {
  610. ledc_hal_set_sig_out_en(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
  611. ledc_hal_set_duty_start(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
  612. ledc_ls_channel_update(speed_mode, channel);
  613. }
  614. esp_err_t ledc_update_duty(ledc_mode_t speed_mode, ledc_channel_t channel)
  615. {
  616. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  617. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  618. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  619. portENTER_CRITICAL(&ledc_spinlock);
  620. _ledc_update_duty(speed_mode, channel);
  621. portEXIT_CRITICAL(&ledc_spinlock);
  622. return ESP_OK;
  623. }
  624. esp_err_t ledc_stop(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t idle_level)
  625. {
  626. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  627. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  628. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  629. portENTER_CRITICAL(&ledc_spinlock);
  630. ledc_hal_set_idle_level(&(p_ledc_obj[speed_mode]->ledc_hal), channel, idle_level);
  631. ledc_hal_set_sig_out_en(&(p_ledc_obj[speed_mode]->ledc_hal), channel, false);
  632. ledc_hal_set_duty_start(&(p_ledc_obj[speed_mode]->ledc_hal), channel, false);
  633. ledc_ls_channel_update(speed_mode, channel);
  634. portEXIT_CRITICAL(&ledc_spinlock);
  635. return ESP_OK;
  636. }
  637. esp_err_t ledc_set_fade(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, ledc_duty_direction_t fade_direction,
  638. uint32_t step_num, uint32_t duty_cyle_num, uint32_t duty_scale)
  639. {
  640. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  641. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  642. LEDC_ARG_CHECK(fade_direction < LEDC_DUTY_DIR_MAX, "fade_direction");
  643. LEDC_ARG_CHECK(step_num <= LEDC_LL_DUTY_NUM_MAX, "step_num");
  644. LEDC_ARG_CHECK(duty_cyle_num <= LEDC_LL_DUTY_CYCLE_MAX, "duty_cycle_num");
  645. LEDC_ARG_CHECK(duty_scale <= LEDC_LL_DUTY_SCALE_MAX, "duty_scale");
  646. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  647. _ledc_fade_hw_acquire(speed_mode, channel);
  648. portENTER_CRITICAL(&ledc_spinlock);
  649. ledc_duty_config(speed_mode,
  650. channel, //uint32_t chan_num,
  651. LEDC_VAL_NO_CHANGE,
  652. duty, //uint32_t duty_val,
  653. fade_direction, //uint32_t increase,
  654. step_num, //uint32_t duty_num,
  655. duty_cyle_num, //uint32_t duty_cycle,
  656. duty_scale //uint32_t duty_scale
  657. );
  658. portEXIT_CRITICAL(&ledc_spinlock);
  659. _ledc_fade_hw_release(speed_mode, channel);
  660. return ESP_OK;
  661. }
  662. esp_err_t ledc_set_duty_with_hpoint(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, uint32_t hpoint)
  663. {
  664. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  665. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  666. LEDC_ARG_CHECK(hpoint <= LEDC_LL_HPOINT_VAL_MAX, "hpoint");
  667. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  668. /* The channel configuration should not be changed before the fade operation is done. */
  669. _ledc_fade_hw_acquire(speed_mode, channel);
  670. portENTER_CRITICAL(&ledc_spinlock);
  671. ledc_duty_config(speed_mode,
  672. channel, //uint32_t chan_num,
  673. hpoint, //uint32_t hpoint_val,
  674. duty, //uint32_t duty_val,
  675. 1, //uint32_t increase,
  676. 0, //uint32_t duty_num,
  677. 0, //uint32_t duty_cycle,
  678. 0 //uint32_t duty_scale
  679. );
  680. portEXIT_CRITICAL(&ledc_spinlock);
  681. _ledc_fade_hw_release(speed_mode, channel);
  682. return ESP_OK;
  683. }
  684. esp_err_t ledc_set_duty(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty)
  685. {
  686. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  687. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  688. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  689. /* The channel configuration should not be changed before the fade operation is done. */
  690. _ledc_fade_hw_acquire(speed_mode, channel);
  691. portENTER_CRITICAL(&ledc_spinlock);
  692. ledc_duty_config(speed_mode,
  693. channel, //uint32_t chan_num,
  694. LEDC_VAL_NO_CHANGE,
  695. duty, //uint32_t duty_val,
  696. 1, //uint32_t increase,
  697. 0, //uint32_t duty_num,
  698. 0, //uint32_t duty_cycle,
  699. 0 //uint32_t duty_scale
  700. );
  701. portEXIT_CRITICAL(&ledc_spinlock);
  702. _ledc_fade_hw_release(speed_mode, channel);
  703. return ESP_OK;
  704. }
  705. uint32_t ledc_get_duty(ledc_mode_t speed_mode, ledc_channel_t channel)
  706. {
  707. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  708. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  709. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  710. uint32_t duty = 0;
  711. ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty);
  712. return duty;
  713. }
  714. int ledc_get_hpoint(ledc_mode_t speed_mode, ledc_channel_t channel)
  715. {
  716. LEDC_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode argument is invalid", LEDC_ERR_VAL);
  717. LEDC_CHECK(channel < LEDC_CHANNEL_MAX, "channel argument is invalid", LEDC_ERR_VAL);
  718. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  719. uint32_t hpoint = 0;
  720. ledc_hal_get_hpoint(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &hpoint);
  721. return hpoint;
  722. }
  723. esp_err_t ledc_set_freq(ledc_mode_t speed_mode, ledc_timer_t timer_num, uint32_t freq_hz)
  724. {
  725. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  726. LEDC_ARG_CHECK(timer_num < LEDC_TIMER_MAX, "timer_num");
  727. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  728. ledc_clk_cfg_t clk_cfg = LEDC_AUTO_CLK;
  729. uint32_t duty_resolution = 0;
  730. ledc_hal_get_clk_cfg(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &clk_cfg);
  731. ledc_hal_get_duty_resolution(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &duty_resolution);
  732. return ledc_set_timer_div(speed_mode, timer_num, clk_cfg, freq_hz, duty_resolution);
  733. }
  734. uint32_t ledc_get_freq(ledc_mode_t speed_mode, ledc_timer_t timer_num)
  735. {
  736. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  737. LEDC_ARG_CHECK(timer_num < LEDC_TIMER_MAX, "timer_num");
  738. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  739. portENTER_CRITICAL(&ledc_spinlock);
  740. uint32_t clock_divider = 0;
  741. uint32_t duty_resolution = 0;
  742. ledc_clk_cfg_t clk_cfg = LEDC_AUTO_CLK;
  743. ledc_hal_get_clock_divider(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &clock_divider);
  744. ledc_hal_get_duty_resolution(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &duty_resolution);
  745. ledc_hal_get_clk_cfg(&(p_ledc_obj[speed_mode]->ledc_hal), timer_num, &clk_cfg);
  746. uint32_t precision = (0x1 << duty_resolution);
  747. uint32_t src_clk_freq = ledc_get_src_clk_freq(clk_cfg);
  748. portEXIT_CRITICAL(&ledc_spinlock);
  749. if (clock_divider == 0) {
  750. ESP_LOGW(LEDC_TAG, "LEDC timer not configured, call ledc_timer_config to set timer frequency");
  751. return 0;
  752. }
  753. return ((uint64_t) src_clk_freq << 8) / precision / clock_divider;
  754. }
  755. static inline void ledc_calc_fade_end_channel(uint32_t *fade_end_status, uint32_t *channel)
  756. {
  757. uint32_t i = __builtin_ffs((*fade_end_status)) - 1;
  758. (*fade_end_status) &= ~(1 << i);
  759. *channel = i;
  760. }
  761. void IRAM_ATTR ledc_fade_isr(void *arg)
  762. {
  763. bool cb_yield = false;
  764. portBASE_TYPE HPTaskAwoken = pdFALSE;
  765. uint32_t speed_mode = 0;
  766. uint32_t channel = 0;
  767. uint32_t intr_status = 0;
  768. ledc_fade_fsm_t state;
  769. for (speed_mode = 0; speed_mode < LEDC_SPEED_MODE_MAX; speed_mode++) {
  770. if (p_ledc_obj[speed_mode] == NULL) {
  771. continue;
  772. }
  773. ledc_hal_get_fade_end_intr_status(&(p_ledc_obj[speed_mode]->ledc_hal), &intr_status);
  774. while (intr_status) {
  775. ledc_calc_fade_end_channel(&intr_status, &channel);
  776. // clear interrupt
  777. ledc_hal_clear_fade_end_intr_status(&(p_ledc_obj[speed_mode]->ledc_hal), channel);
  778. if (s_ledc_fade_rec[speed_mode][channel] == NULL) {
  779. //fade object not initialized yet.
  780. continue;
  781. }
  782. // Switch fade state to ISR_CAL if current state is HW_FADE
  783. bool already_stopped = false;
  784. portENTER_CRITICAL_ISR(&ledc_spinlock);
  785. state = s_ledc_fade_rec[speed_mode][channel]->fsm;
  786. assert(state != LEDC_FSM_ISR_CAL && state != LEDC_FSM_KILLED_PENDING);
  787. if (state == LEDC_FSM_HW_FADE) {
  788. s_ledc_fade_rec[speed_mode][channel]->fsm = LEDC_FSM_ISR_CAL;
  789. } else if (state == LEDC_FSM_IDLE) {
  790. // interrupt seen, but has already been stopped by task
  791. already_stopped = true;
  792. }
  793. portEXIT_CRITICAL_ISR(&ledc_spinlock);
  794. if (already_stopped) {
  795. continue;
  796. }
  797. bool set_to_idle = false;
  798. int cycle = 0;
  799. int delta = 0;
  800. int step = 0;
  801. int next_duty = 0;
  802. uint32_t duty_cur = 0;
  803. ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty_cur);
  804. uint32_t duty_tar = s_ledc_fade_rec[speed_mode][channel]->target_duty;
  805. int scale = s_ledc_fade_rec[speed_mode][channel]->scale;
  806. if (duty_cur == duty_tar || scale == 0) {
  807. // Target duty has reached
  808. set_to_idle = true;
  809. } else {
  810. // Calculate new duty config parameters
  811. delta = (s_ledc_fade_rec[speed_mode][channel]->direction == LEDC_DUTY_DIR_DECREASE) ?
  812. (duty_cur - duty_tar) : (duty_tar - duty_cur);
  813. if (delta > scale) {
  814. next_duty = duty_cur;
  815. step = (delta / scale > LEDC_DUTY_NUM_MAX) ? LEDC_DUTY_NUM_MAX : (delta / scale);
  816. cycle = s_ledc_fade_rec[speed_mode][channel]->cycle_num;
  817. } else {
  818. next_duty = duty_tar;
  819. step = 1;
  820. cycle = 1;
  821. scale = 0;
  822. }
  823. }
  824. bool finished = false;
  825. portENTER_CRITICAL_ISR(&ledc_spinlock);
  826. state = s_ledc_fade_rec[speed_mode][channel]->fsm;
  827. assert(state != LEDC_FSM_IDLE && state != LEDC_FSM_HW_FADE);
  828. if (set_to_idle || state == LEDC_FSM_KILLED_PENDING) {
  829. // Either fade has completed or has been killed, skip HW duty config
  830. finished = true;
  831. s_ledc_fade_rec[speed_mode][channel]->fsm = LEDC_FSM_IDLE;
  832. } else if (state == LEDC_FSM_ISR_CAL) {
  833. // Loading new fade to start
  834. ledc_duty_config(speed_mode,
  835. channel,
  836. LEDC_VAL_NO_CHANGE,
  837. next_duty,
  838. s_ledc_fade_rec[speed_mode][channel]->direction,
  839. step,
  840. cycle,
  841. scale);
  842. s_ledc_fade_rec[speed_mode][channel]->fsm = LEDC_FSM_HW_FADE;
  843. ledc_hal_set_duty_start(&(p_ledc_obj[speed_mode]->ledc_hal), channel, true);
  844. }
  845. portEXIT_CRITICAL_ISR(&ledc_spinlock);
  846. if (finished) {
  847. xSemaphoreGiveFromISR(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem, &HPTaskAwoken);
  848. ledc_cb_t fade_cb = s_ledc_fade_rec[speed_mode][channel]->ledc_fade_callback;
  849. if (fade_cb) {
  850. ledc_cb_param_t param = {
  851. .event = LEDC_FADE_END_EVT,
  852. .speed_mode = speed_mode,
  853. .channel = channel,
  854. .duty = duty_cur
  855. };
  856. cb_yield |= fade_cb(&param, s_ledc_fade_rec[speed_mode][channel]->cb_user_arg);
  857. }
  858. }
  859. }
  860. }
  861. if (HPTaskAwoken == pdTRUE || cb_yield) {
  862. portYIELD_FROM_ISR();
  863. }
  864. }
  865. static esp_err_t ledc_fade_channel_deinit(ledc_mode_t speed_mode, ledc_channel_t channel)
  866. {
  867. if (s_ledc_fade_rec[speed_mode][channel]) {
  868. if (s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux) {
  869. vSemaphoreDelete(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux);
  870. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux = NULL;
  871. }
  872. if (s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem) {
  873. vSemaphoreDelete(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem);
  874. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem = NULL;
  875. }
  876. free(s_ledc_fade_rec[speed_mode][channel]);
  877. s_ledc_fade_rec[speed_mode][channel] = NULL;
  878. }
  879. return ESP_OK;
  880. }
  881. static esp_err_t ledc_fade_channel_init_check(ledc_mode_t speed_mode, ledc_channel_t channel)
  882. {
  883. if (s_ledc_fade_isr_handle == NULL) {
  884. ESP_LOGE(LEDC_TAG, "Fade service not installed, call ledc_fade_func_install");
  885. return ESP_FAIL;
  886. }
  887. if (s_ledc_fade_rec[speed_mode][channel] == NULL) {
  888. #if CONFIG_SPIRAM_USE_MALLOC
  889. s_ledc_fade_rec[speed_mode][channel] = (ledc_fade_t *) heap_caps_calloc(1, sizeof(ledc_fade_t), MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
  890. if (s_ledc_fade_rec[speed_mode][channel] == NULL) {
  891. ledc_fade_channel_deinit(speed_mode, channel);
  892. return ESP_ERR_NO_MEM;
  893. }
  894. memset(&s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem_storage, 0, sizeof(StaticQueue_t));
  895. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem = xSemaphoreCreateBinaryStatic(&s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem_storage);
  896. #else
  897. s_ledc_fade_rec[speed_mode][channel] = (ledc_fade_t *) calloc(1, sizeof(ledc_fade_t));
  898. if (s_ledc_fade_rec[speed_mode][channel] == NULL) {
  899. ledc_fade_channel_deinit(speed_mode, channel);
  900. return ESP_ERR_NO_MEM;
  901. }
  902. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem = xSemaphoreCreateBinary();
  903. #endif
  904. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux = xSemaphoreCreateMutex();
  905. xSemaphoreGive(s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem);
  906. s_ledc_fade_rec[speed_mode][channel]->fsm = LEDC_FSM_IDLE;
  907. }
  908. if (s_ledc_fade_rec[speed_mode][channel]
  909. && s_ledc_fade_rec[speed_mode][channel]->ledc_fade_mux
  910. && s_ledc_fade_rec[speed_mode][channel]->ledc_fade_sem) {
  911. return ESP_OK;
  912. } else {
  913. ledc_fade_channel_deinit(speed_mode, channel);
  914. return ESP_FAIL;
  915. }
  916. }
  917. 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)
  918. {
  919. portENTER_CRITICAL(&ledc_spinlock);
  920. uint32_t duty_cur = 0;
  921. ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty_cur);
  922. // When duty == max_duty, meanwhile, if scale == 1 and fade_down == 1, counter would overflow.
  923. if (duty_cur == ledc_get_max_duty(speed_mode, channel)) {
  924. duty_cur -= 1;
  925. }
  926. s_ledc_fade_rec[speed_mode][channel]->speed_mode = speed_mode;
  927. s_ledc_fade_rec[speed_mode][channel]->target_duty = target_duty;
  928. s_ledc_fade_rec[speed_mode][channel]->cycle_num = cycle_num;
  929. s_ledc_fade_rec[speed_mode][channel]->scale = scale;
  930. int step_num = 0;
  931. int dir = LEDC_DUTY_DIR_DECREASE;
  932. if (scale > 0) {
  933. if (duty_cur > target_duty) {
  934. s_ledc_fade_rec[speed_mode][channel]->direction = LEDC_DUTY_DIR_DECREASE;
  935. step_num = (duty_cur - target_duty) / scale;
  936. step_num = step_num > LEDC_DUTY_NUM_MAX ? LEDC_DUTY_NUM_MAX : step_num;
  937. } else {
  938. s_ledc_fade_rec[speed_mode][channel]->direction = LEDC_DUTY_DIR_INCREASE;
  939. dir = LEDC_DUTY_DIR_INCREASE;
  940. step_num = (target_duty - duty_cur) / scale;
  941. step_num = step_num > LEDC_DUTY_NUM_MAX ? LEDC_DUTY_NUM_MAX : step_num;
  942. }
  943. }
  944. portEXIT_CRITICAL(&ledc_spinlock);
  945. if (scale > 0 && step_num > 0) {
  946. portENTER_CRITICAL(&ledc_spinlock);
  947. ledc_duty_config(speed_mode, channel, LEDC_VAL_NO_CHANGE, duty_cur, dir, step_num, cycle_num, scale);
  948. portEXIT_CRITICAL(&ledc_spinlock);
  949. ESP_LOGD(LEDC_TAG, "cur duty: %d; target: %d, step: %d, cycle: %d; scale: %d; dir: %d\n",
  950. duty_cur, target_duty, step_num, cycle_num, scale, dir);
  951. } else {
  952. portENTER_CRITICAL(&ledc_spinlock);
  953. ledc_duty_config(speed_mode, channel, LEDC_VAL_NO_CHANGE, target_duty, dir, 0, 1, 0);
  954. portEXIT_CRITICAL(&ledc_spinlock);
  955. ESP_LOGD(LEDC_TAG, "Set to target duty: %d", target_duty);
  956. }
  957. return ESP_OK;
  958. }
  959. 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)
  960. {
  961. ledc_timer_t timer_sel;
  962. uint32_t duty_cur = 0;
  963. ledc_hal_get_channel_timer(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &timer_sel);
  964. ledc_hal_get_duty(&(p_ledc_obj[speed_mode]->ledc_hal), channel, &duty_cur);
  965. uint32_t freq = ledc_get_freq(speed_mode, timer_sel);
  966. uint32_t duty_delta = target_duty > duty_cur ? target_duty - duty_cur : duty_cur - target_duty;
  967. if (duty_delta == 0) {
  968. return _ledc_set_fade_with_step(speed_mode, channel, target_duty, 0, 0);
  969. }
  970. uint32_t total_cycles = max_fade_time_ms * freq / 1000;
  971. if (total_cycles == 0) {
  972. ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_FAST_STR);
  973. return _ledc_set_fade_with_step(speed_mode, channel, target_duty, 0, 0);
  974. }
  975. int scale, cycle_num;
  976. if (total_cycles > duty_delta) {
  977. scale = 1;
  978. cycle_num = total_cycles / duty_delta;
  979. if (cycle_num > LEDC_LL_DUTY_NUM_MAX) {
  980. ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_SLOW_STR);
  981. cycle_num = LEDC_LL_DUTY_NUM_MAX;
  982. }
  983. } else {
  984. cycle_num = 1;
  985. scale = duty_delta / total_cycles;
  986. if (scale > LEDC_LL_DUTY_SCALE_MAX) {
  987. ESP_LOGW(LEDC_TAG, LEDC_FADE_TOO_FAST_STR);
  988. scale = LEDC_LL_DUTY_SCALE_MAX;
  989. }
  990. }
  991. return _ledc_set_fade_with_step(speed_mode, channel, target_duty, scale, cycle_num);
  992. }
  993. static void _ledc_fade_start(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_fade_mode_t fade_mode)
  994. {
  995. ledc_fade_t *fade = s_ledc_fade_rec[speed_mode][channel];
  996. fade->mode = fade_mode;
  997. // Clear interrupt status of channel
  998. ledc_hal_clear_fade_end_intr_status(&(p_ledc_obj[speed_mode]->ledc_hal), channel);
  999. // Enable interrupt for channel
  1000. portENTER_CRITICAL(&ledc_spinlock);
  1001. ledc_enable_intr_type(speed_mode, channel, LEDC_INTR_FADE_END);
  1002. // Set fade state to HW_FADE state for starting the fade
  1003. assert(fade->fsm == LEDC_FSM_IDLE);
  1004. fade->fsm = LEDC_FSM_HW_FADE;
  1005. portEXIT_CRITICAL(&ledc_spinlock);
  1006. // Trigger the fade
  1007. ledc_update_duty(speed_mode, channel);
  1008. if (fade_mode == LEDC_FADE_WAIT_DONE) {
  1009. // Waiting for fade done
  1010. _ledc_fade_hw_acquire(speed_mode, channel);
  1011. // Release hardware to support next time fade configure
  1012. _ledc_fade_hw_release(speed_mode, channel);
  1013. }
  1014. }
  1015. 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)
  1016. {
  1017. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1018. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1019. LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
  1020. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1021. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1022. _ledc_fade_hw_acquire(speed_mode, channel);
  1023. _ledc_set_fade_with_time(speed_mode, channel, target_duty, max_fade_time_ms);
  1024. _ledc_fade_hw_release(speed_mode, channel);
  1025. return ESP_OK;
  1026. }
  1027. 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)
  1028. {
  1029. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1030. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1031. LEDC_ARG_CHECK((scale > 0) && (scale <= LEDC_LL_DUTY_SCALE_MAX), "fade scale");
  1032. LEDC_ARG_CHECK((cycle_num > 0) && (cycle_num <= LEDC_LL_DUTY_CYCLE_MAX), "cycle_num");
  1033. LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
  1034. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1035. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1036. _ledc_fade_hw_acquire(speed_mode, channel);
  1037. _ledc_set_fade_with_step(speed_mode, channel, target_duty, scale, cycle_num);
  1038. _ledc_fade_hw_release(speed_mode, channel);
  1039. return ESP_OK;
  1040. }
  1041. esp_err_t ledc_fade_start(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_fade_mode_t fade_mode)
  1042. {
  1043. LEDC_CHECK(s_ledc_fade_rec[speed_mode][channel] != NULL, LEDC_FADE_SERVICE_ERR_STR, ESP_ERR_INVALID_STATE);
  1044. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1045. LEDC_ARG_CHECK(fade_mode < LEDC_FADE_MAX, "fade_mode");
  1046. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1047. _ledc_fade_hw_acquire(speed_mode, channel);
  1048. _ledc_fade_start(speed_mode, channel, fade_mode);
  1049. return ESP_OK;
  1050. }
  1051. // ESP32 does not support this functionality, fade cannot be overwritten with new duty config
  1052. #if SOC_LEDC_SUPPORT_FADE_STOP
  1053. esp_err_t ledc_fade_stop(ledc_mode_t speed_mode, ledc_channel_t channel)
  1054. {
  1055. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1056. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1057. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1058. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK , LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1059. ledc_fade_t *fade = s_ledc_fade_rec[speed_mode][channel];
  1060. ledc_fade_fsm_t state = fade->fsm;
  1061. bool wait_for_idle = false;
  1062. assert(state != LEDC_FSM_KILLED_PENDING);
  1063. if (state == LEDC_FSM_IDLE) {
  1064. // if there is no fade going on, do nothing
  1065. return ESP_OK;
  1066. }
  1067. // Fade state is either HW_FADE or ISR_CAL (there is a fade in process)
  1068. portENTER_CRITICAL(&ledc_spinlock);
  1069. // Disable ledc channel interrupt first
  1070. ledc_enable_intr_type(speed_mode, channel, LEDC_INTR_DISABLE);
  1071. // Config duty to the duty cycle at this moment
  1072. uint32_t duty_cur = ledc_get_duty(speed_mode, channel);
  1073. ledc_duty_config(speed_mode,
  1074. channel, //uint32_t chan_num,
  1075. LEDC_VAL_NO_CHANGE,
  1076. duty_cur, //uint32_t duty_val,
  1077. 1, //uint32_t increase,
  1078. 0, //uint32_t duty_num,
  1079. 0, //uint32_t duty_cycle,
  1080. 0 //uint32_t duty_scale
  1081. );
  1082. _ledc_update_duty(speed_mode, channel);
  1083. state = fade->fsm;
  1084. assert(state != LEDC_FSM_IDLE && state != LEDC_FSM_KILLED_PENDING);
  1085. if (state == LEDC_FSM_HW_FADE) {
  1086. fade->fsm = LEDC_FSM_IDLE;
  1087. } else if (state == LEDC_FSM_ISR_CAL) {
  1088. fade->fsm = LEDC_FSM_KILLED_PENDING;
  1089. wait_for_idle = true;
  1090. }
  1091. portEXIT_CRITICAL(&ledc_spinlock);
  1092. if (wait_for_idle) {
  1093. // Wait for ISR return, which gives the semaphore and switchs state to IDLE
  1094. _ledc_fade_hw_acquire(speed_mode, channel);
  1095. assert(fade->fsm == LEDC_FSM_IDLE);
  1096. }
  1097. _ledc_fade_hw_release(speed_mode, channel);
  1098. return ESP_OK;
  1099. }
  1100. #endif
  1101. esp_err_t ledc_fade_func_install(int intr_alloc_flags)
  1102. {
  1103. //OR intr_alloc_flags with ESP_INTR_FLAG_IRAM because the fade isr is in IRAM
  1104. return ledc_isr_register(ledc_fade_isr, NULL, intr_alloc_flags | ESP_INTR_FLAG_IRAM, &s_ledc_fade_isr_handle);
  1105. }
  1106. void ledc_fade_func_uninstall(void)
  1107. {
  1108. if (s_ledc_fade_isr_handle) {
  1109. esp_intr_free(s_ledc_fade_isr_handle);
  1110. s_ledc_fade_isr_handle = NULL;
  1111. }
  1112. int channel, mode;
  1113. for (mode = 0; mode < LEDC_SPEED_MODE_MAX; mode++) {
  1114. for (channel = 0; channel < LEDC_CHANNEL_MAX; channel++) {
  1115. ledc_fade_channel_deinit(mode, channel);
  1116. }
  1117. }
  1118. return;
  1119. }
  1120. esp_err_t ledc_cb_register(ledc_mode_t speed_mode, ledc_channel_t channel, ledc_cbs_t *cbs, void *user_arg)
  1121. {
  1122. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1123. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1124. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1125. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1126. s_ledc_fade_rec[speed_mode][channel]->ledc_fade_callback = cbs->fade_cb;
  1127. s_ledc_fade_rec[speed_mode][channel]->cb_user_arg = user_arg;
  1128. return ESP_OK;
  1129. }
  1130. /*
  1131. * The functions below are thread-safe version of APIs for duty and fade control.
  1132. * These APIs can be called from different tasks.
  1133. */
  1134. esp_err_t ledc_set_duty_and_update(ledc_mode_t speed_mode, ledc_channel_t channel, uint32_t duty, uint32_t hpoint)
  1135. {
  1136. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1137. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1138. LEDC_ARG_CHECK(duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
  1139. LEDC_ARG_CHECK(hpoint <= LEDC_LL_HPOINT_VAL_MAX, "hpoint");
  1140. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1141. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1142. _ledc_fade_hw_acquire(speed_mode, channel);
  1143. portENTER_CRITICAL(&ledc_spinlock);
  1144. ledc_duty_config(speed_mode, channel, hpoint, duty, 1, 0, 0, 0);
  1145. _ledc_update_duty(speed_mode, channel);
  1146. portEXIT_CRITICAL(&ledc_spinlock);
  1147. _ledc_fade_hw_release(speed_mode, channel);
  1148. return ESP_OK;
  1149. }
  1150. 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)
  1151. {
  1152. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1153. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1154. LEDC_ARG_CHECK(fade_mode < LEDC_FADE_MAX, "fade_mode");
  1155. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1156. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1157. LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
  1158. _ledc_op_lock_acquire(speed_mode, channel);
  1159. _ledc_fade_hw_acquire(speed_mode, channel);
  1160. _ledc_set_fade_with_time(speed_mode, channel, target_duty, max_fade_time_ms);
  1161. _ledc_fade_start(speed_mode, channel, fade_mode);
  1162. _ledc_op_lock_release(speed_mode, channel);
  1163. return ESP_OK;
  1164. }
  1165. 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)
  1166. {
  1167. LEDC_ARG_CHECK(speed_mode < LEDC_SPEED_MODE_MAX, "speed_mode");
  1168. LEDC_ARG_CHECK(channel < LEDC_CHANNEL_MAX, "channel");
  1169. LEDC_ARG_CHECK(fade_mode < LEDC_FADE_MAX, "fade_mode");
  1170. LEDC_CHECK(p_ledc_obj[speed_mode] != NULL, LEDC_NOT_INIT, ESP_ERR_INVALID_STATE);
  1171. LEDC_CHECK(ledc_fade_channel_init_check(speed_mode, channel) == ESP_OK, LEDC_FADE_INIT_ERROR_STR, ESP_FAIL);
  1172. LEDC_ARG_CHECK((scale > 0) && (scale <= LEDC_LL_DUTY_SCALE_MAX), "fade scale");
  1173. LEDC_ARG_CHECK((cycle_num > 0) && (cycle_num <= LEDC_LL_DUTY_CYCLE_MAX), "cycle_num");
  1174. LEDC_ARG_CHECK(target_duty <= ledc_get_max_duty(speed_mode, channel), "target_duty");
  1175. _ledc_op_lock_acquire(speed_mode, channel);
  1176. _ledc_fade_hw_acquire(speed_mode, channel);
  1177. _ledc_set_fade_with_step(speed_mode, channel, target_duty, scale, cycle_num);
  1178. _ledc_fade_start(speed_mode, channel, fade_mode);
  1179. _ledc_op_lock_release(speed_mode, channel);
  1180. return ESP_OK;
  1181. }