From 5e81eb6cf7d26ed9693138db74e2faae214c58ea Mon Sep 17 00:00:00 2001 From: wuzhenghui Date: Fri, 7 Feb 2025 14:30:40 +0800 Subject: [PATCH] fix(esp_hw_support): add timer wakeup sleep duration check Closes https://github.com/espressif/esp-idf/issues/15255 --- components/esp_hw_support/include/esp_sleep.h | 8 ++++++-- components/esp_hw_support/port/esp32/rtc_time.c | 8 ++++---- components/esp_hw_support/port/esp32c2/rtc_time.c | 8 ++++---- components/esp_hw_support/port/esp32c3/rtc_time.c | 8 ++++---- components/esp_hw_support/port/esp32c6/rtc_time.c | 8 ++++---- components/esp_hw_support/port/esp32h2/rtc_time.c | 8 ++++---- components/esp_hw_support/port/esp32p4/rtc_time.c | 8 ++++---- components/esp_hw_support/port/esp32s2/rtc_time.c | 8 ++++---- components/esp_hw_support/port/esp32s3/rtc_time.c | 8 ++++---- components/esp_hw_support/sleep_modes.c | 5 +++++ .../test_apps/esp_system_unity_tests/main/test_sleep.c | 6 ++++++ components/soc/esp32/include/soc/Kconfig.soc_caps.in | 8 ++++++++ components/soc/esp32/include/soc/soc_caps.h | 4 ++++ components/soc/esp32c2/include/soc/Kconfig.soc_caps.in | 8 ++++++++ components/soc/esp32c2/include/soc/soc_caps.h | 4 ++++ components/soc/esp32c3/include/soc/Kconfig.soc_caps.in | 8 ++++++++ components/soc/esp32c3/include/soc/soc_caps.h | 4 ++++ components/soc/esp32s2/include/soc/Kconfig.soc_caps.in | 8 ++++++++ components/soc/esp32s2/include/soc/soc_caps.h | 4 ++++ components/soc/esp32s3/include/soc/Kconfig.soc_caps.in | 8 ++++++++ components/soc/esp32s3/include/soc/soc_caps.h | 4 ++++ 21 files changed, 109 insertions(+), 34 deletions(-) diff --git a/components/esp_hw_support/include/esp_sleep.h b/components/esp_hw_support/include/esp_sleep.h index 079f41c33a..63d20c9a2d 100644 --- a/components/esp_hw_support/include/esp_sleep.h +++ b/components/esp_hw_support/include/esp_sleep.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -168,9 +168,13 @@ esp_err_t esp_sleep_enable_ulp_wakeup(void); /** * @brief Enable wakeup by timer * @param time_in_us time before wakeup, in microseconds + * @note The valid `time_in_us` value depends on the bit width of the lp_timer/rtc_timer counter and the + * current slow clock source selection (Refer RTC clock source configuration in menuconfig). + * Valid values should be positive values less than RTC slow clock period * (2 ^ RTC timer bitwidth). + * * @return * - ESP_OK on success - * - ESP_ERR_INVALID_ARG if value is out of range (TBD) + * - ESP_ERR_INVALID_ARG if value is out of range. */ esp_err_t esp_sleep_enable_timer_wakeup(uint64_t time_in_us); diff --git a/components/esp_hw_support/port/esp32/rtc_time.c b/components/esp_hw_support/port/esp32/rtc_time.c index 227aed8a95..528aa549ad 100644 --- a/components/esp_hw_support/port/esp32/rtc_time.c +++ b/components/esp_hw_support/port/esp32/rtc_time.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -145,9 +145,9 @@ uint32_t rtc_clk_cal(rtc_cal_sel_t cal_clk, uint32_t slowclk_cycles) uint64_t rtc_time_us_to_slowclk(uint64_t time_in_us, uint32_t period) { assert(period); - /* Overflow will happen in this function if time_in_us >= 2^45, which is about 400 days. - * TODO: fix overflow. - */ + if (time_in_us > (UINT64_MAX >> RTC_CLK_CAL_FRACT)) { + return ((time_in_us / period) << RTC_CLK_CAL_FRACT) + ((time_in_us % period) << RTC_CLK_CAL_FRACT) / period; + } return (time_in_us << RTC_CLK_CAL_FRACT) / period; } diff --git a/components/esp_hw_support/port/esp32c2/rtc_time.c b/components/esp_hw_support/port/esp32c2/rtc_time.c index 26332a12c2..acae81a813 100644 --- a/components/esp_hw_support/port/esp32c2/rtc_time.c +++ b/components/esp_hw_support/port/esp32c2/rtc_time.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2020-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2020-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -159,9 +159,9 @@ uint32_t rtc_clk_cal(rtc_cal_sel_t cal_clk, uint32_t slowclk_cycles) uint64_t rtc_time_us_to_slowclk(uint64_t time_in_us, uint32_t period) { assert(period); - /* Overflow will happen in this function if time_in_us >= 2^45, which is about 400 days. - * TODO: fix overflow. - */ + if (time_in_us > (UINT64_MAX >> RTC_CLK_CAL_FRACT)) { + return ((time_in_us / period) << RTC_CLK_CAL_FRACT) + ((time_in_us % period) << RTC_CLK_CAL_FRACT) / period; + } return (time_in_us << RTC_CLK_CAL_FRACT) / period; } diff --git a/components/esp_hw_support/port/esp32c3/rtc_time.c b/components/esp_hw_support/port/esp32c3/rtc_time.c index b002ea1a7d..d31209b0c9 100644 --- a/components/esp_hw_support/port/esp32c3/rtc_time.c +++ b/components/esp_hw_support/port/esp32c3/rtc_time.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2020-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2020-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -162,9 +162,9 @@ uint32_t rtc_clk_cal(rtc_cal_sel_t cal_clk, uint32_t slowclk_cycles) uint64_t rtc_time_us_to_slowclk(uint64_t time_in_us, uint32_t period) { assert(period); - /* Overflow will happen in this function if time_in_us >= 2^45, which is about 400 days. - * TODO: fix overflow. - */ + if (time_in_us > (UINT64_MAX >> RTC_CLK_CAL_FRACT)) { + return ((time_in_us / period) << RTC_CLK_CAL_FRACT) + ((time_in_us % period) << RTC_CLK_CAL_FRACT) / period; + } return (time_in_us << RTC_CLK_CAL_FRACT) / period; } diff --git a/components/esp_hw_support/port/esp32c6/rtc_time.c b/components/esp_hw_support/port/esp32c6/rtc_time.c index 53aaed511c..b215e0f948 100644 --- a/components/esp_hw_support/port/esp32c6/rtc_time.c +++ b/components/esp_hw_support/port/esp32c6/rtc_time.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -237,9 +237,9 @@ uint32_t rtc_clk_cal(rtc_cal_sel_t cal_clk, uint32_t slowclk_cycles) uint64_t rtc_time_us_to_slowclk(uint64_t time_in_us, uint32_t period) { assert(period); - /* Overflow will happen in this function if time_in_us >= 2^45, which is about 400 days. - * TODO: fix overflow. - */ + if (time_in_us > (UINT64_MAX >> RTC_CLK_CAL_FRACT)) { + return ((time_in_us / period) << RTC_CLK_CAL_FRACT) + ((time_in_us % period) << RTC_CLK_CAL_FRACT) / period; + } return (time_in_us << RTC_CLK_CAL_FRACT) / period; } diff --git a/components/esp_hw_support/port/esp32h2/rtc_time.c b/components/esp_hw_support/port/esp32h2/rtc_time.c index 58816b1b02..306fe4e307 100644 --- a/components/esp_hw_support/port/esp32h2/rtc_time.c +++ b/components/esp_hw_support/port/esp32h2/rtc_time.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -236,9 +236,9 @@ uint32_t rtc_clk_cal(rtc_cal_sel_t cal_clk, uint32_t slowclk_cycles) uint64_t rtc_time_us_to_slowclk(uint64_t time_in_us, uint32_t period) { assert(period); - /* Overflow will happen in this function if time_in_us >= 2^45, which is about 400 days. - * TODO: fix overflow. - */ + if (time_in_us > (UINT64_MAX >> RTC_CLK_CAL_FRACT)) { + return ((time_in_us / period) << RTC_CLK_CAL_FRACT) + ((time_in_us % period) << RTC_CLK_CAL_FRACT) / period; + } return (time_in_us << RTC_CLK_CAL_FRACT) / period; } diff --git a/components/esp_hw_support/port/esp32p4/rtc_time.c b/components/esp_hw_support/port/esp32p4/rtc_time.c index d1d20b6f14..3eb3253cd7 100644 --- a/components/esp_hw_support/port/esp32p4/rtc_time.c +++ b/components/esp_hw_support/port/esp32p4/rtc_time.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -198,9 +198,9 @@ uint32_t rtc_clk_cal(rtc_cal_sel_t cal_clk, uint32_t slowclk_cycles) uint64_t rtc_time_us_to_slowclk(uint64_t time_in_us, uint32_t period) { assert(period); - /* Overflow will happen in this function if time_in_us >= 2^45, which is about 400 days. - * TODO: fix overflow. - */ + if (time_in_us > (UINT64_MAX >> RTC_CLK_CAL_FRACT)) { + return ((time_in_us / period) << RTC_CLK_CAL_FRACT) + ((time_in_us % period) << RTC_CLK_CAL_FRACT) / period; + } return (time_in_us << RTC_CLK_CAL_FRACT) / period; } diff --git a/components/esp_hw_support/port/esp32s2/rtc_time.c b/components/esp_hw_support/port/esp32s2/rtc_time.c index 9222d784a4..3818a2624a 100644 --- a/components/esp_hw_support/port/esp32s2/rtc_time.c +++ b/components/esp_hw_support/port/esp32s2/rtc_time.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -227,9 +227,9 @@ uint32_t rtc_clk_cal_cycling(rtc_cal_sel_t cal_clk, uint32_t slowclk_cycles) uint64_t rtc_time_us_to_slowclk(uint64_t time_in_us, uint32_t period) { assert(period); - /* Overflow will happen in this function if time_in_us >= 2^45, which is about 400 days. - * TODO: fix overflow. - */ + if (time_in_us > (UINT64_MAX >> RTC_CLK_CAL_FRACT)) { + return ((time_in_us / period) << RTC_CLK_CAL_FRACT) + ((time_in_us % period) << RTC_CLK_CAL_FRACT) / period; + } return (time_in_us << RTC_CLK_CAL_FRACT) / period; } diff --git a/components/esp_hw_support/port/esp32s3/rtc_time.c b/components/esp_hw_support/port/esp32s3/rtc_time.c index 720ef8e0fd..c161e57d1e 100644 --- a/components/esp_hw_support/port/esp32s3/rtc_time.c +++ b/components/esp_hw_support/port/esp32s3/rtc_time.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -161,9 +161,9 @@ uint32_t rtc_clk_cal(rtc_cal_sel_t cal_clk, uint32_t slowclk_cycles) uint64_t rtc_time_us_to_slowclk(uint64_t time_in_us, uint32_t period) { assert(period); - /* Overflow will happen in this function if time_in_us >= 2^45, which is about 400 days. - * TODO: fix overflow. - */ + if (time_in_us > (UINT64_MAX >> RTC_CLK_CAL_FRACT)) { + return ((time_in_us / period) << RTC_CLK_CAL_FRACT) + ((time_in_us % period) << RTC_CLK_CAL_FRACT) / period; + } return (time_in_us << RTC_CLK_CAL_FRACT) / period; } diff --git a/components/esp_hw_support/sleep_modes.c b/components/esp_hw_support/sleep_modes.c index b3897e50fb..4c9b301159 100644 --- a/components/esp_hw_support/sleep_modes.c +++ b/components/esp_hw_support/sleep_modes.c @@ -12,6 +12,7 @@ #include "esp_attr.h" #include "esp_memory_utils.h" #include "esp_sleep.h" +#include "esp_private/esp_clk_tree_common.h" #include "esp_private/esp_sleep_internal.h" #include "esp_private/esp_timer_private.h" #include "esp_private/sleep_event.h" @@ -1488,6 +1489,10 @@ esp_err_t esp_sleep_enable_ulp_wakeup(void) esp_err_t esp_sleep_enable_timer_wakeup(uint64_t time_in_us) { + if (time_in_us > ((BIT64(SOC_LP_TIMER_BIT_WIDTH_LO + SOC_LP_TIMER_BIT_WIDTH_HI) - 1) / esp_clk_tree_lp_slow_get_freq_hz(ESP_CLK_TREE_SRC_FREQ_PRECISION_APPROX)) * MHZ ) { + return ESP_ERR_INVALID_ARG; + } + s_config.wakeup_triggers |= RTC_TIMER_TRIG_EN; s_config.sleep_duration = time_in_us; return ESP_OK; diff --git a/components/esp_system/test_apps/esp_system_unity_tests/main/test_sleep.c b/components/esp_system/test_apps/esp_system_unity_tests/main/test_sleep.c index 29d0ea2ccb..205e78488b 100644 --- a/components/esp_system/test_apps/esp_system_unity_tests/main/test_sleep.c +++ b/components/esp_system/test_apps/esp_system_unity_tests/main/test_sleep.c @@ -19,6 +19,7 @@ #include "soc/rtc.h" // for wakeup trigger defines #include "soc/rtc_periph.h" // for read rtc registers directly (cause) #include "soc/soc.h" // for direct register read macros +#include "esp_clk_tree.h" #include "esp_newlib.h" #include "test_utils.h" #include "sdkconfig.h" @@ -26,6 +27,7 @@ #include "esp_rom_sys.h" #include "esp_timer.h" #include "esp_private/esp_clk.h" +#include "esp_private/esp_clk_tree_common.h" #include "esp_private/uart_private.h" #include "esp_random.h" #include "nvs_flash.h" @@ -57,6 +59,10 @@ static void deep_sleep_task(void *arg) static void do_deep_sleep_from_app_cpu(void) { + TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_sleep_enable_timer_wakeup(UINT64_MAX)); + uint64_t lp_timer_max_allowed_time_in_us = ((BIT64(SOC_LP_TIMER_BIT_WIDTH_LO + SOC_LP_TIMER_BIT_WIDTH_HI) - 1) / esp_clk_tree_lp_slow_get_freq_hz(ESP_CLK_TREE_SRC_FREQ_PRECISION_APPROX)) * MHZ; + TEST_ASSERT_EQUAL(ESP_OK, esp_sleep_enable_timer_wakeup(lp_timer_max_allowed_time_in_us)); + TEST_ASSERT_EQUAL(ESP_ERR_INVALID_ARG, esp_sleep_enable_timer_wakeup(lp_timer_max_allowed_time_in_us + 1)); esp_sleep_enable_timer_wakeup(2000000); xTaskCreatePinnedToCore(&deep_sleep_task, "ds", 2048, NULL, 5, NULL, 1); diff --git a/components/soc/esp32/include/soc/Kconfig.soc_caps.in b/components/soc/esp32/include/soc/Kconfig.soc_caps.in index becaf8af6c..af46989afd 100644 --- a/components/soc/esp32/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32/include/soc/Kconfig.soc_caps.in @@ -667,6 +667,14 @@ config SOC_TIMER_GROUP_SUPPORT_APB bool default y +config SOC_LP_TIMER_BIT_WIDTH_LO + int + default 32 + +config SOC_LP_TIMER_BIT_WIDTH_HI + int + default 16 + config SOC_TOUCH_VERSION_1 bool default y diff --git a/components/soc/esp32/include/soc/soc_caps.h b/components/soc/esp32/include/soc/soc_caps.h index 648b750d1a..a188cbb985 100644 --- a/components/soc/esp32/include/soc/soc_caps.h +++ b/components/soc/esp32/include/soc/soc_caps.h @@ -317,6 +317,10 @@ #define SOC_TIMER_GROUP_TOTAL_TIMERS (4) #define SOC_TIMER_GROUP_SUPPORT_APB (1) +/*-------------------------- LP_TIMER CAPS ----------------------------------*/ +#define SOC_LP_TIMER_BIT_WIDTH_LO 32 // Bit width of lp_timer low part +#define SOC_LP_TIMER_BIT_WIDTH_HI 16 // Bit width of lp_timer high part + /*-------------------------- TOUCH SENSOR CAPS -------------------------------*/ #define SOC_TOUCH_VERSION_1 (1) /*!