bm_storage.h

 
#ifndef BM_STORAGE_H__
#define BM_STORAGE_H__
 
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum bm_storage_evt_type {
        BM_STORAGE_EVT_WRITE_RESULT,
        BM_STORAGE_EVT_ERASE_RESULT
};
 
struct bm_storage_evt {
        enum bm_storage_evt_type id;
        bool is_async;
        int result;
        uint32_t addr;
        const void *src;
        size_t len;
        void *ctx;
};
 
typedef void (*bm_storage_evt_handler_t)(struct bm_storage_evt *evt);
 
struct bm_storage_info {
        uint32_t program_unit;
        uint32_t erase_unit;
        uint32_t wear_unit;
        uint8_t erase_value;
        bool is_erase_before_write;
};
 
struct bm_storage;
struct bm_storage_config;
 
struct bm_storage_api {
        int (*init)(struct bm_storage *storage, const struct bm_storage_config *config);
        int (*uninit)(struct bm_storage *storage);
        int (*read)(const struct bm_storage *storage, uint32_t src, void *dest, uint32_t len);
        int (*write)(const struct bm_storage *storage, uint32_t dest, const void *src, uint32_t len,
                     void *ctx);
        int (*erase)(const struct bm_storage *storage, uint32_t addr, uint32_t len, void *ctx);
        bool (*is_busy)(const struct bm_storage *storage);
};
 
struct bm_storage {
        const struct bm_storage_api *api;
        const struct bm_storage_info *nvm_info;
        bm_storage_evt_handler_t evt_handler;
        uint32_t addr;
        uint32_t size;
        struct {
                bool is_initialized : 1;
                bool is_wear_aligned : 1;
                bool is_write_padded : 1;
        } flags;
};
 
struct bm_storage_config {
        bm_storage_evt_handler_t evt_handler;
        const struct bm_storage_api *api;
        uint32_t addr;
        uint32_t size;
        struct {
                bool is_wear_aligned : 1;
                bool is_write_padded : 1;
        } flags;
};
 
int bm_storage_init(struct bm_storage *storage, const struct bm_storage_config *config);
 
int bm_storage_uninit(struct bm_storage *storage);
 
int bm_storage_read(const struct bm_storage *storage, uint32_t src, void *dest, uint32_t len);
 
int bm_storage_write(const struct bm_storage *storage, uint32_t dest, const void *src,
                     uint32_t len, void *ctx);
 
int bm_storage_erase(const struct bm_storage *storage, uint32_t addr, uint32_t len, void *ctx);
 
bool bm_storage_is_busy(const struct bm_storage *storage);
 
const struct bm_storage_info *bm_storage_nvm_info_get(const struct bm_storage *storage);
 
void bm_storage_evt_dispatch(const struct bm_storage *storage, struct bm_storage_evt *evt);
 
#ifdef __cplusplus
}
#endif
 
#include <bm/storage/bm_storage_backends.h>
 
#endif /* BM_STORAGE_H__ */