chore: import upstream snapshot with attribution

components/bootloader_support/include/bootloader_memory_utils.h

@@ -0,0 +1,256 @@
+/*
+ * SPDX-FileCopyrightText: 2010-2026 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+#include <stdlib.h>
+#include <stdint.h>
+#include <stdbool.h>
+
+#include "soc/soc.h"
+#include "soc/ext_mem_defs.h"
+#include "soc/soc_caps.h"
+#include "sdkconfig.h"
+#include "esp_attr.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** The content of this file is to be kept in sync with the common section of esp_memory_utils.h **/
+
+/**
+ * @brief Check if the IRAM and DRAM are separate or using the same memory space
+ *
+ * @return true if the DRAM and IRAM are sharing the same memory space, false otherwise
+ */
+__attribute__((always_inline))
+inline static bool esp_dram_match_iram(void) {
+    return ((SOC_DRAM_LOW == SOC_IRAM_LOW) && (SOC_DRAM_HIGH == SOC_IRAM_HIGH));
+}
+
+/**
+ * @brief Check if the RTC IRAM and RTC DRAM are separate or using the same memory space
+ *
+ * @return true if the RTC DRAM and RTC IRAM are sharing the same memory space, false otherwise
+ */
+__attribute__((always_inline))
+inline static bool esp_rtc_dram_match_rtc_iram(void) {
+#if SOC_RTC_FAST_MEM_SUPPORTED
+    return ((SOC_RTC_IRAM_LOW == SOC_RTC_DRAM_LOW) && (SOC_RTC_IRAM_HIGH == SOC_RTC_DRAM_HIGH));
+#else
+    return false;
+#endif
+}
+
+/**
+ * @brief Check if the pointer is in iram
+ *
+ * @param p pointer
+ *
+ * @return true: is in iram; false: not in iram
+ */
+__attribute__((always_inline))
+inline static bool esp_ptr_in_iram(const void *p) {
+#if CONFIG_IDF_TARGET_ESP32 && CONFIG_ESP_SYSTEM_SINGLE_CORE_MODE
+    return ((intptr_t)p >= SOC_CACHE_APP_LOW && (intptr_t)p < SOC_IRAM_HIGH);
+#else
+    return ((intptr_t)p >= SOC_IRAM_LOW && (intptr_t)p < SOC_IRAM_HIGH);
+#endif
+}
+
+/**
+ * @brief Check if the pointer is in dram
+ *
+ * @param p pointer
+ *
+ * @return true: is in dram; false: not in dram
+ */
+__attribute__((always_inline))
+inline static bool esp_ptr_in_dram(const void *p) {
+    return ((intptr_t)p >= SOC_DRAM_LOW && (intptr_t)p < SOC_DRAM_HIGH);
+}
+
+/**
+ * @brief Check if the pointer is in diram_dram
+ *
+ * @param p pointer
+ *
+ * @return true: is in diram_dram; false: not in diram_dram
+ */
+__attribute__((always_inline))
+inline static bool esp_ptr_in_diram_dram(const void *p) {
+    return ((intptr_t)p >= SOC_DIRAM_DRAM_LOW && (intptr_t)p < SOC_DIRAM_DRAM_HIGH);
+}
+
+/**
+ * @brief Check if the pointer is in diram_iram
+ *
+ * @param p pointer
+ *
+ * @return true: is in diram_iram; false: not in diram_iram
+ */
+__attribute__((always_inline))
+inline static bool esp_ptr_in_diram_iram(const void *p) {
+// TODO: IDF-5980 esp32c6 D/I RAM share the same address
+#if SOC_DIRAM_IRAM_LOW == SOC_DIRAM_DRAM_LOW
+    (void)p;
+    return false;
+#else
+    return ((intptr_t)p >= SOC_DIRAM_IRAM_LOW && (intptr_t)p < SOC_DIRAM_IRAM_HIGH);
+#endif
+}
+
+/**
+ * @brief Check if the pointer is in rtc_iram_fast
+ *
+ * @param p pointer
+ *
+ * @return true: is in rtc_iram_fast; false: not in rtc_iram_fast
+ */
+__attribute__((always_inline))
+inline static bool esp_ptr_in_rtc_iram_fast(const void *p) {
+#if SOC_RTC_FAST_MEM_SUPPORTED
+    return ((intptr_t)p >= SOC_RTC_IRAM_LOW && (intptr_t)p < SOC_RTC_IRAM_HIGH);
+#else
+    (void)p;
+    return false;
+#endif
+}
+
+/**
+ * @brief Check if the pointer is in rtc_dram_fast
+ *
+ * @param p pointer
+ *
+ * @return true: is in rtc_dram_fast; false: not in rtc_dram_fast
+ */
+__attribute__((always_inline))
+inline static bool esp_ptr_in_rtc_dram_fast(const void *p) {
+#if SOC_RTC_FAST_MEM_SUPPORTED
+    return ((intptr_t)p >= SOC_RTC_DRAM_LOW && (intptr_t)p < SOC_RTC_DRAM_HIGH);
+#else
+    (void)p;
+    return false;
+#endif
+}
+
+/**
+ * @brief Check if the pointer is in rtc_slow
+ *
+ * @param p pointer
+ *
+ * @return true: is in rtc_slow; false: not in rtc_slow
+ */
+__attribute__((always_inline))
+inline static bool esp_ptr_in_rtc_slow(const void *p) {
+#if SOC_RTC_SLOW_MEM_SUPPORTED
+    return ((intptr_t)p >= SOC_RTC_DATA_LOW && (intptr_t)p < SOC_RTC_DATA_HIGH);
+#else
+    return false;
+#endif
+}
+
+
+/* Convert a D/IRAM DRAM pointer to equivalent word address in IRAM
+
+   - Address must be word aligned
+   - Address must pass esp_ptr_in_diram_dram() test, or result will be invalid pointer
+*/
+__attribute__((always_inline))
+inline static void * esp_ptr_diram_dram_to_iram(const void *p) {
+#if SOC_DIRAM_INVERTED
+    return (void *) ( SOC_DIRAM_IRAM_LOW + (SOC_DIRAM_DRAM_HIGH - (intptr_t)p) - 4);
+#else
+    return (void *) ( SOC_DIRAM_IRAM_LOW + ((intptr_t)p - SOC_DIRAM_DRAM_LOW) );
+#endif
+}
+
+/* Convert a RTC DRAM pointer to equivalent word address in RTC IRAM
+
+   - Address must be word aligned
+   - Address must pass esp_ptr_in_rtc_dram_fast() test, or result will be invalid pointer
+*/
+__attribute__((always_inline))
+inline static void * esp_ptr_rtc_dram_to_iram(const void *p) {
+    intptr_t ptr = (intptr_t)p;
+#if SOC_RTC_FAST_MEM_SUPPORTED && (SOC_RTC_IRAM_LOW != SOC_RTC_DRAM_LOW)
+    return (void *) ( SOC_RTC_IRAM_LOW + (ptr - SOC_RTC_DRAM_LOW) );
+#else
+    return (void *) ptr;
+#endif
+}
+
+/* Convert a D/IRAM IRAM pointer to equivalent word address in DRAM
+
+   - Address must be word aligned
+   - Address must pass esp_ptr_in_diram_iram() test, or result will be invalid pointer
+*/
+__attribute__((always_inline))
+inline static void * esp_ptr_diram_iram_to_dram(const void *p) {
+#if SOC_DIRAM_INVERTED
+    return (void *) ( SOC_DIRAM_DRAM_LOW + (SOC_DIRAM_IRAM_HIGH - (intptr_t)p) - 4);
+#else
+    return (void *) ( SOC_DIRAM_DRAM_LOW + ((intptr_t)p - SOC_DIRAM_IRAM_LOW) );
+#endif
+}
+
+#if SOC_MEM_SPM_SUPPORTED
+/**
+ * @brief Check if the pointer is in TCM (SPM)
+ *
+ * @param p pointer
+ *
+ * @return true: is in TCM (SPM); false: not in TCM (SPM)
+ */
+ __attribute__((always_inline, deprecated("esp_ptr_in_tcm is deprecated, please use esp_ptr_in_spm instead")))
+inline static bool esp_ptr_in_tcm(const void *p) {
+    return ((intptr_t)p >= SOC_SPM_LOW && (intptr_t)p < SOC_SPM_HIGH);
+}
+
+/**
+ * @brief Check if the pointer is in SPM
+ *
+ * @param p pointer
+ *
+ * @return true: is in SPM; false: not in SPM
+ */
+ __attribute__((always_inline))
+ inline static bool esp_ptr_in_spm(const void *p) {
+     return ((intptr_t)p >= SOC_SPM_LOW && (intptr_t)p < SOC_SPM_HIGH);
+ }
+#endif  //#if SOC_MEM_SPM_SUPPORTED
+
+/** End of the common section that has to be in sync with esp_memory_utils.h **/
+
+/**
+ * @brief Check if the pointer is in PSRAM vaddr space
+ *
+ * @note This function is only used when in bootloader, where the PSRAM isn't initialised.
+ *       This function simply check if the pointer is the in the PSRAM vaddr space.
+ *       The PSRAM vaddr space is not always the same as the actual PSRAM vaddr range used in APP
+ *
+ * @param p pointer
+ *
+ * @return true: is in PSRAM; false: not in PSRAM
+ */
+__attribute__((always_inline))
+inline static bool esp_ptr_in_extram(const void *p) {
+    bool valid = false;
+#if SOC_IRAM_PSRAM_ADDRESS_LOW
+    valid |= ((intptr_t)p >= SOC_IRAM_PSRAM_ADDRESS_LOW && (intptr_t)p < SOC_IRAM_PSRAM_ADDRESS_HIGH);
+#endif
+
+#if SOC_DRAM_PSRAM_ADDRESS_LOW
+    valid |= ((intptr_t)p >= SOC_DRAM_PSRAM_ADDRESS_LOW && (intptr_t)p < SOC_DRAM_PSRAM_ADDRESS_HIGH);
+#endif
+    return valid;
+}
+
+/** Don't add new functions below **/
+
+#ifdef __cplusplus
+}
+#endif