dfu_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_DFU_SRV_H__
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_DFU_SRV_H__
 
#include <zephyr/bluetooth/mesh/dfu.h>
#include <zephyr/bluetooth/mesh/blob_srv.h>
#include <zephyr/bluetooth/mesh/access.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct bt_mesh_dfu_srv;
 
#define BT_MESH_DFU_SRV_INIT(_handlers, _imgs, _img_count)                     \
        {                                                                      \
                .blob = { .cb = &_bt_mesh_dfu_srv_blob_cb }, .cb = _handlers,  \
                .imgs = _imgs, .img_count = _img_count,                        \
        }
 
#define BT_MESH_MODEL_DFU_SRV(_srv)                                            \
        BT_MESH_MODEL_BLOB_SRV(&(_srv)->blob),                                  \
        BT_MESH_MODEL_CB(BT_MESH_MODEL_ID_DFU_SRV, _bt_mesh_dfu_srv_op, NULL,  \
                         _srv, &_bt_mesh_dfu_srv_cb)
 
struct bt_mesh_dfu_srv_cb {
        int (*check)(struct bt_mesh_dfu_srv *srv,
                     const struct bt_mesh_dfu_img *img,
                     struct net_buf_simple *metadata,
                     enum bt_mesh_dfu_effect *effect);
 
        int (*start)(struct bt_mesh_dfu_srv *srv,
                     const struct bt_mesh_dfu_img *img,
                     struct net_buf_simple *metadata,
                     const struct bt_mesh_blob_io **io);
 
        void (*end)(struct bt_mesh_dfu_srv *srv,
                    const struct bt_mesh_dfu_img *img, bool success);
 
        int (*recover)(struct bt_mesh_dfu_srv *srv,
                       const struct bt_mesh_dfu_img *img,
                       const struct bt_mesh_blob_io **io);
 
        int (*apply)(struct bt_mesh_dfu_srv *srv,
                     const struct bt_mesh_dfu_img *img);
};
 
struct bt_mesh_dfu_srv {
        struct bt_mesh_blob_srv blob;
        const struct bt_mesh_dfu_srv_cb *cb;
        const struct bt_mesh_dfu_img *imgs;
        size_t img_count;
 
        /* Runtime state */
        struct bt_mesh_model *mod;
        struct {
                /* Effect of transfer, @see bt_mesh_dfu_effect. */
                uint8_t effect;
                /* Current phase, @see bt_mesh_dfu_phase. */
                uint8_t phase;
                uint8_t ttl;
                uint8_t idx;
                uint16_t timeout_base;
                uint16_t meta;
        } update;
};
 
void bt_mesh_dfu_srv_verified(struct bt_mesh_dfu_srv *srv);
 
void bt_mesh_dfu_srv_rejected(struct bt_mesh_dfu_srv *srv);
 
void bt_mesh_dfu_srv_cancel(struct bt_mesh_dfu_srv *srv);
 
void bt_mesh_dfu_srv_applied(struct bt_mesh_dfu_srv *srv);
 
bool bt_mesh_dfu_srv_is_busy(const struct bt_mesh_dfu_srv *srv);
 
uint8_t bt_mesh_dfu_srv_progress(const struct bt_mesh_dfu_srv *srv);
 
extern const struct bt_mesh_model_op _bt_mesh_dfu_srv_op[];
extern const struct bt_mesh_model_cb _bt_mesh_dfu_srv_cb;
extern const struct bt_mesh_blob_srv_cb _bt_mesh_dfu_srv_blob_cb;
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_MESH_DFU_SRV_H__ */