samples: wifi: sta: Add Zperf overlay

This overlay is used to run Zperf benchmarks, the network buffer and heap paramters are not overridden to make it easier to collect memory footprints. Signed-off-by: Chaitanya Tata <[email protected]>
nrfconnect · Jan 22, 2025 · dbfe626 · dbfe626
1 parent 3b2295b
commit dbfe626
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 1 deletion.
diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
@@ -435,7 +435,9 @@ Zigbee samples
 Wi-Fi samples
 -------------
 
-|no_changes_yet_note|
+* :ref:`wifi_station_sample` sample:
+
+  * Added an ``overlay-zperf.conf`` overlay for :ref:`performance benchmarking and memory footprint analysis <wifi_sta_performance_testing_memory_footprint>`.
 
 Other samples
 -------------

diff --git a/samples/wifi/sta/README.rst b/samples/wifi/sta/README.rst
@@ -224,6 +224,18 @@ The average current consumption in an idle case can be around ~1-2 mA in the nRF
 
 See :ref:`app_power_opt` for more information on power management testing and usage of the PPK2.
 
+.. _wifi_sta_performance_testing_memory_footprint:
+
+Performance testing and memory footprint analysis
+*************************************************
+
+The sample can be used to test the performance of the Wi-Fi connection.
+The performance tuning is done to achieve a trade-off between memory usage and performance.
+
+You can use the at :file:`overlay-zperf.conf` file to run the performance test.
+The default build, without the overlay, is used for memory footprint testing and analysis.
+The overlay must be enabled to run the performance test corresponding to the memory footprints.
+
 Dependencies
 ************
 

diff --git a/samples/wifi/sta/overlay-zperf.conf b/samples/wifi/sta/overlay-zperf.conf
@@ -0,0 +1,17 @@
+CONFIG_NET_ZPERF=y
+# Mimic real-world conditions
+CONFIG_NET_ZPERF_MAX_PACKET_SIZE=1500
+CONFIG_NRF70_QSPI_LOW_POWER=n
+# Debug
+CONFIG_NRF70_UTIL=y
+CONFIG_SHELL=y
+CONFIG_SHELL_STACK_SIZE=4600
+CONFIG_NET_SHELL=y
+CONFIG_SHELL_GETOPT=y
+CONFIG_SHELL_CMDS_RESIZE=n
+CONFIG_NRF70_UTIL=y
+CONFIG_NET_L2_WIFI_SHELL=y
+CONFIG_NET_STATISTICS=y
+CONFIG_NET_STATISTICS_WIFI=y
+CONFIG_NET_STATISTICS_USER_API=y
+CONFIG_SYS_HEAP_RUNTIME_STATS=y