zephyr

History

Gerard Marull-Paretas c7b5b3c419 samples: migrate includes to contain <zephyr/...> prefix In order to bring consistency in-tree, migrate all samples to the use the new prefix <zephyr/...>. Note that the conversion has been scripted: ```python from pathlib import Path import re EXTENSIONS = ("c", "h", "cpp", "rst") for p in Path(".").glob("samples/*/"): if not p.is_file() or p.suffix and p.suffix[1:] not in EXTENSIONS: continue content = "" with open(p) as f: for line in f: m = re.match(r"^(.)#include <(.)>(.*)$", line) if (m and not m.group(2).startswith("zephyr/") and (Path(".") / "include" / "zephyr" / m.group(2)).exists()): content += ( m.group(1) + "#include <zephyr/" + m.group(2) +">" + m.group(3) + "\n" ) else: content += line with open(p, "w") as f: f.write(content) ``` Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>		2022-05-06 11:29:59 +02:00
..
boards
src	samples: migrate includes to contain <zephyr/...> prefix	2022-05-06 11:29:59 +02:00
CMakeLists.txt	cmake: increase minimal required version to 3.20.0	2021-08-20 09:47:34 +02:00
overlay-bt.conf
overlay-netusb.conf
prj.conf
README.rst
sample.yaml

README.rst

.. _zperf-sample:

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

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

zperf is a network traffic generator for Zephyr that may be used 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)
- Quark SE C1000 Development Board
- QEMU x86

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
*****

If Zephyr acts as a client, iPerf must be executed in server mode.
For example, the following command line must be used for UDP testing:

.. code-block:: console

   $ iperf -s -l 1K -u -V -B 2001:db8::2

For TCP testing, the command line would look like this:

.. code-block:: console

   $ iperf -s -l 1K -V -B 2001:db8::2


In the Zephyr console, zperf can be executed as follows:

.. code-block:: console

   zperf udp upload 2001:db8::2 5001 10 1K 1M


For TCP the zperf command would look like this:

.. code-block:: console

   zperf tcp upload 2001:db8::2 5001 10 1K 1M


If the IP addresses of Zephyr and the host machine are specified in the
config file, zperf can be started as follows:

.. code-block:: console

   zperf udp upload2 v6 10 1K 1M


or like this if you want to test TCP:

.. code-block:: console

   zperf tcp upload2 v6 10 1K 1M


If Zephyr is acting as a server, set the download mode as follows for UDP:

.. code-block:: console

   zperf udp download 5001


or like this for TCP:

.. code-block:: console

   zperf tcp download 5001


and in the host side, iPerf must be executed with the following
command line if you are testing UDP:

.. code-block:: console

   $ iperf -l 1K -u -V -c 2001:db8::1 -p 5001


and this if you are testing TCP:

.. code-block:: console

   $ iperf -l 1K -V -c 2001:db8::1 -p 5001


iPerf output can be limited by using the -b option if Zephyr is not
able to receive all the packets in orderly manner.