dfu_target_stream.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef DFU_TARGET_STREAM_H__
#define DFU_TARGET_STREAM_H__
 
#include <stddef.h>
#include <zephyr/storage/stream_flash.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct stream_flash_ctx *dfu_target_stream_get_stream(void);
 
struct dfu_target_stream_init {
        /* The identifier of the stream, used for storing settings.*/
        const char *id;
 
        /* Flash device that the stream should be written to. */
        const struct device *fdev;
 
        /* Buffer used for stream flash writing. The length of the
         * buffer must be smaller than a page size of `fdev`.
         */
        uint8_t *buf;
 
        /* Length of `buf` */
        size_t len;
 
        /* Offset within `fdev` to write the stream to. */
        size_t offset;
 
        /* The number of bytes within fdev to use for the stream.
         * Set to 0 to use all available memory in the device
         * (starting from `offset`).
         */
        size_t size;
 
        /* Callback invoked upon successful flash write operations. This
         * can be used to inspect the actual written data.
         */
        stream_flash_callback_t cb;
};
 
int dfu_target_stream_init(const struct dfu_target_stream_init *init);
 
int dfu_target_stream_offset_get(size_t *offset);
 
int dfu_target_stream_write(const uint8_t *buf, size_t len);
 
int dfu_target_stream_done(bool successful);
 
int dfu_target_stream_reset(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DFU_TARGET_STREAM_H__ */