nRF5340 external-xip DFU sample #13509

nvlsianpu · 2023-12-22T16:29:01Z

This PR is for introducing support for external-xip sample and basic support for nRF5340.
This brings work which was hosted in https://github.com/NordicPlayground/ncs-nrf5340-xip-app/tree/main/smp_svr to the NCS.

the sample is support using childimage. It will be migrated to sysbuild after the NCS 2.6.0 by my team.
there are many issues on multi-image DFU support. These issues are planed to be solved one by one in iteratively manner. Most of issues I know are threaten independently from this sample - they are on parallel track in roadmap.
sum-up is that: this sample is experimental sample.

external-xip documentation PR

NordicBuilder · 2023-12-22T16:58:29Z

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.

NordicBuilder · 2024-01-02T10:16:55Z

Test specification

CI/Jenkins/NRF

Integration Platforms

CI/Jenkins/integration

Test Module	File based changes	Manually selected	West overwrite
test-fw-nrfconnect-boot	X
test-fw-nrfconnect-chip	X
test-fw-nrfconnect-fw-update	X
test-fw-nrfconnect-zigbee	X
test-sdk-find-my	X
test-sdk-sidewalk	X

Detailed information of selected test modules

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

nvlsianpu · 2024-01-11T16:16:19Z

samples/nrf5340/smp_svr/CMakeLists.txt

+
+project(smp_svr)
+
+target_sources(app PRIVATE src/main.c)


[RFC]: Zephyr original source code might be included into that build instead of their copies.
Should that way be used?

target_sources(app PRIVATE $ENV{ZEPHYR_BASE}/samples/subsys/mgmt/mcumgr/smp_svr/src/main.c) target_sources_ifdef(CONFIG_MCUMGR_TRANSPORT_BT app PRIVATE $ENV{ZEPHYR_BASE}/samples/subsys/mgmt/mcumgr/smp_svr/src/bluetooth.c) # This places the application bluetooth.c file and some MCUmgr libraries into QSPI XIP zephyr_code_relocate(FILES $ENV{ZEPHYR_BASE}/samples/subsys/mgmt/mcumgr/smp_svr/src/bluetooth.c LOCATION EXTFLASH_TEXT NOCOPY)

@de-nordic @nordicjm Your opinion?

nvlsianpu · 2024-01-11T16:24:30Z

samples/nrf5340/smp_svr/CMakeLists.txt

+
+project(smp_svr)
+
+target_sources(app PRIVATE src/main.c)


@de-nordic @nordicjm Your opinion?

samples/nrf5340/smp_svr/README.rst

nordicjm · 2024-01-15T07:39:39Z

I've said my opinions on this before

nvlsianpu · 2024-01-17T10:15:52Z

I've said my opinions on this before

I know your opinion. For others:

the sample is support using childimage. It will be migrated to sysbuild after the NCS 2.6.0 by my team.
there are many issues on multi-image DFU support. These issues are planed to be solved one by one in iteratively manner. Most of issues I know are threaten independently from this sample - they are on parallel track in roadmap.
sum-up is that: this sample is experimental.

gchwier

This sample is based on smp_svr, but IMO it should have different name, something with xip in it, because it is specific to XIP.
You can consider also moving it to tests folder. You can find specific tests for mcuboot here:
https://github.com/nrfconnect/sdk-nrf/tree/main/tests/modules/mcuboot,
or for bootloader:
https://github.com/nrfconnect/sdk-nrf/tree/main/tests/subsys/bootloader/boot_chains

gchwier · 2024-01-17T10:11:01Z

samples/nrf5340/smp_svr/sample.yaml

+  description: Simple Management Protocol sample
+  name: smp svr
+common:
+  harness: bluetooth


consider changing it to at least harness: console, to just verify if sample is booted,
you can use something like that:

harness: console harness_config: type: one_line regex: - "Hello World! (.*)"

or I can later (in separate PR) extend it with a pytest scenario to test full upgrade with mcumgr (like in https://github.com/zephyrproject-rtos/zephyr/tree/main/tests/boot/with_mcumgr)

gchwier · 2024-01-17T10:12:02Z

samples/nrf5340/smp_svr/sample.yaml

+      - thingy53_nrf5340_cpuapp
+    integration_platforms:
+      - nrf5340dk_nrf5340_cpuapp
+      - thingy53_nrf5340_cpuapp


is this sample works on thingy? with the same pm_static.yml?

gchwier · 2024-01-17T10:16:59Z

samples/nrf5340/smp_svr/app.overlay

is that file used anywhere? I don't see extra_args: DTC_OVERLAY_FILE="app.overlay" in sample.yaml

de-nordic · 2024-01-17T13:50:46Z

I do not know whether this is relevant here, but I have created some time ago PR for support of nrf5340, non-xip, to sdk-nrf but it has been denied because it was not upstreamed nrfconnect/sdk-zephyr#909

samples/nrf5340/extxip_smp_svr/README.rst

nvlsianpu

@kittydepa Applied.

samples/nrf5340/extxip_smp_svr/README.rst

annwoj · 2024-02-20T07:18:57Z

modules/mcuboot/Kconfig

+	help
+	  Allows for an image to be split into 2 parts where there is code executing from internal
+	  flash and code from QSPI via XIP. Requires specific project setup for projects to use
+	  this feature:: project's cmake which supports code dispatching, linker script for describe QSPI


@nvlsianpu Are the double colons here intentional (::)?

that a typo

samples/nrf5340/extxip_smp_svr/README.rst

nvlsianpu · 2024-02-20T10:55:58Z

Falling CI stage passed after re-run.

Adds support for third image in the QSPI XIP space. This image is desired to be the part of cpuapp application executable relocated to the QSPI memory. Signed-off-by: Jamie McCrae <[email protected]> Signed-off-by: Torsten Rasmussen <[email protected]> Signed-off-by: Andrzej Puzdrowski <[email protected]>

Added sample whit configuration which allows to run part of the code form external QSPI flash, which shows the QSPI XIP feature. The sample C code is the same as zephr-rtos smp_svr sample (It Use zephy-rtos embedded source C code instead of copying it) Signed-off-by: Anna Wojdylo <[email protected]> Signed-off-by: Kitty Depa <[email protected]> Signed-off-by: Andrzej Puzdrowski <[email protected]>

Added release note on external XIP DFU sample for nrf5340. Signed-off-by: Andrzej Puzdrowski <[email protected]>

github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Dec 22, 2023

nvlsianpu force-pushed the nrf5340-anpu-ext-xip branch from ac54fd5 to c901c34 Compare January 11, 2024 15:43

nvlsianpu commented Jan 11, 2024

View reviewed changes

nvlsianpu changed the title ~~Nrf5340 anpu ext xip~~ nRF5340 external-xip DFU sample Jan 11, 2024

nvlsianpu force-pushed the nrf5340-anpu-ext-xip branch from c901c34 to e4ab6dc Compare January 12, 2024 12:50

nvlsianpu marked this pull request as ready for review January 12, 2024 13:45

nvlsianpu requested review from a team, de-nordic and nordicjm as code owners January 12, 2024 13:45

nvlsianpu commented Jan 12, 2024

View reviewed changes

nvlsianpu force-pushed the nrf5340-anpu-ext-xip branch from e4ab6dc to b4d0614 Compare January 12, 2024 15:52

nordicjm removed their request for review January 15, 2024 07:39

nvlsianpu force-pushed the nrf5340-anpu-ext-xip branch 4 times, most recently from 013f97c to 4f7b736 Compare January 16, 2024 18:10

shanthanordic requested review from gchwier and removed request for a team January 17, 2024 08:01

nvlsianpu requested review from wbober, sigvartmh and michalek-no January 17, 2024 08:34

nvlsianpu added this to the 2.6.0 milestone Jan 17, 2024

gchwier reviewed Jan 17, 2024

View reviewed changes

nvlsianpu force-pushed the nrf5340-anpu-ext-xip branch from 4f7b736 to f826697 Compare January 17, 2024 11:05

nvlsianpu force-pushed the nrf5340-anpu-ext-xip branch from 6626ae7 to 1ae7930 Compare February 14, 2024 13:42

kittydepa reviewed Feb 19, 2024

View reviewed changes

samples/nrf5340/extxip_smp_svr/README.rst Show resolved Hide resolved

nvlsianpu force-pushed the nrf5340-anpu-ext-xip branch from 1ae7930 to 7073077 Compare February 19, 2024 12:04

nvlsianpu commented Feb 19, 2024

View reviewed changes

samples/nrf5340/extxip_smp_svr/README.rst Show resolved Hide resolved

nvlsianpu force-pushed the nrf5340-anpu-ext-xip branch from 7073077 to 43f40d3 Compare February 19, 2024 13:00

michalek-no approved these changes Feb 19, 2024

View reviewed changes

kittydepa reviewed Feb 19, 2024

View reviewed changes

de-nordic requested review from kittydepa and de-nordic February 19, 2024 14:33

nvlsianpu force-pushed the nrf5340-anpu-ext-xip branch from 36b3059 to c04bdfc Compare February 19, 2024 14:34

nvlsianpu requested a review from carlescufi as a code owner February 19, 2024 14:34

github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Feb 19, 2024

kittydepa approved these changes Feb 19, 2024

View reviewed changes

michalek-no approved these changes Feb 19, 2024

View reviewed changes

de-nordic approved these changes Feb 19, 2024

View reviewed changes

annwoj reviewed Feb 20, 2024

View reviewed changes

nvlsianpu force-pushed the nrf5340-anpu-ext-xip branch from 61b9f4d to 9a2bb53 Compare February 20, 2024 08:49

de-nordic requested review from wbober, annwoj, kittydepa and gchwier February 20, 2024 09:25

sigvartmh approved these changes Feb 20, 2024

View reviewed changes

kittydepa approved these changes Feb 20, 2024

View reviewed changes

annwoj approved these changes Feb 20, 2024

View reviewed changes

nvlsianpu added 3 commits February 20, 2024 12:06

release-note: record smp_svr_ext_xip sample

0ee651f

Added release note on external XIP DFU sample for nrf5340. Signed-off-by: Andrzej Puzdrowski <[email protected]>

nvlsianpu force-pushed the nrf5340-anpu-ext-xip branch from 9a2bb53 to 0ee651f Compare February 20, 2024 11:06

nordicjm merged commit 1d13a15 into nrfconnect:main Feb 20, 2024
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nRF5340 external-xip DFU sample #13509

nRF5340 external-xip DFU sample #13509

nvlsianpu commented Dec 22, 2023 •

edited

Loading

NordicBuilder commented Dec 22, 2023

NordicBuilder commented Jan 2, 2024 •

edited

Loading

nvlsianpu Jan 11, 2024

nvlsianpu Jan 11, 2024

nvlsianpu Jan 11, 2024

nordicjm commented Jan 15, 2024

nvlsianpu commented Jan 17, 2024

gchwier left a comment

gchwier Jan 17, 2024

gchwier Jan 17, 2024

gchwier Jan 17, 2024

gchwier Jan 17, 2024

nvlsianpu Feb 5, 2024

de-nordic commented Jan 17, 2024

nvlsianpu left a comment

annwoj Feb 20, 2024

nvlsianpu Feb 20, 2024

nvlsianpu commented Feb 20, 2024

nRF5340 external-xip DFU sample #13509

nRF5340 external-xip DFU sample #13509

Conversation

nvlsianpu commented Dec 22, 2023 • edited Loading

NordicBuilder commented Dec 22, 2023

NordicBuilder commented Jan 2, 2024 • edited Loading

Test specification

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nordicjm commented Jan 15, 2024

nvlsianpu commented Jan 17, 2024

gchwier left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

de-nordic commented Jan 17, 2024

nvlsianpu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nvlsianpu commented Feb 20, 2024

nvlsianpu commented Dec 22, 2023 •

edited

Loading

NordicBuilder commented Jan 2, 2024 •

edited

Loading