cfg_cli.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2017 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_MESH_CFG_CLI_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_CFG_CLI_H_
 
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct bt_mesh_cfg_cli;
struct bt_mesh_cfg_cli_hb_pub;
struct bt_mesh_cfg_cli_hb_sub;
struct bt_mesh_cfg_cli_mod_pub;
 
struct bt_mesh_cfg_cli_cb {
 
        void (*comp_data)(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t page,
                          struct net_buf_simple *buf);
 
        void (*mod_pub_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status,
                               uint16_t elem_addr, uint16_t mod_id, uint16_t cid,
                               struct bt_mesh_cfg_cli_mod_pub *pub);
 
        void (*mod_sub_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                             uint8_t status, uint16_t elem_addr,
                             uint16_t sub_addr, uint32_t mod_id);
 
        void (*mod_sub_list)(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status,
                             uint16_t elem_addr, uint16_t mod_id, uint16_t cid,
                             struct net_buf_simple *buf);
 
        void (*node_reset_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr);
 
        void (*beacon_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                                uint8_t status);
 
        void (*ttl_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                           uint8_t status);
 
        void (*friend_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                              uint8_t status);
 
        void (*gatt_proxy_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                                  uint8_t status);
 
        void (*network_transmit_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                                        uint8_t status);
 
        void (*relay_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                             uint8_t status, uint8_t transmit);
 
        void (*net_key_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                               uint8_t status, uint16_t net_idx);
 
        void (*net_key_list)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                             struct net_buf_simple *buf);
 
        void (*app_key_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                               uint8_t status, uint16_t net_idx,
                               uint16_t app_idx);
 
        void (*app_key_list)(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status,
                             uint16_t net_idx, struct net_buf_simple *buf);
 
        void (*mod_app_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                               uint8_t status, uint16_t elem_addr,
                               uint16_t app_idx, uint32_t mod_id);
 
        void (*mod_app_list)(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status,
                             uint16_t elem_addr, uint16_t mod_id, uint16_t cid,
                             struct net_buf_simple *buf);
 
        void (*node_identity_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                                     uint8_t status, uint16_t net_idx,
                                     uint8_t identity);
 
        void (*lpn_timeout_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr,
                                   uint16_t elem_addr, uint32_t timeout);
 
        void (*krp_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status,
                           uint16_t net_idx, uint8_t phase);
 
        void (*hb_pub_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status,
                              struct bt_mesh_cfg_cli_hb_pub *pub);
 
        void (*hb_sub_status)(struct bt_mesh_cfg_cli *cli, uint16_t addr, uint8_t status,
                              struct bt_mesh_cfg_cli_hb_sub *sub);
};
 
struct bt_mesh_cfg_cli {
        const struct bt_mesh_model *model;
 
        const struct bt_mesh_cfg_cli_cb *cb;
 
        /* Internal parameters for tracking message responses. */
        struct bt_mesh_msg_ack_ctx ack_ctx;
};
 
#define BT_MESH_MODEL_CFG_CLI(cli_data)                 \
        BT_MESH_MODEL_CNT_CB(BT_MESH_MODEL_ID_CFG_CLI,  \
                             bt_mesh_cfg_cli_op, NULL,  \
                             cli_data, 1, 0, &bt_mesh_cfg_cli_cb)
 
#define BT_MESH_PUB_PERIOD_100MS(steps)  ((steps) & BIT_MASK(6))
 
#define BT_MESH_PUB_PERIOD_SEC(steps)   (((steps) & BIT_MASK(6)) | (1 << 6))
 
#define BT_MESH_PUB_PERIOD_10SEC(steps) (((steps) & BIT_MASK(6)) | (2 << 6))
 
#define BT_MESH_PUB_PERIOD_10MIN(steps) (((steps) & BIT_MASK(6)) | (3 << 6))
 
struct bt_mesh_cfg_cli_mod_pub {
        uint16_t addr;
        const uint8_t *uuid;
        uint16_t  app_idx;
        bool   cred_flag;
        uint8_t   ttl;
        uint8_t   period;
        uint8_t   transmit;
};
 
struct bt_mesh_cfg_cli_hb_sub {
        uint16_t src;
        uint16_t dst;
        uint8_t  period;
        uint8_t  count;
        uint8_t  min;
        uint8_t  max;
};
 
struct bt_mesh_cfg_cli_hb_pub {
        uint16_t dst;
        uint8_t  count;
        uint8_t  period;
        uint8_t  ttl;
        uint16_t feat;
        uint16_t net_idx;
};
 
int bt_mesh_cfg_cli_node_reset(uint16_t net_idx, uint16_t addr, bool *status);
 
int bt_mesh_cfg_cli_comp_data_get(uint16_t net_idx, uint16_t addr, uint8_t page, uint8_t *rsp,
                                  struct net_buf_simple *comp);
 
int bt_mesh_cfg_cli_beacon_get(uint16_t net_idx, uint16_t addr, uint8_t *status);
 
int bt_mesh_cfg_cli_krp_get(uint16_t net_idx, uint16_t addr, uint16_t key_net_idx, uint8_t *status,
                            uint8_t *phase);
 
int bt_mesh_cfg_cli_krp_set(uint16_t net_idx, uint16_t addr, uint16_t key_net_idx,
                            uint8_t transition, uint8_t *status, uint8_t *phase);
 
int bt_mesh_cfg_cli_beacon_set(uint16_t net_idx, uint16_t addr, uint8_t val, uint8_t *status);
 
int bt_mesh_cfg_cli_ttl_get(uint16_t net_idx, uint16_t addr, uint8_t *ttl);
 
int bt_mesh_cfg_cli_ttl_set(uint16_t net_idx, uint16_t addr, uint8_t val, uint8_t *ttl);
 
int bt_mesh_cfg_cli_friend_get(uint16_t net_idx, uint16_t addr, uint8_t *status);
 
int bt_mesh_cfg_cli_friend_set(uint16_t net_idx, uint16_t addr, uint8_t val, uint8_t *status);
 
int bt_mesh_cfg_cli_gatt_proxy_get(uint16_t net_idx, uint16_t addr, uint8_t *status);
 
int bt_mesh_cfg_cli_gatt_proxy_set(uint16_t net_idx, uint16_t addr, uint8_t val, uint8_t *status);
 
int bt_mesh_cfg_cli_net_transmit_get(uint16_t net_idx, uint16_t addr, uint8_t *transmit);
 
int bt_mesh_cfg_cli_net_transmit_set(uint16_t net_idx, uint16_t addr, uint8_t val,
                                     uint8_t *transmit);
 
int bt_mesh_cfg_cli_relay_get(uint16_t net_idx, uint16_t addr, uint8_t *status, uint8_t *transmit);
 
int bt_mesh_cfg_cli_relay_set(uint16_t net_idx, uint16_t addr, uint8_t new_relay,
                              uint8_t new_transmit, uint8_t *status, uint8_t *transmit);
 
int bt_mesh_cfg_cli_net_key_add(uint16_t net_idx, uint16_t addr, uint16_t key_net_idx,
                                const uint8_t net_key[16], uint8_t *status);
 
int bt_mesh_cfg_cli_net_key_get(uint16_t net_idx, uint16_t addr, uint16_t *keys, size_t *key_cnt);
 
int bt_mesh_cfg_cli_net_key_del(uint16_t net_idx, uint16_t addr, uint16_t key_net_idx,
                                uint8_t *status);
 
int bt_mesh_cfg_cli_app_key_add(uint16_t net_idx, uint16_t addr, uint16_t key_net_idx,
                                uint16_t key_app_idx, const uint8_t app_key[16], uint8_t *status);
 
int bt_mesh_cfg_cli_app_key_get(uint16_t net_idx, uint16_t addr, uint16_t key_net_idx,
                                uint8_t *status, uint16_t *keys, size_t *key_cnt);
 
int bt_mesh_cfg_cli_app_key_del(uint16_t net_idx, uint16_t addr, uint16_t key_net_idx,
                                uint16_t key_app_idx, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_app_bind(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                 uint16_t mod_app_idx, uint16_t mod_id, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_app_unbind(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                   uint16_t mod_app_idx, uint16_t mod_id, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_app_bind_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                     uint16_t mod_app_idx, uint16_t mod_id, uint16_t cid,
                                     uint8_t *status);
 
int bt_mesh_cfg_cli_mod_app_unbind_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                       uint16_t mod_app_idx, uint16_t mod_id, uint16_t cid,
                                       uint8_t *status);
 
int bt_mesh_cfg_cli_mod_app_get(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                uint16_t mod_id, uint8_t *status, uint16_t *apps, size_t *app_cnt);
 
int bt_mesh_cfg_cli_mod_app_get_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                    uint16_t mod_id, uint16_t cid, uint8_t *status, uint16_t *apps,
                                    size_t *app_cnt);
 
int bt_mesh_cfg_cli_mod_pub_get(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                uint16_t mod_id, struct bt_mesh_cfg_cli_mod_pub *pub,
                                uint8_t *status);
 
int bt_mesh_cfg_cli_mod_pub_get_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                    uint16_t mod_id, uint16_t cid,
                                    struct bt_mesh_cfg_cli_mod_pub *pub, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_pub_set(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                uint16_t mod_id, struct bt_mesh_cfg_cli_mod_pub *pub,
                                uint8_t *status);
 
int bt_mesh_cfg_cli_mod_pub_set_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                    uint16_t mod_id, uint16_t cid,
                                    struct bt_mesh_cfg_cli_mod_pub *pub, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_add(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                uint16_t sub_addr, uint16_t mod_id, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_add_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                    uint16_t sub_addr, uint16_t mod_id, uint16_t cid,
                                    uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_del(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                uint16_t sub_addr, uint16_t mod_id, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_del_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                    uint16_t sub_addr, uint16_t mod_id, uint16_t cid,
                                    uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_overwrite(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                      uint16_t sub_addr, uint16_t mod_id, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_overwrite_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                          uint16_t sub_addr, uint16_t mod_id, uint16_t cid,
                                          uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_va_add(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                   const uint8_t label[16], uint16_t mod_id, uint16_t *virt_addr,
                                   uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_va_add_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                       const uint8_t label[16], uint16_t mod_id, uint16_t cid,
                                       uint16_t *virt_addr, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_va_del(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                   const uint8_t label[16], uint16_t mod_id, uint16_t *virt_addr,
                                   uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_va_del_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                       const uint8_t label[16], uint16_t mod_id, uint16_t cid,
                                       uint16_t *virt_addr, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_va_overwrite(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                         const uint8_t label[16], uint16_t mod_id,
                                         uint16_t *virt_addr, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_va_overwrite_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                             const uint8_t label[16], uint16_t mod_id, uint16_t cid,
                                             uint16_t *virt_addr, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_get(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                uint16_t mod_id, uint8_t *status, uint16_t *subs, size_t *sub_cnt);
 
int bt_mesh_cfg_cli_mod_sub_get_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                    uint16_t mod_id, uint16_t cid, uint8_t *status, uint16_t *subs,
                                    size_t *sub_cnt);
 
int bt_mesh_cfg_cli_hb_sub_set(uint16_t net_idx, uint16_t addr, struct bt_mesh_cfg_cli_hb_sub *sub,
                               uint8_t *status);
 
int bt_mesh_cfg_cli_hb_sub_get(uint16_t net_idx, uint16_t addr, struct bt_mesh_cfg_cli_hb_sub *sub,
                               uint8_t *status);
 
int bt_mesh_cfg_cli_hb_pub_set(uint16_t net_idx, uint16_t addr,
                               const struct bt_mesh_cfg_cli_hb_pub *pub, uint8_t *status);
 
int bt_mesh_cfg_cli_hb_pub_get(uint16_t net_idx, uint16_t addr, struct bt_mesh_cfg_cli_hb_pub *pub,
                               uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_del_all(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                    uint16_t mod_id, uint8_t *status);
 
int bt_mesh_cfg_cli_mod_sub_del_all_vnd(uint16_t net_idx, uint16_t addr, uint16_t elem_addr,
                                        uint16_t mod_id, uint16_t cid, uint8_t *status);
 
int bt_mesh_cfg_cli_net_key_update(uint16_t net_idx, uint16_t addr, uint16_t key_net_idx,
                                   const uint8_t net_key[16], uint8_t *status);
 
int bt_mesh_cfg_cli_app_key_update(uint16_t net_idx, uint16_t addr, uint16_t key_net_idx,
                                   uint16_t key_app_idx, const uint8_t app_key[16],
                                   uint8_t *status);
 
int bt_mesh_cfg_cli_node_identity_set(uint16_t net_idx, uint16_t addr, uint16_t key_net_idx,
                                      uint8_t new_identity, uint8_t *status, uint8_t *identity);
 
int bt_mesh_cfg_cli_node_identity_get(uint16_t net_idx, uint16_t addr, uint16_t key_net_idx,
                                      uint8_t *status, uint8_t *identity);
 
int bt_mesh_cfg_cli_lpn_timeout_get(uint16_t net_idx, uint16_t addr, uint16_t unicast_addr,
                                    int32_t *polltimeout);
 
int32_t bt_mesh_cfg_cli_timeout_get(void);
 
void bt_mesh_cfg_cli_timeout_set(int32_t timeout);
 
struct bt_mesh_comp_p0 {
        uint16_t cid;
        uint16_t pid;
        uint16_t vid;
        uint16_t crpl;
        uint16_t feat;
 
        struct net_buf_simple *_buf;
};
 
struct bt_mesh_comp_p0_elem {
        uint16_t loc;
        size_t nsig;
        size_t nvnd;
 
        uint8_t *_buf;
};
 
int bt_mesh_comp_p0_get(struct bt_mesh_comp_p0 *comp,
                        struct net_buf_simple *buf);
 
struct bt_mesh_comp_p0_elem *bt_mesh_comp_p0_elem_pull(const struct bt_mesh_comp_p0 *comp,
                                                       struct bt_mesh_comp_p0_elem *elem);
 
uint16_t bt_mesh_comp_p0_elem_mod(struct bt_mesh_comp_p0_elem *elem, int idx);
 
struct bt_mesh_mod_id_vnd bt_mesh_comp_p0_elem_mod_vnd(struct bt_mesh_comp_p0_elem *elem, int idx);
 
struct bt_mesh_comp_p1_elem {
        size_t nsig;
        size_t nvnd;
        struct net_buf_simple *_buf;
};
 
struct bt_mesh_comp_p1_model_item {
        bool cor_present;
        bool format;
        uint8_t ext_item_cnt : 6;
        uint8_t cor_id;
        struct net_buf_simple *_buf;
};
 
struct bt_mesh_comp_p1_item_short {
        uint8_t elem_offset : 3;
        uint8_t mod_item_idx : 5;
};
 
struct bt_mesh_comp_p1_item_long {
        uint8_t elem_offset;
        uint8_t mod_item_idx;
};
 
struct bt_mesh_comp_p1_ext_item {
        enum { SHORT, LONG } type;
 
        union {
                struct bt_mesh_comp_p1_item_short short_item;
                struct bt_mesh_comp_p1_item_long long_item;
        };
};
 
struct bt_mesh_comp_p1_elem *bt_mesh_comp_p1_elem_pull(
        struct net_buf_simple *buf, struct bt_mesh_comp_p1_elem *elem);
 
struct bt_mesh_comp_p1_model_item *bt_mesh_comp_p1_item_pull(
        struct bt_mesh_comp_p1_elem *elem, struct bt_mesh_comp_p1_model_item *item);
 
struct bt_mesh_comp_p1_ext_item *bt_mesh_comp_p1_pull_ext_item(
        struct bt_mesh_comp_p1_model_item *item, struct bt_mesh_comp_p1_ext_item *ext_item);
 
struct bt_mesh_comp_p2_record {
        uint16_t id;
        struct {
                uint8_t x;
                uint8_t y;
                uint8_t z;
        } version;
        struct net_buf_simple *elem_buf;
        struct net_buf_simple *data_buf;
};
 
struct bt_mesh_comp_p2_record *bt_mesh_comp_p2_record_pull(struct net_buf_simple *buf,
                                                           struct bt_mesh_comp_p2_record *record);
 
int bt_mesh_key_idx_unpack_list(struct net_buf_simple *buf, uint16_t *dst_arr, size_t *dst_cnt);
 
extern const struct bt_mesh_model_op bt_mesh_cfg_cli_op[];
extern const struct bt_mesh_model_cb bt_mesh_cfg_cli_cb;
#ifdef __cplusplus
}
#endif
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_MESH_CFG_CLI_H_ */