nvs.h

Go to the documentation of this file.

/*  NVS: non volatile storage in flash
 *
 * Copyright (c) 2018 Laczen
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_FS_NVS_H_
#define ZEPHYR_INCLUDE_FS_NVS_H_
 
#include <sys/types.h>
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <zephyr/toolchain.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct nvs_fs {
        off_t offset;
        uint32_t ate_wra;
        uint32_t data_wra;
        uint16_t sector_size;
        uint16_t sector_count;
        bool ready;
        struct k_mutex nvs_lock;
        const struct device *flash_device;
        const struct flash_parameters *flash_parameters;
#if CONFIG_NVS_LOOKUP_CACHE
        uint32_t lookup_cache[CONFIG_NVS_LOOKUP_CACHE_SIZE];
#endif
};
 
int nvs_mount(struct nvs_fs *fs);
 
int nvs_clear(struct nvs_fs *fs);
 
ssize_t nvs_write(struct nvs_fs *fs, uint16_t id, const void *data, size_t len);
 
int nvs_delete(struct nvs_fs *fs, uint16_t id);
 
ssize_t nvs_read(struct nvs_fs *fs, uint16_t id, void *data, size_t len);
 
ssize_t nvs_read_hist(struct nvs_fs *fs, uint16_t id, void *data, size_t len, uint16_t cnt);
 
ssize_t nvs_calc_free_space(struct nvs_fs *fs);
 
__deprecated static inline int nvs_init(struct nvs_fs *fs, const char *dev_name)
{
        fs->flash_device = device_get_binding(dev_name);
        if (fs->flash_device == NULL) {
                return -ENODEV;
        }
 
        return nvs_mount(fs);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_FS_NVS_H_ */