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

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

See also
--------

- :doc:`./fatfs`
- :doc:`../../api-guides/partition-tables`

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

An example that 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 :example_file:`storage/wear_levelling/README.md` for more information.

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

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

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

High-level wear levelling functions :cpp:func:`esp_vfs_fat_spiflash_mount_rw_wl`, :cpp:func:`esp_vfs_fat_spiflash_unmount_rw_wl` and struct :cpp:class:`esp_vfs_fat_mount_config_t` are described in :doc:`./fatfs`.

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`
			`--------`

docs: Provide CN translation for wear-levelling.rst 2023-07-31 03:11:39 -04:00			- :doc:`./fatfs`
			- :doc:`../../api-guides/partition-tables`
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
			`Application Example`
			`-------------------`

docs: Provide CN translation for wear-levelling.rst 2023-07-31 03:11:39 -04:00			An example that 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 :example_file:`storage/wear_levelling/README.md` 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
docs: Provide CN translation for wear-levelling.rst 2023-07-31 03:11:39 -04:00			`High-level API Reference`
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			`------------------------`

			`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
docs: Provide CN translation for wear-levelling.rst 2023-07-31 03:11:39 -04:00			High-level wear levelling functions :cpp:func:`esp_vfs_fat_spiflash_mount_rw_wl`, :cpp:func:`esp_vfs_fat_spiflash_unmount_rw_wl` and struct :cpp:class:`esp_vfs_fat_mount_config_t` are described in :doc:`./fatfs`.
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
docs: Provide CN translation for wear-levelling.rst 2023-07-31 03:11:39 -04:00			`Mid-level API Reference`
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			`-----------------------`

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`