177e9b93bf
Mesh models may have a data that needs to be stored persistently. Currently, the models should call bt_mesh_model_data_store and the store will happen in the calling context. Most likely that it will be called in BT RX thread as this is the context from which model's opcodes handlers are called. Thus, the thread will be blocked until the store is finished. Another issues is that some models may have states that changes frequently. Triggering the store on every state change may wear out flash. Therefore, the models need to implement some postpone mechanism to reduce the flash wear out. The mesh stack has already implemented the mechanism of deferred store with its own settings. The models could use it instead of implementing their own mechanism. In combination with the mesh settings workqueue, the models can store their data without blocking the stack work. Signed-off-by: Pavel Vasilyev <pavel.vasilyev@nordicsemi.no>
102 lines
3.3 KiB
C
102 lines
3.3 KiB
C
/*
|
|
* Copyright (c) 2017 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/* Tree walk return codes */
|
|
enum bt_mesh_walk {
|
|
BT_MESH_WALK_STOP,
|
|
BT_MESH_WALK_CONTINUE,
|
|
};
|
|
|
|
/* bt_mesh_model.flags */
|
|
enum {
|
|
BT_MESH_MOD_BIND_PENDING = BIT(0),
|
|
BT_MESH_MOD_SUB_PENDING = BIT(1),
|
|
BT_MESH_MOD_PUB_PENDING = BIT(2),
|
|
BT_MESH_MOD_EXTENDED = BIT(3),
|
|
BT_MESH_MOD_DEVKEY_ONLY = BIT(4),
|
|
BT_MESH_MOD_DATA_PENDING = BIT(5),
|
|
};
|
|
|
|
void bt_mesh_elem_register(struct bt_mesh_elem *elem, uint8_t count);
|
|
|
|
uint8_t bt_mesh_elem_count(void);
|
|
size_t bt_mesh_comp_page_0_size(void);
|
|
int bt_mesh_comp_data_get_page_0(struct net_buf_simple *buf, size_t offset);
|
|
size_t bt_mesh_metadata_page_0_size(void);
|
|
int bt_mesh_metadata_get_page_0(struct net_buf_simple *buf, size_t offset);
|
|
int bt_mesh_comp_data_get_page_1(struct net_buf_simple *buf);
|
|
|
|
/* Find local element based on unicast address */
|
|
struct bt_mesh_elem *bt_mesh_elem_find(uint16_t addr);
|
|
|
|
bool bt_mesh_has_addr(uint16_t addr);
|
|
bool bt_mesh_model_has_key(struct bt_mesh_model *mod, uint16_t key);
|
|
|
|
void bt_mesh_model_extensions_walk(struct bt_mesh_model *root,
|
|
enum bt_mesh_walk (*cb)(struct bt_mesh_model *mod,
|
|
void *user_data),
|
|
void *user_data);
|
|
|
|
uint16_t *bt_mesh_model_find_group(struct bt_mesh_model **mod, uint16_t addr);
|
|
|
|
void bt_mesh_model_foreach(void (*func)(struct bt_mesh_model *mod,
|
|
struct bt_mesh_elem *elem,
|
|
bool vnd, bool primary,
|
|
void *user_data),
|
|
void *user_data);
|
|
|
|
int32_t bt_mesh_model_pub_period_get(struct bt_mesh_model *mod);
|
|
|
|
void bt_mesh_comp_provision(uint16_t addr);
|
|
void bt_mesh_comp_unprovision(void);
|
|
|
|
uint16_t bt_mesh_primary_addr(void);
|
|
|
|
const struct bt_mesh_comp *bt_mesh_comp_get(void);
|
|
|
|
struct bt_mesh_model *bt_mesh_model_get(bool vnd, uint8_t elem_idx, uint8_t mod_idx);
|
|
|
|
int bt_mesh_model_recv(struct bt_mesh_msg_ctx *ctx, struct net_buf_simple *buf);
|
|
|
|
int bt_mesh_comp_register(const struct bt_mesh_comp *comp);
|
|
int bt_mesh_comp_store(void);
|
|
int bt_mesh_comp_read(struct net_buf_simple *buf);
|
|
|
|
int bt_mesh_models_metadata_store(void);
|
|
int bt_mesh_models_metadata_read(struct net_buf_simple *buf, size_t offset);
|
|
|
|
void bt_mesh_comp_data_pending_clear(void);
|
|
void bt_mesh_comp_data_clear(void);
|
|
|
|
void bt_mesh_model_pending_store(void);
|
|
void bt_mesh_model_bind_store(struct bt_mesh_model *mod);
|
|
void bt_mesh_model_sub_store(struct bt_mesh_model *mod);
|
|
void bt_mesh_model_pub_store(struct bt_mesh_model *mod);
|
|
void bt_mesh_model_settings_commit(void);
|
|
|
|
/** @brief Register a callback function hook for mesh model messages.
|
|
*
|
|
* Register a callback function to act as a hook for receiving mesh model layer messages
|
|
* directly to the application without having instantiated the relevant models.
|
|
*
|
|
* @param cb A pointer to the callback function.
|
|
*/
|
|
void bt_mesh_msg_cb_set(void (*cb)(uint32_t opcode, struct bt_mesh_msg_ctx *ctx,
|
|
struct net_buf_simple *buf));
|
|
|
|
/** @brief Send a mesh model message.
|
|
*
|
|
* Send a mesh model layer message out into the mesh network without having instantiated
|
|
* the relevant mesh models.
|
|
*
|
|
* @param ctx The Bluetooth mesh message context.
|
|
* @param buf The message payload.
|
|
*
|
|
* @return 0 on success or negative error code on failure.
|
|
*/
|
|
int bt_mesh_access_send(struct bt_mesh_msg_ctx *ctx, struct net_buf_simple *buf, uint16_t src_addr,
|
|
const struct bt_mesh_send_cb *cb, void *cb_data);
|