stream_flash.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017, 2020 Nordic Semiconductor ASA
 * Copyright (c) 2017 Linaro Limited
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_STORAGE_STREAM_FLASH_H_
#define ZEPHYR_INCLUDE_STORAGE_STREAM_FLASH_H_

 
#include <stdbool.h>
#include <zephyr/drivers/flash.h>
 
#ifdef __cplusplus
extern "C" {
#endif

typedef int (*stream_flash_callback_t)(uint8_t *buf, size_t len, size_t offset);

struct stream_flash_ctx {
        uint8_t *buf; /* Write buffer */
        size_t buf_len; /* Length of write buffer */
        size_t buf_bytes; /* Number of bytes currently stored in write buf */
        const struct device *fdev; /* Flash device */
        size_t bytes_written; /* Number of bytes written to flash */
        size_t offset; /* Offset from base of flash device to write area */
        size_t available; /* Available bytes in write area */
#ifdef CONFIG_STREAM_FLASH_POST_WRITE_CALLBACK
        stream_flash_callback_t callback; /* Callback invoked after write op */
#endif
#ifdef CONFIG_STREAM_FLASH_ERASE
        size_t erased_up_to;            /* First offset in continuous range,
                                         * relative to the stream_flash_ctx.offset,
                                         * that has not yet been erased while
                                         * preparing Stream Flash designated area
                                         * for write.
                                         */
#endif
        size_t write_block_size;        /* Offset/size device write alignment */
        uint8_t erase_value;
};

int stream_flash_init(struct stream_flash_ctx *ctx, const struct device *fdev,
                      uint8_t *buf, size_t buf_len, size_t offset, size_t size,
                      stream_flash_callback_t cb);
size_t stream_flash_bytes_written(const struct stream_flash_ctx *ctx);

size_t stream_flash_bytes_buffered(const struct stream_flash_ctx *ctx);

int stream_flash_buffered_write(struct stream_flash_ctx *ctx, const uint8_t *data,
                                size_t len, bool flush);

__deprecated int stream_flash_erase_page(struct stream_flash_ctx *ctx, off_t off);

int stream_flash_progress_load(struct stream_flash_ctx *ctx,
                               const char *settings_key);

int stream_flash_progress_save(const struct stream_flash_ctx *ctx,
                               const char *settings_key);

int stream_flash_progress_clear(const struct stream_flash_ctx *ctx,
                                const char *settings_key);
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_STORAGE_STREAM_FLASH_H_ */