Skip to content

Commit 858a9de

Browse files
committed
doc: nrf: add wifi low-level API docs
Add docs from nrf_wifi. Signed-off-by: Gerard Marull-Paretas <[email protected]>
1 parent aa7e241 commit 858a9de

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

doc/nrf/drivers/wifi.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ Wi-Fi drivers
88

99
wifi/nrf70_native
1010
wifi/nrf70_portable
11+
wifi/low_level_api
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Low-Level API
2+
#############
3+
4+
Common
5+
******
6+
7+
The common API is used for both normal operation and Radio Test mode.
8+
9+
| Header file: :file:`nrf_wifi/fw_if/umac_if/inc/fmac_structs_common.h`
10+
| Source file: :file:`nrf_wifi/fw_if/umac_if/src/fmac_api_common.c`
11+
12+
13+
.. doxygengroup:: nrf_wifi_api_common
14+
:project: wifi
15+
16+
Radio Test mode
17+
***************
18+
19+
The Radio Test mode is used for testing the RF performance of the nRF70 Series device, mainly to characterize the RF.
20+
21+
.. note::
22+
23+
Documentation for data structure definitions is disabled for this module.
24+
It will be enabled in the future.
25+
26+
| Source file: :file:`nrf_wifi/fw_if/umac_if/src/radio_test/fmac_api.c`
27+
28+
.. doxygengroup:: nrf_wifi_api_radio_test
29+
:project: wifi
30+
31+
Wi-Fi mode
32+
**********
33+
34+
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.
35+
36+
| Header file: :file:`nrf_wifi/fw_if/umac_if/inc/default/fmac_api.h`
37+
| Source file: :file:`nrf_wifi/fw_if/umac_if/src/default/fmac_api.c`
38+
39+
.. doxygengroup:: nrf_wifi_api
40+
:project: wifi

0 commit comments

Comments
 (0)