doc: nrf: app_dev: bootloaders_dfu: Add sysbuild image ID docs #18152
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
github-actions
bot
added
doc-required
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:more detailsGithub labels
List of changed files detected by CI (0)Outputs:ToolchainVersion: Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
|
@greg-fer would you be able to have a quick once over of this documentation? I've disabled the doc build as it requires a previous PR to be merged for the Kconfig options |
nordicjm
force-pushed
the
imageiddoc
branch
3 times, most recently
from
def9e51
to
eef2e3d
Compare
|
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. |
nordicjm
removed
the
changelog-entry-required
annwoj
reviewed
Oct 28, 2024
github-actions
bot
added
the
changelog-entry-required
nordicjm
added
backport v2.8-branch
annwoj
reviewed
Oct 29, 2024
greg-fer
requested changes
Oct 29, 2024
Comment on lines
+51
to
+54
|
|
||
| .. _sysbuild_assigned_images_ids_mcuboot_only: |
There was a problem hiding this comment.
Suggested change
| .. _sysbuild_assigned_images_ids_mcuboot_only: | |
| See :ref:`configuring_kconfig` for information about how to configure these options. | |
| .. _sysbuild_assigned_images_ids_mcuboot_only: |
| This setup supports features like shared secondary slots. | ||
| Currently, MCUboot uses this capability to update itself, which can be enabled with secure boot. | ||
| MCUboot then shares the main application's secondary slot for firmware updates. | ||
| However, it directly transfers the update to the designated MCUboot image slot, which is then booted by |NSIB|. |
There was a problem hiding this comment.
Suggested change
| However, it directly transfers the update to the designated MCUboot image slot, which is then booted by |NSIB|. | |
| However, it directly transfers the update to the designated MCUboot image slot, which is then booted by :ref:`bootloader`. |
| *********************************** | ||
|
|
||
| When building with sysbuild, the image IDs are provided to the application through Kconfig values and can be used in the code as needed. | ||
| These image IDs are also used in |NCS| hooks for tasks such as nRF5340 network core updates, so no additional configuration is required. |
There was a problem hiding this comment.
Is this an allusion to https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/device_guides/nrf53/serial_recovery.html ? Can we link there?
Suggested change
| These image IDs are also used in |NCS| hooks for tasks such as nRF5340 network core updates, so no additional configuration is required. | |
| These image IDs are also used in |NCS| hooks for various tasks (such as :ref:`nRF5340 network core updates <ug_nrf5340_serial_recovery>`), so no additional configuration is required. |
or maybe to https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/device_guides/nrf53/simultaneous_multi_image_dfu_nrf5340.html ? (In such case, the ref is ug_nrf5340_multi_image_dfu.)
There was a problem hiding this comment.
Fixed to second link
| If the version in the update is lower than the current version, MCUboot will reject the update and not transfer it to the opposing secure boot firmware slot. | ||
|
|
||
| Additionally, make sure to load the correct update image onto the device. | ||
| If MCUboot is currently running from the s0 slot, then you must use the s1 update, and if it is running from the s1 slot, then you must use the s0 update. |
There was a problem hiding this comment.
Suggested change
| If MCUboot is currently running from the s0 slot, then you must use the s1 update, and if it is running from the s1 slot, then you must use the s0 update. | |
| If MCUboot is currently running from the `s0` slot, then you must use the `s1` update, and if it is running from the `s1` slot, then you must use the `s0` update. |
There was a problem hiding this comment.
Fixed, assuming these should have been ``
Adds documentation describing this feature Signed-off-by: Jamie McCrae <[email protected]>
github-actions
bot
added
the
changelog-entry-required
annwoj
approved these changes
Oct 29, 2024
greg-fer
approved these changes
Oct 29, 2024
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.
Adds documentation describing this feature