pkg/lwext4: add lightweight implementation of the ext2/3/4 filesystem

Makefile.dep

@@ -72,6 +72,11 @@ ifneq (,$(filter fatfs_vfs,$(USEMODULE)))
   USEMODULE += vfs
 endif
 
+ifneq (,$(filter lwext%_vfs,$(USEMODULE)))
+  USEPKG += lwext4
+  USEMODULE += vfs
+endif
+
 ifneq (,$(filter nimble_%,$(USEMODULE)))
   USEPKG += nimble
 endif

boards/native/Makefile.dep

@@ -14,7 +14,7 @@ endif
 
 # default to using littlefs2 on the virtual flash if no other fs was selected
 ifneq (,$(filter vfs_default,$(USEMODULE)))
-  ifeq (,$(filter spiffs littlefs fatfs_vfs,$(USEMODULE)))
+  ifeq (,$(filter lwext%_vfs spiffs littlefs fatfs_vfs,$(USEMODULE)))
     USEMODULE += littlefs2
   endif
   USEMODULE += mtd

boards/native/board_init.c

@@ -35,7 +35,7 @@ mtd_native_dev_t mtd0_dev = {
 mtd_dev_t *mtd0 = &mtd0_dev.base;
 #endif
 
-#ifdef MODULE_VFS
+#ifdef MODULE_VFS_DEFAULT
 #include "vfs_default.h"
 
 /*
@@ -62,8 +62,12 @@ VFS_AUTO_MOUNT(spiffs, VFS_MTD(mtd0_dev), VFS_DEFAULT_NVM(0), 0);
 #elif defined(MODULE_FATFS_VFS)
 VFS_AUTO_MOUNT(fatfs, VFS_MTD(mtd0_dev), VFS_DEFAULT_NVM(0), 0);
 
+/* ext2/3/4 support */
+#elif defined(MODULE_LWEXT4)
+VFS_AUTO_MOUNT(lwext4, VFS_MTD(mtd0_dev), VFS_DEFAULT_NVM(0), 0);
+
 #endif
-#endif /* MODULE_VFS */
+#endif /* MODULE_VFS_DEFAULT */
 
 /**
  * Nothing to initialize at the moment.

boards/native/include/board.h

@@ -60,22 +60,26 @@ void _native_LED_RED_TOGGLE(void);
  * @{
  */
 #ifndef MTD_PAGE_SIZE
-#ifdef MODULE_FATFS
+#if defined(MODULE_FATFS) || defined(MODULE_LWEXT4)
 #define MTD_PAGE_SIZE           (512)
 #else
 #define MTD_PAGE_SIZE           (256)
 #endif
 #endif
 #ifndef MTD_SECTOR_SIZE
-#ifdef MODULE_FATFS
+#if defined(MODULE_FATFS) || defined(MODULE_LWEXT4)
 #define MTD_SECTOR_SIZE         (512)
 #else
 #define MTD_SECTOR_SIZE         (4096)
 #endif
 #endif
 #ifndef MTD_SECTOR_NUM
+#if defined(MODULE_FATFS) || defined(MODULE_LWEXT4)
+#define MTD_SECTOR_NUM          (32768)
+#else
 #define MTD_SECTOR_NUM          (2048)
 #endif
+#endif
 /** Advertised write size. While the file system backend supports single byte
  * granularity, this can be increased to mimic other media. */
 #ifndef MTD_WRITE_SIZE

boards/same54-xpro/Makefile.dep

@@ -21,6 +21,9 @@ endif
 # default to using littlefs2 on the external flash and fatfs on SD card
 ifneq (,$(filter vfs_default,$(USEMODULE)))
   USEPKG += littlefs2
-  USEMODULE += fatfs_vfs
+  # if ext2/3/4 is used, don't use FAT
+  ifeq (,$(filter lwext%_vfs,$(USEMODULE)))
+    USEMODULE += fatfs_vfs
+  endif
   USEMODULE += mtd
 endif

boards/same54-xpro/board.c

@@ -87,6 +87,12 @@ static mtd_sam0_sdhc_t sdhc_dev = {
 mtd_dev_t *mtd2 = (mtd_dev_t *)&sdhc_dev;
 
 #ifdef MODULE_VFS_DEFAULT
+/* default to FAT */
+#if defined(MODULE_FATFS_VFS)
 VFS_AUTO_MOUNT(fatfs, VFS_MTD(sdhc_dev), VFS_DEFAULT_SD(0), 1);
+/* but also support ext2/3/4 */
+#elif defined(MODULE_LWEXT4)
+VFS_AUTO_MOUNT(lwext4, VFS_MTD(sdhc_dev), VFS_DEFAULT_SD(0), 1);
 #endif
+#endif /* MODULE_VFS_DEFAULT */
 #endif /* MODULE_SAM0_SDHC */

makefiles/pseudomodules.inc.mk

@@ -129,6 +129,11 @@ PSEUDOMODULES += log
 PSEUDOMODULES += log_printfnoformat
 PSEUDOMODULES += log_color
 PSEUDOMODULES += lora
+PSEUDOMODULES += lwext4_no_gpl
+PSEUDOMODULES += lwext2_vfs
+PSEUDOMODULES += lwext3_vfs
+PSEUDOMODULES += lwext4_vfs
+PSEUDOMODULES += lwext4_vfs_format
 ## @defgroup pseudomodule_libc_gettimeofday libc_gettimeofday
 ## @brief Includes implementation of gettimeofday()
 ##

pkg/lwext4/Makefile

@@ -0,0 +1,13 @@
+PKG_NAME=lwext4
+PKG_URL=https://github.com/gkostka/lwext4.git
+PKG_VERSION=58bcf89a121b72d4fb66334f1693d3b30e4cb9c5
+PKG_LICENSE=GPLv2
+
+CFLAGS += -Wno-cast-align
+CFLAGS += -Wno-error=format
+CFLAGS += -Wno-unused-parameter -Wno-unused-variable
+
+include $(RIOTBASE)/pkg/pkg.mk
+
+all:
+	$(QQ)"$(MAKE)" -C $(PKG_SOURCE_DIR)/src -f $(RIOTBASE)/Makefile.base MODULE=$(PKG_NAME)

pkg/lwext4/Makefile.dep

@@ -0,0 +1,5 @@
+USEMODULE += lwext_fs
+
+ifneq (,$(filter vfs_auto_format,$(USEMODULE)))
+  DEFAULT_MODULE += lwext4_vfs_format
+endif

pkg/lwext4/Makefile.include

@@ -0,0 +1,23 @@
+INCLUDES += -I$(PKGDIRBASE)/lwext4/include
+
+DIRS += $(RIOTPKG)/lwext4/fs
+
+CFLAGS += -DCONFIG_USE_DEFAULT_CFG=1
+CFLAGS += -DCONFIG_HAVE_OWN_OFLAGS=0
+
+# select ext2/3/4 feature level based on module name
+ifneq (,$(filter lwext4_vfs,$(USEMODULE)))
+  CFLAGS += -DCONFIG_EXT_FEATURE_SET_LVL=F_SET_EXT4
+endif
+ifneq (,$(filter lwext3_vfs,$(USEMODULE)))
+  CFLAGS += -DCONFIG_EXT_FEATURE_SET_LVL=F_SET_EXT3
+endif
+ifneq (,$(filter lwext2_vfs,$(USEMODULE)))
+  CFLAGS += -DCONFIG_EXT_FEATURE_SET_LVL=F_SET_EXT2
+endif
+
+# Disable GPL-only features
+ifneq (,$(filter lwext4_no_gpl,$(USEMODULE)))
+  CFLAGS += -DCONFIG_EXTENTS_ENABLE=0
+  CFLAGS += -DCONFIG_XATTR_ENABLE=0
+endif

pkg/lwext4/doc.txt

@@ -0,0 +1,19 @@
+/**
+ * @defgroup pkg_lwext4     lightweight ext2/3/4 implementation
+ * @ingroup  pkg
+ * @ingroup  sys_fs
+ * @brief    Provides a lightweight implementation of the ext2/3/4
+ *           filesystem with optional journaling transactions & recovery
+ *
+ *           Lwext4 is an excellent choice for SD/MMC card, USB flash drive
+ *           or any other wear leveled memory types. However it is not good
+ *           for raw flash devices.
+ *
+ *           Some of the source files are licensed under GPLv2.
+ *           It makes whole lwext4 GPLv2 licensed. To use library as a BSD3,
+ *           GPLv2 licensed source files must be disabled.
+ *           To do so, enable the `lwext4_no_gpl` module.
+ *           This will disable support for extends and extended attributes.
+ *
+ * @see      https://github.com/gkostka/lwext4
+ */

pkg/lwext4/fs/Makefile

@@ -0,0 +1,3 @@
+MODULE := lwext_fs
+
+include $(RIOTBASE)/Makefile.base