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_2.0.5. Note that in newer iPerf versions,
17  an error message like this is printed and the server reported statistics
18  are missing.
19
20.. code-block:: console
21
22   LAST PACKET NOT RECEIVED!!!
23
24- Client or server mode allowed without need to modify the source code.
25
26Supported Boards
27****************
28
29zperf is board-agnostic. However, to run the zperf sample application,
30the target platform must provide a network interface supported by Zephyr.
31
32This sample application has been tested on the following platforms:
33
34- Freedom Board (FRDM K64F)
35- QEMU x86
36- Arm FVP BaseR AEMv8-R
37- ARM BASE RevC AEMv8A Fixed Virtual Platforms
38
39For best performance, the sample configures a lot of network packets and buffers.
40Because of this, the sample's RAM requirements are quite large. In case the
41sample does not fit into target platform RAM, reduce the following configs:
42
43.. code-block:: cfg
44
45   CONFIG_NET_PKT_RX_COUNT=40
46   CONFIG_NET_PKT_TX_COUNT=40
47   CONFIG_NET_BUF_RX_COUNT=160
48   CONFIG_NET_BUF_TX_COUNT=160
49
50Requirements
51************
52
53- iPerf 2.0.5 installed on the host machine
54- Supported board
55
56Depending on the network technology chosen, extra steps may be required
57to setup the network environment.
58
59Usage
60*****
61
62See :ref:`zperf library documentation <zperf>` for more information about
63the library usage.
64
65Wi-Fi
66=====
67
68The IPv4 Wi-Fi support can be enabled in the sample with
69:ref:`Wi-Fi snippet <snippet-wifi-ipv4>`.
70