1.. zephyr:code-sample:: zperf
2   :name: zperf: Network Traffic Generator
3   :relevant-api: net_config
4
5   Use the zperf shell utility to evaluate network bandwidth.
6
7Description
8***********
9
10The zperf sample demonstrates the :ref:`zperf shell utility <zperf>`, which
11allows to evaluate network bandwidth.
12
13Features
14*********
15
16- Compatible with iPerf v2.0.10 and newer. For older versions, enable
17  :kconfig:option:`CONFIG_NET_ZPERF_LEGACY_HEADER_COMPAT`.
18
19- Client or server mode allowed without need to modify the source code.
20
21Supported Boards
22****************
23
24zperf is board-agnostic. However, to run the zperf sample application,
25the target platform must provide a network interface supported by Zephyr.
26
27This sample application has been tested on the following platforms:
28
29- Freedom Board (FRDM K64F)
30- QEMU x86
31- Arm FVP BaseR AEMv8-R
32- ARM BASE RevC AEMv8A Fixed Virtual Platforms
33
34For best performance, the sample configures a lot of network packets and buffers.
35Because of this, the sample's RAM requirements are quite large. In case the
36sample does not fit into target platform RAM, reduce the following configs:
37
38.. code-block:: cfg
39
40   CONFIG_NET_PKT_RX_COUNT=40
41   CONFIG_NET_PKT_TX_COUNT=40
42   CONFIG_NET_BUF_RX_COUNT=160
43   CONFIG_NET_BUF_TX_COUNT=160
44
45Requirements
46************
47
48- iPerf 2.0.10 or newer installed on the host machine
49- Supported board
50
51Depending on the network technology chosen, extra steps may be required
52to setup the network environment.
53
54Usage
55*****
56
57See :ref:`zperf library documentation <zperf>` for more information about
58the library usage.
59
60Wi-Fi
61=====
62
63The IPv4 Wi-Fi support can be enabled in the sample with
64:ref:`Wi-Fi snippet <snippet-wifi-ipv4>`.
65