ref/eepromfs_8h_source.html

#ifndef __LIBDRAGON_EEPROMFS_H

#define __LIBDRAGON_EEPROMFS_H


#include <stddef.h>

#include <stdint.h>

#include <stdbool.h>


#define EEPFS_ESUCCESS   0

#define EEPFS_EBADINPUT  -1

#define EEPFS_ENOFILE    -2

#define EEPFS_EBADFS     -3

#define EEPFS_ENOMEM     -4

#define EEPFS_EBADHANDLE -5

#define EEPFS_ECONFLICT  -6

#ifdef __cplusplus

extern "C" {

#endif


typedef struct eepfs_entry_t

{

    const char * path;

    size_t size;

} eepfs_entry_t;


int eepfs_init(const eepfs_entry_t * entries, size_t count);


int eepfs_close(void);


int eepfs_read(const char * path, void * dest, size_t size);


int eepfs_write(const char * path, const void * src, size_t size);


int eepfs_erase(const char * path);


bool eepfs_verify_signature(void);


void eepfs_wipe(void);


#ifdef __cplusplus

}

#endif


#endif

eepfs_verify_signature
bool eepfs_verify_signature(void)
Validates the first block of EEPROM.
Definition eepromfs.c:371

eepfs_read
int eepfs_read(const char *path, void *dest, size_t size)
Reads an entire file from the EEPROM filesystem.
Definition eepromfs.c:301

eepfs_close
int eepfs_close(void)
De-initializes the EEPROM filesystem.
Definition eepromfs.c:284

eepfs_entry_t::path
const char * path
File path.
Definition eepromfs.h:57

eepfs_init
int eepfs_init(const eepfs_entry_t *entries, size_t count)
Initializes the EEPROM filesystem.
Definition eepromfs.c:208

eepfs_entry_t::size
size_t size
File size in bytes.
Definition eepromfs.h:73

eepfs_write
int eepfs_write(const char *path, const void *src, size_t size)
Writes an entire file to the EEPROM filesystem.
Definition eepromfs.c:323

eepfs_erase
int eepfs_erase(const char *path)
Erases a file in the EEPROM filesystem.
Definition eepromfs.c:345

eepfs_wipe
void eepfs_wipe(void)
Erases all blocks in EEPROM and sets a new signature.
Definition eepromfs.c:385

eepfs_entry_t
EEPROM filesystem configuration file entry.
Definition eepromfs.h:42