net: wifi: Changes needed to run Zephyr net samples with Wi-Fi #11803

rlubos · 2023-07-13T14:46:38Z

This PR introduces a set of changes needed to run upstream Zephyr networking samples with nRF7002. For a list of samples, see nrfconnect/sdk-zephyr#1242 - samples with an overlay added have been successfully tested with nrf7002dk_nrf5340_cpuapp.

This PR comprises mostly of changes needed to automatically enable features essential for Wi-Fi operation when an appropriate board is selected and networking is enabled. The current feature auto-enablement is pretty aggressive so in most cases, the only change needed on the sample side is to configure SSID/password.

Originally, I was hoping we could rely on automatic configuration only, and avoid overlays in sdk-zephyr, but it soon turned out that in some cases an overlay config is unavoidable (for example when the sample overwritten the default POSIX_MAX_FDS). Since we'd need to carry downstream patch anyway because of this, I've decided to add an overlay to all of the required samples, to clearly indicate which samples have been tested and are supported. This means we can relax the current approach to automatically enable certain features a bit and move configuration to the overlay files. If you think something is too much (like for example enabling Connection Manager automatically is a bit of a gray area for me) please speak up, this PR is, among others, to gather feedback.

As for the remaining patches:

ae933961e5abd4e228fa9d72f31be69562a508ca - upstream networking samples rely on the NET_CONFIG library (and its initial boot delay) heavily, therefore we should not skip that part. I propose to revert that change, and set timeout to 0 in sdk-nrf samples only (not sure if it's really needed though)
b92a6745741f9d83c836ec60950ccee6ebdaaf8e - in case static SSID/password configuration is used, we don't really need a backend to store credentials, it only adds overall configuration complexity (you need to enable settings/nvs/flash etc. for each and every sample). Therefore I suggest to introduce a dummy variant of the backend, enabled automatically when static credential configuration is used.

NordicBuilder · 2023-07-13T14:47:11Z

The following west manifest projects have been modified in this Pull Request:

Name	Old Revision	New Revision	Diff
zephyr	nrfconnect/sdk-zephyr@`6041f17`	nrfconnect/sdk-zephyr@`4579f02` (main)	nrfconnect/sdk-zephyr@6041f17c..4579f028

Note: This message is automatically posted and updated by the Manifest GitHub Action.

krish2718 · 2023-07-13T15:01:28Z

boards/arm/nrf7002dk_nrf5340/Kconfig.defconfig

@@ -71,6 +71,25 @@ config FLASH_LOAD_SIZE

 endif # BOARD_NRF7002DK_NRF5340_CPUAPP_NS

+if NETWORKING


We should do this for nRF7000/nRF7001 also.

Yes, definitely.

@krish2718 Now looking at this, I would add a similar defconfig for nR7001 DK/shield, but what about nRF7000 shield? WPA_SUPP is not needed for sure, but do NETWORKING/NET_L2_ETHERNET need to be enabled for scan only? Or is WIFI/WIFI_NRF700X enough?

WIFI_NRF700X and NET_L2_ETHERNET both are needed.

drivers/wifi/nrf700x/Kconfig.nrf700x

NordicBuilder · 2023-07-13T15:09:24Z

Test specification

CI/Jenkins/NRF

Integration Platforms

CI/Jenkins/integration

Test Module	File based changes	Manually selected	West overwrite
desktop52_verification	X
test-fw-nrfconnect-ble	X
test-fw-nrfconnect-ble_samples	X
test-fw-nrfconnect-chip	X
test-fw-nrfconnect-fem	X
test-fw-nrfconnect-nfc	X
test-fw-nrfconnect-nrf-iot_cloud	X
test-fw-nrfconnect-nrf-iot_lwm2m	X
test-fw-nrfconnect-nrf-iot_mosh	X
test-fw-nrfconnect-nrf-iot_positioning	X
test-fw-nrfconnect-nrf-iot_thingy91	X
test-fw-nrfconnect-nrf-iot_zephyr_lwm2m	X
test-fw-nrfconnect-nrf_crypto	X
test-fw-nrfconnect-rpc	X
test-fw-nrfconnect-rs	X
test-fw-nrfconnect-tfm	X
test-fw-nrfconnect-thread	X
test-sdk-find-my	X
test-sdk-wifi	X

Detailed information of selected test modules

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

NordicBuilder · 2023-07-13T15:29:22Z

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.

rlubos · 2023-07-25T08:35:28Z

Thanks @richabp, I've applied your comments, and added "Configuration" section.

@richabp The doc page content/location is just my proposal, I'm fully open for even a complete redesign, whatever you suggest.

@rlubos Shouldn't it be in the Wi-Fi folder?

Did you mean samples/wifi here? I wasn't sure if we can put documentation there, as we'd be adding doc file in the sample folder structure w/o a corresponding sample, but if that's fine I can move it there. Unless you meant something else.

@rlubos As discussed offline, we keep it as is for now.

richabp

Some minor changes for consistency.

doc/nrf/samples/wifi_zephyr.rst

rlubos · 2023-07-25T14:01:41Z

Thanks @richabp, I've applied your suggestions

rlubos · 2023-08-01T13:17:05Z

As the Zephyr part of the supplicant was moved to sdk-nrf, the PR towards sdk-hostap was no longer applicable. Instead, I've moved the two commits to this PR.

Using the default timeout value is beneficial in terms of support for upstream sample, which often rely on network interface being up and running before the sample code starts. Using the default timeout gives the conn_mgr/supplicant a chance to connect to a Wi-Fi network before the sample runs. Therefore avoid modifying the default value of the timeout in the driver. Instead, set the timeout explicitly to 0 for the NCS samples that use the net config module. Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>

Fine tune defaults for certain system components (heap/stacks/fd entries) to better match driver requirements. This allows to run upstream networking samples without modifying the configuration files. Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>

In case of simple samples, no Wi-Fi credentials storage backend is really needed if static credentials configuration is used. Therefore add an option to use no storage backend. Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>

Enable Wi-Fi components essential for automatic connection establishment by default, if Wi-Fi is enabled. Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>

Pull changes needed to run Zephyr samples with Wi-Fi Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>

Add a documentation page which specifies which Zephyr networking samples are currently supported in terms of nRF700x and how to build them for that platform. Add changelog entry that mentions adding nRF700x support for upstream Zephyr networking samples. Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>

Supplicant won't work w/o sockets, so just enable them, instead of relying on dependency. This is more consistent with other modules like NET_SOCKETS_PACKET which are selected by the supplicant. It also seems that supplicant requires newlib to work, so enable it by default. Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>

Statically created threads with K_THREAD_DEFINE() are launched after the SYS_INIT phase. This does not play well wth NET_CONFIG library, which may block during SYS_INIT until network interface is UP and RUNNING. In order to be able to connect to Wi-Fi network and thus mark the network interface as running, we need to be able to run supplicant during SYS_INIT. This can be achieved, by starting the thread dynamically during SYS_INIT phase, instead of relying on static thread creation. Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>

rlubos added the DNM label Jul 13, 2023

github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. manifest labels Jul 13, 2023

NordicBuilder added manifest-hostap manifest-zephyr labels Jul 13, 2023

rlubos force-pushed the upstream-net-samples-nrf7002 branch from c31677b to ca94ed7 Compare July 13, 2023 14:48

rlubos marked this pull request as ready for review July 13, 2023 14:55

rlubos requested review from maxd-nordic, muraliThokala, bama-nordic, D-Triveni, krish2718, sachinthegreen, rado17, tejlmand and carlescufi as code owners July 13, 2023 14:55

krish2718 reviewed Jul 13, 2023

View reviewed changes

rlubos force-pushed the upstream-net-samples-nrf7002 branch 4 times, most recently from cc42928 to aaa684e Compare July 13, 2023 19:20

rlubos requested a review from a team as a code owner July 13, 2023 19:20

rlubos force-pushed the upstream-net-samples-nrf7002 branch 3 times, most recently from 2fa897f to 155d233 Compare July 20, 2023 08:56

rlubos requested a review from glarsennordic July 20, 2023 09:28

sachinthegreen approved these changes Jul 20, 2023

View reviewed changes

rlubos force-pushed the upstream-net-samples-nrf7002 branch from d59dc5b to 0b55be6 Compare July 25, 2023 08:33

richabp reviewed Jul 25, 2023

View reviewed changes

rlubos force-pushed the upstream-net-samples-nrf7002 branch 3 times, most recently from f4d00bc to e295696 Compare July 25, 2023 14:01

rlubos force-pushed the upstream-net-samples-nrf7002 branch from e295696 to dbbbccc Compare July 25, 2023 15:27

github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jul 25, 2023

rlubos force-pushed the upstream-net-samples-nrf7002 branch from dbbbccc to c7f646b Compare July 25, 2023 15:30

richabp approved these changes Jul 26, 2023

View reviewed changes

rlubos force-pushed the upstream-net-samples-nrf7002 branch from c7f646b to 79bfe2e Compare July 26, 2023 13:08

krish2718 approved these changes Jul 27, 2023

View reviewed changes

rlubos force-pushed the upstream-net-samples-nrf7002 branch 2 times, most recently from 990b69e to e9f5150 Compare August 1, 2023 13:15

rlubos force-pushed the upstream-net-samples-nrf7002 branch 2 times, most recently from f4222be to b11ae86 Compare August 2, 2023 07:26

rlubos added 8 commits August 2, 2023 14:00

net: wifi: Enable essential Wi-Fi components automatically

613e6bd

Enable Wi-Fi components essential for automatic connection establishment by default, if Wi-Fi is enabled. Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>

manifest: Pull changes needed to run Zephyr samples with Wi-Fi

f977cfc

Pull changes needed to run Zephyr samples with Wi-Fi Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>

rlubos force-pushed the upstream-net-samples-nrf7002 branch from b11ae86 to 0055cc9 Compare August 2, 2023 12:01

NordicBuilder removed the DNM label Aug 2, 2023

rlubos merged commit d02e160 into nrfconnect:main Aug 3, 2023
29 of 32 checks passed

rlubos deleted the upstream-net-samples-nrf7002 branch August 31, 2023 12:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

net: wifi: Changes needed to run Zephyr net samples with Wi-Fi #11803

net: wifi: Changes needed to run Zephyr net samples with Wi-Fi #11803

rlubos commented Jul 13, 2023

NordicBuilder commented Jul 13, 2023 •

edited

Loading

krish2718 Jul 13, 2023

rlubos Jul 13, 2023

rlubos Jul 19, 2023

krish2718 Jul 19, 2023

NordicBuilder commented Jul 13, 2023 •

edited

Loading

NordicBuilder commented Jul 13, 2023

rlubos commented Jul 25, 2023 •

edited by richabp

Loading

richabp left a comment

rlubos commented Jul 25, 2023

rlubos commented Aug 1, 2023 •

edited

Loading

		@@ -71,6 +71,25 @@ config FLASH_LOAD_SIZE

		endif # BOARD_NRF7002DK_NRF5340_CPUAPP_NS

		if NETWORKING

net: wifi: Changes needed to run Zephyr net samples with Wi-Fi #11803

net: wifi: Changes needed to run Zephyr net samples with Wi-Fi #11803

Conversation

rlubos commented Jul 13, 2023

NordicBuilder commented Jul 13, 2023 • edited Loading

krish2718 Jul 13, 2023

Choose a reason for hiding this comment

rlubos Jul 13, 2023

Choose a reason for hiding this comment

rlubos Jul 19, 2023

Choose a reason for hiding this comment

krish2718 Jul 19, 2023

Choose a reason for hiding this comment

NordicBuilder commented Jul 13, 2023 • edited Loading

Test specification

CI/Jenkins/NRF

CI/Jenkins/integration

NordicBuilder commented Jul 13, 2023

rlubos commented Jul 25, 2023 • edited by richabp Loading

richabp left a comment

Choose a reason for hiding this comment

rlubos commented Jul 25, 2023

rlubos commented Aug 1, 2023 • edited Loading

NordicBuilder commented Jul 13, 2023 •

edited

Loading

NordicBuilder commented Jul 13, 2023 •

edited

Loading

rlubos commented Jul 25, 2023 •

edited by richabp

Loading

rlubos commented Aug 1, 2023 •

edited

Loading