Skip to content

Commit 6695c8f

Browse files
JordanYateskartben
authored andcommitted
doc: zbus: update iperf version information
Update iperf version information for use with zperf. Note the fallback kconfig option for versions older than `2.0.10`, and remove the warning about `LAST PACKET NOT RECEIVED!!!` since it is not longer present with the fixed UDP header. Signed-off-by: Jordan Yates <jordan@embeint.com>
1 parent 4582c64 commit 6695c8f

File tree

2 files changed

+5
-15
lines changed

2 files changed

+5
-15
lines changed

doc/connectivity/networking/api/zperf.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,8 @@ Overview
1313
zperf is a shell utility which allows to generate network traffic in Zephyr. The
1414
tool may be used to evaluate network bandwidth.
1515

16-
zperf is 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!!!
16+
zperf is compatible with iPerf 2.0.10 and newer. For compatability with older versions,
17+
enable :kconfig:option:`CONFIG_NET_ZPERF_LEGACY_HEADER_COMPAT`.
2318

2419
zperf can be enabled in any application, a dedicated sample is also present
2520
in Zephyr. See :zephyr:code-sample:`zperf sample application <zperf>` for details.

samples/net/zperf/README.rst

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,8 @@ allows to evaluate network bandwidth.
1313
Features
1414
*********
1515

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!!!
16+
- Compatible with iPerf v2.0.10 and newer. For older versions, enable
17+
:kconfig:option:`CONFIG_NET_ZPERF_LEGACY_HEADER_COMPAT`.
2318

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

@@ -50,7 +45,7 @@ sample does not fit into target platform RAM, reduce the following configs:
5045
Requirements
5146
************
5247

53-
- iPerf 2.0.5 installed on the host machine
48+
- iPerf 2.0.10 or newer installed on the host machine
5449
- Supported board
5550

5651
Depending on the network technology chosen, extra steps may be required

0 commit comments

Comments
 (0)