From c9c7573f715534edf19e8290bc10d2a5d134c4a8 Mon Sep 17 00:00:00 2001 From: Martin Vychodil Date: Fri, 14 Oct 2022 14:15:32 +0200 Subject: [PATCH] Storage: Partition APIs moved to the new component 'esp_partition' All the partition handling API functions and data-types were moved from the 'spi_flash' component to the new one named 'esp_partition'. See Storage 5.x migration guide for more details --- .gitlab/CODEOWNERS | 1 + .gitlab/ci/host-test.yml | 2 +- components/app_update/CMakeLists.txt | 4 +- components/app_update/esp_ota_ops.c | 7 ++- .../app_update/test_apps/main/CMakeLists.txt | 5 ++- components/driver/test/CMakeLists.txt | 2 +- components/driver/test/test_spi_bus_lock.c | 1 + components/esp_hw_support/test/CMakeLists.txt | 2 +- .../esp_partition/.build-test-rules.yml | 6 +++ components/esp_partition/CMakeLists.txt | 30 +++++++++++++ .../partition_api_test/CMakeLists.txt | 0 .../host_test/partition_api_test/README.md | 0 .../partition_api_test/main/CMakeLists.txt | 2 + .../main/partition_api_test.c | 2 +- .../partition_api_test/partition_table.csv | 0 .../partition_api_test/sdkconfig.defaults | 0 .../include/esp_partition.h | 43 +++++++++++++++---- .../include/esp_private/partition_linux.h | 3 ++ .../{spi_flash => esp_partition}/partition.c | 16 ++++++- .../partition_linux.c | 4 +- .../partition_target.c | 11 +++-- components/esp_partition/test/CMakeLists.txt | 4 ++ .../test/test_partition.c | 8 ++-- .../test/test_partition_ext.c | 6 +++ .../test/test_partitions.c | 2 + .../test_apps/psram/main/test_psram.c | 2 + components/esp_system/CMakeLists.txt | 4 +- components/esp_timer/test/CMakeLists.txt | 2 +- components/espcoredump/CMakeLists.txt | 2 +- .../fatfs/test_fatfs_host/Makefile.files | 1 + .../mbedtls/test_apps/main/CMakeLists.txt | 2 +- components/mbedtls/test_apps/main/test_sha.c | 1 + components/mqtt/test/CMakeLists.txt | 2 +- components/mqtt/test/test_mqtt.c | 1 + components/mqtt/test/test_mqtt5.c | 1 + components/newlib/test/CMakeLists.txt | 2 +- components/nvs_flash/CMakeLists.txt | 3 +- .../host_test/nvs_page_test/CMakeLists.txt | 1 + .../nvs_page_test/main/CMakeLists.txt | 2 +- components/nvs_flash/test/CMakeLists.txt | 2 +- components/nvs_flash/test_nvs_host/Makefile | 2 +- .../partition_table/test/CMakeLists.txt | 4 -- components/spi_flash/.build-test-rules.yml | 5 --- components/spi_flash/CMakeLists.txt | 15 +------ .../partition_api_test/main/CMakeLists.txt | 2 - components/spi_flash/sim/Makefile.files | 5 ++- components/spi_flash/sim/flash_mock.cpp | 5 +-- components/spi_flash/sim/flash_mock_util.c | 3 -- components/spi_flash/sim/stubs/Makefile.files | 1 + components/spi_flash/test/test_esp_flash.c | 1 + .../spi_flash/test/test_large_flash_writes.c | 1 + .../spi_flash/test/test_out_of_bounds_write.c | 1 + components/spi_flash/test/test_read_write.c | 2 + .../esp_flash/main/test_esp_flash_drv.c | 1 + .../test_apps/flash_mmap/main/test_mmap.c | 1 + components/spiffs/CMakeLists.txt | 4 +- components/wear_levelling/CMakeLists.txt | 3 +- .../private_include/Partition.h | 1 + .../test_apps/main/CMakeLists.txt | 2 +- .../wear_levelling/test_apps/main/test_wl.c | 1 + .../test_wl_host/Makefile.files | 1 + docs/doxygen/Doxyfile | 2 +- .../release-5.x/5.0/storage.rst | 28 ++++++++++++ .../release-5.x/5.0/storage.rst | 28 ++++++++++++ examples/protocols/mqtt/ssl/main/app_main.c | 2 + .../mqtt/ssl_ds/main/idf_component.yml | 2 +- .../partition_mmap/main/CMakeLists.txt | 4 +- .../partition_api/partition_mmap/main/main.c | 1 + .../partition_ops/main/CMakeLists.txt | 4 +- .../partition_api/partition_ops/main/main.c | 1 + examples/system/flash_suspend/main/app_main.c | 1 + tools/idf_py_actions/hints.yml | 5 +++ tools/mocks/esp_partition/CMakeLists.txt | 8 ++++ .../mocks/esp_partition/mock/mock_config.yaml | 10 +++++ tools/mocks/spi_flash/CMakeLists.txt | 3 +- .../system/g1_components/CMakeLists.txt | 3 ++ .../system/panic/main/CMakeLists.txt | 2 +- .../components/test_utils/CMakeLists.txt | 2 +- 78 files changed, 269 insertions(+), 87 deletions(-) create mode 100644 components/esp_partition/.build-test-rules.yml create mode 100644 components/esp_partition/CMakeLists.txt rename components/{spi_flash => esp_partition}/host_test/partition_api_test/CMakeLists.txt (100%) rename components/{spi_flash => esp_partition}/host_test/partition_api_test/README.md (100%) create mode 100644 components/esp_partition/host_test/partition_api_test/main/CMakeLists.txt rename components/{spi_flash => esp_partition}/host_test/partition_api_test/main/partition_api_test.c (99%) rename components/{spi_flash => esp_partition}/host_test/partition_api_test/partition_table.csv (100%) rename components/{spi_flash => esp_partition}/host_test/partition_api_test/sdkconfig.defaults (100%) rename components/{spi_flash => esp_partition}/include/esp_partition.h (93%) rename components/{spi_flash => esp_partition}/include/esp_private/partition_linux.h (96%) rename components/{spi_flash => esp_partition}/partition.c (97%) rename components/{spi_flash => esp_partition}/partition_linux.c (98%) rename components/{spi_flash => esp_partition}/partition_target.c (94%) create mode 100644 components/esp_partition/test/CMakeLists.txt rename components/{partition_table => esp_partition}/test/test_partition.c (95%) rename components/{spi_flash => esp_partition}/test/test_partition_ext.c (92%) rename components/{spi_flash => esp_partition}/test/test_partitions.c (98%) delete mode 100644 components/partition_table/test/CMakeLists.txt delete mode 100644 components/spi_flash/host_test/partition_api_test/main/CMakeLists.txt create mode 100644 tools/mocks/esp_partition/CMakeLists.txt create mode 100644 tools/mocks/esp_partition/mock/mock_config.yaml diff --git a/.gitlab/CODEOWNERS b/.gitlab/CODEOWNERS index 3eb5aaf5e12..b763ccf62d6 100644 --- a/.gitlab/CODEOWNERS +++ b/.gitlab/CODEOWNERS @@ -92,6 +92,7 @@ /components/esp_lcd/ @esp-idf-codeowners/peripherals /components/esp_local_ctrl/ @esp-idf-codeowners/app-utilities /components/esp_netif/ @esp-idf-codeowners/network +/components/esp_partition/ @esp-idf-codeowners/storage /components/esp_phy/ @esp-idf-codeowners/bluetooth @esp-idf-codeowners/wifi @esp-idf-codeowners/ieee802154 /components/esp_pm/ @esp-idf-codeowners/power-management @esp-idf-codeowners/bluetooth @esp-idf-codeowners/wifi /components/esp_psram/ @esp-idf-codeowners/peripherals @esp-idf-codeowners/system diff --git a/.gitlab/ci/host-test.yml b/.gitlab/ci/host-test.yml index ad326ad1481..6a43f7673e5 100644 --- a/.gitlab/ci/host-test.yml +++ b/.gitlab/ci/host-test.yml @@ -441,7 +441,7 @@ test_system_cxx: test_partition_api_host: extends: .host_test_template script: - - cd ${IDF_PATH}/components/spi_flash/host_test/partition_api_test + - cd ${IDF_PATH}/components/esp_partition/host_test/partition_api_test - idf.py build - timeout 5 ./build/partition_api_test.elf | tee test.txt - grep " 0 Failures" test.txt diff --git a/components/app_update/CMakeLists.txt b/components/app_update/CMakeLists.txt index 2fb1be8cdbb..5d9692a73de 100644 --- a/components/app_update/CMakeLists.txt +++ b/components/app_update/CMakeLists.txt @@ -1,7 +1,7 @@ idf_component_register(SRCS "esp_ota_ops.c" "esp_ota_app_desc.c" INCLUDE_DIRS "include" - REQUIRES spi_flash partition_table bootloader_support esp_app_format - PRIV_REQUIRES esptool_py efuse) + REQUIRES partition_table bootloader_support esp_app_format esp_partition + PRIV_REQUIRES esptool_py efuse spi_flash) if(NOT BOOTLOADER_BUILD) partition_table_get_partition_info(otadata_offset "--partition-type data --partition-subtype ota" "offset") diff --git a/components/app_update/esp_ota_ops.c b/components/app_update/esp_ota_ops.c index eda7f972606..3bc6d0e0dd2 100644 --- a/components/app_update/esp_ota_ops.c +++ b/components/app_update/esp_ota_ops.c @@ -14,7 +14,6 @@ #include "esp_err.h" #include "esp_partition.h" -#include "spi_flash_mmap.h" #include "esp_image_format.h" #include "esp_secure_boot.h" #include "esp_flash_encrypt.h" @@ -84,16 +83,16 @@ static const esp_partition_t *read_otadata(esp_ota_select_entry_t *two_otadata) return NULL; } - spi_flash_mmap_handle_t ota_data_map; + esp_partition_mmap_handle_t ota_data_map; const void *result = NULL; - esp_err_t err = esp_partition_mmap(otadata_partition, 0, otadata_partition->size, SPI_FLASH_MMAP_DATA, &result, &ota_data_map); + esp_err_t err = esp_partition_mmap(otadata_partition, 0, otadata_partition->size, ESP_PARTITION_MMAP_DATA, &result, &ota_data_map); if (err != ESP_OK) { ESP_LOGE(TAG, "mmap otadata filed. Err=0x%8x", err); return NULL; } else { memcpy(&two_otadata[0], result, sizeof(esp_ota_select_entry_t)); memcpy(&two_otadata[1], result + SPI_FLASH_SEC_SIZE, sizeof(esp_ota_select_entry_t)); - spi_flash_munmap(ota_data_map); + esp_partition_munmap(ota_data_map); } return otadata_partition; } diff --git a/components/app_update/test_apps/main/CMakeLists.txt b/components/app_update/test_apps/main/CMakeLists.txt index 45e4edf674c..a853e80a3d0 100644 --- a/components/app_update/test_apps/main/CMakeLists.txt +++ b/components/app_update/test_apps/main/CMakeLists.txt @@ -1,5 +1,6 @@ idf_component_register(SRC_DIRS "." PRIV_INCLUDE_DIRS "." - PRIV_REQUIRES cmock test_utils app_update bootloader_support nvs_flash driver - WHOLE_ARCHIVE) + PRIV_REQUIRES cmock test_utils app_update bootloader_support nvs_flash driver spi_flash + WHOLE_ARCHIVE) + target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") diff --git a/components/driver/test/CMakeLists.txt b/components/driver/test/CMakeLists.txt index dc3eb2437f2..03120a8e9c0 100644 --- a/components/driver/test/CMakeLists.txt +++ b/components/driver/test/CMakeLists.txt @@ -1,7 +1,7 @@ idf_component_register(SRC_DIRS . param_test PRIV_INCLUDE_DIRS include param_test/include PRIV_REQUIRES cmock test_utils driver nvs_flash - esp_timer esp_adc esp_event esp_wifi) + esp_timer esp_adc esp_event esp_wifi spi_flash) target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") # A local copy of idf-extra-components esp_serial_slave_link, for stabilities of the SDIO test diff --git a/components/driver/test/test_spi_bus_lock.c b/components/driver/test/test_spi_bus_lock.c index 8acae4627fb..1ca27b8f368 100644 --- a/components/driver/test/test_spi_bus_lock.c +++ b/components/driver/test/test_spi_bus_lock.c @@ -8,6 +8,7 @@ #include "driver/spi_master.h" #include "driver/gpio.h" #include "esp_flash_spi_init.h" +#include "spi_flash_mmap.h" #include "test/test_common_spi.h" #include "unity.h" diff --git a/components/esp_hw_support/test/CMakeLists.txt b/components/esp_hw_support/test/CMakeLists.txt index 03d70c34c08..5479db5f6a6 100644 --- a/components/esp_hw_support/test/CMakeLists.txt +++ b/components/esp_hw_support/test/CMakeLists.txt @@ -1,6 +1,6 @@ idf_component_register(SRC_DIRS "." PRIV_INCLUDE_DIRS "${include_dirs}" - PRIV_REQUIRES cmock test_utils esp_hw_support driver efuse esp_timer esp_psram) + PRIV_REQUIRES cmock test_utils esp_hw_support driver efuse esp_timer esp_psram spi_flash) target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") target_link_libraries(${COMPONENT_LIB} INTERFACE "-u ld_include_test_dport_xt_highint5") diff --git a/components/esp_partition/.build-test-rules.yml b/components/esp_partition/.build-test-rules.yml new file mode 100644 index 00000000000..b46c5564534 --- /dev/null +++ b/components/esp_partition/.build-test-rules.yml @@ -0,0 +1,6 @@ +# Documentation: .gitlab/ci/README.md#manifest-file-to-control-the-buildtest-apps + +components/esp_partition/host_test/partition_api_test: + enable: + - if: IDF_TARGET == "linux" + reason: only test on linux diff --git a/components/esp_partition/CMakeLists.txt b/components/esp_partition/CMakeLists.txt new file mode 100644 index 00000000000..7201b772119 --- /dev/null +++ b/components/esp_partition/CMakeLists.txt @@ -0,0 +1,30 @@ +set(srcs "partition.c") +set(priv_reqs esp_system bootloader_support spi_flash app_update partition_table) +set(reqs) +set(include_dirs "include") + +idf_build_get_property(target IDF_TARGET) +if(${target} STREQUAL "linux") + list(APPEND srcs "partition_linux.c") + set(priv_reqs partition_table) + + # Steal some include directories from bootloader_support and hal components: + idf_component_get_property(hal_dir hal COMPONENT_DIR) + idf_component_get_property(bootloader_support_dir bootloader_support COMPONENT_DIR) + list(APPEND include_dirs include ${hal_dir}/include ${bootloader_support_dir}/include) +else() + list(APPEND srcs "partition_target.c") +endif() + +idf_component_register(SRCS "${srcs}" + INCLUDE_DIRS ${include_dirs} + REQUIRES ${reqs} + PRIV_REQUIRES ${priv_reqs}) + +if(CMAKE_C_COMPILER_ID MATCHES "GNU") + # These flags are GCC specific + set_property(SOURCE ${cache_srcs} APPEND_STRING PROPERTY COMPILE_FLAGS + " -fno-inline-small-functions -fno-inline-functions-called-once") +endif() + +target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") diff --git a/components/spi_flash/host_test/partition_api_test/CMakeLists.txt b/components/esp_partition/host_test/partition_api_test/CMakeLists.txt similarity index 100% rename from components/spi_flash/host_test/partition_api_test/CMakeLists.txt rename to components/esp_partition/host_test/partition_api_test/CMakeLists.txt diff --git a/components/spi_flash/host_test/partition_api_test/README.md b/components/esp_partition/host_test/partition_api_test/README.md similarity index 100% rename from components/spi_flash/host_test/partition_api_test/README.md rename to components/esp_partition/host_test/partition_api_test/README.md diff --git a/components/esp_partition/host_test/partition_api_test/main/CMakeLists.txt b/components/esp_partition/host_test/partition_api_test/main/CMakeLists.txt new file mode 100644 index 00000000000..5dee25b7405 --- /dev/null +++ b/components/esp_partition/host_test/partition_api_test/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRCS "partition_api_test.c" + REQUIRES esp_partition unity) diff --git a/components/spi_flash/host_test/partition_api_test/main/partition_api_test.c b/components/esp_partition/host_test/partition_api_test/main/partition_api_test.c similarity index 99% rename from components/spi_flash/host_test/partition_api_test/main/partition_api_test.c rename to components/esp_partition/host_test/partition_api_test/main/partition_api_test.c index a4d5278c0ab..2f0db43efac 100644 --- a/components/spi_flash/host_test/partition_api_test/main/partition_api_test.c +++ b/components/esp_partition/host_test/partition_api_test/main/partition_api_test.c @@ -98,7 +98,7 @@ TEST(partition_api, test_partition_ops) memset(buffout, 0, sizeof(buffout)); size_t sector_off = 0; //erase works per whole sector - offset must be aligned to 4kB boundaries - err = esp_partition_erase_range(partition_data, sector_off, SPI_FLASH_SEC_SIZE); + err = esp_partition_erase_range(partition_data, sector_off, partition_data->erase_size); assert(esp_partition_read(partition_data, off, (void *)buffout, bufsize) == ESP_OK); TEST_ESP_OK(err); TEST_ASSERT_EQUAL(0, memcmp(buffout, buferase, bufsize)); diff --git a/components/spi_flash/host_test/partition_api_test/partition_table.csv b/components/esp_partition/host_test/partition_api_test/partition_table.csv similarity index 100% rename from components/spi_flash/host_test/partition_api_test/partition_table.csv rename to components/esp_partition/host_test/partition_api_test/partition_table.csv diff --git a/components/spi_flash/host_test/partition_api_test/sdkconfig.defaults b/components/esp_partition/host_test/partition_api_test/sdkconfig.defaults similarity index 100% rename from components/spi_flash/host_test/partition_api_test/sdkconfig.defaults rename to components/esp_partition/host_test/partition_api_test/sdkconfig.defaults diff --git a/components/spi_flash/include/esp_partition.h b/components/esp_partition/include/esp_partition.h similarity index 93% rename from components/spi_flash/include/esp_partition.h rename to components/esp_partition/include/esp_partition.h index 4d0d9d29b3c..0b75dd5f1a9 100644 --- a/components/spi_flash/include/esp_partition.h +++ b/components/esp_partition/include/esp_partition.h @@ -11,8 +11,6 @@ #include #include #include "esp_err.h" -#include "esp_flash.h" -#include "spi_flash_mmap.h" #ifdef __cplusplus extern "C" { @@ -23,6 +21,22 @@ extern "C" { * @brief Partition APIs */ +/** @cond */ +typedef struct esp_flash_t esp_flash_t; +/** @endcond */ + +/** + * @brief Enumeration which specifies memory space requested in an mmap call + */ +typedef enum { + ESP_PARTITION_MMAP_DATA, /**< map to data memory (Vaddr0), allows byte-aligned access, 4 MB total */ + ESP_PARTITION_MMAP_INST, /**< map to instruction memory (Vaddr1-3), allows only 4-byte-aligned access, 11 MB total */ +} esp_partition_mmap_memory_t; + +/** + * @brief Opaque handle for memory region obtained from esp_partition_mmap. + */ +typedef uint32_t esp_partition_mmap_handle_t; /** * @brief Partition type @@ -114,6 +128,7 @@ typedef struct { esp_partition_subtype_t subtype; /*!< partition subtype */ uint32_t address; /*!< starting address of the partition in flash */ uint32_t size; /*!< size of the partition, in bytes */ + uint32_t erase_size; /*!< size the erase operation should be aligned to */ char label[17]; /*!< partition label, zero-terminated ASCII string */ bool encrypted; /*!< flag is set to true if partition is encrypted */ } esp_partition_t; @@ -318,9 +333,9 @@ esp_err_t esp_partition_write_raw(const esp_partition_t* partition, * esp_partition_find_first or esp_partition_get. * Must be non-NULL. * @param offset Offset from the beginning of partition where erase operation - * should start. Must be aligned to 4 kilobytes. + * should start. Must be aligned to partition->erase_size. * @param size Size of the range which should be erased, in bytes. - * Must be divisible by 4 kilobytes. + * Must be divisible by partition->erase_size. * * @return ESP_OK, if the range was erased successfully; * ESP_ERR_INVALID_ARG, if iterator or dst are NULL; @@ -342,7 +357,7 @@ esp_err_t esp_partition_erase_range(const esp_partition_t* partition, * requested offset (not necessarily to the beginning of mmap-ed region). * * To release mapped memory, pass handle returned via out_handle argument to - * spi_flash_munmap function. + * esp_partition_munmap function. * * @param partition Pointer to partition structure obtained using * esp_partition_find_first or esp_partition_get. @@ -351,13 +366,25 @@ esp_err_t esp_partition_erase_range(const esp_partition_t* partition, * @param size Size of the area to be mapped. * @param memory Memory space where the region should be mapped * @param out_ptr Output, pointer to the mapped memory region - * @param out_handle Output, handle which should be used for spi_flash_munmap call + * @param out_handle Output, handle which should be used for esp_partition_munmap call * * @return ESP_OK, if successful */ esp_err_t esp_partition_mmap(const esp_partition_t* partition, size_t offset, size_t size, - spi_flash_mmap_memory_t memory, - const void** out_ptr, spi_flash_mmap_handle_t* out_handle); + esp_partition_mmap_memory_t memory, + const void** out_ptr, esp_partition_mmap_handle_t* out_handle); + +/** + * @brief Release region previously obtained using esp_partition_mmap + * + * @note Calling this function will not necessarily unmap memory region. + * Region will only be unmapped when there are no other handles which + * reference this region. In case of partially overlapping regions + * it is possible that memory will be unmapped partially. + * + * @param handle Handle obtained from spi_flash_mmap + */ +void esp_partition_munmap(esp_partition_mmap_handle_t handle); /** * @brief Get SHA-256 digest for required partition. diff --git a/components/spi_flash/include/esp_private/partition_linux.h b/components/esp_partition/include/esp_private/partition_linux.h similarity index 96% rename from components/spi_flash/include/esp_private/partition_linux.h rename to components/esp_partition/include/esp_private/partition_linux.h index 5da5738d78f..efb1e65b0ff 100644 --- a/components/spi_flash/include/esp_private/partition_linux.h +++ b/components/esp_partition/include/esp_private/partition_linux.h @@ -19,6 +19,9 @@ extern "C" { * @brief Private API functions used for Linux-target emulation of the Partition APIs (host-side testing) */ +/** @brief emulated sector size for the partition API on Linux */ +#define ESP_PARTITION_EMULATED_SECTOR_SIZE 0x1000 + /** * @brief Partition type to string conversion routine * diff --git a/components/spi_flash/partition.c b/components/esp_partition/partition.c similarity index 97% rename from components/spi_flash/partition.c rename to components/esp_partition/partition.c index a161c484e5a..2bf015ec20b 100644 --- a/components/spi_flash/partition.c +++ b/components/esp_partition/partition.c @@ -12,10 +12,10 @@ #include "sdkconfig.h" #include "esp_flash_partitions.h" #include "esp_attr.h" -#include "esp_flash.h" #include "esp_partition.h" #if !CONFIG_IDF_TARGET_LINUX +#include "esp_flash.h" #include "esp_flash_encrypt.h" #endif @@ -90,9 +90,11 @@ static esp_err_t load_partitions(void) #if CONFIG_IDF_TARGET_LINUX esp_err_t err = esp_partition_file_mmap(&p_start); + size_t mapped_size = ESP_PARTITION_EMULATED_SECTOR_SIZE; #else esp_err_t err = spi_flash_mmap(partition_align_pg_size, SPI_FLASH_SEC_SIZE, SPI_FLASH_MMAP_DATA, (const void **)&p_start, &handle); + size_t mapped_size = SPI_FLASH_SEC_SIZE; #endif if (err != ESP_OK) { @@ -101,7 +103,7 @@ static esp_err_t load_partitions(void) // calculate partition address within mmap-ed region p_start += partition_pad; - p_end = p_start + SPI_FLASH_SEC_SIZE; + p_end = p_start + mapped_size; for (const uint8_t *p_entry = p_start; p_entry < p_end; p_entry += sizeof(esp_partition_info_t)) { esp_partition_info_t entry; @@ -136,6 +138,11 @@ static esp_err_t load_partitions(void) #endif item->info.address = entry.pos.offset; item->info.size = entry.pos.size; +#if CONFIG_IDF_TARGET_LINUX + item->info.erase_size = ESP_PARTITION_EMULATED_SECTOR_SIZE; +#else + item->info.erase_size = SPI_FLASH_SEC_SIZE; +#endif item->info.type = entry.type; item->info.subtype = entry.subtype; item->info.encrypted = entry.flags & PART_FLAG_ENCRYPTED; @@ -363,9 +370,14 @@ esp_err_t esp_partition_register_external(esp_flash_t *flash_chip, size_t offset *out_partition = NULL; } +#if CONFIG_IDF_TARGET_LINUX + return ESP_ERR_NOT_SUPPORTED; + +#else if (offset + size > flash_chip->size) { return ESP_ERR_INVALID_SIZE; } +#endif // CONFIG_IDF_TARGET_LINUX esp_err_t err = ensure_partitions_loaded(); if (err != ESP_OK) { diff --git a/components/spi_flash/partition_linux.c b/components/esp_partition/partition_linux.c similarity index 98% rename from components/spi_flash/partition_linux.c rename to components/esp_partition/partition_linux.c index 784b0d1c11c..d20ccb51556 100644 --- a/components/spi_flash/partition_linux.c +++ b/components/esp_partition/partition_linux.c @@ -238,10 +238,10 @@ esp_err_t esp_partition_erase_range(const esp_partition_t *partition, size_t off { assert(partition != NULL); - if (offset > partition->size || offset % SPI_FLASH_SEC_SIZE != 0) { + if (offset > partition->size || offset % partition->erase_size != 0) { return ESP_ERR_INVALID_ARG; } - if (offset + size > partition->size || size % SPI_FLASH_SEC_SIZE != 0) { + if (offset + size > partition->size || size % partition->erase_size != 0) { return ESP_ERR_INVALID_SIZE; } diff --git a/components/spi_flash/partition_target.c b/components/esp_partition/partition_target.c similarity index 94% rename from components/spi_flash/partition_target.c rename to components/esp_partition/partition_target.c index cacdc3bba5f..6d635f2fa0f 100644 --- a/components/spi_flash/partition_target.c +++ b/components/esp_partition/partition_target.c @@ -143,8 +143,8 @@ esp_err_t esp_partition_erase_range(const esp_partition_t *partition, * mmaped pointers, and a single handle for all these regions. */ esp_err_t esp_partition_mmap(const esp_partition_t *partition, size_t offset, size_t size, - spi_flash_mmap_memory_t memory, - const void **out_ptr, spi_flash_mmap_handle_t *out_handle) + esp_partition_mmap_memory_t memory, + const void **out_ptr, esp_partition_mmap_handle_t *out_handle) { assert(partition != NULL); if (offset > partition->size) { @@ -160,7 +160,7 @@ esp_err_t esp_partition_mmap(const esp_partition_t *partition, size_t offset, si // offset within mmu page size block size_t region_offset = phys_addr & (CONFIG_MMU_PAGE_SIZE - 1); size_t mmap_addr = phys_addr & ~(CONFIG_MMU_PAGE_SIZE - 1); - esp_err_t rc = spi_flash_mmap(mmap_addr, size + region_offset, memory, out_ptr, out_handle); + esp_err_t rc = spi_flash_mmap(mmap_addr, size + region_offset, (spi_flash_mmap_memory_t) memory, out_ptr, (spi_flash_mmap_handle_t*) out_handle); // adjust returned pointer to point to the correct offset if (rc == ESP_OK) { *out_ptr = (void *) (((ptrdiff_t) * out_ptr) + region_offset); @@ -168,6 +168,11 @@ esp_err_t esp_partition_mmap(const esp_partition_t *partition, size_t offset, si return rc; } +void esp_partition_munmap(esp_partition_mmap_handle_t handle) +{ + spi_flash_munmap((spi_flash_mmap_handle_t) handle); +} + esp_err_t esp_partition_get_sha256(const esp_partition_t *partition, uint8_t *sha_256) { return bootloader_common_get_sha256_of_partition(partition->address, partition->size, partition->type, sha_256); diff --git a/components/esp_partition/test/CMakeLists.txt b/components/esp_partition/test/CMakeLists.txt new file mode 100644 index 00000000000..56c4de4a73e --- /dev/null +++ b/components/esp_partition/test/CMakeLists.txt @@ -0,0 +1,4 @@ +idf_component_register(SRC_DIRS "." + PRIV_INCLUDE_DIRS "." + PRIV_REQUIRES test_utils esp_partition esp_system app_update bootloader_support spi_flash) +target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") diff --git a/components/partition_table/test/test_partition.c b/components/esp_partition/test/test_partition.c similarity index 95% rename from components/partition_table/test/test_partition.c rename to components/esp_partition/test/test_partition.c index 50b2ce5a3be..b32edac1091 100644 --- a/components/partition_table/test/test_partition.c +++ b/components/esp_partition/test/test_partition.c @@ -49,7 +49,7 @@ TEST_CASE("Can write, read, mmap partition", "[partition][ignore]") const esp_partition_t *p = get_test_data_partition(); printf("Using partition %s at 0x%x, size 0x%x\n", p->label, p->address, p->size); TEST_ASSERT_NOT_NULL(p); - const size_t max_size = 2 * SPI_FLASH_SEC_SIZE; + const size_t max_size = 2 * p->erase_size; uint8_t *data = (uint8_t *) malloc(max_size); TEST_ASSERT_NOT_NULL(data); @@ -85,10 +85,10 @@ TEST_CASE("Can write, read, mmap partition", "[partition][ignore]") free(data); const uint32_t *mmap_data; - spi_flash_mmap_handle_t mmap_handle; + esp_partition_mmap_handle_t mmap_handle; size_t begin = 3000; size_t size = 64000; //chosen so size is smaller than 64K but the mmap straddles 2 MMU blocks - TEST_ASSERT_EQUAL(ESP_OK, esp_partition_mmap(p, begin, size, SPI_FLASH_MMAP_DATA, + TEST_ASSERT_EQUAL(ESP_OK, esp_partition_mmap(p, begin, size, ESP_PARTITION_MMAP_DATA, (const void **)&mmap_data, &mmap_handle)); srand(0); for (size_t offset = 0; offset < p->size; offset += block_size) { @@ -107,5 +107,5 @@ TEST_CASE("Can write, read, mmap partition", "[partition][ignore]") } } - spi_flash_munmap(mmap_handle); + esp_partition_munmap(mmap_handle); } diff --git a/components/spi_flash/test/test_partition_ext.c b/components/esp_partition/test/test_partition_ext.c similarity index 92% rename from components/spi_flash/test/test_partition_ext.c rename to components/esp_partition/test/test_partition_ext.c index 62011a9ead0..b2721c87889 100644 --- a/components/spi_flash/test/test_partition_ext.c +++ b/components/esp_partition/test/test_partition_ext.c @@ -1,4 +1,10 @@ +/* + * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Unlicense OR CC0-1.0 + */ #include "esp_flash.h" +#include "spi_flash_mmap.h" #include "esp_partition.h" #include "unity.h" diff --git a/components/spi_flash/test/test_partitions.c b/components/esp_partition/test/test_partitions.c similarity index 98% rename from components/spi_flash/test/test_partitions.c rename to components/esp_partition/test/test_partitions.c index f4c47c1562d..a3fe7ebca1a 100644 --- a/components/spi_flash/test/test_partitions.c +++ b/components/esp_partition/test/test_partitions.c @@ -18,6 +18,8 @@ #include #include #include +#include "esp_flash.h" +#include "spi_flash_mmap.h" TEST_CASE("Test erase partition", "[spi_flash][esp_flash]") { diff --git a/components/esp_psram/test_apps/psram/main/test_psram.c b/components/esp_psram/test_apps/psram/main/test_psram.c index 3b2e730726c..edc7682ca7f 100644 --- a/components/esp_psram/test_apps/psram/main/test_psram.c +++ b/components/esp_psram/test_apps/psram/main/test_psram.c @@ -17,6 +17,8 @@ #include "esp_private/esp_psram_io.h" #include "esp_psram.h" #include "esp_private/esp_psram_extram.h" +#include "esp_flash.h" +#include "esp_partition.h" __attribute__((unused)) const static char *TAG = "PSRAM"; diff --git a/components/esp_system/CMakeLists.txt b/components/esp_system/CMakeLists.txt index d8da31a8374..25307d36ca8 100644 --- a/components/esp_system/CMakeLists.txt +++ b/components/esp_system/CMakeLists.txt @@ -47,7 +47,9 @@ else() # link-time registration is used. # [refactor-todo] requires "driver" for headers: # - spi_common_internal.h - pthread bootloader_support efuse driver + # [refactor-todo] esp_partition required for virtual efuse + # init code. Move to esp_efuse component. + pthread bootloader_support efuse driver esp_partition LDFRAGMENTS "linker.lf" "app.lf") add_subdirectory(port) diff --git a/components/esp_timer/test/CMakeLists.txt b/components/esp_timer/test/CMakeLists.txt index 6aa26250980..bf7f6ea740d 100644 --- a/components/esp_timer/test/CMakeLists.txt +++ b/components/esp_timer/test/CMakeLists.txt @@ -1,4 +1,4 @@ idf_component_register(SRC_DIRS "." PRIV_INCLUDE_DIRS "../private_include" - PRIV_REQUIRES cmock test_utils esp_timer) + PRIV_REQUIRES cmock test_utils esp_timer spi_flash) target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") diff --git a/components/espcoredump/CMakeLists.txt b/components/espcoredump/CMakeLists.txt index 6be5b6a29af..577e39a11f2 100644 --- a/components/espcoredump/CMakeLists.txt +++ b/components/espcoredump/CMakeLists.txt @@ -24,7 +24,7 @@ idf_component_register(SRCS ${srcs} INCLUDE_DIRS ${includes} PRIV_INCLUDE_DIRS ${priv_includes} LDFRAGMENTS linker.lf - PRIV_REQUIRES spi_flash bootloader_support mbedtls esp_rom soc esp_system driver) + PRIV_REQUIRES esp_partition spi_flash bootloader_support mbedtls esp_rom soc esp_system driver) if(CONFIG_ESP_COREDUMP_DATA_FORMAT_ELF) target_link_libraries(${COMPONENT_LIB} PRIVATE idf::esp_app_format) diff --git a/components/fatfs/test_fatfs_host/Makefile.files b/components/fatfs/test_fatfs_host/Makefile.files index baa9597b70c..f0c7bbf7678 100644 --- a/components/fatfs/test_fatfs_host/Makefile.files +++ b/components/fatfs/test_fatfs_host/Makefile.files @@ -40,4 +40,5 @@ INCLUDE_DIRS := \ hal/include \ spi_flash/include \ wear_levelling/include \ + esp_partition/include \ ) diff --git a/components/mbedtls/test_apps/main/CMakeLists.txt b/components/mbedtls/test_apps/main/CMakeLists.txt index 533724e2a6b..2063cdd28c1 100644 --- a/components/mbedtls/test_apps/main/CMakeLists.txt +++ b/components/mbedtls/test_apps/main/CMakeLists.txt @@ -7,7 +7,7 @@ set(TEST_CRTS "crts/server_cert_chain.pem" idf_component_register(SRC_DIRS "." PRIV_INCLUDE_DIRS "." - PRIV_REQUIRES cmock test_utils mbedtls esp_timer unity + PRIV_REQUIRES cmock test_utils mbedtls esp_timer unity spi_flash EMBED_TXTFILES ${TEST_CRTS} WHOLE_ARCHIVE) target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") diff --git a/components/mbedtls/test_apps/main/test_sha.c b/components/mbedtls/test_apps/main/test_sha.c index c6a771f67ce..a40c70ee3dc 100644 --- a/components/mbedtls/test_apps/main/test_sha.c +++ b/components/mbedtls/test_apps/main/test_sha.c @@ -12,6 +12,7 @@ #include "esp_heap_caps.h" #include "idf_performance.h" #include "esp_private/esp_clk.h" +#include "spi_flash_mmap.h" #include "soc/soc_caps.h" diff --git a/components/mqtt/test/CMakeLists.txt b/components/mqtt/test/CMakeLists.txt index 616d362045a..3261bec86fc 100644 --- a/components/mqtt/test/CMakeLists.txt +++ b/components/mqtt/test/CMakeLists.txt @@ -5,5 +5,5 @@ if(CONFIG_MQTT_PROTOCOL_5) endif() idf_component_register(SRCS "${srcs}" - PRIV_REQUIRES cmock test_utils mqtt nvs_flash app_update esp_eth esp_netif) + PRIV_REQUIRES cmock test_utils mqtt nvs_flash app_update esp_eth esp_netif spi_flash) target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") diff --git a/components/mqtt/test/test_mqtt.c b/components/mqtt/test/test_mqtt.c index d997bceb98b..3bda6c05c7d 100644 --- a/components/mqtt/test/test_mqtt.c +++ b/components/mqtt/test/test_mqtt.c @@ -23,6 +23,7 @@ #include "test_mqtt_client_broker.h" #include "test_mqtt_connection.h" #include "esp_mac.h" +#include "spi_flash_mmap.h" static void test_leak_setup(const char * file, long line) { diff --git a/components/mqtt/test/test_mqtt5.c b/components/mqtt/test/test_mqtt5.c index 01c33e79daa..502cd1ce53c 100644 --- a/components/mqtt/test/test_mqtt5.c +++ b/components/mqtt/test/test_mqtt5.c @@ -17,6 +17,7 @@ #include "test_mqtt5_client_broker.h" #include "test_mqtt_connection.h" #include "esp_mac.h" +#include "spi_flash_mmap.h" static esp_mqtt5_user_property_item_t user_property_arr[3] = { {"board", "esp32"}, diff --git a/components/newlib/test/CMakeLists.txt b/components/newlib/test/CMakeLists.txt index cb3cf2f3460..12b5a18f5db 100644 --- a/components/newlib/test/CMakeLists.txt +++ b/components/newlib/test/CMakeLists.txt @@ -1,4 +1,4 @@ idf_component_register(SRC_DIRS "." PRIV_INCLUDE_DIRS "." - PRIV_REQUIRES cmock test_utils driver esp_timer) + PRIV_REQUIRES cmock test_utils driver esp_timer spi_flash) target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") diff --git a/components/nvs_flash/CMakeLists.txt b/components/nvs_flash/CMakeLists.txt index 306f3655479..f19655a71d0 100644 --- a/components/nvs_flash/CMakeLists.txt +++ b/components/nvs_flash/CMakeLists.txt @@ -14,7 +14,8 @@ set(srcs "src/nvs_api.cpp" "src/nvs_types.cpp") idf_component_register(SRCS "${srcs}" - REQUIRES "spi_flash" + REQUIRES "esp_partition" + PRIV_REQUIRES spi_flash INCLUDE_DIRS "include" PRIV_INCLUDE_DIRS "private_include") diff --git a/components/nvs_flash/host_test/nvs_page_test/CMakeLists.txt b/components/nvs_flash/host_test/nvs_page_test/CMakeLists.txt index 6d51e4612e8..c0a706af57d 100644 --- a/components/nvs_flash/host_test/nvs_page_test/CMakeLists.txt +++ b/components/nvs_flash/host_test/nvs_page_test/CMakeLists.txt @@ -6,6 +6,7 @@ set(COMPONENTS main) list(APPEND EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/mocks/driver/") list(APPEND EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/mocks/freertos/") list(APPEND EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/mocks/spi_flash/") +list(APPEND EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/mocks/esp_partition/") idf_build_set_property(COMPILE_DEFINITIONS "NO_DEBUG_STORAGE" APPEND) project(test_nvs_page_host) diff --git a/components/nvs_flash/host_test/nvs_page_test/main/CMakeLists.txt b/components/nvs_flash/host_test/nvs_page_test/main/CMakeLists.txt index a6fe64ec974..a9b8374dc2c 100644 --- a/components/nvs_flash/host_test/nvs_page_test/main/CMakeLists.txt +++ b/components/nvs_flash/host_test/nvs_page_test/main/CMakeLists.txt @@ -5,7 +5,7 @@ idf_component_register(SRCS "nvs_page_test.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/../../../src" PRIV_INCLUDE_DIRS "${CMAKE_CURRENT_SOURCE_DIR}/../../../private_include" - REQUIRES cmock nvs_flash spi_flash partition_table) + REQUIRES cmock nvs_flash spi_flash partition_table esp_partition) target_compile_options(${COMPONENT_LIB} PUBLIC --coverage) target_link_libraries(${COMPONENT_LIB} --coverage) diff --git a/components/nvs_flash/test/CMakeLists.txt b/components/nvs_flash/test/CMakeLists.txt index bcfbbc2b592..13515aa4161 100644 --- a/components/nvs_flash/test/CMakeLists.txt +++ b/components/nvs_flash/test/CMakeLists.txt @@ -1,6 +1,6 @@ idf_component_register(SRC_DIRS "." PRIV_INCLUDE_DIRS "." - PRIV_REQUIRES cmock test_utils nvs_flash bootloader_support + PRIV_REQUIRES cmock test_utils nvs_flash bootloader_support spi_flash EMBED_TXTFILES encryption_keys.bin partition_encrypted.bin sample.bin) target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") diff --git a/components/nvs_flash/test_nvs_host/Makefile b/components/nvs_flash/test_nvs_host/Makefile index ffa5a920c32..0e238d09621 100644 --- a/components/nvs_flash/test_nvs_host/Makefile +++ b/components/nvs_flash/test_nvs_host/Makefile @@ -37,7 +37,7 @@ else COMPILER := gcc endif -CPPFLAGS += -I../private_include -I../include -I../src -I../../esp_rom/include -I../../esp_rom/include/linux -I../../log/include -I./ -I../../esp_common/include -I../../esp32/include -I ../../mbedtls/mbedtls/include -I ../../spi_flash/include -I ../../hal/include -I ../../xtensa/include -I ../../../tools/catch -fprofile-arcs -ftest-coverage -g2 -ggdb +CPPFLAGS += -I../private_include -I../include -I../src -I../../esp_rom/include -I../../esp_rom/include/linux -I../../log/include -I./ -I../../esp_common/include -I../../esp32/include -I ../../mbedtls/mbedtls/include -I ../../spi_flash/include -I ../../esp_partition/include -I ../../hal/include -I ../../xtensa/include -I ../../../tools/catch -fprofile-arcs -ftest-coverage -g2 -ggdb CFLAGS += -fprofile-arcs -ftest-coverage -DLINUX_TARGET -DLINUX_HOST_LEGACY_TEST CXXFLAGS += -std=c++11 -Wall -Werror -DLINUX_TARGET -DLINUX_HOST_LEGACY_TEST LDFLAGS += -lstdc++ -Wall -fprofile-arcs -ftest-coverage diff --git a/components/partition_table/test/CMakeLists.txt b/components/partition_table/test/CMakeLists.txt deleted file mode 100644 index 9de17b084a8..00000000000 --- a/components/partition_table/test/CMakeLists.txt +++ /dev/null @@ -1,4 +0,0 @@ -idf_component_register(SRC_DIRS "." - PRIV_INCLUDE_DIRS "." - PRIV_REQUIRES cmock test_utils) -target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") diff --git a/components/spi_flash/.build-test-rules.yml b/components/spi_flash/.build-test-rules.yml index eb69f151028..c10cce3665c 100644 --- a/components/spi_flash/.build-test-rules.yml +++ b/components/spi_flash/.build-test-rules.yml @@ -1,10 +1,5 @@ # Documentation: .gitlab/ci/README.md#manifest-file-to-control-the-buildtest-apps -components/spi_flash/host_test/partition_api_test: - enable: - - if: IDF_TARGET == "linux" - reason: only test on linux - components/spi_flash/test_apps/esp_flash: disable: - if: IDF_TARGET == "esp32c6" diff --git a/components/spi_flash/CMakeLists.txt b/components/spi_flash/CMakeLists.txt index 72544d895e4..86860417bd8 100644 --- a/components/spi_flash/CMakeLists.txt +++ b/components/spi_flash/CMakeLists.txt @@ -1,14 +1,5 @@ idf_build_get_property(target IDF_TARGET) if(${target} STREQUAL "linux") - set(srcs "partition.c" - "partition_linux.c") - idf_component_get_property(hal_dir hal COMPONENT_DIR) - idf_component_get_property(bootloader_support_dir bootloader_support COMPONENT_DIR) - - idf_component_register(SRCS "${srcs}" - INCLUDE_DIRS include ${hal_dir}/include ${bootloader_support_dir}/include - PRIV_INCLUDE_DIRS include/spi_flash - PRIV_REQUIRES partition_table) return() endif() @@ -23,11 +14,7 @@ else() "${target}/flash_ops_${target}.c" ) - set(srcs - "partition.c" - "partition_target.c" - "flash_brownout_hook.c" - ) + set(srcs "flash_brownout_hook.c") if(CONFIG_SOC_SPI_MEM_SUPPORT_OPI_MODE) list(APPEND srcs "${target}/spi_flash_oct_flash_init.c") diff --git a/components/spi_flash/host_test/partition_api_test/main/CMakeLists.txt b/components/spi_flash/host_test/partition_api_test/main/CMakeLists.txt deleted file mode 100644 index a43dde98bf2..00000000000 --- a/components/spi_flash/host_test/partition_api_test/main/CMakeLists.txt +++ /dev/null @@ -1,2 +0,0 @@ -idf_component_register(SRCS "partition_api_test.c" - REQUIRES spi_flash unity) diff --git a/components/spi_flash/sim/Makefile.files b/components/spi_flash/sim/Makefile.files index 186fce56d30..7ea9d325f63 100644 --- a/components/spi_flash/sim/Makefile.files +++ b/components/spi_flash/sim/Makefile.files @@ -3,8 +3,8 @@ SOURCE_FILES := \ flash_mock.cpp \ flash_mock_util.c \ $(addprefix ../, \ - partition.c \ - ../spi_flash/partition_target.c \ + ../esp_partition/partition.c \ + ../esp_partition/partition_target.c \ flash_ops.c \ ../esp_rom/linux/esp_rom_efuse.c \ ) \ @@ -46,4 +46,5 @@ INCLUDE_DIRS := \ hal/esp32/include \ hal/platform_port/include \ spi_flash/include \ + esp_partition/include \ ) diff --git a/components/spi_flash/sim/flash_mock.cpp b/components/spi_flash/sim/flash_mock.cpp index f047cd5cba0..54777d24580 100644 --- a/components/spi_flash/sim/flash_mock.cpp +++ b/components/spi_flash/sim/flash_mock.cpp @@ -1,11 +1,8 @@ -#include "SpiFlash.h" - #include #include +#include "SpiFlash.h" #include "spi_flash_mmap.h" -#include "esp_partition.h" - #include "esp_err.h" #include "esp_rom_spiflash.h" #include "esp_flash.h" diff --git a/components/spi_flash/sim/flash_mock_util.c b/components/spi_flash/sim/flash_mock_util.c index b84e2307c84..362cad2d7ae 100644 --- a/components/spi_flash/sim/flash_mock_util.c +++ b/components/spi_flash/sim/flash_mock_util.c @@ -1,6 +1,3 @@ -#include "spi_flash_mmap.h" -#include "esp_partition.h" - #include "esp_err.h" #include "esp_rom_spiflash.h" diff --git a/components/spi_flash/sim/stubs/Makefile.files b/components/spi_flash/sim/stubs/Makefile.files index b2f789c39b7..243d7f76dc0 100644 --- a/components/spi_flash/sim/stubs/Makefile.files +++ b/components/spi_flash/sim/stubs/Makefile.files @@ -37,5 +37,6 @@ INCLUDE_DIRS := \ bootloader_support/bootloader_flash/include \ app_update/include \ hal/include \ + esp_partition/include \ spi_flash/include \ ) diff --git a/components/spi_flash/test/test_esp_flash.c b/components/spi_flash/test/test_esp_flash.c index 72f2f3abb8a..6bcea9f46ec 100644 --- a/components/spi_flash/test/test_esp_flash.c +++ b/components/spi_flash/test/test_esp_flash.c @@ -7,6 +7,7 @@ #include #include "esp_flash.h" #include "esp_private/spi_common_internal.h" +#include "spi_flash_mmap.h" #include "esp_flash_spi_init.h" #include "memspi_host_driver.h" #include diff --git a/components/spi_flash/test/test_large_flash_writes.c b/components/spi_flash/test/test_large_flash_writes.c index 7305f64d697..cf8ac083b68 100644 --- a/components/spi_flash/test/test_large_flash_writes.c +++ b/components/spi_flash/test/test_large_flash_writes.c @@ -20,6 +20,7 @@ #include "esp_rom_spiflash.h" #include "esp_private/cache_utils.h" #include "soc/timer_periph.h" +#include "esp_flash.h" static const uint8_t large_const_buffer[16400] = { 203, // first byte diff --git a/components/spi_flash/test/test_out_of_bounds_write.c b/components/spi_flash/test/test_out_of_bounds_write.c index 9854335321d..10391bc002b 100644 --- a/components/spi_flash/test/test_out_of_bounds_write.c +++ b/components/spi_flash/test/test_out_of_bounds_write.c @@ -3,6 +3,7 @@ #include "unity.h" #include "spi_flash_mmap.h" #include "esp_ota_ops.h" +#include "esp_flash.h" #if CONFIG_SPI_FLASH_DANGEROUS_WRITE_ABORTS || CONFIG_SPI_FLASH_DANGEROUS_WRITE_FAILS diff --git a/components/spi_flash/test/test_read_write.c b/components/spi_flash/test/test_read_write.c index a3e2b9d739e..9412b253427 100644 --- a/components/spi_flash/test/test_read_write.c +++ b/components/spi_flash/test/test_read_write.c @@ -20,6 +20,8 @@ #include "esp_attr.h" #include "esp_heap_caps.h" #include "esp_rom_spiflash.h" +#include "esp_flash.h" + #if CONFIG_IDF_TARGET_ESP32 // Used for rom_fix function #include "esp32/rom/spi_flash.h" diff --git a/components/spi_flash/test_apps/esp_flash/main/test_esp_flash_drv.c b/components/spi_flash/test_apps/esp_flash/main/test_esp_flash_drv.c index 65516d1dcec..3032c1713f1 100644 --- a/components/spi_flash/test_apps/esp_flash/main/test_esp_flash_drv.c +++ b/components/spi_flash/test_apps/esp_flash/main/test_esp_flash_drv.c @@ -28,6 +28,7 @@ #include "esp_rom_sys.h" #include "esp_timer.h" #include "test_esp_flash_def.h" +#include "spi_flash_mmap.h" #if CONFIG_IDF_TARGET_ESP32S2 #include "esp32s2/rom/cache.h" diff --git a/components/spi_flash/test_apps/flash_mmap/main/test_mmap.c b/components/spi_flash/test_apps/flash_mmap/main/test_mmap.c index 0b7322c94ec..aece7302797 100644 --- a/components/spi_flash/test_apps/flash_mmap/main/test_mmap.c +++ b/components/spi_flash/test_apps/flash_mmap/main/test_mmap.c @@ -16,6 +16,7 @@ #include #include #include +#include "esp_flash.h" #include "test_utils.h" diff --git a/components/spiffs/CMakeLists.txt b/components/spiffs/CMakeLists.txt index ec8275ae03a..68e5cc6b87b 100644 --- a/components/spiffs/CMakeLists.txt +++ b/components/spiffs/CMakeLists.txt @@ -15,8 +15,8 @@ endif() idf_component_register(SRCS ${srcs} INCLUDE_DIRS "include" PRIV_INCLUDE_DIRS "." "spiffs/src" - REQUIRES spi_flash - PRIV_REQUIRES ${pr}) + REQUIRES esp_partition + PRIV_REQUIRES ${pr} spi_flash) if(CMAKE_C_COMPILER_ID MATCHES "GNU") set_source_files_properties(spiffs/src/spiffs_nucleus.c PROPERTIES COMPILE_FLAGS -Wno-stringop-truncation) diff --git a/components/wear_levelling/CMakeLists.txt b/components/wear_levelling/CMakeLists.txt index 1a44349585a..751f6822732 100644 --- a/components/wear_levelling/CMakeLists.txt +++ b/components/wear_levelling/CMakeLists.txt @@ -7,6 +7,7 @@ idf_component_register(SRCS "Partition.cpp" "wear_levelling.cpp" INCLUDE_DIRS include PRIV_INCLUDE_DIRS private_include - REQUIRES spi_flash) + REQUIRES esp_partition + PRIV_REQUIRES spi_flash) target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") diff --git a/components/wear_levelling/private_include/Partition.h b/components/wear_levelling/private_include/Partition.h index 3c83f0bbae4..e07d4092952 100644 --- a/components/wear_levelling/private_include/Partition.h +++ b/components/wear_levelling/private_include/Partition.h @@ -11,6 +11,7 @@ #include "Flash_Access.h" #include "esp_partition.h" +#include "spi_flash_mmap.h" // for SPI_FLASH_SEC_SIZE /** * @brief This class is used to access partition. Class implements Flash_Access interface diff --git a/components/wear_levelling/test_apps/main/CMakeLists.txt b/components/wear_levelling/test_apps/main/CMakeLists.txt index bb8eeaa368f..84359c084b0 100644 --- a/components/wear_levelling/test_apps/main/CMakeLists.txt +++ b/components/wear_levelling/test_apps/main/CMakeLists.txt @@ -1,6 +1,6 @@ idf_component_register(SRCS test_wl.c PRIV_INCLUDE_DIRS . - PRIV_REQUIRES wear_levelling unity + PRIV_REQUIRES wear_levelling unity spi_flash EMBED_FILES test_partition_v1.bin ) target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format") diff --git a/components/wear_levelling/test_apps/main/test_wl.c b/components/wear_levelling/test_apps/main/test_wl.c index f8dd94454a7..3f9fed84a04 100644 --- a/components/wear_levelling/test_apps/main/test_wl.c +++ b/components/wear_levelling/test_apps/main/test_wl.c @@ -13,6 +13,7 @@ #include "esp_private/esp_clk.h" #include "sdkconfig.h" #include "esp_cpu.h" +#include "spi_flash_mmap.h" TEST_GROUP(wear_levelling); diff --git a/components/wear_levelling/test_wl_host/Makefile.files b/components/wear_levelling/test_wl_host/Makefile.files index 3b010634c3a..6c6f1b2705c 100644 --- a/components/wear_levelling/test_wl_host/Makefile.files +++ b/components/wear_levelling/test_wl_host/Makefile.files @@ -39,4 +39,5 @@ INCLUDE_DIRS := \ app_update/include \ hal/include \ spi_flash/include \ + esp_partition/include \ ) diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index c5caf20816c..40c124b9608 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -149,6 +149,7 @@ INPUT = \ $(PROJECT_PATH)/components/esp_netif/include/esp_netif_types.h \ $(PROJECT_PATH)/components/esp_netif/include/esp_netif.h \ $(PROJECT_PATH)/components/esp_netif/include/esp_vfs_l2tap.h \ + $(PROJECT_PATH)/components/esp_partition/include/esp_partition.h \ $(PROJECT_PATH)/components/esp_phy/include/esp_phy_init.h \ $(PROJECT_PATH)/components/esp_pm/include/$(IDF_TARGET)/pm.h \ $(PROJECT_PATH)/components/esp_pm/include/esp_pm.h \ @@ -237,7 +238,6 @@ INPUT = \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/uart_channel.h \ $(PROJECT_PATH)/components/spi_flash/include/esp_flash_spi_init.h \ $(PROJECT_PATH)/components/spi_flash/include/esp_flash.h \ - $(PROJECT_PATH)/components/spi_flash/include/esp_partition.h \ $(PROJECT_PATH)/components/spi_flash/include/spi_flash_mmap.h \ $(PROJECT_PATH)/components/spiffs/include/esp_spiffs.h \ $(PROJECT_PATH)/components/touch_element/include/touch_element/touch_button.h \ diff --git a/docs/en/migration-guides/release-5.x/5.0/storage.rst b/docs/en/migration-guides/release-5.x/5.0/storage.rst index 54454fe79f0..fb196aa9073 100644 --- a/docs/en/migration-guides/release-5.x/5.0/storage.rst +++ b/docs/en/migration-guides/release-5.x/5.0/storage.rst @@ -1,6 +1,34 @@ Storage ======= +New Component for the Partition APIs +------------------------------------ + +Breaking change: all the Partition API code has been moved to a new component :component:`esp_partition`. For the complete list of affected functions and data-types, see header file :component_file:`esp_partition.h `. + +These API functions and data-types were previously a part of the :component:`spi_flash` component, and thus possible dependencies on the ``spi_flash`` in existing applications may cause the build failure, in case of direct esp_partition_* APIs/data-types use (for instance, ``fatal error: esp_partition.h: No such file or directory`` at lines with ``#include "esp_partition.h"``). If you encounter such an issue, please update your project's CMakeLists.txt file as follows: + +Original dependency setup: + +.. code-block:: cmake + + idf_component_register(... + REQUIRES spi_flash) + +Updated dependency setup: + +.. code-block:: cmake + + idf_component_register(... + REQUIRES spi_flash esp_partition) + +.. note:: + + Please update relevant ``REQUIRES`` or ``PRIV_REQUIRES`` section according to your project. The above-presented code snippet is just an example. + +If the issue persists, please let us know and we will assist you with your code migration. + + SDMMC/SDSPI ----------- diff --git a/docs/zh_CN/migration-guides/release-5.x/5.0/storage.rst b/docs/zh_CN/migration-guides/release-5.x/5.0/storage.rst index 7e759515ab7..4146e6681c6 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.0/storage.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.0/storage.rst @@ -1,6 +1,34 @@ 存储 ======= +分区 API 的新组件 +------------------------------------ + +非兼容性更新：所有的分区 API 代码都已迁移到新组件 :component:`esp_partition` 中。如需查看所有受影响的函数及数据类型，请参见头文件 :component_file:`esp_partition.h `。 + +在以前，这些 API 函数和数据类型属于 :component:`spi_flash` 组件。因此，在现有的应用程序中或将依赖 ``spi_flash``，这也意味着在直接使用 esp_partition_* API/数据类型时，可能会导致构建过程失败（比如，在出现 ``#include "esp_partition.h"`` 的行中报错 ``fatal error: esp_partition.h: No such file or directory``）。如果遇到类似问题，请按以下步骤更新项目中的 CMakeLists.txt 文件： + +原有的依赖性设置： + +.. code-block:: cmake + + idf_component_register(... + REQUIRES spi_flash) + +更新后的依赖性设置： + +.. code-block:: cmake + + idf_component_register(... + REQUIRES spi_flash esp_partition) + +.. note:: + + 请根据项目的实际情况，更新相应的 ``REQUIRES`` 或是 ``PRIV_REQUIRES`` 部分。上述代码片段仅为范例。 + +如果问题仍未解决，请联系我们，我们将协助您进行代码迁移。 + + SDMMC/SDSPI ----------- diff --git a/examples/protocols/mqtt/ssl/main/app_main.c b/examples/protocols/mqtt/ssl/main/app_main.c index 3e6e8637848..a9781113d56 100644 --- a/examples/protocols/mqtt/ssl/main/app_main.c +++ b/examples/protocols/mqtt/ssl/main/app_main.c @@ -12,6 +12,8 @@ #include #include #include "esp_system.h" +#include "esp_partition.h" +#include "spi_flash_mmap.h" #include "nvs_flash.h" #include "esp_event.h" #include "esp_netif.h" diff --git a/examples/protocols/mqtt/ssl_ds/main/idf_component.yml b/examples/protocols/mqtt/ssl_ds/main/idf_component.yml index 80c7c822a87..8dd90a3b089 100644 --- a/examples/protocols/mqtt/ssl_ds/main/idf_component.yml +++ b/examples/protocols/mqtt/ssl_ds/main/idf_component.yml @@ -1,3 +1,3 @@ ## IDF Component Manager Manifest File dependencies: - espressif/esp_secure_cert_mgr: "^2.0.0" + espressif/esp_secure_cert_mgr: "^2.0.2" diff --git a/examples/storage/partition_api/partition_mmap/main/CMakeLists.txt b/examples/storage/partition_api/partition_mmap/main/CMakeLists.txt index cf2c455cb50..29f3e8d2d5d 100644 --- a/examples/storage/partition_api/partition_mmap/main/CMakeLists.txt +++ b/examples/storage/partition_api/partition_mmap/main/CMakeLists.txt @@ -1,2 +1,4 @@ idf_component_register(SRCS "main.c" - INCLUDE_DIRS ".") + INCLUDE_DIRS "." + REQUIRES esp_partition + PRIV_REQUIRES spi_flash) diff --git a/examples/storage/partition_api/partition_mmap/main/main.c b/examples/storage/partition_api/partition_mmap/main/main.c index 492dd8046b5..30d8ec2da71 100644 --- a/examples/storage/partition_api/partition_mmap/main/main.c +++ b/examples/storage/partition_api/partition_mmap/main/main.c @@ -8,6 +8,7 @@ #include #include #include "esp_partition.h" +#include "spi_flash_mmap.h" #include "esp_log.h" static const char *TAG = "example"; diff --git a/examples/storage/partition_api/partition_ops/main/CMakeLists.txt b/examples/storage/partition_api/partition_ops/main/CMakeLists.txt index cf2c455cb50..29f3e8d2d5d 100644 --- a/examples/storage/partition_api/partition_ops/main/CMakeLists.txt +++ b/examples/storage/partition_api/partition_ops/main/CMakeLists.txt @@ -1,2 +1,4 @@ idf_component_register(SRCS "main.c" - INCLUDE_DIRS ".") + INCLUDE_DIRS "." + REQUIRES esp_partition + PRIV_REQUIRES spi_flash) diff --git a/examples/storage/partition_api/partition_ops/main/main.c b/examples/storage/partition_api/partition_ops/main/main.c index 4afaa0d6a75..49486ad4fdb 100644 --- a/examples/storage/partition_api/partition_ops/main/main.c +++ b/examples/storage/partition_api/partition_ops/main/main.c @@ -8,6 +8,7 @@ #include #include #include "esp_partition.h" +#include "spi_flash_mmap.h" #include "esp_log.h" static const char *TAG = "example"; diff --git a/examples/system/flash_suspend/main/app_main.c b/examples/system/flash_suspend/main/app_main.c index 62a4829607f..73c744c9432 100644 --- a/examples/system/flash_suspend/main/app_main.c +++ b/examples/system/flash_suspend/main/app_main.c @@ -19,6 +19,7 @@ #include "esp_cpu.h" #include "esp_partition.h" #include "driver/gptimer.h" +#include "esp_flash.h" #define TIMER_RESOLUTION_HZ (1 * 1000 * 1000) // 1MHz resolution diff --git a/tools/idf_py_actions/hints.yml b/tools/idf_py_actions/hints.yml index e93f05a84e6..3448da17474 100644 --- a/tools/idf_py_actions/hints.yml +++ b/tools/idf_py_actions/hints.yml @@ -273,3 +273,8 @@ re: "fatal error: (tinyusb.h): No such file or directory" hint: "{} was removed. Please use esp_tinyusb component from IDF component manager instead.\nYou can install `esp_tinyusb` using 'idf.py add-dependency espressif/esp_tinyusb' command.\nRefer to the migration guide for more details." match_to_output: True + +- + re: "fatal error: esp_partition.h: No such file or directory" + hint: "All the Partition APIs have been moved to the new component 'esp_partition' - please, update your project dependencies. See Storage migration guide 5.x for more details." + match_to_output: True diff --git a/tools/mocks/esp_partition/CMakeLists.txt b/tools/mocks/esp_partition/CMakeLists.txt new file mode 100644 index 00000000000..ba87c7fbdbe --- /dev/null +++ b/tools/mocks/esp_partition/CMakeLists.txt @@ -0,0 +1,8 @@ +message(STATUS "building ESP_PARTITION MOCKS") + +idf_component_get_property(original_esp_partition_dir esp_partition COMPONENT_OVERRIDEN_DIR) + +idf_component_mock(INCLUDE_DIRS "${original_esp_partition_dir}/include" + REQUIRES spi_flash + MOCK_HEADER_FILES + ${original_esp_partition_dir}/include/esp_partition.h) diff --git a/tools/mocks/esp_partition/mock/mock_config.yaml b/tools/mocks/esp_partition/mock/mock_config.yaml new file mode 100644 index 00000000000..7afabb7f941 --- /dev/null +++ b/tools/mocks/esp_partition/mock/mock_config.yaml @@ -0,0 +1,10 @@ + :cmock: + :includes_h_pre_orig_header: + - esp_flash.h + :plugins: + - expect + - expect_any_args + - return_thru_ptr + - array + - ignore_arg + - callback diff --git a/tools/mocks/spi_flash/CMakeLists.txt b/tools/mocks/spi_flash/CMakeLists.txt index ceae52f0d57..a0f5bbd89dc 100644 --- a/tools/mocks/spi_flash/CMakeLists.txt +++ b/tools/mocks/spi_flash/CMakeLists.txt @@ -2,7 +2,7 @@ # On Espressif chips, too many dependencies are missing at the moment. # Furthermore, this component can only mock the interfaces of # spi_master.h and gpio.h. -message(STATUS "building SPI FLASH MOCKS (only esp_partition* API)") +message(STATUS "building SPI FLASH MOCKS (only esp_partition support)") idf_component_get_property(original_spi_flash_dir spi_flash COMPONENT_OVERRIDEN_DIR) @@ -19,6 +19,5 @@ endif() idf_component_mock(INCLUDE_DIRS ${include_dirs} REQUIRES esp_common MOCK_HEADER_FILES - ${original_spi_flash_dir}/include/esp_partition.h ${original_spi_flash_dir}/include/esp_flash.h ${original_spi_flash_dir}/include/spi_flash_mmap.h) diff --git a/tools/test_apps/system/g1_components/CMakeLists.txt b/tools/test_apps/system/g1_components/CMakeLists.txt index 0380cdd3952..3c2324800c2 100644 --- a/tools/test_apps/system/g1_components/CMakeLists.txt +++ b/tools/test_apps/system/g1_components/CMakeLists.txt @@ -59,6 +59,9 @@ set(extra_components_which_shouldnt_be_included mbedtls # partition_table is pulled in by app_update, esptool_py, bootloader; all to be removed partition_table + # esp_partition is a new component for separated IDF partition APIs. Added due to its involvement in the spi_flash + # code. To be possibly removed (?) + esp_partition # pthread is required by esp_system (for initialization only, can be made a weak dependency) # and cxx. See also [refactor-todo] about cxx, can it work without pthread? pthread diff --git a/tools/test_apps/system/panic/main/CMakeLists.txt b/tools/test_apps/system/panic/main/CMakeLists.txt index ba36e85dd49..83427066bf1 100644 --- a/tools/test_apps/system/panic/main/CMakeLists.txt +++ b/tools/test_apps/system/panic/main/CMakeLists.txt @@ -1,3 +1,3 @@ idf_component_register(SRCS "test_panic_main.c" INCLUDE_DIRS "." - REQUIRES spi_flash esp_system) + REQUIRES spi_flash esp_system esp_partition) diff --git a/tools/unit-test-app/components/test_utils/CMakeLists.txt b/tools/unit-test-app/components/test_utils/CMakeLists.txt index 63f56255c30..fee20cbf24d 100644 --- a/tools/unit-test-app/components/test_utils/CMakeLists.txt +++ b/tools/unit-test-app/components/test_utils/CMakeLists.txt @@ -25,6 +25,6 @@ endif() idf_component_register(SRCS ${srcs} INCLUDE_DIRS include PRIV_INCLUDE_DIRS private_include - REQUIRES spi_flash idf_test cmock + REQUIRES esp_partition idf_test cmock PRIV_REQUIRES perfmon driver esp_netif) target_compile_options(${COMPONENT_LIB} PRIVATE "-Wno-format")