doc: add suit SMP readme #15287

kittydepa · 2024-05-14T07:30:27Z

Add README page for SUIT SMP sample

NordicBuilder · 2024-05-14T07:36:37Z

Test specification

CI/Jenkins/NRF

Skipped

CI/Jenkins/integration

Skipped

Note: This message is automatically posted and updated by the CI

samples/suit/smp_transfer/README.rst

tomchy · 2024-05-14T08:23:05Z

samples/suit/smp_transfer/README.rst

+          * :file:`hci_rpmsg_subimage.suit` - This file is the envelop for the Radio Core, containing embedded radio core firmware as an integrated payload.
+
+         For more information about files generated as output of the build process, see :ref:`app_build_output_files`.
+         For more information on the contents of the build directory, see :ref:`zephyr:build-directory-contents` in the Zephyr documentation.


If there is a specific page that show the file structure generated by sysbuild build, it will be worth to use it instead (there are some changes, i.e. application artifacts are under a dedicated subfolder).

Good point! Will look into this and get back to this.

I found this: https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/build/sysbuild/index.html will provide a link to this.

The link you provided looks different than the one you implemented, @kittydepa , so I'm not sure if this line has been updated. Anyway, I'm not sure if providing a link to output files in the NCS with the detailed tables first, and then linking to a generic section in Zephyr with way less detailed list makes sense.

samples/suit/smp_transfer/README.rst

NordicBuilder · 2024-05-15T07:20:52Z

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

tomchy · 2024-05-20T12:32:25Z

samples/suit/smp_transfer/README.rst

+
+|config|
+
+The default configuration uses UART with Version 1.


Version -> sequence number ?

@tomchy Would it be okay to rewrite to include both? Something like:

Suggested change

The default configuration uses UART with Version 1.

The default configuration uses UART with sequence number 1 (shown as Version 1 in the nRF Connect Device Manager app).

Yes, as long as you talk about nRF Connect Device Manager app it is fine 👍

tomchy · 2024-05-20T12:32:48Z

samples/suit/smp_transfer/README.rst

+|config|
+
+The default configuration uses UART with Version 1.
+To change the version of the application, configure the :ref:`CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM` Kconfig option.


version -> sequence number ?

tomchy · 2024-05-20T12:34:19Z

samples/suit/smp_transfer/README.rst

+To change the version of the application, configure the :ref:`CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM` Kconfig option.
+This also changes the number of blinks on **LED 1** and sets the :ref:`sequence number <ug_suit_dfu_suit_manifest_elements>` of the SUIT :ref:`envelope <ug_suit_dfu_suit_concepts>`’s manifest.
+
+To use this configuration, include the ``-DCONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=x`` option with the build command, where x is the version number.


Once again changed CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM to a sysbuild KConfig: SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM. That way it is a common value for all manifests that are generated by the build system.

tomchy · 2024-05-20T12:34:47Z

samples/suit/smp_transfer/README.rst

+
+   west build -p -b nrf54h20dk/nrf54h20/cpuapp --sysbuild -- -DCONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2
+
+If you do not specify this configuration, the sample is built with Version 1.


Version -> sequence number

tomchy · 2024-05-20T12:35:26Z

samples/suit/smp_transfer/README.rst

+
+.. _CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM:
+
+CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM - Configuration for the application version


Please rephrase all references to the application version.

tomchy · 2024-05-20T12:37:50Z

samples/suit/smp_transfer/README.rst

+          * :file:`root.suit` - This file is the most important envelope, containing the embedded :file:`application.suit` and :file:`radio.suit` files as integrated dependencies.
+            These files are used to execute DFU.
+          * :file:`application.suit` - This file is the envelope for the Application Core, containing embedded Application Core firmware as an integrated payload.
+          * :file:`radio.suit` - This file is the envelop for the Radio Core, containing embedded radio core firmware as an integrated payload.


nit: envelop -> envelope

tomchy · 2024-05-20T12:41:06Z

samples/suit/smp_transfer/README.rst

+
+         If you want to further configure your sample, see :ref:`configure_application` for additional information.
+
+         After running the ``west build`` command, the output build files can be found in the :file:`build/zephyr` directory.


build/zephyr -> build/DFU

tomchy · 2024-05-20T12:44:47Z

samples/suit/smp_transfer/README.rst

+
+            .. code-block:: console
+
+               west build -p -b nrf54h20dk/nrf54h20/cpuapp -d C:\ncs-lcs\west_working_dir\build\


missing: --sysbuild

tomchy · 2024-05-20T12:45:04Z

samples/suit/smp_transfer/README.rst

+
+            .. code-block:: console
+
+               west build -p -b nrf54h20dk/nrf54h20/cpuapp -d C:/ncs-lcs/work-dir -- -DFILE_SUFFIX=bt -DCONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2


missing: --sysbuild

greg-fer · 2024-05-21T10:29:10Z

doc/nrf/samples/suit.rst

   :maxdepth: 1
   :caption: Subpages
   :glob:
-
-   ../../../samples/suit/*/README


If this samples/suit.rst is basically being emptied out, shouldn't it be orphaned too?

I thought so too, but just got latest info from Francesco that it's not needed/okay to be un-orphaned now.

greg-fer · 2024-05-21T10:31:27Z

samples/suit/smp_transfer/README.rst

+Building and programming using |nRFVSC|
+=======================================
+
+To build the sample using |VSC|, follow the steps listed on the `How to build an application`_ page in the |nRFVSC| documentation.


I think nRFVSC being the recommended IDE, it should be listed first, before the command line steps.
Also, have this sample been tested with nRF VSC extension? @tomchy ?

It has been verified once in sdk-nrf-next and the next round is planned to be a part of NCSDK-24867.

Okay, will remove for now but have added to an existing ticket to watch for this/update if needed

greg-fer · 2024-05-21T10:32:39Z

samples/suit/smp_transfer/README.rst

+
+   .. group-tab:: Over Bluetooth Low Energy
+
+      1. **Update the envelope sequence number:**


We don't bold out the step descriptions, as per style guide :(
Also, while I think this bold should not be here, it is also not applied consistently to all steps.

greg-fer · 2024-05-21T10:36:53Z

samples/suit/smp_transfer/README.rst

+         Build the sample with an updated sequence number:
+
+         .. code-block:: console
+
+            west build -p -b nrf54h20dk/nrf54h20/cpuapp --sysbuild -- -DFILE_SUFFIX=bt -DCONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2


Here's the pickle: normally, for all samples, Testing is about pressing some buttons or verifying that the programmed firmware works. Here, in this sample, Testing includes building steps.

Also note that only command line building steps are provided.

Still looking into this, with @richabp

greg-fer · 2024-05-21T10:54:07Z

samples/suit/smp_transfer/README.rst

+            .. figure:: /images/suit_smp_select_image_read.png
+               :alt: Select READ from Images
+
+            Observe "Version: 1" printed in the **Images** section of the mobile app.


(Global comment for multiple occurrences)
Starting with a verb makes this technically a separate step, an action to be taken.
A way to go around this and keep one step is to rephrase this line so that it reads like a result of the action.
Something like ""Version: 1" is listed in the Images section of the mobile app." or "The Images section
now mentions "Version: 1".

greg-fer · 2024-05-21T11:13:44Z

samples/suit/smp_transfer/README.rst

+         After running the ``west build`` command, the output build files can be found in the :file:`build/dfur` directory.
+         The following build artifacts are found with both firmware binaries embedded as integrated payloads:
+
+          * :file:`root.suit` - This file is the most important envelope, containing embedded :file:`app.suit` as an integrated dependency.
+            This file is used to execute DFU.
+          * :file:`app.suit` - This file is the envelope for the Application Core, containing embedded Application Core firmware as an integrated payload.
+
+         For more information about files generated as output of the build process, see :ref:`app_build_output_files`.
+         For more information on the contents of the build directory, see :ref:`zephyr:build-directory-contents` in the Zephyr documentation.


greg-fer · 2024-05-21T11:13:51Z

samples/suit/smp_transfer/README.rst

+      #. Program the sample to the kit using the following command:
+
+         .. code-block:: console
+
+            west flash
+
+         .. note::
+
+            If you are compiling in Windows and the build is unsuccessful due to the maximum path length limitation, use the following command:
+
+            .. code-block:: console
+
+               west flash -d C:/ncs-lcs/work-dir


greg-fer · 2024-05-21T11:17:07Z

samples/suit/smp_transfer/README.rst

+Manifest template files
+=======================


The title suggests to me I would find here a list of the template files. Not finding the detailed list and having the note here that mentions the radio domain manifest template makes me really confused. Only later, when I read about building, can I really understand what this note means. (I guess you mean radio.suit here?) For this reason, I think the order of presenting information here is not optimal.

That is a good point - I will take a look and try to reorder.
I have also just realised that this note may not be true anymore, and then can be removed (will check with SMEs). But will still try to adjust the order

greg-fer · 2024-05-21T11:33:49Z

samples/suit/smp_transfer/README.rst

+MCUmgr is a tool that can be used to upload SUIT envelopes through the SMP protocol.
+For more information on MCUmgr installation, see :ref:`zephyr:mcu_mgr`.


Does this mean that one also needs to (or can) use the samples/common MCUmgr component if I want to use MCUmgr?

It is not clear to me what do you mean by MCUmgr component, but going into the details we provide an alternative implementation of the image command group as well as a dedicated, custom suit command group for SMP protocol.

That said, yes, you can extend the sample with other SMP commands with the exception of the image group, since the code should not include two implementations of the same group (already blocked through Kconfig dependencies).

Any tool that supports SMP protocol over UART or BLE can be used with the sample.

@tomchy I believe Greg maybe referring to the CONFIG_NCS_SAMPLE_MCUMGR_BT_OTA_DFU Kconfig option found in samples/common (See here for description. It is currently recommended for BLE FOTA updates on nRF52 Series and nRF5340 DK).

My guess is no, it is not required and/or it has not been tested for SUIT specifically yet?

Yes, I'm referring to CONFIG_NCS_SAMPLE_MCUMGR_BT_OTA_DFU. When we discussed CONFIG_NCS_SAMPLE_MCUMGR_BT_OTA_DFU in the call, Kamil Piszczek said it can be used with whatever sample that uses Bluetooth LE, so I'd like to make sure there are no collisions between that Kconfig option ("MCUmgr component") and this implementation.

It cannot be used ATM, because it depends on BOOTLOADER_MCUBOOT which is not compatible with nRF54Hxx devices.
I have not heard of this Kconfig before and I do not know if it should be supported on nRF54H (so it would depend on the SUIT and our implementation of SMP image group).

greg-fer · 2024-05-21T11:34:55Z

samples/suit/smp_transfer/README.rst

+Overview
+********
+
+The sample uses one of the following to perform an update on the nRF54H20 SoC, featuring Nordic Semiconductor’s implementation of the SUIT procedure:


Suggested change

The sample uses one of the following to perform an update on the nRF54H20 SoC, featuring Nordic Semiconductor’s implementation of the SUIT procedure:

The sample uses one of the following methods to perform a firmware update on the nRF54H20 SoC, featuring Nordic Semiconductor’s implementation of the SUIT procedure:

kittydepa · 2024-05-23T09:44:34Z

Just pushed what I have completed so far, still working to address remaining suggestions.

greg-fer · 2024-05-23T10:33:14Z

Just pushed what I have completed so far, still working to address remaining suggestions.

OK, thanks @kittydepa . Poke me when you address all and want me to have a look.

greg-fer · 2024-05-28T09:15:50Z

samples/suit/smp_transfer/README.rst

+   :local:
+   :depth: 2
+
+The sample demonstrates how to update and boot the nRF54H20 System-on-Chip (SoC) using the Software Update for Internet of Things (SUIT) procedure on the application and radio cores of the SoC.


Link Software Update for Internet of Things (SUIT) to a generic SUIT intro page (in the NCS docs or external) or to a term in the glossary (which we also need anyway, actually).

greg-fer · 2024-05-28T09:17:35Z

samples/suit/smp_transfer/README.rst

+LED 1:
+    The number of blinks indicates the application SUIT envelope sequence number.
+    The default is set to ``1`` to blink once, indicating "Version 1".


LED 1 or LED 0? @tomchy , @FrancescoSer ? See note at the start of https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/samples/matter/light_bulb/README.html#user-interface

Waiting for SME response.

I think we can apply here the rules Bartek posted after the meeting with Paal.

The first one. The number changes from DK to DK. I have no idea what will be written on the final one.

greg-fer · 2024-05-28T09:20:17Z

samples/suit/smp_transfer/README.rst

+To change the sequence number of the application, configure the :ref:`CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM` Kconfig option.
+This also changes the number of blinks on **LED 1** and sets the :ref:`sequence number <ug_suit_dfu_suit_manifest_elements>` of the SUIT :ref:`envelope <ug_suit_dfu_suit_concepts>`’s manifest.
+
+To use this configuration, include the ``SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=x`` option with the build command, where x is the version number.


Suggested change

To use this configuration, include the ``SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=x`` option with the build command, where x is the version number.

To use this configuration, build the sample with sysbuild and set the ``SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM`` Sysbuild Kconfig option to `x`, where `x` is the version number.

greg-fer · 2024-05-28T09:20:31Z

samples/suit/smp_transfer/README.rst

+
+   west build -p -b nrf54h20dk/nrf54h20/cpuapp --sysbuild -- -SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2
+
+If you do not specify this configuration, the sample is built with sequence number 1 (shown as Version 1 in the nRF Device Manager app.


Suggested change

If you do not specify this configuration, the sample is built with sequence number 1 (shown as Version 1 in the nRF Device Manager app.

If you do not specify this configuration, the sample is built with sequence number 1 (shown as Version 1 in the nRF Device Manager app).

greg-fer · 2024-05-28T09:25:03Z

samples/suit/smp_transfer/README.rst

+All required manifest files (used to later create SUIT envelopes) are automatically created after the sample is built for the first time, and are the following:
+
+* The root manifest - :file:`root_hierarchical_envelope.yaml.jinja2`
+
+* The application domain manifest - :file:`app_envelope.yaml.jinja2`
+
+* The radio domain manifest - :file:`rad_envelope.yaml.jinja2`


We can now link to output build files here too! :)

Ah, yeah! Will add.

greg-fer · 2024-05-28T09:27:54Z

samples/suit/smp_transfer/README.rst

+         The output build files can be found in the :file:`build/DFU` directory.
+         The following build artifacts are found with both firmware binaries embedded as integrated payloads:
+
+          * :file:`root.suit` - This file is the most important envelope, containing the embedded :file:`application.suit` and :file:`radio.suit` files as integrated dependencies.
+            These files are used to execute DFU.
+          * :file:`application.suit` - This file is the envelope for the application core, containing embedded application core firmware as an integrated payload.
+          * :file:`radio.suit` - This file is the envelope for the radio core, containing embedded radio core firmware as an integrated payload.
+
+         For more information about files generated as output of the build process, see :ref:`app_build_output_files`, specifically :ref:`app_build_output_files_suit_dfu`.


Maybe just like this?

Suggested change

The output build files can be found in the :file:`build/DFU` directory.

The following build artifacts are found with both firmware binaries embedded as integrated payloads:

* :file:`root.suit` - This file is the most important envelope, containing the embedded :file:`application.suit` and :file:`radio.suit` files as integrated dependencies.

These files are used to execute DFU.

* :file:`application.suit` - This file is the envelope for the application core, containing embedded application core firmware as an integrated payload.

* :file:`radio.suit` - This file is the envelope for the radio core, containing embedded radio core firmware as an integrated payload.

For more information about files generated as output of the build process, see :ref:`app_build_output_files`, specifically :ref:`app_build_output_files_suit_dfu`.

The output build files can be found in the :file:`build/DFU` directory, including the :ref:`app_build_output_files_suit_dfu`.

greg-fer · 2024-05-28T09:29:09Z

samples/suit/smp_transfer/README.rst

+         After running the ``west build`` command, the output build files can be found in the :file:`build/dfu` directory.
+         The following build artifacts are found with both firmware binaries embedded as integrated payloads:
+
+          * :file:`root.suit` - This file is the most important envelope, containing embedded :file:`app.suit` as an integrated dependency.
+            This file is used to execute DFU.
+          * :file:`application.suit` - This file is the envelope for the application core, containing embedded application core firmware as an integrated payload.
+
+         For more information about files generated as output of the build process, see :ref:`app_build_output_files`, specifically :ref:`app_build_output_files_suit_dfu`.


Same as above?

greg-fer · 2024-05-28T09:29:27Z

samples/suit/smp_transfer/README.rst

+      1. Upload the signed envelope onto your mobile phone:
+
+         a. Open the nRF Device Manager app on your mobile phone.
+         #. Select the device **SUIT SMP Sample**. You should see the following:


Suggested change

#. Select the device **SUIT SMP Sample**. You should see the following:

#. Select the device **SUIT SMP Sample**.

You should see the following:

greg-fer

Approving, though with additional comments. Mostly suggestions.

greg-fer · 2024-06-04T12:30:37Z

samples/suit/smp_transfer/README.rst

@@ -0,0 +1,382 @@
+:orphan:


Note that this won't be applied in the current structure, because the :orphaned: SUIT samples are made visible by the toctree inclusion on this page: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/samples/suit.html

Both samples visible there are orphaned.

Removed :orphan: label

greg-fer · 2024-06-04T12:32:27Z

samples/suit/smp_transfer/README.rst

+
+.. _nrf54h_suit_sample:
+
+SUIT DFU: Firmware update on the nRF54H20 SoC


Suggested change

SUIT DFU: Firmware update on the nRF54H20 SoC

SUIT: Device firmware update on the nRF54H20 SoC

To me, SUIT itself is about DFU, DFU next to it is also about DFU, and then we have "firmware update" right after it. This is a lot of firmware updates in one title.

greg-fer · 2024-06-04T12:34:30Z

samples/suit/smp_transfer/README.rst

+For a SUIT update over UART, you need to install MCUmgr.
+MCUmgr is a tool that can be used to upload SUIT envelopes through the SMP protocol.
+For more information on MCUmgr installation, see :ref:`zephyr:mcu_mgr`.


Suggested change

For a SUIT update over UART, you need to install MCUmgr.

MCUmgr is a tool that can be used to upload SUIT envelopes through the SMP protocol.

For more information on MCUmgr installation, see :ref:`zephyr:mcu_mgr`.

For a SUIT update over UART, you need to install :ref:`zephyr:mcu_mgr`, a tool that can be used to upload SUIT envelopes through the SMP protocol.

Shorter suggestion, nothing wrong with the original.

greg-fer · 2024-06-04T12:35:32Z

samples/suit/smp_transfer/README.rst

+LED 1:
+    The number of blinks indicates the application SUIT envelope sequence number.
+    The default is set to ``1`` to blink once, indicating "Version 1".


I think we can apply here the rules Bartek posted after the meeting with Paal.

greg-fer · 2024-06-04T12:35:56Z

samples/suit/smp_transfer/README.rst

+
+The default configuration uses UART with sequence number 1 (shown as Version 1 in the nRF Device Manager app).
+To change the sequence number of the application, configure the :ref:`CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM` Kconfig option.
+This also changes the number of blinks on **LED 1** and sets the :ref:`sequence number <ug_suit_dfu_suit_manifest_elements>` of the SUIT :ref:`envelope <ug_suit_dfu_suit_concepts>`’s manifest.


Suggested change

This also changes the number of blinks on **LED 1** and sets the :ref:`sequence number <ug_suit_dfu_suit_manifest_elements>` of the SUIT :ref:`envelope <ug_suit_dfu_suit_concepts>`’s manifest.

This also changes the number of blinks on **LED 1** and sets the :ref:`sequence number <ug_suit_dfu_suit_manifest_elements>` of the :ref:`SUIT envelope <ug_suit_dfu_suit_concepts>`'s manifest.

greg-fer · 2024-06-04T12:37:16Z

samples/suit/smp_transfer/README.rst

+To change the sequence number of the application, configure the :ref:`CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM` Kconfig option.
+This also changes the number of blinks on **LED 1** and sets the :ref:`sequence number <ug_suit_dfu_suit_manifest_elements>` of the SUIT :ref:`envelope <ug_suit_dfu_suit_concepts>`’s manifest.
+
+To use this configuration, build the sample with sysbuild and set the ``SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM`` Sysbuild Kconfig option to ``x``, where ``x`` is the version number.


Suggested change

To use this configuration, build the sample with sysbuild and set the ``SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM`` Sysbuild Kconfig option to ``x``, where ``x`` is the version number.

To use this configuration, build the sample with :ref:`configuration_system_overview_sysbuild` and set the ``SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM`` Sysbuild Kconfig option to ``x``, where ``x`` is the version number.

greg-fer · 2024-06-04T12:38:14Z

samples/suit/smp_transfer/README.rst

+* To modify the DFU partition, modify the values for ``dfu_partition`` defined in :file:`samples/suit/smp_transfer/boards/nrf54h20dk_nrf54h20_cpuapp.overlay`.
+
+    * ``dfu_partition`` is where the update candidate is stored before the update process begins.


Suggested change

* To modify the DFU partition, modify the values for ``dfu_partition`` defined in :file:`samples/suit/smp_transfer/boards/nrf54h20dk_nrf54h20_cpuapp.overlay`.

* ``dfu_partition`` is where the update candidate is stored before the update process begins.

* To modify the DFU partition, modify the values for ``dfu_partition`` defined in :file:`samples/suit/smp_transfer/boards/nrf54h20dk_nrf54h20_cpuapp.overlay`.

This partition is where the update candidate is stored before the update process begins.

This is a nit.
If the intention is to highlight the importance of this partition, then maybe you can add this entry between lines 94 and 95, in a list that describes the purpose of both this partition and cpuapp_slot0_partition? Just a suggestion.

greg-fer · 2024-06-04T12:50:55Z

samples/suit/smp_transfer/README.rst

+         .. note::
+
+            |application_sample_long_path_windows|
+
+            In this case, you may need to run the following instead:
+
+            .. code-block:: console
+
+               west build -p -b nrf54h20dk/nrf54h20/cpuapp -d C:/ncs-lcs/work-dir --sysbuild -- -SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2


Hm, would it be possible to post this note at the beginning of the procedure once, with some generic information, instead of repeating it 5 times within the same procedure? I know the command is different each time, but also what is critical for this information -- -d <path> -- stays the same.

tomchy · 2024-06-04T13:20:29Z

samples/suit/smp_transfer/README.rst

+
+Check and configure the following configuration option for the sample:
+
+.. _CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM:


If you use a dedicated format for sysbuild Kconfigs, please apply it here.

tomchy · 2024-06-04T13:23:57Z

doc/nrf/config_and_build/configuring_app/output_build_files.rst

+------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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.                                       |


This time build system produced root_with_binary_nordic_top.yaml.jinja2 instead.
Feel free to update or leave it as is. I think we will make one more round later to double check all of the names, paths etc.

Okay, will change it, and make a note for all of us to review this table. @richabp Just FYI

Add README page for SUIT SMP sample Signed-off-by: Katherine Depa <[email protected]>

kittydepa added the DNM label May 14, 2024

kittydepa requested review from tomchy and ahasztag as code owners May 14, 2024 07:30

github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels May 14, 2024

kittydepa force-pushed the doc_add_suit_smp_readme branch from c7692d3 to 600a9db Compare May 14, 2024 07:33

kittydepa requested a review from greg-fer as a code owner May 14, 2024 07:33

tomchy requested changes May 14, 2024

View reviewed changes

kittydepa force-pushed the doc_add_suit_smp_readme branch from 600a9db to fdc3f09 Compare May 14, 2024 11:36

kittydepa requested a review from carlescufi as a code owner May 14, 2024 11:36

kittydepa commented May 14, 2024

View reviewed changes

samples/suit/smp_transfer/README.rst Outdated Show resolved Hide resolved

kittydepa force-pushed the doc_add_suit_smp_readme branch from fdc3f09 to 7e3c404 Compare May 14, 2024 11:39

kittydepa requested a review from tomchy May 14, 2024 11:39

kittydepa force-pushed the doc_add_suit_smp_readme branch 2 times, most recently from 3a806de to 9c229fa Compare May 14, 2024 11:46

kittydepa commented May 14, 2024

View reviewed changes

samples/suit/smp_transfer/README.rst Outdated Show resolved Hide resolved

kittydepa force-pushed the doc_add_suit_smp_readme branch 3 times, most recently from de30f28 to e8757d6 Compare May 15, 2024 06:43

kittydepa requested a review from richabp May 15, 2024 07:24

kittydepa added this to the 2.7.0 milestone May 15, 2024

kittydepa force-pushed the doc_add_suit_smp_readme branch 2 times, most recently from ff2b1f5 to 2d97476 Compare May 16, 2024 08:06

richabp approved these changes May 16, 2024

View reviewed changes

kittydepa removed changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. DNM labels May 16, 2024

tomchy requested changes May 20, 2024

View reviewed changes

kittydepa force-pushed the doc_add_suit_smp_readme branch from 2d97476 to 4b43095 Compare May 21, 2024 06:52

greg-fer requested changes May 21, 2024

View reviewed changes

kittydepa force-pushed the doc_add_suit_smp_readme branch from 1f1dc1f to fdf8a59 Compare May 23, 2024 09:44

kittydepa force-pushed the doc_add_suit_smp_readme branch 3 times, most recently from 5e4bae7 to 73f4965 Compare May 24, 2024 12:00

kittydepa requested review from tomchy and greg-fer May 24, 2024 12:01

kittydepa added DNM and removed changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels May 24, 2024

kittydepa force-pushed the doc_add_suit_smp_readme branch from 73f4965 to fe9bccd Compare May 24, 2024 12:26

github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label May 24, 2024

kittydepa force-pushed the doc_add_suit_smp_readme branch 2 times, most recently from b36bd5b to fdd2fe2 Compare May 24, 2024 13:43

greg-fer reviewed May 28, 2024

View reviewed changes

kittydepa force-pushed the doc_add_suit_smp_readme branch from fdd2fe2 to ec521fc Compare June 3, 2024 09:43

kittydepa requested a review from greg-fer June 3, 2024 09:43

kittydepa removed DNM changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jun 4, 2024

greg-fer approved these changes Jun 4, 2024

View reviewed changes

tomchy approved these changes Jun 4, 2024

View reviewed changes

kittydepa force-pushed the doc_add_suit_smp_readme branch from ec521fc to fa0199d Compare June 4, 2024 16:00

github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jun 4, 2024

kittydepa removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jun 4, 2024

kittydepa force-pushed the doc_add_suit_smp_readme branch from fa0199d to e779763 Compare June 4, 2024 19:04

github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jun 4, 2024

doc: add suit SMP readme

16f63e1

Add README page for SUIT SMP sample Signed-off-by: Katherine Depa <[email protected]>

kittydepa force-pushed the doc_add_suit_smp_readme branch from e779763 to 16f63e1 Compare June 5, 2024 07:45

rlubos merged commit e553c49 into nrfconnect:main Jun 5, 2024
13 checks passed

	The default configuration uses UART with Version 1.
	The default configuration uses UART with sequence number 1 (shown as Version 1 in the nRF Connect Device Manager app).


		west build -p -b nrf54h20dk/nrf54h20/cpuapp --sysbuild -- -DCONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2

		If you do not specify this configuration, the sample is built with Version 1.


		.. _CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM:

		CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM - Configuration for the application version


		If you want to further configure your sample, see :ref:`configure_application` for additional information.

		After running the ``west build`` command, the output build files can be found in the :file:`build/zephyr` directory.


		.. code-block:: console

		west build -p -b nrf54h20dk/nrf54h20/cpuapp -d C:\ncs-lcs\west_working_dir\build\


		.. group-tab:: Over Bluetooth Low Energy

		1. Update the envelope sequence number:

		MCUmgr is a tool that can be used to upload SUIT envelopes through the SMP protocol.
		For more information on MCUmgr installation, see :ref:`zephyr:mcu_mgr`.

	The sample uses one of the following to perform an update on the nRF54H20 SoC, featuring Nordic Semiconductor’s implementation of the SUIT procedure:
	The sample uses one of the following methods to perform a firmware update on the nRF54H20 SoC, featuring Nordic Semiconductor’s implementation of the SUIT procedure:

	To use this configuration, include the ``SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=x`` option with the build command, where x is the version number.
	To use this configuration, build the sample with sysbuild and set the ``SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM`` Sysbuild Kconfig option to `x`, where `x` is the version number.

	#. Select the device SUIT SMP Sample. You should see the following:
	#. Select the device SUIT SMP Sample.
	You should see the following:


		.. _nrf54h_suit_sample:

		SUIT DFU: Firmware update on the nRF54H20 SoC

	SUIT DFU: Firmware update on the nRF54H20 SoC
	SUIT: Device firmware update on the nRF54H20 SoC

	This also changes the number of blinks on LED 1 and sets the :ref:`sequence number <ug_suit_dfu_suit_manifest_elements>` of the SUIT :ref:`envelope <ug_suit_dfu_suit_concepts>`’s manifest.
	This also changes the number of blinks on LED 1 and sets the :ref:`sequence number <ug_suit_dfu_suit_manifest_elements>` of the :ref:`SUIT envelope <ug_suit_dfu_suit_concepts>`'s manifest.

		* To modify the DFU partition, modify the values for ``dfu_partition`` defined in :file:`samples/suit/smp_transfer/boards/nrf54h20dk_nrf54h20_cpuapp.overlay`.

		* ``dfu_partition`` is where the update candidate is stored before the update process begins.


		Check and configure the following configuration option for the sample:

		.. _CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM:

doc: add suit SMP readme #15287

doc: add suit SMP readme #15287

Conversation

kittydepa commented May 14, 2024

NordicBuilder commented May 14, 2024 • edited Loading

Test specification

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NordicBuilder commented May 15, 2024

Choose a reason for hiding this comment

kittydepa May 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kittydepa May 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kittydepa commented May 23, 2024

greg-fer commented May 23, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greg-fer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomchy Jun 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NordicBuilder commented May 14, 2024 •

edited

Loading

kittydepa May 21, 2024 •

edited

Loading

kittydepa May 22, 2024 •

edited

Loading

tomchy Jun 4, 2024 •

edited

Loading