blob.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_H__
#define ZEPHYR_INCLUDE_BLUETOOTH_MESH_BLOB_H__
 
#include <sys/types.h>
 
#include <zephyr/kernel.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef CONFIG_BT_MESH_BLOB_CHUNK_COUNT_MAX
#define CONFIG_BT_MESH_BLOB_CHUNK_COUNT_MAX 0
#endif
 
enum bt_mesh_blob_xfer_mode {
        BT_MESH_BLOB_XFER_MODE_NONE,
        BT_MESH_BLOB_XFER_MODE_PUSH,
        BT_MESH_BLOB_XFER_MODE_PULL,
        BT_MESH_BLOB_XFER_MODE_ALL,
};
 
enum bt_mesh_blob_xfer_phase {
        BT_MESH_BLOB_XFER_PHASE_INACTIVE,
        BT_MESH_BLOB_XFER_PHASE_WAITING_FOR_START,
        BT_MESH_BLOB_XFER_PHASE_WAITING_FOR_BLOCK,
        BT_MESH_BLOB_XFER_PHASE_WAITING_FOR_CHUNK,
        BT_MESH_BLOB_XFER_PHASE_COMPLETE,
        BT_MESH_BLOB_XFER_PHASE_SUSPENDED,
};
 
enum bt_mesh_blob_status {
        BT_MESH_BLOB_SUCCESS,
        BT_MESH_BLOB_ERR_INVALID_BLOCK_NUM,
        BT_MESH_BLOB_ERR_INVALID_BLOCK_SIZE,
        BT_MESH_BLOB_ERR_INVALID_CHUNK_SIZE,
        BT_MESH_BLOB_ERR_WRONG_PHASE,
        BT_MESH_BLOB_ERR_INVALID_PARAM,
        BT_MESH_BLOB_ERR_WRONG_BLOB_ID,
        BT_MESH_BLOB_ERR_BLOB_TOO_LARGE,
        BT_MESH_BLOB_ERR_UNSUPPORTED_MODE,
        BT_MESH_BLOB_ERR_INTERNAL,
        BT_MESH_BLOB_ERR_INFO_UNAVAILABLE,
};
 
struct bt_mesh_blob_block {
        size_t size;
        off_t offset;
        uint16_t number;
        uint16_t chunk_count;
        uint8_t missing[DIV_ROUND_UP(CONFIG_BT_MESH_BLOB_CHUNK_COUNT_MAX,
                                         8)];
};
 
struct bt_mesh_blob_chunk {
        off_t offset;
        size_t size;
        uint8_t *data;
};
 
struct bt_mesh_blob_xfer {
        uint64_t id;
        size_t size;
        enum bt_mesh_blob_xfer_mode mode;
        /* Logarithmic representation of the block size. */
        uint8_t block_size_log;
        uint16_t chunk_size;
};
 
enum bt_mesh_blob_io_mode {
        BT_MESH_BLOB_READ,
        BT_MESH_BLOB_WRITE,
};
 
struct bt_mesh_blob_io {
        int (*open)(const struct bt_mesh_blob_io *io,
                    const struct bt_mesh_blob_xfer *xfer,
                    enum bt_mesh_blob_io_mode mode);
 
        void (*close)(const struct bt_mesh_blob_io *io,
                      const struct bt_mesh_blob_xfer *xfer);
 
        int (*block_start)(const struct bt_mesh_blob_io *io,
                           const struct bt_mesh_blob_xfer *xfer,
                           const struct bt_mesh_blob_block *block);
 
        void (*block_end)(const struct bt_mesh_blob_io *io,
                          const struct bt_mesh_blob_xfer *xfer,
                          const struct bt_mesh_blob_block *block);
 
        int (*wr)(const struct bt_mesh_blob_io *io,
                  const struct bt_mesh_blob_xfer *xfer,
                  const struct bt_mesh_blob_block *block,
                  const struct bt_mesh_blob_chunk *chunk);
 
        int (*rd)(const struct bt_mesh_blob_io *io,
                  const struct bt_mesh_blob_xfer *xfer,
                  const struct bt_mesh_blob_block *block,
                  const struct bt_mesh_blob_chunk *chunk);
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_MESH_BLOB_H__ */