[dpdk-dev,v3] doc: add known uio_pci_generic issue for i40e

Message ID 1484823403-24868-1-git-send-email-jia.guo@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers

Checks

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

Commit Message

Guo, Jia Jan. 19, 2017, 10:56 a.m. UTC
From: "Guo, Jia" <jia.guo@intel.com>

When bind with the "uio_pci_generic" module in X710/XL710/XXV710,
the result is failed. The "uio_pci_generic" module is not supported
by X710/XL710/XXV710.

Signed-off-by: Guo, Jia <jia.guo@intel.com>
Acked-by: Jingjing Wu <jingjing.wu@intel.com>
---
v3: add related linux kernel commit info and fix some syntax issues
v2: add X710/XXV710 limitation case
---
 doc/guides/rel_notes/known_issues.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
  

Comments

Mcnamara, John Jan. 19, 2017, 11:17 a.m. UTC | #1
> -----Original Message-----

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Jeff Guo

> Sent: Thursday, January 19, 2017 10:57 AM

> To: Zhang, Helin <helin.zhang@intel.com>; Wu, Jingjing

> <jingjing.wu@intel.com>

> Cc: dev@dpdk.org; Guo, Jia <jia.guo@intel.com>; Guo@dpdk.org

> Subject: [dpdk-dev] [PATCH v3] doc: add known uio_pci_generic issue for

> i40e

> 

> +

> +The uio_pci_generic module bind failed in X710/XL710/XXV710

> +-----------------------------------------------------------

> +

> +**Description**:

> +   The “uio_pci_generic” module is not supported by XL710, since the

> errata of XL710

> +   states that the Interrupt Status bit is not implemented. The errata is

> the item #71

> +   from the `xl710 controller spec

> +


> <http://www.intel.com/content/www/us/en/embedded/products/networking/xl710

> -10-40-controller-spec-update.html>`_.

> +   The hw limitation is the same as other X710/XXV710 NICs.

> +

> +**Implication**:

> +   When bind the “uio_pci_generic” module, it probe device and check the

> Interrupt Status


Better as: When using ``bind uio_pci_generic``, it probes the device


> +   bit. Since it is not supported by X710/XL710/XXV710, it return a

> *failed* value. The statement

> +   that these products don’t support INTx masking, is indicated in the

> related `linux kernel commit

> +   < https://git.kernel.org/cgit/linux/kernel/git/stable/linux-

> stable.git/commit/drivers/pci/quirks.c?id=8bcf4525c5d43306c5fd07e132bc8650

> e3491aec>`_.

> +

> +**Resolution/Workaround**:

> +   Do not bind to use the “uio_pci_generic” module in X710/XL710/XXV710

> NICs.


Better as: Do not bind to ``uio_pci_generic`` in X710/XL710/XXV710 NICs.
  
Ferruh Yigit Jan. 19, 2017, 12:06 p.m. UTC | #2
On 1/19/2017 10:56 AM, Jeff Guo wrote:
> From: "Guo, Jia" <jia.guo@intel.com>
> 
> When bind with the "uio_pci_generic" module in X710/XL710/XXV710,
> the result is failed. The "uio_pci_generic" module is not supported
> by X710/XL710/XXV710.
> 
> Signed-off-by: Guo, Jia <jia.guo@intel.com>

To be consistent on names, this should be "Jeff Guo <jia.guo@intel.com>"
both in sign-off and author field.

If you will send a new version of the patch, please take care of this
too, if there won't be a new version please confirm it is OK to fix
while applying.

Thanks,
ferruh

<...>
  
Guo, Jia Jan. 19, 2017, 1:50 p.m. UTC | #3
Hi,john
      The "bind uio_pci_generic`` is not the definitely command, but very appreciate for your correcting the other syntax issue. I will involve them in v4, Thanks very much.

Best regards,
Jeff Guo


-----Original Message-----
From: Mcnamara, John 

Sent: Thursday, January 19, 2017 7:17 PM
To: Guo, Jia <jia.guo@intel.com>; Zhang, Helin <helin.zhang@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>
Cc: dev@dpdk.org; Guo, Jia <jia.guo@intel.com>; Guo@dpdk.org
Subject: RE: [dpdk-dev] [PATCH v3] doc: add known uio_pci_generic issue for i40e



> -----Original Message-----

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Jeff Guo

> Sent: Thursday, January 19, 2017 10:57 AM

> To: Zhang, Helin <helin.zhang@intel.com>; Wu, Jingjing 

> <jingjing.wu@intel.com>

> Cc: dev@dpdk.org; Guo, Jia <jia.guo@intel.com>; Guo@dpdk.org

> Subject: [dpdk-dev] [PATCH v3] doc: add known uio_pci_generic issue 

> for i40e

> 

> +

> +The uio_pci_generic module bind failed in X710/XL710/XXV710

> +-----------------------------------------------------------

> +

> +**Description**:

> +   The “uio_pci_generic” module is not supported by XL710, since the

> errata of XL710

> +   states that the Interrupt Status bit is not implemented. The 

> + errata is

> the item #71

> +   from the `xl710 controller spec

> +


> <http://www.intel.com/content/www/us/en/embedded/products/networking/x

> l710 -10-40-controller-spec-update.html>`_.

> +   The hw limitation is the same as other X710/XXV710 NICs.

> +

> +**Implication**:

> +   When bind the “uio_pci_generic” module, it probe device and check 

> +the

> Interrupt Status


Better as: When using ``bind uio_pci_generic``, it probes the device


> +   bit. Since it is not supported by X710/XL710/XXV710, it return a

> *failed* value. The statement

> +   that these products don’t support INTx masking, is indicated in 

> + the

> related `linux kernel commit

> +   < https://git.kernel.org/cgit/linux/kernel/git/stable/linux-

> stable.git/commit/drivers/pci/quirks.c?id=8bcf4525c5d43306c5fd07e132bc

> 8650

> e3491aec>`_.

> +

> +**Resolution/Workaround**:

> +   Do not bind to use the “uio_pci_generic” module in 

> +X710/XL710/XXV710

> NICs.


Better as: Do not bind to ``uio_pci_generic`` in X710/XL710/XXV710 NICs.
  
Guo, Jia Jan. 19, 2017, 1:53 p.m. UTC | #4
Yes, rerruh, I will recheck the gitconfig and consistent the sign-off name in v4. thanks for your suggestion. 

Best regards,
Jeff Guo


-----Original Message-----
From: Yigit, Ferruh 

Sent: Thursday, January 19, 2017 8:06 PM
To: Guo, Jia <jia.guo@intel.com>; Zhang, Helin <helin.zhang@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>
Cc: dev@dpdk.org; Guo@dpdk.org
Subject: Re: [dpdk-dev] [PATCH v3] doc: add known uio_pci_generic issue for i40e

On 1/19/2017 10:56 AM, Jeff Guo wrote:
> From: "Guo, Jia" <jia.guo@intel.com>

> 

> When bind with the "uio_pci_generic" module in X710/XL710/XXV710, the 

> result is failed. The "uio_pci_generic" module is not supported by 

> X710/XL710/XXV710.

> 

> Signed-off-by: Guo, Jia <jia.guo@intel.com>


To be consistent on names, this should be "Jeff Guo <jia.guo@intel.com>"
both in sign-off and author field.

If you will send a new version of the patch, please take care of this too, if there won't be a new version please confirm it is OK to fix while applying.

Thanks,
ferruh

<...>
  
Mcnamara, John Jan. 19, 2017, 2:53 p.m. UTC | #5
> -----Original Message-----

> From: Guo, Jia

> Sent: Thursday, January 19, 2017 1:50 PM

> To: Mcnamara, John <john.mcnamara@intel.com>; Zhang, Helin

> <helin.zhang@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>

> Cc: dev@dpdk.org; Guo@dpdk.org

> Subject: RE: [dpdk-dev] [PATCH v3] doc: add known uio_pci_generic issue

> for i40e

> 

> Hi,john

>       The "bind uio_pci_generic`` is not the definitely command, but very

> appreciate for your correcting the other syntax issue. I will involve them

> in v4, Thanks very much.


Hi Jeff, 

Variables, functions, program names, file names and any other literal should 
be in backtick quotes, as outlined in the DPDK Documentation: 

http://dpdk.org/doc/guides/contributing/documentation.html#code-and-literal-block-sections

So uio_pci_generic should be quoted with backticks. If you want to add bind then do:
``--bind= uio_pci_generic`` or similar.

Either way it shouldn't be quoted using the "smart" Unicode or non-Unicode quotes as in the
patch. All quotes should be straight ASCII double quotes (""). The Html/PDF renderers
will convert to the correct quotes as required.



> > related `linux kernel commit

> > +   < https://git.kernel.org/cgit/linux/kernel/git/stable/linux-

> > stable.git/commit/drivers/pci/quirks.c?id=8bcf4525c5d43306c5fd07e132bc

> > 8650

> > e3491aec>`_.


Also, this link generates a doc build error. I think because of the space
between the < and the https:.

John
  
Guo, Jia Jan. 20, 2017, 2:28 a.m. UTC | #6
Ok, that make sense, I will re-correct it then. Thanks.

Best regards,
Jeff Guo

-----Original Message-----
From: Mcnamara, John 

Sent: Thursday, January 19, 2017 10:54 PM
To: Guo, Jia <jia.guo@intel.com>; Zhang, Helin <helin.zhang@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>
Cc: dev@dpdk.org; Guo@dpdk.org
Subject: RE: [dpdk-dev] [PATCH v3] doc: add known uio_pci_generic issue for i40e

> -----Original Message-----

> From: Guo, Jia

> Sent: Thursday, January 19, 2017 1:50 PM

> To: Mcnamara, John <john.mcnamara@intel.com>; Zhang, Helin 

> <helin.zhang@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>

> Cc: dev@dpdk.org; Guo@dpdk.org

> Subject: RE: [dpdk-dev] [PATCH v3] doc: add known uio_pci_generic 

> issue for i40e

> 

> Hi,john

>       The "bind uio_pci_generic`` is not the definitely command, but 

> very appreciate for your correcting the other syntax issue. I will 

> involve them in v4, Thanks very much.


Hi Jeff, 

Variables, functions, program names, file names and any other literal should be in backtick quotes, as outlined in the DPDK Documentation: 

http://dpdk.org/doc/guides/contributing/documentation.html#code-and-literal-block-sections

So uio_pci_generic should be quoted with backticks. If you want to add bind then do:
``--bind= uio_pci_generic`` or similar.

Either way it shouldn't be quoted using the "smart" Unicode or non-Unicode quotes as in the patch. All quotes should be straight ASCII double quotes (""). The Html/PDF renderers will convert to the correct quotes as required.



> > related `linux kernel commit

> > +   < https://git.kernel.org/cgit/linux/kernel/git/stable/linux-

> > stable.git/commit/drivers/pci/quirks.c?id=8bcf4525c5d43306c5fd07e132

> > bc

> > 8650

> > e3491aec>`_.


Also, this link generates a doc build error. I think because of the space between the < and the https:.

John
  

Patch

diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst
index 3cd4237..8b083a0 100644
--- a/doc/guides/rel_notes/known_issues.rst
+++ b/doc/guides/rel_notes/known_issues.rst
@@ -640,3 +640,29 @@  I40e VF may not receive packets in the promiscuous mode
 
 **Driver/Module**:
    Poll Mode Driver (PMD).
+
+
+The uio_pci_generic module bind failed in X710/XL710/XXV710
+-----------------------------------------------------------
+
+**Description**:
+   The “uio_pci_generic” module is not supported by XL710, since the errata of XL710
+   states that the Interrupt Status bit is not implemented. The errata is the item #71
+   from the `xl710 controller spec
+   <http://www.intel.com/content/www/us/en/embedded/products/networking/xl710-10-40-controller-spec-update.html>`_.
+   The hw limitation is the same as other X710/XXV710 NICs.
+
+**Implication**:
+   When bind the “uio_pci_generic” module, it probe device and check the Interrupt Status
+   bit. Since it is not supported by X710/XL710/XXV710, it return a *failed* value. The statement
+   that these products don’t support INTx masking, is indicated in the related `linux kernel commit
+   < https://git.kernel.org/cgit/linux/kernel/git/stable/linux-stable.git/commit/drivers/pci/quirks.c?id=8bcf4525c5d43306c5fd07e132bc8650e3491aec>`_.
+
+**Resolution/Workaround**:
+   Do not bind to use the “uio_pci_generic” module in X710/XL710/XXV710 NICs.
+
+**Affected Environment/Platform**:
+   All.
+
+**Driver/Module**:
+   Poll Mode Driver (PMD).