ledc.c 38 KB

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