1.. _zperf-sample:
2
3zperf: Network Traffic Generator
4################################
5
6Description
7***********
8
9The zperf sample demonstrates the :ref:`zperf shell utility <zperf>`, which
10allows to evaluate network bandwidth.
11
12Features
13*********
14
15- Compatible with iPerf_2.0.5. Note that in newer iPerf versions,
16  an error message like this is printed and the server reported statistics
17  are missing.
18
19.. code-block:: console
20
21   LAST PACKET NOT RECEIVED!!!
22
23- Client or server mode allowed without need to modify the source code.
24
25Supported Boards
26****************
27
28zperf is board-agnostic. However, to run the zperf sample application,
29the target platform must provide a network interface supported by Zephyr.
30
31This sample application has been tested on the following platforms:
32
33- Freedom Board (FRDM K64F)
34- QEMU x86
35- Arm FVP BaseR AEMv8-R
36- ARM BASE RevC AEMv8A Fixed Virtual Platforms
37
38Requirements
39************
40
41- iPerf 2.0.5 installed on the host machine
42- Supported board
43
44Depending on the network technology chosen, extra steps may be required
45to setup the network environment.
46
47Usage
48*****
49
50See :ref:`zperf library documentation <zperf>` for more information about
51the library usage.
52