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.
Storage Examples
Storage and management of user and system data in module’s flash and on external memory / devices. This directory contains a range of examples ESP-IDF projects. These are intended to demonstrate the storage features, and to provide code that you can copy and adapt into your own projects.
Example Layout
The examples are grouped into sub-directories by category. Each category directory contains one or more example projects:
fatfs_basicminimal example of FatFS usage on SPI FLASHfatfs_advancedexample demonstrates how to use advanced features for working with FatFS such as automatic partition generationcustom_flash_driverexample demonstrates how to implement your own flash chip driver by overriding the default driver.emmcexample demonstrates how to use an eMMC chip with an ESP device.ext_flash_fatfsexample demonstrates how to use FATFS partition with external SPI FLASH chip.fatfsgenexample demonstrates how to use FATFS partition generatornvs_bootloaderexample demonstrates how to read data from NVS in the bootloader code.nvs_rw_blobexample demonstrates how to read and write a single integer value and a blob (binary large object) using NVS to preserve them between ESP module restarts.nvs_rw_valueexample demonstrates how to read and write a single integer value using NVS.nvs_rw_value_cxxexample demonstrates how to read and write a single integer value using NVS (it uses the C++ NVS handle API).nvs_consoleexample demonstrates how to use NVS through an interactive console interface.nvs_statisticsexample demonstrates how to obtain and interpret stats about used/available NVS storage entries in given NVS partition.nvs_iterationexample demonstrates iterating over entries of specific (or any) data type in given namespace, and the info to be obtained about the entries while doing so.partition_apiexamples demonstrate how to use different partition APIs.parttoolexample demonstrates common operations the partitions tool allows the user to perform.sd_cardexamples demonstrate how to use an SD card with an ESP device.semihost_vfsexample demonstrates how to use semihosting VFS driver with ESP device.spiffsexample demonstrates how to use SPIFFS with ESP device.spiffsgenexample demonstrates how to use the SPIFFS image generation tool spiffsgen.py to automatically create a SPIFFS.wear_levellingexample demonstrates how to use wear levelling library and FATFS library to store files in a partition inside SPI flash.
More
See the README.md file in the upper level examples directory for more information about examples.