Skip to content

Commit bab9498

Browse files
committed
docs(storage/vfs): add documentation for existing automounted vfs drivers
1 parent b0712b6 commit bab9498

File tree

1 file changed

+9
-0
lines changed
  • docs/en/api-reference/storage

1 file changed

+9
-0
lines changed

docs/en/api-reference/storage/vfs.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,15 @@ Standard I/O streams (``stdin``, ``stdout``, ``stderr``) are mapped to file desc
192192

193193
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.
194194

195+
Well known VFS devices
196+
----------------------
197+
198+
IDF defines several VFS devices that can be used by applications. These devices are, among others:
199+
200+
* ``/dev/uart/<UART NUMBER>`` - file mapping to an UART opened with the VFS driver. The UART number is the number of the UART peripheral.
201+
* ``/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.
202+
* ``/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`.
203+
195204
Application Examples
196205
--------------------
197206

0 commit comments

Comments
 (0)