aboutsummaryrefslogtreecommitdiff
path: root/test/performance/odp_pktio_perf.c
diff options
context:
space:
mode:
authorMatias Elo <matias.elo@nokia.com>2024-03-11 16:39:27 +0200
committerGitHub <noreply@github.com>2024-03-11 16:39:27 +0200
commit8063101c4fac56e16c5a2bb9843f2fd9c5acbfd7 (patch)
tree63e2500c41ea7d1e4714236561be641b1639f287 /test/performance/odp_pktio_perf.c
parentc00ef7d6bce1e483c4cf1bb3cdf6cd629530d795 (diff)
parent9ff786ed3d9d553f8e108eff4ee4ceec4adb585e (diff)
Merge ODP linux-generic v1.44.0.0 into linux-dpdk.
Diffstat (limited to 'test/performance/odp_pktio_perf.c')
-rw-r--r--test/performance/odp_pktio_perf.c17
1 files changed, 10 insertions, 7 deletions
diff --git a/test/performance/odp_pktio_perf.c b/test/performance/odp_pktio_perf.c
index 06620fd27..4cfeb50cf 100644
--- a/test/performance/odp_pktio_perf.c
+++ b/test/performance/odp_pktio_perf.c
@@ -2,14 +2,16 @@
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
+ */
+
+/**
+ * @example odp_pktio_perf.c
*
- * ODP Packet IO basic performance test application.
- *
- * Runs a number of transmit and receive workers on separate cores, the
- * transmitters generate packets at a defined rate and the receivers consume
- * them. Generated packets are UDP and each packet is marked with a magic
- * number in the UDP payload allowing receiver to distinguish them from other
- * traffic.
+ * Packet IO basic performance test application. Runs a number of transmit and
+ * receive workers on separate cores, the transmitters generate packets at a
+ * defined rate and the receivers consume them. Generated packets are UDP and
+ * each packet is marked with a magic number in the UDP payload allowing
+ * receiver to distinguish them from other traffic.
*
* Each test iteration runs for a fixed period, at the end of the iteration
* it is verified that the number of packets transmitted was as expected and
@@ -19,6 +21,7 @@
* determine the maximum rate at which no packet loss occurs. Alternatively
* a single packet rate can be specified on the command line.
*
+ * @cond _ODP_HIDE_FROM_DOXYGEN_
*/
#include <odp_api.h>