You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_suit_recovery.rst
+3-7Lines changed: 3 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,11 +52,11 @@ The following image shows the recovery manifest topology for the nRF54H20 SoC:
52
52
If a failure during a boot process occurred, the Secure Domain sets the recovery flag and reboots the device.
53
53
Upon each boot the Secure Domain checks if the recovery flag is set.
54
54
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.
56
56
57
57
After entering the recovery mode it is verified if MPI configuration for the APP_RECOVERY is present.
58
58
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.
60
60
This is needed, as the device might enter recovery mode if it is empty.
61
61
The recovery flag is not cleared after flashing the firmware, but the device should proceed as if it would boot normally.
62
62
@@ -80,10 +80,6 @@ Nordic provides a default recovery firmware that can be used in the recovery pro
80
80
This firmware uses Bluetooth LE and SMP as a transport.
81
81
It is optimized for memory usage, currently using around 164 kB of MRAM (72 kB of application core and 92 kB radio core).
82
82
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
-
87
83
To use the firmware:
88
84
89
85
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:
95
91
This will cause the recovery firmware to be built automatically as part of the main application build.
96
92
97
93
#. :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.
99
95
100
96
#. 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.
101
97
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`.
Copy file name to clipboardExpand all lines: samples/suit/recovery/README.rst
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,10 @@ SUIT: Recovery application
10
10
The SUIT recovery application is a minimal application that allows recovering the device firmware if the original firmware is damaged.
11
11
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.
12
12
13
-
The following limitations apply to this application:
13
+
The following limitation applies to this application:
14
14
15
15
* The recovery firmware is only able to recover from a situation where the application or radio core are damaged.
16
16
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.
#. Open the nRF Device Manager app on your mobile phone, and observe the device now advertising itself as *SUIT Recovery*.
110
109
#. 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