zephyr/samples/net/zperf
Johann Fischer 0929d73788 samples: zperf: add overlays for USBD CDC ECM implementation
Add DT and Kconfig overlay for new experimental CDC ECM
implementation. USB device support configuration and
initialization can be done through shell by following
commands:

uart:~$ usbd config add 1
uart:~$ usbd class add cdc_ecm_0 1
uart:~$ usbd defaults
uart:~$ usbd init
uart:~$ usbd enable

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2023-05-11 11:26:54 +02:00
..
boards samples: zperf: enable it on the fvp_base_revc_2xaemv8a board 2023-04-11 11:27:05 +02:00
src samples, tests, boards: Switch main return type from void to int 2023-04-14 07:49:41 +09:00
CMakeLists.txt net: zperf: Extract zperf into library 2022-08-10 11:15:21 +02:00
overlay-bt.conf
overlay-loopback.conf samples: net: zperf: Add loopback overlay 2022-10-21 13:15:05 +02:00
overlay-netusb.conf samples: Explicitly disable boot USB device support init at boot 2023-01-10 12:21:10 +01:00
overlay-usbd_next_ecm.conf samples: zperf: add overlays for USBD CDC ECM implementation 2023-05-11 11:26:54 +02:00
prj.conf net: zperf: Fix SO_RCVTIMEO dependency 2022-12-15 17:14:26 +01:00
README.rst samples: zperf: enable it on the fvp_base_revc_2xaemv8a board 2023-04-11 11:27:05 +02:00
sample.yaml samples: zperf: add overlays for USBD CDC ECM implementation 2023-05-11 11:26:54 +02:00
usbd_next_ecm.overlay samples: zperf: add overlays for USBD CDC ECM implementation 2023-05-11 11:26:54 +02:00

.. _zperf-sample:

zperf: Network Traffic Generator
################################

Description
***********

The zperf sample demonstrates the :ref:`zperf shell utility <zperf>`, which
allows to evaluate network bandwidth.

Features
*********

- Compatible with iPerf_2.0.5. Note that in newer iPerf versions,
  an error message like this is printed and the server reported statistics
  are missing.

.. code-block:: console

   LAST PACKET NOT RECEIVED!!!

- Client or server mode allowed without need to modify the source code.

Supported Boards
****************

zperf is board-agnostic. However, to run the zperf sample application,
the target platform must provide a network interface supported by Zephyr.

This sample application has been tested on the following platforms:

- Freedom Board (FRDM K64F)
- QEMU x86
- Arm FVP BaseR AEMv8-R
- ARM BASE RevC AEMv8A Fixed Virtual Platforms

Requirements
************

- iPerf 2.0.5 installed on the host machine
- Supported board

Depending on the network technology chosen, extra steps may be required
to setup the network environment.

Usage
*****

See :ref:`zperf library documentation <zperf>` for more information about
the library usage.