esp-idf/docs/en/api-reference/storage/index.rst

Storage API
***********

:link_to_translation:`zh_CN:[中文]`

This section contains reference of the high-level storage APIs. They are based on low-level drivers such as SPI flash, SD/MMC.

- :doc:`Partitions API <partition>` allow block based access to SPI flash according to the :doc:`/api-guides/partition-tables`.
- :doc:`Non-Volatile Storage library (NVS) <nvs_flash>` implements a fault-tolerant wear-levelled key-value storage in SPI NOR flash.
- :doc:`Virtual File System (VFS) <vfs>` library provides an interface for registration of file system drivers. SPIFFS, FAT and various other file system libraries are based on the VFS.
- :doc:`SPIFFS <spiffs>` is a wear-levelled file system optimized for SPI NOR flash, well suited for small partition sizes and low throughput
- :doc:`FAT <fatfs>` is a standard file system which can be used in SPI flash or on SD/MMC cards
- :doc:`Wear Levelling <wear-levelling>` library implements a flash translation layer (FTL) suitable for SPI NOR flash. It is used as a container for FAT partitions in flash.

.. note::

    It is suggested to use high-level APIs (``esp_partition`` or file system) instead of low-level driver APIs to access the SPI NOR flash.

    Due to the restriction of NOR flash and ESP hardware, accessing the main flash will affect the performance of the whole system. See :doc:`/api-reference/peripherals/spi_flash/index` to learn more about the limitations.

.. toctree::
    :maxdepth: 1

    fatfs
    fatfsgen
    mass_mfg.rst
    nvs_flash
    nvs_encryption
    nvs_partition_gen.rst
    nvs_partition_parse.rst
    sdmmc
    partition
    spiffs
    vfs
    wear-levelling

Code examples for this API section are provided in the :example:`storage` directory of ESP-IDF examples.
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`Storage API`
			`***********`

Add Chinese translation for the rst documents in storage folder, including: 1. docs/zh_CN/api-reference/storage/fatfs.rst 2. docs/zh_CN/api-reference/storage/index.rst 3. docs/zh_CN/api-reference/storage/sdmmc.rst 4. docs/zh_CN/api-reference/storage/spiffs.rst 5. docs/zh_CN/api-reference/storage/wear-levelling.rst 2019-09-06 07:12:36 -04:00			:link_to_translation:`zh_CN:[中文]`

docs: update document format issues 2023-10-13 15:55:41 -04:00			`This section contains reference of the high-level storage APIs. They are based on low-level drivers such as SPI flash, SD/MMC.`
docs: split spi_flash api-reference documents to peripherals folder 2022-11-23 03:48:17 -05:00
docs: update document format issues 2023-10-13 15:55:41 -04:00			- :doc:`Partitions API <partition>` allow block based access to SPI flash according to the :doc:`/api-guides/partition-tables`.
			- :doc:`Non-Volatile Storage library (NVS) <nvs_flash>` implements a fault-tolerant wear-levelled key-value storage in SPI NOR flash.
docs: split spi_flash api-reference documents to peripherals folder 2022-11-23 03:48:17 -05:00			- :doc:`Virtual File System (VFS) <vfs>` library provides an interface for registration of file system drivers. SPIFFS, FAT and various other file system libraries are based on the VFS.
docs: update document format issues 2023-10-13 15:55:41 -04:00			- :doc:`SPIFFS <spiffs>` is a wear-levelled file system optimized for SPI NOR flash, well suited for small partition sizes and low throughput
			- :doc:`FAT <fatfs>` is a standard file system which can be used in SPI flash or on SD/MMC cards
			- :doc:`Wear Levelling <wear-levelling>` library implements a flash translation layer (FTL) suitable for SPI NOR flash. It is used as a container for FAT partitions in flash.
docs: split spi_flash api-reference documents to peripherals folder 2022-11-23 03:48:17 -05:00
			`.. note::`
docs: update format issues for EN and CN files under api-reference/provisioning and api-reference/storage 2023-07-18 05:16:41 -04:00
docs: update document format issues 2023-10-13 15:55:41 -04:00			It is suggested to use high-level APIs (``esp_partition`` or file system) instead of low-level driver APIs to access the SPI NOR flash.
docs: split spi_flash api-reference documents to peripherals folder 2022-11-23 03:48:17 -05:00
docs: update document format issues 2023-10-13 15:55:41 -04:00			Due to the restriction of NOR flash and ESP hardware, accessing the main flash will affect the performance of the whole system. See :doc:`/api-reference/peripherals/spi_flash/index` to learn more about the limitations.
docs: split spi_flash api-reference documents to peripherals folder 2022-11-23 03:48:17 -05:00
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`.. toctree::`
docs: Alphbetically sort toctree This commit sorts the entries of variuos toctrees alphabetically. Indentation was also fixed. The order of some toctrees were not modified if the existing order had some form of suggested reading order. 2019-08-13 04:01:50 -04:00			`:maxdepth: 1`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`fatfs`
docs(storage): Make "Generating and Parsing FATFS on Host" doc more visible 2024-05-07 17:54:05 -04:00			`fatfsgen`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`mass_mfg.rst`
			`nvs_flash`
docs: Update `nvs_flash` docs for the HMAC-based NVS encr-keys protection scheme - Also updated the `nvs_partition_generator` and `mass_mfg` tools documentation 2023-04-18 08:39:38 -04:00			`nvs_encryption`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`nvs_partition_gen.rst`
add: data classes for parsing NVS binary data add: functions to print formatted NVS data add: color support via ANSI escape sequences add: documentation 2022-04-14 06:08:26 -04:00			`nvs_partition_parse.rst`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`sdmmc`
docs: split spi_flash api-reference documents to peripherals folder 2022-11-23 03:48:17 -05:00			`partition`
docs: Updated CN translation for index files in api-guides and api-reference 2021-12-30 05:50:55 -05:00			`spiffs`
			`vfs`
			`wear-levelling`
docs:update CN translation for API reference storage(fatfs and index) 2021-09-03 04:06:02 -04:00
Doc/review api ref storage 2019-06-17 02:23:52 -04:00			Code examples for this API section are provided in the :example:`storage` directory of ESP-IDF examples.