5502879a5b
This is very much still work in progress and much more will change before the final 2.0.0 Some APIs have changed. New libraries have been added. LittleFS included. Co-authored-by: Seon Rozenblum <seonr@3sprockets.com> Co-authored-by: Me No Dev <me-no-dev@users.noreply.github.com> Co-authored-by: geeksville <kevinh@geeksville.com> Co-authored-by: Mike Dunston <m_dunston@comcast.net> Co-authored-by: Unexpected Maker <seon@unexpectedmaker.com> Co-authored-by: Seon Rozenblum <seonr@3sprockets.com> Co-authored-by: microDev <70126934+microDev1@users.noreply.github.com> Co-authored-by: tobozo <tobozo@users.noreply.github.com> Co-authored-by: bobobo1618 <bobobo1618@users.noreply.github.com> Co-authored-by: lorol <lorolouis@gmail.com> Co-authored-by: geeksville <kevinh@geeksville.com> Co-authored-by: Limor "Ladyada" Fried <limor@ladyada.net> Co-authored-by: Sweety <switi.mhaiske@espressif.com> Co-authored-by: Loick MAHIEUX <loick111@gmail.com> Co-authored-by: Larry Bernstone <lbernstone@gmail.com> Co-authored-by: Valerii Koval <valeros@users.noreply.github.com> Co-authored-by: 快乐的我531 <2302004040@qq.com> Co-authored-by: chegewara <imperiaonline4@gmail.com> Co-authored-by: Clemens Kirchgatterer <clemens@1541.org> Co-authored-by: Aron Rubin <aronrubin@gmail.com> Co-authored-by: Pete Lewis <601236+lewispg228@users.noreply.github.com>
119 lines
3.3 KiB
C
119 lines
3.3 KiB
C
#ifndef ESP_LITTLEFS_H__
|
|
#define ESP_LITTLEFS_H__
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include <stdarg.h>
|
|
#include <unistd.h>
|
|
#include <utime.h>
|
|
#include "freertos/FreeRTOS.h"
|
|
#include "freertos/semphr.h"
|
|
#include "esp_err.h"
|
|
#include <sys/types.h>
|
|
#include <sys/reent.h>
|
|
#include <sys/stat.h>
|
|
#include <sys/time.h>
|
|
#include <sys/poll.h>
|
|
#include <dirent.h>
|
|
#include <string.h>
|
|
#include "sdkconfig.h"
|
|
|
|
#include "littlefs/lfs.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Last Modified Time
|
|
*
|
|
* Use 't' for LITTLEFS_ATTR_MTIME to match example:
|
|
* https://github.com/ARMmbed/littlefs/issues/23#issuecomment-482293539
|
|
* And to match other external tools such as:
|
|
* https://github.com/earlephilhower/mklittlefs
|
|
*/
|
|
#define LITTLEFS_ATTR_MTIME ((uint8_t) 't')
|
|
|
|
/**
|
|
*Configuration structure for esp_vfs_littlefs_register.
|
|
*/
|
|
typedef struct {
|
|
const char *base_path; /**< Mounting point. */
|
|
const char *partition_label; /**< Label of partition to use. */
|
|
uint8_t format_if_mount_failed:1; /**< Format the file system if it fails to mount. */
|
|
uint8_t dont_mount:1; /**< Don't attempt to mount or format. Overrides format_if_mount_failed */
|
|
} esp_vfs_littlefs_conf_t;
|
|
|
|
/**
|
|
* Register and mount littlefs to VFS with given path prefix.
|
|
*
|
|
* @param conf Pointer to esp_vfs_littlefs_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 littlefs was not found
|
|
* - ESP_FAIL if mount or format fails
|
|
*/
|
|
esp_err_t esp_vfs_littlefs_register(const esp_vfs_littlefs_conf_t * conf);
|
|
|
|
/**
|
|
* Unregister and unmount littlefs from VFS
|
|
*
|
|
* @param partition_label Label of the partition to unregister.
|
|
*
|
|
* @return
|
|
* - ESP_OK if successful
|
|
* - ESP_ERR_INVALID_STATE already unregistered
|
|
*/
|
|
esp_err_t esp_vfs_littlefs_unregister(const char* partition_label);
|
|
|
|
/**
|
|
* Check if littlefs is mounted
|
|
*
|
|
* @param partition_label Label of the partition to check.
|
|
*
|
|
* @return
|
|
* - true if mounted
|
|
* - false if not mounted
|
|
*/
|
|
bool esp_littlefs_mounted(const char* partition_label);
|
|
|
|
/**
|
|
* Format the littlefs partition
|
|
*
|
|
* @param partition_label Label of the partition to format.
|
|
* @return
|
|
* - ESP_OK if successful
|
|
* - ESP_FAIL on error
|
|
*/
|
|
esp_err_t esp_littlefs_format(const char* partition_label);
|
|
|
|
/**
|
|
* Get information for littlefs
|
|
*
|
|
* @param partition_label Optional, label of the partition to get info for.
|
|
* @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_littlefs_info(const char* partition_label, size_t *total_bytes, size_t *used_bytes);
|
|
|
|
#if CONFIG_LITTLEFS_HUMAN_READABLE
|
|
/**
|
|
* @brief converts an enumerated lfs error into a string.
|
|
* @param lfs_errno The enumerated littlefs error.
|
|
*/
|
|
const char * esp_littlefs_errno(enum lfs_error lfs_errno);
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
} // extern "C"
|
|
#endif
|
|
|
|
#endif
|