esp-idf/docs/en/api-reference/storage/wear-levelling.rst

.. include:: ../../../../components/wear_levelling/README.rst

See also
--------

- :doc:`FAT Filesystem <./fatfs>`
- :doc:`Partition Table documentation <../../api-guides/partition-tables>`

Application Example
-------------------

An example which combines the wear levelling driver with the FATFS library is provided in the :example:`storage/wear_levelling` directory. This example initializes the wear levelling driver, mounts FATFS partition, as well as writes and reads data from it using POSIX and C library APIs. See the :example_file:`storage/wear_levelling/README.md` file for more information.

High level API Reference
------------------------

Header Files
^^^^^^^^^^^^

* :component_file:`fatfs/vfs/esp_vfs_fat.h`

Functions
^^^^^^^^^

.. doxygenfunction:: esp_vfs_fat_spiflash_mount
.. doxygenstruct:: esp_vfs_fat_mount_config_t
    :members:
.. doxygenfunction:: esp_vfs_fat_spiflash_unmount

Mid level API Reference
-----------------------

.. include-build-file:: inc/wear_levelling.inc
Replace all DOS line endings with Unix Command run was: git ls-tree -r HEAD --name-only \| xargs dos2unix 2018-07-04 19:01:03 -04:00			`.. include:: ../../../../components/wear_levelling/README.rst`

			`See also`
			`--------`

			- :doc:`FAT Filesystem <./fatfs>`
			- :doc:`Partition Table documentation <../../api-guides/partition-tables>`

			`Application Example`
			`-------------------`

docs: Fix broken or incorrect link roles to IDF files & directories 2020-02-10 03:52:41 -05:00			An example which combines the wear levelling driver with the FATFS library is provided in the :example:`storage/wear_levelling` directory. This example initializes the wear levelling driver, mounts FATFS partition, as well as writes and reads data from it using POSIX and C library APIs. See the :example_file:`storage/wear_levelling/README.md` file for more information.
Replace all DOS line endings with Unix Command run was: git ls-tree -r HEAD --name-only \| xargs dos2unix 2018-07-04 19:01:03 -04:00
			`High level API Reference`
			`------------------------`

			`Header Files`
			`^^^^^^^^^^^^`

docs: Fix broken or incorrect link roles to IDF files & directories 2020-02-10 03:52:41 -05:00			* :component_file:`fatfs/vfs/esp_vfs_fat.h`
Replace all DOS line endings with Unix Command run was: git ls-tree -r HEAD --name-only \| xargs dos2unix 2018-07-04 19:01:03 -04:00
			`Functions`
			`^^^^^^^^^`

			`.. doxygenfunction:: esp_vfs_fat_spiflash_mount`
			`.. doxygenstruct:: esp_vfs_fat_mount_config_t`
			`:members:`
			`.. doxygenfunction:: esp_vfs_fat_spiflash_unmount`

			`Mid level API Reference`
			`-----------------------`

docs: add new top-level docs builder that builds docs for a single chip 2019-11-12 22:46:16 -05:00			`.. include-build-file:: inc/wear_levelling.inc`
Replace all DOS line endings with Unix Command run was: git ls-tree -r HEAD --name-only \| xargs dos2unix 2018-07-04 19:01:03 -04:00