suit: Separated recovery application cache partitions

This commits allows for creation of a separate DFU cache
partitions file holding recovery images.

Signed-off-by: Artur Hadasz <[email protected]>

Author: ahasztag

cmake/sysbuild/suit.cmake

@@ -110,9 +110,14 @@ function(suit_generate_recovery_dfu_zip)
     GLOBAL PROPERTY
     SUIT_RECOVERY_DFU_ARTIFACTS
   )
+  get_property(
+    additional_script_params
+    GLOBAL PROPERTY
+    SUIT_RECOVERY_DFU_ZIP_ADDITIONAL_SCRIPT_PARAMS
+  )
 
   set(root_name "${SB_CONFIG_SUIT_ENVELOPE_APP_RECOVERY_ARTIFACT_NAME}.suit")
-  set(script_params "${root_name}type=suit-envelope")
+  set(script_params "${root_name}type=suit-envelope;${additional_script_params}")
 
   include(${ZEPHYR_NRF_MODULE_DIR}/cmake/fw_zip.cmake)
 
@@ -321,17 +326,30 @@ function(suit_create_package)
     )
   endforeach()
 
-  # First parse which images should be extracted to which cache partition
+  # First parse which images should be extracted to which cache partitions
   set(DFU_CACHE_PARTITIONS_USED "")
+  set(RECOVERY_DFU_CACHE_PARTITIONS_USED "")
+
   foreach(image ${IMAGES})
     sysbuild_get(EXTRACT_TO_CACHE IMAGE ${image} VAR CONFIG_SUIT_DFU_CACHE_EXTRACT_IMAGE KCONFIG)
     if(EXTRACT_TO_CACHE)
       sysbuild_get(CACHE_PARTITION_NUM IMAGE ${image} VAR CONFIG_SUIT_DFU_CACHE_EXTRACT_IMAGE_PARTITION KCONFIG)
-      list(APPEND DFU_CACHE_PARTITIONS_USED ${CACHE_PARTITION_NUM})
-      list(APPEND SUIT_CACHE_PARTITION_${CACHE_PARTITION_NUM} ${image})
+
+      unset(CONFIG_SUIT_RECOVERY)
+      sysbuild_get(CONFIG_SUIT_RECOVERY IMAGE ${image} VAR CONFIG_SUIT_RECOVERY KCONFIG)
+
+      if(CONFIG_SUIT_RECOVERY)
+        list(APPEND RECOVERY_DFU_CACHE_PARTITIONS_USED ${CACHE_PARTITION_NUM})
+        list(APPEND SUIT_RECOVERY_CACHE_PARTITION_${CACHE_PARTITION_NUM} ${image})
+      else()
+        list(APPEND DFU_CACHE_PARTITIONS_USED ${CACHE_PARTITION_NUM})
+        list(APPEND SUIT_CACHE_PARTITION_${CACHE_PARTITION_NUM} ${image})
+      endif()
     endif()
   endforeach()
+
   list(REMOVE_DUPLICATES DFU_CACHE_PARTITIONS_USED)
+  list(REMOVE_DUPLICATES RECOVERY_DFU_CACHE_PARTITIONS_USED)
 
   # Then create the cache partitions
   foreach(CACHE_PARTITION_NUM ${DFU_CACHE_PARTITIONS_USED})
@@ -353,10 +371,36 @@ function(suit_create_package)
       "${CACHE_CREATE_ARGS}"
       "${SUIT_ROOT_DIRECTORY}dfu_cache_partition_${CACHE_PARTITION_NUM}.bin"
       ${CACHE_PARTITION_NUM}
+      FALSE
     )
   endforeach()
 
   if(SB_CONFIG_SUIT_BUILD_RECOVERY)
+
+    # Create cache partitions for the recovery images
+    foreach(CACHE_PARTITION_NUM ${RECOVERY_DFU_CACHE_PARTITIONS_USED})
+      set(CACHE_CREATE_ARGS "")
+      foreach(image ${SUIT_RECOVERY_CACHE_PARTITION_${CACHE_PARTITION_NUM}})
+        sysbuild_get(BINARY_DIR IMAGE ${image} VAR APPLICATION_BINARY_DIR CACHE)
+        sysbuild_get(BINARY_FILE IMAGE ${image} VAR CONFIG_KERNEL_BIN_NAME KCONFIG)
+        sysbuild_get(IMAGE_CACHE_URI IMAGE ${image} VAR CONFIG_SUIT_DFU_CACHE_EXTRACT_IMAGE_URI KCONFIG)
+        list(APPEND CACHE_CREATE_ARGS
+          "--input" "\"${IMAGE_CACHE_URI},${BINARY_DIR}/zephyr/${BINARY_FILE}.bin\""
+        )
+      endforeach()
+
+      if(SUIT_DFU_CACHE_PARTITION_${CACHE_PARTITION_NUM}_EB_SIZE)
+        list(APPEND CACHE_CREATE_ARGS "--eb-size" "${SUIT_DFU_CACHE_PARTITION_${CACHE_PARTITION_NUM}_EB_SIZE}")
+      endif()
+
+      suit_create_cache_partition(
+        "${CACHE_CREATE_ARGS}"
+        "${SUIT_ROOT_DIRECTORY}dfu_cache_partition_recovery_${CACHE_PARTITION_NUM}.bin"
+        ${CACHE_PARTITION_NUM}
+        TRUE
+      )
+    endforeach()
+
     suit_get_manifest(${SB_CONFIG_SUIT_ENVELOPE_APP_RECOVERY_TEMPLATE_FILENAME} INPUT_APP_RECOVERY_ENVELOPE_JINJA_FILE)
 
     # create app recovery envelope if defined

cmake/sysbuild/suit_utilities.cmake

@@ -84,7 +84,7 @@ function(suit_create_envelope input_file output_file create_signature)
   endif()
 endfunction()
 
-function(suit_create_cache_partition args output_file partition_num)
+function(suit_create_cache_partition args output_file partition_num recovery)
 
   list(APPEND args "--output-file" "${output_file}")
 
@@ -98,6 +98,13 @@ function(suit_create_cache_partition args output_file partition_num)
 
   get_filename_component(output_file_name ${output_file} NAME)
 
-  set_property(GLOBAL APPEND PROPERTY SUIT_DFU_ARTIFACTS ${output_file})
-  set_property(GLOBAL APPEND PROPERTY SUIT_DFU_ZIP_ADDITIONAL_SCRIPT_PARAMS "${output_file_name}type=cache;${output_file_name}partition=${partition_num};")
+  if (recovery)
+    set_property(GLOBAL APPEND PROPERTY SUIT_RECOVERY_DFU_ARTIFACTS ${output_file})
+    set_property(GLOBAL APPEND PROPERTY SUIT_RECOVERY_DFU_ZIP_ADDITIONAL_SCRIPT_PARAMS
+                 "${output_file_name}type=cache;${output_file_name}partition=${partition_num};")
+  else()
+    set_property(GLOBAL APPEND PROPERTY SUIT_DFU_ARTIFACTS ${output_file})
+    set_property(GLOBAL APPEND PROPERTY SUIT_DFU_ZIP_ADDITIONAL_SCRIPT_PARAMS
+                 "${output_file_name}type=cache;${output_file_name}partition=${partition_num};")
+  endif()
 endfunction()

config/suit/templates/nrf54h20/default/v1/rad_recovery_envelope.yaml.jinja2

@@ -101,7 +101,7 @@ SUIT_Envelope_Tagged:
     - RFC4122_UUID:
         namespace: {{ mpi_rad_recovery_vendor_name }}
         name: {{ mpi_rad_recovery_class_name }}
-  suit-integrated-payloads:
 {%- if 'CONFIG_SUIT_DFU_CACHE_EXTRACT_IMAGE' not in rad_recovery['config'] or rad_recovery['config']['CONFIG_SUIT_DFU_CACHE_EXTRACT_IMAGE'] == '' %}
+  suit-integrated-payloads:
     '#{{ rad_recovery['name'] }}': {{ rad_recovery['binary'] }}
 {%- endif %}