doc: SUIT recovery and customize DFU update #19686
Open
+7
−12
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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]>
github-actions
bot
added
doc-required
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:sdk-nrf: PR head: 117a7a6df047cba5bd34f549f59ade18883e24cb more detailssdk-nrf:
Github labels
List of changed files detected by CI (3)Outputs:ToolchainVersion: Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
|
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 Publish GitHub Action. |
FrancescoSer
requested changes
Dec 23, 2024
| @@ -195,7 +195,7 @@ Specifically, in the basic case: | |||
| * :kconfig:option:`SB_CONFIG_SUIT_MPI_RAD_LOCAL_1_CLASS_NAME` | |||
|
|
|||
| These Kconfig options are used during Manifest Provisioning Information (MPI) generation. | |||
| 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, | |||
| 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. | |||
There was a problem hiding this comment.
Suggested change
| 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. | |
| 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. |
| @@ -52,11 +52,11 @@ The following image shows the recovery manifest topology for the nRF54H20 SoC: | |||
| If a failure during a boot process occurred, the Secure Domain sets the recovery flag and reboots the device. | |||
| Upon each boot the Secure Domain checks if the recovery flag is set. | |||
| If it is set, the device enters recovery mode. | |||
| If it isn't booting proceeds normally by running the root manifest. | |||
| If it isn't, booting proceeds normally by running the root manifest. | |||
There was a problem hiding this comment.
Suggested change
| If it isn't, booting proceeds normally by running the root manifest. | |
| If it is not, the boot process continues normally by executing the root manifest. |
|
|
||
| After entering the recovery mode it is verified if MPI configuration for the APP_RECOVERY is present. | ||
| If it is, the APP_RECOVERY manifest is processed. | ||
| It no MPI configuration is found the Secure Domain performs an attempt to process the normal manufacturer root manifest. | ||
| If no MPI configuration is found the Secure Domain performs an attempt to process the normal manufacturer root manifest. |
There was a problem hiding this comment.
Suggested change
| If no MPI configuration is found the Secure Domain performs an attempt to process the normal manufacturer root manifest. | |
| If no MPI configuration is found, the Secure Domain attempts to process the normal manufacturer root manifest. |
| @@ -95,7 +91,7 @@ To use the firmware: | |||
| This will cause the recovery firmware to be built automatically as part of the main application build. | |||
|
|
|||
| #. :ref:`Program the main application firmware to the device <programming>`. | |||
| This will automatically program both the main application and the recovery firmware to the device. | |||
| This will automatically program both the main application and the recovery firmware to the device. | |||
There was a problem hiding this comment.
Suggested change
| This will automatically program both the main application and the recovery firmware to the device. | |
| This automatically programs both the main application and the recovery firmware onto the device. |
| @@ -10,11 +10,10 @@ SUIT: Recovery application | |||
| The SUIT recovery application is a minimal application that allows recovering the device firmware if the original firmware is damaged. | |||
| 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. | |||
|
|
|||
| The following limitations apply to this application: | |||
| The following limitation apply to this application: | |||
There was a problem hiding this comment.
Suggested change
| The following limitation apply to this application: | |
| The following limitation applies to this application: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.