From bab9498a523999f9c9c2a0295a0943a24b24084b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Rohl=C3=ADnek?= Date: Wed, 29 May 2024 08:46:09 +0200 Subject: [PATCH] docs(storage/vfs): add documentation for existing automounted vfs drivers --- docs/en/api-reference/storage/vfs.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/en/api-reference/storage/vfs.rst b/docs/en/api-reference/storage/vfs.rst index e0a3a104b7..fd49db948f 100644 --- a/docs/en/api-reference/storage/vfs.rst +++ b/docs/en/api-reference/storage/vfs.rst @@ -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/`` - 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 --------------------