diff mbox

[dpdk-dev,v4] doc: add queue region feature info to release notes

Message ID 20180119032814.57248-1-wei.zhao1@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Helin Zhang
Headers

Checks

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

Commit Message

Zhao1, Wei Jan. 19, 2018, 3:28 a.m. UTC 
  This patch add inforation about i40e queue region
realted to release notes, it has been missed before
in v17.11 release notes. This feature has been
implemented in v17.11.

Signed-off-by: Wei Zhao <wei.zhao1@intel.com>

---

v2:
-change this information to v18.02 release notes.

v3:
-rework it on dpdk-next-net-intel sub tree.

v4:
-rework it into 17.11 release notes and i40e.rst
---
 doc/guides/nics/i40e.rst               | 24 +++++++++++++++++++++++-
 doc/guides/rel_notes/release_17_11.rst |  6 ++++++
 2 files changed, 29 insertions(+), 1 deletion(-)

Comments

John McNamara Jan. 21, 2018, 9:22 p.m. UTC | #1 
> -----Original Message-----
> From: Zhao1, Wei
> Sent: Friday, January 19, 2018 3:28 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; stable@dpdk.org; Zhao1, Wei
> <wei.zhao1@intel.com>
> Subject: [PATCH v4] doc: add queue region feature info to release notes
> 
> This patch add inforation about i40e queue region realted to release
> notes, it has been missed before in v17.11 release notes. This feature has
> been implemented in v17.11.
> 

Here is a suggested reworking with minor changes and a link to the testpmd docs:

Queue region configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~

The Ethernet Controller X710/XL710 supports a feature of queue regions
configuration for RSS in the PF, so that different traffic classes or
different packet classification types can be separated to different queues in
different queue regions. There is an API for configuration of queue regions in
RSS with a command line. It can parse the parameters of the region index,
queue number, queue start index, user priority, traffic classes and so
on. Depending on commands from the command line, it will call i40e private
APIs and start the process of setting or flushing the queue region
configuration. As this feature is specific for i40e only private APIs are
used. These new ``test_pmd`` commands are as shown below. For details please
refer to :doc:`../testpmd_app_ug/index`.

.. code-block:: console

   testpmd> set port (port_id) queue-region region_id (value) \
		queue_start_index (value) queue_num (value)
   testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
   testpmd> set port (port_id) queue-region UP (value) region_id (value)
   testpmd> set port (port_id) queue-region flush (on|off)
   testpmd> show port (port_id) queue-region
Zhao1, Wei Jan. 22, 2018, 5:27 a.m. UTC | #2 
Thank you for your help!
I have commit a v5 patch https://dpdk.org/dev/patchwork/patch/34211/


> -----Original Message-----
> From: Mcnamara, John
> Sent: Monday, January 22, 2018 5:22 AM
> To: Zhao1, Wei <wei.zhao1@intel.com>; dev@dpdk.org
> Cc: stable@dpdk.org
> Subject: RE: [PATCH v4] doc: add queue region feature info to release notes
> 
> 
> 
> > -----Original Message-----
> > From: Zhao1, Wei
> > Sent: Friday, January 19, 2018 3:28 AM
> > To: dev@dpdk.org
> > Cc: Mcnamara, John <john.mcnamara@intel.com>; stable@dpdk.org;
> Zhao1,
> > Wei <wei.zhao1@intel.com>
> > Subject: [PATCH v4] doc: add queue region feature info to release
> > notes
> >
> > This patch add inforation about i40e queue region realted to release
> > notes, it has been missed before in v17.11 release notes. This feature
> > has been implemented in v17.11.
> >
> 
> Here is a suggested reworking with minor changes and a link to the testpmd
> docs:
> 
> Queue region configuration
> ~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> The Ethernet Controller X710/XL710 supports a feature of queue regions
> configuration for RSS in the PF, so that different traffic classes or different
> packet classification types can be separated to different queues in different
> queue regions. There is an API for configuration of queue regions in RSS with
> a command line. It can parse the parameters of the region index, queue
> number, queue start index, user priority, traffic classes and so on. Depending
> on commands from the command line, it will call i40e private APIs and start
> the process of setting or flushing the queue region configuration. As this
> feature is specific for i40e only private APIs are used. These new ``test_pmd``
> commands are as shown below. For details please refer
> to :doc:`../testpmd_app_ug/index`.
> 
> .. code-block:: console
> 
>    testpmd> set port (port_id) queue-region region_id (value) \
> 		queue_start_index (value) queue_num (value)
>    testpmd> set port (port_id) queue-region region_id (value) flowtype
> (value)
>    testpmd> set port (port_id) queue-region UP (value) region_id (value)
>    testpmd> set port (port_id) queue-region flush (on|off)
>    testpmd> show port (port_id) queue-region
> 
> 
>
diff mbox

Patch

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 50d5e36..345abf3 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -66,7 +66,7 @@  Features of the I40E PMD are:
 - IEEE1588/802.1AS timestamping
 - VF Daemon (VFD) - EXPERIMENTAL
 - Dynamic Device Personalization (DDP)
-
+- Queue region configuration
 
 Prerequisites
 -------------
@@ -430,6 +430,28 @@  For example, to use only 48bit prefix for IPv6 src address for IPv6 TCP RSS:
    testpmd> port config 0 pctype 43 hash_inset set field 14
    testpmd> port config 0 pctype 43 hash_inset set field 15
 
+Queue region configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The Ethernet Controller X710/XL710 support a feature of queue regions
+configuration for RSS in PF, so that different traffic classes or different
+packet classification types can be separated to different queues in different
+queue regions. There is an API for configuration of queue region in rss with
+command line. It can parse the parameters of region index, queue number, queue
+start index, user priority, traffic classes and so on. According to commands
+from command line, it will call i40e private API and start the process of set
+or flush queue region configuration. As this feature is specific for i40e, so
+private API is used. These new commands are as below, for details please reference to
+document testpmd_funcs.rst.
+
+.. code-block:: console
+
+   testpmd> set port (port_id) queue-region region_id (value) \
+		queue_start_index (value) queue_num (value)
+   testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
+   testpmd> set port (port_id) queue-region UP (value) region_id (value)
+   testpmd> set port (port_id) queue-region flush (on|off)
+   testpmd> show port (port_id) queue-region
+
 Limitations or Known issues
 ---------------------------
 
diff --git a/doc/guides/rel_notes/release_17_11.rst b/doc/guides/rel_notes/release_17_11.rst
index 016a08c..15321d6 100644
--- a/doc/guides/rel_notes/release_17_11.rst
+++ b/doc/guides/rel_notes/release_17_11.rst
@@ -273,6 +273,12 @@  New Features
   applications to classify an input packet by matching it against a set of
   flow rules. It uses the ``librte_table`` API to manage the flow rules.
 
+* **Added the i40e ethernet driver to support queue region feature.**
+
+  This feature enable queue regions configuration for RSS in PF,
+  so that different traffic classes or different packet
+  classification types can be separated into different queues in
+  different queue regions.
 
 Resolved Issues
 ---------------