All of lore.kernel.org
 help / color / mirror / Atom feed
From: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
To: jerin.jacob@caviumnetworks.com,
	santosh.shukla@caviumnetworks.com, erik.g.carrillo@intel.com
Cc: dev@dpdk.org, Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
Subject: [PATCH 4/4] doc: update test eventdev documentation
Date: Sun, 18 Mar 2018 18:42:16 +0530	[thread overview]
Message-ID: <20180318131216.11699-4-pbhagavatula@caviumnetworks.com> (raw)
In-Reply-To: <20180318131216.11699-1-pbhagavatula@caviumnetworks.com>

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.
+
+ * ``--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
 ~~~~~~~~~~~~~~~~~~~
-- 
2.16.2

  parent reply	other threads:[~2018-03-18 13:13 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-03-18 13:12 [PATCH 1/4] app/eventdev: add event timer adapter as a producer Pavan Nikhilesh
2018-03-18 13:12 ` [PATCH 2/4] app/eventdev: add burst mode for event timer adapter Pavan Nikhilesh
2018-03-30 19:54   ` Carrillo, Erik G
2018-03-18 13:12 ` [PATCH 3/4] app/eventdev: add options to configure " Pavan Nikhilesh
2018-03-18 13:12 ` Pavan Nikhilesh [this message]
2018-03-30 19:50 ` [PATCH 1/4] app/eventdev: add event timer adapter as a producer Carrillo, Erik G
2018-04-03 16:01 ` [PATCH v2 " Pavan Nikhilesh
2018-04-03 16:01   ` [PATCH v2 2/4] app/eventdev: add burst mode for event timer adapter Pavan Nikhilesh
2018-04-04 21:07     ` Carrillo, Erik G
2018-04-03 16:01   ` [PATCH v2 3/4] app/eventdev: add options to configure " Pavan Nikhilesh
2018-04-04 21:10     ` Carrillo, Erik G
2018-04-03 16:01   ` [PATCH v2 4/4] doc: update test eventdev documentation Pavan Nikhilesh
2018-04-04 21:16     ` Carrillo, Erik G
2018-04-03 20:21   ` [PATCH v2 1/4] app/eventdev: add event timer adapter as a producer Carrillo, Erik G
2018-04-04 21:20     ` Carrillo, Erik G
2018-04-05 11:53 ` [PATCH v3 " Pavan Nikhilesh
2018-04-05 11:53   ` [PATCH v3 2/4] app/eventdev: add burst mode for event timer adapter Pavan Nikhilesh
2018-04-06 11:11     ` Jerin Jacob
2018-04-05 11:53   ` [PATCH v3 3/4] app/eventdev: add options to configure " Pavan Nikhilesh
2018-04-06 11:15     ` Jerin Jacob
2018-04-05 11:53   ` [PATCH v3 4/4] doc: update test eventdev documentation Pavan Nikhilesh
2018-04-06 11:37     ` Jerin Jacob
2018-04-06 11:07   ` [PATCH v3 1/4] app/eventdev: add event timer adapter as a producer Jerin Jacob
2018-04-06 11:18   ` Jerin Jacob
2018-04-06 14:55 ` [PATCH v4 " Pavan Nikhilesh
2018-04-06 14:55   ` [PATCH v4 2/4] app/eventdev: add burst mode for event timer adapter Pavan Nikhilesh
2018-04-06 14:55   ` [PATCH v4 3/4] app/eventdev: add options to configure " Pavan Nikhilesh
2018-04-06 14:55   ` [PATCH v4 4/4] doc: update test eventdev documentation Pavan Nikhilesh
2018-04-06 15:13 ` [PATCH v5 1/4] app/eventdev: add event timer adapter as a producer Pavan Nikhilesh
2018-04-06 15:13   ` [PATCH v5 2/4] app/eventdev: add burst mode for event timer adapter Pavan Nikhilesh
2018-04-06 15:13   ` [PATCH v5 3/4] app/eventdev: add options to configure " Pavan Nikhilesh
2018-04-06 15:13   ` [PATCH v5 4/4] doc: update test eventdev documentation Pavan Nikhilesh
2018-04-07  9:34   ` [PATCH v5 1/4] app/eventdev: add event timer adapter as a producer Jerin Jacob
2018-04-17  8:18   ` Maxime Coquelin
2018-04-17  8:22     ` Pavan Nikhilesh
2018-04-17  8:24       ` Maxime Coquelin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180318131216.11699-4-pbhagavatula@caviumnetworks.com \
    --to=pbhagavatula@caviumnetworks.com \
    --cc=dev@dpdk.org \
    --cc=erik.g.carrillo@intel.com \
    --cc=jerin.jacob@caviumnetworks.com \
    --cc=santosh.shukla@caviumnetworks.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.