Merge branch 'refactor/update_lpperi_regs_for_h2_eco5_v5.4' into 'release/v5.4'

refactor(lpperi): compatible refactor for H2 ECO5 (v5.4)

See merge request espressif/esp-idf!36335

Author: suda-morris

components/bootloader_support/src/esp32h2/bootloader_esp32h2.c

@@ -41,6 +41,7 @@
 #include "hal/lpwdt_ll.h"
 #include "soc/lp_wdt_reg.h"
 #include "soc/pmu_reg.h"
+#include "soc/lpperi_struct.h"
 #include "hal/efuse_hal.h"
 #include "hal/regi2c_ctrl_ll.h"
 #include "hal/brownout_ll.h"
@@ -108,6 +109,9 @@ esp_err_t bootloader_init(void)
 {
     esp_err_t ret = ESP_OK;
 
+    // Assign the compatible LPPERI register address in case it is used in the bootloader
+    lpperi_compatible_reg_addr_init();
+
     bootloader_hardware_init();
     bootloader_ana_reset_config();
     bootloader_super_wdt_auto_feed();

components/esp_system/port/cpu_start.c

@@ -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
  */
@@ -61,6 +61,7 @@
 #include "esp32h2/rtc.h"
 #include "esp32h2/rom/cache.h"
 #include "esp_memprot.h"
+#include "soc/lpperi_struct.h"
 #elif CONFIG_IDF_TARGET_ESP32C2
 #include "esp32c2/rtc.h"
 #include "esp32c2/rom/cache.h"
@@ -449,6 +450,13 @@ void IRAM_ATTR call_start_cpu0(void)
     }
 #endif
 
+#if CONFIG_IDF_TARGET_ESP32H2
+    // Some modules' register layout are not binary compatible among the different chip revisions,
+    // they will be wrapped into a new compatible instance which will point to the correct register address according to the revision.
+    // To ensure the compatible instance is initialized before used, the initialization is done after BBS is cleared
+    lpperi_compatible_reg_addr_init();
+#endif
+
 #if !CONFIG_APP_BUILD_TYPE_PURE_RAM_APP && !CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE && !SOC_CACHE_INTERNAL_MEM_VIA_L1CACHE
     // It helps to fix missed cache settings for other cores. It happens when bootloader is unicore.
     do_multicore_settings();

components/hal/esp32h2/include/hal/lp_clkrst_ll.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -63,7 +63,7 @@ static inline void lp_clkrst_ll_select_modem_32k_clock_source(lp_clkrst_dev_t *h
 __attribute__((always_inline))
 static inline void _lp_clkrst_ll_enable_rng_clock(bool en)
 {
-    LPPERI.clk_en.rng_ck_en = en;
+    LPPERI.clk_en->rng_ck_en = en;
 }
 
 /// LPPERI.clk_en is a shared register, so this function must be used in an atomic way

components/hal/esp32h2/include/hal/rtc_io_ll.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -38,8 +38,8 @@ typedef enum {
  */
 static inline void _rtcio_ll_enable_io_clock(bool enable)
 {
-    LPPERI.clk_en.lp_io_ck_en = enable;
-    while (LPPERI.clk_en.lp_io_ck_en != enable) {
+    LPPERI.clk_en->lp_io_ck_en = enable;
+    while (LPPERI.clk_en->lp_io_ck_en != enable) {
         ;
     }
 }

components/soc/CMakeLists.txt

@@ -27,6 +27,10 @@ if(target STREQUAL "esp32")
     list(APPEND srcs "${target_folder}/dport_access.c")
 endif()
 
+if(target STREQUAL "esp32h2")
+    list(APPEND srcs "${target_folder}/lpperi_struct.c")
+endif()
+
 if(CONFIG_SOC_ADC_SUPPORTED)
     list(APPEND srcs "${target_folder}/adc_periph.c")
 endif()

components/soc/esp32h2/include/soc/lpperi_struct.h

@@ -0,0 +1,48 @@
+/**
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ */
+
+/* For compatibility of ECO0 and ECO5 */
+
+#pragma once
+
+#include "soc/lpperi_rev0_0_struct.h"
+#include "soc/lpperi_rev1_2_struct.h"
+
+#include <stdint.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Compatible lpperi struct for ECO0-ECO4 and ECO5
+ *
+ */
+typedef struct {
+    volatile lpperi_clk_en_reg_t *clk_en;
+    volatile lpperi_reset_en_reg_t *reset_en;
+    volatile lpperi_rng_cfg_reg_t *rng_cfg;
+    volatile lpperi_rng_data_reg_t *rng_data;
+    volatile lpperi_cpu_reg_t *cpu;
+    volatile lpperi_bus_timeout_reg_t *bus_timeout;
+    volatile lpperi_bus_timeout_addr_reg_t *bus_timeout_addr;
+    volatile lpperi_bus_timeout_uid_reg_t *bus_timeout_uid;
+    volatile lpperi_mem_ctrl_reg_t *mem_ctrl;
+    volatile lpperi_interrupt_source_reg_t *interrupt_source;
+    volatile lpperi_debug_sel0_reg_t *debug_sel0;
+    volatile lpperi_debug_sel1_reg_t *debug_sel1;
+    volatile lpperi_date_reg_t *date;
+} lpperi_dev_t;
+
+extern lpperi_dev_t LPPERI;  // Compatible instance that achieved in 'lpperi_struct.c'
+
+/**
+ * @brief Initialize the LP_PERI register address according to the register version
+ */
+void lpperi_compatible_reg_addr_init(void);
+
+#ifdef __cplusplus
+}
+#endif

components/soc/esp32h2/ld/esp32h2.peripherals.ld

@@ -66,7 +66,8 @@ PROVIDE ( LP_TIMER      = 0x600B0C00 );
 PROVIDE ( LP_AON        = 0x600B1000 );
 PROVIDE ( LP_WDT        = 0x600B1C00 );
 PROVIDE ( I2C_ANA_MST   = 0x600B2400 );
-PROVIDE ( LPPERI       = 0x600B2800 );
+PROVIDE ( LPPERI_REV0_0 = 0x600B2800 );
+PROVIDE ( LPPERI_REV1_2 = 0x600B2800 );
 PROVIDE ( LP_ANA_PERI   = 0x600B2C00 );
 PROVIDE ( LP_APM        = 0x600B3800 );
 PROVIDE ( OTP_DEBUG     = 0x600B3C00 );

components/soc/esp32h2/lpperi_struct.c

@@ -0,0 +1,47 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#include <stddef.h>
+#include "assert.h"
+#include "soc/lpperi_struct.h"
+
+#define LPPERI_REV1_2_DATE   (0x2308030)
+#define LPPERI_REG_ADDR(reg) ((LPPERI_REV1_2.date.lpperi_date >= LPPERI_REV1_2_DATE) ?  \
+                              &LPPERI_REV1_2.reg :  \
+                              (volatile typeof(LPPERI_REV1_2.reg) *)&LPPERI_REV0_0.reg)
+
+/**
+ * @brief Compatible LPPERI instance
+ * @note  Set NULL as default so that to abort when use the LPPEIR before initialization
+ *        If you want to use the LPPERI before it is initialized, please use `lpperi_reg.h` instead
+ */
+lpperi_dev_t LPPERI = {};
+
+/**
+ * @brief Initialize the LP_PERI register address according to the register version
+ */
+void lpperi_compatible_reg_addr_init(void)
+{
+    LPPERI.clk_en             = LPPERI_REG_ADDR(clk_en);
+    LPPERI.reset_en           = LPPERI_REG_ADDR(reset_en);
+    LPPERI.rng_cfg            = ((LPPERI_REV1_2.date.lpperi_date >= LPPERI_REV1_2_DATE) ? &LPPERI_REV1_2.rng_cfg : NULL);
+    LPPERI.rng_data           = LPPERI_REG_ADDR(rng_data);
+    LPPERI.cpu                = LPPERI_REG_ADDR(cpu);
+    LPPERI.bus_timeout        = LPPERI_REG_ADDR(bus_timeout);
+    LPPERI.bus_timeout_addr   = LPPERI_REG_ADDR(bus_timeout_addr);
+    LPPERI.bus_timeout_uid    = LPPERI_REG_ADDR(bus_timeout_uid);
+    LPPERI.mem_ctrl           = LPPERI_REG_ADDR(mem_ctrl);
+    LPPERI.interrupt_source   = LPPERI_REG_ADDR(interrupt_source);
+    LPPERI.debug_sel0         = LPPERI_REG_ADDR(debug_sel0);
+    LPPERI.debug_sel1         = LPPERI_REG_ADDR(debug_sel1);
+    LPPERI.date               = LPPERI_REG_ADDR(date);
+}
+
+__attribute__((constructor))
+static void s_lpperi_compatible_init_check(void)
+{
+    // Make sure it is initialized
+    assert(LPPERI.clk_en != NULL);
+}