mkspiffs

用于构建和解包SPIFFS映像的工具。

使用方法

   mkspiffs  {-c <pack_dir>|-u <dest_dir>|-l|-i} [-d <0-5>] [-b <number>]
             [-p <number>] [-s <number>] [--] [--version] [-h]
             <image_file>

其中：

   -c <pack_dir>,  --create <pack_dir>
     （或必选）从目录创建SPIFFS映像
         或者 —— 
   -u <dest_dir>,  --unpack <dest_dir>
     （或必选）将SPIFFS映像解包到一个目录
         或者 —— 
   -l,  --list
     （或必选）列出SPIFFS映像中的文件
         或者 —— 
   -i,  --visualize
     （或必选）可视化SPIFFS映像


   -d <0-5>,  --debug <0-5>
     调试级别。0表示无调试输出。

   -b <number>,  --block <number>
     文件系统块大小，以字节为单位

   -p <number>,  --page <number>
     文件系统页大小，以字节为单位

   -s <number>,  --size <number>
     文件系统映像大小，以字节为单位

   --,  --ignore_rest
     忽略此标志后紧跟的标记参数。

   --version
     显示版本信息并退出。

   -h,  --help
     显示使用说明并退出。

   <image_file>
     （必选）SPIFFS映像文件

构建

你需要gcc（≥4.8）或clang（≥600.0.57），以及make。在Windows上，使用MinGW。

运行：

$ git submodule update --init
$ make dist

SPIFFS 配置

一些在mkspiffs构建时设置的SPIFFS选项会影响生成的文件系统映像格式。确保在构建mkspiffs和构建使用SPIFFS的应用程序时这些选项设置为相同的值。

这些选项包括：

• SPIFFS_OBJ_NAME_LEN
• SPIFFS_OBJ_META_LEN
• SPIFFS_USE_MAGIC
• SPIFFS_USE_MAGIC_LENGTH
• SPIFFS_ALIGNED_OBJECT_INDEX_TABLES
• 可能还有其他选项

要查看这些选项的默认值，请检查此存储库中的include/spiffs_config.h文件。

要在构建时覆盖某些选项，通过传递额外的CPPFLAGS给make。您还可以设置BUILD_CONFIG_NAME变量来区分编译出的二进制文件：

$ make clean
$ make dist CPPFLAGS="-DSPIFFS_OBJ_META_LEN=4" BUILD_CONFIG_NAME=-custom

要检查构建mkspiffs时设置了哪些选项，请使用--version命令：

$ mkspiffs --version
mkspiffs ver. 0.2.2
构建配置名称：custom
SPIFFS ver. 0.3.7-5-gf5e26c4
额外构建标志：-DSPIFFS_OBJ_META_LEN=4
SPIFFS配置：
  SPIFFS_OBJ_NAME_LEN: 32
  SPIFFS_OBJ_META_LEN: 4
  SPIFFS_USE_MAGIC: 1
  SPIFFS_USE_MAGIC_LENGTH: 1
  SPIFFS_ALIGNED_OBJECT_INDEX_TABLES: 0

许可证

MIT

待办事项

• 添加更多调试输出，打印SPIFFS的调试输出
• 错误处理
• 代码清理