diff mbox

[dpdk-dev,v2,4/4] doc: update test eventdev documentation

Message ID 20180403160134.27355-4-pbhagavatula@caviumnetworks.com (mailing list archive)
State Superseded, archived
Delegated to: Jerin Jacob
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues

Commit Message

Pavan Nikhilesh April 3, 2018, 4:01 p.m. UTC 
  Update documentation to include new options added for using event timer
adapter as a producer.

Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
---
 doc/guides/tools/testeventdev.rst | 60 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)

Comments

Carrillo, Erik G April 4, 2018, 9:16 p.m. UTC | #1 
> -----Original Message-----
> From: Pavan Nikhilesh [mailto:pbhagavatula@caviumnetworks.com]
> Sent: Tuesday, April 3, 2018 11:02 AM
> To: jerin.jacob@caviumnetworks.com;
> santosh.shukla@caviumnetworks.com; Carrillo, Erik G
> <erik.g.carrillo@intel.com>
> Cc: dev@dpdk.org; Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> Subject: [dpdk-dev] [PATCH v2 4/4] doc: update test eventdev
> documentation
> 
> Update documentation to include new options added for using event timer
> adapter as a producer.
> 
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> ---
>  doc/guides/tools/testeventdev.rst | 60
> +++++++++++++++++++++++++++++++++++++++
>  1 file changed, 60 insertions(+)
> 
> diff --git a/doc/guides/tools/testeventdev.rst
> b/doc/guides/tools/testeventdev.rst
> index 77480ffe9..ab07c0284 100644
> --- a/doc/guides/tools/testeventdev.rst
> +++ b/doc/guides/tools/testeventdev.rst
> @@ -123,6 +123,36 @@ The following are the application command-line
> options:
> 
>          Use ethernet device as producer.
> 
> +* ``--prod_type_timerdev``
> +
> +        Use event timer adapter as producer.
> +
> + * ``--prod_type_timerdev_burst``
> +
> +        Use burst mode event timer adapter as producer.
> +
> + * ``--bkt_tck_nsec``
> +
> +        Used to dictate number of nano seconds between bucket traversal of
> the
> +        event timer adapter. Refer `rte_event_timer_adapter_conf`.
> +
> + * ``--max_tmo_nsec``
> +
> +        Used to configure event timer adapter max arm timeout in nano
> seconds.
> +
> + * ``--nb_bkt_tcks``
> +
> +        Dictate the number of bucket ticks after which the event timer expires.
> +
> + * ``--nb_timers``
> +
> +        Number of event timers each producer cores will generate.

s/cores/core/

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

<...snipped...>

One minor grammatical edit, and with that:

Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
diff mbox

Patch

diff --git a/doc/guides/tools/testeventdev.rst b/doc/guides/tools/testeventdev.rst
index 77480ffe9..ab07c0284 100644
--- a/doc/guides/tools/testeventdev.rst
+++ b/doc/guides/tools/testeventdev.rst
@@ -123,6 +123,36 @@  The following are the application command-line options:
 
         Use ethernet device as producer.
 
+* ``--prod_type_timerdev``
+
+        Use event timer adapter as producer.
+
+ * ``--prod_type_timerdev_burst``
+
+        Use burst mode event timer adapter as producer.
+
+ * ``--bkt_tck_nsec``
+
+        Used to dictate number of nano seconds between bucket traversal of the
+        event timer adapter. Refer `rte_event_timer_adapter_conf`.
+
+ * ``--max_tmo_nsec``
+
+        Used to configure event timer adapter max arm timeout in nano seconds.
+
+ * ``--nb_bkt_tcks``
+
+        Dictate the number of bucket ticks after which the event timer expires.
+
+ * ``--nb_timers``
+
+        Number of event timers each producer cores will generate.
+
+ * ``--nb_timer_adptrs``
+
+        Number of event timer adapters to be used. Each adapter is used in
+        round robin manner by the producer cores.
+
 Eventdev Tests
 --------------
 
@@ -347,6 +377,13 @@  Supported application command line options are following::
         --fwd_latency
         --queue_priority
         --prod_type_ethdev
+        --prod_type_timerdev_burst
+        --prod_type_timerdev
+        --bkt_tck_nsec
+        --max_tmo_nsec
+        --nb_bkt_tcks
+        --nb_timers
+        --nb_timer_adptrs
 
 Example
 ^^^^^^^
@@ -365,6 +402,14 @@  Example command to run perf queue test with ethernet ports:
    sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
         --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --prod_type_ethdev
 
+Example command to run perf queue test with event timer adapter:
+
+.. code-block:: console
+
+   sudo  build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
+                --wlcores 4 --plcores 12 --test perf_queue --stlist=a \
+                --prod_type_timerdev --fwd_latency
+
 PERF_ATQ Test
 ~~~~~~~~~~~~~~~
 
@@ -431,6 +476,13 @@  Supported application command line options are following::
         --worker_deq_depth
         --fwd_latency
         --prod_type_ethdev
+        --prod_type_timerdev_burst
+        --prod_type_timerdev
+        --bkt_tck_nsec
+        --max_tmo_nsec
+        --nb_bkt_tcks
+        --nb_timers
+        --nb_timer_adptrs
 
 Example
 ^^^^^^^
@@ -442,6 +494,14 @@  Example command to run perf ``all types queue`` test:
    sudo build/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
+
+   sudo  build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
+                --wlcores 4 --plcores 12 --test perf_atq --verbose 20 \
+                --stlist=a --prod_type_timerdev --fwd_latency
+
 
 PIPELINE_QUEUE Test
 ~~~~~~~~~~~~~~~~~~~