icarus-os-core/fs_8h_source.html

#ifndef ICARUS_FS_H

#define ICARUS_FS_H


#ifdef __cplusplus

extern "C" {

#endif


#include <stdint.h>

#include <stdbool.h>


/* ---- Sizing ------------------------------------------------------------ */


#define FS_MAX_FILES      16

#define FS_MAX_NAME_LEN   12   /* null-terminated, so 11 usable chars */

#define FS_MAX_FILE_SIZE  2048 /* bytes per file */

#define FS_TOTAL_BYTES    (FS_MAX_FILES * FS_MAX_FILE_SIZE) /* 32 KB */


/* ---- Types ------------------------------------------------------------- */


typedef struct {

    uint8_t  slot;

    bool     valid;

} fs_file_t;


typedef struct {

    char     name[FS_MAX_NAME_LEN];

    uint16_t size;

} fs_file_info_t;


typedef struct {

    uint32_t total_bytes;

    uint32_t used_bytes;

    uint32_t free_bytes;

    uint8_t  file_count;

} fs_stats_t;


/* ---- API --------------------------------------------------------------- */


void fs_init(void);


bool fs_create(const char *name, fs_file_t *out);


bool fs_open(const char *name, fs_file_t *out);


bool fs_write(fs_file_t *f, const uint8_t *data, uint16_t len);


uint16_t fs_read(fs_file_t *f, uint8_t *buf, uint16_t len, uint16_t offset);


bool fs_delete(const char *name);


uint8_t fs_list(fs_file_info_t *out, uint8_t max);


void fs_stats(fs_stats_t *out);


/* ---- Privileged implementations (internal — do not call directly) ------ */


void     __fs_init(void);

bool     __fs_create(const char *name, fs_file_t *out);

bool     __fs_open(const char *name, fs_file_t *out);

bool     __fs_write(fs_file_t *f, const uint8_t *data, uint16_t len);

uint16_t __fs_read(fs_file_t *f, uint8_t *buf, uint16_t len, uint16_t offset);

bool     __fs_delete(const char *name);

uint8_t  __fs_list(fs_file_info_t *out, uint8_t max);

void     __fs_stats(fs_stats_t *out);


#ifdef __cplusplus

}

#endif


#endif /* ICARUS_FS_H */

__fs_write
bool __fs_write(fs_file_t *f, const uint8_t *data, uint16_t len)
Privileged implementation of fs_write().
Definition fs.c:146

FS_MAX_NAME_LEN
#define FS_MAX_NAME_LEN
Definition fs.h:33

fs_write
bool fs_write(fs_file_t *f, const uint8_t *data, uint16_t len)
Append data to an open file.
Definition fs.c:345

fs_create
bool fs_create(const char *name, fs_file_t *out)
Create a new file with the given name.
Definition fs.c:292

fs_delete
bool fs_delete(const char *name)
Delete a file by name.
Definition fs.c:401

__fs_init
void __fs_init(void)
Privileged implementation of fs_init().
Definition fs.c:76

__fs_list
uint8_t __fs_list(fs_file_info_t *out, uint8_t max)
Privileged implementation of fs_list().
Definition fs.c:227

__fs_open
bool __fs_open(const char *name, fs_file_t *out)
Privileged implementation of fs_open().
Definition fs.c:124

fs_read
uint16_t fs_read(fs_file_t *f, uint8_t *buf, uint16_t len, uint16_t offset)
Read bytes from an open file at a given offset.
Definition fs.c:373

__fs_create
bool __fs_create(const char *name, fs_file_t *out)
Privileged implementation of fs_create().
Definition fs.c:88

fs_stats
void fs_stats(fs_stats_t *out)
Return aggregate filesystem statistics.
Definition fs.c:447

fs_list
uint8_t fs_list(fs_file_info_t *out, uint8_t max)
Enumerate all files currently in the filesystem.
Definition fs.c:424

fs_open
bool fs_open(const char *name, fs_file_t *out)
Open an existing file by name.
Definition fs.c:318

fs_init
void fs_init(void)
Clear all file table entries and zero the data store.
Definition fs.c:277

__fs_stats
void __fs_stats(fs_stats_t *out)
Privileged implementation of fs_stats().
Definition fs.c:249

__fs_read
uint16_t __fs_read(fs_file_t *f, uint8_t *buf, uint16_t len, uint16_t offset)
Privileged implementation of fs_read().
Definition fs.c:175

__fs_delete
bool __fs_delete(const char *name)
Privileged implementation of fs_delete().
Definition fs.c:205

fs_file_info_t
Per-file metadata returned by fs_list().
Definition fs.h:46

fs_file_info_t::size
uint16_t size
Current number of bytes written.
Definition fs.h:48

fs_file_t
Opaque file handle — callers hold one of these per open file.
Definition fs.h:40

fs_file_t::slot
uint8_t slot
Index into internal file table (0-based).
Definition fs.h:41

fs_file_t::valid
bool valid
True if handle references a live file entry.
Definition fs.h:42

fs_stats_t
Aggregate filesystem statistics.
Definition fs.h:52

fs_stats_t::free_bytes
uint32_t free_bytes
Bytes available for new data.
Definition fs.h:55

fs_stats_t::used_bytes
uint32_t used_bytes
Bytes occupied by all file data.
Definition fs.h:54

fs_stats_t::total_bytes
uint32_t total_bytes
Total storage capacity in bytes.
Definition fs.h:53

fs_stats_t::file_count
uint8_t file_count
Number of files currently stored.
Definition fs.h:56