OrgApache/incubator-nuttx
OrgApache
/
incubator-nuttx
mirror of https://github.com/apache/incubator-nuttx.git
1
0
Fork 0
Code Issues Releases Wiki Activity

spiffs: Document how to generate images

This commit is contained in:
YAMAMOTO Takashi 2020-12-21 16:39:10 +09:00 committed by Xiang Xiao
parent 7305e04336
commit b3d36219e4
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
fs/spiffs/README.md Normal file
View File

@ -0,0 +1,25 @@
# SPIFFS
## Creating an image
This implementation is supposed to be compatible with
images generated by the following tools:
* mkspiffs <https://github.com/igrr/mkspiffs>
* ESP-IDF spiffsgen.py <https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/storage/spiffs.html#spiffsgen-py>
Note: please ensure the following NuttX configs to be compatible with
these tools:
* CONFIG_SPIFFS_COMPAT_OLD_NUTTX is disabled
* CONFIG_SPIFFS_LEADING_SLASH=y
### mkspiffs
* Specify CONFIG_SPIFFS_NAME_MAX + 1 for SPIFFS_OBJ_NAME_LEN.
* Specify 0 for SPIFFS_OBJ_META_LEN.
### ESP-IDF spiffsgen.py
* Specify CONFIG_SPIFFS_NAME_MAX + 1 for the --obj-name-len option.
* Specify 0 for the --meta-len option.