From 05c7c8791f892d73734342174b00cf333155f1d5 Mon Sep 17 00:00:00 2001 From: Ravi Dondaputi Date: Thu, 3 Aug 2023 16:35:33 +0530 Subject: [PATCH] doc: nrf: drivers: Add documentation for Wi-Fi driver kconfig options Add documentation for Wi-Fi driver kconfig options. Signed-off-by: Ravi Dondaputi --- doc/nrf/drivers.rst | 1 + doc/nrf/drivers/{ => wifi/nrf700x}/nrf700x.rst | 12 ++++++++++-- .../nrf700x/subpages}/low_api_common.rst | 0 .../nrf700x/subpages}/low_api_radio_test.rst | 0 .../nrf700x/subpages}/low_api_wifi.rst | 0 drivers/wifi/Kconfig | 2 +- drivers/wifi/nrf700x/{Kconfig.nrf700x => Kconfig} | 0 7 files changed, 12 insertions(+), 3 deletions(-) rename doc/nrf/drivers/{ => wifi/nrf700x}/nrf700x.rst (95%) rename doc/nrf/drivers/{nrf700x => wifi/nrf700x/subpages}/low_api_common.rst (100%) rename doc/nrf/drivers/{nrf700x => wifi/nrf700x/subpages}/low_api_radio_test.rst (100%) rename doc/nrf/drivers/{nrf700x => wifi/nrf700x/subpages}/low_api_wifi.rst (100%) rename drivers/wifi/nrf700x/{Kconfig.nrf700x => Kconfig} (100%) diff --git a/doc/nrf/drivers.rst b/doc/nrf/drivers.rst index a792a611ee6..56cbf7106fb 100644 --- a/doc/nrf/drivers.rst +++ b/doc/nrf/drivers.rst @@ -16,3 +16,4 @@ Here you can find documentation for drivers in the |NCS|, including API document :glob: drivers/* + drivers/wifi/nrf700x/* diff --git a/doc/nrf/drivers/nrf700x.rst b/doc/nrf/drivers/wifi/nrf700x/nrf700x.rst similarity index 95% rename from doc/nrf/drivers/nrf700x.rst rename to doc/nrf/drivers/wifi/nrf700x/nrf700x.rst index cc5ebbfd80b..11996bf51c2 100644 --- a/doc/nrf/drivers/nrf700x.rst +++ b/doc/nrf/drivers/wifi/nrf700x/nrf700x.rst @@ -55,7 +55,7 @@ The following features are in the driver code but not yet supported: Except for scan only mode, the driver uses host access point daemon (hostapd) to implement AP Media Access Control (MAC) Sublayer Management Entity (AP MLME) and wpa_supplicant to implement 802.1X supplicant. -Radio test mode +Radio Test mode ^^^^^^^^^^^^^^^ The nRF700X Wi-Fi driver supports Radio Test mode, which you can use to test the RF performance of the nRF700X device. This is a build time option that you can enable using the :kconfig:option:`CONFIG_NRF700X_RADIO_TEST` Kconfig option. @@ -71,6 +71,14 @@ The nRF7002 DK uses QSPI whereas the nRF7002 EK uses SPI. To connect the nRF7002 EK to the SoC, the ``nrf7002ek`` shield is required. +Configuration +************* + +The nRF700X Wi-Fi driver has the following configuration options: + +.. options-from-kconfig:: + :show-type: + API documentation ***************** @@ -89,4 +97,4 @@ This is typically intended for customers who want to use the nRF700X device in a :caption: Modules: :glob: - nrf700x/* + subpages/* diff --git a/doc/nrf/drivers/nrf700x/low_api_common.rst b/doc/nrf/drivers/wifi/nrf700x/subpages/low_api_common.rst similarity index 100% rename from doc/nrf/drivers/nrf700x/low_api_common.rst rename to doc/nrf/drivers/wifi/nrf700x/subpages/low_api_common.rst diff --git a/doc/nrf/drivers/nrf700x/low_api_radio_test.rst b/doc/nrf/drivers/wifi/nrf700x/subpages/low_api_radio_test.rst similarity index 100% rename from doc/nrf/drivers/nrf700x/low_api_radio_test.rst rename to doc/nrf/drivers/wifi/nrf700x/subpages/low_api_radio_test.rst diff --git a/doc/nrf/drivers/nrf700x/low_api_wifi.rst b/doc/nrf/drivers/wifi/nrf700x/subpages/low_api_wifi.rst similarity index 100% rename from doc/nrf/drivers/nrf700x/low_api_wifi.rst rename to doc/nrf/drivers/wifi/nrf700x/subpages/low_api_wifi.rst diff --git a/drivers/wifi/Kconfig b/drivers/wifi/Kconfig index 1806c5c42e0..95ab147c235 100644 --- a/drivers/wifi/Kconfig +++ b/drivers/wifi/Kconfig @@ -6,6 +6,6 @@ if WIFI -rsource "nrf700x/Kconfig.nrf700x" +rsource "nrf700x/Kconfig" endif # WIFI diff --git a/drivers/wifi/nrf700x/Kconfig.nrf700x b/drivers/wifi/nrf700x/Kconfig similarity index 100% rename from drivers/wifi/nrf700x/Kconfig.nrf700x rename to drivers/wifi/nrf700x/Kconfig