zephyr,fstab,littlefs

Vendor: Zephyr-specific binding

Note

An implementation of a driver matching this compatible is available in subsys/fs/littlefs_fs.c.

Description

Description of pre-defined file systems.

Properties

Properties not inherited from the base binding file.

Name

Type

Details

mount-point

string

The absolute path used as the file system mount point.

This property is required.

partition

phandle

A reference to the file system's partition.

This property is required.

automount

boolean

Mount file system on boot if present.

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

read-only

boolean

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

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

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.

read-size

int

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

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

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

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

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_BLOCK_CYCLES.

This property is required.