espressif/spiffs
1
0
Fork 0
mirror of https://github.com/pellepl/spiffs.git synced 2025-05-17 15:26:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

upped version: doc fixing, check fixing, commenting, config restructuring

Browse Source
This commit is contained in:
Peter Andersson
2013-08-01 22:15:21 +02:00
parent bee35895c3
commit c6214a14c4
10 changed files with 170 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/INTEGRATION
View File

@ -90,7 +90,7 @@ define the SPI flash access functions:
spiffs_config.hal_erase_f - pointing to the function erasing the SPI flash
Depending on the build config - if SPIFFS_SINGLETON is undefined - following
Depending on the build config - if SPIFFS_SINGLETON is set to zero - following
parameters must be defined:
spiffs_config.phys_size - the physical number of bytes accounted for
@ -102,9 +102,13 @@ parameters must be defined:
on the SPI flash found within the spiffs
usage address space
spiffs_config.log_block_size -
spiffs_config.log_block_size - the logical size of a spiffs block
spiffs_config.log_page_size - the logical size of a spiffs page
If SPIFFS_SINGLETON is set to one, above parameters must be set ny defines in
the config header file.
spiffs_config.log_page_size -
** Build config
@ -117,6 +121,7 @@ be typedeffed.
spiffs_config.h: you also need to define a spiffs_config.h header. Example of
this is found in the default/ directory.
** RAM
Spiffs needs ram. It needs a working buffer being double the size of the
@ -144,7 +149,7 @@ you point out these files in your make script for compilation.
Also copy the spiffs_config.h over from the default/ folder.
Try buliding. This fails, nagging about inclusions and u32_t and whatnot. Open
Try building. This fails, nagging about inclusions and u32_t and whatnot. Open
the spiffs_config.h and delete the bad inclusions. Also, add following
typedefs:

4
docs/TECH_SPEC
View File

@ -228,9 +228,9 @@ would look like this:
PAGE 0 [ 12 12 545 12 *12 34 34 *4 0 0 0 0 ...]
where the asterisk means the msb is set.
where the asterisk means the msb of the object id is set.
This is another way to speed up the searches when looking for object indices.
By looking on the object id's msb in the object lookup, it is also possible
whether the page is an object index page or a data page.
to find out whether the page is an object index page or a data page.