Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/known-warnings.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Each line should contain the regular expression of a known Sphinx warning
# that should be filtered out
.*Duplicate C declaration.*\n.*'\.\. c:.*:: dma_config'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: flash_img_check'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: zsock_fd_set'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: net_if_mcast_monitor'.*
.*Duplicate C declaration.*\n.*'\.\. c:.*:: fs_statvfs'.*
Expand Down
13 changes: 13 additions & 0 deletions doc/services/storage/flash_img/flash_img.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. _flash_img_api:

Flash Image
###########

The flash image API as part of the Device Firmware Upgrade (DFU) subsystem
provides an abstraction on top of Flash Stream to simplify writing firmware
image chunks to flash.

API Reference
*************

.. doxygengroup:: flash_img_api
1 change: 1 addition & 0 deletions doc/services/storage/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ Storage
nvs/nvs.rst
disk/access.rst
flash_map/flash_map.rst
flash_img/flash_img.rst
fcb/fcb.rst
stream/stream_flash.rst
18 changes: 18 additions & 0 deletions include/zephyr/dfu/flash_img.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,25 @@
* SPDX-License-Identifier: Apache-2.0
*/

/**
* @file
* @brief Flash image header file
*
* This header file declares prototypes for the flash image APIs used for DFU.
*/

#ifndef ZEPHYR_INCLUDE_DFU_FLASH_IMG_H_
#define ZEPHYR_INCLUDE_DFU_FLASH_IMG_H_

#include <zephyr/storage/stream_flash.h>

/**
* @brief Abstraction layer to write firmware images to flash
*
* @defgroup flash_img_api Flash image API
* @{
*/

#ifdef __cplusplus
extern "C" {
#endif
Expand Down Expand Up @@ -100,4 +114,8 @@ int flash_img_check(struct flash_img_context *ctx,
}
#endif

/**
* @}
*/

#endif /* ZEPHYR_INCLUDE_DFU_FLASH_IMG_H_ */