Skip to content

Conversation

@krish2718
Copy link
Contributor

@krish2718 krish2718 commented Oct 5, 2024

The driver still resides in Zephyr upstream, but docs are only in NCS as Zephyr doesn't have vedor docs.

  • Fix options-from-kconfig extensions to take a custom path @gmarull
  • Add external_context extensions to pull in RST + Doxygen docs from modules/hal/nordic/drivers/nrf_wifi/doc @gmarull

@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 5, 2024
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Oct 5, 2024

CI Information

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

Inputs:

Sources:

sdk-nrf: PR head: dff52939484af343f551659eff0c20e41ca22fd5
nrfxlib: PR head: 7dbaa1c26233af138b2f02f7e56fe7c98ba48269
zephyr: PR head: c8fd566676f5205165304243f4313469d01d9e65

more details

sdk-nrf:

PR head: dff52939484af343f551659eff0c20e41ca22fd5
merge base: 19c0f9c249d0e53b50b188596133f207b68ff0d2
target head (main): 19c0f9c249d0e53b50b188596133f207b68ff0d2
Diff

nrfxlib:

PR head: 7dbaa1c26233af138b2f02f7e56fe7c98ba48269
merge base: 1e25b050dc4cfc767ced5f75174460d67b19b688
Diff

zephyr:

PR head: c8fd566676f5205165304243f4313469d01d9e65
merge base: 08f1c5bc9f202932467d1ba8c0398c8093d29fa4
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 (28)
CODEOWNERS
doc
│  ├── CMakeLists.txt
│  ├── nrf
│  │  ├── drivers
│  │  │  ├── wifi.rst
│  │  │  ├── wifi
│  │  │  │  ├── nrf70_native.rst
│  │  │  │  │ nrf70_portable.rst
│  ├── nrfxlib
│  │  │ nrfxlib.doxyfile.in
│  ├── wifi
│  │  │ wifi.doxyfile.in
dts
│  ├── bindings
│  │  ├── radio_coex
│  │  │  │ nordic,nrf700x-coex.yaml
nrfxlib
│  ├── CODEOWNERS
│  ├── nrf_wifi
│  │  ├── bin
│  │  │  ├── ncs
│  │  │  │  ├── default
│  │  │  │  │  │ nrf70.bin
│  │  │  │  ├── offloaded_raw_tx
│  │  │  │  │  │ nrf70.bin
│  │  │  │  ├── radio_test
│  │  │  │  │  │ nrf70.bin
│  │  │  │  ├── scan_only
│  │  │  │  │  │ nrf70.bin
│  │  │  │  ├── system_with_raw
│  │  │  │  │  │ nrf70.bin
snippets
│  ├── nrf70-driver-debug
│  │  │ overlay-nrf70-driver-debug.conf
subsys
│  ├── mpsl
│  │  ├── cx
│  │  │  │ Kconfig
west.yml
zephyr
│  ├── boards
│  │  ├── nordic
│  │  │  ├── nrf7002dk
│  │  │  │  │ nrf7002dk_nrf5340_cpunet.dts
│  │  ├── shields
│  │  │  ├── nrf7002eb
│  │  │  │  ├── nrf7002eb.overlay
│  │  │  │  │ nrf7002eb_coex.overlay
│  │  │  ├── nrf7002ek
│  │  │  │  │ nrf7002ek_coex.overlay
│  ├── drivers
│  │  ├── wifi
│  │  │  ├── nrfwifi
│  │  │  │  ├── CMakeLists.txt
│  │  │  │  ├── off_raw_tx
│  │  │  │  │  ├── src
│  │  │  │  │  │  │ off_raw_tx_api.c
│  │  │  │  ├── src
│  │  │  │  │  │ net_if.c
│  ├── subsys
│  │  ├── net
│  │  │  ├── lib
│  │  │  │  ├── capture
│  │  │  │  │  │ capture.c
│  ├── tests
│  │  ├── drivers
│  │  │  ├── can
│  │  │  │  ├── api
│  │  │  │  │  ├── src
│  │  │  │  │  │  ├── canfd.c
│  │  │  │  │  │  │ classic.c
│  │ west.yml

Outputs:

Toolchain

Version: b44b7a08c9
Build docker image: docker-dtr.nordicsemi.no/sw-production/ncs-build:b44b7a08c9_912848a074

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

  • ◻️ Toolchain - Skipped: existing toolchain is used
  • ✅ Build twister
    • sdk-nrf test count: 1235
    • sdk-zephyr test count: 7200
  • ❌ Integration tests
    • ❌ test_ble_nrf_config
    • ❌ test-fw-nrfconnect-ble_samples
    • ✅ test-fw-nrfconnect-chip
    • ✅ test-fw-nrfconnect-nfc
    • ✅ test-fw-nrfconnect-nrf-iot_cloud
    • ✅ test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • ❌ test-fw-nrfconnect-nrf-iot_samples
    • ✅ test-fw-nrfconnect-nrf-iot_thingy91
    • ✅ test-fw-nrfconnect-rs
    • ✅ test-fw-nrfconnect-fem
    • ✅ test-fw-nrfconnect-thread
    • ✅ test-fw-nrfconnect-zigbee
    • ✅ test-sdk-find-my
    • ✅ test-fw-nrfconnect-nrf-iot_mosh
    • ✅ test-fw-nrfconnect-nrf-iot_positioning
    • ✅ test-sdk-wifi
    • ✅ test-low-level
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_lwm2m
    • test-fw-nrfconnect-nrf-iot_nrf_provisioning
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-proprietary_esb
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-tfm
    • test-sdk-audio
    • test-sdk-dfu
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-sidewalk

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

@krish2718 krish2718 added this to the 2.8.0 milestone Oct 5, 2024
@krish2718
Copy link
Contributor Author

krish2718 commented Oct 5, 2024

Doc failure is due to Task1 not being complete.

@gmarull
Copy link
Member

gmarull commented Oct 7, 2024

The driver still resides in Zephyr upstream, but docs are only in NCS as Zephyr doesn't have vedor docs.

  • Fix options-from-kconfig extensions to take a custom path @gmarull
  • Add external_context extensions to pull in RST + Doxygen docs from modules/hal/nordic/drivers/nrf_wifi/doc @gmarull

For external_content simply extend doc/nrf/conf.py paths, and for Doxygen the same in doc/nrf/nrf.doxyfile.in.

@krish2718
Copy link
Contributor Author

The driver still resides in Zephyr upstream, but docs are only in NCS as Zephyr doesn't have vedor docs.

  • Fix options-from-kconfig extensions to take a custom path @gmarull
  • Add external_context extensions to pull in RST + Doxygen docs from modules/hal/nordic/drivers/nrf_wifi/doc @gmarull

For external_content simply extend doc/nrf/conf.py paths, and for Doxygen the same in doc/nrf/nrf.doxyfile.in.

The nrfx (hal_nordic) docset from the utils has been removed https://github.com/nrfconnect/sdk-nrf/blame/main/doc/_utils/utils.py#L22 should I bring it back or just hardcode the path HAL_NORDIC_BASE?

Copy link
Contributor

@richabp richabp left a comment

Choose a reason for hiding this comment

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

I think it requires an additional Wi-Fi driver top page, with the following subpages-

  • nRF Wi-Fi driver
  • nRF Wi-Fi portable driver

@richabp
Copy link
Contributor

richabp commented Oct 17, 2024

Please remove the third bullet about the driver documentation form the "Removed" section of "Documentation" from the Changelog https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/releases/release-notes-changelog.html#documentation.

@prsi98 prsi98 force-pushed the wifi_doc_reorg branch 3 times, most recently from 18d03ec to 2b253ad Compare October 17, 2024 12:20
@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.

@krish2718 krish2718 marked this pull request as ready for review October 24, 2024 20:48
@krish2718 krish2718 requested review from a team as code owners October 24, 2024 20:48
@krish2718 krish2718 requested a review from a team as a code owner October 24, 2024 21:15
@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 24, 2024
@krish2718
Copy link
Contributor Author

I think it requires an additional Wi-Fi driver top page, with the following subpages-

  • nRF Wi-Fi driver
  • nRF Wi-Fi portable driver

we already have it https://developer.nordicsemi.com/nRF_Connect_SDK_dev/doc/PR-17653/nrf/drivers/wifi.html

PerMac
PerMac previously requested changes Oct 29, 2024
Copy link
Contributor

@PerMac PerMac left a comment

Choose a reason for hiding this comment

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

does this resolve any issue from the quarantine https://github.com/nrfconnect/sdk-nrf/blob/main/scripts/quarantine.yaml? If so, please also remove such entries from quarantine within this PR so we can let the CI verify the fixes. If not relevant, just ignore my comment and dismiss my request

@krish2718
Copy link
Contributor Author

krish2718 commented Oct 29, 2024

does this resolve any issue from the quarantine https://github.com/nrfconnect/sdk-nrf/blob/main/scripts/quarantine.yaml? If so, please also remove such entries from quarantine within this PR so we can let the CI verify the fixes. If not relevant, just ignore my comment and dismiss my request

As commented #18241 (review) un-quarantine will be part of that PR.

@krish2718 krish2718 dismissed PerMac’s stale review October 29, 2024 14:07

As requested, unquarantine will happen in the other PR

@krish2718 krish2718 removed the backport v2.8-branch auto-create a PR with same commits to v2.8-branch label Oct 29, 2024
Copy link
Contributor

@rlubos rlubos left a comment

Choose a reason for hiding this comment

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

Please update SHAs

gmarull and others added 10 commits October 30, 2024 16:45
Top-level wifi page.

Signed-off-by: Gerard Marull-Paretas <[email protected]>
This was removed during switch to nRF70, now its being re-instate as the
doc would still be part of NCS docs, but with slight changes to use
sources from Zephyr upstream.

Signed-off-by: Chaitanya Tata <[email protected]>
These docs are primarily for low-level API.

Signed-off-by: Chaitanya Tata <[email protected]>
[SHEL-3149] Correct power ceiling description in nrf70 driver
documentation.

Signed-off-by: Prasun Sinha <[email protected]>
This patch adds a new Doxygen docset for the Wifi APIs.

Signed-off-by: Gerard Marull-Paretas <[email protected]>
These are now re-instated.

Signed-off-by: Chaitanya Tata <[email protected]>
These files are now in hal_nordic.

Signed-off-by: Chaitanya Tata <[email protected]>
When debugging driver we don't need WPA supplicant logs.

Signed-off-by: Chaitanya Tata <[email protected]>
Handle the rename when nRF70 moved upstream Zephyr.

Signed-off-by: Chaitanya Tata <[email protected]>
These are now part of upstream Zephyr.

Signed-off-by: Chaitanya Tata <[email protected]>
Fixes co-ex label name to match MPSL requirements.

Signed-off-by: Chaitanya Tata <[email protected]>
Latest Wi-Fi FW blobs.

Signed-off-by: Chaitanya Tata <[email protected]>
@NordicBuilder NordicBuilder removed the DNM label Oct 30, 2024
@rlubos
Copy link
Contributor

rlubos commented Oct 30, 2024

@nrfconnect/ncs-co-drivers @nrfconnect/ncs-co-build-system Please review

@rlubos rlubos merged commit 5591db1 into nrfconnect:main Oct 30, 2024
12 of 14 checks passed
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. manifest manifest-nrfxlib manifest-zephyr

Projects

None yet

Development

Successfully merging this pull request may close these issues.