blob_srv.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_MESH_BLOB_SRV_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_BLOB_SRV_H_
 
#include <zephyr/bluetooth/mesh/access.h>
#include <zephyr/bluetooth/mesh/blob.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct bt_mesh_blob_srv;
 
#if defined(CONFIG_BT_MESH_BLOB_SRV)
#define BT_MESH_BLOB_BLOCKS_MAX                                                \
        (DIV_ROUND_UP(CONFIG_BT_MESH_BLOB_SIZE_MAX,                        \
                          CONFIG_BT_MESH_BLOB_BLOCK_SIZE_MIN))
#else
#define BT_MESH_BLOB_BLOCKS_MAX 1
#endif
 
#define BT_MESH_MODEL_BLOB_SRV(_srv)                                           \
        BT_MESH_MODEL_CB(BT_MESH_MODEL_ID_BLOB_SRV, _bt_mesh_blob_srv_op,      \
                         NULL, _srv, &_bt_mesh_blob_srv_cb)
 
struct bt_mesh_blob_srv_cb {
        int (*start)(struct bt_mesh_blob_srv *srv, struct bt_mesh_msg_ctx *ctx,
                     struct bt_mesh_blob_xfer *xfer);
 
        void (*end)(struct bt_mesh_blob_srv *srv, uint64_t id, bool success);
 
        void (*suspended)(struct bt_mesh_blob_srv *srv);
 
        void (*resume)(struct bt_mesh_blob_srv *srv);
 
        int (*recover)(struct bt_mesh_blob_srv *srv,
                       struct bt_mesh_blob_xfer *xfer,
                       const struct bt_mesh_blob_io **io);
};
 
struct bt_mesh_blob_srv {
        const struct bt_mesh_blob_srv_cb *cb;
 
        /* Runtime state: */
        const struct bt_mesh_blob_io *io;
        struct k_work_delayable rx_timeout;
        struct bt_mesh_blob_block block;
        struct bt_mesh_model *mod;
        enum bt_mesh_blob_xfer_phase phase;
 
        struct bt_mesh_blob_srv_state {
                struct bt_mesh_blob_xfer xfer;
                uint16_t cli;
                uint16_t app_idx;
                uint16_t timeout_base;
                uint16_t mtu_size;
                uint8_t ttl;
 
                /* Bitfield of pending blocks. */
                ATOMIC_DEFINE(blocks, BT_MESH_BLOB_BLOCKS_MAX);
        } state;
 
        /* Pull mode (Pull BLOB Transfer Mode) behavior. */
        struct {
                uint16_t chunk_idx;
                struct k_work_delayable report;
        } pull;
};
 
int bt_mesh_blob_srv_recv(struct bt_mesh_blob_srv *srv, uint64_t id,
                          const struct bt_mesh_blob_io *io, uint8_t ttl,
                          uint16_t timeout_base);
 
int bt_mesh_blob_srv_cancel(struct bt_mesh_blob_srv *srv);
 
bool bt_mesh_blob_srv_is_busy(const struct bt_mesh_blob_srv *srv);
 
uint8_t bt_mesh_blob_srv_progress(const struct bt_mesh_blob_srv *srv);
 
extern const struct bt_mesh_model_op _bt_mesh_blob_srv_op[];
extern const struct bt_mesh_model_cb _bt_mesh_blob_srv_cb;
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_MESH_BLOB_SRV_H_ */