/ components / spiffs / Kconfig
Kconfig
  1  
  2  
  3  config COMPONENT_SPIFFS_ENABLE
  4  	bool "Enable spiffs component"
  5  	default n
  6  menu "SPIFFS Configuration"
  7  	depends on COMPONENT_SPIFFS_ENABLE
  8  
  9  	menu "SPIFFS Cache Configuration"
 10          config SPIFFS_CACHE
 11              bool "Enable SPIFFS Cache"
 12              default "y"
 13              help
 14                  Enables/disable memory read caching of nucleus file system
 15                  operations.
 16  
 17          config SPIFFS_CACHE_WR
 18              bool "Enable SPIFFS Write Caching"
 19              default "y"
 20              depends on SPIFFS_CACHE
 21              help
 22                  Enables memory write caching for file descriptors in hydrogen.
 23  
 24          config SPIFFS_CACHE_STATS
 25              bool "Enable SPIFFS Cache Statistics"
 26              default "n"
 27              depends on SPIFFS_CACHE
 28              help
 29                  Enable/disable statistics on caching. Debug/test purpose only.
 30      endmenu
 31  
 32  	config SPIFFS_SIZE
 33  		hex "SPIFFS size"
 34  		default 0x300000
 35  
 36  	config SPIFFS_START_ADDR
 37  		hex "Start address of SPIFFS"
 38  		default 0xD00000
 39  		help
 40  			must be on block boundary
 41  
 42  	config SPIFFS_EREASE_SIZE
 43  		hex "Erease size of SPIFFS, see the datasheet"
 44  		default 0x1000
 45  	
 46  	config SPIFFS_LOGICAL_BLOCK_SIZE
 47  		hex "Logical block size of SPIFFS(default 32*4k)"
 48  		default 0x20000
 49  		help
 50  			logical size of a block, must be on physical block size boundary
 51  			and must never be less than a physical block
 52  
 53  	config SPIFFS_LOGICAL_PAGE_SIZE
 54  		hex "Logical page size of SPIFFS(default 4k(SPIFFS_LOGICAL_BLOCK_SIZE/32))"
 55  		default 0x1000
 56  		help
 57  			logical size of a page, must be at least logical block size / 8
 58  
 59  	config SPIFFS_OBJ_NAME_LEN
 60          int "Set SPIFFS Maximum Name Length"
 61          default 128
 62          range 1 256
 63      
 64          config SPIFFS_USE_MAGIC
 65          bool "Enable SPIFFS Filesystem Magic"
 66          default "y"
 67          help
 68              Enable this to have an identifiable spiffs filesystem.
 69              This will look for a magic in all sectors to determine if this
 70              is a valid spiffs system or not at mount time.
 71  
 72      config SPIFFS_USE_MAGIC_LENGTH
 73          bool "Enable SPIFFS Filesystem Length Magic"
 74          default "y"
 75          depends on SPIFFS_USE_MAGIC
 76          help
 77              If this option is enabled, the magic will also be dependent
 78              on the length of the filesystem. For example, a filesystem
 79              configured and formatted for 4 megabytes will not be accepted
 80              for mounting with a configuration defining the filesystem as 2 megabytes.
 81  
 82      config SPIFFS_META_LENGTH
 83          int "Size of per-file metadata field"
 84          default 0
 85          help
 86              This option sets the number of extra bytes stored in the file header.
 87              These bytes can be used in an application-specific manner.
 88              Set this to at least 4 bytes to enable support for saving file
 89              modification time.
 90  
 91              SPIFFS_OBJ_NAME_LEN + SPIFFS_META_LENGTH should not exceed
 92              SPIFFS_PAGE_SIZE - 64.
 93  	
 94  	menu "Debug Configuration"
 95  
 96          config SPIFFS_DBG
 97              bool "Enable general SPIFFS debug"
 98              default "n"
 99              help
100                  Enabling this option will print general debug mesages to the console.
101  
102          config SPIFFS_API_DBG
103              bool "Enable SPIFFS API debug"
104              default "n"
105              help
106                  Enabling this option will print API debug mesages to the console.
107  
108          config SPIFFS_GC_DBG
109              bool "Enable SPIFFS Garbage Cleaner debug"
110              default "n"
111              help
112                  Enabling this option will print GC debug mesages to the console.
113  
114          config SPIFFS_CACHE_DBG
115              bool "Enable SPIFFS Cache debug"
116              default "n"
117              depends on SPIFFS_CACHE
118              help
119                  Enabling this option will print cache debug mesages to the console.
120  
121          config SPIFFS_CHECK_DBG
122              bool "Enable SPIFFS Filesystem Check debug"
123              default "n"
124              help
125                  Enabling this option will print Filesystem Check debug mesages
126                  to the console.
127      endmenu
128  	
129  endmenu