diff --git a/doc/known-warnings.txt b/doc/known-warnings.txt index 08b0d760674c6..0177831efaf8e 100644 --- a/doc/known-warnings.txt +++ b/doc/known-warnings.txt @@ -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'.* diff --git a/doc/services/storage/flash_img/flash_img.rst b/doc/services/storage/flash_img/flash_img.rst new file mode 100644 index 0000000000000..199ef1227005e --- /dev/null +++ b/doc/services/storage/flash_img/flash_img.rst @@ -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 diff --git a/doc/services/storage/index.rst b/doc/services/storage/index.rst index 8d3dd3da50c2b..2b96a7b4745a3 100644 --- a/doc/services/storage/index.rst +++ b/doc/services/storage/index.rst @@ -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 diff --git a/include/zephyr/dfu/flash_img.h b/include/zephyr/dfu/flash_img.h index de33b9cb036e3..3e0c28d25dddd 100644 --- a/include/zephyr/dfu/flash_img.h +++ b/include/zephyr/dfu/flash_img.h @@ -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 +/** + * @brief Abstraction layer to write firmware images to flash + * + * @defgroup flash_img_api Flash image API + * @{ + */ + #ifdef __cplusplus extern "C" { #endif @@ -100,4 +114,8 @@ int flash_img_check(struct flash_img_context *ctx, } #endif +/** + * @} + */ + #endif /* ZEPHYR_INCLUDE_DFU_FLASH_IMG_H_ */