storage.h

Go to the documentation of this file.

#ifndef NEXUS_COMPONENTS_STORAGE_H
#define NEXUS_COMPONENTS_STORAGE_H
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    NX_STORAGE_OK = 0,
    NX_STORAGE_INVALID,
    NX_STORAGE_IO,
    NX_STORAGE_CORRUPT,
    NX_STORAGE_NO_SPACE,
    NX_STORAGE_NOT_FOUND,
    NX_STORAGE_UNSUPPORTED
} nx_storage_status_t;

typedef struct {
    void* ctx;
    size_t size;
    size_t erase_size;
    size_t program_size;
    nx_storage_status_t (*read)(void*, size_t, void*, size_t);
    nx_storage_status_t (*program)(void*, size_t, const void*, size_t);
    nx_storage_status_t (*erase)(void*, size_t, size_t);
    nx_storage_status_t (*sync)(void*);
} nx_storage_port_t;
 
#define NX_STORAGE_HEADER_SIZE 32u

typedef struct {
    nx_storage_port_t flash;
    size_t offset;
    size_t bank_size;
    size_t payload_offset;
    uint64_t generation;
    size_t payload_size;
    int active_bank;
    bool opened;
    uint8_t* workspace;
    size_t workspace_bytes;
} nx_storage_t;

nx_storage_status_t nx_storage_open(nx_storage_t* storage,
                                    const nx_storage_port_t* port,
                                    size_t offset, size_t bank_size,
                                    void* workspace, size_t workspace_bytes);
nx_storage_status_t nx_storage_load(nx_storage_t* storage, void* output,
                                    size_t* size);
nx_storage_status_t nx_storage_save(nx_storage_t* storage, const void* data,
                                    size_t size);
size_t nx_storage_capacity(const nx_storage_t* storage);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NEXUS_COMPONENTS_STORAGE_H */