Merge branch 'refactor/move_from_esp_system' into 'master'

Movements from esp_system

Closes IDF-2165

See merge request espressif/esp-idf!12695

components/esp_hw_support/CMakeLists.txt

@@ -5,15 +5,25 @@ if(${target} STREQUAL "esp32")
      list(APPEND requires efuse)
 endif()
 
+set(priv_requires efuse)
+
 set(srcs "compare_set.c" "cpu_util.c")
 if(NOT BOOTLOADER_BUILD)
-    list(APPEND srcs "esp_clk.c" "clk_ctrl_os.c" "mac_addr.c" "hw_random.c")
+    list(APPEND srcs "esp_async_memcpy.c"
+                     "esp_clk.c"
+                     "clk_ctrl_os.c"
+                     "hw_random.c"
+                     "intr_alloc.c"
+                     "mac_addr.c"
+                     "sleep_modes.c")
+     list(APPEND priv_requires esp_ipc)
 endif()
 
 idf_component_register(SRCS ${srcs}
                        INCLUDE_DIRS include include/soc
+                       PRIV_INCLUDE_DIRS port/include
                        REQUIRES ${requires}
-                       PRIV_REQUIRES efuse
+                       PRIV_REQUIRES ${priv_requires}
                        LDFRAGMENTS linker.lf)
 
 idf_build_get_property(target IDF_TARGET)

components/esp_hw_support/Kconfig

@@ -15,4 +15,19 @@ menu "Hardware Settings"
             # Insert chip-specific MAC config
             rsource "./port/$IDF_TARGET/Kconfig.mac"
     endmenu
+
+    menu "Sleep Config"
+        # This is here since this option affect behavior of esp_light_sleep_start
+        # regardless of power management configuration.
+        config ESP_SLEEP_POWER_DOWN_FLASH
+            bool "Power down flash in light sleep when there is no SPIRAM"
+            depends on !SPIRAM
+            default y
+            help
+                If enabled, chip will try to power down flash as part of esp_light_sleep_start(), which costs
+                more time when chip wakes up. Can only be enabled if there is no SPIRAM configured.
+                This option will in fact consider VDD_SDIO auto power value (ESP_PD_OPTION_AUTO) as OFF. Also, it is
+                possible to force a power domain to stay ON during light sleep by using esp_sleep_pd_config()
+                function.
+    endmenu
 endmenu

components/esp_hw_support/component.mk

@@ -5,5 +5,7 @@ COMPONENT_ADD_LDFRAGMENTS := linker.lf
 port/$(IDF_TARGET)/rtc_clk.o: CFLAGS += -fno-jump-tables -fno-tree-switch-conversion
 
 ifdef IS_BOOTLOADER_BUILD
-COMPONENT_OBJEXCLUDE += clk_ctrl_os.o mac_addr.o
+COMPONENT_OBJEXCLUDE += clk_ctrl_os.o mac_addr.o esp_async_memcpy.o intr_alloc.o sleep_modes.o
 endif
+
+COMPONENT_OBJEXCLUDE += esp_async_memcpy.o

components/esp_hw_support/include/esp_sleep.h

@@ -441,6 +441,18 @@ void esp_default_wake_deep_sleep(void);
  */
 void esp_deep_sleep_disable_rom_logging(void);
 
+#ifdef SOC_PM_SUPPORT_CPU_PD
+/**
+ * @brief CPU Power down low-level initialize
+ *
+ * @param enable  enable or disable CPU power down during light sleep
+ * @return
+ *      - ESP_OK on success
+ *      - ESP_ERR_NO_MEM not enough retention memory
+ */
+esp_err_t esp_sleep_cpu_pd_low_init(bool enable);
+#endif
+
 #if SOC_GPIO_SUPPORT_SLP_SWITCH
 /**
  * @brief Configure to isolate all GPIO pins in sleep state

components/esp_hw_support/port/esp32c3/CMakeLists.txt

@@ -8,6 +8,10 @@ set(srcs "cpu_util_esp32c3.c"
          "chip_info.c"
          )
 
+if(NOT BOOTLOADER_BUILD)
+    list(APPEND srcs "../async_memcpy_impl_gdma.c")
+endif()
+
 add_prefix(srcs "${CMAKE_CURRENT_LIST_DIR}/" "${srcs}")
 
 target_sources(${COMPONENT_LIB} PRIVATE "${srcs}")

components/esp_hw_support/port/esp32s2/CMakeLists.txt

@@ -13,6 +13,10 @@ set(srcs
     "chip_info.c"
     )
 
+if(NOT BOOTLOADER_BUILD)
+    list(APPEND srcs "async_memcpy_impl_cp_dma.c")
+endif()
+
 add_prefix(srcs "${CMAKE_CURRENT_LIST_DIR}/" "${srcs}")
 target_sources(${COMPONENT_LIB} PRIVATE "${srcs}")
 

components/esp_hw_support/port/esp32s3/CMakeLists.txt

@@ -12,6 +12,10 @@ set(srcs
     "chip_info.c"
     )
 
+if(NOT BOOTLOADER_BUILD)
+    list(APPEND srcs "../async_memcpy_impl_gdma.c")
+endif()
+
 add_prefix(srcs "${CMAKE_CURRENT_LIST_DIR}/" "${srcs}")
 target_sources(${COMPONENT_LIB} PRIVATE "${srcs}")
 

components/esp_hw_support/port/include/esp_async_memcpy_impl.h

@@ -12,6 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 #include <stdint.h>
 #include <stdbool.h>
 #include "esp_err.h"
@@ -27,6 +31,7 @@
 #include "esp_private/gdma.h"
 #endif
 
+
 /**
  * @brief Type of async mcp implementation layer context
  *
@@ -103,3 +108,7 @@ esp_err_t async_memcpy_impl_restart(async_memcpy_impl_t *impl);
  * @return True if both address are valid
  */
 bool async_memcpy_impl_is_buffer_address_valid(async_memcpy_impl_t *impl, void *src, void *dst);
+
+#ifdef __cplusplus
+}
+#endif

components/esp_hw_support/sdkconfig.rename

@@ -4,3 +4,5 @@
 CONFIG_NUMBER_OF_UNIVERSAL_MAC_ADDRESS                  CONFIG_ESP32_UNIVERSAL_MAC_ADDRESSES
 CONFIG_TWO_UNIVERSAL_MAC_ADDRESS                        CONFIG_ESP32_UNIVERSAL_MAC_ADDRESSES_TWO
 CONFIG_FOUR_UNIVERSAL_MAC_ADDRESS                       CONFIG_ESP32_UNIVERSAL_MAC_ADDRESSES_FOUR
+
+CONFIG_ESP_SYSTEM_PD_FLASH                              CONFIG_ESP_SLEEP_POWER_DOWN_FLASH

components/esp_hw_support/sleep_modes.c

@@ -1336,7 +1336,7 @@ static uint32_t get_power_down_flags(void)
 
     /**
      * VDD_SDIO power domain shall be kept on during the light sleep
-     * when CONFIG_ESP_SYSTEM_PD_FLASH is not set and off when it is set.
+     * when CONFIG_ESP_SLEEP_POWER_DOWN_FLASH is not set and off when it is set.
      * The application can still force the power domain to remain on by calling
      * `esp_sleep_pd_config` before getting into light sleep mode.
      *
@@ -1344,7 +1344,7 @@ static uint32_t get_power_down_flags(void)
      * value of this field.
      */
     if (s_config.pd_options[ESP_PD_DOMAIN_VDDSDIO] == ESP_PD_OPTION_AUTO) {
-#ifdef CONFIG_ESP_SYSTEM_PD_FLASH
+#ifdef CONFIG_ESP_SLEEP_POWER_DOWN_FLASH
         s_config.pd_options[ESP_PD_DOMAIN_VDDSDIO] = ESP_PD_OPTION_OFF;
 #else
         s_config.pd_options[ESP_PD_DOMAIN_VDDSDIO] = ESP_PD_OPTION_ON;

components/esp_pm/Kconfig

@@ -94,4 +94,12 @@ menu "Power Management"
         bool
         default n
 
+    config PM_POWER_DOWN_CPU_IN_LIGHT_SLEEP
+        bool "Power down CPU in light sleep"
+        depends on IDF_TARGET_ESP32C3
+        default y
+        help
+            If enabled, the CPU will be powered down in light sleep. Enabling this option will consume
+            1.68 KB of internal RAM and will reduce sleep current consumption by about 100 uA.
+
 endmenu # "Power Management"

components/esp_pm/linker.lf

@@ -11,6 +11,10 @@ entries:
 archive: libesp_hw_support.a
 entries:
     if PM_SLP_IRAM_OPT = y:
+        sleep_modes:esp_light_sleep_start (noflash)
+        sleep_modes:esp_sleep_enable_timer_wakeup (noflash)
+        sleep_modes:timer_wakeup_prepare (noflash)
+        sleep_modes:get_power_down_flags (noflash)
         rtc_init:rtc_vddsdio_get_config (noflash)
         esp_clk:esp_clk_slowclk_cal_set (noflash)
         esp_clk:esp_clk_slowclk_cal_get (noflash)
@@ -22,10 +26,6 @@ entries:
     if PM_RTOS_IDLE_OPT = y:
         freertos_hooks:esp_vApplicationIdleHook (noflash)
     if PM_SLP_IRAM_OPT = y:
-        sleep_modes:esp_light_sleep_start (noflash)
-        sleep_modes:esp_sleep_enable_timer_wakeup (noflash)
-        sleep_modes:timer_wakeup_prepare (noflash)
-        sleep_modes:get_power_down_flags (noflash)
         task_wdt:idle_hook_cb (noflash)
         task_wdt:esp_task_wdt_reset (noflash)
         task_wdt:find_task_in_twdt_list (noflash)
@@ -70,5 +70,5 @@ entries:
             gpio_hal_workaround:gpio_hal_sleep_pupd_config_unapply  (noflash)
             gpio_hal_workaround:gpio_hal_sleep_mode_setup_wrapper   (noflash)
             gpio_hal_workaround:gpio_hal_fun_pupd_restore           (noflash)
-    if PM_SLP_IRAM_OPT = y && ESP_SYSTEM_PM_POWER_DOWN_CPU = y:
+    if PM_SLP_IRAM_OPT = y && PM_POWER_DOWN_CPU_IN_LIGHT_SLEEP = y:
         rtc_cntl_hal:rtc_cntl_hal_enable_cpu_retention (noflash)

components/esp_pm/pm_impl.c

@@ -60,7 +60,6 @@
 #include "esp32c3/clk.h"
 #include "esp32c3/pm.h"
 #include "driver/gpio.h"
-#include "esp_private/sleep_modes.h"
 #endif
 
 #define MHZ (1000000)
@@ -307,7 +306,7 @@ esp_err_t esp_pm_configure(const void* vconfig)
     esp_sleep_enable_gpio_switch(config->light_sleep_enable);
 #endif
 
-#if CONFIG_ESP_SYSTEM_PM_POWER_DOWN_CPU && SOC_PM_SUPPORT_CPU_PD
+#if CONFIG_PM_POWER_DOWN_CPU_IN_LIGHT_SLEEP && SOC_PM_SUPPORT_CPU_PD
     esp_err_t ret = esp_sleep_cpu_pd_low_init(config->light_sleep_enable);
     if (config->light_sleep_enable && ret != ESP_OK) {
         ESP_LOGW(TAG, "Failed to enable CPU power down during light sleep.");

components/esp_pm/sdkconfig.rename

@@ -0,0 +1,3 @@
+# sdkconfig replacement configurations for deprecated options formatted as
+# CONFIG_DEPRECATED_OPTION CONFIG_NEW_OPTION
+CONFIG_ESP_SYSTEM_PM_POWER_DOWN_CPU                                      CONFIG_PM_POWER_DOWN_CPU_IN_LIGHT_SLEEP

components/esp_system/CMakeLists.txt

@@ -13,15 +13,12 @@ else()
     list(APPEND srcs "crosscore_int.c"
             "esp_err.c"
             "freertos_hooks.c"
-            "intr_alloc.c"
             "int_wdt.c"
-            "esp_async_memcpy.c"
             "panic.c"
             "esp_system.c"
             "startup.c"
             "system_time.c"
             "stack_check.c"
-            "sleep_modes.c"
             "task_wdt.c")
 
     if(NOT (${target} STREQUAL "esp32c3") )
@@ -34,7 +31,7 @@ else()
                                     # [refactor-todo] requirements due to init code,
                                     # should be removable once using component init functions
                                     # link-time registration is used.
-                                    esp_pm app_update nvs_flash pthread app_trace esp_gdbstub esp_ipc
+                                    esp_pm app_update nvs_flash pthread app_trace esp_gdbstub
                                     espcoredump
                         LDFRAGMENTS "linker.lf" "app.lf")
     add_subdirectory(port)

components/esp_system/Kconfig

@@ -83,24 +83,6 @@ menu "ESP System Settings"
             heap initialization order by early startup services and scheduler related code. Speed
             wise RTC fast memory operates on APB clock and hence does not have much performance impact.
 
-    config ESP_SYSTEM_PD_FLASH
-        bool "PD flash at light sleep when there is no SPIRAM"
-        depends on !SPIRAM
-        default y
-        help
-            If enabled, chip will try to power down flash at light sleep, which costs more time when chip wakes up.
-            Can only be enabled if there is no SPIRAM configured. This option will in fact consider VDD_SDIO auto power
-            value (ESP_PD_OPTION_AUTO) as OFF. Also, it is possible to force a power domain to stay ON during light
-            sleep by using esp_sleep_pd_config() function.
-
-    config ESP_SYSTEM_PM_POWER_DOWN_CPU
-        bool "Power down CPU in light sleep"
-        depends on IDF_TARGET_ESP32C3
-        default y
-        help
-            If enabled, the CPU will be powered down in light sleep. Enabling this option will consume
-            1.68 KB of internal RAM and will reduce sleep current consumption by about 100 uA.
-
     menu "Memory protection"
 
         config ESP_SYSTEM_MEMPROT_FEATURE

components/esp_system/component.mk

@@ -11,7 +11,7 @@ else
 SOC_NAME := $(IDF_TARGET)
 
 COMPONENT_SRCDIRS := .
-COMPONENT_ADD_INCLUDEDIRS := include
+COMPONENT_ADD_INCLUDEDIRS := include port/public_compat
 COMPONENT_PRIV_INCLUDEDIRS := port/include port
 COMPONENT_ADD_LDFRAGMENTS += linker.lf app.lf
 

components/esp_system/include/esp_private/sleep_modes.h

@@ -1,40 +0,0 @@
-// Copyright 2020 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-#pragma once
-
-#include <stdbool.h>
-#include <stddef.h>
-#include <stdint.h>
-#include "esp_err.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#ifdef CONFIG_ESP_SYSTEM_PM_POWER_DOWN_CPU
-/**
- * @brief CPU Power down low-level initialize
- *
- * @param enable  enable or disable CPU power down during light sleep
- * @return
- *      - ESP_OK on success
- *      - ESP_ERR_NO_MEM not enough retention memory
- */
-esp_err_t esp_sleep_cpu_pd_low_init(bool enable);
-#endif
-
-#ifdef __cplusplus
-}
-#endif

components/esp_system/port/CMakeLists.txt

@@ -1,4 +1,5 @@
-target_include_directories(${COMPONENT_LIB} PRIVATE include . PUBLIC soc)
+target_include_directories(${COMPONENT_LIB} PRIVATE . include PUBLIC soc)
+target_include_directories(${COMPONENT_LIB} PUBLIC public_compat)
 
 set(srcs "cpu_start.c" "panic_handler.c" "brownout.c")
 add_prefix(srcs "${CMAKE_CURRENT_LIST_DIR}/" ${srcs})

components/esp_system/port/public_compat/trax.h

@@ -18,6 +18,10 @@
 #include "xtensa-debug-module.h"
 #include "xt_trax.h"
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 typedef enum {
     TRAX_DOWNCOUNT_WORDS,
     TRAX_DOWNCOUNT_INSTRUCTIONS
@@ -70,3 +74,7 @@ int trax_start_trace(trax_downcount_unit_t units_until_stop);
  * @return esp_err_t
  */
 int trax_trigger_traceend_after_delay(int delay);
+
+#ifdef __cplusplus
+}
+#endif

components/esp_system/port/soc/esp32c3/CMakeLists.txt

@@ -2,7 +2,6 @@ set(srcs "clk.c"
          "reset_reason.c"
          "system_internal.c"
          "cache_err_int.c"
-         "../../async_memcpy_impl_gdma.c"
          "apb_backup_dma.c"
          "../../arch/riscv/expression_with_stack.c"
          "../../arch/riscv/expression_with_stack_asm.S"

components/esp_system/port/soc/esp32s2/CMakeLists.txt

@@ -1,5 +1,4 @@
-set(srcs "async_memcpy_impl_cp_dma.c"
-         "dport_panic_highint_hdl.S"
+set(srcs "dport_panic_highint_hdl.S"
          "clk.c"
          "reset_reason.c"
          "system_internal.c"

components/esp_system/port/soc/esp32s3/CMakeLists.txt

@@ -3,7 +3,6 @@ set(srcs "dport_panic_highint_hdl.S"
          "reset_reason.c"
          "system_internal.c"
          "cache_err_int.c"
-         "../../async_memcpy_impl_gdma.c"
          "../../arch/xtensa/panic_arch.c"
          "../../arch/xtensa/panic_handler_asm.S"
          "../../arch/xtensa/expression_with_stack.c"