mirror of
https://github.com/espressif/esp-idf.git
synced 2026-04-27 19:13:21 +00:00
Adam Múdry
749c446a7e
Add a new CMake function esp_partition_flash_binary() that provides a unified API for registering partition data binaries to be flashed. It replaces the direct esptool_py_flash_target calls scattered across components (spiffs, fatfs, nvs_flash) with a single function that: - Resolves partition offset from the partition table automatically - Determines encryption requirements (auto-detect or ALWAYS_PLAINTEXT) - Creates per-partition flash targets (e.g. idf.py <partition>-flash) - Optionally includes the binary in `idf.py flash` via FLASH_IN_PROJECT On the linux target, the function registers binaries for pre-loading into the emulated flash. A build-time manifest (linux_flash_data.txt) is generated via file(GENERATE), and partition_linux.c reads it at runtime to copy each binary into the memory-mapped flash buffer at the correct offset. The partition_ops example is updated to use the new function and includes a custom_partition with pre-built data to demonstrate the full workflow, including on the linux target.
64 lines
2.3 KiB
CMake
64 lines
2.3 KiB
CMake
# nvs_create_partition_image
|
|
#
|
|
# Create a NVS image of the specified CSV on the host during build and
|
|
# optionally have the created image flashed using `idf.py flash`
|
|
function(nvs_create_partition_image partition csv)
|
|
set(options FLASH_IN_PROJECT)
|
|
set(one VERSION)
|
|
set(multi DEPENDS)
|
|
cmake_parse_arguments(arg "${options}" "${one}" "${multi}" "${ARGN}")
|
|
|
|
# Default to version 2
|
|
if(NOT DEFINED arg_VERSION)
|
|
set(arg_VERSION 2)
|
|
endif()
|
|
|
|
idf_build_get_property(idf_path IDF_PATH)
|
|
set(nvs_partition_gen_py
|
|
${PYTHON}
|
|
${idf_path}/components/nvs_flash/nvs_partition_generator/nvs_partition_gen.py
|
|
)
|
|
|
|
get_filename_component(csv_full_path ${csv} ABSOLUTE)
|
|
|
|
partition_table_get_partition_info(size "--partition-name ${partition}" "size")
|
|
partition_table_get_partition_info(offset "--partition-name ${partition}" "offset")
|
|
|
|
if("${size}" AND "${offset}")
|
|
set(image_file ${CMAKE_BINARY_DIR}/${partition}.bin)
|
|
|
|
add_custom_command(
|
|
OUTPUT ${image_file}
|
|
COMMAND ${nvs_partition_gen_py} generate --version ${arg_VERSION} ${csv_full_path} ${image_file} ${size}
|
|
MAIN_DEPENDENCY ${csv_full_path}
|
|
DEPENDS ${arg_DEPENDS}
|
|
COMMENT "Generating NVS partition image for ${partition} from ${csv}"
|
|
)
|
|
|
|
add_custom_target(nvs_${partition}_bin ALL DEPENDS ${image_file})
|
|
|
|
set_property(
|
|
DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
|
|
APPEND
|
|
PROPERTY ADDITIONAL_CLEAN_FILES ${image_file}
|
|
)
|
|
|
|
set(register_target_optional_args ALWAYS_PLAINTEXT DEPENDS nvs_${partition}_bin)
|
|
|
|
if(arg_FLASH_IN_PROJECT)
|
|
list(APPEND register_target_optional_args FLASH_IN_PROJECT)
|
|
if(CONFIG_SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT)
|
|
list(APPEND register_target_optional_args FLASH_IN_PROJECT_DEPENDENCY_TARGETS encrypted-flash)
|
|
endif()
|
|
endif()
|
|
|
|
esp_partition_register_target(${partition} "${image_file}" ${register_target_optional_args})
|
|
else()
|
|
set(message
|
|
"Failed to create NVS image for partition '${partition}'. "
|
|
"Check project configuration if using the correct partition table file."
|
|
)
|
|
fail_at_build_time(nvs_${partition}_bin "${message}")
|
|
endif()
|
|
endfunction()
|