diff --git a/.github/workflows/docbuild.yml b/.github/workflows/docbuild.yml index a98893bc4e7a..b999ce7a122a 100644 --- a/.github/workflows/docbuild.yml +++ b/.github/workflows/docbuild.yml @@ -143,7 +143,7 @@ jobs: done # Doxygen APIs standalone - declare -a DOXYGEN=("nrfx") + declare -a DOXYGEN=("nrfx" "wifi") for docset in "${DOXYGEN[@]}"; do OUTDIR=doc/_build/html-doxygen/$docset-apis diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index a2c1a5f9a256..61aab94812ea 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -396,7 +396,7 @@ endfunction() add_dependencies(nrfxlib-inventory-all kconfig-all zephyr-all) add_doc_dependencies(zephyr kconfig-all) add_doc_dependencies(mcuboot kconfig-all) -add_doc_dependencies(nrf zephyr-all nrfxlib-inventory-all mcuboot-all matter-all tfm-all kconfig-all) +add_doc_dependencies(nrf zephyr-all nrfxlib-inventory-all mcuboot-all matter-all tfm-all kconfig-all wifi) add_doc_dependencies(nrfxlib nrf-all) add_custom_target(build-all ALL) diff --git a/doc/_zoomin/wifi.apis.custom.properties b/doc/_zoomin/wifi.apis.custom.properties new file mode 100644 index 000000000000..057a31713a10 --- /dev/null +++ b/doc/_zoomin/wifi.apis.custom.properties @@ -0,0 +1,2 @@ +manual.name=wifi-apis-__VERSION__ +booktitle=Wi-Fi APIs - __VERSION__ diff --git a/doc/_zoomin/wifi.apis.tags.yml b/doc/_zoomin/wifi.apis.tags.yml new file mode 100644 index 000000000000..dfe6700619cc --- /dev/null +++ b/doc/_zoomin/wifi.apis.tags.yml @@ -0,0 +1,10 @@ +# Document tags for Zoomin. + +# Tags for all topics: +mapping_global: + - wifi-apis + - wifi-apis-__VERSION__ + - cluster-wifi-apis-__VERSION__ + +# Tags for individual topics: +mapping_topics: [] diff --git a/doc/nrf/conf.py b/doc/nrf/conf.py index 4f1ab3b4b12d..b13801c86807 100644 --- a/doc/nrf/conf.py +++ b/doc/nrf/conf.py @@ -156,7 +156,11 @@ # -- Options for doxybridge plugin --------------------------------------------- -doxybridge_projects = {"nrf": _doxyrunner_outdir} +doxybridge_projects = { + "nrf": _doxyrunner_outdir, + "wifi": utils.get_builddir() / "html" / "wifi", + "zephyr": utils.get_builddir() / "html" / "zephyr" / "doxygen", +} # Options for ncs_include ------------------------------------------------------ diff --git a/doc/nrf/drivers/wifi.rst b/doc/nrf/drivers/wifi.rst index 5f51bb0bd21d..30f857edc2b3 100644 --- a/doc/nrf/drivers/wifi.rst +++ b/doc/nrf/drivers/wifi.rst @@ -8,3 +8,4 @@ Wi-Fi drivers wifi/nrf70_native wifi/nrf70_portable + wifi/low_level_api diff --git a/doc/nrf/drivers/wifi/low_level_api.rst b/doc/nrf/drivers/wifi/low_level_api.rst new file mode 100644 index 000000000000..6824bde8799c --- /dev/null +++ b/doc/nrf/drivers/wifi/low_level_api.rst @@ -0,0 +1,40 @@ +Low-Level API +############# + +Common +****** + +The common API is used for both normal operation and Radio Test mode. + +| Header file: :file:`nrf_wifi/fw_if/umac_if/inc/fmac_structs_common.h` +| Source file: :file:`nrf_wifi/fw_if/umac_if/src/fmac_api_common.c` + + +.. doxygengroup:: nrf_wifi_api_common + :project: wifi + +Radio Test mode +*************** + +The Radio Test mode is used for testing the RF performance of the nRF70 Series device, mainly to characterize the RF. + +.. note:: + + Documentation for data structure definitions is disabled for this module. + It will be enabled in the future. + +| Source file: :file:`nrf_wifi/fw_if/umac_if/src/radio_test/fmac_api.c` + +.. doxygengroup:: nrf_wifi_api_radio_test + :project: wifi + +Wi-Fi mode +********** + +The Wi-Fi mode is used for the normal operation of the nRF70 Series device in the :abbr:`STA (Station)` mode or other modes that will be supported in the future. + +| Header file: :file:`nrf_wifi/fw_if/umac_if/inc/default/fmac_api.h` +| Source file: :file:`nrf_wifi/fw_if/umac_if/src/default/fmac_api.c` + +.. doxygengroup:: nrf_wifi_api + :project: wifi