event/dlb: add infos get and configure

[dpdk.git] / doc / guides / tools / testeventdev.rst

diff --git a/doc/guides/tools/testeventdev.rst b/doc/guides/tools/testeventdev.rst
index db5c437..ad1788a 100644 (file)
--- a/doc/guides/tools/testeventdev.rst
+++ b/doc/guides/tools/testeventdev.rst
@@ -10,19 +10,6 @@ This application has a generic framework to add new eventdev based test cases to
 verify functionality and measure the performance parameters of DPDK eventdev
 devices.
 
 verify functionality and measure the performance parameters of DPDK eventdev
 devices.
 

-Compiling the Application
--------------------------
-
-**Build the application**
-
-Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the
-``dpdk-test-eventdev`` application.
-
-Initially, the user must select a DPDK target to choose the correct target type
-and compiler options to use when building the libraries.
-The user must have all libraries, modules, updates and compilers installed
-in the system prior to this,
-as described in the earlier chapters in this Getting Started Guide.

 
 Running the Application
 -----------------------
 
 Running the Application
 -----------------------


@@ -161,6 +148,16 @@ The following are the application command-line options:
        timeout is out of the supported range of event device it will be
        adjusted to the highest/lowest supported dequeue timeout supported.
 
        timeout is out of the supported range of event device it will be
        adjusted to the highest/lowest supported dequeue timeout supported.
 

+* ``--mbuf_sz``
+
+       Set packet mbuf size. Can be used to configure Jumbo Frames. Only
+       applicable for `pipeline_atq` and `pipeline_queue` tests.
+
+* ``--max_pkt_sz``
+
+       Set max packet mbuf size. Can be used configure Rx/Tx scatter gather.
+       Only applicable for `pipeline_atq` and `pipeline_queue` tests.
+

 
 Eventdev Tests
 --------------
 
 Eventdev Tests
 --------------


@@ -241,7 +238,7 @@ Example command to run order queue test:
 
 .. code-block:: console
 
 
 .. code-block:: console
 

-   sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
+   sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_sw0 -- \

                 --test=order_queue --plcores 1 --wlcores 2,3
 
 
                 --test=order_queue --plcores 1 --wlcores 2,3
 
 


@@ -304,7 +301,7 @@ Example command to run order ``all types queue`` test:
 
 .. code-block:: console
 
 
 .. code-block:: console
 

-   sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
+   sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_octeontx -- \

                         --test=order_atq --plcores 1 --wlcores 2,3
 
 
                         --test=order_atq --plcores 1 --wlcores 2,3
 
 


@@ -404,7 +401,7 @@ Example command to run perf queue test:
 
 .. code-block:: console
 
 
 .. code-block:: console
 

-   sudo build/app/dpdk-test-eventdev -c 0xf -s 0x1 --vdev=event_sw0 -- \
+   sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x1 --vdev=event_sw0 -- \

         --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
 
 Example command to run perf queue test with ethernet ports:
         --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
 
 Example command to run perf queue test with ethernet ports:


@@ -418,7 +415,7 @@ Example command to run perf queue test with event timer adapter:
 
 .. code-block:: console
 
 
 .. code-block:: console
 

-   sudo  build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
+   sudo  <build_dir>/app/dpdk-test-eventdev --vdev="event_octeontx" -- \

                 --wlcores 4 --plcores 12 --test perf_queue --stlist=a \
                 --prod_type_timerdev --fwd_latency
 
                 --wlcores 4 --plcores 12 --test perf_queue --stlist=a \
                 --prod_type_timerdev --fwd_latency
 


@@ -504,14 +501,14 @@ Example command to run perf ``all types queue`` test:
 
 .. code-block:: console
 
 
 .. code-block:: console
 

-   sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
+   sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_octeontx -- \

                 --test=perf_atq --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
 
 Example command to run perf ``all types queue`` test with event timer adapter:
 
 .. code-block:: console
 
                 --test=perf_atq --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
 
 Example command to run perf ``all types queue`` test with event timer adapter:
 
 .. code-block:: console
 

-   sudo  build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
+   sudo  <build_dir>/app/dpdk-test-eventdev --vdev="event_octeontx" -- \

                 --wlcores 4 --plcores 12 --test perf_atq --verbose 20 \
                 --stlist=a --prod_type_timerdev --fwd_latency
 
                 --wlcores 4 --plcores 12 --test perf_atq --verbose 20 \
                 --stlist=a --prod_type_timerdev --fwd_latency
 


@@ -623,7 +620,7 @@ Example command to run pipeline queue test:
 
 .. code-block:: console
 
 
 .. code-block:: console
 

-    sudo build/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
+    sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \

         --test=pipeline_queue --wlcore=1 --prod_type_ethdev --stlist=a
 
 
         --test=pipeline_queue --wlcore=1 --prod_type_ethdev --stlist=a
 
 


@@ -715,5 +712,5 @@ Example command to run pipeline queue test:
 
 .. code-block:: console
 
 
 .. code-block:: console
 

-    sudo build/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
+    sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \

         --test=pipeline_atq --wlcore=1 --prod_type_ethdev --stlist=a
         --test=pipeline_atq --wlcore=1 --prod_type_ethdev --stlist=a