Merge pull request #250 from joltwallet/v6-support

BrianPugh · web-flow · commit 2b0faf0c77c1 · 2025-12-05T14:49:04.000-05:00
Add v6 support.
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        idf_ver: ["release-v5.0", "release-v5.1", "release-v5.2", "release-v5.3", "release-v5.4"] # re-add "latest" once we support v6.0
+        idf_ver: ["release-v5.0", "release-v5.1", "release-v5.2", "release-v5.3", "release-v5.4", "release-v6.0", "latest"]
         idf_target: ["esp32"]
         include:
           - idf_ver: "release-v5.2"
@@ -25,6 +25,10 @@ jobs:
             idf_target: esp32c3
           - idf_ver: "release-v5.2"
             idf_target: esp32s3
+          - idf_ver: "latest"
+            idf_target: esp32c6
+          - idf_ver: "latest"
+            idf_target: esp32p4
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -48,8 +52,20 @@ jobs:
           path: "example/"
           command: apt-get update && apt-get install -y python3-venv && idf.py --version && idf.py build
 
-      - name: esp-idf build tests
+      # ESP-IDF v5.x: Use legacy unit-test-app
+      - name: esp-idf build tests (v5.x)
+        if: ${{ !contains(matrix.idf_ver, 'v6.') && matrix.idf_ver != 'latest' }}
         uses: espressif/esp-idf-ci-action@main
         with:
           esp_idf_version: ${{ matrix.idf_ver }}
           command: '/bin/bash -c " ln -s /app /opt/esp/idf/tools/unit-test-app/components/littlefs; cd /opt/esp/idf/tools/unit-test-app; idf.py -T littlefs build"'
+
+      # ESP-IDF v6.0+: Use new test_apps structure
+      - name: esp-idf build tests (v6.0+)
+        if: ${{ contains(matrix.idf_ver, 'v6.') || matrix.idf_ver == 'latest' }}
+        uses: espressif/esp-idf-ci-action@main
+        with:
+          esp_idf_version: ${{ matrix.idf_ver }}
+          target: ${{ matrix.idf_target }}
+          path: "test_apps/"
+          command: idf.py build
diff --git a/.gitignore b/.gitignore
@@ -7,5 +7,10 @@ example/sdkconfig
 example/sdkconfig.old
 example/dependencies.lock
 
+test_apps/build/
+test_apps/sdkconfig
+test_apps/sdkconfig.old
+test_apps/dependencies.lock
+
 *.DS_Store
 */.cache
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,4 +1,4 @@
-cmake_minimum_required(VERSION 3.10)
+cmake_minimum_required(VERSION 3.16)
 
 file(GLOB SOURCES src/littlefs/*.c)
 list(APPEND SOURCES src/esp_littlefs.c src/littlefs_esp_part.c src/lfs_config.c)
diff --git a/README.md b/README.md
@@ -226,6 +226,8 @@ LittleFS (cache=4096):             27,709 us
 
 # Running Unit Tests
 
+## ESP-IDF v5.x
+
 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:
@@ -257,6 +259,19 @@ The unit tester can then be flashed via the command:
 idf.py -T littlefs -p YOUR_PORT_HERE encrypted-flash monitor
 ```
 
+## ESP-IDF v6.0+
+
+ESP-IDF v6.0 removed the legacy `unit-test-app`. Instead, use the standalone test app in `test_apps/`:
+
+```
+cd test_apps
+idf.py set-target esp32  # Or your target
+idf.py build
+idf.py -p YOUR_PORT_HERE flash monitor
+```
+
+Once running, press Enter to see the test menu. You can run all tests by typing `*` or run specific tests by name or number.
+
 # Breaking Changes
 
 * July 22, 2020 - Changed attribute type for file timestamp from `0` to `0x74` ('t' ascii value).
diff --git a/src/esp_littlefs.c b/src/esp_littlefs.c
@@ -17,6 +17,7 @@
 #include "freertos/semphr.h"
 #include "freertos/task.h"
 #include "littlefs_api.h"
+#include <dirent.h>
 #include <sys/dirent.h>
 #include <sys/errno.h>
 #include <sys/fcntl.h>
@@ -36,24 +37,7 @@
 #endif
 
 #include "spi_flash_mmap.h"
-
-#if CONFIG_IDF_TARGET_ESP32
-#include "esp32/rom/spi_flash.h"
-#elif CONFIG_IDF_TARGET_ESP32S2
-#include "esp32s2/rom/spi_flash.h"
-#elif CONFIG_IDF_TARGET_ESP32S3
-#include "esp32s3/rom/spi_flash.h"
-#elif CONFIG_IDF_TARGET_ESP32C3
-#include "esp32c3/rom/spi_flash.h"
-#elif CONFIG_IDF_TARGET_ESP32H2
-#include "esp32h2/rom/spi_flash.h"
-#elif CONFIG_IDF_TARGET_ESP8684
-#include "esp8684/rom/spi_flash.h"
-#elif __has_include("esp32/rom/spi_flash.h")
-#include "esp32/rom/spi_flash.h" //IDF 4
-#else
-#include "rom/spi_flash.h" //IDF 3
-#endif
+#include "esp_rom_spiflash.h"
 
 #define CONFIG_LITTLEFS_BLOCK_SIZE 4096 /* ESP32 can only operate at 4kb */
 
diff --git a/test_apps/CMakeLists.txt b/test_apps/CMakeLists.txt
@@ -0,0 +1,10 @@
+# This is the project CMakeLists.txt file for the test subproject
+cmake_minimum_required(VERSION 3.16)
+
+set(COMPONENTS main)
+
+# Include test_utils from ESP-IDF tools
+list(APPEND EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/test_apps/components")
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(test_littlefs)
diff --git a/test_apps/main/CMakeLists.txt b/test_apps/main/CMakeLists.txt
@@ -0,0 +1,27 @@
+set(TEST_DIR "${CMAKE_CURRENT_LIST_DIR}/../../test")
+
+idf_component_register(
+    SRCS
+        "test_main.c"
+        "${TEST_DIR}/test_littlefs.c"
+        "${TEST_DIR}/test_littlefs_common.c"
+        "${TEST_DIR}/test_dir.c"
+        "${TEST_DIR}/test_benchmark.c"
+        "${TEST_DIR}/test_littlefs_static_partition.c"
+    INCLUDE_DIRS "${TEST_DIR}"
+    PRIV_REQUIRES
+        esp_littlefs
+        unity
+        test_utils
+        vfs
+        spi_flash
+        spiffs
+        fatfs
+        wear_levelling
+        esp_timer
+        esp_partition
+    WHOLE_ARCHIVE
+)
+
+# Embed the test filesystem binary
+target_add_binary_data(${COMPONENT_LIB} "${TEST_DIR}/testfs.bin" BINARY)
diff --git a/test_apps/main/idf_component.yml b/test_apps/main/idf_component.yml
@@ -0,0 +1,4 @@
+dependencies:
+  idf: ">=5.0"
+  esp_littlefs:
+    path: "../../"
diff --git a/test_apps/main/test_main.c b/test_apps/main/test_main.c
@@ -0,0 +1,11 @@
+/*
+ * Entry point for the littlefs test application (ESP-IDF v6.0+)
+ */
+
+#include "unity.h"
+
+void app_main(void)
+{
+    printf("Running littlefs tests\n");
+    unity_run_menu();
+}
diff --git a/test_apps/partitions.csv b/test_apps/partitions.csv
@@ -0,0 +1,10 @@
+# Partition table for littlefs unit tests
+# Name,        Type, SubType,  Offset,   Size,    Flags
+nvs,           data, nvs,      0x9000,   0x4000
+phy_init,      data, phy,      0xd000,   0x1000
+factory,       app,  factory,  0x10000,  1M
+# Partitions for filesystem tests and benchmarks
+fat_store,     data, fat,      ,         528K
+spiffs_store,  data, spiffs,   ,         512K
+flash_test,    data, spiffs,   ,         512K
+named_part,    data, 0x83,     ,         64K
diff --git a/test_apps/sdkconfig.defaults b/test_apps/sdkconfig.defaults
@@ -0,0 +1,23 @@
+# Use 4MB flash (partition table requires ~2.6MB)
+CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
+
+# General options for additional checks
+CONFIG_HEAP_POISONING_COMPREHENSIVE=y
+CONFIG_COMPILER_WARN_WRITE_STRINGS=y
+CONFIG_FREERTOS_WATCHPOINT_END_OF_STACK=y
+CONFIG_COMPILER_STACK_CHECK_MODE_STRONG=y
+CONFIG_COMPILER_STACK_CHECK=y
+
+# Disable the task watchdog since this app uses an interactive menu
+CONFIG_ESP_TASK_WDT_INIT=n
+
+# Custom partition table for this test app
+CONFIG_PARTITION_TABLE_CUSTOM=y
+CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions.csv"
+
+# LittleFS settings for testing
+CONFIG_LITTLEFS_USE_MTIME=y
+
+# SPIFFS settings (for benchmark comparisons)
+CONFIG_SPIFFS_USE_MTIME=y
+CONFIG_SPIFFS_GC_MAX_RUNS=64

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-cmake_minimum_required(VERSION 3.10)`
	`1`	`+cmake_minimum_required(VERSION 3.16)`
`2`	`2`
`3`	`3`	`file(GLOB SOURCES src/littlefs/*.c)`
`4`	`4`	`list(APPEND SOURCES src/esp_littlefs.c src/littlefs_esp_part.c src/lfs_config.c)`