Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
|
Topics | |
Settings backend interface | |
settings | |
Settings name processing | |
Settings subsystem runtime | |
Data Structures | |
struct | settings_handler |
Config handlers for subtree implement a set of handler functions. More... | |
struct | settings_handler_static |
Config handlers without the node element, used for static handlers. More... | |
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) |
Define a static handler for settings items. | |
Typedefs | |
typedef ssize_t(* | settings_read_cb) (void *cb_arg, void *data, size_t len) |
Function used to read the data from the settings storage in h_set handler implementations. | |
typedef int(* | settings_load_direct_cb) (const char *key, size_t len, settings_read_cb read_cb, void *cb_arg, void *param) |
Callback function used for direct loading. | |
Functions | |
int | settings_subsys_init (void) |
Initialization of settings and backend. | |
int | settings_register (struct settings_handler *cf) |
Register a handler for settings items stored in RAM. | |
int | settings_load (void) |
Load serialized items from registered persistence sources. | |
int | settings_load_subtree (const char *subtree) |
Load limited set of serialized items from registered persistence sources. | |
int | settings_load_subtree_direct (const char *subtree, settings_load_direct_cb cb, void *param) |
Load limited set of serialized items using given callback. | |
int | settings_save (void) |
Save currently running serialized items. | |
int | settings_save_subtree (const char *subtree) |
Save limited set of currently running serialized items. | |
int | settings_save_one (const char *name, const void *value, size_t val_len) |
Write a single serialized value to persisted storage (if it has changed value). | |
int | settings_delete (const char *name) |
Delete a single serialized in persisted storage. | |
int | settings_commit (void) |
Call commit for all settings handler. | |
int | settings_commit_subtree (const char *subtree) |
Call commit for settings handler that belong to subtree. | |
#define SETTINGS_EXTRA_LEN ((SETTINGS_MAX_DIR_DEPTH - 1) + 2) |
#include <zephyr/settings/settings.h>
#define SETTINGS_MAX_DIR_DEPTH 8 /* max depth of settings tree */ |
#include <zephyr/settings/settings.h>
#define SETTINGS_MAX_NAME_LEN (8 * SETTINGS_MAX_DIR_DEPTH) |
#include <zephyr/settings/settings.h>
#define SETTINGS_MAX_VAL_LEN 256 |
#include <zephyr/settings/settings.h>
#define SETTINGS_NAME_END '=' |
#include <zephyr/settings/settings.h>
#define SETTINGS_NAME_SEPARATOR '/' |
#include <zephyr/settings/settings.h>
#define SETTINGS_STATIC_HANDLER_DEFINE | ( | _hname, | |
_tree, | |||
_get, | |||
_set, | |||
_commit, | |||
_export ) |
#include <zephyr/settings/settings.h>
Define a static handler for settings items.
_hname | handler name |
_tree | subtree name |
_get | get routine (can be NULL) |
_set | set routine (can be NULL) |
_commit | commit routine (can be NULL) |
_export | export routine (can be NULL) |
This creates a variable hname prepended by settings_handler.
typedef int(* settings_load_direct_cb) (const char *key, size_t len, settings_read_cb read_cb, void *cb_arg, void *param) |
#include <zephyr/settings/settings.h>
Callback function used for direct loading.
Used by settings_load_subtree_direct function.
[in] | key | the name with skipped part that was used as name in handler registration |
[in] | len | the size of the data found in the backend. |
[in] | read_cb | function provided to read the data from the backend. |
[in,out] | cb_arg | arguments for the read function provided by the backend. |
[in,out] | param | parameter given to the settings_load_subtree_direct function. |
#include <zephyr/settings/settings.h>
Function used to read the data from the settings storage in h_set handler implementations.
[in] | cb_arg | arguments for the read function. Appropriate cb_arg is transferred to h_set handler implementation by the backend. |
[out] | data | the destination buffer |
[in] | len | length of read |
int settings_commit | ( | void | ) |
#include <zephyr/settings/settings.h>
Call commit for all settings handler.
This should apply all settings which has been set, but not applied yet.
int settings_commit_subtree | ( | const char * | subtree | ) |
#include <zephyr/settings/settings.h>
Call commit for settings handler that belong to subtree.
This should apply all settings which has been set, but not applied yet.
[in] | subtree | name of the subtree to be committed. |
int settings_delete | ( | const char * | name | ) |
#include <zephyr/settings/settings.h>
Delete a single serialized in persisted storage.
Deleting an existing key-value pair in the settings mean to set its value to NULL.
name | Name/key of the settings item. |
int settings_load | ( | void | ) |
#include <zephyr/settings/settings.h>
Load serialized items from registered persistence sources.
Handlers for serialized item subtrees registered earlier will be called for encountered values.
int settings_load_subtree | ( | const char * | subtree | ) |
#include <zephyr/settings/settings.h>
Load limited set of serialized items from registered persistence sources.
Handlers for serialized item subtrees registered earlier will be called for encountered values that belong to the subtree.
[in] | subtree | name of the subtree to be loaded. |
int settings_load_subtree_direct | ( | const char * | subtree, |
settings_load_direct_cb | cb, | ||
void * | param ) |
#include <zephyr/settings/settings.h>
Load limited set of serialized items using given callback.
This function bypasses the normal data workflow in settings module. All the settings values that are found are passed to the given callback.
[in] | subtree | subtree name of the subtree to be loaded. |
[in] | cb | pointer to the callback function. |
[in,out] | param | parameter to be passed when callback function is called. |
int settings_register | ( | struct settings_handler * | cf | ) |
#include <zephyr/settings/settings.h>
Register a handler for settings items stored in RAM.
cf | Structure containing registration info. |
int settings_save | ( | void | ) |
#include <zephyr/settings/settings.h>
Save currently running serialized items.
All serialized items which are different from currently persisted values will be saved.
int settings_save_one | ( | const char * | name, |
const void * | value, | ||
size_t | val_len ) |
#include <zephyr/settings/settings.h>
Write a single serialized value to persisted storage (if it has changed value).
name | Name/key of the settings item. |
value | Pointer to the value of the settings item. This value will be transferred to the settings_handler::h_export handler implementation. |
val_len | Length of the value. |
int settings_save_subtree | ( | const char * | subtree | ) |
#include <zephyr/settings/settings.h>
Save limited set of currently running serialized items.
All serialized items that belong to subtree and which are different from currently persisted values will be saved.
[in] | subtree | name of the subtree to be loaded. |
int settings_subsys_init | ( | void | ) |
#include <zephyr/settings/settings.h>
Initialization of settings and backend.
Can be called at application startup. In case the backend is a FS Remember to call it after the FS was mounted. For FCB backend it can be called without such a restriction.