The latest development version of this page may be more current than this released 3.7.0 version.

BLOB Flash

The BLOB Flash Readers and Writers implement BLOB reading to and writing from flash partitions defined in the flash map.

BLOB Flash Reader

The BLOB Flash Reader interacts with the BLOB Transfer Client to read BLOB data directly from flash. It must be initialized by calling bt_mesh_blob_flash_rd_init() before being passed to the BLOB Transfer Client. Each BLOB Flash Reader only supports one transfer at the time.

BLOB Flash Writer

The BLOB Flash Writer interacts with the BLOB Transfer Server to write BLOB data directly to flash. It must be initialized by calling bt_mesh_blob_flash_rd_init() before being passed to the BLOB Transfer Server. Each BLOB Flash Writer only supports one transfer at the time, and requires a block size that is a multiple of the flash page size. If a transfer is started with a block size lower than the flash page size, the transfer will be rejected.

The BLOB Flash Writer copies chunk data into a buffer to accommodate chunks that are unaligned with the flash write block size. The buffer data is padded with 0xff if either the start or length of the chunk is unaligned.

API Reference

group bt_mesh_blob_io_flash

Functions

int bt_mesh_blob_io_flash_init(struct bt_mesh_blob_io_flash *flash, uint8_t area_id, off_t offset)

Initialize a flash stream.

Parameters:
  • flash – Flash stream.

  • area_id – Flash partition identifier. See flash_area_open.

  • offset – Offset into the flash area, in bytes.

Returns:

0 on success or (negative) error code otherwise.

struct bt_mesh_blob_io_flash
#include <blob_io_flash.h>

BLOB flash stream.

Public Members

uint8_t area_id

Flash area ID to write the BLOB to.

enum bt_mesh_blob_io_mode mode

Active stream mode.

off_t offset

Offset into the flash area to place the BLOB at (in bytes).