Skip to content

bootutil: Add manifest-based loader for Direct XIP #2511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

bootutil: Add manifest-based loader for Direct XIP #2511

wants to merge 5 commits into from

Conversation

@tomchy
Copy link
Collaborator

@tomchy tomchy commented Oct 21, 2025 •
edited
Loading

Add a loader variant that is capable of booting images in Direct XIP mode, based on a simple manifest.

  • The manifest image, configured through MCUBOOT_MANIFEST_IMAGE_INDEX (slot pair) is the main/lead image - it describes firmware bundle for the device.
  • The firmware bundle description is provided in the protected TLV of the manifest image. Images relations are expressed as their hashes. Hash of the manifest image is not in the TLV as it covers it as well.

For more details, please take a look at updates inside the design.md file.

@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch 3 times, most recently from 6ebfcaf to aaf2a5a Compare October 21, 2025 14:10
tomchy
tomchy commented Oct 22, 2025
View reviewed changes
tomchy
tomchy commented Oct 22, 2025
View reviewed changes
@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch from aaf2a5a to d8e62ff Compare October 22, 2025 09:00
@tomchy tomchy marked this pull request as ready for review October 22, 2025 15:13
@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch from d8e62ff to 3688d72 Compare October 23, 2025 12:07
JarmouniA
JarmouniA reviewed Oct 23, 2025
View reviewed changes
Copy link
Contributor

@JarmouniA JarmouniA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we have some documentation for this feature? Thanks!

@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch from 3688d72 to 8eca34c Compare October 24, 2025 09:02
de-nordic
de-nordic reviewed Oct 28, 2025
View reviewed changes
tomchy
tomchy commented Oct 31, 2025
View reviewed changes
de-nordic
de-nordic requested changes Oct 31, 2025
View reviewed changes
@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch from 8eca34c to 34d235b Compare November 4, 2025 12:52
@tomchy
Copy link
Collaborator Author

tomchy commented Nov 4, 2025

Can we have some documentation for this feature? Thanks!

This feature definitely deserves a few words in the docs. Just keep in mind that:

  • This is marked as experimental, since this feature is not yet fully implemented.
  • This is 1/3 or even 1/4 of a solution - only Direct XIP mode is supported.
  • The review or further implementation process may introduce changes, that will make any early attempts to write documentation obsolete.

@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch from 34d235b to faed92a Compare November 4, 2025 14:26
@tomchy tomchy requested review from JarmouniA and de-nordic November 4, 2025 15:01
@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch 5 times, most recently from fbb5565 to 937c80a Compare November 7, 2025 11:33
@JarmouniA
Copy link
Contributor

JarmouniA commented Nov 7, 2025

This feature definitely deserves a few words in the docs. Just keep in mind that:

  • This is marked as experimental, since this feature is not yet fully implemented.
  • This is 1/3 or even 1/4 of a solution - only Direct XIP mode is supported.
  • The review or further implementation process may introduce changes, that will make any early attempts to write documentation obsolete.

Alternatively, you could expand the PR's description.

@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch 2 times, most recently from 37184b0 to 0a6ed81 Compare November 17, 2025 09:14
nvlsianpu
nvlsianpu reviewed Nov 17, 2025
View reviewed changes
@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch from 0a6ed81 to 81a6c5f Compare November 17, 2025 15:11
@tomchy tomchy requested a review from nvlsianpu November 17, 2025 15:18
de-nordic
de-nordic reviewed Nov 18, 2025
View reviewed changes
@tomchy
design: Fix UUID TLVs
7d0adc2 
Fix values presented in the design.md for UUID TLVs.

Signed-off-by: Tomasz Chyrowicz <[email protected]>
@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch from 81a6c5f to cd4c1c9 Compare November 18, 2025 18:46
@tomchy tomchy requested a review from de-nordic November 18, 2025 18:47
@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch from cd4c1c9 to 078bcd7 Compare November 18, 2025 18:52
@tomchy
boot: Add MCUboot manifest TLV
25a4ddd 
Add a possibility to attach a basic manifest with expected digests to an
image.
Alter the image verification logic, so only digests specified by the
manifest are allowed on the device.

Signed-off-by: Tomasz Chyrowicz <[email protected]>
@tomchy
imgtool: Add a possibility to attach manifest TLV
ae651c1 
Add a simple logic that allows to attach a manifest TLV to an image.

Signed-off-by: Tomasz Chyrowicz <[email protected]>
@tomchy
bootutil: Add manifest-based loader for Direct XIP
7488513 
Add a loader variant that is capable of booting images, based on a
simple manifest.

Signed-off-by: Tomasz Chyrowicz <[email protected]>
@tomchy
doc: Add manifest conceptual description
61956e5 
Add a short description about motivation behind manifest-based updates
and the Direct XIP mode of operation if the manifests are enabled.

Signed-off-by: Tomasz Chyrowicz <[email protected]>
@tomchy tomchy force-pushed the feature/mcuboot/NCSDK-NONE_Transaction_manifest_xip_upstream branch from 078bcd7 to 61956e5 Compare November 18, 2025 19:02
@tomchy
Copy link
Collaborator Author

tomchy commented Nov 18, 2025

This feature definitely deserves a few words in the docs. Just keep in mind that:

  • This is marked as experimental, since this feature is not yet fully implemented.
  • This is 1/3 or even 1/4 of a solution - only Direct XIP mode is supported.
  • The review or further implementation process may introduce changes, that will make any early attempts to write documentation obsolete.

Alternatively, you could expand the PR's description.

Description aligned, few paragraphs inside the design.md file added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nvlsianpu nvlsianpu nvlsianpu approved these changes

@de-nordic de-nordic de-nordic approved these changes

@nordicjm nordicjm Awaiting requested review from nordicjm nordicjm is a code owner

@almir-okato almir-okato Awaiting requested review from almir-okato almir-okato is a code owner

@davidvincze davidvincze Awaiting requested review from davidvincze davidvincze is a code owner

@d3zd3z d3zd3z Awaiting requested review from d3zd3z d3zd3z is a code owner

@JarmouniA JarmouniA Awaiting requested review from JarmouniA

+1 more reviewer

@michalek-no michalek-no michalek-no approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@tomchy @JarmouniA @nvlsianpu @de-nordic @michalek-no