From a550c74da14efe459affba721ea788eff8dac9c5 Mon Sep 17 00:00:00 2001 From: Jordan Yates Date: Fri, 30 May 2025 14:44:02 +1000 Subject: [PATCH] doc: document `WIFI_USAGE_MODE` Add docs for `WIFI_USAGE_MODE` in the Wi-Fi section and release notes. Signed-off-by: Jordan Yates --- doc/connectivity/networking/api/wifi.rst | 15 +++++++++++++++ doc/releases/release-notes-4.2.rst | 4 ++++ 2 files changed, 19 insertions(+) diff --git a/doc/connectivity/networking/api/wifi.rst b/doc/connectivity/networking/api/wifi.rst index 3a150efc050..ad7825b5ace 100644 --- a/doc/connectivity/networking/api/wifi.rst +++ b/doc/connectivity/networking/api/wifi.rst @@ -25,6 +25,21 @@ Currently, two types of Wi-Fi drivers are supported: * Networking or socket offloaded drivers * Native L2 Ethernet drivers +Compiled Features +***************** + +To support applications that only require a certain subset of Wi-Fi features, :kconfig:option:`CONFIG_WIFI_USAGE_MODE` can be used +as a hint for drivers to limit the functionality that needs to be compiled in. The following usage hints are available: + + * :kconfig:option:`CONFIG_WIFI_USAGE_MODE_STA` (Connecting to an access point) + * :kconfig:option:`CONFIG_WIFI_USAGE_MODE_AP` (Being an access point) + * :kconfig:option:`CONFIG_WIFI_USAGE_MODE_STA_AP` (Both being and connecting to an access point) + * :kconfig:option:`CONFIG_WIFI_USAGE_MODE_SCAN_ONLY` (Access point SSID scanning only) + +.. note:: + + Support for a requested usage mode is hardware dependent. + Wi-Fi PSA crypto supported build ******************************** diff --git a/doc/releases/release-notes-4.2.rst b/doc/releases/release-notes-4.2.rst index 6586d8b1b99..00c65556880 100644 --- a/doc/releases/release-notes-4.2.rst +++ b/doc/releases/release-notes-4.2.rst @@ -186,6 +186,10 @@ New APIs and options * :kconfig:option:`CONFIG_MQTT_VERSION_5_0` + * Wi-Fi + + * :kconfig:option:`CONFIG_WIFI_USAGE_MODE` + * Power management * :kconfig:option:`CONFIG_PM_DEVICE_RUNTIME_USE_SYSTEM_WQ`