Skip to content
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

Merged
merged 1 commit into from
Oct 8, 2024

Conversation

ahasztag
Copy link
Contributor

Added the documnetation regarding updating of Nordic Semiconductor provided firmware components.

@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Sep 20, 2024
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Sep 20, 2024

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 19

Inputs:

Sources:

sdk-nrf: PR head: 76622b12e47b123291192738b2e93a7234d95fad

more details

sdk-nrf:

PR head: 76622b12e47b123291192738b2e93a7234d95fad
merge base: f0654346b9c7b64482740b1ee730641f2470410b
target head (main): 18d7fd830f9293d5ce95ae70a70313b177257d03
Diff

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (4)
doc
│  ├── nrf
│  │  ├── app_dev
│  │  │  ├── device_guides
│  │  │  │  ├── working_with_nrf
│  │  │  │  │  ├── nrf54h
│  │  │  │  │  │  ├── ug_nrf54h20_suit_customize_qsg.rst
│  │  │  │  │  │  ├── ug_nrf54h20_suit_dfu.rst
│  │  │  │  │  │  │ ug_nrf54h20_suit_soc_binaries.rst
│  │  ├── releases_and_maturity
│  │  │  ├── releases
│  │  │  │  │ release-notes-changelog.rst

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test_ble_nrf_config
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-ble_samples
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-chip
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_cloud
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_lwm2m
    • test-fw-nrfconnect-nrf-iot_mosh
    • test-fw-nrfconnect-nrf-iot_nrf_provisioning
    • test-fw-nrfconnect-nrf-iot_positioning
    • test-fw-nrfconnect-nrf-iot_samples
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • test-fw-nrfconnect-nrf-iot_thingy91
    • test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-proprietary_esb
    • test-fw-nrfconnect-ps
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread
    • test-fw-nrfconnect-zigbee
    • test-low-level
    • test-sdk-audio
    • test-sdk-dfu
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-sidewalk
    • test-sdk-wifi
    • test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

@NordicBuilder
Copy link
Contributor

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.

Copy link
Contributor

@maciejpietras maciejpietras left a 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.

@ahasztag ahasztag force-pushed the NCSDK-29004_nordic_top_doc branch 3 times, most recently from bf001b9 to e2869c5 Compare September 23, 2024 13:23
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.
Copy link
Contributor

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.

Copy link
Contributor Author

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.
Copy link
Contributor

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.

Copy link
Contributor Author

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
Copy link
Contributor

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

Copy link
Contributor Author

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

@@ -0,0 +1,71 @@
.. _ug_nrf54h20_suit_soc_binaries:
Copy link
Contributor

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@ahasztag ahasztag force-pushed the NCSDK-29004_nordic_top_doc branch 4 times, most recently from 98503f4 to 17b0ab8 Compare October 7, 2024 08:02
@ahasztag ahasztag requested a review from a team as a code owner October 8, 2024 08:13
@github-actions github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Oct 8, 2024
Added the documnetation regarding updating of Nordic Semiconductor
provided firmware components.

Signed-off-by: Artur Hadasz <artur.hadasz@nordicsemi.no>
@rlubos rlubos merged commit f91a247 into nrfconnect:main Oct 8, 2024
13 checks passed
@ahasztag ahasztag deleted the NCSDK-29004_nordic_top_doc branch November 4, 2024 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants