Skip to content

Commit

Permalink
samples: suit: Documentation update
Browse files Browse the repository at this point in the history 
Correct build and test steps in the documentation.

Signed-off-by: Janusz Gąsior <[email protected]>
  • Loading branch information
@jnsgsr @anangl
jnsgsr authored and anangl committed Jun 28, 2024
1 parent 982feac commit fff8022
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 66 deletions.
2 changes: 1 addition & 1 deletion doc/nrf/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_external_memory.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ To enable the external memory, you must add the ``-DFILE_SUFFIX="extflash"`` arg
west build -b nrf54h20dk/nrf54h20/cpuapp
west flash
The build system will automatically use :ref:`configuration_system_overview_sysbuild` and generate a :file:`build/dfu_suit.zip` archive, which contains the SUIT envelope and candidate images.
The build system will automatically use :ref:`configuration_system_overview_sysbuild` and generate a :file:`build/zephyr/dfu_suit.zip` archive, which contains the SUIT envelope and candidate images.

#. Build a new version of the application with the incremented ``SB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM`` value.

Expand Down
70 changes: 5 additions & 65 deletions samples/suit/smp_transfer/README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ For example:

.. code-block:: console
west build -p -b nrf54h20dk/nrf54h20/cpuapp -- -DSB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2
west build -b nrf54h20dk/nrf54h20/cpuapp -- -DSB_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).

Expand Down Expand Up @@ -154,15 +154,6 @@ To build and program the sample to the nRF54H20 DK, complete the following steps
west build -p -b nrf54h20dk/nrf54h20/cpuapp -- -DFILE_SUFFIX=bt -DSB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=1
.. 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 -- -DFILE_SUFFIX=bt -DSB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=1
The output build files can be found in the :file:`build/DFU` directory, including the :ref:`app_build_output_files_suit_dfu`.
For more information on the contents of the build directory, see :ref:`zephyr:build-directory-contents` in the Zephyr documentation.
Expand All @@ -171,32 +162,11 @@ To build and program the sample to the nRF54H20 DK, complete the following steps
#. Connect the DK to your computer using a USB cable.
#. Power on the DK.
#. Program the sample to the kit (see :ref:`programming_cmd` for instructions).

.. note::

|application_sample_long_path_windows|

In this case, you may need to run the following instead:

.. code-block:: console
west flash --erase -d C:/ncs-lcs/work-dir
#. Update the SUIT envelope sequence number, by rebuilding the sample with an updated sequence number:

.. code-block:: console
west build -p -b nrf54h20dk/nrf54h20/cpuapp -- -DFILE_SUFFIX=bt -DSB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2
.. 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 -- -DFILE_SUFFIX=bt -DSB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2
west build -b nrf54h20dk/nrf54h20/cpuapp -- -DFILE_SUFFIX=bt -DSB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2
Another :file:`root.suit` file is created after running this command, that contains the updated firmware.
You must manually transfer this file onto the same mobile device you will use with the nRF Device Manager app.
Expand All @@ -210,16 +180,6 @@ To build and program the sample to the nRF54H20 DK, complete the following steps
west build -p -b nrf54h20dk/nrf54h20/cpuapp
.. 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\west_working_dir\build\
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/dfu` directory.
Expand All @@ -230,32 +190,12 @@ To build and program the sample to the nRF54H20 DK, complete the following steps
#. Connect the DK to your computer using a USB cable.
#. Power on the DK.
#. Program the sample to the kit (see :ref:`programming_cmd` for instructions).

.. note::

|application_sample_long_path_windows|

In this case, you may need to run the following instead:

.. code-block:: console
west flash --erase -d C:/ncs-lcs/work-dir
#. Update the SUIT envelope sequence number, by rebuilding the sample with an updated sequence number:

.. code-block:: console
west build -p -b nrf54h20dk/nrf54h20/cpuapp -- -DSB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2
.. note::

|application_sample_long_path_windows|

In this case, you may need to run the following instead:

.. code-block:: console
west build -b nrf54h20dk/nrf54h20/cpuapp -- -DSB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2
west build -p -b nrf54h20dk/nrf54h20/cpuapp -d C:/ncs-lcs/work-dir -- -DSB_CONFIG_SUIT_ENVELOPE_SEQUENCE_NUM=2
Another :file:`root.suit` file is created after running this command, that contains the updated firmware.

Expand Down Expand Up @@ -348,7 +288,7 @@ After programming the sample to your development kit and updating the sequence n

.. code-block:: console
mcumgr --conntype serial --connstring "dev=/dev/ttyACM0,baud=115200,mtu=512" image upload root.suit
mcumgr --conntype serial --connstring "dev=/dev/ttyACM0,baud=115200" image upload build/DFU/root.suit
You should see an output similar to the following logged on UART:

Expand All @@ -368,7 +308,7 @@ After programming the sample to your development kit and updating the sequence n

.. code-block:: console
mcumgr --conntype serial --connstring "dev=/dev/ttyACM0,baud=115200,mtu=512" image list
mcumgr --conntype serial --connstring "dev=/dev/ttyACM0,baud=115200" image list
You should see an output similar to the following logged on UART:
Expand Down

0 comments on commit fff8022

Please sign in to comment.