750818de72
* 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
100 lines
3.3 KiB
C
100 lines
3.3 KiB
C
// Copyright 2015-2017 Espressif Systems (Shanghai) PTE LTD
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#ifndef _ESP_SPIFFS_H_
|
|
#define _ESP_SPIFFS_H_
|
|
|
|
#include <stdbool.h>
|
|
#include "esp_err.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Configuration structure for esp_vfs_spiffs_register
|
|
*/
|
|
typedef struct {
|
|
const char* base_path; /*!< File path prefix associated with the filesystem. */
|
|
const char* partition_label; /*!< Optional, label of SPIFFS partition to use. If set to NULL, first partition with subtype=spiffs will be used. */
|
|
size_t max_files; /*!< Maximum files that could be open at the same time. */
|
|
bool format_if_mount_failed; /*!< If true, it will format the file system if it fails to mount. */
|
|
} esp_vfs_spiffs_conf_t;
|
|
|
|
/**
|
|
* Register and mount SPIFFS to VFS with given path prefix.
|
|
*
|
|
* @param conf Pointer to esp_vfs_spiffs_conf_t configuration structure
|
|
*
|
|
* @return
|
|
* - ESP_OK if success
|
|
* - ESP_ERR_NO_MEM if objects could not be allocated
|
|
* - ESP_ERR_INVALID_STATE if already mounted or partition is encrypted
|
|
* - ESP_ERR_NOT_FOUND if partition for SPIFFS was not found
|
|
* - ESP_FAIL if mount or format fails
|
|
*/
|
|
esp_err_t esp_vfs_spiffs_register(const esp_vfs_spiffs_conf_t * conf);
|
|
|
|
/**
|
|
* Unregister and unmount SPIFFS from VFS
|
|
*
|
|
* @param partition_label Same label as passed to esp_vfs_spiffs_register.
|
|
*
|
|
* @return
|
|
* - ESP_OK if successful
|
|
* - ESP_ERR_INVALID_STATE already unregistered
|
|
*/
|
|
esp_err_t esp_vfs_spiffs_unregister(const char* partition_label);
|
|
|
|
/**
|
|
* Check if SPIFFS is mounted
|
|
*
|
|
* @param partition_label Optional, label of the partition to check.
|
|
* If not specified, first partition with subtype=spiffs is used.
|
|
*
|
|
* @return
|
|
* - true if mounted
|
|
* - false if not mounted
|
|
*/
|
|
bool esp_spiffs_mounted(const char* partition_label);
|
|
|
|
/**
|
|
* Format the SPIFFS partition
|
|
*
|
|
* @param partition_label Same label as passed to esp_vfs_spiffs_register.
|
|
* @return
|
|
* - ESP_OK if successful
|
|
* - ESP_FAIL on error
|
|
*/
|
|
esp_err_t esp_spiffs_format(const char* partition_label);
|
|
|
|
/**
|
|
* Get information for SPIFFS
|
|
*
|
|
* @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
|
|
*
|
|
* @return
|
|
* - ESP_OK if success
|
|
* - ESP_ERR_INVALID_STATE if not mounted
|
|
*/
|
|
esp_err_t esp_spiffs_info(const char* partition_label, size_t *total_bytes, size_t *used_bytes);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _ESP_SPIFFS_H_ */
|