bm_zms.h

/* Copyright (c) 2018 Laczen
 * Copyright (c) 2024 BayLibre SAS
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * BM_ZMS: Bare Metal Zephyr Memory Storage
 */
#ifndef ZEPHYR_INCLUDE_FS_BM_ZMS_H_
#define ZEPHYR_INCLUDE_FS_BM_ZMS_H_
 
#include <sys/types.h>
#include <zephyr/sys/atomic.h>
#include <stdbool.h>
#include <bm/storage/bm_storage.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum bm_zms_evt_type {
        BM_ZMS_EVT_NONE,
        BM_ZMS_EVT_MOUNT,
        BM_ZMS_EVT_WRITE,
        BM_ZMS_EVT_DELETE,
        BM_ZMS_EVT_CLEAR,
};
 
struct bm_zms_evt {
        enum bm_zms_evt_type evt_type;
        int result;
        uint32_t id;
};
 
struct bm_zms_init_flags {
        volatile bool initialized;
        volatile bool initializing;
} __packed;
 
typedef void (*bm_zms_evt_handler_t)(const struct bm_zms_evt *evt);
 
struct bm_zms_fs {
        off_t offset;
        uint64_t ate_wra;
        uint64_t ate_ra;
        uint64_t data_wra;
        uint32_t sector_size;
        uint32_t sector_count;
        uint8_t sector_cycle;
        struct bm_zms_init_flags init_flags;
        size_t ate_size;
        struct bm_storage zms_bm_storage;
        const struct bm_storage_info *nvm_info;
        atomic_t ongoing_writes;
        bm_zms_evt_handler_t evt_handler;
#if CONFIG_BM_ZMS_LOOKUP_CACHE
        uint64_t lookup_cache[CONFIG_BM_ZMS_LOOKUP_CACHE_SIZE];
#endif
};
 
struct bm_zms_fs_config {
        off_t offset;
        uint32_t sector_size;
        uint32_t sector_count;
        bm_zms_evt_handler_t evt_handler;
        const struct bm_storage_api *storage_api;
};
 
int bm_zms_mount(struct bm_zms_fs *fs, const struct bm_zms_fs_config *config);
 
int bm_zms_clear(struct bm_zms_fs *fs);
 
ssize_t bm_zms_write(struct bm_zms_fs *fs, uint32_t id, const void *data, size_t len);
 
int bm_zms_delete(struct bm_zms_fs *fs, uint32_t id);
 
ssize_t bm_zms_read(struct bm_zms_fs *fs, uint32_t id, void *data, size_t len);
 
ssize_t bm_zms_read_hist(struct bm_zms_fs *fs, uint32_t id, void *data, size_t len, uint32_t cnt);
 
ssize_t bm_zms_get_data_length(struct bm_zms_fs *fs, uint32_t id);
 
ssize_t bm_zms_calc_free_space(struct bm_zms_fs *fs);
 
ssize_t bm_zms_active_sector_free_space(struct bm_zms_fs *fs);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_FS_BM_ZMS_H_ */