dfu: dfu_target: Align dfu_target to SUIT Cache

Aligned dfu_target to allow processing SUIT envelope
and all images stored in the Cache partitions.

This implementation allows writing of the SUIT manifests
to dfu_partition and all following images to the defined
dfu_partition_cache_x partitions.

After writing manifests and images you can use dfu_target
to start processing it and schedule an update.

The implementation is integrated with the dfu_multi_target
functionality.

Added the additional DFU_TARGET_SUIT_CACHE_PROCESSING kconfig.

Signed-off-by: Arkadiusz Balys <[email protected]>

Author: ArekBalysNordic

include/dfu/dfu_target_suit.h

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023 Nordic Semiconductor ASA
+ * Copyright (c) 2024 Nordic Semiconductor ASA
  *
  * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
  */
@@ -29,23 +29,22 @@ extern "C" {
 int dfu_target_suit_set_buf(uint8_t *buf, size_t len);
 
 /**
- * @brief See if data in buf indicates SUIT style upgrade.
+ * @brief Initialize dfu target for specific image, perform steps necessary to receive firmware.
  *
- * Not implemented as it does not currently have any use cases.
- * Currently always returns -ENOSYS.
- *
- * @retval -ENOSYS
- */
-bool dfu_target_suit_identify(const void *const buf);
-
-/**
- * @brief Initialize dfu target, perform steps necessary to receive firmware.
+ * If you call this function, you must call dfu_target_suit_done() to finalize the firmware upgrade
+ * before initializing any other images.
  *
  * @param[in] file_size Size of the current file being downloaded.
- * @param[in] img_num Image pair index.
+ * @param[in] img_num Image index.
  * @param[in] cb Callback for signaling events(unused).
  *
- * @retval 0 If successful, negative errno otherwise.
+ * @return 0 If successful
+ * @return -ENODEV errno code if the buffer has not been initialized.
+ * @return -ENXIO errno code if the partition dedicated for provided image is not found.
+ * @return -ENOMEM errno code if the buffer is not large enough.
+ * @return -EFAULT errno code if flash device assigned to the image is not available on the device.
+ * @return -EBUSY errno code if the any image is already initialized and stream flash is in use.
+ * @return other negative errno code if the initialization failed.
  */
 int dfu_target_suit_init(size_t file_size, int img_num, dfu_target_callback_t cb);
 
@@ -54,7 +53,7 @@ int dfu_target_suit_init(size_t file_size, int img_num, dfu_target_callback_t cb
  *
  * @param[out] offset Returns the offset of the firmware upgrade.
  *
- * @return 0 if success, otherwise negative value if unable to get the offset
+ * @retval 0 if success, otherwise negative value if unable to get the offset
  */
 int dfu_target_suit_offset_get(size_t *offset);
 
@@ -64,7 +63,9 @@ int dfu_target_suit_offset_get(size_t *offset);
  * @param[in] buf Pointer to data that should be written.
  * @param[in] len Length of data to write.
  *
- * @return 0 on success, negative errno otherwise.
+ * @return 0 on success
+ * @return -EFAULT errno code if the stream flash has not been initialized for any dfu image.
+ * @return other negative errno code if the initialization failed.
  */
 int dfu_target_suit_write(const void *const buf, size_t len);
 
@@ -73,21 +74,23 @@ int dfu_target_suit_write(const void *const buf, size_t len);
 
  * @param[in] successful Indicate whether the firmware was successfully recived.
  *
- * @return 0 on success, negative errno otherwise.
+ * @retval 0 on success, negative errno otherwise.
  */
 int dfu_target_suit_done(bool successful);
 
 /**
- * @brief Schedule update and reset the device.
+ * @brief Schedule an update
+ *
+ * This call processes SUIT envelope and requests images update.
  *
- * This call requests images update and immediately starts it
- * by resetting the device.
+ * Firmware update will start after the device reboot.
+ * You can reboot device, for example, by calling dfu_target_suit_reboot().
  *
  * @param[in] img_num Given image pair index or -1 for all
  *		      of image pair indexes.
  *
- * @return 0 for a successful request or a negative error
- *	   code identicating reason of failure.
+ * @retval 0 for a successful request or a negative error
+ *	   code indicating reason of failure.
  **/
 int dfu_target_suit_schedule_update(int img_num);
 
@@ -96,10 +99,19 @@ int dfu_target_suit_schedule_update(int img_num);
  *
  * Cancels any ongoing updates.
  *
- * @return 0 on success, negative errno otherwise.
+ * @retval 0 on success, negative errno otherwise.
  */
 int dfu_target_suit_reset(void);
 
+/**
+ * @brief Reboot the device, and apply new image.
+ *
+ * The reboot can be delayed by setting the
+ * CONFIG_DFU_TARGET_REBOOT_RESET_DELAY_MS kconfig value.
+ *
+ * @retval 0 on success, negative errno otherwise.
+ */
+int dfu_target_suit_reboot(void);
 
 #ifdef __cplusplus
 }

subsys/dfu/dfu_target/CMakeLists.txt

@@ -29,6 +29,9 @@ zephyr_library_sources_ifdef(CONFIG_DFU_TARGET_SMP
 zephyr_library_sources(src/dfu_stream_flatten.c)
 if (CONFIG_DFU_TARGET_SUIT)
   zephyr_library_sources(src/dfu_target_suit.c)
+  zephyr_library_link_libraries(suit_memory_layout_interface)
+  zephyr_library_link_libraries(suit_envelope_info)
+  zephyr_library_link_libraries_ifdef(CONFIG_SUIT_CACHE_RW suit_cache_interface)
   if (CONFIG_SSF_SUIT_SERVICE_ENABLED)
     zephyr_library_link_libraries(suit_utils)
   endif()

subsys/dfu/dfu_target/Kconfig

@@ -117,14 +117,42 @@ config DFU_TARGET_SUIT
 	bool "SUIT DFU target support"
 	default y
 	depends on SUIT
+	depends on SUIT_ENVELOPE_INFO
 	imply MPU_ALLOW_FLASH_WRITE
 	select SUIT_UTILS
 	select ZCBOR
 	select ZCBOR_CANONICAL
+	select FLASH
+	select STREAM_FLASH
 	select DFU_TARGET_STREAM
 	help
 	  Enable support for updates using DFU target based on SUIT
 
+if DFU_TARGET_SUIT
+
+config DFU_TARGET_SUIT_CACHE_PROCESSING
+	bool "SUIT cache processing"
+	default y
+	depends on SUIT_CACHE_RW
+	help
+	  Enable SUIT cache processing to process images ids bigger than 0.
+	  It allows to store the image in the cache cache partitions and
+	  assign them to be processed by the SUIT.
+
+config DFU_TARGET_SUIT_INITIALIZE_SUIT
+	bool "Initialize SUIT dfu library"
+	help
+	  Initialize SUIT library during the system startup.
+
+config DFU_TARGET_REBOOT_RESET_DELAY_MS
+	int "Reboot reset delay in milliseconds"
+	default 0
+	help
+	  Set the delay in milliseconds before the device is reset after a reboot
+	  function is called.
+
+endif # DFU_TARGET_SUIT
+
 module=DFU_TARGET
 module-dep=LOG
 module-str=Device Firmware Upgrade

subsys/dfu/dfu_target/src/dfu_target.c

@@ -127,7 +127,8 @@ int dfu_target_init(int img_type, int img_num, size_t file_size, dfu_target_call
 	 * abort and to change the image number.
 	 */
 	if (new_target == current_target && img_type != DFU_TARGET_IMAGE_TYPE_MODEM_DELTA &&
-	    img_type != DFU_TARGET_IMAGE_TYPE_SMP && current_img_num == img_num) {
+	    img_type != DFU_TARGET_IMAGE_TYPE_SMP && current_img_num == img_num &&
+	    img_type != DFU_TARGET_IMAGE_TYPE_SUIT) {
 		return 0;
 	}