[v6,3/3] doc: update queue number per vf for i40e

Message ID 20181218160933.11113-4-zhirun.yan@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Qi Zhang
Headers
Series Support request more queues |

Checks

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

Commit Message

Yan, Zhirun Dec. 18, 2018, 4:09 p.m. UTC
  Updated the doc and release notes on the support for requesting more queues.

Signed-off-by: Zhirun Yan <zhirun.yan@intel.com>
---
 doc/guides/nics/i40e.rst               | 16 +++++++++-------
 doc/guides/rel_notes/release_19_02.rst |  8 ++++++++
 2 files changed, 17 insertions(+), 7 deletions(-)
  

Comments

Qi Zhang Dec. 18, 2018, 12:59 p.m. UTC | #1
> -----Original Message-----
> From: Yan, Zhirun
> Sent: Wednesday, December 19, 2018 12:10 AM
> To: dev@dpdk.org; Zhang, Qi Z <qi.z.zhang@intel.com>
> Cc: Yan, Zhirun <zhirun.yan@intel.com>
> Subject: [PATCH v6 3/3] doc: update queue number per vf for i40e
> 
> Updated the doc and release notes on the support for requesting more queues.

Please fix the warning due to exceed 75 chars

> 
> Signed-off-by: Zhirun Yan <zhirun.yan@intel.com>
> ---
>  doc/guides/nics/i40e.rst               | 16 +++++++++-------
>  doc/guides/rel_notes/release_19_02.rst |  8 ++++++++
>  2 files changed, 17 insertions(+), 7 deletions(-)
> 
> diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index
> bfacbd117..70143d6a0 100644
> --- a/doc/guides/nics/i40e.rst
> +++ b/doc/guides/nics/i40e.rst
> @@ -129,13 +129,15 @@ Please note that enabling debugging options may affect
> system performance.
>  Runtime Config Options
>  ~~~~~~~~~~~~~~~~~~~~~~
> 
> -- ``Number of Queues per VF`` (default ``4``)
> -
> -  The number of queue per VF is determined by its host PF. If the PCI address
> -  of an i40e PF is aaaa:bb.cc, the number of queues per VF can be configured
> -  with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value n can
> be
> -  1, 2, 4, 8 or 16. If no such parameter is configured, the number of queues
> -  per VF is 4 by default.
> +- ``Reserved number of Queues per VF`` (default ``4``)
> +
> +  The number of reserved queue per VF is determined by its host PF. If
> + the  PCI address of an i40e PF is aaaa:bb.cc, the number of reserved
> + queues per  VF can be configured with EAL parameter like -w
> aaaa:bb.cc,queue-num-per-vf=n.
> +  The value n can be 1, 2, 4, 8 or 16. If no such parameter is
> + configured, the  number of reserved queues per VF is 4 by default. If
> + VF request more than  reserved queues per VF, PF will able to allocate
> + max to 16 queues after a VF  reset.
> 
>  - ``Support multiple driver`` (default ``disable``)
> 
> diff --git a/doc/guides/rel_notes/release_19_02.rst
> b/doc/guides/rel_notes/release_19_02.rst
> index e86ef9511..f99443cfa 100644
> --- a/doc/guides/rel_notes/release_19_02.rst
> +++ b/doc/guides/rel_notes/release_19_02.rst
> @@ -60,6 +60,14 @@ New Features
>    * Added the handler to get firmware version string.
>    * Added support for multicast filtering.
> 
> +* **Support dynamic queues allocation for VF.**

I think you need to specify this is for i40e.

Base on previous release note. It's better to follow the style like "Added ..."
So It could be "Added dynamic queues allocation support for i40e VF".

> +
> +  Previously, available queues of VF is reserved by PF at initialize stage.
> +  Now both DPDK PF and Kernel PF (>=2.1.14) will support dynamic queue
> + allocation. At runtime, when VF request more queue number exceed the
> + initial  reserved amount, PF can allocate up to 16 queues as the
> + request after a VF  reset.
> +


> 
>  Removed Items
>  -------------
> --
> 2.17.1
  
Yan, Zhirun Dec. 19, 2018, 1:33 a.m. UTC | #2
> -----Original Message-----
> From: Zhang, Qi Z
> Sent: Tuesday, December 18, 2018 9:00 PM
> To: Yan, Zhirun <zhirun.yan@intel.com>; dev@dpdk.org
> Subject: RE: [PATCH v6 3/3] doc: update queue number per vf for i40e
> 
> 
> 
> > -----Original Message-----
> > From: Yan, Zhirun
> > Sent: Wednesday, December 19, 2018 12:10 AM
> > To: dev@dpdk.org; Zhang, Qi Z <qi.z.zhang@intel.com>
> > Cc: Yan, Zhirun <zhirun.yan@intel.com>
> > Subject: [PATCH v6 3/3] doc: update queue number per vf for i40e
> >
> > Updated the doc and release notes on the support for requesting more
> queues.
> 
> Please fix the warning due to exceed 75 chars
> 
> >
> > Signed-off-by: Zhirun Yan <zhirun.yan@intel.com>
> > ---
> >  doc/guides/nics/i40e.rst               | 16 +++++++++-------
> >  doc/guides/rel_notes/release_19_02.rst |  8 ++++++++
> >  2 files changed, 17 insertions(+), 7 deletions(-)
> >
> > diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index
> > bfacbd117..70143d6a0 100644
> > --- a/doc/guides/nics/i40e.rst
> > +++ b/doc/guides/nics/i40e.rst
> > @@ -129,13 +129,15 @@ Please note that enabling debugging options may
> > affect system performance.
> >  Runtime Config Options
> >  ~~~~~~~~~~~~~~~~~~~~~~
> >
> > -- ``Number of Queues per VF`` (default ``4``)
> > -
> > -  The number of queue per VF is determined by its host PF. If the PCI
> > address
> > -  of an i40e PF is aaaa:bb.cc, the number of queues per VF can be
> > configured
> > -  with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value
> > n can be
> > -  1, 2, 4, 8 or 16. If no such parameter is configured, the number of
> > queues
> > -  per VF is 4 by default.
> > +- ``Reserved number of Queues per VF`` (default ``4``)
> > +
> > +  The number of reserved queue per VF is determined by its host PF.
> > + If the  PCI address of an i40e PF is aaaa:bb.cc, the number of
> > + reserved queues per  VF can be configured with EAL parameter like -w
> > aaaa:bb.cc,queue-num-per-vf=n.
> > +  The value n can be 1, 2, 4, 8 or 16. If no such parameter is
> > + configured, the  number of reserved queues per VF is 4 by default.
> > + If VF request more than  reserved queues per VF, PF will able to
> > + allocate max to 16 queues after a VF  reset.
> >
> >  - ``Support multiple driver`` (default ``disable``)
> >
> > diff --git a/doc/guides/rel_notes/release_19_02.rst
> > b/doc/guides/rel_notes/release_19_02.rst
> > index e86ef9511..f99443cfa 100644
> > --- a/doc/guides/rel_notes/release_19_02.rst
> > +++ b/doc/guides/rel_notes/release_19_02.rst
> > @@ -60,6 +60,14 @@ New Features
> >    * Added the handler to get firmware version string.
> >    * Added support for multicast filtering.
> >
> > +* **Support dynamic queues allocation for VF.**
> 
> I think you need to specify this is for i40e.
> 
> Base on previous release note. It's better to follow the style like "Added ..."
> So It could be "Added dynamic queues allocation support for i40e VF".
> 

Yes, I will modify it in next version.

> > +
> > +  Previously, available queues of VF is reserved by PF at initialize stage.
> > +  Now both DPDK PF and Kernel PF (>=2.1.14) will support dynamic
> > + queue allocation. At runtime, when VF request more queue number
> > + exceed the initial  reserved amount, PF can allocate up to 16 queues
> > + as the request after a VF  reset.
> > +
> 
> 
> >
> >  Removed Items
> >  -------------
> > --
> > 2.17.1
  

Patch

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index bfacbd117..70143d6a0 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -129,13 +129,15 @@  Please note that enabling debugging options may affect system performance.
 Runtime Config Options
 ~~~~~~~~~~~~~~~~~~~~~~
 
-- ``Number of Queues per VF`` (default ``4``)
-
-  The number of queue per VF is determined by its host PF. If the PCI address
-  of an i40e PF is aaaa:bb.cc, the number of queues per VF can be configured
-  with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value n can be
-  1, 2, 4, 8 or 16. If no such parameter is configured, the number of queues
-  per VF is 4 by default.
+- ``Reserved number of Queues per VF`` (default ``4``)
+
+  The number of reserved queue per VF is determined by its host PF. If the
+  PCI address of an i40e PF is aaaa:bb.cc, the number of reserved queues per
+  VF can be configured with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n.
+  The value n can be 1, 2, 4, 8 or 16. If no such parameter is configured, the
+  number of reserved queues per VF is 4 by default. If VF request more than
+  reserved queues per VF, PF will able to allocate max to 16 queues after a VF
+  reset.
 
 - ``Support multiple driver`` (default ``disable``)
 
diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst
index e86ef9511..f99443cfa 100644
--- a/doc/guides/rel_notes/release_19_02.rst
+++ b/doc/guides/rel_notes/release_19_02.rst
@@ -60,6 +60,14 @@  New Features
   * Added the handler to get firmware version string.
   * Added support for multicast filtering.
 
+* **Support dynamic queues allocation for VF.**
+
+  Previously, available queues of VF is reserved by PF at initialize stage.
+  Now both DPDK PF and Kernel PF (>=2.1.14) will support dynamic queue
+  allocation. At runtime, when VF request more queue number exceed the initial
+  reserved amount, PF can allocate up to 16 queues as the request after a VF
+  reset.
+
 
 Removed Items
 -------------