doc: add suit SMP readme

Add README page for SUIT SMP sample Signed-off-by: Katherine Depa <[email protected]>
nrfconnect · May 24, 2024 · fdd2fe2 · fdd2fe2
1 parent de6a369
commit fdd2fe2
Show file tree

Hide file tree

Showing 9 changed files with 417 additions and 0 deletions.
diff --git a/doc/nrf/config_and_build/configuring_app/output_build_files.rst b/doc/nrf/config_and_build/configuring_app/output_build_files.rst
@@ -148,6 +148,29 @@ MCUboot output build files
 |                                                                  | Created when the :kconfig:option:`CONFIG_BOOT_BUILD_DIRECT_XIP_VARIANT` Kconfig option is enabled.                                                                                                                                                                                       |
 +------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
+.. _app_build_output_files_suit_dfu:
+
+SUIT output build files
+***********************
+
+The following table lists secondary build files that can be generated when building firmware update packages using the :ref:`Software Updates for Internet of Things (SUIT) DFU procedure <ug_nrf54h20_suit_intro>`.
+
++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| File                                           | Description                                                                                                                                                            |
++================================================+========================================================================================================================================================================+
+| :file:`root_hierarchical_envelope.yaml.jinja2` | SUIT Manifest templates automatically placed in the sample directory after the first build of the ``nrf54h_suit_sample`` sample.                                       |
+|                                                | They serve as the basis for generating the specific SUIT envelopes tailored to the requirements of different domains within the device (root, application, and radio). |
+| :file:`app_envelope.yaml.jinja2`               |                                                                                                                                                                        |
+|                                                |                                                                                                                                                                        |
+| :file:`rad_envelope.yaml.jinja2`               |                                                                                                                                                                        |
++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| :file:`root.suit`                              | Binary SUIT envelopes that are generated from their respective YAML manifest templates during the build process of the ``nrf54h_suit_sample`` sample.                  |
+|                                                | The :file:`root.suit` contains embedded application core manifest (:file:`application.suit`) and radio core manifest (:file:`radio.suit`).                             |
+| :file:`application.suit`                       | The :file:`radio.suit` is not generated for the UART version of the ``nrf54h_suit_sample``.                                                                            |
+|                                                | These files can be found in the :file:`build/zephyr` directory after building the sample.                                                                              |
+| :file:`radio.suit`                             |                                                                                                                                                                        |
++------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
 .. _app_build_output_files_other:
 
 Other output build files

diff --git a/doc/nrf/images/suit_smp_firmware_upload_complete.png b/doc/nrf/images/suit_smp_firmware_upload_complete.png
diff --git a/doc/nrf/images/suit_smp_firmware_uploading.png b/doc/nrf/images/suit_smp_firmware_uploading.png
diff --git a/doc/nrf/images/suit_smp_images_v2.png b/doc/nrf/images/suit_smp_images_v2.png
diff --git a/doc/nrf/images/suit_smp_select_advanced.png b/doc/nrf/images/suit_smp_select_advanced.png
diff --git a/doc/nrf/images/suit_smp_select_firmware_select_file.png b/doc/nrf/images/suit_smp_select_firmware_select_file.png
diff --git a/doc/nrf/images/suit_smp_select_image_read.png b/doc/nrf/images/suit_smp_select_image_read.png
diff --git a/doc/nrf/images/suit_smp_select_suit_smp_sample.png b/doc/nrf/images/suit_smp_select_suit_smp_sample.png
diff --git a/samples/suit/smp_transfer/README.rst b/samples/suit/smp_transfer/README.rst