alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-09-30 19:19:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Storage: Partition APIs moved to the new component 'esp_partition'

Browse Source 
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
This commit is contained in:
Martin Vychodil
2022-10-14 14:15:32 +02:00
parent 54d0d870a6
commit c9c7573f71
78 changed files with 269 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/en/migration-guides/release-5.x/5.0/storage.rst
View File

@@ -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 <esp_partition/include/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
-----------