Merge branch 'refactor/move_etm_retention_to_driver_layer' into 'master'

refactor(etm): move ETM retention info from HAL to driver layer

See merge request espressif/esp-idf!50669

components/esp_hw_support/CMakeLists.txt

@@ -112,6 +112,9 @@ if(NOT non_os_build)
 
     if(CONFIG_SOC_ETM_SUPPORTED)
         list(APPEND srcs "etm/esp_etm.c")
+        if(CONFIG_SOC_PAU_SUPPORTED)
+            list(APPEND srcs "port/${target}/etm_retention.c")
+        endif()
     endif()
 
     if(CONFIG_SOC_PAU_SUPPORTED)

components/esp_hw_support/etm/esp_etm.c

@@ -16,7 +16,7 @@
 #endif
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
-#include "hal/etm_periph.h"
+#include "etm_retention.h"
 #include "esp_log.h"
 #include "esp_check.h"
 #include "esp_heap_caps.h"

components/esp_hw_support/include/esp_private/etm_retention.h

@@ -9,11 +9,9 @@
 #include <stdint.h>
 #include "soc/soc_caps.h"
 #include "soc/regdma.h"
-
 #if SOC_HAS(ETM)
 #include "hal/etm_ll.h"
 #endif
-
 #if SOC_HAS(PAU)
 #include "soc/retention_periph_defs.h"
 #endif
@@ -22,7 +20,7 @@
 extern "C" {
 #endif
 
-#if SOC_HAS(PAU) && SOC_ETM_SUPPORT_SLEEP_RETENTION
+#if SOC_HAS(PAU)
 
 typedef struct {
     periph_retention_module_t module;                  // ID of the ETM as a retention module

components/esp_hw_support/port/esp32c5/etm_retention.c

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "hal/etm_periph.h"
+#include "etm_retention.h"
 #include "soc/soc_etm_reg.h"
 
 /**

components/esp_hw_support/port/esp32c6/etm_retention.c

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "hal/etm_periph.h"
+#include "etm_retention.h"
 #include "soc/soc_etm_reg.h"
 
 /**

components/esp_hw_support/port/esp32c61/etm_retention.c

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "hal/etm_periph.h"
+#include "etm_retention.h"
 #include "soc/soc_etm_reg.h"
 
 /**

components/esp_hw_support/port/esp32h2/etm_retention.c

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "hal/etm_periph.h"
+#include "etm_retention.h"
 #include "soc/soc_etm_reg.h"
 
 /**

components/esp_hw_support/port/esp32h21/etm_retention.c

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "hal/etm_periph.h"
+#include "etm_retention.h"
 #include "soc/soc_etm_reg.h"
 
 /**
@@ -19,19 +19,19 @@ static const regdma_entries_config_t etm_regdma_entries[] = {
     [0] = {
         .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x00),
                                               SOC_ETM_CH_ENA_AD0_REG, SOC_ETM_CH_ENA_AD0_SET_REG, 1, 0, 0),
-        .owner = ENTRY(0) | ENTRY(2),
+        .owner = ENTRY(0),
     },
     [1] = {
         .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x01),
                                               SOC_ETM_CH_ENA_AD1_REG, SOC_ETM_CH_ENA_AD1_SET_REG, 1, 0, 0),
-        .owner = ENTRY(0) | ENTRY(2),
+        .owner = ENTRY(0),
     },
     // backup stage: save configuration registers
     // restore stage: restore the configuration registers
     [2] = {
         .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x02),
                                               SOC_ETM_CH0_EVT_ID_REG, SOC_ETM_CH0_EVT_ID_REG, ETM_RETENTION_REGS_CNT, 0, 0),
-        .owner = ENTRY(0) | ENTRY(2),
+        .owner = ENTRY(0),
     },
 };
 

components/esp_hw_support/port/esp32h4/etm_retention.c

@@ -0,0 +1,44 @@
+/*
+ * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "etm_retention.h"
+#include "soc/soc_etm_reg.h"
+
+/**
+ * ETM Registers to be saved during sleep retention
+ * - Channel configuration registers, e.g.: SOC_ETM_CH0_EVT_ID_REG, SOC_ETM_CH0_TASK_ID_REG
+*/
+#define ETM_RETENTION_REGS_CNT ((SOC_ETM_CH49_TASK_ID_REG - SOC_ETM_CH0_EVT_ID_REG) / 4 + 1)
+
+static const regdma_entries_config_t etm_regdma_entries[] = {
+    // backup stage: save the status of enabled channels
+    // restore stage: store the enabled channels
+    [0] = {
+        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x00),
+                                              SOC_ETM_CH_ENA_AD0_REG, SOC_ETM_CH_ENA_AD0_SET_REG, 1, 0, 0),
+        .owner = ENTRY(0) | ENTRY(2),
+    },
+    [1] = {
+        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x01),
+                                              SOC_ETM_CH_ENA_AD1_REG, SOC_ETM_CH_ENA_AD1_SET_REG, 1, 0, 0),
+        .owner = ENTRY(0) | ENTRY(2),
+    },
+    // backup stage: save configuration registers
+    // restore stage: restore the configuration registers
+    [2] = {
+        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x02),
+                                              SOC_ETM_CH0_EVT_ID_REG, SOC_ETM_CH0_EVT_ID_REG, ETM_RETENTION_REGS_CNT, 0, 0),
+        .owner = ENTRY(0) | ENTRY(2),
+    },
+};
+
+const soc_etm_retention_desc_t soc_etm_retention_info[1] = {
+    [0] = {
+        .module = SLEEP_RETENTION_MODULE_ETM0,
+        .regdma_entry_array = etm_regdma_entries,
+        .array_size = ARRAY_SIZE(etm_regdma_entries)
+    },
+};

components/esp_hw_support/port/esp32p4/etm_retention.c

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "hal/etm_periph.h"
+#include "etm_retention.h"
 #include "soc/soc_etm_reg.h"
 
 /**

components/esp_hw_support/port/esp32s31/etm_retention.c

@@ -0,0 +1,44 @@
+/*
+ * SPDX-FileCopyrightText: 2025-2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "etm_retention.h"
+#include "soc/soc_etm_reg.h"
+
+/**
+ * ETM Registers to be saved during sleep retention
+ * - Channel configuration registers, e.g.: SOC_ETM_CH0_EVT_ID_REG, SOC_ETM_CH0_TASK_ID_REG
+*/
+#define ETM_RETENTION_REGS_CNT ((SOC_ETM_CH49_TASK_ID_REG - SOC_ETM_CH0_EVT_ID_REG) / 4 + 1)
+
+static const regdma_entries_config_t etm_regdma_entries[] = {
+    // backup stage: save the status of enabled channels
+    // restore stage: store the enabled channels
+    [0] = {
+        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x00),
+                                              SOC_ETM_CH_ENA_AD0_REG, SOC_ETM_CH_ENA_AD0_SET_REG, 1, 0, 0),
+        .owner = ENTRY(0) | ENTRY(2),
+    },
+    [1] = {
+        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x01),
+                                              SOC_ETM_CH_ENA_AD1_REG, SOC_ETM_CH_ENA_AD1_SET_REG, 1, 0, 0),
+        .owner = ENTRY(0) | ENTRY(2),
+    },
+    // backup stage: save configuration registers
+    // restore stage: restore the configuration registers
+    [2] = {
+        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x02),
+                                              SOC_ETM_CH0_EVT_ID_REG, SOC_ETM_CH0_EVT_ID_REG, ETM_RETENTION_REGS_CNT, 0, 0),
+        .owner = ENTRY(0) | ENTRY(2),
+    },
+};
+
+const soc_etm_retention_desc_t soc_etm_retention_info[1] = {
+    [0] = {
+        .module = SLEEP_RETENTION_MODULE_ETM0,
+        .regdma_entry_array = etm_regdma_entries,
+        .array_size = ARRAY_SIZE(etm_regdma_entries)
+    },
+};

components/esp_hw_support/test_apps/esp_hw_support_unity_tests/main/test_etm_core.c

@@ -10,7 +10,7 @@
 #include "freertos/task.h"
 #include "unity.h"
 #include "esp_etm.h"
-#include "hal/etm_periph.h"
+#include "hal/etm_ll.h"
 
 TEST_CASE("etm_channel_install_uninstall", "[etm]")
 {

components/hal/CMakeLists.txt

@@ -38,7 +38,7 @@ if(NOT esp_tee_build AND NOT BOOTLOADER_BUILD)
     list(APPEND srcs "color_hal.c")
 
     if(CONFIG_SOC_ETM_SUPPORTED)
-        list(APPEND srcs "etm_hal.c" "${target}/etm_periph.c")
+        list(APPEND srcs "etm_hal.c")
     endif()
 
     if(CONFIG_SOC_MODEM_CLOCK_IS_INDEPENDENT AND CONFIG_SOC_MODEM_CLOCK_SUPPORTED)

components/hal/esp32h4/etm_periph.c

@@ -1,44 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-#include "hal/etm_periph.h"
-#include "soc/soc_etm_reg.h"
-
-/**
- * ETM Registers to be saved during sleep retention
- * - Channel configuration registers, e.g.: SOC_ETM_CH0_EVT_ID_REG, SOC_ETM_CH0_TASK_ID_REG
-*/
-#define ETM_RETENTION_REGS_CNT ((SOC_ETM_CH49_TASK_ID_REG - SOC_ETM_CH0_EVT_ID_REG) / 4 + 1)
-
-static const regdma_entries_config_t etm_regdma_entries[] = {
-    // backup stage: save the status of enabled channels
-    // restore stage: store the enabled channels
-    [0] = {
-        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x00),
-                                              SOC_ETM_CH_ENA_AD0_REG, SOC_ETM_CH_ENA_AD0_SET_REG, 1, 0, 0),
-        .owner = ENTRY(0) | ENTRY(2),
-    },
-    [1] = {
-        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x01),
-                                              SOC_ETM_CH_ENA_AD1_REG, SOC_ETM_CH_ENA_AD1_SET_REG, 1, 0, 0),
-        .owner = ENTRY(0) | ENTRY(2),
-    },
-    // backup stage: save configuration registers
-    // restore stage: restore the configuration registers
-    [2] = {
-        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x02),
-                                              SOC_ETM_CH0_EVT_ID_REG, SOC_ETM_CH0_EVT_ID_REG, ETM_RETENTION_REGS_CNT, 0, 0),
-        .owner = ENTRY(0) | ENTRY(2),
-    },
-};
-
-const soc_etm_retention_desc_t soc_etm_retention_info[1] = {
-    [0] = {
-        .module = SLEEP_RETENTION_MODULE_ETM0,
-        .regdma_entry_array = etm_regdma_entries,
-        .array_size = ARRAY_SIZE(etm_regdma_entries)
-    },
-};

components/hal/esp32s31/etm_periph.c

@@ -1,44 +0,0 @@
-/*
- * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-#include "hal/etm_periph.h"
-#include "soc/soc_etm_reg.h"
-
-/**
- * ETM Registers to be saved during sleep retention
- * - Channel configuration registers, e.g.: SOC_ETM_CH0_EVT_ID_REG, SOC_ETM_CH0_TASK_ID_REG
- */
-#define ETM_RETENTION_REGS_CNT ((SOC_ETM_CH49_TASK_ID_REG - SOC_ETM_CH0_EVT_ID_REG) / 4 + 1)
-
-static const regdma_entries_config_t etm_regdma_entries[] = {
-    // backup stage: save the status of enabled channels
-    // restore stage: store the enabled channels
-    [0] = {
-        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x00),
-                                              SOC_ETM_CH_ENA_AD0_REG, SOC_ETM_CH_ENA_AD0_SET_REG, 1, 0, 0),
-        .owner = ENTRY(0) | ENTRY(2),
-    },
-    [1] = {
-        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x01),
-                                              SOC_ETM_CH_ENA_AD1_REG, SOC_ETM_CH_ENA_AD1_SET_REG, 1, 0, 0),
-        .owner = ENTRY(0) | ENTRY(2),
-    },
-    // backup stage: save configuration registers
-    // restore stage: restore the configuration registers
-    [2] = {
-        .config = REGDMA_LINK_CONTINUOUS_INIT(REGDMA_ETM_LINK(0x02),
-                                              SOC_ETM_CH0_EVT_ID_REG, SOC_ETM_CH0_EVT_ID_REG, ETM_RETENTION_REGS_CNT, 0, 0),
-        .owner = ENTRY(0) | ENTRY(2),
-    },
-};
-
-const soc_etm_retention_desc_t soc_etm_retention_info[1] = {
-    [0] = {
-        .module = SLEEP_RETENTION_MODULE_ETM0,
-        .regdma_entry_array = etm_regdma_entries,
-        .array_size = ARRAY_SIZE(etm_regdma_entries)
-    },
-};