pm_impl.c 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846
  1. /*
  2. * SPDX-FileCopyrightText: 2016-2023 Espressif Systems (Shanghai) CO LTD
  3. *
  4. * SPDX-License-Identifier: Apache-2.0
  5. */
  6. #include <stdlib.h>
  7. #include <stdbool.h>
  8. #include <string.h>
  9. #include <stdint.h>
  10. #include <sys/param.h>
  11. #include "esp_attr.h"
  12. #include "esp_err.h"
  13. #include "esp_pm.h"
  14. #include "esp_log.h"
  15. #include "esp_cpu.h"
  16. #include "esp_private/crosscore_int.h"
  17. #include "soc/rtc.h"
  18. #include "hal/uart_ll.h"
  19. #include "hal/uart_types.h"
  20. #include "driver/uart.h"
  21. #include "driver/gpio.h"
  22. #include "freertos/FreeRTOS.h"
  23. #include "freertos/task.h"
  24. #if CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
  25. #include "freertos/xtensa_timer.h"
  26. #include "xtensa/core-macros.h"
  27. #endif
  28. #if SOC_SPI_MEM_SUPPORT_TIMING_TUNING
  29. #include "esp_private/mspi_timing_tuning.h"
  30. #endif
  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_private/esp_clk.h"
  35. #include "esp_private/sleep_cpu.h"
  36. #include "esp_private/sleep_gpio.h"
  37. #include "esp_private/sleep_modem.h"
  38. #include "esp_sleep.h"
  39. #include "sdkconfig.h"
  40. #define MHZ (1000000)
  41. #ifdef CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
  42. /* CCOMPARE update timeout, in CPU cycles. Any value above ~600 cycles will work
  43. * for the purpose of detecting a deadlock.
  44. */
  45. #define CCOMPARE_UPDATE_TIMEOUT 1000000
  46. /* When changing CCOMPARE, don't allow changes if the difference is less
  47. * than this. This is to prevent setting CCOMPARE below CCOUNT.
  48. */
  49. #define CCOMPARE_MIN_CYCLES_IN_FUTURE 1000
  50. #endif // CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
  51. /* When light sleep is used, wake this number of microseconds earlier than
  52. * the next tick.
  53. */
  54. #define LIGHT_SLEEP_EARLY_WAKEUP_US 100
  55. #if CONFIG_IDF_TARGET_ESP32
  56. /* Minimal divider at which REF_CLK_FREQ can be obtained */
  57. #define REF_CLK_DIV_MIN 10
  58. #elif CONFIG_IDF_TARGET_ESP32S2
  59. /* Minimal divider at which REF_CLK_FREQ can be obtained */
  60. #define REF_CLK_DIV_MIN 2
  61. #elif CONFIG_IDF_TARGET_ESP32S3
  62. /* Minimal divider at which REF_CLK_FREQ can be obtained */
  63. #define REF_CLK_DIV_MIN 2 // TODO: IDF-5660
  64. #elif CONFIG_IDF_TARGET_ESP32C3
  65. #define REF_CLK_DIV_MIN 2
  66. #elif CONFIG_IDF_TARGET_ESP32C2
  67. #define REF_CLK_DIV_MIN 2
  68. #elif CONFIG_IDF_TARGET_ESP32C6
  69. #define REF_CLK_DIV_MIN 2
  70. #elif CONFIG_IDF_TARGET_ESP32H2
  71. #define REF_CLK_DIV_MIN 2
  72. #elif CONFIG_IDF_TARGET_ESP32P4
  73. #define REF_CLK_DIV_MIN 2
  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. /* Number of times each mode was locked */
  85. static size_t s_mode_lock_counts[PM_MODE_COUNT];
  86. /* Bit mask of locked modes. BIT(i) is set iff s_mode_lock_counts[i] > 0. */
  87. static uint32_t s_mode_mask;
  88. #if CONFIG_FREERTOS_USE_TICKLESS_IDLE
  89. #define PERIPH_SKIP_LIGHT_SLEEP_NO 2
  90. /* Indicates if light sleep shoule be skipped by peripherals. */
  91. static skip_light_sleep_cb_t s_periph_skip_light_sleep_cb[PERIPH_SKIP_LIGHT_SLEEP_NO];
  92. /* Indicates if light sleep entry was skipped in vApplicationSleep for given CPU.
  93. * This in turn gets used in IDLE hook to decide if `waiti` needs
  94. * to be invoked or not.
  95. */
  96. static bool s_skipped_light_sleep[portNUM_PROCESSORS];
  97. #if portNUM_PROCESSORS == 2
  98. /* When light sleep is finished on one CPU, it is possible that the other CPU
  99. * will enter light sleep again very soon, before interrupts on the first CPU
  100. * get a chance to run. To avoid such situation, set a flag for the other CPU to
  101. * skip light sleep attempt.
  102. */
  103. static bool s_skip_light_sleep[portNUM_PROCESSORS];
  104. #endif // portNUM_PROCESSORS == 2
  105. #endif // CONFIG_FREERTOS_USE_TICKLESS_IDLE
  106. /* A flag indicating that Idle hook has run on a given CPU;
  107. * Next interrupt on the same CPU will take s_rtos_lock_handle.
  108. */
  109. static bool s_core_idle[portNUM_PROCESSORS];
  110. /* When no RTOS tasks are active, these locks are released to allow going into
  111. * a lower power mode. Used by ISR hook and idle hook.
  112. */
  113. static esp_pm_lock_handle_t s_rtos_lock_handle[portNUM_PROCESSORS];
  114. /* Lookup table of CPU frequency configs to be used in each mode.
  115. * Initialized by esp_pm_impl_init and modified by esp_pm_configure.
  116. */
  117. static rtc_cpu_freq_config_t s_cpu_freq_by_mode[PM_MODE_COUNT];
  118. /* Whether automatic light sleep is enabled */
  119. static bool s_light_sleep_en = false;
  120. /* When configuration is changed, current frequency may not match the
  121. * newly configured frequency for the current mode. This is an indicator
  122. * to the mode switch code to get the actual current frequency instead of
  123. * relying on the current mode.
  124. */
  125. static bool s_config_changed = false;
  126. #ifdef WITH_PROFILING
  127. /* Time, in microseconds, spent so far in each mode */
  128. static pm_time_t s_time_in_mode[PM_MODE_COUNT];
  129. /* Timestamp, in microseconds, when the mode switch last happened */
  130. static pm_time_t s_last_mode_change_time;
  131. /* User-readable mode names, used by esp_pm_impl_dump_stats */
  132. static const char* s_mode_names[] = {
  133. "SLEEP",
  134. "APB_MIN",
  135. "APB_MAX",
  136. "CPU_MAX"
  137. };
  138. static uint32_t s_light_sleep_counts, s_light_sleep_reject_counts;
  139. #endif // WITH_PROFILING
  140. #ifdef CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
  141. /* Indicates to the ISR hook that CCOMPARE needs to be updated on the given CPU.
  142. * Used in conjunction with cross-core interrupt to update CCOMPARE on the other CPU.
  143. */
  144. static volatile bool s_need_update_ccompare[portNUM_PROCESSORS];
  145. /* Divider and multiplier used to adjust (ccompare - ccount) duration.
  146. * Only set to non-zero values when switch is in progress.
  147. */
  148. static uint32_t s_ccount_div;
  149. static uint32_t s_ccount_mul;
  150. static void update_ccompare(void);
  151. #endif // CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
  152. static const char* TAG = "pm";
  153. static void do_switch(pm_mode_t new_mode);
  154. static void leave_idle(void);
  155. static void on_freq_update(uint32_t old_ticks_per_us, uint32_t ticks_per_us);
  156. pm_mode_t esp_pm_impl_get_mode(esp_pm_lock_type_t type, int arg)
  157. {
  158. (void) arg;
  159. if (type == ESP_PM_CPU_FREQ_MAX) {
  160. return PM_MODE_CPU_MAX;
  161. } else if (type == ESP_PM_APB_FREQ_MAX) {
  162. return PM_MODE_APB_MAX;
  163. } else if (type == ESP_PM_NO_LIGHT_SLEEP) {
  164. return PM_MODE_APB_MIN;
  165. } else {
  166. // unsupported mode
  167. abort();
  168. }
  169. }
  170. static esp_err_t esp_pm_sleep_configure(const void *vconfig)
  171. {
  172. esp_err_t err = ESP_OK;
  173. const esp_pm_config_t* config = (const esp_pm_config_t*) vconfig;
  174. #if SOC_PM_SUPPORT_CPU_PD
  175. err = sleep_cpu_configure(config->light_sleep_enable);
  176. if (err != ESP_OK) {
  177. return err;
  178. }
  179. #endif
  180. err = sleep_modem_configure(config->max_freq_mhz, config->min_freq_mhz, config->light_sleep_enable);
  181. return err;
  182. }
  183. esp_err_t esp_pm_configure(const void* vconfig)
  184. {
  185. #ifndef CONFIG_PM_ENABLE
  186. return ESP_ERR_NOT_SUPPORTED;
  187. #endif
  188. const esp_pm_config_t* config = (const esp_pm_config_t*) vconfig;
  189. #ifndef CONFIG_FREERTOS_USE_TICKLESS_IDLE
  190. if (config->light_sleep_enable) {
  191. return ESP_ERR_NOT_SUPPORTED;
  192. }
  193. #endif
  194. int min_freq_mhz = config->min_freq_mhz;
  195. int max_freq_mhz = config->max_freq_mhz;
  196. if (min_freq_mhz > max_freq_mhz) {
  197. return ESP_ERR_INVALID_ARG;
  198. }
  199. rtc_cpu_freq_config_t freq_config;
  200. if (!rtc_clk_cpu_freq_mhz_to_config(min_freq_mhz, &freq_config)) {
  201. ESP_LOGW(TAG, "invalid min_freq_mhz value (%d)", min_freq_mhz);
  202. return ESP_ERR_INVALID_ARG;
  203. }
  204. int xtal_freq_mhz = esp_clk_xtal_freq() / MHZ;
  205. if (min_freq_mhz < xtal_freq_mhz && min_freq_mhz * MHZ / REF_CLK_FREQ < REF_CLK_DIV_MIN) {
  206. ESP_LOGW(TAG, "min_freq_mhz should be >= %d", REF_CLK_FREQ * REF_CLK_DIV_MIN / MHZ);
  207. return ESP_ERR_INVALID_ARG;
  208. }
  209. if (!rtc_clk_cpu_freq_mhz_to_config(max_freq_mhz, &freq_config)) {
  210. ESP_LOGW(TAG, "invalid max_freq_mhz value (%d)", max_freq_mhz);
  211. return ESP_ERR_INVALID_ARG;
  212. }
  213. #if CONFIG_IDF_TARGET_ESP32
  214. int apb_max_freq = max_freq_mhz; /* CPU frequency in APB_MAX mode */
  215. if (max_freq_mhz == 240) {
  216. /* We can't switch between 240 and 80/160 without disabling PLL,
  217. * so use 240MHz CPU frequency when 80MHz APB frequency is requested.
  218. */
  219. apb_max_freq = 240;
  220. } else if (max_freq_mhz == 160 || max_freq_mhz == 80) {
  221. /* Otherwise, can use 80MHz
  222. * CPU frequency when 80MHz APB frequency is requested.
  223. */
  224. apb_max_freq = 80;
  225. }
  226. #else
  227. /* Maximum SOC APB clock frequency is 40 MHz, maximum Modem (WiFi,
  228. * Bluetooth, etc..) APB clock frequency is 80 MHz */
  229. int apb_clk_freq = esp_clk_apb_freq() / MHZ;
  230. #if CONFIG_ESP_WIFI_ENABLED || CONFIG_BT_ENABLED || CONFIG_IEEE802154_ENABLED
  231. apb_clk_freq = MAX(apb_clk_freq, MODEM_REQUIRED_MIN_APB_CLK_FREQ / MHZ);
  232. #endif
  233. int apb_max_freq = MIN(max_freq_mhz, apb_clk_freq); /* CPU frequency in APB_MAX mode */
  234. #endif
  235. apb_max_freq = MAX(apb_max_freq, min_freq_mhz);
  236. ESP_LOGI(TAG, "Frequency switching config: "
  237. "CPU_MAX: %d, APB_MAX: %d, APB_MIN: %d, Light sleep: %s",
  238. max_freq_mhz,
  239. apb_max_freq,
  240. min_freq_mhz,
  241. config->light_sleep_enable ? "ENABLED" : "DISABLED");
  242. portENTER_CRITICAL(&s_switch_lock);
  243. bool res __attribute__((unused));
  244. res = rtc_clk_cpu_freq_mhz_to_config(max_freq_mhz, &s_cpu_freq_by_mode[PM_MODE_CPU_MAX]);
  245. assert(res);
  246. res = rtc_clk_cpu_freq_mhz_to_config(apb_max_freq, &s_cpu_freq_by_mode[PM_MODE_APB_MAX]);
  247. assert(res);
  248. res = rtc_clk_cpu_freq_mhz_to_config(min_freq_mhz, &s_cpu_freq_by_mode[PM_MODE_APB_MIN]);
  249. assert(res);
  250. s_cpu_freq_by_mode[PM_MODE_LIGHT_SLEEP] = s_cpu_freq_by_mode[PM_MODE_APB_MIN];
  251. s_light_sleep_en = config->light_sleep_enable;
  252. s_config_changed = true;
  253. portEXIT_CRITICAL(&s_switch_lock);
  254. esp_pm_sleep_configure(config);
  255. return ESP_OK;
  256. }
  257. esp_err_t esp_pm_get_configuration(void* vconfig)
  258. {
  259. if (vconfig == NULL) {
  260. return ESP_ERR_INVALID_ARG;
  261. }
  262. esp_pm_config_t* config = (esp_pm_config_t*) vconfig;
  263. portENTER_CRITICAL(&s_switch_lock);
  264. config->light_sleep_enable = s_light_sleep_en;
  265. config->max_freq_mhz = s_cpu_freq_by_mode[PM_MODE_CPU_MAX].freq_mhz;
  266. config->min_freq_mhz = s_cpu_freq_by_mode[PM_MODE_APB_MIN].freq_mhz;
  267. portEXIT_CRITICAL(&s_switch_lock);
  268. return ESP_OK;
  269. }
  270. static pm_mode_t IRAM_ATTR get_lowest_allowed_mode(void)
  271. {
  272. /* TODO: optimize using ffs/clz */
  273. if (s_mode_mask >= BIT(PM_MODE_CPU_MAX)) {
  274. return PM_MODE_CPU_MAX;
  275. } else if (s_mode_mask >= BIT(PM_MODE_APB_MAX)) {
  276. return PM_MODE_APB_MAX;
  277. } else if (s_mode_mask >= BIT(PM_MODE_APB_MIN) || !s_light_sleep_en) {
  278. return PM_MODE_APB_MIN;
  279. } else {
  280. return PM_MODE_LIGHT_SLEEP;
  281. }
  282. }
  283. void IRAM_ATTR esp_pm_impl_switch_mode(pm_mode_t mode,
  284. pm_mode_switch_t lock_or_unlock, pm_time_t now)
  285. {
  286. bool need_switch = false;
  287. uint32_t mode_mask = BIT(mode);
  288. portENTER_CRITICAL_SAFE(&s_switch_lock);
  289. uint32_t count;
  290. if (lock_or_unlock == MODE_LOCK) {
  291. count = ++s_mode_lock_counts[mode];
  292. } else {
  293. count = s_mode_lock_counts[mode]--;
  294. }
  295. if (count == 1) {
  296. if (lock_or_unlock == MODE_LOCK) {
  297. s_mode_mask |= mode_mask;
  298. } else {
  299. s_mode_mask &= ~mode_mask;
  300. }
  301. need_switch = true;
  302. }
  303. pm_mode_t new_mode = s_mode;
  304. if (need_switch) {
  305. new_mode = get_lowest_allowed_mode();
  306. #ifdef WITH_PROFILING
  307. if (s_last_mode_change_time != 0) {
  308. pm_time_t diff = now - s_last_mode_change_time;
  309. s_time_in_mode[s_mode] += diff;
  310. }
  311. s_last_mode_change_time = now;
  312. #endif // WITH_PROFILING
  313. }
  314. portEXIT_CRITICAL_SAFE(&s_switch_lock);
  315. if (need_switch) {
  316. do_switch(new_mode);
  317. }
  318. }
  319. /**
  320. * @brief Update clock dividers in esp_timer and FreeRTOS, and adjust CCOMPARE
  321. * values on both CPUs.
  322. * @param old_ticks_per_us old CPU frequency
  323. * @param ticks_per_us new CPU frequency
  324. */
  325. static void IRAM_ATTR on_freq_update(uint32_t old_ticks_per_us, uint32_t ticks_per_us)
  326. {
  327. uint32_t old_apb_ticks_per_us = MIN(old_ticks_per_us, 80);
  328. uint32_t apb_ticks_per_us = MIN(ticks_per_us, 80);
  329. /* Update APB frequency value used by the timer */
  330. if (old_apb_ticks_per_us != apb_ticks_per_us) {
  331. esp_timer_private_update_apb_freq(apb_ticks_per_us);
  332. }
  333. #ifdef CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
  334. #ifdef XT_RTOS_TIMER_INT
  335. /* Calculate new tick divisor */
  336. _xt_tick_divisor = ticks_per_us * MHZ / XT_TICK_PER_SEC;
  337. #endif
  338. int core_id = xPortGetCoreID();
  339. if (s_rtos_lock_handle[core_id] != NULL) {
  340. ESP_PM_TRACE_ENTER(CCOMPARE_UPDATE, core_id);
  341. /* ccount_div and ccount_mul are used in esp_pm_impl_update_ccompare
  342. * to calculate new CCOMPARE value.
  343. */
  344. s_ccount_div = old_ticks_per_us;
  345. s_ccount_mul = ticks_per_us;
  346. /* Update CCOMPARE value on this CPU */
  347. update_ccompare();
  348. #if portNUM_PROCESSORS == 2
  349. /* Send interrupt to the other CPU to update CCOMPARE value */
  350. int other_core_id = (core_id == 0) ? 1 : 0;
  351. s_need_update_ccompare[other_core_id] = true;
  352. esp_crosscore_int_send_freq_switch(other_core_id);
  353. int timeout = 0;
  354. while (s_need_update_ccompare[other_core_id]) {
  355. if (++timeout == CCOMPARE_UPDATE_TIMEOUT) {
  356. assert(false && "failed to update CCOMPARE, possible deadlock");
  357. }
  358. }
  359. #endif // portNUM_PROCESSORS == 2
  360. s_ccount_mul = 0;
  361. s_ccount_div = 0;
  362. ESP_PM_TRACE_EXIT(CCOMPARE_UPDATE, core_id);
  363. }
  364. #endif // CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
  365. }
  366. /**
  367. * Perform the switch to new power mode.
  368. * Currently only changes the CPU frequency and adjusts clock dividers.
  369. * No light sleep yet.
  370. * @param new_mode mode to switch to
  371. */
  372. static void IRAM_ATTR do_switch(pm_mode_t new_mode)
  373. {
  374. const int core_id = xPortGetCoreID();
  375. do {
  376. portENTER_CRITICAL_ISR(&s_switch_lock);
  377. if (!s_is_switching) {
  378. break;
  379. }
  380. #ifdef CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
  381. if (s_need_update_ccompare[core_id]) {
  382. s_need_update_ccompare[core_id] = false;
  383. }
  384. #endif
  385. portEXIT_CRITICAL_ISR(&s_switch_lock);
  386. } while (true);
  387. if (new_mode == s_mode) {
  388. portEXIT_CRITICAL_ISR(&s_switch_lock);
  389. return;
  390. }
  391. s_is_switching = true;
  392. bool config_changed = s_config_changed;
  393. s_config_changed = false;
  394. portEXIT_CRITICAL_ISR(&s_switch_lock);
  395. rtc_cpu_freq_config_t new_config = s_cpu_freq_by_mode[new_mode];
  396. rtc_cpu_freq_config_t old_config;
  397. if (!config_changed) {
  398. old_config = s_cpu_freq_by_mode[s_mode];
  399. } else {
  400. rtc_clk_cpu_freq_get_config(&old_config);
  401. }
  402. if (new_config.freq_mhz != old_config.freq_mhz) {
  403. uint32_t old_ticks_per_us = old_config.freq_mhz;
  404. uint32_t new_ticks_per_us = new_config.freq_mhz;
  405. bool switch_down = new_ticks_per_us < old_ticks_per_us;
  406. ESP_PM_TRACE_ENTER(FREQ_SWITCH, core_id);
  407. if (switch_down) {
  408. on_freq_update(old_ticks_per_us, new_ticks_per_us);
  409. }
  410. if (new_config.source == SOC_CPU_CLK_SRC_PLL) {
  411. rtc_clk_cpu_freq_set_config_fast(&new_config);
  412. #if SOC_SPI_MEM_SUPPORT_TIMING_TUNING
  413. mspi_timing_change_speed_mode_cache_safe(false);
  414. #endif
  415. } else {
  416. #if SOC_SPI_MEM_SUPPORT_TIMING_TUNING
  417. mspi_timing_change_speed_mode_cache_safe(true);
  418. #endif
  419. rtc_clk_cpu_freq_set_config_fast(&new_config);
  420. }
  421. if (!switch_down) {
  422. on_freq_update(old_ticks_per_us, new_ticks_per_us);
  423. }
  424. ESP_PM_TRACE_EXIT(FREQ_SWITCH, core_id);
  425. }
  426. portENTER_CRITICAL_ISR(&s_switch_lock);
  427. s_mode = new_mode;
  428. s_is_switching = false;
  429. portEXIT_CRITICAL_ISR(&s_switch_lock);
  430. }
  431. #ifdef CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
  432. /**
  433. * @brief Calculate new CCOMPARE value based on s_ccount_{mul,div}
  434. *
  435. * Adjusts CCOMPARE value so that the interrupt happens at the same time as it
  436. * would happen without the frequency change.
  437. * Assumes that the new_frequency = old_frequency * s_ccount_mul / s_ccount_div.
  438. */
  439. static void IRAM_ATTR update_ccompare(void)
  440. {
  441. #if CONFIG_PM_UPDATE_CCOMPARE_HLI_WORKAROUND
  442. /* disable level 4 and below */
  443. uint32_t irq_status = XTOS_SET_INTLEVEL(XCHAL_DEBUGLEVEL - 2);
  444. #endif
  445. uint32_t ccount = esp_cpu_get_cycle_count();
  446. uint32_t ccompare = XTHAL_GET_CCOMPARE(XT_TIMER_INDEX);
  447. if ((ccompare - CCOMPARE_MIN_CYCLES_IN_FUTURE) - ccount < UINT32_MAX / 2) {
  448. uint32_t diff = ccompare - ccount;
  449. uint32_t diff_scaled = (diff * s_ccount_mul + s_ccount_div - 1) / s_ccount_div;
  450. if (diff_scaled < _xt_tick_divisor) {
  451. uint32_t new_ccompare = ccount + diff_scaled;
  452. XTHAL_SET_CCOMPARE(XT_TIMER_INDEX, new_ccompare);
  453. }
  454. }
  455. #if CONFIG_PM_UPDATE_CCOMPARE_HLI_WORKAROUND
  456. XTOS_RESTORE_INTLEVEL(irq_status);
  457. #endif
  458. }
  459. #endif // CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
  460. static void IRAM_ATTR leave_idle(void)
  461. {
  462. int core_id = xPortGetCoreID();
  463. if (s_core_idle[core_id]) {
  464. // TODO: possible optimization: raise frequency here first
  465. esp_pm_lock_acquire(s_rtos_lock_handle[core_id]);
  466. s_core_idle[core_id] = false;
  467. }
  468. }
  469. #if CONFIG_FREERTOS_USE_TICKLESS_IDLE
  470. esp_err_t esp_pm_register_skip_light_sleep_callback(skip_light_sleep_cb_t cb)
  471. {
  472. for (int i = 0; i < PERIPH_SKIP_LIGHT_SLEEP_NO; i++) {
  473. if (s_periph_skip_light_sleep_cb[i] == cb) {
  474. return ESP_OK;
  475. } else if (s_periph_skip_light_sleep_cb[i] == NULL) {
  476. s_periph_skip_light_sleep_cb[i] = cb;
  477. return ESP_OK;
  478. }
  479. }
  480. return ESP_ERR_NO_MEM;
  481. }
  482. esp_err_t esp_pm_unregister_skip_light_sleep_callback(skip_light_sleep_cb_t cb)
  483. {
  484. for (int i = 0; i < PERIPH_SKIP_LIGHT_SLEEP_NO; i++) {
  485. if (s_periph_skip_light_sleep_cb[i] == cb) {
  486. s_periph_skip_light_sleep_cb[i] = NULL;
  487. return ESP_OK;
  488. }
  489. }
  490. return ESP_ERR_INVALID_STATE;
  491. }
  492. static inline bool IRAM_ATTR periph_should_skip_light_sleep(void)
  493. {
  494. if (s_light_sleep_en) {
  495. for (int i = 0; i < PERIPH_SKIP_LIGHT_SLEEP_NO; i++) {
  496. if (s_periph_skip_light_sleep_cb[i]) {
  497. if (s_periph_skip_light_sleep_cb[i]() == true) {
  498. return true;
  499. }
  500. }
  501. }
  502. }
  503. return false;
  504. }
  505. static inline bool IRAM_ATTR should_skip_light_sleep(int core_id)
  506. {
  507. #if portNUM_PROCESSORS == 2
  508. if (s_skip_light_sleep[core_id]) {
  509. s_skip_light_sleep[core_id] = false;
  510. s_skipped_light_sleep[core_id] = true;
  511. return true;
  512. }
  513. #endif // portNUM_PROCESSORS == 2
  514. if (s_mode != PM_MODE_LIGHT_SLEEP || s_is_switching || periph_should_skip_light_sleep()) {
  515. s_skipped_light_sleep[core_id] = true;
  516. } else {
  517. s_skipped_light_sleep[core_id] = false;
  518. }
  519. return s_skipped_light_sleep[core_id];
  520. }
  521. static inline void IRAM_ATTR other_core_should_skip_light_sleep(int core_id)
  522. {
  523. #if portNUM_PROCESSORS == 2
  524. s_skip_light_sleep[!core_id] = true;
  525. #endif
  526. }
  527. void IRAM_ATTR vApplicationSleep( TickType_t xExpectedIdleTime )
  528. {
  529. portENTER_CRITICAL(&s_switch_lock);
  530. int core_id = xPortGetCoreID();
  531. if (!should_skip_light_sleep(core_id)) {
  532. /* Calculate how much we can sleep */
  533. int64_t next_esp_timer_alarm = esp_timer_get_next_alarm_for_wake_up();
  534. int64_t now = esp_timer_get_time();
  535. int64_t time_until_next_alarm = next_esp_timer_alarm - now;
  536. int64_t wakeup_delay_us = portTICK_PERIOD_MS * 1000LL * xExpectedIdleTime;
  537. int64_t sleep_time_us = MIN(wakeup_delay_us, time_until_next_alarm);
  538. if (sleep_time_us >= configEXPECTED_IDLE_TIME_BEFORE_SLEEP * portTICK_PERIOD_MS * 1000LL) {
  539. esp_sleep_enable_timer_wakeup(sleep_time_us - LIGHT_SLEEP_EARLY_WAKEUP_US);
  540. #if CONFIG_PM_TRACE && SOC_PM_SUPPORT_RTC_PERIPH_PD
  541. /* to force tracing GPIOs to keep state */
  542. esp_sleep_pd_config(ESP_PD_DOMAIN_RTC_PERIPH, ESP_PD_OPTION_ON);
  543. #endif
  544. /* Enter sleep */
  545. ESP_PM_TRACE_ENTER(SLEEP, core_id);
  546. int64_t sleep_start = esp_timer_get_time();
  547. if (esp_light_sleep_start() != ESP_OK){
  548. #ifdef WITH_PROFILING
  549. s_light_sleep_reject_counts++;
  550. } else {
  551. s_light_sleep_counts++;
  552. #endif
  553. }
  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. #ifdef CONFIG_FREERTOS_SYSTICK_USES_CCOUNT
  561. /* Trigger tick interrupt, since sleep time was longer
  562. * than portTICK_PERIOD_MS. Note that setting INTSET does not
  563. * work for timer interrupt, and changing CCOMPARE would clear
  564. * the interrupt flag.
  565. */
  566. esp_cpu_set_cycle_count(XTHAL_GET_CCOMPARE(XT_TIMER_INDEX) - 16);
  567. while (!(XTHAL_GET_INTERRUPT() & BIT(XT_TIMER_INTNUM))) {
  568. ;
  569. }
  570. #else
  571. portYIELD_WITHIN_API();
  572. #endif
  573. }
  574. other_core_should_skip_light_sleep(core_id);
  575. }
  576. }
  577. portEXIT_CRITICAL(&s_switch_lock);
  578. }
  579. #endif //CONFIG_FREERTOS_USE_TICKLESS_IDLE
  580. #ifdef WITH_PROFILING
  581. void esp_pm_impl_dump_stats(FILE* out)
  582. {
  583. pm_time_t time_in_mode[PM_MODE_COUNT];
  584. portENTER_CRITICAL_ISR(&s_switch_lock);
  585. memcpy(time_in_mode, s_time_in_mode, sizeof(time_in_mode));
  586. pm_time_t last_mode_change_time = s_last_mode_change_time;
  587. pm_mode_t cur_mode = s_mode;
  588. pm_time_t now = pm_get_time();
  589. bool light_sleep_en = s_light_sleep_en;
  590. uint32_t light_sleep_counts = s_light_sleep_counts;
  591. uint32_t light_sleep_reject_counts = s_light_sleep_reject_counts;
  592. portEXIT_CRITICAL_ISR(&s_switch_lock);
  593. time_in_mode[cur_mode] += now - last_mode_change_time;
  594. fprintf(out, "\nMode stats:\n");
  595. fprintf(out, "%-8s %-10s %-10s %-10s\n", "Mode", "CPU_freq", "Time(us)", "Time(%)");
  596. for (int i = 0; i < PM_MODE_COUNT; ++i) {
  597. if (i == PM_MODE_LIGHT_SLEEP && !light_sleep_en) {
  598. /* don't display light sleep mode if it's not enabled */
  599. continue;
  600. }
  601. fprintf(out, "%-8s %-3"PRIu32"M%-7s %-10lld %-2d%%\n",
  602. s_mode_names[i],
  603. s_cpu_freq_by_mode[i].freq_mhz,
  604. "", //Empty space to align columns
  605. time_in_mode[i],
  606. (int) (time_in_mode[i] * 100 / now));
  607. }
  608. if (light_sleep_en){
  609. fprintf(out, "\nSleep stats:\n");
  610. fprintf(out, "light_sleep_counts:%ld light_sleep_reject_counts:%ld\n", light_sleep_counts, light_sleep_reject_counts);
  611. }
  612. }
  613. #endif // WITH_PROFILING
  614. int esp_pm_impl_get_cpu_freq(pm_mode_t mode)
  615. {
  616. int freq_mhz;
  617. if (mode >= PM_MODE_LIGHT_SLEEP && mode < PM_MODE_COUNT) {
  618. portENTER_CRITICAL(&s_switch_lock);
  619. freq_mhz = s_cpu_freq_by_mode[mode].freq_mhz;
  620. portEXIT_CRITICAL(&s_switch_lock);
  621. } else {
  622. abort();
  623. }
  624. return freq_mhz;
  625. }
  626. void esp_pm_impl_init(void)
  627. {
  628. #if defined(CONFIG_ESP_CONSOLE_UART)
  629. //This clock source should be a source which won't be affected by DFS
  630. uart_sclk_t clk_source = UART_SCLK_DEFAULT;
  631. #if SOC_UART_SUPPORT_REF_TICK
  632. clk_source = UART_SCLK_REF_TICK;
  633. #elif SOC_UART_SUPPORT_XTAL_CLK
  634. clk_source = UART_SCLK_XTAL;
  635. #else
  636. #error "No UART clock source is aware of DFS"
  637. #endif // SOC_UART_SUPPORT_xxx
  638. while(!uart_ll_is_tx_idle(UART_LL_GET_HW(CONFIG_ESP_CONSOLE_UART_NUM)));
  639. /* When DFS is enabled, override system setting and use REFTICK as UART clock source */
  640. uart_ll_set_sclk(UART_LL_GET_HW(CONFIG_ESP_CONSOLE_UART_NUM), (soc_module_clk_t)clk_source);
  641. uint32_t sclk_freq;
  642. esp_err_t err = uart_get_sclk_freq(clk_source, &sclk_freq);
  643. assert(err == ESP_OK);
  644. uart_ll_set_baudrate(UART_LL_GET_HW(CONFIG_ESP_CONSOLE_UART_NUM), CONFIG_ESP_CONSOLE_UART_BAUDRATE, sclk_freq);
  645. #endif // CONFIG_ESP_CONSOLE_UART
  646. #ifdef CONFIG_PM_TRACE
  647. esp_pm_trace_init();
  648. #endif
  649. ESP_ERROR_CHECK(esp_pm_lock_create(ESP_PM_CPU_FREQ_MAX, 0, "rtos0",
  650. &s_rtos_lock_handle[0]));
  651. ESP_ERROR_CHECK(esp_pm_lock_acquire(s_rtos_lock_handle[0]));
  652. #if portNUM_PROCESSORS == 2
  653. ESP_ERROR_CHECK(esp_pm_lock_create(ESP_PM_CPU_FREQ_MAX, 0, "rtos1",
  654. &s_rtos_lock_handle[1]));
  655. ESP_ERROR_CHECK(esp_pm_lock_acquire(s_rtos_lock_handle[1]));
  656. #endif // portNUM_PROCESSORS == 2
  657. /* Configure all modes to use the default CPU frequency.
  658. * This will be modified later by a call to esp_pm_configure.
  659. */
  660. rtc_cpu_freq_config_t default_config;
  661. if (!rtc_clk_cpu_freq_mhz_to_config(CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ, &default_config)) {
  662. assert(false && "unsupported frequency");
  663. }
  664. for (size_t i = 0; i < PM_MODE_COUNT; ++i) {
  665. s_cpu_freq_by_mode[i] = default_config;
  666. }
  667. #ifdef CONFIG_PM_DFS_INIT_AUTO
  668. int xtal_freq_mhz = esp_clk_xtal_freq() / MHZ;
  669. esp_pm_config_t cfg = {
  670. .max_freq_mhz = CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ,
  671. .min_freq_mhz = xtal_freq_mhz,
  672. };
  673. esp_pm_configure(&cfg);
  674. #endif //CONFIG_PM_DFS_INIT_AUTO
  675. }
  676. void esp_pm_impl_idle_hook(void)
  677. {
  678. int core_id = xPortGetCoreID();
  679. #if CONFIG_FREERTOS_SMP
  680. uint32_t state = portDISABLE_INTERRUPTS();
  681. #else
  682. uint32_t state = portSET_INTERRUPT_MASK_FROM_ISR();
  683. #endif
  684. if (!s_core_idle[core_id]
  685. #ifdef CONFIG_FREERTOS_USE_TICKLESS_IDLE
  686. && !periph_should_skip_light_sleep()
  687. #endif
  688. ) {
  689. esp_pm_lock_release(s_rtos_lock_handle[core_id]);
  690. s_core_idle[core_id] = true;
  691. }
  692. #if CONFIG_FREERTOS_SMP
  693. portRESTORE_INTERRUPTS(state);
  694. #else
  695. portCLEAR_INTERRUPT_MASK_FROM_ISR(state);
  696. #endif
  697. ESP_PM_TRACE_ENTER(IDLE, core_id);
  698. }
  699. void IRAM_ATTR esp_pm_impl_isr_hook(void)
  700. {
  701. int core_id = xPortGetCoreID();
  702. ESP_PM_TRACE_ENTER(ISR_HOOK, core_id);
  703. /* Prevent higher level interrupts (than the one this function was called from)
  704. * from happening in this section, since they will also call into esp_pm_impl_isr_hook.
  705. */
  706. #if CONFIG_FREERTOS_SMP
  707. uint32_t state = portDISABLE_INTERRUPTS();
  708. #else
  709. uint32_t state = portSET_INTERRUPT_MASK_FROM_ISR();
  710. #endif
  711. #if defined(CONFIG_FREERTOS_SYSTICK_USES_CCOUNT) && (portNUM_PROCESSORS == 2)
  712. if (s_need_update_ccompare[core_id]) {
  713. update_ccompare();
  714. s_need_update_ccompare[core_id] = false;
  715. } else {
  716. leave_idle();
  717. }
  718. #else
  719. leave_idle();
  720. #endif // CONFIG_FREERTOS_SYSTICK_USES_CCOUNT && portNUM_PROCESSORS == 2
  721. #if CONFIG_FREERTOS_SMP
  722. portRESTORE_INTERRUPTS(state);
  723. #else
  724. portCLEAR_INTERRUPT_MASK_FROM_ISR(state);
  725. #endif
  726. ESP_PM_TRACE_EXIT(ISR_HOOK, core_id);
  727. }
  728. void esp_pm_impl_waiti(void)
  729. {
  730. #if CONFIG_FREERTOS_USE_TICKLESS_IDLE
  731. int core_id = xPortGetCoreID();
  732. if (s_skipped_light_sleep[core_id]) {
  733. esp_cpu_wait_for_intr();
  734. /* Interrupt took the CPU out of waiti and s_rtos_lock_handle[core_id]
  735. * is now taken. However since we are back to idle task, we can release
  736. * the lock so that vApplicationSleep can attempt to enter light sleep.
  737. */
  738. esp_pm_impl_idle_hook();
  739. }
  740. s_skipped_light_sleep[core_id] = true;
  741. #else
  742. esp_cpu_wait_for_intr();
  743. #endif // CONFIG_FREERTOS_USE_TICKLESS_IDLE
  744. }