Awesome

LittleFS for ESP-IDF.

What is LittleFS?

LittleFS is a small fail-safe filesystem for microcontrollers. We ported LittleFS to esp-idf (specifically, the ESP32) because SPIFFS was too slow, and FAT was too fragile.

How to Use

ESP-IDF

There are two ways to add this component to your project

1. As a ESP-IDF managed component: In your project directory run

idf.py add-dependency joltwallet/littlefs==1.16.0

2. As a submodule: In your project, add this as a submodule to your components/ directory.

git submodule add https://github.com/joltwallet/esp_littlefs.git
git submodule update --init --recursive

The library can be configured via idf.py menuconfig under Component config->LittleFS.

Example

User @wreyford has kindly provided a demo repo showing the use of esp_littlefs. A modified copy exists in the example/ directory.

PlatformIO

Add to the following line to your project's platformio.ini file:

lib_deps = https://github.com/joltwallet/esp_littlefs.git

Example platformio.ini file:

[env]
platform = espressif32
framework = espidf
monitor_speed = 115200

[common]
lib_deps = https://github.com/joltwallet/esp_littlefs.git

[env:nodemcu-32s]
board = nodemcu-32s
board_build.filesystem = littlefs
board_build.partitions = min_littlefs.csv
lib_deps = ${common.lib_deps}

Example min_littlefs.cvs flash partition layout:

# Name,   Type, SubType,  Offset,  Size, Flags
nvs,      data, nvs,      0x9000,  0x5000,
otadata,  data, ota,      0xe000,  0x2000,
app0,     app,  ota_0,    0x10000, 0x1E0000,
app1,     app,  ota_1,    0x1F0000,0x1E0000,
littlefs, data, spiffs,   0x3D0000,0x20000,
coredump, data, coredump, 0x3F0000,0x10000,

Currently, it is required to modify CMakeList.txt. Add the following 2 lines to the your project's CMakeList.txt:

get_filename_component(configName "${CMAKE_BINARY_DIR}" NAME)
list(APPEND EXTRA_COMPONENT_DIRS "${CMAKE_SOURCE_DIR}/.pio/libdeps/${configName}/esp_littlefs")

Example CMakeList.txt:

cmake_minimum_required(VERSION 3.16.0)
include($ENV{IDF_PATH}/tools/cmake/project.cmake)

get_filename_component(configName "${CMAKE_BINARY_DIR}" NAME)
list(APPEND EXTRA_COMPONENT_DIRS "${CMAKE_SOURCE_DIR}/.pio/libdeps/${configName}/esp_littlefs")

project(my_project_name_here)

To configure LittleFS from PlatformIO, run the following command:

$ pio run -t menuconfig

An entry Component config->LittleFS should be available for configuration. If not, check your CMakeList.txt configuration.

Documentation

See the official ESP-IDF SPIFFS documentation, basically all the functionality is the same; just replace spiffs with littlefs in all function calls.

Also see the comments in include/esp_littlefs.h

Slight differences between this configuration and SPIFFS's configuration is in the esp_vfs_littlefs_conf_t:

1. max_files field doesn't exist since we removed the file limit, thanks to @X-Ryl669
2. partition_label is not allowed to be NULL. You must specify the partition name from your partition table. This is because there isn't a define littlefs partition subtype in esp-idf. The subtype doesn't matter.
   • Alternatively, you can specify an esp_partition_t* to a partition and set partition_label=NULL.
3. grow_on_mount will expand an existing filesystem to fill the partition. Defaults to false.
   • LittleFS filesystems can only grow, they cannot shrink.

Filesystem Image Creation

At compile time, a filesystem image can be created and flashed to the device by adding the following to your project's CMakeLists.txt file:

littlefs_create_partition_image(partition_name path_to_folder_containing_files FLASH_IN_PROJECT)

If FLASH_IN_PROJECT is not specified, the image will still be generated, but you will have to flash it manually using esptool.py, parttool.py, or a custom build system target.

For example, if your partition table looks like:

# Name,   Type, SubType,  Offset,  Size, Flags
nvs,      data, nvs,      0x9000,  0x6000,
phy_init, data, phy,      0xf000,  0x1000,
factory,  app,  factory,  0x10000, 1M,
graphics,  data, spiffs,         ,  0xF0000, 

and your project has a folder called device_graphics/, your call should be:

littlefs_create_partition_image(graphics device_graphics FLASH_IN_PROJECT)

Performance

Here are some naive benchmarks to give a vague indicator on performance. Tests were performed with the following configuration:

• ESP-IDF: v4.4
• Target: ESP32
• CPU Clock: 160MHz
• Flash SPI Freq: 80MHz
• Flash SPI Mode: QIO

In these tests, FAT has a cache size of 4096, and SPIFFS has a cahce size of 256 bytes.

Formatting a 512KB partition

FAT:         549,494 us
SPIFFS:   10,715,425 us
LittleFS:    110,997 us

Writing 5 88KB files

FAT:                            7,124,812 us
SPIFFS*:                       99,138,905 us
LittleFS (cache=128):           8,261,920 us
LittleFS (cache=512 default):   6,356,247 us
LittleFS (cache=4096):          6,026,592 us
*Only wrote 374,784 bytes instead of the benchmark 440,000, so this value is extrapolated

In the above test, SPIFFS drastically slows down as the filesystem fills up. Below is the specific breakdown of file write times for SPIFFS. Not sure what happens on the last file write.

SPIFFS:

88000 bytes written in 2190635 us
88000 bytes written in 2190321 us
88000 bytes written in 5133605 us
88000 bytes written in 16570667 us
22784 bytes written in 73053677 us

Reading 5 88KB files

FAT:                            5,685,230 us
SPIFFS*:                        5,162,289 us
LittleFS (cache=128):           6,284,142 us
LittleFS (cache=512 default):   5,874,931 us
LittleFS (cache=4096):          5,731,385 us
*Only read 374,784 bytes instead of the benchmark 440,000, so this value is extrapolated

Deleting 5 88KB files

FAT:                              680,358 us
SPIFFS*:                        1,653,500 us
LittleFS (cache=128):              86,090 us
LittleFS (cache=512 default):      53,705 us
LittleFS (cache=4096):             27,709 us
*The 5th file was smaller, did not extrapolate value.

Tips, Tricks, and Gotchas

• LittleFS operates on blocks, and blocks have a size of 4096 bytes on the ESP32.

• A freshly formatted LittleFS will have 2 blocks in use, making it seem like 8KB are in use.

• The esp32 has flash concurrency constraints. When using UART (either for data transfer or generic logging) at the same time, you MUST enable the following option in KConfig: menuconfig > Component config > Driver config > UART > UART ISR in IRAM.

Running Unit Tests

To flash the unit-tester app and the unit-tests, clone or symbolicly link this component to $IDF_PATH/tools/unit-test-app/components/littlefs. Make sure the folder name is littlefs, not esp_littlefs. Then, run the following:

cd $IDF_PATH/tools/unit-test-app
idf.py menuconfig  # See notes
idf.py -T littlefs -p YOUR_PORT_HERE flash monitor

In menuconfig:

• Set the partition table to components/littlefs/partition_table_unit_test_app.csv

• Double check your crystal frequency ESP32_XTAL_FREQ_SEL; my board doesn't work with autodetect.

To test on an encrypted partition, add the encrypted flag to the flash_test partition in partition_table_unit_test_app.csv. I.e.

flash_test,  data, spiffs,    ,        512K, encrypted

Also make sure that CONFIG_SECURE_FLASH_ENC_ENABLED=y in menuconfig.

The unit tester can then be flashed via the command:

idf.py -T littlefs -p YOUR_PORT_HERE encrypted-flash monitor

Breaking Changes

• July 22, 2020 - Changed attribute type for file timestamp from 0 to 0x74 ('t' ascii value).
• May 3, 2023 - All logging tags have been changed to a unified esp_littlefs.

Acknowledgement

This code base was heavily modeled after the SPIFFS esp-idf component.