feat(esp32): Add automatic lightSleep and WiFi listenInterval APIs

Author: tshcherban

cores/esp32/esp32-hal-cpu.c

@@ -18,6 +18,7 @@
 #include "freertos/task.h"
 #include "esp_attr.h"
 #include "esp_log.h"
+#include "esp_pm.h"
 #include "soc/rtc.h"
 #if !defined(CONFIG_IDF_TARGET_ESP32C2) && !defined(CONFIG_IDF_TARGET_ESP32C6) && !defined(CONFIG_IDF_TARGET_ESP32H2)
 #include "soc/rtc_cntl_reg.h"
@@ -278,3 +279,16 @@ uint32_t getApbFrequency(){
     rtc_clk_cpu_freq_get_config(&conf);
     return calculateApb(&conf);
 }
+
+bool setAutomaticLightSleep(bool enabled)
+{
+    uint32_t cpuFreq = getCpuFrequencyMhz();
+
+    esp_pm_config_t pm_config = {
+        .max_freq_mhz = cpuFreq,
+        .min_freq_mhz = cpuFreq,
+        .light_sleep_enable = enabled,
+    };
+
+    return esp_pm_configure(&pm_config) == ESP_OK;
+}

cores/esp32/esp32-hal-cpu.h

@@ -41,6 +41,15 @@ uint32_t getCpuFrequencyMhz();  // In MHz
 uint32_t getXtalFrequencyMhz(); // In MHz
 uint32_t getApbFrequency();     // In Hz
 
+/**
+ * @brief Set automatic light sleep state. CPU will fo into light sleep if no ongoing activity (active task, peripheral activity etc.)
+ * @param enabled true to enable automatic lightSleep
+ * @return
+ *      - ESP_OK on success
+ *      - ESP_ERR_NOT_SUPPORTED if CONFIG_PM_ENABLE is not enabled in sdkconfig
+ */
+bool setAutomaticLightSleep(bool enabled);
+
 #ifdef __cplusplus
 }
 #endif

libraries/WiFi/src/WiFiGeneric.cpp

@@ -1393,6 +1393,27 @@ bool WiFiGenericClass::setSleep(wifi_ps_type_t sleepType)
     return false;
 }
 
+bool WiFiGenericClass::setSleep(wifi_ps_type_t sleepType, uint16_t listenInterval)
+{
+    if (!setSleep(sleepType))
+        return false;
+    
+    wifi_config_t current_conf;
+    if(esp_wifi_get_config((wifi_interface_t)ESP_IF_WIFI_STA, &current_conf) != ESP_OK){
+        log_e("setSleep(wifi_ps_type_t sleepType, uint16_t listenInterval) failed: get current config failed!");
+        return false;
+    }
+
+    current_conf.sta.listen_interval = listenInterval;
+
+    if(esp_wifi_set_config((wifi_interface_t)ESP_IF_WIFI_STA, &current_conf) != ESP_OK){
+        log_e("setSleep(wifi_ps_type_t sleepType, uint16_t listenInterval) failed: set wifi config failed!");
+        return false;
+    }
+
+    return true;
+}
+
 /**
  * get modem sleep enabled
  * @return true if modem sleep is enabled

libraries/WiFi/src/WiFiGeneric.h

@@ -182,6 +182,16 @@ class WiFiGenericClass
 
     bool setSleep(bool enabled);
     bool setSleep(wifi_ps_type_t sleepType);
+
+    /**
+    * @brief Set modem sleep state
+    * @param sleepType Modem sleep type, one of WIFI_PS_NONE, WIFI_PS_MIN_MODEM, WIFI_PS_MAX_MODEM
+	* @param listenInterval Listen interval for ESP32 station to receive beacon when WIFI_PS_MAX_MODEM is set. Units: AP beacon intervals. Defaults to 3 if set to 0.
+    * @return
+    *      - true on success
+    *      - false on internal error when parameters combination is not valid
+    */
+    bool setSleep(wifi_ps_type_t sleepType, uint16_t listenInterval);
     wifi_ps_type_t getSleep();
 
     bool setTxPower(wifi_power_t power);