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

Message ID 20180122051830.102203-1-wei.zhao1@intel.com (mailing list archive)
State Accepted, 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. 22, 2018, 5:18 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.

v5:
-change some use of words and comment location in file.
---
 doc/guides/nics/i40e.rst               | 25 ++++++++++++++++++++++++-
 doc/guides/rel_notes/release_17_11.rst |  7 +++++++
 2 files changed, 31 insertions(+), 1 deletion(-)
  

Comments

John McNamara Jan. 23, 2018, 10:22 a.m. UTC | #1
> -----Original Message-----
> From: Zhao1, Wei
> Sent: Monday, January 22, 2018 5:19 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; thomas@monjalon.net;
> stable@dpdk.org; Zhao1, Wei <wei.zhao1@intel.com>
> Subject: [PATCH v5] 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.
> 
> ...
> +Queue region configuration
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~

The underline for a section header should match the length of the text
and should be followed by a blank line, line in my suggested changes.

See also: http://dpdk.org/doc/guides/contributing/documentation.html#section-headers

However, this isn't an error so:

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Zhang, Helin Jan. 23, 2018, 3:01 p.m. UTC | #2
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John
> Sent: Tuesday, January 23, 2018 6:22 PM
> To: Zhao1, Wei; dev@dpdk.org
> Cc: thomas@monjalon.net; stable@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v5] doc: add queue region feature info to
> release notes
> 
> 
> 
> > -----Original Message-----
> > From: Zhao1, Wei
> > Sent: Monday, January 22, 2018 5:19 AM
> > To: dev@dpdk.org
> > Cc: Mcnamara, John <john.mcnamara@intel.com>; thomas@monjalon.net;
> > stable@dpdk.org; Zhao1, Wei <wei.zhao1@intel.com>
> > Subject: [PATCH v5] 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.
> >
> > ...
> > +Queue region configuration
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> The underline for a section header should match the length of the text and
> should be followed by a blank line, line in my suggested changes.
> 
> See also:
> http://dpdk.org/doc/guides/contributing/documentation.html#section-
> headers
> 
> However, this isn't an error so:
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>
Applied to dpdk-next-net-intel, with commit log changes. Thanks!

/Helin
> 
>
  

Patch

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 50d5e36..29601f1 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,29 @@  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 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
+
 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 c37c71a..088778b 100644
--- a/doc/guides/rel_notes/release_17_11.rst
+++ b/doc/guides/rel_notes/release_17_11.rst
@@ -216,6 +216,13 @@  New Features
   profiles which can be programmed by dynamic device personalization (DDP)
   process.
 
+* **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.
+
 * **Updated ipsec-secgw application to support rte_security.**
 
   Updated the ``ipsec-secgw`` sample application to support ``rte_security``