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.

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

doc/dev_guides/nrf54l: added fota_update & KMU guides #18231

Merged
merged 1 commit into from
Nov 8, 2024
Merged

doc/dev_guides/nrf54l: added fota_update & KMU guides #18231

merged 1 commit into from
Nov 8, 2024
+322 −0

Conversation

nvlsianpu
Copy link
Contributor

@nvlsianpu nvlsianpu commented Oct 25, 2024 •
edited
Loading

Added fota_update guide for nRF54l15 SoC based on the nRF52 doc.

ref.: NCSDK-29601

gen doc review link: https://developer.nordicsemi.com/nRF_Connect_SDK_dev/doc/PR-18231/nrf/app_dev/device_guides/nrf54l/fota_update.html

@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 Oct 25, 2024
@nvlsianpu nvlsianpu added this to the 2.8.0 milestone Oct 25, 2024
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Oct 25, 2024 •
edited
Loading

CI Information

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

Inputs:

Sources:

sdk-nrf: PR head: 62e5aa78bf66cb1abc7c2f051d76bc0f0cfcc829

more details

sdk-nrf:

PR head: 62e5aa78bf66cb1abc7c2f051d76bc0f0cfcc829
merge base: 4fff33072bdcc179d3c771e0c37961d4e14df4af
target head (main): c20613d2e787578c8dc2dd7ebc95aef6a1b165ec
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 (3) 
doc
│  ├── nrf
│  │  ├── app_dev
│  │  │  ├── device_guides
│  │  │  │  ├── nrf54l
│  │  │  │  │  ├── fota_update.rst
│  │  │  │  │  ├── index.rst
│  │  │  │  │  │ kmu_provision.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_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

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

annwoj
annwoj reviewed Oct 28, 2024
View reviewed changes
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
@nvlsianpu nvlsianpu force-pushed the doc_nrf54l_fota_guide branch 2 times, most recently from 82006b2 to 616a160 Compare October 29, 2024 05:50
@nvlsianpu nvlsianpu changed the title doc/dev_guides/nrf54l: added fota_update guide doc/dev_guides/nrf54l: added fota_update & KMU guide Oct 29, 2024
@nvlsianpu nvlsianpu changed the title doc/dev_guides/nrf54l: added fota_update & KMU guide doc/dev_guides/nrf54l: added fota_update & KMU guides Oct 29, 2024
@umapraseeda
Copy link
Contributor

@gmarull, any idea why there is doc build failure related to redirects.py checks?

@nvlsianpu nvlsianpu requested a review from a team as a code owner October 29, 2024 12:07
@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 29, 2024
@nvlsianpu nvlsianpu requested a review from a team as a code owner October 29, 2024 12:28
@nvlsianpu nvlsianpu force-pushed the doc_nrf54l_fota_guide branch 2 times, most recently from d663d90 to d5a16d0 Compare October 29, 2024 13:28
@nvlsianpu nvlsianpu requested a review from a team as a code owner October 29, 2024 13:28
@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.

@divipillai
Copy link
Contributor

If this PR requires a changelog entry, Please add a comment on PR #18192, after this PR is merged.

@divipillai divipillai added the backport v2.8-branch auto-create a PR with same commits to v2.8-branch label Nov 5, 2024
omkar3141
omkar3141 requested changes Nov 7, 2024
View reviewed changes
Copy link
Contributor

@omkar3141 omkar3141 left a comment

Choose a reason for hiding this comment

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

Some comments are still left.

doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated

.. note::
When performing a FOTA update with the iOS app for samples using random HCI identities, ensure that the :guilabel:`Erase application settings` option is deselected before starting the procedure.
Otherwise, the new image will boot with random IDs, causing communication issues between the app and the device.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not addressed.

doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated Show resolved Hide resolved
omkar3141
omkar3141 requested changes Nov 7, 2024
View reviewed changes
Copy link
Contributor

@omkar3141 omkar3141 left a comment

Choose a reason for hiding this comment

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

Forgot to mention about security related note.

doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Show resolved Hide resolved
@nvlsianpu nvlsianpu force-pushed the doc_nrf54l_fota_guide branch 4 times, most recently from db90bb6 to e9d852d Compare November 7, 2024 14:54
@annwoj annwoj requested a review from omkar3141 November 8, 2024 12:53
nordicjm
nordicjm approved these changes Nov 8, 2024
View reviewed changes
doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst

|fota_upgrades_def|
You can also use FOTA updates to replace the application.
See the :ref:`app_dfu` page for general Device Firmware Update (DFU) information, such as supported methods for sending and receiving updates on the device.
Copy link
Contributor

Choose a reason for hiding this comment

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

since someone asked about it already, might be an idea to mention only cpuapp updates are supported

doc/nrf/app_dev/device_guides/nrf54l/fota_update.rst Outdated
Comment on lines 230 to 231
Confirmation mark should not, however, be added when building update images.
These requirements are ensure by the build system.
Copy link
Contributor

Choose a reason for hiding this comment

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

would remove this, users don't need to know this (also ensured missing d)

doc/nrf/app_dev/device_guides/nrf54l/kmu_provision.rst Outdated
.. parsed-literal::
:class: highlight

./bootloader/mcuboot/scripts/imgtool.py keygen -k my_ed25519_priv_key.pem -t ed25519
Copy link
Contributor

@nordicjm nordicjm Nov 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

this assumes a (wrong) path, if they are using ncs or have installed it using pip then imgtool should be available globally without needing a path so this should be removed

omkar3141
omkar3141 approved these changes Nov 8, 2024
View reviewed changes
Copy link
Contributor

@omkar3141 omkar3141 left a comment

Choose a reason for hiding this comment

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

Looks reasonably good now.

@nvlsianpu
doc/dev_guides/nrf54l: added fota_update guide
62e5aa7 
Added fota_update guide for nRF54l15 SoC based on the nRF52 doc.

ref.: NCSDK-29601

Signed-off-by: Andrzej Puzdrowski <[email protected]>
Signed-off-by: Anna Wojdylo <[email protected]>
Signed-off-by: Omkar Kulkarni <[email protected]>
@rlubos rlubos merged commit 54f8a63 into nrfconnect:main Nov 8, 2024
13 checks passed
@NordicBuilder NordicBuilder mentioned this pull request Nov 8, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gchwier gchwier gchwier left review comments

@divipillai divipillai divipillai left review comments

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

@annwoj annwoj annwoj approved these changes

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

@nordicjm nordicjm nordicjm approved these changes

@omkar3141 omkar3141 omkar3141 approved these changes

Assignees
No one assigned
Labels
backport v2.8-branch auto-create a PR with same commits to v2.8-branch changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc only doc-required PR must not be merged without tech writer approval.
Projects
None yet
Milestone
2.8.0
Development

Successfully merging this pull request may close these issues.