zms.h File Reference

#include <sys/types.h>
#include <zephyr/drivers/flash.h>
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <zephyr/toolchain.h>

Go to the source code of this file.

Data Structures
struct	zms_fs
	Zephyr Memory Storage file system structure. More...

Typedefs
typedef uint32_t	zms_id_t
	ID type used in the ZMS API.

Functions
int	zms_mount (struct zms_fs *fs)
	Mount a ZMS file system onto the device specified in fs.
int	zms_clear (struct zms_fs *fs)
	Clear the ZMS file system from device.
ssize_t	zms_write (struct zms_fs *fs, zms_id_t id, const void *data, size_t len)
	Write an entry to the file system.
int	zms_delete (struct zms_fs *fs, zms_id_t id)
	Delete an entry from the file system.
ssize_t	zms_read (struct zms_fs *fs, zms_id_t id, void *data, size_t len)
	Read an entry from the file system.
ssize_t	zms_read_hist (struct zms_fs *fs, zms_id_t id, void *data, size_t len, uint32_t cnt)
	Read a history entry from the file system.
ssize_t	zms_get_data_length (struct zms_fs *fs, zms_id_t id)
	Gets the length of the data that is stored in an entry with a given id
ssize_t	zms_calc_free_space (struct zms_fs *fs)
	Calculate the available free space in the file system.
ssize_t	zms_active_sector_free_space (struct zms_fs *fs)
	Tell how much contiguous free space remains in the currently active ZMS sector.
int	zms_sector_use_next (struct zms_fs *fs)
	Close the currently active sector and switch to the next one.