add littlefs surport.

Author: diskman88

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "filesystem/littlefs"]
+	path = filesystem/littlefs
+	url = https://github.com/ARMmbed/mbed-littlefs.git

CMakeLists.txt

@@ -17,15 +17,19 @@ include_directories(filesystem/diskio/include)
 include_directories(filesystem/fatfs/include)
 include_directories(filesystem/vfs/include)
 include_directories(tclap)
+include_directories(filesystem/littlefs/littlefs)
+include_directories(filesystem/littlefs/littlefs/bd)
 
 aux_source_directory(. DIR_SRCS)
 aux_source_directory(esp_idf DIR_ESP_IDF)
 aux_source_directory(esp_idf/freertos DIR_RTOS)
 aux_source_directory(filesystem/diskio DIR_DISKIO)
 aux_source_directory(filesystem/fatfs DIR_FATFS)
 aux_source_directory(filesystem/vfs DIR_VFS)
+aux_source_directory(filesystem/littlefs/littlefs DIR_LITTLEFS)
+set(SRC_RAMBD filesystem/littlefs/littlefs/bd/lfs2_rambd.c )
 
-add_executable(mkfatfs ${DIR_SRCS} ${DIR_ESP_IDF} ${DIR_RTOS} ${DIR_DISKIO} ${DIR_FATFS} ${DIR_VFS})
+add_executable(mkfatfs ${DIR_SRCS} ${DIR_ESP_IDF} ${DIR_RTOS} ${DIR_DISKIO} ${DIR_FATFS} ${DIR_VFS} ${DIR_LITTLEFS} ${SRC_RAMBD})
 
 # add_subdirectory(esp_idf)
 # add_subdirectory(filesystem/diskio)

README.md

@@ -9,14 +9,26 @@ Tool to build and unpack [FATFS](https://github.com/jkearins/ESP32_mkfatfs) imag
   in windows:
 
   mkfatfs  {-c <pack_dir>|-u <dest_dir>|-l|-i} [-d <0-5>] [-b <number>]
-            [-p <number>] [-s <number>] [--] [--version] [-h]
+            [-p <number>] [-s <number>] [--] [--version] [-t <fstype>] [-h]
             <image_file>
 
   in linux:
   ./mkfatfs  {-c <pack_dir>|-u <dest_dir>|-l|-i} [-d <0-5>] [-b <number>]
-          [-p <number>] [-s <number>] [--] [--version] [-h]
+          [-p <number>] [-s <number>] [--] [--version] [-t <fstype>] [-h]
           <image_file>
 
+eg:
+pack:
+windows:
+mkfatfs.exe -c Test -s 0x200000 -t littlefs test.bin
+linux: 
+./mkfatfs -c Test -s 0x200000 -t littlefs test.bin
+
+unpack:
+windows:
+mkfatfs.exe -u Test -s 0 -t littlefs test.bin
+linux:
+./mkfatfs -u Test -s 0 -t littlefs test.bin
 
 Where: 
 
@@ -45,6 +57,9 @@ Where:
    -s <number>,  --size <number>
      fs image size, in bytes
 
+   -t <fstype> --type <fstype>
+     fs type, surport fatfs and littlefs
+
    --,  --ignore_rest
      Ignores the rest of the labeled arguments following this flag.
 
@@ -65,6 +80,10 @@ You need gcc (≥4.8) or clang(≥600.0.57), and make. On Windows, use MinGW.
 You need cmake (≥3.0.0).
 Youn can develop in vscode. install extension CMake and CMake Tools.
 More help for build project, please read the extension's help.
+in linux:
+  cd mkfatfs
+  cmake .
+  make
 
 ## License
 

filesystem/littlefs

@@ -18,7 +18,8 @@
 #define TCLAP_SETBASE_ZERO 1
 #include "tclap/CmdLine.h"
 #include "tclap/UnlabeledValueArg.h"
-#include "pack.h"
+#include "pack_fat.h"
+#include "pack_littlefs.h"
 
 #define APP_VERSION mkfatfs_VERSION
 
@@ -30,7 +31,7 @@ static Action s_action = ACTION_NONE;
 static std::string s_dirName;
 static std::string s_imageName;
 static int s_imageSize;
-Pack pack = Pack();
+static std::string s_fs;
 
 void processArgs(int argc, const char** argv) {
     TCLAP::CmdLine cmd("", ' ', APP_VERSION);
@@ -39,14 +40,16 @@ void processArgs(int argc, const char** argv) {
     TCLAP::SwitchArg listArg( "l", "list", "list files in fatFS image", false);
     TCLAP::SwitchArg visualizeArg( "i", "visualize", "visualize fatFS image", false);
     TCLAP::UnlabeledValueArg<std::string> outNameArg( "image_file", "fatFS image file", true, "", "image_file"  );
-    TCLAP::ValueArg<int> imageSizeArg( "s", "size", "fs image size, in bytes", false, 0x10000, "number" );
+    TCLAP::ValueArg<int> imageSizeArg( "s", "size", "fs image size, in bytes", false, 0x200000, "number" );
     TCLAP::ValueArg<int> debugArg( "d", "debug", "Debug level. 0 means no debug output.", false, 0, "0-5" );
+    TCLAP::ValueArg<std::string> fsType( "t", "type", "Select file system type, suport fatfs littlefs now.", false, "fatfs", "fatfs or littlefs" );
 
     cmd.add( imageSizeArg );
     cmd.add(debugArg);
     std::vector<TCLAP::Arg*> args = {&packArg, &unpackArg, &listArg, &visualizeArg};
     cmd.xorAdd( args );
     cmd.add( outNameArg );
+    cmd.add( fsType );
     cmd.parse( argc, argv );
 
     if (debugArg.getValue() > 0) {
@@ -68,6 +71,7 @@ void processArgs(int argc, const char** argv) {
 
     s_imageName = outNameArg.getValue();
     s_imageSize = imageSizeArg.getValue();
+    s_fs = fsType.getValue();
 }
 
 int main(int argc, const char * argv[]) {
@@ -78,12 +82,22 @@ int main(int argc, const char * argv[]) {
         return 1;
     }
 
+    Pack_fat pack_fat = Pack_fat(); 
+    Pack_littlefs pack_littlefs = Pack_littlefs(); 
+
     switch (s_action) {
     case ACTION_PACK:
-        return pack.actionPack(s_dirName, s_imageName, s_imageSize);
+        if(s_fs == "fatfs")
+            return pack_fat.actionPack(s_dirName, s_imageName, s_imageSize);
+        else if(s_fs == "littlefs")
+            return pack_littlefs.actionPack(s_dirName, s_imageName, s_imageSize);
         break;
     case ACTION_UNPACK:
-        return pack.actionUnpack(s_imageName, s_dirName, s_imageSize);
+        if(s_fs == "fatfs")
+            return pack_fat.actionUnpack(s_imageName, s_dirName, s_imageSize);
+        else if(s_fs == "littlefs")
+            return pack_littlefs.actionUnpack(s_imageName, s_dirName, s_imageSize);
+        break;
          break;
     case ACTION_LIST:
 

main.cpp

@@ -4,7 +4,7 @@
 //  Created by zhao hui jiang on 07/03/2020.
 //  Copyright (c). All rights reserved.
 //
-#include "pack.h"
+#include "pack_fat.h"
 
 static const char *BASE_PATH = "/fatfs";
 static RAM_handle_t s_ram_handle;
@@ -20,9 +20,9 @@ struct dirent_1 {
     char d_name[256];   /*!< zero-terminated file name */
 }dirent_t;
 
-Pack::Pack()
+Pack_fat::Pack_fat()
 {}
-Pack::~Pack()
+Pack_fat::~Pack_fat()
 {}
 
 /**
@@ -31,7 +31,7 @@ Pack::~Pack()
  * @param 
  * @return True or false.
  */
-bool Pack::fatfsMount(int s_imageSize) {
+bool Pack_fat::fsMount(int s_imageSize) {
   bool result;
   esp_vfs_fat_mount_config_t mountConfig;
   mountConfig.max_files = 4; //Max files.
@@ -47,7 +47,7 @@ bool Pack::fatfsMount(int s_imageSize) {
  * @param 
  * @return True or false.
  */
-bool Pack::fatfsUnmount() {
+bool Pack_fat::fsUnmount() {
   bool result;
 
   result = (ESP_OK == emulate_esp_vfs_fat_spiflash_unmount(BASE_PATH, s_ram_handle));
@@ -63,7 +63,7 @@ bool Pack::fatfsUnmount() {
   return result;
 }
 
-size_t Pack::getFileSize(FILE* fp)
+size_t Pack_fat::getFileSize(FILE* fp)
 {
     fseek(fp, 0L, SEEK_END);
     size_t size = (size_t) ftell(fp);
@@ -77,7 +77,7 @@ size_t Pack::getFileSize(FILE* fp)
  * @return True if exists otherwise false.
  *
  */
-bool Pack::dirExists(const char* path) {
+bool Pack_fat::dirExists(const char* path) {
     DIR *d = opendir(path);
 
     if (d) {
@@ -93,7 +93,7 @@ bool Pack::dirExists(const char* path) {
  * @param path Directory path.
  * @return True or false.
  */
-bool Pack::dirCreate(const char* path) {
+bool Pack_fat::dirCreate(const char* path) {
     // Check if directory also exists.
     if (dirExists(path)) {
 	    return false;
@@ -117,7 +117,7 @@ bool Pack::dirCreate(const char* path) {
  * @param path Directory name, full path.
  * @return True or false.
  */
-int Pack::parkDirToRamFS(const char* name) {
+int Pack_fat::parkDirToRamFS(const char* name) {
     std::string fileName = name;
     fileName += "/.";
 
@@ -140,7 +140,7 @@ int Pack::parkDirToRamFS(const char* name) {
  * @param path_des des Directory path, full path.
  * @return True or false.
  */
-int Pack::parkFileToRamFS(char* path_src, const char* path_des) {
+int Pack_fat::parkFileToRamFS(char* path_src, const char* path_des) {
     FILE* f_src = fopen(path_src, "rb"); //open file in pc.
     if (!f_src) {
         std::cerr << "error: failed to open " << path_src << " for reading" << std::endl;
@@ -200,7 +200,7 @@ int Pack::parkFileToRamFS(char* path_src, const char* path_des) {
  * @return True if exists otherwise false.
  *
  */
-bool Pack::parkFilesToRamFS(const char* dirSrc, const char* dirDes)
+bool Pack_fat::parkFilesToRamFS(const char* dirSrc, const char* dirDes)
 {  
     DIR *dir;
     bool error = false;
@@ -314,7 +314,7 @@ bool Pack::parkFilesToRamFS(const char* dirSrc, const char* dirDes)
  * @param path_des: des file, to pc
  * @return True or false.
  */
-int Pack::unparkFileFromRamFS(const char* path_src, const char* path_des) 
+int Pack_fat::unparkFileFromRamFS(const char* path_src, const char* path_des) 
 {
     std::vector<uint8_t> temp_buf;
 
@@ -354,7 +354,7 @@ int Pack::unparkFileFromRamFS(const char* path_src, const char* path_des)
  *  @param dirDes directory/file in pc.
  * @return True or false.
  */
-bool Pack::unparkFilesFromRamFS(const char* dirSrc, const char* dirDes)
+bool Pack_fat::unparkFilesFromRamFS(const char* dirSrc, const char* dirDes)
 {
     DIR *dir;
     struct dirent_1 *ent;
@@ -434,14 +434,14 @@ bool Pack::unparkFilesFromRamFS(const char* dirSrc, const char* dirDes)
  * @param 
  * @return True or false.
  */
-int Pack::actionPack(std::string s_dirName, std::string s_imageName, int s_imageSize) {
+int Pack_fat::actionPack(std::string s_dirName, std::string s_imageName, int s_imageSize) {
     int ret = 0; //0 - ok
 
     // 1. resize g_flashmem and fill 0xff, it will used for RAM fat filesystem.
     g_flashmem.resize(s_imageSize, 0xff);
 
     // 2. mount g_flashmem(in RAM) as a fat filesystem, mount point is BASE_PATH(root directory of the RAM filesystem). 
-    if (fatfsMount(s_imageSize)) { 
+    if (fsMount(s_imageSize)) { 
       if (g_debugLevel > 0) {
         std::cout << "Mounted successfully" << std::endl;
       }
@@ -454,7 +454,7 @@ int Pack::actionPack(std::string s_dirName, std::string s_imageName, int s_image
     ret = parkFilesToRamFS(s_dirName.c_str(), BASE_PATH);
 
     // 4. unmount the RAM fat filesystem.
-    fatfsUnmount();
+    fsUnmount();
 
     // 5. open *.bin file witch read from esp32. 
     FILE* fdres = fopen(s_imageName.c_str(), "wb"); 
@@ -483,7 +483,7 @@ int Pack::actionPack(std::string s_dirName, std::string s_imageName, int s_image
  * @param s_dirName directory in pc, we will read all files to it.
  * @return 0 success, 1 error
  */
-int Pack::actionUnpack(std::string s_imageName, std::string s_dirName,int s_imageSize)
+int Pack_fat::actionUnpack(std::string s_imageName, std::string s_dirName,int s_imageSize)
 {
     int ret = 0;
 
@@ -505,7 +505,7 @@ int Pack::actionUnpack(std::string s_imageName, std::string s_dirName,int s_imag
     fclose(f_src);
 
     // 3. mount RAM(g_flashmem) file system， so we can use vfs read file in RAM file system.
-    if (fatfsMount(s_imageSize)) {
+    if (fsMount(s_imageSize)) {
       if (g_debugLevel > 0) {
         std::cout << "Mounted successfully" << std::endl;
       }
@@ -523,7 +523,7 @@ int Pack::actionUnpack(std::string s_imageName, std::string s_dirName,int s_imag
     }
 
     // unmount file system
-    fatfsUnmount();
+    fsUnmount();
 
     return ret;
 }

pack.cpp renamed to pack_fat.cpp

@@ -26,17 +26,17 @@
 * @brief This class is used to pack/upack filesystem.
 *
 */
-class Pack
+class Pack_fat
 {
 public:
-    Pack();
-    ~Pack();
+    Pack_fat();
+    ~Pack_fat();
     int actionPack(std::string s_dirName, std::string s_imageName, int s_imageSize);
     int actionUnpack(std::string s_imageName, std::string s_dirName,int s_imageSize);
 
 private:
-    bool   fatfsMount(int s_imageSize);
-    bool   fatfsUnmount();
+    bool   fsMount(int s_imageSize);
+    bool   fsUnmount();
     size_t getFileSize(FILE* fp);
     bool   dirExists(const char* path);
     bool   dirCreate(const char* path);