#include <sys/types.h>
#include <zephyr/sys/util.h>
#include <zephyr/sys/slist.h>
#include <zephyr/sys/iterable_sections.h>
#include <stdint.h>

Data Structures
struct	settings_handler

struct	settings_handler_static

struct	settings_store

struct	settings_load_arg

struct	settings_store_itf

Macros
#define	SETTINGS_MAX_DIR_DEPTH 8 /* max depth of settings tree */

#define	SETTINGS_MAX_NAME_LEN (8 * SETTINGS_MAX_DIR_DEPTH)

#define	SETTINGS_MAX_VAL_LEN 256

#define	SETTINGS_NAME_SEPARATOR '/'

#define	SETTINGS_NAME_END '='

#define	SETTINGS_EXTRA_LEN ((SETTINGS_MAX_DIR_DEPTH - 1) + 2)

#define	SETTINGS_STATIC_HANDLER_DEFINE(_hname, _tree, _get, _set, _commit, _export)

Typedefs
typedef ssize_t(*	settings_read_cb) (void cb_arg, void data, size_t len)

typedef int(*	settings_load_direct_cb) (const char key, size_t len, settings_read_cb read_cb, void cb_arg, void *param)

Functions
int	settings_subsys_init (void)

int	settings_register (struct settings_handler *cf)

int	settings_load (void)

int	settings_load_subtree (const char *subtree)

int	settings_load_subtree_direct (const char subtree, settings_load_direct_cb cb, void param)

int	settings_save (void)

int	settings_save_one (const char name, const void value, size_t val_len)

int	settings_delete (const char *name)

int	settings_commit (void)

int	settings_commit_subtree (const char *subtree)

void	settings_src_register (struct settings_store *cs)

void	settings_dst_register (struct settings_store *cs)

struct settings_handler_static *	settings_parse_and_lookup (const char name, const char *next)

int	settings_call_set_handler (const char name, size_t len, settings_read_cb read_cb, void read_cb_arg, const struct settings_load_arg *load_arg)

int	settings_name_steq (const char name, const char key, const char **next)

int	settings_name_next (const char name, const char *next)

int	settings_runtime_set (const char name, const void data, size_t len)

int	settings_runtime_get (const char name, void data, size_t len)

int	settings_runtime_commit (const char *name)

int	settings_storage_get (void **storage)

Function Documentation

◆ settings_storage_get()

int settings_storage_get ( void ** storage )

Get the storage instance used by zephyr.

The type of storage object instance depends on the settings backend used. It might pointer to: struct nvs_fs, struct fcb or string witch file name depends on settings backend type used.

Return values

Pointer	to which reference to the storage object can be stored.
0	on success, negative error code on failure.

Data Structures

Macros

Typedefs

Functions

Function Documentation

◆ settings_storage_get()