feat(esp_hw_support): support switch to VBAT power supply in deepsleep on esp32p4

Author: esp-wzh

components/esp_hw_support/CMakeLists.txt

@@ -157,7 +157,7 @@ if(NOT non_os_build)
         list(APPEND srcs "power_supply/brownout.c")
     endif()
 
-    if(CONFIG_ESP_VBAT_INIT_AUTO)
+    if(CONFIG_SOC_VBAT_SUPPORTED)
         list(APPEND srcs "power_supply/vbat.c")
     endif()
 

components/esp_hw_support/include/esp_private/esp_pmu.h

@@ -47,6 +47,7 @@ typedef enum {
 #define RTC_SLEEP_PD_MODEM              PMU_SLEEP_PD_MODEM      //!< Power down modem(include wifi, ble and 15.4)
 
 //These flags are not power domains, but will affect some sleep parameters
+#define RTC_SLEEP_POWER_BY_VBAT         BIT(26)
 #define RTC_SLEEP_DIG_USE_8M            BIT(27)
 #define RTC_SLEEP_USE_ADC_TESEN_MONITOR BIT(28)
 #define RTC_SLEEP_NO_ULTRA_LOW          BIT(29) //!< Avoid using ultra low power in deep sleep, in which RTCIO cannot be used as input, and RTCMEM can't work under high temperature
@@ -123,6 +124,12 @@ typedef enum {
 #define RTC_LP_VAD_TRIG_EN          0
 #endif //SOC_LP_VAD_SUPPORTED
 
+#if SOC_VBAT_SUPPORTED
+#define RTC_VBAT_UNDER_VOLT_TRIG_EN            PMU_VBAT_UNDERVOLT_WAKEUP_EN   //!< VBAT under voltage wakeup
+#else
+#define RTC_VBAT_UNDER_VOLT_TRIG_EN            0
+#endif //SOC_VBAT_SUPPORTED
+
 #define RTC_XTAL32K_DEAD_TRIG_EN    0 // TODO
 #define RTC_BROWNOUT_DET_TRIG_EN    0 // TODO
 
@@ -143,6 +150,7 @@ typedef enum {
                                RTC_XTAL32K_DEAD_TRIG_EN | \
                                RTC_USB_TRIG_EN          | \
                                RTC_LP_VAD_TRIG_EN       | \
+                               RTC_VBAT_UNDER_VOLT_TRIG_EN | \
                                RTC_BROWNOUT_DET_TRIG_EN)
 
 

components/esp_hw_support/include/esp_private/esp_sleep_internal.h

@@ -39,6 +39,7 @@ typedef enum {
     ESP_SLEEP_RTC_FAST_USE_XTAL_MODE,     //!< The mode in which the crystal is used as the RTC_FAST clock source, need keep XTAL on in HP_SLEEP mode when ULP is working.
     ESP_SLEEP_DIG_USE_XTAL_MODE,          //!< The mode requested by digital peripherals to keep XTAL clock on during sleep (both HP_SLEEP and LP_SLEEP mode). (!!! Only valid for lightsleep, will override the XTAL domain config by esp_sleep_pd_config)
     ESP_SLEEP_LP_USE_XTAL_MODE,           //!< The mode requested by lp peripherals to keep XTAL clock on during sleep. Only valid for lightsleep.
+    ESP_SLEEP_VBAT_POWER_DEEPSLEEP_MODE,  //!< The mode to switch power supply to VBAT during deep sleep.
     ESP_SLEEP_MODE_MAX,
 } esp_sleep_sub_mode_t;
 

components/esp_hw_support/include/esp_sleep.h

@@ -119,6 +119,7 @@ typedef enum {
     ESP_SLEEP_WAKEUP_COCPU_TRAP_TRIG,   //!< Wakeup caused by COCPU crash
     ESP_SLEEP_WAKEUP_BT,           //!< Wakeup caused by BT (light sleep only)
     ESP_SLEEP_WAKEUP_VAD,          //!< Wakeup caused by VAD
+    ESP_SLEEP_WAKEUP_VBAT_UNDER_VOLT, //!< Wakeup caused by VDD_BAT under voltage.
 } esp_sleep_source_t;
 
 /**
@@ -194,6 +195,16 @@ esp_err_t esp_sleep_enable_timer_wakeup(uint64_t time_in_us);
 esp_err_t esp_sleep_enable_vad_wakeup(void);
 #endif
 
+#if SOC_VBAT_SUPPORTED
+/**
+ * Wakeup chip is VBAT power voltage is lower than the configured brownout_threshold value.
+ *
+ * @return
+ *      - ESP_OK on success
+ */
+esp_err_t esp_sleep_enable_vbat_under_volt_wakeup(void);
+#endif
+
 #if SOC_TOUCH_SENSOR_SUPPORTED
 /**
  * @brief Enable wakeup by touch sensor
@@ -591,6 +602,7 @@ esp_err_t esp_sleep_pd_config(esp_sleep_pd_domain_t domain,
  *
  * @return
  *  - No return - If the sleep is not rejected.
+ *  - ESP_ERR_INVALID_STATE VBAT power does not meet the requirements for entering deepsleep
  *  - ESP_ERR_SLEEP_REJECT sleep request is rejected(wakeup source set before the sleep request)
  */
 esp_err_t esp_deep_sleep_try_to_start(void);

components/esp_hw_support/linker.lf

@@ -68,6 +68,11 @@ entries:
             sar_periph_ctrl (noflash)
         elif PM_SLP_IRAM_OPT = y:
             sar_periph_ctrl: sar_periph_ctrl_power_enable (noflash)
+    if ESP_VBAT_ISR_CACHE_SAFE = y:
+        sleep_modes: esp_sleep_disable_wakeup_source (noflash)
+        sleep_modes: esp_sleep_enable_vbat_under_volt_wakeup (noflash)
+        sleep_modes: esp_sleep_sub_mode_config (noflash)
+        sleep_modes: esp_sleep_sub_mode_force_disable (noflash)
 
 [mapping:soc_pm]
 archive: libsoc.a

components/esp_hw_support/port/esp32h2/pmu_sleep.c

@@ -140,18 +140,18 @@ const pmu_sleep_config_t* pmu_sleep_config_default(
     )
 {
     pmu_sleep_power_config_t power_default = PMU_SLEEP_POWER_CONFIG_DEFAULT(sleep_flags);
-    config->power = power_default;
-
-    pmu_sleep_param_config_t param_default = PMU_SLEEP_PARAM_CONFIG_DEFAULT(sleep_flags);
-    config->param = *pmu_sleep_param_config_default(&param_default, &power_default, sleep_flags, adjustment, slowclk_period, fastclk_period);
-
     if (dslp) {
         pmu_sleep_digital_config_t digital_default = PMU_SLEEP_DIGITAL_DSLP_CONFIG_DEFAULT(sleep_flags, clk_flags);
         config->digital = digital_default;
 
         pmu_sleep_analog_config_t analog_default = PMU_SLEEP_ANALOG_DSLP_CONFIG_DEFAULT(sleep_flags);
         analog_default.lp_sys[LP(SLEEP)].analog.dbias = get_slp_lp_dbias();
         config->analog = analog_default;
+
+        if (sleep_flags & RTC_SLEEP_POWER_BY_VBAT) {
+            power_default.lp_sys[PMU_MODE_LP_SLEEP].dig_power.vddbat_mode = 1;
+            power_default.lp_sys[PMU_MODE_LP_SLEEP].dig_power.bod_source_sel = 1;
+        }
     } else {
         pmu_sleep_digital_config_t digital_default = PMU_SLEEP_DIGITAL_LSLP_CONFIG_DEFAULT(sleep_flags, clk_flags);
         config->digital = digital_default;
@@ -174,6 +174,9 @@ const pmu_sleep_config_t* pmu_sleep_config_default(
         }
         config->analog = analog_default;
     }
+    config->power = power_default;
+    pmu_sleep_param_config_t param_default = PMU_SLEEP_PARAM_CONFIG_DEFAULT(sleep_flags);
+    config->param = *pmu_sleep_param_config_default(&param_default, &power_default, sleep_flags, adjustment, slowclk_period, fastclk_period);
     return config;
 }
 

components/esp_hw_support/port/esp32h2/private_include/pmu_bit_defs.h

@@ -18,6 +18,7 @@ extern "C" {
 #define PMU_UART1_WAKEUP_EN         BIT(7)
 #define PMU_BLE_SOC_WAKEUP_EN       BIT(10)
 #define PMU_USB_WAKEUP_EN           BIT(14)
+#define PMU_VBAT_UNDERVOLT_WAKEUP_EN  BIT(15)
 
 #ifdef __cplusplus
 }

components/esp_hw_support/port/esp32h2/private_include/pmu_param.h

@@ -139,7 +139,9 @@ typedef union {
 
 typedef union {
     struct {
-        uint32_t reserved0 : 30;
+        uint32_t reserved0 : 27;
+        uint32_t bod_source_sel : 1;
+        uint32_t vddbat_mode : 2;
         uint32_t mem_dslp  : 1;
         uint32_t peri_pd_en: 1;
     };

components/esp_hw_support/port/esp32p4/pmu_sleep.c

@@ -169,6 +169,11 @@ const pmu_sleep_config_t* pmu_sleep_config_default(
         pmu_sleep_analog_config_t analog_default = PMU_SLEEP_ANALOG_DSLP_CONFIG_DEFAULT(sleep_flags);
         analog_default.hp_sys.analog.xpd_0p1a = 0;
         config->analog = analog_default;
+
+        if (sleep_flags & RTC_SLEEP_POWER_BY_VBAT) {
+            power_default.lp_sys[PMU_MODE_LP_SLEEP].dig_power.vddbat_mode = 1;
+            power_default.lp_sys[PMU_MODE_LP_SLEEP].dig_power.bod_source_sel = 1;
+        }
     } else {
         // Get light sleep digital_default
         pmu_sleep_digital_config_t digital_default = PMU_SLEEP_DIGITAL_LSLP_CONFIG_DEFAULT(sleep_flags);

components/esp_hw_support/port/esp32p4/private_include/pmu_bit_defs.h

@@ -25,7 +25,7 @@ extern "C" {
 #define PMU_EXT1_WAKEUP_EN              BIT(12)
 #define PMU_LP_TIMER_WAKEUP_EN          BIT(13)
 #define PMU_BOD_WAKEUP_EN               BIT(14)
-#define PMU_VDDBAT_UNDERVOLT_WAKEUP_EN  BIT(15)
+#define PMU_VBAT_UNDERVOLT_WAKEUP_EN    BIT(15)
 #define PMU_LP_CORE_TRAP_WAKEUP_EN      BIT(16)
 #define PMU_ETM_WAKEUP_EN               BIT(17)
 #define PMU_LP_TIMER1_WAKEUP_EN         BIT(18)

components/esp_hw_support/power_supply/include/esp_vbat.h

@@ -0,0 +1,49 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include "sdkconfig.h"
+#include "freertos/FreeRTOS.h"
+#include "esp_err.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef enum {
+    ESP_VBAT_STATE_NORMAL,          /*!< Normal working state, not charging */
+    ESP_VBAT_STATE_CHARGING,        /*!< Battery is charging by VDDA, only for chargeable battery. */
+    ESP_VBAT_STATE_LOWBATTERY,      /*!< Battery is under voltage, battery replacement required */
+} esp_vbat_state_t;
+
+#if CONFIG_ESP_VBAT_USE_RECHARGEABLE_BATTERY
+/**
+ * @brief Wait until battery charging done.
+ *
+ * @note This function is not allowed to be called in ISR  context.
+ *
+ * @param  checking_period Time in ticks to wait until timeout or succeed
+ * @return
+ *  - ESP_OK: Battery charging completed
+ *  - ESP_FAIL: Called in ISR context
+ *  - ESP_ERR_TIMEOUT: Timeout waiting for battery charging to complete
+ */
+esp_err_t esp_vbat_wait_battery_charge_done(TickType_t checking_period);
+#endif
+
+/**
+ * @brief Get battery status.
+ * @return
+ *     - DISCHARGING Battery is discharging.
+ *     - CHARGING    Battery is charing (ESP_VBAT_USE_RECHARGEABLE_BATTERY only).
+ *     - LOWBATTERY  Battery is under voltage.
+ */
+esp_vbat_state_t esp_vbat_get_battery_state(void);
+
+#ifdef __cplusplus
+}
+#endif

components/esp_hw_support/power_supply/port/esp32h2/Kconfig.power

@@ -78,6 +78,14 @@ menu "Power Supplier"
                     during deep sleep.
                 - When this option is disabled, the RTC battery input (VBAT) must not be left floating.
 
+        config ESP_VBAT_ISR_CACHE_SAFE
+            bool "VBAT ISR IRAM-Safe"
+            default y
+            depends on SOC_VBAT_SUPPORTED && ESP_VBAT_INIT_AUTO
+            help
+                Ensure the VBAT interrupt is IRAM-Safe by allowing the interrupt handler to be
+                executable when the cache is disabled (e.g. SPI Flash write).
+
         config ESP_VBAT_USE_RECHARGEABLE_BATTERY
             bool "The battery for RTC battery is a rechargeable battery"
             default n
@@ -167,6 +175,13 @@ menu "Power Supplier"
                 bool "2.57V"
         endchoice
 
+        config ESP_VBAT_WAKEUP_CHIP_ON_VBAT_BROWNOUT
+            bool "Wake up chip in deepsleep if VBAT brownout"
+            depends on !ESP_VBAT_USE_RECHARGEABLE_BATTERY
+            default n
+            help
+                Wake up the chip if the vbat voltage drops below the brownout voltage during deepsleep.
+
         config ESP_VBAT_DET_LVL_LOW
             int
             depends on ESP_VBAT_USE_RECHARGEABLE_BATTERY

components/esp_hw_support/power_supply/port/esp32p4/Kconfig.power

@@ -67,6 +67,14 @@ menu "Power Supplier"
                     during deep sleep.
                 - When this option is disabled, the RTC battery input (VBAT) must not be left floating.
 
+        config ESP_VBAT_ISR_CACHE_SAFE
+            bool "VBAT ISR IRAM-Safe"
+            default y
+            depends on SOC_VBAT_SUPPORTED && ESP_VBAT_INIT_AUTO
+            help
+                Ensure the VBAT interrupt is IRAM-Safe by allowing the interrupt handler to be
+                executable when the cache is disabled (e.g. SPI Flash write).
+
         config ESP_VBAT_USE_RECHARGEABLE_BATTERY
             bool "The battery for RTC battery is a rechargeable battery"
             default n
@@ -126,6 +134,13 @@ menu "Power Supplier"
                 bool "2.42V"
         endchoice
 
+        config ESP_VBAT_WAKEUP_CHIP_ON_VBAT_BROWNOUT
+            bool "Wake up chip in deepsleep if VBAT brownout"
+            depends on !ESP_VBAT_USE_RECHARGEABLE_BATTERY
+            default n
+            help
+                Wake up the chip if the vbat voltage drops below the brownout voltage during deepsleep.
+
         config ESP_VBAT_DET_LVL_LOW
             int
             depends on ESP_VBAT_USE_RECHARGEABLE_BATTERY