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

Merge branch 'docs/partition_table_api_guide_update_data_subtypes' into 'master'

Browse Source 
docs(storage): Add supported data partition subtypes

Closes IDF-818

See merge request espressif/esp-idf!25614
This commit is contained in:
Adam Múdry
2023-09-06 15:31:39 +08:00
parent 4f7e7ce6c9 13d2b5bc93
commit 2b5d12858d
3 changed files with 25 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/en/api-guides/partition-tables.rst
View File

@@ -127,7 +127,16 @@ See enum :cpp:type:`esp_partition_subtype_t` for the full list of subtypes defin
- It is used to store NVS encryption keys when `NVS Encryption` feature is enabled.
- The size of this partition should be 4096 bytes (minimum partition size).
- There are other predefined data subtypes for data storage supported by ESP-IDF. These include :doc:`FAT filesystem </api-reference/storage/fatfs>` (:cpp:enumerator:`ESP_PARTITION_SUBTYPE_DATA_FAT`), :doc:`SPIFFS </api-reference/storage/spiffs>` (:cpp:enumerator:`ESP_PARTITION_SUBTYPE_DATA_SPIFFS`), etc.
- There are other predefined data subtypes for data storage supported by ESP-IDF. These include:
- ``coredump`` (0x03) is for storing core dumps while using a custom partition table CSV file. See :doc:`/api-guides/core_dump` for more details.
- ``efuse`` (0x05) is for emulating eFuse bits using :ref:`virtual-efuses`.
- ``undefined`` (0x06) is implicitly used for data partitions with unspecified (empty) subtype, but it is possible to explicitly mark them as undefined as well.
- ``fat`` (0x81) is for :doc:`/api-reference/storage/fatfs`.
- ``spiffs`` (0x82) is for :doc:`/api-reference/storage/spiffs`.
- ``littlefs`` (0x83) is for `LittleFS filesystem <https://github.com/littlefs-project/littlefs>`_. See :example:`storage/littlefs` example for more details.
.. Comment: ``esphttpd`` (0x80) was not added to the list because there is no docs section for it and it is not clear whether user should use it explicitly.
Other subtypes of ``data`` type are reserved for future ESP-IDF uses.