feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

docs(storage): Add supported data partition subtypes

Browse Source
This commit is contained in:
Adam Múdry
2023-08-28 19:45:33 +02:00
parent c9adbe13d8
commit 087de4c77a
2 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -123,7 +123,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. - 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). - 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:`Core Dump </api-guides/core_dump>` for more details.
- ``efuse`` (0x05) is for emulating eFuse bits using :ref:`Virtual eFuses <virtual-efuses>`.
- ``undefined`` (0x06) is implicitly used for data partitions with unspecified (empty) subtype, however it is possible to explicitly mark them as undefined as well.
- ``fat`` (0x81) is for :doc:`FAT filesystem </api-reference/storage/fatfs>`.
- ``spiffs`` (0x82) is for :doc:`SPIFFS filesystem </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. Other subtypes of ``data`` type are reserved for future ESP-IDF uses.

2
docs/en/api-reference/system/efuse.rst
View File

@@ -461,6 +461,8 @@ There is an example test :example_file:`system/efuse/CMakeLists.txt` which adds
Debug eFuse & Unit Tests Debug eFuse & Unit Tests
------------------------ ------------------------
.. _virtual-efuses:
Virtual eFuses Virtual eFuses
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^