Adds skeleton for littlefs

Author: networkfusion

CMake/Modules/FindSTM32F4_CubePackage.cmake

@@ -11,7 +11,7 @@ set(STM32F4_CubePackage_SRCS
 
     # add HAL files here as required
 
-    # SPIFFS
+    # SPIFFS & littlefs
     stm32f4xx_hal_dma.c
     stm32f4xx_hal_qspi.c
 )

CMake/Modules/FindSTM32F7_CubePackage.cmake

@@ -11,7 +11,7 @@ set(STM32F7_CubePackage_SRCS
 
     # add HAL files here as required
 
-    # SPIFFS
+    # SPIFFS & littlefs
     stm32f7xx_hal_dma.c
     stm32f7xx_hal_qspi.c
 )

CMake/Modules/FindSTM32H7_CubePackage.cmake

@@ -11,7 +11,7 @@ set(STM32H7_CubePackage_SRCS
 
     # add HAL files here as required
 
-    # SPIFFS
+    # SPIFFS & littlefs
     stm32h7xx_hal_qspi.c
 )
 

CMake/Modules/Findlittlefs.cmake

@@ -0,0 +1,37 @@
+#
+# Copyright (c) 2019 The nanoFramework project contributors
+# See LICENSE file in the project root for full license information.
+#
+
+
+# List of the required littlefs include files.
+list(APPEND LITTLEFS_INCLUDE_DIRS ${PROJECT_BINARY_DIR}/littlefs_Source)
+list(APPEND LITTLEFS_INCLUDE_DIRS ${PROJECT_BINARY_DIR}/littlefs_Source/bd)
+list(APPEND LITTLEFS_INCLUDE_DIRS ${TARGET_BASE_LOCATION})
+
+set(LITTLEFS_SRCS
+
+    # littlefs
+    lfs.c
+    lfs_util.c
+
+    lfs_filebd.c
+    lfs_rambd.c
+    lfs_testbd.c
+)
+
+foreach(SRC_FILE ${LITTLEFS_SRCS})
+    set(LITTLEFS_SRC_FILE SRC_FILE -NOTFOUND)
+    find_file(LITTLEFS_SRC_FILE ${SRC_FILE}
+        PATHS 
+            ${PROJECT_BINARY_DIR}/littlefs_Source
+
+        CMAKE_FIND_ROOT_PATH_BOTH
+    )
+    # message("${SRC_FILE} >> ${LITTLEFS_SRC_FILE}") # debug helper
+    list(APPEND FATFS_SOURCES ${LITTLEFS_SRC_FILE})
+endforeach()
+
+include(FindPackageHandleStandardArgs)
+
+FIND_PACKAGE_HANDLE_STANDARD_ARGS(LITTLEFS DEFAULT_MSG LITTLEFS_INCLUDE_DIRS LITTLEFS_SOURCES)

CMake/littlefs.CMakeLists.cmake.in

@@ -0,0 +1,26 @@
+#
+# Copyright (c) 2020 The nanoFramework project contributors
+# See LICENSE file in the project root for full license information.
+#
+
+cmake_minimum_required(VERSION 3.15)
+
+project(littlefs-download NONE)
+
+include(ExternalProject)
+
+# download littlefs source from official GitHub repo
+ExternalProject_Add( 
+    LITTLEFS
+    PREFIX LITTLEFS
+    SOURCE_DIR ${CMAKE_BINARY_DIR}/littlefs_Source
+    GIT_REPOSITORY  https://github.com/ARMmbed/littlefs
+    GIT_TAG "v2.2.1"  # target latest release
+    GIT_SHALLOW 1   # download only the tip of the branch, not the complete history
+    TIMEOUT 10
+    LOG_DOWNLOAD 1
+    # Disable all other steps
+    INSTALL_COMMAND ""
+    CONFIGURE_COMMAND ""
+    BUILD_COMMAND ""
+)

CMakeLists.txt

@@ -357,6 +357,31 @@ endif()
 
 #################################################################
 
+#################################################################
+# enables support for littlefs file system
+# (default is OFF so littlefs is NOT supported)
+option(NF_FEATURE_USE_LITTLEFS "option to enable support for littlefs file system")
+
+if(NF_FEATURE_USE_LITTLEFS)
+
+    # this feature currently is supported only on ChibiOS and ESP32
+    if(NOT RTOS_CHIBIOS_CHECK)
+        message(FATAL_ERROR "Support for littlefs is only available for ChibiOS Cortex-M and ESP32 targets.")
+    endif()
+
+    # force inclusion of Windows.Storage API
+    set(API_Windows.Storage ON CACHE INTERNAL "Forcing Windows.Storage API option to ON")
+
+    set(NF_FEATURE_USE_LITTLEFS_OPTION TRUE CACHE INTERNAL "Set nF littlefs feature TRUE")
+
+    message(STATUS "Support for littlefs is included")
+else()
+    set(NF_FEATURE_USE_LITTLEFS_OPTION FALSE CACHE INTERNAL "Set nF littlefs feature FALSE")
+    message(STATUS "Support for littlefs IS NOT included")
+endif()
+
+#################################################################
+
 if(RTOS_CHIBIOS_CHECK)
 
     #################################################################

CMakeSettings.SAMPLE.json

@@ -253,6 +253,11 @@
           "value": "False",
           "type": "BOOL"
         },
+        {
+          "name": "NF_FEATURE_USE_LITTLEFS",
+          "value": "False",
+          "type": "BOOL"
+        },
         {
           "name": "NF_FEATURE_HAS_SDCARD",
           "value": "True",

CMakeSettings.json

@@ -456,6 +456,11 @@
           "value": "False",
           "type": "BOOL"
         },
+        {
+          "name": "NF_FEATURE_USE_LITTLEFS",
+          "value": "False",
+          "type": "BOOL"
+        },
         {
           "name": "NF_FEATURE_HAS_SDCARD",
           "value": "True",

cmake-variants.TEMPLATE.json

@@ -51,6 +51,7 @@
           "TI_BOARD" : "<valid-TI-board-name-from-boards-collection>",
           "TI_SL_CC32xx_SDK_SOURCE" : "<path-to-local-TI-SimpleLink-CC32xx-SDK-source-mind-the-forward-slash>",
           "SPIFFS_SOURCE" : "<path-to-local-SPIFFS-source-mind-the-forward-slash>",
+          "LITTLEFS_SOURCE" : "<path-to-local-littlefs-source-mind-the-forward-slash>",
           "SWO_OUTPUT" : "OFF-default-ON-to-enable-ARM-CortexM-Single-Wire-Output",
           "FATFS_VERSION": "<valid-fatfs-version-if-empty-use-default-set-cmake>",
           "NF_BUILD_RTM" : "OFF-default-ON-to-enable-RTM-build",
@@ -69,6 +70,7 @@
           "NF_FEATURE_HAS_SDCARD" : "OFF-default-ON-to-enable-support-for-SDCard-storage-device",
           "NF_FEATURE_HAS_USB_MSD" : "OFF-default-ON-to-enable-support-for-USB-Mass-storage-device",
           "NF_FEATURE_USE_SPIFFS" : "OFF-default-ON-to-enable-support-for-SPI-flash-file-system",
+          "NF_FEATURE_USE_LITTLEFS" : "OFF-default-ON-to-enable-support-for-little-file-system",
           "NF_PLATFORM_NO_CLR_TRACE" : "OFF-default-ON-to-disable-all-trace-on-CLR",
           "NF_CLR_NO_IL_INLINE" : "OFF-default-ON-to-disable-CLR-IL-inlining",
           "NF_INTEROP_ASSEMBLIES" : [ "Assembly1-Namespace", "Assembly2-Namespace" ],

targets/CMSIS-OS/ChibiOS/CMakeLists.txt

@@ -596,6 +596,106 @@ if(NF_FEATURE_USE_SPIFFS)
 
 endif()
 
+
+# if support for littlefs is enabled add it to the build
+if(NF_FEATURE_USE_LITTLEFS)
+
+    # check if LITTLEFS_SOURCE was specified or if it's empty (default is empty)
+    set(NO_LITTLEFS_SOURCE TRUE)
+
+    if(LITTLEFS_SOURCE)
+        if(NOT "${LITTLEFS_SOURCE}" STREQUAL "")
+            set(NO_LITTLEFS_SOURCE FALSE)
+        endif()
+    endif()
+
+    if(NO_LITTLEFS_SOURCE)
+        # no littlefs source specified, download it from it's repo
+
+        # check for Git (needed here for advanced warning to user if it's not installed)
+        find_package(Git)
+
+        #  check if Git was found, if not report to user and abort
+        if(NOT GIT_EXECUTABLE)
+            message(FATAL_ERROR "error: could not find Git, make sure you have it installed.")
+        endif()
+
+        # need to setup a separate CMake project to download the code from the GitHub repository
+        # otherwise it won't be available before the actual build step
+        configure_file("${PROJECT_SOURCE_DIR}/CMake/littlefs.CMakeLists.cmake.in"
+                    "${CMAKE_BINARY_DIR}/littlefs_Download/CMakeLists.txt")
+
+        # setup CMake project for littlefs download
+        execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" .
+                        RESULT_VARIABLE result
+                        WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/littlefs_Download")
+
+        # run build on littlefs download CMake project to perform the download
+        execute_process(COMMAND ${CMAKE_COMMAND} --build .
+                        RESULT_VARIABLE result
+                        WORKING_DIRECTORY "${CMAKE_BINARY_DIR}/littlefs_Download")
+
+        # add littlefs as external project
+        ExternalProject_Add(
+            LITTLEFS
+            PREFIX LITTLEFS
+            SOURCE_DIR ${CMAKE_BINARY_DIR}/littlefs_Source
+            GIT_REPOSITORY  https://github.com/ARMmbed/littlefs
+            GIT_TAG "v2.2.1"  # target latest release
+            GIT_SHALLOW 1   # download only the tip of the branch, not the complete history
+            TIMEOUT 10
+            LOG_DOWNLOAD 1
+
+            # Disable all other steps
+            CONFIGURE_COMMAND ""
+            BUILD_COMMAND ""
+            INSTALL_COMMAND ""
+        )
+
+    else()
+        # littlefs source was specified
+
+        # sanity check is source path exists
+        if(EXISTS "${LITTLEFS_SOURCE}/")
+
+            # check if we already have the sources, no need to copy again
+            if(NOT EXISTS "${CMAKE_BINARY_DIR}/littlefs_Source")
+                message(STATUS "littlefs source from: ${LITTLEFS_SOURCE}")
+                file(COPY "${LITTLEFS_SOURCE}/" DESTINATION "${CMAKE_BINARY_DIR}/littlefs_Source")
+            else()
+                message(STATUS "Using local cache of littlefs source from ${LITTLEFS_SOURCE}")
+            endif()
+
+            set(LITTLEFS_INCLUDE_DIR ${CMAKE_BINARY_DIR}/littlefs_Source)
+            set(LITTLEFS_INCLUDE_DIR ${CMAKE_BINARY_DIR}/littlefs_Source/bd)
+        else()
+            message(FATAL_ERROR "Couldn't find littlefs source at ${LITTLEFS_SOURCE}/")
+        endif()
+
+        # add littlefs as external project
+        ExternalProject_Add(
+            LITTLEFS
+            PREFIX LITTLEFS
+            SOURCE_DIR ${CMAKE_BINARY_DIR}/littlefs_Source
+
+            # Disable all other steps
+            CONFIGURE_COMMAND ""
+            BUILD_COMMAND ""
+            INSTALL_COMMAND ""
+        )
+
+    endif()
+
+    # get source dir for littlefs CMake project
+    ExternalProject_Get_Property(LITTLEFS SOURCE_DIR)
+
+    set(LITTLEFS_LIBRARIES "${CMAKE_SHARED_LIBRARY_PREFIX}LITTLEFS${CMAKE_SHARED_LIBRARY_SUFFIX}")
+    include_directories(${LITTLEFS_INCLUDE_DIRS})
+
+    add_subdirectory(littlefs)
+
+endif()
+
 # add target ChibiOS dirs
 add_subdirectory(Include)
 add_subdirectory(common)

targets/CMSIS-OS/ChibiOS/MBN_QUAIL/target_windows_storage_config.h

@@ -11,3 +11,6 @@
 
 // includes SPIFFS in storage
 #define USE_SPIFFS_FOR_STORAGE  FALSE
+
+// includes littlefs in storage
+#define USE_LITTLEFS_FOR_STORAGE  FALSE

targets/CMSIS-OS/ChibiOS/NETDUINO3_WIFI/target_windows_storage_config.h

@@ -11,3 +11,6 @@
 
 // includes SPIFFS in storage
 #define USE_SPIFFS_FOR_STORAGE  FALSE
+
+// includes littlefs in storage
+#define USE_LITTLEFS_FOR_STORAGE  FALSE

targets/CMSIS-OS/ChibiOS/ST_STM32F769I_DISCOVERY/CMakeLists.txt

@@ -62,6 +62,12 @@ if(NF_FEATURE_USE_SPIFFS)
     find_package(SPIFFS REQUIRED)
 endif()
 
+# littlefs
+if(NF_FEATURE_USE_LITTLEFS)
+    find_package(STM32F7_CubePackage REQUIRED)
+    find_package(LITTLEFS REQUIRED)
+endif()
+
 #######################################
 
 add_subdirectory("common")
@@ -139,6 +145,9 @@ add_executable(
     # sources for SPIFFS
     ${SPIFFS_SOURCES}
 
+    # sources for littlefs
+    ${LITTLEFS_SOURCES}
+
     # sources for nanoFramework APIs
     ${TARGET_NANO_APIS_SOURCES}
 )
@@ -219,6 +228,9 @@ target_include_directories(${NANOCLR_PROJECT_NAME}.elf PUBLIC
 
     # includes for SPIFFS
     ${SPIFFS_INCLUDE_DIRS}
+
+    # includes for littlefs
+    ${LITTLEFS_INCLUDE_DIRS}
 )
 
 # set compiler options

targets/CMSIS-OS/ChibiOS/ST_STM32F769I_DISCOVERY/littlefs_config.h

@@ -11,3 +11,6 @@
 
 // includes SPIFFS in storage
 #define USE_SPIFFS_FOR_STORAGE  FALSE
+
+// includes littlefs in storage
+#define USE_LITTLEFS_FOR_STORAGE  FALSE

targets/CMSIS-OS/ChibiOS/ST_STM32F769I_DISCOVERY/target_littlefs.c

@@ -18,6 +18,9 @@
 #if (USE_SPIFFS_FOR_STORAGE == TRUE)
 #include <hal_spiffs.h>
 #endif
+#if (USE_LITTLEFS_FOR_STORAGE == TRUE)
+#include <hal_littlefs.h>
+#endif
 
 // defining these types here to make it shorter and improve code readability
 typedef Library_win_storage_native_Windows_Storage_StorageFolder StorageFolder;

targets/CMSIS-OS/ChibiOS/ST_STM32F769I_DISCOVERY/target_littlefs.h

@@ -0,0 +1,14 @@
+#
+# Copyright (c) 2019 The nanoFramework project contributors
+# See LICENSE file in the project root for full license information.
+#
+
+# include littlefs sources, if feature is enabled
+if(NF_FEATURE_USE_LITTLEFS)
+    list(APPEND TARGET_CHIBIOS_COMMON_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/hal_littlefs.c")
+    list(APPEND TARGET_CHIBIOS_COMMON_INCLUDE_DIRS "${CMAKE_CURRENT_SOURCE_DIR}")
+endif()
+
+# make var global
+set(TARGET_CHIBIOS_COMMON_SOURCES ${TARGET_CHIBIOS_COMMON_SOURCES} CACHE INTERNAL "make global")
+set(TARGET_CHIBIOS_COMMON_INCLUDE_DIRS ${TARGET_CHIBIOS_COMMON_INCLUDE_DIRS} CACHE INTERNAL "make global")

targets/CMSIS-OS/ChibiOS/ST_STM32F769I_DISCOVERY/target_windows_storage_config.h

@@ -14,6 +14,9 @@
 // enable SPIFFS
 #define NF_FEATURE_USE_SPIFFS @NF_FEATURE_USE_SPIFFS_OPTION@
 
+// enable littlefs
+#define NF_FEATURE_USE_LITTLEFS @NF_FEATURE_USE_LITTLEFS_OPTION@
+
 // set preference to enable (or not) the RTC subsystem
 #define HAL_USE_RTC @HAL_USE_RTC_OPTION@