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 <kernel.h>
#include <device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct nvs_fs {
        off_t offset;           /* filesystem offset in flash */
        uint32_t ate_wra;               /* next alloc table entry write address */
        uint32_t data_wra;              /* next data write address */
        uint16_t sector_size;   /* filesystem is divided into sectors,
                                 * sector size should be multiple of pagesize
                                 */
        uint16_t sector_count;  /* amount of sectors in the filesystem */
        bool ready;             /* is the filesystem initialized ? */
 
        struct k_mutex nvs_lock;
        const struct device *flash_device;
        const struct flash_parameters *flash_parameters;
};
 
int nvs_init(struct nvs_fs *fs, const char *dev_name);
 
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);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_FS_NVS_H_ */