From b4749b88d967be50cee59b8c9df7c21c5c3b1345 Mon Sep 17 00:00:00 2001 From: Sachin Billore Date: Tue, 17 Sep 2024 15:08:48 +0530 Subject: [PATCH] feat(APM): Add APM APIs for ESP32-C61 --- .../bootloader_support/src/bootloader_mem.c | 13 - components/hal/esp32c61/include/hal/apm_ll.h | 407 ++++++++++++++++++ .../esp32c61/include/soc/Kconfig.soc_caps.in | 8 + .../soc/esp32c61/include/soc/reg_base.h | 1 + .../soc/esp32c61/include/soc/soc_caps.h | 5 +- components/soc/esp32c61/include/soc/tee_reg.h | 2 +- 6 files changed, 421 insertions(+), 15 deletions(-) create mode 100644 components/hal/esp32c61/include/hal/apm_ll.h diff --git a/components/bootloader_support/src/bootloader_mem.c b/components/bootloader_support/src/bootloader_mem.c index 8240293bee..2a837feb56 100644 --- a/components/bootloader_support/src/bootloader_mem.c +++ b/components/bootloader_support/src/bootloader_mem.c @@ -16,12 +16,6 @@ #include "hal/apm_hal.h" #endif -#if CONFIG_IDF_TARGET_ESP32C61 // TODO: IDF-9230 Remove the workaround when APM supported on C61! -#include "soc/hp_apm_reg.h" -#include "soc/lp_apm_reg.h" -#endif - - void bootloader_init_mem(void) { @@ -38,13 +32,6 @@ void bootloader_init_mem(void) #endif #endif -#if CONFIG_IDF_TARGET_ESP32C61 // TODO: IDF-9230 Remove the workaround when APM supported on C61! - // disable apm filter - REG_WRITE(LP_APM_FUNC_CTRL_REG, 0); - REG_WRITE(HP_APM_FUNC_CTRL_REG, 0); -#endif - - #ifdef CONFIG_BOOTLOADER_REGION_PROTECTION_ENABLE // protect memory region esp_cpu_configure_region_protection(); diff --git a/components/hal/esp32c61/include/hal/apm_ll.h b/components/hal/esp32c61/include/hal/apm_ll.h new file mode 100644 index 0000000000..664160ec2e --- /dev/null +++ b/components/hal/esp32c61/include/hal/apm_ll.h @@ -0,0 +1,407 @@ +/* + * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Apache-2.0 + */ +#pragma once + +#include +#include +#include "soc/pcr_reg.h" +#include "soc/tee_reg.h" +#include "soc/hp_apm_reg.h" +#include "soc/lp_apm_reg.h" +#include "soc/interrupts.h" + +#ifdef __cplusplus +extern "C" { +#endif + +#define APM_LL_CTRL_EXCEPTION_ID 0x0000001FU +#define APM_LL_CTRL_EXCEPTION_ID_S 18 +#define APM_LL_CTRL_EXCEPTION_ID_V 0x0000001FU +#define APM_LL_CTRL_EXCEPTION_MODE 0x00000003U +#define APM_LL_CTRL_EXCEPTION_MODE_S 16 +#define APM_LL_CTRL_EXCEPTION_MODE_V 0x00000003U +#define APM_LL_CTRL_EXCEPTION_REGION 0x0000FFFFU +#define APM_LL_CTRL_EXCEPTION_REGION_S 0 +#define APM_LL_CTRL_EXCEPTION_REGION_V 0x0000FFFFU + +#define APM_LL_HP_MAX_REGION_NUM 15 +#define APM_LL_LP_MAX_REGION_NUM 3 +#define APM_LL_MASTER_MAX 32 + +#define HP_APM_MAX_ACCESS_PATH 0x4 +#define LP_APM_MAX_ACCESS_PATH 0x1 + +#define APM_CTRL_REGION_FILTER_EN_REG(apm_ctrl) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_REGION_FILTER_EN_REG) : \ + (HP_APM_REGION_FILTER_EN_REG); \ + }) + +#define TEE_LL_MODE_CTRL_REG(master_id) (TEE_M0_MODE_CTRL_REG + 4 * (master_id)) + +#define APM_LL_REGION_ADDR_START_REG(apm_ctrl, regn_num) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_REGION0_ADDR_START_REG + 0xC * (regn_num)) : \ + (HP_APM_REGION0_ADDR_START_REG + 0xC * (regn_num)); \ + }) + +#define APM_LL_REGION_ADDR_END_REG(apm_ctrl, regn_num) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_REGION0_ADDR_END_REG + 0xC * (regn_num)) : \ + (HP_APM_REGION0_ADDR_END_REG + 0xC * (regn_num)); \ + }) + +#define APM_LL_REGION_ADDR_ATTR_REG(apm_ctrl, regn_num) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_REGION0_ATTR_REG + 0xC * (regn_num)) : \ + (HP_APM_REGION0_ATTR_REG + 0xC * (regn_num)); \ + }) + +#define APM_LL_APM_CTRL_EXCP_STATUS_REG(apm_ctrl, apm_m_path) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_M0_STATUS_REG + 0x10 * (apm_m_path)) : \ + (HP_APM_M0_STATUS_REG + 0x10 * (apm_m_path)); \ + }) + +#define APM_CTRL_M_REGION_STATUS_CLR (BIT(0)) +#define APM_LL_APM_CTRL_EXCP_CLR_REG(apm_ctrl, apm_m_path) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_M0_STATUS_CLR_REG + 0x10 * (apm_m_path)) : \ + (HP_APM_M0_STATUS_CLR_REG + 0x10 * (apm_m_path)); \ + }) + +#define APM_LL_TEE_EXCP_INFO0_REG(apm_ctrl, apm_m_path) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_M0_EXCEPTION_INFO0_REG + 0x10 * (apm_m_path)) : \ + (HP_APM_M0_EXCEPTION_INFO0_REG + 0x10 * (apm_m_path)); \ + }) + +#define APM_LL_APM_CTRL_EXCP_STATUS_REG(apm_ctrl, apm_m_path) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_M0_STATUS_REG + 0x10 * (apm_m_path)) : \ + (HP_APM_M0_STATUS_REG + 0x10 * (apm_m_path)); \ + }) + +#define APM_LL_TEE_EXCP_INFO1_REG(apm_ctrl, apm_m_path) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_M0_EXCEPTION_INFO1_REG + 0x10 * (apm_m_path)) : \ + (HP_APM_M0_EXCEPTION_INFO1_REG + 0x10 * (apm_m_path)); \ + }) + +#define APM_LL_SEC_MODE_REGION_ATTR(sec_mode, regn_pms) ((regn_pms) << (4 * (sec_mode - 1))) +#define APM_LL_SEC_MODE_REGION_ATTR_V 0x00000003U +#define APM_LL_SEC_MODE_REGION_ATTR_M(sec_mode) (APM_LL_SEC_MODE_REGION_ATTR_V << (4 * (sec_mode - 1))) + +#define APM_LL_APM_CTRL_INT_EN_REG(apm_ctrl) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_INT_EN_REG) : \ + (HP_APM_INT_EN_REG); \ + }) + +#define APM_CTRL_CLK_EN (BIT(0)) +#define APM_LL_APM_CTRL_CLOCK_GATE_REG(apm_ctrl) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_CLOCK_GATE_REG) : \ + (HP_APM_CLOCK_GATE_REG); \ + }) + +#define APM_LL_APM_CTRL_FUNC_CTRL_REG(apm_ctrl) \ + ({\ + (LP_APM_CTRL == apm_ctrl) ? (LP_APM_FUNC_CTRL_REG) : \ + (HP_APM_FUNC_CTRL_REG); \ + }) + +/** + * @brief APM Master ID + */ +typedef enum { + APM_LL_MASTER_HPCORE = 0, + APM_LL_MASTER_LPCORE = 1, + APM_LL_MASTER_REGDMA = 2, + APM_LL_MASTER_SDIOSLV = 3, + APM_LL_MASTER_MODEM = 4, + APM_LL_MASTER_MEM_MONITOR = 5, + APM_LL_MASTER_TRACE = 6, + APM_LL_MASTER_GDMA = 16, // The beginning of GDMA master ID + APM_LL_MASTER_GDMA_SPI2 = 16, + APM_LL_MASTER_GDMA_UHCI0 = 18, + APM_LL_MASTER_GDMA_I2S0 = 19, + APM_LL_MASTER_GDMA_AES = 22, + APM_LL_MASTER_GDMA_SHA = 23, + APM_LL_MASTER_GDMA_ADC = 24, + APM_LL_MASTER_GDMA_PARLIO = 25, +} apm_ll_master_id_t; + +/** + * @brief APM Controller + */ +typedef enum { + LP_APM_CTRL = 0, + HP_APM_CTRL = 1, +} apm_ll_apm_ctrl_t; + +/** + * @brief APM Secure Mode + */ +typedef enum { + APM_LL_SECURE_MODE_TEE = 0, /* Trusted execution environment mode */ + APM_LL_SECURE_MODE_REE0 = 1, /* Rich execution environment mode0 */ + APM_LL_SECURE_MODE_REE1 = 2, /* Rich execution environment mode1 */ + APM_LL_SECURE_MODE_REE2 = 3, /* Rich execution environment mode2 */ +} apm_ll_secure_mode_t; + +/** + * @brief APM Ctrl access path + */ +typedef enum { + APM_CTRL_ACCESS_PATH_M0 = 0x0, + APM_CTRL_ACCESS_PATH_M1 = 0x1, + APM_CTRL_ACCESS_PATH_M2 = 0x2, + APM_CTRL_ACCESS_PATH_M3 = 0x3, +} apm_ll_ctrl_access_path_t; + +/** + * @brief APM Ctrl path. + */ +typedef struct { + apm_ll_apm_ctrl_t apm_ctrl; /* APM Ctrl: LP APM/HP APM. */ + apm_ll_ctrl_access_path_t apm_m_path; /* APM Ctrl access path M[0:n]. */ +} apm_ctrl_path_t; + +/** + * @brief APM exception information + */ +typedef struct { + apm_ctrl_path_t apm_path; + uint8_t excp_regn; + uint8_t excp_mode; + uint8_t excp_id; + uint8_t excp_type; + uint32_t excp_addr; +} apm_ctrl_exception_info_t; + +/** + * @brief Set secure mode + * + * @param apm_ctrl APM Ctrl (LP_APM/HP_APM) + * @param master_id APM master ID + * @param sec_mode Secure mode + */ +static inline void apm_tee_ll_set_master_secure_mode(apm_ll_apm_ctrl_t apm_ctrl, apm_ll_master_id_t master_id, + apm_ll_secure_mode_t sec_mode) +{ + if (apm_ctrl == HP_APM_CTRL) { + REG_WRITE(TEE_LL_MODE_CTRL_REG(master_id), sec_mode); + } +} + +/** + * @brief TEE controller clock auto gating enable + * + * @param enable Flag for HP clock auto gating enable/disable + */ +static inline void apm_tee_ll_clk_gating_enable(bool enable) +{ + if (enable) { + REG_SET_BIT(TEE_CLOCK_GATE_REG, TEE_CLK_EN); + } else { + REG_CLR_BIT(TEE_CLOCK_GATE_REG, TEE_CLK_EN); + } +} + +/** + * @brief enable/disable APM Ctrl Region access permission filter + * + * @param apm_ctrl APM Ctrl (LP_APM/HP_APM) + * @param regn_num Memory Region number + * @param enable Flag for Region access filter enable/disable + */ +static inline void apm_ll_apm_ctrl_region_filter_enable(apm_ll_apm_ctrl_t apm_ctrl, + uint32_t regn_num, bool enable) +{ + if (enable) { + REG_SET_BIT(APM_CTRL_REGION_FILTER_EN_REG(apm_ctrl), BIT(regn_num)); + } else { + REG_CLR_BIT(APM_CTRL_REGION_FILTER_EN_REG(apm_ctrl), BIT(regn_num)); + } +} + +/** + * @brief enable/disable APM Ctrl access path(M[0:n]) + * + * @param apm_ctrl APM Ctrl (LP_APM/HP_APM) + * @param apm_m_path APM Ctrl access path + * @param enable Flag for APM Ctrl M path filter enable/disable + */ +static inline void apm_ll_apm_ctrl_filter_enable(apm_ll_apm_ctrl_t apm_ctrl, + apm_ll_ctrl_access_path_t apm_m_path, bool enable) +{ + if (enable) { + REG_SET_BIT(APM_LL_APM_CTRL_FUNC_CTRL_REG(apm_ctrl), BIT(apm_m_path)); + } else { + REG_CLR_BIT(APM_LL_APM_CTRL_FUNC_CTRL_REG(apm_ctrl), BIT(apm_m_path)); + } +} + +/** + * @brief APM Ctrl Region start address configuration + * + * @param apm_ctrl APM Ctrl (LP_APM/HP_APM) + * @param regn_num Region number to be configured + * @param addr Region start address + */ +static inline void apm_ll_apm_ctrl_set_region_start_address(apm_ll_apm_ctrl_t apm_ctrl, + uint32_t regn_num, uint32_t addr) +{ + REG_WRITE(APM_LL_REGION_ADDR_START_REG(apm_ctrl, regn_num), addr); +} + +/** + * @brief APM Ctrl Region end address configuration + * + * @param apm_ctrl APM Ctrl (LP_APM/HP_APM) + * @param regn_num Region number to be configured + * @param addr Region end address + */ +static inline void apm_ll_apm_ctrl_set_region_end_address(apm_ll_apm_ctrl_t apm_ctrl, + uint32_t regn_num, uint32_t addr) +{ + REG_WRITE(APM_LL_REGION_ADDR_END_REG(apm_ctrl, regn_num), addr); +} + +/** + * @brief HP Region pms attributes configuration + * + * @param apm_ctrl APM Ctrl (LP_APM/HP_APM) + * @param regn_num Region number to be configured + * @param sec_mode Secure mode of the Master + * @param regn_pms XWR permissions for the given secure mode and Region number + */ +static inline void apm_ll_apm_ctrl_sec_mode_region_attr_config(apm_ll_apm_ctrl_t apm_ctrl, + uint32_t regn_num, apm_ll_secure_mode_t sec_mode, uint32_t regn_pms) +{ + uint32_t val = 0; + val = REG_READ(APM_LL_REGION_ADDR_ATTR_REG(apm_ctrl, regn_num)); + val &= ~APM_LL_SEC_MODE_REGION_ATTR_M(sec_mode); + val |= APM_LL_SEC_MODE_REGION_ATTR(sec_mode, regn_pms); + REG_WRITE(APM_LL_REGION_ADDR_ATTR_REG(apm_ctrl, regn_num), val); +} + +/** + * @brief Get APM Ctrl access path(M[0:n]) exception status + * + * @param apm_ctrl APM Ctrl (LP_APM/HP_APM) + * @param apm_m_path APM Ctrl access path + */ +static inline uint8_t apm_ll_apm_ctrl_exception_status(apm_ll_apm_ctrl_t apm_ctrl, + apm_ll_ctrl_access_path_t apm_m_path) +{ + return REG_READ(APM_LL_APM_CTRL_EXCP_STATUS_REG(apm_ctrl, apm_m_path)); +} + +/** + * @brief Clear APM Ctrl access path(M[0:n]) exception + * + * @param apm_ctrl APM Ctrl (LP_APM/HP_APM) + * @param amp_m_path APM Ctrl access path + */ +static inline void apm_ll_apm_ctrl_exception_clear(apm_ll_apm_ctrl_t apm_ctrl, + apm_ll_ctrl_access_path_t apm_m_path) +{ + REG_SET_BIT(APM_LL_APM_CTRL_EXCP_CLR_REG(apm_ctrl, apm_m_path), + APM_CTRL_M_REGION_STATUS_CLR); +} + +/** + * @brief Get APM Ctrl access path(M[0:n]) exception information + * + * @param excp_info Exception related information like addr, + * region, apm_ctrl, apm_m_path, sec_mode and master id + */ +static inline void apm_ll_apm_ctrl_get_exception_info(apm_ctrl_exception_info_t *excp_info) +{ + excp_info->excp_id = REG_GET_FIELD(APM_LL_TEE_EXCP_INFO0_REG(excp_info->apm_path.apm_ctrl, excp_info->apm_path.apm_m_path), + APM_LL_CTRL_EXCEPTION_ID); + excp_info->excp_mode = REG_GET_FIELD(APM_LL_TEE_EXCP_INFO0_REG(excp_info->apm_path.apm_ctrl, excp_info->apm_path.apm_m_path), + APM_LL_CTRL_EXCEPTION_MODE); + excp_info->excp_regn = REG_GET_FIELD(APM_LL_TEE_EXCP_INFO0_REG(excp_info->apm_path.apm_ctrl, excp_info->apm_path.apm_m_path), + APM_LL_CTRL_EXCEPTION_REGION); + excp_info->excp_type = apm_ll_apm_ctrl_exception_status(excp_info->apm_path.apm_ctrl, excp_info->apm_path.apm_m_path); + excp_info->excp_addr = REG_READ(APM_LL_TEE_EXCP_INFO1_REG(excp_info->apm_path.apm_ctrl, excp_info->apm_path.apm_m_path)); +} + +/** + * @brief Interrupt enable for APM Ctrl at access path(M[0:n]) + * + * @param apm_ctrl APM Ctrl (LP_APM/HP_APM) + * @param apm_m_path APM Ctrl access patch(M[0:n]) + * @param enable Flag for access path interrupt enable/disable + */ +static inline void apm_ll_apm_ctrl_interrupt_enable(apm_ll_apm_ctrl_t apm_ctrl, + apm_ll_ctrl_access_path_t apm_m_path, bool enable) +{ + if (enable) { + REG_SET_BIT(APM_LL_APM_CTRL_INT_EN_REG(apm_ctrl), BIT(apm_m_path)); + } else { + REG_CLR_BIT(APM_LL_APM_CTRL_INT_EN_REG(apm_ctrl), BIT(apm_m_path)); + } +} + +/** + * @brief APM Ctrl clock auto gating enable + * + * @param apm_ctrl APM Ctrl (LP_APM/HP_APM) + * @param enable Flag for HP clock auto gating enable/disable + */ +static inline void apm_ll_apm_ctrl_clk_gating_enable(apm_ll_apm_ctrl_t apm_ctrl, bool enable) +{ + if (enable) { + REG_SET_BIT(APM_LL_APM_CTRL_CLOCK_GATE_REG(apm_ctrl), APM_CTRL_CLK_EN); + } else { + REG_CLR_BIT(APM_LL_APM_CTRL_CLOCK_GATE_REG(apm_ctrl), APM_CTRL_CLK_EN); + } +} + +/** + * @brief APM/TEE/HP System Reg reset event bypass enable + * + * Disable: tee_reg/apm_reg/hp_system_reg will not only be reset by power-reset, + * but also some reset events. + * Enable: tee_reg/apm_reg/hp_system_reg will only be reset by power-reset. + * Some reset events will be bypassed. + * + * @param enable Flag for event bypass enable/disable + */ +static inline void apm_ll_apm_ctrl_reset_event_enable(bool enable) +{ + if (enable) { + REG_SET_BIT(PCR_RESET_EVENT_BYPASS_REG, PCR_RESET_EVENT_BYPASS_APM); + } else { + REG_CLR_BIT(PCR_RESET_EVENT_BYPASS_REG, PCR_RESET_EVENT_BYPASS_APM); + } +} + +/** + * @brief Fetch the APM Ctrl interrupt source number. + * + * @param apm_ctrl APM Ctrl (LP_APM0/HP_APM/LP_APM) + * @param apm_m_path APM Ctrl access patch(M[0:n]) + */ +static inline int apm_ll_apm_ctrl_get_int_src_num(apm_ll_apm_ctrl_t apm_ctrl, apm_ll_ctrl_access_path_t apm_m_path) +{ + switch (apm_ctrl) { + case HP_APM_CTRL : + return (ETS_HP_APM_M0_INTR_SOURCE + apm_m_path); + case LP_APM_CTRL : + return (ETS_LP_APM_M0_INTR_SOURCE + apm_m_path); + } + + return -1; +} + +#ifdef __cplusplus +} +#endif diff --git a/components/soc/esp32c61/include/soc/Kconfig.soc_caps.in b/components/soc/esp32c61/include/soc/Kconfig.soc_caps.in index 5288c73e64..8eb34b5134 100644 --- a/components/soc/esp32c61/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32c61/include/soc/Kconfig.soc_caps.in @@ -87,6 +87,10 @@ config SOC_BOD_SUPPORTED bool default y +config SOC_APM_SUPPORTED + bool + default y + config SOC_PMU_SUPPORTED bool default y @@ -679,6 +683,10 @@ config SOC_FLASH_ENCRYPTION_XTS_AES_128 bool default y +config SOC_APM_CTRL_FILTER_SUPPORTED + bool + default y + config SOC_CRYPTO_DPA_PROTECTION_SUPPORTED bool default y diff --git a/components/soc/esp32c61/include/soc/reg_base.h b/components/soc/esp32c61/include/soc/reg_base.h index 9bdde4117d..c3c302b592 100644 --- a/components/soc/esp32c61/include/soc/reg_base.h +++ b/components/soc/esp32c61/include/soc/reg_base.h @@ -61,3 +61,4 @@ #define DR_REG_INTPRI_BASE 0x600C5000 #define DR_REG_CACHE_BASE 0x600C8000 #define DR_REG_CLINT_M_BASE 0x20000000 +#define DR_REG_TEE_BASE DR_REG_TEE_REG_BASE diff --git a/components/soc/esp32c61/include/soc/soc_caps.h b/components/soc/esp32c61/include/soc/soc_caps.h index a4fb3372dd..935a9adf68 100644 --- a/components/soc/esp32c61/include/soc/soc_caps.h +++ b/components/soc/esp32c61/include/soc/soc_caps.h @@ -45,7 +45,7 @@ #define SOC_FLASH_ENC_SUPPORTED 1 #define SOC_SECURE_BOOT_SUPPORTED 1 #define SOC_BOD_SUPPORTED 1 -// \#define SOC_APM_SUPPORTED 1 //TODO: [ESP32C61] IDF-9230 +#define SOC_APM_SUPPORTED 1 /*!< Support for APM peripheral */ #define SOC_PMU_SUPPORTED 1 #define SOC_LP_TIMER_SUPPORTED 1 // \#define SOC_LP_AON_SUPPORTED 1 @@ -374,6 +374,9 @@ #define SOC_FLASH_ENCRYPTION_XTS_AES 1 #define SOC_FLASH_ENCRYPTION_XTS_AES_128 1 +/*-------------------------- APM CAPS ----------------------------------------*/ +#define SOC_APM_CTRL_FILTER_SUPPORTED 1 /*!< Support for APM control filter */ + /*------------------------ Anti DPA (Security) CAPS --------------------------*/ #define SOC_CRYPTO_DPA_PROTECTION_SUPPORTED 1 diff --git a/components/soc/esp32c61/include/soc/tee_reg.h b/components/soc/esp32c61/include/soc/tee_reg.h index 1de464f98d..2a9cca5270 100644 --- a/components/soc/esp32c61/include/soc/tee_reg.h +++ b/components/soc/esp32c61/include/soc/tee_reg.h @@ -768,7 +768,7 @@ extern "C" { /** TEE_DATE_REG : R/W; bitpos: [27:0]; default: 35725664; * Version control register */ -#define TEE_DATE_REG 0x0FFFFFFFU +#define TEE_DATE 0x0FFFFFFFU #define TEE_DATE_REG_M (TEE_DATE_REG_V << TEE_DATE_REG_S) #define TEE_DATE_REG_V 0x0FFFFFFFU #define TEE_DATE_REG_S 0