[dpdk-dev,v3,8/8] doc: update app eventdev options

Message ID 20171211151346.14405-8-pbhagavatula@caviumnetworks.com (mailing list archive)
State Accepted, archived
Delegated to: Jerin Jacob
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail apply patch file failure

Commit Message

Pavan Nikhilesh Dec. 11, 2017, 3:13 p.m. UTC
  Update documentation about new --prod_type_ethdev option in app/eventdev.

Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
---
 doc/guides/tools/testeventdev.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
  

Comments

Eads, Gage Dec. 11, 2017, 5:34 p.m. UTC | #1
Once the compilation errors are fixed:
(Series) Acked-by: Gage Eads <gage.eads@intel.com>

> -----Original Message-----
> From: Pavan Nikhilesh [mailto:pbhagavatula@caviumnetworks.com]
> Sent: Monday, December 11, 2017 9:14 AM
> To: jerin.jacob@caviumnetworks.com; Richardson, Bruce
> <bruce.richardson@intel.com>; Van Haaren, Harry
> <harry.van.haaren@intel.com>; Eads, Gage <gage.eads@intel.com>;
> hemant.agrawal@nxp.com; nipun.gupta@nxp.com; Rao, Nikhil
> <nikhil.rao@intel.com>; santosh.shukla@caviumnetworks.com
> Cc: dev@dpdk.org; Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> Subject: [dpdk-dev] [PATCH v3 8/8] doc: update app eventdev options
> 
> Update documentation about new --prod_type_ethdev option in app/eventdev.
> 
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>
> Acked-by: John McNamara <john.mcnamara@intel.com>
> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> ---
>  doc/guides/tools/testeventdev.rst | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/doc/guides/tools/testeventdev.rst
> b/doc/guides/tools/testeventdev.rst
> index 5aa2237b5..11e608b74 100644
> --- a/doc/guides/tools/testeventdev.rst
> +++ b/doc/guides/tools/testeventdev.rst
> @@ -146,6 +146,9 @@ The following are the application command-line
> options:
> 
>          Enable queue priority.
> 
> +* ``--prod_type_ethdev``
> +
> +        Use ethernet device as producer.
> 
>  Eventdev Tests
>  --------------
> @@ -348,6 +351,10 @@ the timestamp in the event on the first stage and then
> on termination, it  updates the number of cycles to forward a packet. The
> application uses this  value to compute the average latency to a forward packet.
> 
> +When ``--prod_type_ethdev`` command line option is selected, the
> +application uses the probed ethernet devices as producers by
> +configuring them as Rx adapters instead of using synthetic producers.
> +
>  Application options
>  ^^^^^^^^^^^^^^^^^^^
> 
> @@ -366,6 +373,7 @@ Supported application command line options are
> following::
>          --worker_deq_depth
>          --fwd_latency
>          --queue_priority
> +        --prod_type_ethdev
> 
>  Example
>  ^^^^^^^
> @@ -377,6 +385,12 @@ Example command to run perf queue test:
>     sudo build/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:
> +
> +.. code-block:: console
> +
> +   sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
> +        --test=perf_queue --plcores=2 --wlcore=3 --stlist=p
> + --prod_type_ethdev
> 
>  PERF_ATQ Test
>  ~~~~~~~~~~~~~~~
> @@ -443,6 +457,7 @@ Supported application command line options are
> following::
>          --nb_pkts
>          --worker_deq_depth
>          --fwd_latency
> +        --prod_type_ethdev
> 
>  Example
>  ^^^^^^^
> --
> 2.14.1
  
Pavan Nikhilesh Dec. 12, 2017, 7:19 a.m. UTC | #2
On Mon, Dec 11, 2017 at 05:34:50PM +0000, Eads, Gage wrote:
> Once the compilation errors are fixed:
> (Series) Acked-by: Gage Eads <gage.eads@intel.com>
>
Thanks for the ack,
The compilation issues have been fixed but for some reason patchworks failed to
apply the patset
Pavan.
  
Jerin Jacob Dec. 16, 2017, 9:32 a.m. UTC | #3
-----Original Message-----
> Date: Mon, 11 Dec 2017 17:34:50 +0000
> From: "Eads, Gage" <gage.eads@intel.com>
> To: Pavan Nikhilesh <pbhagavatula@caviumnetworks.com>,
>  "jerin.jacob@caviumnetworks.com" <jerin.jacob@caviumnetworks.com>,
>  "Richardson, Bruce" <bruce.richardson@intel.com>, "Van Haaren, Harry"
>  <harry.van.haaren@intel.com>, "hemant.agrawal@nxp.com"
>  <hemant.agrawal@nxp.com>, "nipun.gupta@nxp.com" <nipun.gupta@nxp.com>,
>  "Rao, Nikhil" <nikhil.rao@intel.com>, "santosh.shukla@caviumnetworks.com"
>  <santosh.shukla@caviumnetworks.com>
> CC: "dev@dpdk.org" <dev@dpdk.org>
> Subject: RE: [dpdk-dev] [PATCH v3 8/8] doc: update app eventdev options
> 
> Once the compilation errors are fixed:
> (Series) Acked-by: Gage Eads <gage.eads@intel.com>

Series Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
  

Patch

diff --git a/doc/guides/tools/testeventdev.rst b/doc/guides/tools/testeventdev.rst
index 5aa2237b5..11e608b74 100644
--- a/doc/guides/tools/testeventdev.rst
+++ b/doc/guides/tools/testeventdev.rst
@@ -146,6 +146,9 @@  The following are the application command-line options:
 
         Enable queue priority.
 
+* ``--prod_type_ethdev``
+
+        Use ethernet device as producer.
 
 Eventdev Tests
 --------------
@@ -348,6 +351,10 @@  the timestamp in the event on the first stage and then on termination, it
 updates the number of cycles to forward a packet. The application uses this
 value to compute the average latency to a forward packet.
 
+When ``--prod_type_ethdev`` command line option is selected, the application
+uses the probed ethernet devices as producers by configuring them as Rx
+adapters instead of using synthetic producers.
+
 Application options
 ^^^^^^^^^^^^^^^^^^^
 
@@ -366,6 +373,7 @@  Supported application command line options are following::
         --worker_deq_depth
         --fwd_latency
         --queue_priority
+        --prod_type_ethdev
 
 Example
 ^^^^^^^
@@ -377,6 +385,12 @@  Example command to run perf queue test:
    sudo build/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:
+
+.. code-block:: console
+
+   sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
+        --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --prod_type_ethdev
 
 PERF_ATQ Test
 ~~~~~~~~~~~~~~~
@@ -443,6 +457,7 @@  Supported application command line options are following::
         --nb_pkts
         --worker_deq_depth
         --fwd_latency
+        --prod_type_ethdev
 
 Example
 ^^^^^^^