e91c47d338
Increase the number of network packets and buffers for better TCP
performance in the sample out-of-the-box.
Decrease the network buffer data size for better buffer management in
the sample (less buffer space wasted for L2 header). The only drawback
of this is reduced TCP TX performance, but less than 2 Mbps in my case.
Finally, enable speed optimizations for another small performance boost.
As the RAM requirements of the sample now increase considerably in the
default configuration, add a note in the readme file about it, and how
to make it fit into smaller boards.
Tested on nucleo_h723zg:
Before (current defaults):
UDP TX RX
76.47 Mbps 93.48 Mbps
TCP TX RX
76.18 Mbps 67.75 Mbps
After (new defaults):
UDP TX RX
76.08 Mbps 93.62 Mbps
TCP TX RX
74.19 Mbps 85.51 Mbps
Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
64 lines
1.6 KiB
ReStructuredText
64 lines
1.6 KiB
ReStructuredText
.. zephyr:code-sample:: zperf
|
|
:name: zperf: Network Traffic Generator
|
|
:relevant-api: net_config
|
|
|
|
Use the zperf shell utility to evaluate network bandwidth.
|
|
|
|
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
|
|
|
|
For best performance, the sample configures a lot of network packets and buffers.
|
|
Because of this, the sample's RAM requirements are quite large. In case the
|
|
sample does not fit into target platform RAM, reduce the following configs:
|
|
|
|
.. code-block:: cfg
|
|
|
|
CONFIG_NET_PKT_RX_COUNT=40
|
|
CONFIG_NET_PKT_TX_COUNT=40
|
|
CONFIG_NET_BUF_RX_COUNT=160
|
|
CONFIG_NET_BUF_TX_COUNT=160
|
|
|
|
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.
|