Skip to content

Commit ef98a0d

Browse files
krish2718rlubos
authored andcommitted
doc: nrf: Add a section about hostap
Now that we use upstream Zephyr fork for hostap, we need to document the scope of features supported in NCS as it's only a subset of upstream Zephyr. Signed-off-by: Chaitanya Tata <[email protected]> (cherry picked from commit 3ed5022)
1 parent b09b3ab commit ef98a0d

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

doc/nrf/app_dev/device_guides/nrf70/features.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,39 @@ The nRF70 Series devices also support the following functionalities:
5555
Peer-to-peer support in the form of Wi-Fi Direct® will be available in the future.
5656

5757
See the :ref:`ug_wifi` documentation for more information related to Wi-Fi modes of operation.
58+
59+
.. _ug_nrf70_features_hostap:
60+
61+
hostap
62+
******
63+
64+
The nRF70 Series devices use the `WPA Supplicant`_ to implement full Wi-Fi functionality.
65+
The WPA supplicant is part of the ``hostap`` project and is a widely used implementation of the IEEE 802.11i standard for wireless LAN security.
66+
The WPA supplicant is a software component that implements the Wi-Fi Protected Access (WPA™), WPA2™ and WPA3™ security protocols.
67+
68+
The nRF70 Series devices use `Zephyr hostap fork`_, a fork of the hostap project that is integrated with the Zephyr RTOS.
69+
The WPA supplicant is integrated with the Zephyr RTOS and registers as a Wi-Fi network manager in the Zephyr networking stack.
70+
See `Zephyr Wi-Fi NM API`_ for details.
71+
The `Zephyr Wi-Fi management`_ layer in Zephyr uses the Wi-Fi network manager to manage the Wi-Fi interface.
72+
73+
The nRF70 Series driver registers as a Wi-Fi device in the Zephyr networking stack and provides the Wi-Fi interface to the WPA supplicant.
74+
The WPA supplicant then manages the Wi-Fi interface and provides the Wi-Fi functionality to the application.
75+
76+
.. note::
77+
78+
The WPA supplicant is only used for System mode to offer full Wi-Fi functionality.
79+
It is not used in other modes, for example, Scan-only mode.
80+
81+
Supported hostap features in the |NCS|
82+
======================================
83+
84+
The `Zephyr hostap fork`_ supports a wide range of Wi-Fi features and functionalities.
85+
The nRF70 Series devices use the Zephyr hostap fork but only implement a subset of the features supported by the fork.
86+
87+
The nRF70 Series devices support the following features:
88+
89+
* Wi-Fi 6 support.
90+
* Station mode.
91+
* SoftAP mode - Based on ``wpa_supplicant``.
92+
* WPA2-PSK and WPA3-SAE security modes.
93+
* WPA2-EAP-TLS security mode.

doc/nrf/links.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
.. _`Zephyr net capture`: https://docs.zephyrproject.org/latest/samples/net/capture/README.html
2424
.. _`Zephyr net capture Linux setup`: https://docs.zephyrproject.org/latest/connectivity/networking/usbnet_setup.html#usb-device-networking-setup
2525
.. _`Zephyr net DHCPv4 server`: https://docs.zephyrproject.org/apidoc/latest/group__dhcpv4__server.html
26+
.. _`Zephyr Wi-Fi NM API`: https://docs.zephyrproject.org/apidoc/latest/wifi__nm_8h.html
27+
.. _`Zephyr Wi-Fi management`: https://docs.zephyrproject.org/latest/connectivity/networking/api/wifi.html
2628

2729
.. ### Source: github.com
2830

@@ -205,6 +207,8 @@
205207
.. _`Memfault WebBluetooth Client source code`: https://github.com/memfault/web-ble-example/blob/main/mds.js
206208
.. _`Memfault-SDK`: https://github.com/memfault/memfault-firmware-sdk
207209

210+
.. _`Zephyr hostap fork`: https://github.com/zephyrproject-rtos/hostap
211+
208212
.. ### Source: github.io
209213

210214
.. _`TinyCBOR`: https://intel.github.io/tinycbor/current/

0 commit comments

Comments
 (0)