:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: zephyr,fstab,littlefs
.. _dtbinding_zephyr_fstab_littlefs:

zephyr,fstab,littlefs
#####################

Vendor: :ref:`Zephyr-specific binding <dt_vendor_zephyr>`

Description
***********



.. code-block:: none

   Description of pre-defined file systems.

Properties
**********

.. tabs::

   .. group-tab:: Node specific properties

      Properties not inherited from the base binding file.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``read-size``
           - ``int``
           - .. code-block:: none

                The size of file system read operations, in bytes.

                All read operations will be a multiple of this value.  A
                reasonable default is 16.

                This corresponds to CONFIG_FS_LITTLEFS_READ_SIZE.



             This property is **required**.

         * - ``prog-size``
           - ``int``
           - .. code-block:: none

                The size of file system program (write) operations, in bytes.

                All program operations will be a multiple of this value.  A
                reasonable default is 16.

                This corresponds to CONFIG_FS_LITTLEFS_PROG_SIZE.



             This property is **required**.

         * - ``cache-size``
           - ``int``
           - .. code-block:: none

                The size of block caches, in bytes.

                Each cache buffers a portion of a block in RAM.  The littlefs
                needs a read cache, a program cache, and one additional cache per
                file. Larger caches can improve performance by storing more data
                and reducing the number of disk accesses. Must be a multiple of
                the read and program sizes of the underlying flash device, and a
                factor of the block size.

                A reasonable default is 64.

                This corresponds to CONFIG_FS_LITTLEFS_CACHE_SIZE.



             This property is **required**.

         * - ``lookahead-size``
           - ``int``
           - .. code-block:: none

                The size of the lookahead buffer, in bytes.

                A larger lookahead buffer increases the number of blocks found
                during an allocation pass. The lookahead buffer is stored as a
                compact bitmap, so each byte of RAM can track 8 blocks. Must be a
                multiple of 8.

                A reasonable default is 32.

                This corresponds to CONFIG_FS_LITTLEFS_LOOKAHEAD_SIZE.



             This property is **required**.

         * - ``block-cycles``
           - ``int``
           - .. code-block:: none

                The number of erase cycles before moving data to another block.

                For dynamic wear leveling, the number of erase cycles before data
                is moved to another block.  Set to a non-positive value to disable
                leveling.

                This corresponds to CONFIG_FS_LITTLEFS_LOOKAHEAD_SIZE.



             This property is **required**.

         * - ``mount-point``
           - ``string``
           - .. code-block:: none

                The absolute path used as the file system mount point.



             This property is **required**.

         * - ``partition``
           - ``phandle``
           - .. code-block:: none

                A reference to the file system's partition.



             This property is **required**.

         * - ``automount``
           - ``boolean``
           - .. code-block:: none

                Mount file system on boot if present.

                During initialization the file system driver will attempt to mount
                this partition.



         * - ``read-only``
           - ``boolean``
           - .. code-block:: none

                Mount file system read-only if present.

                This adds the FS_MOUNT_FLAG_READ_ONLY option to be set in the
                mount descriptor generated for the file system.



         * - ``no-format``
           - ``boolean``
           - .. code-block:: none

                Do not format file system if mount fails.

                This causes the FS_MOUNT_FLAG_NO_FORMAT option to be set in the
                mount descriptor generated for the file system.



         * - ``disk-access``
           - ``boolean``
           - .. code-block:: none

                Use disk-access for accessing storage media.

                This causes the FS_MOUNT_FLAG_USE_DISK_ACCESS option to be set in
                the mount descriptor generated for the file system.





   .. group-tab:: Deprecated node specific properties

      Deprecated properties not inherited from the base binding file.

      (None)

   .. group-tab:: Base properties

      Properties inherited from the base binding file, which defines
      common properties that may be set on many nodes. Not all of these
      may apply to the "zephyr,fstab,littlefs" compatible.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``status``
           - ``string``
           - .. code-block:: none

                indicates the operational status of a device


             Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``

             See :ref:`dt-important-props` for more information.

         * - ``compatible``
           - ``string-array``
           - .. code-block:: none

                compatible strings


             This property is **required**.

             See :ref:`dt-important-props` for more information.

         * - ``reg``
           - ``array``
           - .. code-block:: none

                register space


             See :ref:`dt-important-props` for more information.

         * - ``reg-names``
           - ``string-array``
           - .. code-block:: none

                name of each register space


         * - ``interrupts``
           - ``array``
           - .. code-block:: none

                interrupts for device


             See :ref:`dt-important-props` for more information.

         * - ``interrupts-extended``
           - ``compound``
           - .. code-block:: none

                extended interrupt specifier for device


         * - ``interrupt-names``
           - ``string-array``
           - .. code-block:: none

                name of each interrupt


         * - ``interrupt-parent``
           - ``phandle``
           - .. code-block:: none

                phandle to interrupt controller node


         * - ``label``
           - ``string``
           - .. code-block:: none

                Human readable string describing the device (used as device_get_binding() argument)



             See :ref:`dt-important-props` for more information.

             This property is **deprecated**.

         * - ``clocks``
           - ``phandle-array``
           - .. code-block:: none

                Clock gate information


         * - ``clock-names``
           - ``string-array``
           - .. code-block:: none

                name of each clock


         * - ``#address-cells``
           - ``int``
           - .. code-block:: none

                number of address cells in reg property


         * - ``#size-cells``
           - ``int``
           - .. code-block:: none

                number of size cells in reg property


         * - ``dmas``
           - ``phandle-array``
           - .. code-block:: none

                DMA channels specifiers


         * - ``dma-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of DMA channel specifiers


         * - ``io-channels``
           - ``phandle-array``
           - .. code-block:: none

                IO channels specifiers


         * - ``io-channel-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of IO channel specifiers


         * - ``mboxes``
           - ``phandle-array``
           - .. code-block:: none

                mailbox / IPM channels specifiers


         * - ``mbox-names``
           - ``string-array``
           - .. code-block:: none

                Provided names of mailbox / IPM channel specifiers


         * - ``wakeup-source``
           - ``boolean``
           - .. code-block:: none

                Property to identify that a device can be used as wake up source.

                When this property is provided a specific flag is set into the
                device that tells the system that the device is capable of
                wake up the system.

                Wake up capable devices are disabled (interruptions will not wake up
                the system) by default but they can be enabled at runtime if necessary.



         * - ``power-domain``
           - ``phandle``
           - .. code-block:: none


                Power domain the device belongs to.

                The device will be notified when the power domain it belongs to is either
                suspended or resumed.



         * - ``zephyr,pm-device-runtime-auto``
           - ``boolean``
           - .. code-block:: none

                Automatically configure the device for runtime power management after the
                init function runs.