log_file.h

Go to the documentation of this file.

 
#include "_feram_private.h"
 
#include "lfs.h"
 
#ifndef LOG_FILE_H
    #define LOG_FILE_H
 
// Log file attributes
struct logfile_metadata {
    unsigned schema_version;
    size_t entry_size;
    unsigned max_entry_cnt;
    unsigned entries_written_cnt;  // index to next available index to write to
};
 
 
// struct to store information about the file
typedef struct {
    struct {
        lfs_file_t file;
        struct lfs_file_config config;
    } lfs;
 
    uint8_t buffer[FERAM_CACHE_SIZE];
    struct logfile_metadata metadata;
    bool is_open;
} Logfile_t;
 
int logfile_create(Logfile_t *file, const char *path, unsigned schema_version, size_t entry_size, unsigned max_entries);
 
int logfile_open(Logfile_t *file, const char *path, int schema_version, int entry_size, int max_entries);
 
int logfile_close(Logfile_t *file);
 
int logfile_read_entry(Logfile_t *file, unsigned index, void *buffer);
 
int logfile_read_oldest(Logfile_t *file, void *buffer);
 
int logfile_read_newest(Logfile_t *file, void *buffer);
 
int logfile_write_next_entry(Logfile_t *file, const void *buffer);
 
int logfile_read_attributes(Logfile_t *file);
 
#endif /* LOG_FILE_H */