msg.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_MESH_MSG_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_MSG_H_
 
#include <zephyr/kernel.h>
#include <zephyr/net_buf.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct bt_mesh_model;
 
#define BT_MESH_MIC_SHORT 4
#define BT_MESH_MIC_LONG 8
 
#define BT_MESH_MODEL_OP_LEN(_op) ((_op) <= 0xff ? 1 : (_op) <= 0xffff ? 2 : 3)
 
#define BT_MESH_MODEL_BUF_LEN(_op, _payload_len)                               \
        (BT_MESH_MODEL_OP_LEN(_op) + (_payload_len) + BT_MESH_MIC_SHORT)
 
#define BT_MESH_MODEL_BUF_LEN_LONG_MIC(_op, _payload_len)                      \
        (BT_MESH_MODEL_OP_LEN(_op) + (_payload_len) + BT_MESH_MIC_LONG)
 
#define BT_MESH_MODEL_BUF_DEFINE(_buf, _op, _payload_len)                      \
        NET_BUF_SIMPLE_DEFINE(_buf, BT_MESH_MODEL_BUF_LEN(_op, (_payload_len)))
 
struct bt_mesh_msg_ctx {
        uint16_t net_idx;
 
        uint16_t app_idx;
 
        uint16_t addr;
 
        uint16_t recv_dst;
 
        const uint8_t *uuid;
 
        int8_t  recv_rssi;
 
        uint8_t  recv_ttl;
 
        bool  send_rel;
 
        bool  rnd_delay;
 
        uint8_t  send_ttl;
};
 
#define BT_MESH_MSG_CTX_INIT(net_key_idx, app_key_idx, dst, ttl) \
        { \
                .net_idx = (net_key_idx), \
                .app_idx = (app_key_idx), \
                .addr = (dst), \
                .send_ttl = (ttl), \
        }
 
#define BT_MESH_MSG_CTX_INIT_APP(app_key_idx, dst) \
        BT_MESH_MSG_CTX_INIT(0, app_key_idx, dst, BT_MESH_TTL_DEFAULT)
 
#define BT_MESH_MSG_CTX_INIT_DEV(net_key_idx, dst) \
        BT_MESH_MSG_CTX_INIT(net_key_idx, BT_MESH_KEY_DEV_REMOTE, dst, BT_MESH_TTL_DEFAULT)
 
#define BT_MESH_MSG_CTX_INIT_PUB(pub) \
        { \
                .app_idx = (pub)->key, \
                .addr = (pub)->addr, \
                .send_ttl = (pub)->ttl, \
                .uuid = (pub)->uuid, \
        }
 
void bt_mesh_model_msg_init(struct net_buf_simple *msg, uint32_t opcode);
 
struct bt_mesh_msg_ack_ctx {
        struct k_sem          sem;       
        uint32_t              op;        
        uint16_t              dst;       
        void                 *user_data; 
};
 
static inline void bt_mesh_msg_ack_ctx_init(struct bt_mesh_msg_ack_ctx *ack)
{
        k_sem_init(&ack->sem, 0, 1);
}
 
static inline void bt_mesh_msg_ack_ctx_reset(struct bt_mesh_msg_ack_ctx *ack)
{
        k_sem_reset(&ack->sem);
}
 
void bt_mesh_msg_ack_ctx_clear(struct bt_mesh_msg_ack_ctx *ack);
 
int bt_mesh_msg_ack_ctx_prepare(struct bt_mesh_msg_ack_ctx *ack,
                                uint32_t op, uint16_t dst, void *user_data);
 
static inline bool bt_mesh_msg_ack_ctx_busy(struct bt_mesh_msg_ack_ctx *ack)
{
        return (ack->op != 0);
}
 
int bt_mesh_msg_ack_ctx_wait(struct bt_mesh_msg_ack_ctx *ack, k_timeout_t timeout);
 
static inline void bt_mesh_msg_ack_ctx_rx(struct bt_mesh_msg_ack_ctx *ack)
{
        k_sem_give(&ack->sem);
}
 
bool bt_mesh_msg_ack_ctx_match(const struct bt_mesh_msg_ack_ctx *ack,
                               uint32_t op, uint16_t addr, void **user_data);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_MESH_MSG_H_ */