storage.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
 
#include "card_state.h"
#include "esp_err.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define STORAGE_MOUNT_POINT "/sdcard"
#define STORAGE_NAME_MAX 64
 
/*
 * A file's size is 64-bit: an exFAT (extended File Allocation Table) volume
 * holds files of 4GiB and more.  FAT12, FAT16 and FAT32 stop at
 * 4GiB less 1 byte.
 */
typedef struct {
    char name[STORAGE_NAME_MAX];
    uint64_t size;
    bool is_dir;
    uint32_t stamp;
} storage_entry_t;

typedef struct {
    uint64_t size;      
    bool is_dir;
    int64_t mtime;      
} storage_stat_t;

esp_err_t storage_init(void);

card_state_t storage_check(void);

bool storage_hold(void);

bool storage_hold_mount(unsigned mount);

void storage_release(void);

FILE *storage_fopen(const char *path, const char *mode);

int storage_fclose(FILE *f);

void storage_deinit(void);

bool storage_mounted(void);

unsigned storage_mount_count(void);

uint64_t storage_total_bytes(void);
uint64_t storage_free_bytes(void);

void storage_card_name(char *out, size_t n);

const char *storage_status(void);

card_state_t storage_card_state(void);

typedef void (*storage_visit_fn)(const storage_entry_t *entry, void *ctx);
 
typedef void (*storage_tick_fn)(void);

#define STORAGE_WALK_NO_DIR (-2)
#define STORAGE_WALK_REMOUNTED (-3)

int storage_walk(const char *dir, const char *suffixes, storage_visit_fn visit,
                 void *ctx, storage_tick_fn tick);

int storage_walk_counted(const char *dir, const char *suffixes,
                         storage_visit_fn visit, void *ctx,
                         storage_tick_fn tick, unsigned *left_out);

esp_err_t storage_stat(const char *path, storage_stat_t *out);

int64_t storage_stamp_mtime(uint32_t stamp);

typedef struct storage_dir storage_dir_t;

storage_dir_t *storage_dir_open(const char *path);

int storage_dir_read(storage_dir_t *d, char *name, size_t cap,
                     storage_stat_t *out);

void storage_dir_close(storage_dir_t *d);

void storage_path(const char *dir, const char *name, char *out, size_t out_size);
 
#ifdef __cplusplus
}
#endif