suit: Integrated nordic binaries pull into build system

This commit allows to build a SUIT envelope prepared for pulling
Nordic firmware binaries into the build system.

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

Author: ahasztag

cmake/sysbuild/suit.cmake

@@ -230,6 +230,18 @@ function(suit_create_package)
     --core sysbuild,,,${PROJECT_BINARY_DIR}/.config
   )
 
+  if(SB_CONFIG_SUIT_ENVELOPE_NORDIC_TOP_IN_ROOT)
+    # Prepare Nordic artifacts for the root SUIT envelope
+    set(nordic_pull FALSE)
+    if(SB_CONFIG_SUIT_ENVELOPE_NORDIC_TOP_EXTRACT_PAYLOADS_FOR_PULL)
+      set(nordic_pull TRUE)
+    endif()
+    suit_nordic_artifacts_prepare(
+      ${SB_CONFIG_SUIT_ENVELOPE_NORDIC_TOP_DIRECTORY}
+      ${nordic_pull}
+    )
+  endif()
+
   foreach(image ${IMAGES})
     unset(target)
     unset(encrypt)

cmake/sysbuild/suit_utilities.cmake

@@ -37,6 +37,51 @@ function(suit_copy_artifact_to_output_directory target artifact)
   )
 endfunction()
 
+function(suit_nordic_artifacts_prepare nordic_top_directory pull)
+  if(pull)
+    list(APPEND nordic_extract_args "--input-envelope" "${nordic_top_directory}/nordic_top.suit")
+    list(APPEND nordic_extract_args "--output-envelope" "nordic_top.suit")
+    list(APPEND nordic_extract_args "--omit-payload-regex" "(?!.*sec.*\.bin|.*sysctl_v.*\.bin).*")
+    list(APPEND nordic_extract_args "--dependency-regex" "(#secdom|#sysctrl)")
+    list(APPEND nordic_extract_args "--payload-file-prefix-to-remove" "file://")
+
+    execute_process(
+      COMMAND ${CMAKE_COMMAND} -E make_directory "nordic_pull_dir"
+      WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    )
+
+    execute_process(
+      COMMAND
+      ${PYTHON_EXECUTABLE} ${SUIT_GENERATOR_CLI_SCRIPT}
+      payload_extract
+      recursive
+      ${nordic_extract_args}
+      WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/nordic_pull_dir
+    )
+
+    set(temporary_dir "${CMAKE_CURRENT_BINARY_DIR}/nordic_pull_dir")
+    file(GLOB nordic_binaries RELATIVE "${temporary_dir}" "${temporary_dir}/*.bin")
+
+    foreach(nordic_bin ${nordic_binaries})
+      set_property(
+        GLOBAL APPEND PROPERTY SUIT_POST_BUILD_COMMANDS
+        COMMAND ${CMAKE_COMMAND} -E copy ${temporary_dir}/${nordic_bin} ${SUIT_ROOT_DIRECTORY}${nordic_bin}
+        BYPRODUCTS ${SUIT_ROOT_DIRECTORY}${nordic_bin}
+      )
+
+      set_property(GLOBAL APPEND PROPERTY SUIT_DFU_ARTIFACTS ${SUIT_ROOT_DIRECTORY}${nordic_bin})
+    endforeach()
+
+    set(nordic_top_directory "${temporary_dir}")
+  endif()
+
+  set_property(
+    GLOBAL APPEND PROPERTY SUIT_POST_BUILD_COMMANDS
+    COMMAND ${CMAKE_COMMAND} -E copy ${nordic_top_directory}/nordic_top.suit ${SUIT_ROOT_DIRECTORY}nordic_top.suit
+    BYPRODUCTS ${SUIT_ROOT_DIRECTORY}nordic_top.suit
+  )
+endfunction()
+
 # Render jinja templates using passed arguments.
 # Function uses core_arguments which is list of folowing entries:
 #   --core <target_name>,<locatino_of_firmware_binary_file>,<location_of_edt_file_representing_dts>
@@ -132,7 +177,7 @@ endfunction()
 #   'output_file' - path to output cache partition file
 function(suit_create_nordic_cache_partition args output_file)
   list(APPEND args "--output-file" "${output_file}")
-  list(APPEND args "--omit-payload-regex" "'(?!.*secdom.*\.bin|.*sysctl_v.*\.bin).*'")
+  list(APPEND args "--omit-payload-regex" "'(?!.*sec.*\.bin|.*sysctl_v.*\.bin).*'")
   list(APPEND args "--dependency-regex" "'(#top|#secdom|#sysctrl)'")
 
   set_property(

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

@@ -510,5 +510,5 @@ SUIT_Envelope_Tagged:
     '#{{ application['name'] }}': {{ artifacts_folder ~ application['name'] }}.suit
 {%- endif %}
 {%- if nordic_top %}
-    '#top': {{ sysbuild['config']['SB_CONFIG_SUIT_ENVELOPE_NORDIC_TOP_DIRECTORY'] }}/nordic_top.suit
+    '#top': {{ artifacts_folder }}nordic_top.suit
 {%- endif %}

samples/suit/smp_transfer/suit/nrf54h20/root_with_binary_nordic_top_extflash.yaml.jinja2

@@ -122,6 +122,23 @@ SUIT_Envelope_Tagged:
 {%- endif %}
 
     suit-payload-fetch:
+{%- if nordic_top %}
+    - suit-directive-set-component-index: 0
+    - suit-directive-override-parameters:
+        suit-parameter-uri: "#top"
+    - suit-directive-fetch:
+      - suit-send-record-failure
+    - suit-condition-dependency-integrity:
+      - suit-send-record-success
+      - suit-send-record-failure
+      - suit-send-sysinfo-success
+      - suit-send-sysinfo-failure
+    - suit-directive-process-dependency:
+      - suit-send-record-success
+      - suit-send-record-failure
+      - suit-send-sysinfo-success
+      - suit-send-sysinfo-failure
+{%- endif %}
 {%- if radio is defined %}
     - suit-directive-set-component-index: 0
     - suit-directive-override-parameters:
@@ -309,5 +326,5 @@ SUIT_Envelope_Tagged:
     '#{{ application['name'] }}': {{ artifacts_folder ~ application['name'] }}.suit
 {%- endif %}
 {%- if nordic_top %}
-    '#top': {{ sysbuild['config']['SB_CONFIG_SUIT_ENVELOPE_NORDIC_TOP_DIRECTORY'] }}/nordic_top.suit
+    '#top': {{ artifacts_folder }}nordic_top.suit
 {%- endif %}

sysbuild/Kconfig.suit

@@ -66,6 +66,15 @@ config SUIT_ENVELOPE_NORDIC_TOP_EXTRACT_PAYLOADS_TO_CACHE
 	  size to 0 in the suit-candidate-verification sequence - so that its
 	  memory can be used as a mirror for the update of the Nordic elements.
 
+config SUIT_ENVELOPE_NORDIC_TOP_EXTRACT_PAYLOADS_FOR_PULL
+	bool "Extract payloads from the nordic_top envelope for the use of the pull model"
+	depends on !SUIT_ENVELOPE_NORDIC_TOP_EXTRACT_PAYLOADS_TO_CACHE
+	help
+	  When this option is enabled, the build system extracts payloads from
+	  the nordic_top envelope into binaries. The binaries are stored in the
+	  DFU directory, allowing them to be used for the pull model.
+	  They are also added to the DFU zip file.
+
 config SUIT_ENVELOPE_NORDIC_TOP_CACHE_PARTITION_NUM
 	int "Cache partition number to store the payloads extracted from nordic_top envelope"
 	default 1