alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

spiffs: clarify the usage of partition_label, fix the example

Browse Source 
* If esp_vfs_spiffs_register is called with an explicit partition
  label, other SPIFFS functions (info, format, unregister) must be
  called with the same label.

* On the other hand, if label was NULL in the call to
  esp_vfs_spiffs_register and the first matching partition was used,
  calls to the rest of the SPIFFS functions should be done with NULL
  partition_label argument.

Fix the Doxygen documentation. Update the example accordingly, in case
a user modifies "partition_label" value in esp_vfs_spiffs_conf_t conf
initializer.

Closes https://github.com/espressif/esp-idf/issues/4450
This commit is contained in:
Ivan Grokhotkov 2019-12-23 18:20:14 +01:00
parent 30372f5a4f
commit 750818de72
2 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
components/spiffs/include/esp_spiffs.h
View File

@ -49,8 +49,7 @@ esp_err_t esp_vfs_spiffs_register(const esp_vfs_spiffs_conf_t * conf);
/**
* Unregister and unmount SPIFFS from VFS
*
* @param partition_label Optional, label of the partition to unregister.
* If not specified, first partition with subtype=spiffs is used.
* @param partition_label Same label as passed to esp_vfs_spiffs_register.
*
* @return
* - ESP_OK if successful
@ -73,8 +72,7 @@ bool esp_spiffs_mounted(const char* partition_label);
/**
* Format the SPIFFS partition
*
* @param partition_label Optional, label of the partition to format.
* If not specified, first partition with subtype=spiffs is used.
* @param partition_label Same label as passed to esp_vfs_spiffs_register.
* @return
* - ESP_OK if successful
* - ESP_FAIL on error
@ -84,8 +82,7 @@ esp_err_t esp_spiffs_format(const char* partition_label);
/**
* Get information for SPIFFS
*
* @param partition_label Optional, label of the partition to get info for.
* If not specified, first partition with subtype=spiffs is used.
* @param partition_label Same label as passed to esp_vfs_spiffs_register
* @param[out] total_bytes Size of the file system
* @param[out] used_bytes Current used bytes in the file system
*

4
examples/storage/spiffs/main/spiffs_example_main.c
View File

@ -43,7 +43,7 @@ void app_main(void)
}
size_t total = 0, used = 0;
ret = esp_spiffs_info(NULL, &total, &used);
ret = esp_spiffs_info(conf.partition_label, &total, &used);
if (ret != ESP_OK) {
ESP_LOGE(TAG, "Failed to get SPIFFS partition information (%s)", esp_err_to_name(ret));
} else {
@ -94,6 +94,6 @@ void app_main(void)
ESP_LOGI(TAG, "Read from file: '%s'", line);
// All done, unmount partition and disable SPIFFS
esp_vfs_spiffs_unregister(NULL);
esp_vfs_spiffs_unregister(conf.partition_label);
ESP_LOGI(TAG, "SPIFFS unmounted");
}