pm_impl.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745
  1. // Copyright 2016-2017 Espressif Systems (Shanghai) PTE LTD
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. #include <stdlib.h>
  15. #include <stdbool.h>
  16. #include <string.h>
  17. #include <sys/param.h>
  18. #include "esp_attr.h"
  19. #include "esp_err.h"
  20. #include "esp_pm.h"
  21. #include "esp_log.h"
  22. #include "esp_private/crosscore_int.h"
  23. #include "soc/rtc.h"
  24. #include "hal/cpu_hal.h"
  25. #include "hal/uart_ll.h"
  26. #include "hal/uart_types.h"
  27. #include "freertos/FreeRTOS.h"
  28. #include "freertos/task.h"
  29. #include "freertos/xtensa_timer.h"
  30. #include "xtensa/core-macros.h"
  31. #include "esp_private/pm_impl.h"
  32. #include "esp_private/pm_trace.h"
  33. #include "esp_private/esp_timer_private.h"
  34. #include "esp_sleep.h"
  35. #include "sdkconfig.h"
  36. // [refactor-todo] opportunity for further refactor
  37. #if CONFIG_IDF_TARGET_ESP32
  38. #include "esp32/clk.h"
  39. #include "esp32/pm.h"
  40. #include "driver/gpio.h"
  41. #elif CONFIG_IDF_TARGET_ESP32S2
  42. #include "esp32s2/clk.h"
  43. #include "esp32s2/pm.h"
  44. #include "driver/gpio.h"
  45. #elif CONFIG_IDF_TARGET_ESP32S3
  46. #include "esp32s3/clk.h"
  47. #include "esp32s3/pm.h"
  48. #endif
  49. #define MHZ (1000000)
  50. /* CCOMPARE update timeout, in CPU cycles. Any value above ~600 cycles will work
  51. * for the purpose of detecting a deadlock.
  52. */
  53. #define CCOMPARE_UPDATE_TIMEOUT 1000000
  54. /* When changing CCOMPARE, don't allow changes if the difference is less
  55. * than this. This is to prevent setting CCOMPARE below CCOUNT.
  56. */
  57. #define CCOMPARE_MIN_CYCLES_IN_FUTURE 1000
  58. /* When light sleep is used, wake this number of microseconds earlier than
  59. * the next tick.
  60. */
  61. #define LIGHT_SLEEP_EARLY_WAKEUP_US 100
  62. #if CONFIG_IDF_TARGET_ESP32
  63. /* Minimal divider at which REF_CLK_FREQ can be obtained */
  64. #define REF_CLK_DIV_MIN 10
  65. #define DEFAULT_CPU_FREQ CONFIG_ESP32_DEFAULT_CPU_FREQ_MHZ
  66. #elif CONFIG_IDF_TARGET_ESP32S2
  67. /* Minimal divider at which REF_CLK_FREQ can be obtained */
  68. #define REF_CLK_DIV_MIN 2
  69. #define DEFAULT_CPU_FREQ CONFIG_ESP32S2_DEFAULT_CPU_FREQ_MHZ
  70. #elif CONFIG_IDF_TARGET_ESP32S3
  71. /* Minimal divider at which REF_CLK_FREQ can be obtained */
  72. #define REF_CLK_DIV_MIN 2
  73. #define DEFAULT_CPU_FREQ CONFIG_ESP32S3_DEFAULT_CPU_FREQ_MHZ
  74. #endif
  75. #ifdef CONFIG_PM_PROFILING
  76. #define WITH_PROFILING
  77. #endif
  78. static portMUX_TYPE s_switch_lock = portMUX_INITIALIZER_UNLOCKED;
  79. /* The following state variables are protected using s_switch_lock: */
  80. /* Current sleep mode; When switching, contains old mode until switch is complete */
  81. static pm_mode_t s_mode = PM_MODE_CPU_MAX;
  82. /* True when switch is in progress */
  83. static volatile bool s_is_switching;
  84. /* When switch is in progress, this is the mode we are switching into */
  85. static pm_mode_t s_new_mode = PM_MODE_CPU_MAX;
  86. /* Number of times each mode was locked */
  87. static size_t s_mode_lock_counts[PM_MODE_COUNT];
  88. /* Bit mask of locked modes. BIT(i) is set iff s_mode_lock_counts[i] > 0. */
  89. static uint32_t s_mode_mask;
  90. /* Divider and multiplier used to adjust (ccompare - ccount) duration.
  91. * Only set to non-zero values when switch is in progress.
  92. */
  93. static uint32_t s_ccount_div;
  94. static uint32_t s_ccount_mul;
  95. #if CONFIG_FREERTOS_USE_TICKLESS_IDLE
  96. #if CONFIG_IDF_TARGET_ESP32S2 || CONFIG_IDF_TARGET_ESP32S3
  97. #define PERIPH_SKIP_LIGHT_SLEEP_NO 1
  98. /* Indicates if light sleep shoule be skipped by peripherals. */
  99. static skip_light_sleep_cb_t s_periph_skip_light_sleep_cb[PERIPH_SKIP_LIGHT_SLEEP_NO];
  100. #endif
  101. /* Indicates if light sleep entry was skipped in vApplicationSleep for given CPU.
  102. * This in turn gets used in IDLE hook to decide if `waiti` needs
  103. * to be invoked or not.
  104. */
  105. static bool s_skipped_light_sleep[portNUM_PROCESSORS];
  106. #if portNUM_PROCESSORS == 2
  107. /* When light sleep is finished on one CPU, it is possible that the other CPU
  108. * will enter light sleep again very soon, before interrupts on the first CPU
  109. * get a chance to run. To avoid such situation, set a flag for the other CPU to
  110. * skip light sleep attempt.
  111. */
  112. static bool s_skip_light_sleep[portNUM_PROCESSORS];
  113. #endif // portNUM_PROCESSORS == 2
  114. #endif // CONFIG_FREERTOS_USE_TICKLESS_IDLE
  115. /* Indicates to the ISR hook that CCOMPARE needs to be updated on the given CPU.
  116. * Used in conjunction with cross-core interrupt to update CCOMPARE on the other CPU.
  117. */
  118. static volatile bool s_need_update_ccompare[portNUM_PROCESSORS];
  119. /* A flag indicating that Idle hook has run on a given CPU;
  120. * Next interrupt on the same CPU will take s_rtos_lock_handle.
  121. */
  122. static bool s_core_idle[portNUM_PROCESSORS];
  123. /* When no RTOS tasks are active, these locks are released to allow going into
  124. * a lower power mode. Used by ISR hook and idle hook.
  125. */
  126. static esp_pm_lock_handle_t s_rtos_lock_handle[portNUM_PROCESSORS];
  127. /* Lookup table of CPU frequency configs to be used in each mode.
  128. * Initialized by esp_pm_impl_init and modified by esp_pm_configure.
  129. */
  130. rtc_cpu_freq_config_t s_cpu_freq_by_mode[PM_MODE_COUNT];
  131. /* Whether automatic light sleep is enabled */
  132. static bool s_light_sleep_en = false;
  133. /* When configuration is changed, current frequency may not match the
  134. * newly configured frequency for the current mode. This is an indicator
  135. * to the mode switch code to get the actual current frequency instead of
  136. * relying on the current mode.
  137. */
  138. static bool s_config_changed = false;
  139. #ifdef WITH_PROFILING
  140. /* Time, in microseconds, spent so far in each mode */
  141. static pm_time_t s_time_in_mode[PM_MODE_COUNT];
  142. /* Timestamp, in microseconds, when the mode switch last happened */
  143. static pm_time_t s_last_mode_change_time;
  144. /* User-readable mode names, used by esp_pm_impl_dump_stats */
  145. static const char* s_mode_names[] = {
  146. "SLEEP",
  147. "APB_MIN",
  148. "APB_MAX",
  149. "CPU_MAX"
  150. };
  151. #endif // WITH_PROFILING
  152. static const char* TAG = "pm_" CONFIG_IDF_TARGET;
  153. static void update_ccompare(void);
  154. static void do_switch(pm_mode_t new_mode);
  155. static void leave_idle(void);
  156. static void on_freq_update(uint32_t old_ticks_per_us, uint32_t ticks_per_us);
  157. pm_mode_t esp_pm_impl_get_mode(esp_pm_lock_type_t type, int arg)
  158. {
  159. (void) arg;
  160. if (type == ESP_PM_CPU_FREQ_MAX) {
  161. return PM_MODE_CPU_MAX;
  162. } else if (type == ESP_PM_APB_FREQ_MAX) {
  163. return PM_MODE_APB_MAX;
  164. } else if (type == ESP_PM_NO_LIGHT_SLEEP) {
  165. return PM_MODE_APB_MIN;
  166. } else {
  167. // unsupported mode
  168. abort();
  169. }
  170. }
  171. esp_err_t esp_pm_configure(const void* vconfig)
  172. {
  173. #ifndef CONFIG_PM_ENABLE
  174. return ESP_ERR_NOT_SUPPORTED;
  175. #endif
  176. #if CONFIG_IDF_TARGET_ESP32
  177. const esp_pm_config_esp32_t* config = (const esp_pm_config_esp32_t*) vconfig;
  178. #elif CONFIG_IDF_TARGET_ESP32S2
  179. const esp_pm_config_esp32s2_t* config = (const esp_pm_config_esp32s2_t*) vconfig;
  180. #elif CONFIG_IDF_TARGET_ESP32S3
  181. const esp_pm_config_esp32s3_t* config = (const esp_pm_config_esp32s3_t*) vconfig;
  182. #endif
  183. #ifndef CONFIG_FREERTOS_USE_TICKLESS_IDLE
  184. if (config->light_sleep_enable) {
  185. return ESP_ERR_NOT_SUPPORTED;
  186. }
  187. #endif
  188. int min_freq_mhz = config->min_freq_mhz;
  189. int max_freq_mhz = config->max_freq_mhz;
  190. if (min_freq_mhz > max_freq_mhz) {
  191. return ESP_ERR_INVALID_ARG;
  192. }
  193. rtc_cpu_freq_config_t freq_config;
  194. if (!rtc_clk_cpu_freq_mhz_to_config(min_freq_mhz, &freq_config)) {
  195. ESP_LOGW(TAG, "invalid min_freq_mhz value (%d)", min_freq_mhz);
  196. return ESP_ERR_INVALID_ARG;
  197. }
  198. int xtal_freq_mhz = (int) rtc_clk_xtal_freq_get();
  199. if (min_freq_mhz < xtal_freq_mhz && min_freq_mhz * MHZ / REF_CLK_FREQ < REF_CLK_DIV_MIN) {
  200. ESP_LOGW(TAG, "min_freq_mhz should be >= %d", REF_CLK_FREQ * REF_CLK_DIV_MIN / MHZ);
  201. return ESP_ERR_INVALID_ARG;
  202. }
  203. if (!rtc_clk_cpu_freq_mhz_to_config(max_freq_mhz, &freq_config)) {
  204. ESP_LOGW(TAG, "invalid max_freq_mhz value (%d)", max_freq_mhz);
  205. return ESP_ERR_INVALID_ARG;
  206. }
  207. #if CONFIG_IDF_TARGET_ESP32
  208. int apb_max_freq = max_freq_mhz; /* CPU frequency in APB_MAX mode */
  209. if (max_freq_mhz == 240) {
  210. /* We can't switch between 240 and 80/160 without disabling PLL,
  211. * so use 240MHz CPU frequency when 80MHz APB frequency is requested.
  212. */
  213. apb_max_freq = 240;
  214. } else if (max_freq_mhz == 160 || max_freq_mhz == 80) {
  215. /* Otherwise, can use 80MHz
  216. * CPU frequency when 80MHz APB frequency is requested.
  217. */
  218. apb_max_freq = 80;
  219. }
  220. #elif CONFIG_IDF_TARGET_ESP32S2 || CONFIG_IDF_TARGET_ESP32S3
  221. int apb_max_freq = MIN(max_freq_mhz, 80); /* CPU frequency in APB_MAX mode */
  222. #endif
  223. apb_max_freq = MAX(apb_max_freq, min_freq_mhz);
  224. ESP_LOGI(TAG, "Frequency switching config: "
  225. "CPU_MAX: %d, APB_MAX: %d, APB_MIN: %d, Light sleep: %s",
  226. max_freq_mhz,
  227. apb_max_freq,
  228. min_freq_mhz,
  229. config->light_sleep_enable ? "ENABLED" : "DISABLED");
  230. portENTER_CRITICAL(&s_switch_lock);
  231. bool res = false;
  232. res = rtc_clk_cpu_freq_mhz_to_config(max_freq_mhz, &s_cpu_freq_by_mode[PM_MODE_CPU_MAX]);
  233. assert(res);
  234. res = rtc_clk_cpu_freq_mhz_to_config(apb_max_freq, &s_cpu_freq_by_mode[PM_MODE_APB_MAX]);
  235. assert(res);
  236. res = rtc_clk_cpu_freq_mhz_to_config(min_freq_mhz, &s_cpu_freq_by_mode[PM_MODE_APB_MIN]);
  237. assert(res);
  238. s_cpu_freq_by_mode[PM_MODE_LIGHT_SLEEP] = s_cpu_freq_by_mode[PM_MODE_APB_MIN];
  239. s_light_sleep_en = config->light_sleep_enable;
  240. s_config_changed = true;
  241. portEXIT_CRITICAL(&s_switch_lock);
  242. #if CONFIG_PM_SLP_DISABLE_GPIO && SOC_GPIO_SUPPORT_SLP_SWITCH
  243. esp_sleep_gpio_status_switch_configure(config->light_sleep_enable);
  244. #endif
  245. return ESP_OK;
  246. }
  247. static pm_mode_t IRAM_ATTR get_lowest_allowed_mode(void)
  248. {
  249. /* TODO: optimize using ffs/clz */
  250. if (s_mode_mask >= BIT(PM_MODE_CPU_MAX)) {
  251. return PM_MODE_CPU_MAX;
  252. } else if (s_mode_mask >= BIT(PM_MODE_APB_MAX)) {
  253. return PM_MODE_APB_MAX;
  254. } else if (s_mode_mask >= BIT(PM_MODE_APB_MIN) || !s_light_sleep_en) {
  255. return PM_MODE_APB_MIN;
  256. } else {
  257. return PM_MODE_LIGHT_SLEEP;
  258. }
  259. }
  260. void IRAM_ATTR esp_pm_impl_switch_mode(pm_mode_t mode,
  261. pm_mode_switch_t lock_or_unlock, pm_time_t now)
  262. {
  263. bool need_switch = false;
  264. uint32_t mode_mask = BIT(mode);
  265. portENTER_CRITICAL_SAFE(&s_switch_lock);
  266. uint32_t count;
  267. if (lock_or_unlock == MODE_LOCK) {
  268. count = ++s_mode_lock_counts[mode];
  269. } else {
  270. count = s_mode_lock_counts[mode]--;
  271. }
  272. if (count == 1) {
  273. if (lock_or_unlock == MODE_LOCK) {
  274. s_mode_mask |= mode_mask;
  275. } else {
  276. s_mode_mask &= ~mode_mask;
  277. }
  278. need_switch = true;
  279. }
  280. pm_mode_t new_mode = s_mode;
  281. if (need_switch) {
  282. new_mode = get_lowest_allowed_mode();
  283. #ifdef WITH_PROFILING
  284. if (s_last_mode_change_time != 0) {
  285. pm_time_t diff = now - s_last_mode_change_time;
  286. s_time_in_mode[s_mode] += diff;
  287. }
  288. s_last_mode_change_time = now;
  289. #endif // WITH_PROFILING
  290. }
  291. portEXIT_CRITICAL_SAFE(&s_switch_lock);
  292. if (need_switch && new_mode != s_mode) {
  293. do_switch(new_mode);
  294. }
  295. }
  296. /**
  297. * @brief Update clock dividers in esp_timer and FreeRTOS, and adjust CCOMPARE
  298. * values on both CPUs.
  299. * @param old_ticks_per_us old CPU frequency
  300. * @param ticks_per_us new CPU frequency
  301. */
  302. static void IRAM_ATTR on_freq_update(uint32_t old_ticks_per_us, uint32_t ticks_per_us)
  303. {
  304. uint32_t old_apb_ticks_per_us = MIN(old_ticks_per_us, 80);
  305. uint32_t apb_ticks_per_us = MIN(ticks_per_us, 80);
  306. /* Update APB frequency value used by the timer */
  307. if (old_apb_ticks_per_us != apb_ticks_per_us) {
  308. esp_timer_private_update_apb_freq(apb_ticks_per_us);
  309. }
  310. /* Calculate new tick divisor */
  311. _xt_tick_divisor = ticks_per_us * MHZ / XT_TICK_PER_SEC;
  312. int core_id = xPortGetCoreID();
  313. if (s_rtos_lock_handle[core_id] != NULL) {
  314. ESP_PM_TRACE_ENTER(CCOMPARE_UPDATE, core_id);
  315. /* ccount_div and ccount_mul are used in esp_pm_impl_update_ccompare
  316. * to calculate new CCOMPARE value.
  317. */
  318. s_ccount_div = old_ticks_per_us;
  319. s_ccount_mul = ticks_per_us;
  320. /* Update CCOMPARE value on this CPU */
  321. update_ccompare();
  322. #if portNUM_PROCESSORS == 2
  323. /* Send interrupt to the other CPU to update CCOMPARE value */
  324. int other_core_id = (core_id == 0) ? 1 : 0;
  325. s_need_update_ccompare[other_core_id] = true;
  326. esp_crosscore_int_send_freq_switch(other_core_id);
  327. int timeout = 0;
  328. while (s_need_update_ccompare[other_core_id]) {
  329. if (++timeout == CCOMPARE_UPDATE_TIMEOUT) {
  330. assert(false && "failed to update CCOMPARE, possible deadlock");
  331. }
  332. }
  333. #endif // portNUM_PROCESSORS == 2
  334. s_ccount_mul = 0;
  335. s_ccount_div = 0;
  336. ESP_PM_TRACE_EXIT(CCOMPARE_UPDATE, core_id);
  337. }
  338. }
  339. /**
  340. * Perform the switch to new power mode.
  341. * Currently only changes the CPU frequency and adjusts clock dividers.
  342. * No light sleep yet.
  343. * @param new_mode mode to switch to
  344. */
  345. static void IRAM_ATTR do_switch(pm_mode_t new_mode)
  346. {
  347. const int core_id = xPortGetCoreID();
  348. do {
  349. portENTER_CRITICAL_ISR(&s_switch_lock);
  350. if (!s_is_switching) {
  351. break;
  352. }
  353. if (s_new_mode <= new_mode) {
  354. portEXIT_CRITICAL_ISR(&s_switch_lock);
  355. return;
  356. }
  357. if (s_need_update_ccompare[core_id]) {
  358. s_need_update_ccompare[core_id] = false;
  359. }
  360. portEXIT_CRITICAL_ISR(&s_switch_lock);
  361. } while (true);
  362. s_new_mode = new_mode;
  363. s_is_switching = true;
  364. bool config_changed = s_config_changed;
  365. s_config_changed = false;
  366. portEXIT_CRITICAL_ISR(&s_switch_lock);
  367. rtc_cpu_freq_config_t new_config = s_cpu_freq_by_mode[new_mode];
  368. rtc_cpu_freq_config_t old_config;
  369. if (!config_changed) {
  370. old_config = s_cpu_freq_by_mode[s_mode];
  371. } else {
  372. rtc_clk_cpu_freq_get_config(&old_config);
  373. }
  374. if (new_config.freq_mhz != old_config.freq_mhz) {
  375. uint32_t old_ticks_per_us = old_config.freq_mhz;
  376. uint32_t new_ticks_per_us = new_config.freq_mhz;
  377. bool switch_down = new_ticks_per_us < old_ticks_per_us;
  378. ESP_PM_TRACE_ENTER(FREQ_SWITCH, core_id);
  379. if (switch_down) {
  380. on_freq_update(old_ticks_per_us, new_ticks_per_us);
  381. }
  382. rtc_clk_cpu_freq_set_config_fast(&new_config);
  383. if (!switch_down) {
  384. on_freq_update(old_ticks_per_us, new_ticks_per_us);
  385. }
  386. ESP_PM_TRACE_EXIT(FREQ_SWITCH, core_id);
  387. }
  388. portENTER_CRITICAL_ISR(&s_switch_lock);
  389. s_mode = new_mode;
  390. s_is_switching = false;
  391. portEXIT_CRITICAL_ISR(&s_switch_lock);
  392. }
  393. /**
  394. * @brief Calculate new CCOMPARE value based on s_ccount_{mul,div}
  395. *
  396. * Adjusts CCOMPARE value so that the interrupt happens at the same time as it
  397. * would happen without the frequency change.
  398. * Assumes that the new_frequency = old_frequency * s_ccount_mul / s_ccount_div.
  399. */
  400. static void IRAM_ATTR update_ccompare(void)
  401. {
  402. uint32_t ccount = cpu_hal_get_cycle_count();
  403. uint32_t ccompare = XTHAL_GET_CCOMPARE(XT_TIMER_INDEX);
  404. if ((ccompare - CCOMPARE_MIN_CYCLES_IN_FUTURE) - ccount < UINT32_MAX / 2) {
  405. uint32_t diff = ccompare - ccount;
  406. uint32_t diff_scaled = (diff * s_ccount_mul + s_ccount_div - 1) / s_ccount_div;
  407. if (diff_scaled < _xt_tick_divisor) {
  408. uint32_t new_ccompare = ccount + diff_scaled;
  409. XTHAL_SET_CCOMPARE(XT_TIMER_INDEX, new_ccompare);
  410. }
  411. }
  412. }
  413. static void IRAM_ATTR leave_idle(void)
  414. {
  415. int core_id = xPortGetCoreID();
  416. if (s_core_idle[core_id]) {
  417. // TODO: possible optimization: raise frequency here first
  418. esp_pm_lock_acquire(s_rtos_lock_handle[core_id]);
  419. s_core_idle[core_id] = false;
  420. }
  421. }
  422. void esp_pm_impl_idle_hook(void)
  423. {
  424. int core_id = xPortGetCoreID();
  425. uint32_t state = portENTER_CRITICAL_NESTED();
  426. if (!s_core_idle[core_id]) {
  427. esp_pm_lock_release(s_rtos_lock_handle[core_id]);
  428. s_core_idle[core_id] = true;
  429. }
  430. portEXIT_CRITICAL_NESTED(state);
  431. ESP_PM_TRACE_ENTER(IDLE, core_id);
  432. }
  433. void IRAM_ATTR esp_pm_impl_isr_hook(void)
  434. {
  435. int core_id = xPortGetCoreID();
  436. ESP_PM_TRACE_ENTER(ISR_HOOK, core_id);
  437. /* Prevent higher level interrupts (than the one this function was called from)
  438. * from happening in this section, since they will also call into esp_pm_impl_isr_hook.
  439. */
  440. uint32_t state = portENTER_CRITICAL_NESTED();
  441. #if portNUM_PROCESSORS == 2
  442. if (s_need_update_ccompare[core_id]) {
  443. update_ccompare();
  444. s_need_update_ccompare[core_id] = false;
  445. } else {
  446. leave_idle();
  447. }
  448. #else
  449. leave_idle();
  450. #endif // portNUM_PROCESSORS == 2
  451. portEXIT_CRITICAL_NESTED(state);
  452. ESP_PM_TRACE_EXIT(ISR_HOOK, core_id);
  453. }
  454. void esp_pm_impl_waiti(void)
  455. {
  456. #if CONFIG_FREERTOS_USE_TICKLESS_IDLE
  457. int core_id = xPortGetCoreID();
  458. if (s_skipped_light_sleep[core_id]) {
  459. asm("waiti 0");
  460. /* Interrupt took the CPU out of waiti and s_rtos_lock_handle[core_id]
  461. * is now taken. However since we are back to idle task, we can release
  462. * the lock so that vApplicationSleep can attempt to enter light sleep.
  463. */
  464. esp_pm_impl_idle_hook();
  465. s_skipped_light_sleep[core_id] = false;
  466. }
  467. #else
  468. asm("waiti 0");
  469. #endif // CONFIG_FREERTOS_USE_TICKLESS_IDLE
  470. }
  471. #if CONFIG_FREERTOS_USE_TICKLESS_IDLE
  472. #if CONFIG_IDF_TARGET_ESP32S2 || CONFIG_IDF_TARGET_ESP32S3
  473. esp_err_t esp_pm_register_skip_light_sleep_callback(skip_light_sleep_cb_t cb)
  474. {
  475. for (int i = 0; i < PERIPH_SKIP_LIGHT_SLEEP_NO; i++) {
  476. if (s_periph_skip_light_sleep_cb[i] == cb) {
  477. return ESP_OK;
  478. } else if (s_periph_skip_light_sleep_cb[i] == NULL) {
  479. s_periph_skip_light_sleep_cb[i] = cb;
  480. return ESP_OK;
  481. }
  482. }
  483. return ESP_ERR_NO_MEM;
  484. }
  485. esp_err_t esp_pm_unregister_skip_light_sleep_callback(skip_light_sleep_cb_t cb)
  486. {
  487. for (int i = 0; i < PERIPH_SKIP_LIGHT_SLEEP_NO; i++) {
  488. if (s_periph_skip_light_sleep_cb[i] == cb) {
  489. s_periph_skip_light_sleep_cb[i] = NULL;
  490. return ESP_OK;
  491. }
  492. }
  493. return ESP_ERR_INVALID_STATE;
  494. }
  495. static inline bool IRAM_ATTR periph_should_skip_light_sleep(void)
  496. {
  497. for (int i = 0; i < PERIPH_SKIP_LIGHT_SLEEP_NO; i++) {
  498. if (s_periph_skip_light_sleep_cb[i]) {
  499. if (s_periph_skip_light_sleep_cb[i]() == true) {
  500. return true;
  501. }
  502. }
  503. }
  504. return false;
  505. }
  506. #endif
  507. static inline bool IRAM_ATTR should_skip_light_sleep(int core_id)
  508. {
  509. #if portNUM_PROCESSORS == 2
  510. if (s_skip_light_sleep[core_id]) {
  511. s_skip_light_sleep[core_id] = false;
  512. s_skipped_light_sleep[core_id] = true;
  513. return true;
  514. }
  515. #endif // portNUM_PROCESSORS == 2
  516. #if CONFIG_IDF_TARGET_ESP32
  517. if (s_mode != PM_MODE_LIGHT_SLEEP || s_is_switching) {
  518. #elif CONFIG_IDF_TARGET_ESP32S2 || CONFIG_IDF_TARGET_ESP32S3
  519. if (s_mode != PM_MODE_LIGHT_SLEEP || s_is_switching || periph_should_skip_light_sleep()) {
  520. #endif
  521. s_skipped_light_sleep[core_id] = true;
  522. } else {
  523. s_skipped_light_sleep[core_id] = false;
  524. }
  525. return s_skipped_light_sleep[core_id];
  526. }
  527. static inline void IRAM_ATTR other_core_should_skip_light_sleep(int core_id)
  528. {
  529. #if portNUM_PROCESSORS == 2
  530. s_skip_light_sleep[!core_id] = true;
  531. #endif
  532. }
  533. void IRAM_ATTR vApplicationSleep( TickType_t xExpectedIdleTime )
  534. {
  535. portENTER_CRITICAL(&s_switch_lock);
  536. int core_id = xPortGetCoreID();
  537. if (!should_skip_light_sleep(core_id)) {
  538. /* Calculate how much we can sleep */
  539. int64_t next_esp_timer_alarm = esp_timer_get_next_alarm();
  540. int64_t now = esp_timer_get_time();
  541. int64_t time_until_next_alarm = next_esp_timer_alarm - now;
  542. int64_t wakeup_delay_us = portTICK_PERIOD_MS * 1000LL * xExpectedIdleTime;
  543. int64_t sleep_time_us = MIN(wakeup_delay_us, time_until_next_alarm);
  544. if (sleep_time_us >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP * portTICK_PERIOD_MS * 1000LL) {
  545. esp_sleep_enable_timer_wakeup(sleep_time_us - LIGHT_SLEEP_EARLY_WAKEUP_US);
  546. #ifdef CONFIG_PM_TRACE
  547. /* to force tracing GPIOs to keep state */
  548. esp_sleep_pd_config(ESP_PD_DOMAIN_RTC_PERIPH, ESP_PD_OPTION_ON);
  549. #endif
  550. /* Enter sleep */
  551. ESP_PM_TRACE_ENTER(SLEEP, core_id);
  552. int64_t sleep_start = esp_timer_get_time();
  553. esp_light_sleep_start();
  554. int64_t slept_us = esp_timer_get_time() - sleep_start;
  555. ESP_PM_TRACE_EXIT(SLEEP, core_id);
  556. uint32_t slept_ticks = slept_us / (portTICK_PERIOD_MS * 1000LL);
  557. if (slept_ticks > 0) {
  558. /* Adjust RTOS tick count based on the amount of time spent in sleep */
  559. vTaskStepTick(slept_ticks);
  560. /* Trigger tick interrupt, since sleep time was longer
  561. * than portTICK_PERIOD_MS. Note that setting INTSET does not
  562. * work for timer interrupt, and changing CCOMPARE would clear
  563. * the interrupt flag.
  564. */
  565. cpu_hal_set_cycle_count(XTHAL_GET_CCOMPARE(XT_TIMER_INDEX) - 16);
  566. while (!(XTHAL_GET_INTERRUPT() & BIT(XT_TIMER_INTNUM))) {
  567. ;
  568. }
  569. }
  570. other_core_should_skip_light_sleep(core_id);
  571. }
  572. }
  573. portEXIT_CRITICAL(&s_switch_lock);
  574. }
  575. #endif //CONFIG_FREERTOS_USE_TICKLESS_IDLE
  576. #ifdef WITH_PROFILING
  577. void esp_pm_impl_dump_stats(FILE* out)
  578. {
  579. pm_time_t time_in_mode[PM_MODE_COUNT];
  580. portENTER_CRITICAL_ISR(&s_switch_lock);
  581. memcpy(time_in_mode, s_time_in_mode, sizeof(time_in_mode));
  582. pm_time_t last_mode_change_time = s_last_mode_change_time;
  583. pm_mode_t cur_mode = s_mode;
  584. pm_time_t now = pm_get_time();
  585. portEXIT_CRITICAL_ISR(&s_switch_lock);
  586. time_in_mode[cur_mode] += now - last_mode_change_time;
  587. fprintf(out, "Mode stats:\n");
  588. for (int i = 0; i < PM_MODE_COUNT; ++i) {
  589. if (i == PM_MODE_LIGHT_SLEEP && !s_light_sleep_en) {
  590. /* don't display light sleep mode if it's not enabled */
  591. continue;
  592. }
  593. fprintf(out, "%8s %3dM %12lld %2d%%\n",
  594. s_mode_names[i],
  595. s_cpu_freq_by_mode[i].freq_mhz,
  596. time_in_mode[i],
  597. (int) (time_in_mode[i] * 100 / now));
  598. }
  599. }
  600. #endif // WITH_PROFILING
  601. void esp_pm_impl_init(void)
  602. {
  603. #if defined(CONFIG_ESP_CONSOLE_UART)
  604. //This clock source should be a source which won't be affected by DFS
  605. uint32_t clk_source;
  606. #if CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32S2
  607. clk_source = UART_SCLK_REF_TICK;
  608. #else
  609. clk_source = UART_SCLK_XTAL;
  610. #endif
  611. while(!uart_ll_is_tx_idle(UART_LL_GET_HW(CONFIG_ESP_CONSOLE_UART_NUM)));
  612. /* When DFS is enabled, override system setting and use REFTICK as UART clock source */
  613. uart_ll_set_sclk(UART_LL_GET_HW(CONFIG_ESP_CONSOLE_UART_NUM), clk_source);
  614. uart_ll_set_baudrate(UART_LL_GET_HW(CONFIG_ESP_CONSOLE_UART_NUM), CONFIG_ESP_CONSOLE_UART_BAUDRATE);
  615. #endif // CONFIG_ESP_CONSOLE_UART
  616. #ifdef CONFIG_PM_TRACE
  617. esp_pm_trace_init();
  618. #endif
  619. #if CONFIG_PM_SLP_DISABLE_GPIO && SOC_GPIO_SUPPORT_SLP_SWITCH
  620. esp_sleep_gpio_status_init();
  621. #endif
  622. ESP_ERROR_CHECK(esp_pm_lock_create(ESP_PM_CPU_FREQ_MAX, 0, "rtos0",
  623. &s_rtos_lock_handle[0]));
  624. ESP_ERROR_CHECK(esp_pm_lock_acquire(s_rtos_lock_handle[0]));
  625. #if portNUM_PROCESSORS == 2
  626. ESP_ERROR_CHECK(esp_pm_lock_create(ESP_PM_CPU_FREQ_MAX, 0, "rtos1",
  627. &s_rtos_lock_handle[1]));
  628. ESP_ERROR_CHECK(esp_pm_lock_acquire(s_rtos_lock_handle[1]));
  629. #endif // portNUM_PROCESSORS == 2
  630. /* Configure all modes to use the default CPU frequency.
  631. * This will be modified later by a call to esp_pm_configure.
  632. */
  633. rtc_cpu_freq_config_t default_config;
  634. if (!rtc_clk_cpu_freq_mhz_to_config(DEFAULT_CPU_FREQ, &default_config)) {
  635. assert(false && "unsupported frequency");
  636. }
  637. for (size_t i = 0; i < PM_MODE_COUNT; ++i) {
  638. s_cpu_freq_by_mode[i] = default_config;
  639. }
  640. #ifdef CONFIG_PM_DFS_INIT_AUTO
  641. int xtal_freq = (int) rtc_clk_xtal_freq_get();
  642. #if CONFIG_IDF_TARGET_ESP32
  643. esp_pm_config_esp32_t cfg = {
  644. #elif CONFIG_IDF_TARGET_ESP32S2
  645. esp_pm_config_esp32s2_t cfg = {
  646. #elif CONFIG_IDF_TARGET_ESP32S3
  647. esp_pm_config_esp32s3_t cfg = {
  648. #endif
  649. .max_freq_mhz = DEFAULT_CPU_FREQ,
  650. .min_freq_mhz = xtal_freq,
  651. };
  652. esp_pm_configure(&cfg);
  653. #endif //CONFIG_PM_DFS_INIT_AUTO
  654. }