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 cddba3b..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
 -----------------------


@@ -129,31 +116,48 @@ The following are the application command-line options:
 
         Use event timer adapter as producer.
 
 
         Use event timer adapter as producer.
 

- * ``--prod_type_timerdev_burst``
+* ``--prod_type_timerdev_burst``
+
+       Use burst mode event timer adapter as producer.
+
+* ``--timer_tick_nsec``
+
+       Used to dictate number of nano seconds between bucket traversal of the
+       event timer adapter. Refer `rte_event_timer_adapter_conf`.

 
 

-        Use burst mode event timer adapter as producer.
+* ``--max_tmo_nsec``

 
 

- * ``--timer_tick_nsec``
+       Used to configure event timer adapter max arm timeout in nano seconds.

 
 

-        Used to dictate number of nano seconds between bucket traversal of the
-        event timer adapter. Refer `rte_event_timer_adapter_conf`.
+* ``--expiry_nsec``

 
 

- * ``--max_tmo_nsec``
+       Dictate the number of nano seconds after which the event timer expires.

 
 

-        Used to configure event timer adapter max arm timeout in nano seconds.
+* ``--nb_timers``

 
 

- * ``--expiry_nsec``
+       Number of event timers each producer core will generate.

 
 

-        Dictate the number of nano seconds after which the event timer expires.
+* ``--nb_timer_adptrs``

 
 

- * ``--nb_timers``
+       Number of event timer adapters to be used. Each adapter is used in
+       round robin manner by the producer cores.

 
 

-        Number of event timers each producer core will generate.
+* ``--deq_tmo_nsec``

 
 

- * ``--nb_timer_adptrs``
+       Global dequeue timeout for all the event ports if the provided dequeue
+       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.

 
 

-        Number of event timer adapters to be used. Each adapter is used in
-        round robin manner by the producer cores.

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


@@ -225,6 +229,7 @@ Supported application command line options are following::
    --nb_flows
    --nb_pkts
    --worker_deq_depth
    --nb_flows
    --nb_pkts
    --worker_deq_depth

+   --deq_tmo_nsec

 
 Example
 ^^^^^^^
 
 Example
 ^^^^^^^


@@ -233,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
 
 


@@ -287,6 +292,7 @@ Supported application command line options are following::
    --nb_flows
    --nb_pkts
    --worker_deq_depth
    --nb_flows
    --nb_pkts
    --worker_deq_depth

+   --deq_tmo_nsec

 
 Example
 ^^^^^^^
 
 Example
 ^^^^^^^


@@ -295,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
 
 


@@ -386,6 +392,7 @@ Supported application command line options are following::
         --expiry_nsec
         --nb_timers
         --nb_timer_adptrs
         --expiry_nsec
         --nb_timers
         --nb_timer_adptrs

+        --deq_tmo_nsec

 
 Example
 ^^^^^^^
 
 Example
 ^^^^^^^


@@ -394,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:


@@ -408,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
 


@@ -485,6 +492,7 @@ Supported application command line options are following::
         --expiry_nsec
         --nb_timers
         --nb_timer_adptrs
         --expiry_nsec
         --nb_timers
         --nb_timer_adptrs

+        --deq_tmo_nsec

 
 Example
 ^^^^^^^
 
 Example
 ^^^^^^^


@@ -493,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
 


@@ -598,6 +606,7 @@ Supported application command line options are following::
         --stlist
         --worker_deq_depth
         --prod_type_ethdev
         --stlist
         --worker_deq_depth
         --prod_type_ethdev

+        --deq_tmo_nsec

 
 
 .. Note::
 
 
 .. Note::


@@ -611,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
 
 


@@ -689,6 +698,7 @@ Supported application command line options are following::
         --stlist
         --worker_deq_depth
         --prod_type_ethdev
         --stlist
         --worker_deq_depth
         --prod_type_ethdev

+        --deq_tmo_nsec

 
 
 .. Note::
 
 
 .. Note::


@@ -702,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