mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-09-07 20:45:10 +00:00
dffcfd8c79
Patch adds option for progressive erase of firmware image. When using this, flash is erased as necessary when receiving new firmware, instead of erasing the whole image slot at once. This is useful on some hardware (like nRF52840) that has long erase times, to prevent long wait times at the beginning of the DFU process. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
70 lines
1.7 KiB
C
70 lines
1.7 KiB
C
/*
|
|
* Copyright (c) 2017 Nordic Semiconductor ASA
|
|
* Copyright (c) 2017 Linaro Limited
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef ZEPHYR_INCLUDE_DFU_FLASH_IMG_H_
|
|
#define ZEPHYR_INCLUDE_DFU_FLASH_IMG_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <flash_map.h>
|
|
|
|
struct flash_img_context {
|
|
u8_t buf[CONFIG_IMG_BLOCK_BUF_SIZE];
|
|
const struct flash_area *flash_area;
|
|
size_t bytes_written;
|
|
u16_t buf_bytes;
|
|
#ifdef CONFIG_IMG_ERASE_PROGRESSIVELY
|
|
off_t off_last;
|
|
#endif
|
|
};
|
|
|
|
/**
|
|
* @brief Initialize context needed for writing the image to the flash.
|
|
*
|
|
* @param ctx context to be initialized
|
|
*
|
|
* @return 0 on success, negative errno code on fail
|
|
*/
|
|
int flash_img_init(struct flash_img_context *ctx);
|
|
|
|
/**
|
|
* @brief Read number of bytes of the image written to the flash.
|
|
*
|
|
* @param ctx context
|
|
*
|
|
* @return Number of bytes written to the image flash.
|
|
*/
|
|
size_t flash_img_bytes_written(struct flash_img_context *ctx);
|
|
|
|
/**
|
|
* @brief Process input buffers to be written to the image slot 1. flash
|
|
* memory in single blocks. Will store remainder between calls.
|
|
*
|
|
* A final call to this function with flush set to true
|
|
* will write out the remaining block buffer to flash. Since flash is written to
|
|
* in blocks, the contents of flash from the last byte written up to the next
|
|
* multiple of CONFIG_IMG_BLOCK_BUF_SIZE is padded with 0xff.
|
|
*
|
|
* @param ctx context
|
|
* @param data data to write
|
|
* @param len Number of bytes to write
|
|
* @param flush when true this forces any buffered
|
|
* data to be written to flash
|
|
*
|
|
* @return 0 on success, negative errno code on fail
|
|
*/
|
|
int flash_img_buffered_write(struct flash_img_context *ctx, u8_t *data,
|
|
size_t len, bool flush);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ZEPHYR_INCLUDE_DFU_FLASH_IMG_H_ */
|