-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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.
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
doc: SUIT documentation on updating Nordic Bundles #17417
Conversation
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:sdk-nrf: PR head: 76622b12e47b123291192738b2e93a7234d95fad more detailssdk-nrf:
Github labels
List of changed files detected by CI (4)
Outputs:ToolchainVersion: Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
f1f08b4
to
fabde1b
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would be good to describe pros and cons of both solutions. Separate update needs less MRAM for DFU so it's worth to mention it. Disadvantage of this approach is a responsibility on customer side to manage compatibility between App/radio and Nordic bundle.
I would also consider adding this page as a part of https://developer.nordicsemi.com/nRF_Connect_SDK_dev/doc/PR-17417/nrf/samples/suit/smp_transfer/README.html instead of dedicated page.
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
bf001b9
to
e2869c5
Compare
Updating the Nordic components separately from the manufacturer application | ||
=========================================================================== | ||
|
||
Updating the Nordic components separately from the manufacturer application is done by performing two separate updates. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To my understanding this sentence is not correct - updating Nordic components is done through a single update, but the update of the whole device (incl. manufacturer application) is done in two steps.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After reading that the sentence indeed might sound confusing. Modified that.
|
||
Replace `<NORDIC_TOP_DIRECTORY>` with the path to the directory containing the extracted nordic_top.suit file. | ||
|
||
3. Use the ``build/DFU/root.suit`` file generated by the build system to update both the manufacturer application and the Nordic Semiconductor firmware components. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please either add advantages/drawbacks here too or make a separate section that compares those two methods.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, at first I wanted to avoid duplication, but I didn't have an idea how to do a "comparison" in a nice way, so I simply copied the pros/cons, switched them, and reworded them in the second section
|
||
Apart from the manufacturer application, the devices also contain the Nordic Semiconductor provided components of the firmware, which are used to provide basic functionalities and security features. | ||
|
||
These components are provided in the form of the so called "nRF54h20 SOC binaries", which can be found in https://files.nordicsemi.com/ui/repos/tree/General/SDSC |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a link to the new ABI compatibility page? It indicates the compatibility between NCS versions and soc binaries versions
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is already done
e2869c5
to
69e3cc6
Compare
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_customize_qsg.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_dfu.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
a786c04
to
89e68df
Compare
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_customize_qsg.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_nordic_bundles.rst
Outdated
Show resolved
Hide resolved
3d988dc
to
6319a5a
Compare
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_dfu.rst
Outdated
Show resolved
Hide resolved
@@ -0,0 +1,71 @@ | |||
.. _ug_nrf54h20_suit_soc_binaries: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please edit also the filename to match the shortcut
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_customize_qsg.rst
Outdated
Show resolved
Hide resolved
98503f4
to
17b0ab8
Compare
17b0ab8
to
8f294e5
Compare
doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_suit_soc_binaries.rst
Outdated
Show resolved
Hide resolved
6049f27
to
2bbcdd7
Compare
Added the documnetation regarding updating of Nordic Semiconductor provided firmware components. Signed-off-by: Artur Hadasz <artur.hadasz@nordicsemi.no>
2bbcdd7
to
76622b1
Compare
Added the documnetation regarding updating of Nordic Semiconductor provided firmware components.