Merge branch 'feature/clean_up_retention_context_definitions' into 'master'

refactor(esp_hw_support): move sleep retention context definition to soc target folder

Closes PM-10

See merge request espressif/esp-idf!26753

components/soc/esp32c6/include/soc/retention_periph_defs.h

@@ -0,0 +1,44 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include <stdint.h>
+#include "esp_bit_defs.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef enum periph_retention_module_bitmap {
+    /* clock module, which includes system and modem */
+    SLEEP_RETENTION_MODULE_CLOCK_SYSTEM = BIT(1),
+    SLEEP_RETENTION_MODULE_CLOCK_MODEM  = BIT(2),
+
+    /* modem module, which includes WiFi, BLE and 802.15.4 */
+    SLEEP_RETENTION_MODULE_WIFI_MAC     = BIT(10),
+    SLEEP_RETENTION_MODULE_WIFI_BB      = BIT(11),
+    SLEEP_RETENTION_MODULE_BLE_MAC      = BIT(12),
+    SLEEP_RETENTION_MODULE_BT_BB        = BIT(13),
+    SLEEP_RETENTION_MODULE_802154_MAC   = BIT(14),
+
+    /* digital peripheral module, which includes Interrupt Matrix, HP_SYSTEM,
+     * TEE, APM, UART, Timer Group, IOMUX, SPIMEM, SysTimer, etc.. */
+    SLEEP_RETENTION_MODULE_INTR_MATRIX  = BIT(16),
+    SLEEP_RETENTION_MODULE_HP_SYSTEM    = BIT(17),
+    SLEEP_RETENTION_MODULE_TEE_APM      = BIT(18),
+    SLEEP_RETENTION_MODULE_UART0        = BIT(19),
+    SLEEP_RETENTION_MODULE_TG0          = BIT(20),
+    SLEEP_RETENTION_MODULE_IOMUX        = BIT(21),
+    SLEEP_RETENTION_MODULE_SPIMEM       = BIT(22),
+    SLEEP_RETENTION_MODULE_SYSTIMER     = BIT(23),
+
+    SLEEP_RETENTION_MODULE_ALL          = (uint32_t)-1
+} periph_retention_module_bitmap_t;
+
+#ifdef __cplusplus
+}
+#endif

components/soc/esp32c6/include/soc/system_periph_retention.h

@@ -0,0 +1,102 @@
+/*
+ * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+
+#include <stdint.h>
+#include "soc/soc_caps.h"
+#include "soc/regdma.h"
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+/**
+ * @brief Provide access to interrupt matrix configuration registers retention
+ * context defination.
+ *
+ * This is an internal function of the sleep retention driver, and is not
+ * useful for external use.
+ */
+#define INT_MTX_RETENTION_LINK_LEN   1
+extern const regdma_entries_config_t intr_matrix_regs_retention[INT_MTX_RETENTION_LINK_LEN];
+
+/**
+ * @brief Provide access to hp_system configuration registers retention
+ * context defination.
+ *
+ * This is an internal function of the sleep retention driver, and is not
+ * useful for external use.
+ */
+#define HP_SYSTEM_RETENTION_LINK_LEN 1
+extern const regdma_entries_config_t hp_system_regs_retention[HP_SYSTEM_RETENTION_LINK_LEN];
+
+/**
+ * @brief Provide access to TEE_APM configuration registers retention
+ * context defination.
+ *
+ * This is an internal function of the sleep retention driver, and is not
+ * useful for external use.
+ */
+#define TEE_APM_RETENTION_LINK_LEN   2
+extern const regdma_entries_config_t tee_apm_regs_retention[TEE_APM_RETENTION_LINK_LEN];
+#define TEE_APM_HIGH_PRI_RETENTION_LINK_LEN   1
+extern const regdma_entries_config_t tee_apm_highpri_regs_retention[TEE_APM_HIGH_PRI_RETENTION_LINK_LEN];
+
+/**
+ * @brief Provide access to uart configuration registers retention
+ * context defination.
+ *
+ * This is an internal function of the sleep retention driver, and is not
+ * useful for external use.
+ */
+#define UART_RETENTION_LINK_LEN     3
+extern const regdma_entries_config_t uart_regs_retention[UART_RETENTION_LINK_LEN];
+
+/**
+ * @brief Provide access to timer group configuration registers retention
+ * context defination.
+ *
+ * This is an internal function of the sleep retention driver, and is not
+ * useful for external use.
+ */
+#define TIMG_RETENTION_LINK_LEN     8
+extern const regdma_entries_config_t tg_regs_retention[TIMG_RETENTION_LINK_LEN];
+
+/**
+ * @brief Provide access to IOMUX configuration registers retention
+ * context defination.
+ *
+ * This is an internal function of the sleep retention driver, and is not
+ * useful for external use.
+ */
+#define IOMUX_RETENTION_LINK_LEN    4
+extern const regdma_entries_config_t iomux_regs_retention[IOMUX_RETENTION_LINK_LEN];
+
+/**
+ * @brief Provide access to spimem configuration registers retention
+ * context defination.
+ *
+ * This is an internal function of the sleep retention driver, and is not
+ * useful for external use.
+ */
+#define SPIMEM_RETENTION_LINK_LEN   8
+extern const regdma_entries_config_t spimem_regs_retention[SPIMEM_RETENTION_LINK_LEN];
+
+/**
+ * @brief Provide access to systimer configuration registers retention
+ * context defination.
+ *
+ * This is an internal function of the sleep retention driver, and is not
+ * useful for external use.
+ */
+#define SYSTIMER_RETENTION_LINK_LEN   19
+extern const regdma_entries_config_t systimer_regs_retention[SYSTIMER_RETENTION_LINK_LEN];
+
+#ifdef __cplusplus
+}
+#endif