Skip to content

Commit b4e177c

Browse files
nordic-mik7degjorva
authored andcommitted
doc: SUIT recovery and customize DFU update
This commit introduces changes to docs regarding SUIT recovery sample and recovery guide. Support for recovery app configuration with external flash was added recently. Also, minor change to Customization DFU guide was added. Signed-off-by: Michal Kozikowski <[email protected]>
1 parent 5f61d65 commit b4e177c

File tree

3 files changed

+7
-12
lines changed

3 files changed

+7
-12
lines changed

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_suit_customize_dfu.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ Specifically, in the basic case:
195195
* :kconfig:option:`SB_CONFIG_SUIT_MPI_RAD_LOCAL_1_CLASS_NAME`
196196

197197
These Kconfig options are used during Manifest Provisioning Information (MPI) generation.
198-
After the MPI has been flashed, it is read by the Secure Domain Firmware, which can then use it to verify if the UUIDs in a manifest are correct,
198+
Once the MPI has been flashed, it is read by the SDFW, which uses it to verify the correctness of the UUIDs in the manifest.
199199

200200
As an example, after adding the following lines to the :file:`sysbuild.conf` file:
201201

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_suit_recovery.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ The following image shows the recovery manifest topology for the nRF54H20 SoC:
5252
If a failure during a boot process occurred, the Secure Domain sets the recovery flag and reboots the device.
5353
Upon each boot the Secure Domain checks if the recovery flag is set.
5454
If it is set, the device enters recovery mode.
55-
If it isn't booting proceeds normally by running the root manifest.
55+
If it is not, the boot process continues normally by executing the root manifest.
5656

5757
After entering the recovery mode it is verified if MPI configuration for the APP_RECOVERY is present.
5858
If it is, the APP_RECOVERY manifest is processed.
59-
It no MPI configuration is found the Secure Domain performs an attempt to process the normal manufacturer root manifest.
59+
If no MPI configuration is found, the Secure Domain attempts to process the normal manufacturer root manifest.
6060
This is needed, as the device might enter recovery mode if it is empty.
6161
The recovery flag is not cleared after flashing the firmware, but the device should proceed as if it would boot normally.
6262

@@ -80,10 +80,6 @@ Nordic provides a default recovery firmware that can be used in the recovery pro
8080
This firmware uses Bluetooth LE and SMP as a transport.
8181
It is optimized for memory usage, currently using around 164 kB of MRAM (72 kB of application core and 92 kB radio core).
8282

83-
.. caution::
84-
The default recovery firmware does not support :ref:`updating from external flash memory <ug_nrf54h20_suit_external_memory>`.
85-
This also means that the recovery firmware is not compatible with a main application that uses external flash for updates.
86-
8783
To use the firmware:
8884

8985
1. Create :file:`recovery.overlay` and :file:`recovery_hci_ipc.ovelay` files in the main application's :ref:`configuration_system_overview_sysbuild` directory.
@@ -95,7 +91,7 @@ To use the firmware:
9591
This will cause the recovery firmware to be built automatically as part of the main application build.
9692

9793
#. :ref:`Program the main application firmware to the device <programming>`.
98-
This will automatically program both the main application and the recovery firmware to the device.
94+
This automatically programs both the main application and the recovery firmware onto the device.
9995

10096
#. To update the recovery firmware perform an update in the same way as described in :ref:`nrf54h_suit_sample`, however using the recovery firmware envelope.
10197
The envelopes needed for the update are located in the build directory of the main application, by default found in :file:`build/DFU/app_recovery.suit` and :file:`build/DFU/rad_recovery.suit`.

samples/suit/recovery/README.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,10 @@ SUIT: Recovery application
1010
The SUIT recovery application is a minimal application that allows recovering the device firmware if the original firmware is damaged.
1111
It is to be used as a companion firmware to the main application that is using :ref:`Software Update for Internet of Things (SUIT) <ug_nrf54h20_suit_intro>` procedure, rather than a stand-alone application.
1212

13-
The following limitations apply to this application:
13+
The following limitation applies to this application:
1414

1515
* The recovery firmware is only able to recover from a situation where the application or radio core are damaged.
1616
It does not recover from Nordic Semiconductor-controlled firmware failures.
17-
* The recovery firmware is not compatible with a main application that uses an external flash for update.
1817

1918
.. _suit_recovery_reqs:
2019

@@ -98,13 +97,13 @@ Testing
9897

9998
.. code-block:: console
10099
101-
nrfutil device x-write --address 0xE0BA000 --value 0xFFFF --serial-number <segger_id>
100+
nrfutil device x-write --address 0xE0B7000 --value 0xFFFF --serial-number <dk_serial_number>
102101
103102
#. Reset the device to enter the recovery path:
104103

105104
.. code-block:: console
106105
107-
nrfutil device reset --serial-port COM7
106+
nrfutil device reset --serial-number <dk_serial_number>
108107
109108
#. Open the nRF Device Manager app on your mobile phone, and observe the device now advertising itself as *SUIT Recovery*.
110109
#. Recover the application using the nRF Device Manager app to perform an update, following the process outlined in the :ref:`nrf54h_suit_sample` sample documentation.

0 commit comments

Comments
 (0)