pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'feat/add_well_know_vfs_docs' into 'master'

Browse Source 
docs(storage/vfs): add documentation for existing automounted vfs drivers

Closes IDF-10108

See merge request espressif/esp-idf!31160
This commit is contained in:
Jiang Jiang Jian
2024-09-29 16:37:35 +08:00
parent 72f3ef8469 542f65f1ff
commit dde0b46390
2 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/storage/vfs.rst
+9
View File
@@ -192,6 +192,15 @@ Standard I/O streams (``stdin``, ``stdout``, ``stderr``) are mapped to file desc
Note that creating an eventfd with ``EFD_SUPPORT_ISR`` will cause interrupts to be temporarily disabled when reading, writing the file and during the beginning and the ending of the ``select()`` when this file is set.
Well Known VFS Devices
----------------------
IDF defines several VFS devices that can be used by applications. These devices are, among others:
* ``/dev/uart/<UART NUMBER>`` - file mapping to an UART opened with the VFS driver. The UART number is the number of the UART peripheral.
* ``/dev/null`` - file that discards all data written to it and returns EOF when read. It is automatically created if :ref:`CONFIG_VFS_INITIALIZE_DEV_NULL` is enabled.
* ``/dev/console`` - file that is connected to the primary and secondary outputs specified in the menuconfig by :ref:`CONFIG_ESP_CONSOLE_UART` and :ref:`CONFIG_ESP_CONSOLE_SECONDARY` respectively. More information can be found here :doc:`../../api-guides/stdio`.
Application Examples
--------------------