littlefs.h File Reference

#include <zephyr/types.h>
#include <zephyr/kernel.h>
#include <zephyr/storage/flash_map.h>
#include <lfs.h>

Go to the source code of this file.

Data Structures
struct	fs_littlefs
	Filesystem info structure for LittleFS mount. More...

Macros
#define	FS_LITTLEFS_DISK_VERSION_MAJOR_GET(disk_version)
	Get the major part of the littlefs disk version.
#define	FS_LITTLEFS_DISK_VERSION_MINOR_GET(disk_version)
	Get the minor part of the littlefs disk version.
#define	FS_LITTLEFS_DECLARE_CUSTOM_CONFIG(name, alignment, read_sz, prog_sz, cache_sz, lookahead_sz)
	Define a littlefs configuration with customized size characteristics.
#define	FS_LITTLEFS_DECLARE_DEFAULT_CONFIG(name)
	Define a littlefs configuration with default characteristics.

Macro Definition Documentation

FS_LITTLEFS_DECLARE_CUSTOM_CONFIG

#define FS_LITTLEFS_DECLARE_CUSTOM_CONFIG	(		name,
			alignment,
			read_sz,
			prog_sz,
			cache_sz,
			lookahead_sz )

Value:

        static uint8_t __aligned(alignment) name ## _read_buffer[cache_sz];               \
        static uint8_t __aligned(alignment) name ## _prog_buffer[cache_sz];               \
        static uint32_t name ## _lookahead_buffer[(lookahead_sz) / sizeof(uint32_t)];     \
        static struct fs_littlefs name = {                                                \
                .cfg = {                                                                  \
                        .read_size = (read_sz),                                           \
                        .prog_size = (prog_sz),                                           \
                        .cache_size = (cache_sz),                                         \
                        .lookahead_size = (lookahead_sz),                                 \
                        .read_buffer = name ## _read_buffer,                              \
                        .prog_buffer = name ## _prog_buffer,                              \
                        .lookahead_buffer = name ## _lookahead_buffer,                    \
                },                                                                        \
        }

Define a littlefs configuration with customized size characteristics.

This defines static arrays required for caches, and initializes the littlefs configuration structure to use the provided values instead of the global Kconfig defaults. A pointer to the named object must be stored in the fs_mount_t::fs_data field of a fs_mount_t object.

To define an instance for the Kconfig defaults, use FS_LITTLEFS_DECLARE_DEFAULT_CONFIG.

To completely control file system configuration the application can directly define and initialize a fs_littlefs object. The application is responsible for ensuring the configured values are consistent with littlefs requirements.

Note

If you use a non-default configuration for cache size, you must also select CONFIG_FS_LITTLEFS_FC_HEAP_SIZE to relax the size constraints on per-file cache allocations.

Parameters

name	the name for the structure. The defined object has file scope.
alignment	needed alignment for read/prog buffer for specific device
read_sz	see CONFIG_FS_LITTLEFS_READ_SIZE
prog_sz	see CONFIG_FS_LITTLEFS_PROG_SIZE
cache_sz	see CONFIG_FS_LITTLEFS_CACHE_SIZE
lookahead_sz	see CONFIG_FS_LITTLEFS_LOOKAHEAD_SIZE

FS_LITTLEFS_DECLARE_DEFAULT_CONFIG

#define FS_LITTLEFS_DECLARE_DEFAULT_CONFIG

(

name

)

Value:

        FS_LITTLEFS_DECLARE_CUSTOM_CONFIG(name,                          \
                                          4,                             \
                                          CONFIG_FS_LITTLEFS_READ_SIZE,  \
                                          CONFIG_FS_LITTLEFS_PROG_SIZE,  \
                                          CONFIG_FS_LITTLEFS_CACHE_SIZE, \
                                          CONFIG_FS_LITTLEFS_LOOKAHEAD_SIZE)

Define a littlefs configuration with default characteristics.

This defines static arrays and initializes the littlefs configuration structure to use the default size configuration provided by Kconfig.

Parameters

name	the name for the structure. The defined object has file scope.

FS_LITTLEFS_DISK_VERSION_MAJOR_GET

#define FS_LITTLEFS_DISK_VERSION_MAJOR_GET

(

disk_version

)

Value:

FIELD_GET(GENMASK(31, 16), disk_version)

Get the major part of the littlefs disk version.

Parameters

disk_version

The disk version of littlefs partition

Returns

The major part of the littlefs disk version.

FS_LITTLEFS_DISK_VERSION_MINOR_GET

#define FS_LITTLEFS_DISK_VERSION_MINOR_GET

(

disk_version

)

Value:

FIELD_GET(GENMASK(15, 0), disk_version)

Get the minor part of the littlefs disk version.

Parameters

disk_version

The disk version of littlefs partition

Returns

The minor part of the littlefs disk version.