dfu.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_H__
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_DFU_H__
 
#include <sys/types.h>
 
#include <zephyr/kernel.h>
#include <zephyr/bluetooth/mesh/blob.h>
 
#ifdef __cplusplus
extern "C" {
#endif

 
#ifndef CONFIG_BT_MESH_DFU_FWID_MAXLEN
#define CONFIG_BT_MESH_DFU_FWID_MAXLEN 0
#endif
 
#ifndef CONFIG_BT_MESH_DFU_METADATA_MAXLEN
#define CONFIG_BT_MESH_DFU_METADATA_MAXLEN 0
#endif
 
#ifndef CONFIG_BT_MESH_DFU_URI_MAXLEN
#define CONFIG_BT_MESH_DFU_URI_MAXLEN 0
#endif
 
#ifndef CONFIG_BT_MESH_DFU_SLOT_CNT
#define CONFIG_BT_MESH_DFU_SLOT_CNT 0
#endif

enum bt_mesh_dfu_phase {
        BT_MESH_DFU_PHASE_IDLE,

        BT_MESH_DFU_PHASE_TRANSFER_ERR,

        BT_MESH_DFU_PHASE_TRANSFER_ACTIVE,

        BT_MESH_DFU_PHASE_VERIFY,

        BT_MESH_DFU_PHASE_VERIFY_OK,

        BT_MESH_DFU_PHASE_VERIFY_FAIL,

        BT_MESH_DFU_PHASE_APPLYING,

        BT_MESH_DFU_PHASE_TRANSFER_CANCELED,

        BT_MESH_DFU_PHASE_APPLY_SUCCESS,

        BT_MESH_DFU_PHASE_APPLY_FAIL,

        BT_MESH_DFU_PHASE_UNKNOWN,
};
 

enum bt_mesh_dfu_status {
        BT_MESH_DFU_SUCCESS,

        BT_MESH_DFU_ERR_RESOURCES,

        BT_MESH_DFU_ERR_WRONG_PHASE,

        BT_MESH_DFU_ERR_INTERNAL,

        BT_MESH_DFU_ERR_FW_IDX,

        BT_MESH_DFU_ERR_METADATA,

        BT_MESH_DFU_ERR_TEMPORARILY_UNAVAILABLE,

        BT_MESH_DFU_ERR_BLOB_XFER_BUSY,
};

enum bt_mesh_dfu_effect {
        BT_MESH_DFU_EFFECT_NONE,

        BT_MESH_DFU_EFFECT_COMP_CHANGE_NO_RPR,

        BT_MESH_DFU_EFFECT_COMP_CHANGE,

        BT_MESH_DFU_EFFECT_UNPROV,
};

enum bt_mesh_dfu_iter {
        BT_MESH_DFU_ITER_STOP,

        BT_MESH_DFU_ITER_CONTINUE,
};

struct bt_mesh_dfu_img {
        const void *fwid;

        size_t fwid_len;

        const char *uri;
};

struct bt_mesh_dfu_slot {
        size_t size;
        size_t fwid_len;
        size_t metadata_len;
        uint8_t fwid[CONFIG_BT_MESH_DFU_FWID_MAXLEN];
        uint8_t metadata[CONFIG_BT_MESH_DFU_METADATA_MAXLEN];
};

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_MESH_DFU_H__ */