[dpdk-dev] doc: move i40e know issue to new file

Message ID 1490330480-26531-1-git-send-email-qiming.yang@intel.com (mailing list archive)
State Changes Requested, archived
Delegated to: Ferruh Yigit
Headers

Checks

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

Commit Message

Qiming Yang March 24, 2017, 4:41 a.m. UTC
  This patch moved i40e related know issues from doc/guides/rel_notes/
known_issues.rst to driver/net/i40e/i40e_know_issues.rst, makes us easy
to track the issue about i40e.

Signed-off-by: Qiming Yang <qiming.yang@intel.com>
---
 doc/guides/rel_notes/known_issues.rst | 65 -----------------------------------
 drivers/net/i40e/i40e_know_issues.rst | 54 +++++++++++++++++++++++++++++
 2 files changed, 54 insertions(+), 65 deletions(-)
 create mode 100644 drivers/net/i40e/i40e_know_issues.rst
  

Comments

Wenzhuo Lu March 24, 2017, 5:03 a.m. UTC | #1
Hi Qiming,

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

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

> Sent: Friday, March 24, 2017 12:41 PM

> To: dev@dpdk.org

> Cc: Wu, Jingjing; Yang, Qiming

> Subject: [dpdk-dev] [PATCH] doc: move i40e know issue to new file

> 

> This patch moved i40e related know issues from doc/guides/rel_notes/

> known_issues.rst to driver/net/i40e/i40e_know_issues.rst, makes us easy to

> track the issue about i40e.

> 

> Signed-off-by: Qiming Yang <qiming.yang@intel.com>

> ---

>  doc/guides/rel_notes/known_issues.rst | 65 -----------------------------------

>  drivers/net/i40e/i40e_know_issues.rst | 54

> +++++++++++++++++++++++++++++

You create a new file for it? We already have a doc file here, doc/guides/nics/i40e.rst.
  
John McNamara March 24, 2017, 2:33 p.m. UTC | #2
> -----Original Message-----

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

> Sent: Friday, March 24, 2017 4:41 AM

> To: dev@dpdk.org

> Cc: Wu, Jingjing <jingjing.wu@intel.com>; Yang, Qiming

> <qiming.yang@intel.com>

> Subject: [dpdk-dev] [PATCH] doc: move i40e know issue to new file

> 

> This patch moved i40e related know issues from doc/guides/rel_notes/

> known_issues.rst to driver/net/i40e/i40e_know_issues.rst, makes us easy to

> track the issue about i40e.



That's good. Someone should probably check if there are other cases like this
in the last 3-4 releases and move them as well.

Acked-by: John McNamara <john.mcnamara@intel.com>
  
John McNamara March 24, 2017, 2:38 p.m. UTC | #3
> -----Original Message-----

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John

> Sent: Friday, March 24, 2017 2:33 PM

> To: Yang, Qiming <qiming.yang@intel.com>; dev@dpdk.org

> Cc: Wu, Jingjing <jingjing.wu@intel.com>; Yang, Qiming

> <qiming.yang@intel.com>

> Subject: Re: [dpdk-dev] [PATCH] doc: move i40e know issue to new file

> 

> 

> 

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

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

> > Sent: Friday, March 24, 2017 4:41 AM

> > To: dev@dpdk.org

> > Cc: Wu, Jingjing <jingjing.wu@intel.com>; Yang, Qiming

> > <qiming.yang@intel.com>

> > Subject: [dpdk-dev] [PATCH] doc: move i40e know issue to new file

> >

> > This patch moved i40e related know issues from doc/guides/rel_notes/

> > known_issues.rst to driver/net/i40e/i40e_know_issues.rst, makes us

> > easy to track the issue about i40e.

> 

> 

> That's good. Someone should probably check if there are other cases like

> this in the last 3-4 releases and move them as well.

> 


Sorry. I missed the fact that this was going to a new, i40e, specific file.
I don't think that is a good idea. Maybe there could be a new i40e section
in the known issues doc but I don't think that we should introduce a new
file.

John
  
Qiming Yang March 27, 2017, 1:23 a.m. UTC | #4
Hi, Wenzhuo

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

> From: Lu, Wenzhuo

> Sent: Friday, March 24, 2017 1:03 PM

> To: Yang, Qiming <qiming.yang@intel.com>; dev@dpdk.org

> Cc: Wu, Jingjing <jingjing.wu@intel.com>; Yang, Qiming

> <qiming.yang@intel.com>

> Subject: RE: [dpdk-dev] [PATCH] doc: move i40e know issue to new file

> 

> Hi Qiming,

> 

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

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

> > Sent: Friday, March 24, 2017 12:41 PM

> > To: dev@dpdk.org

> > Cc: Wu, Jingjing; Yang, Qiming

> > Subject: [dpdk-dev] [PATCH] doc: move i40e know issue to new file

> >

> > This patch moved i40e related know issues from doc/guides/rel_notes/

> > known_issues.rst to driver/net/i40e/i40e_know_issues.rst, makes us

> > easy to track the issue about i40e.

> >

> > Signed-off-by: Qiming Yang <qiming.yang@intel.com>

> > ---

> >  doc/guides/rel_notes/known_issues.rst | 65

> > -----------------------------------

> >  drivers/net/i40e/i40e_know_issues.rst | 54

> > +++++++++++++++++++++++++++++

> You create a new file for it? We already have a doc file here,

> doc/guides/nics/i40e.rst.

You are right, thank you for your remind. I'll fix it.
  
Qiming Yang March 27, 2017, 1:43 a.m. UTC | #5
Hi, John

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

> From: Mcnamara, John

> Sent: Friday, March 24, 2017 10:38 PM

> To: Mcnamara, John <john.mcnamara@intel.com>; Yang, Qiming

> <qiming.yang@intel.com>; dev@dpdk.org

> Cc: Wu, Jingjing <jingjing.wu@intel.com>; Yang, Qiming

> <qiming.yang@intel.com>

> Subject: RE: [dpdk-dev] [PATCH] doc: move i40e know issue to new file

> 

> 

> 

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

> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John

> > Sent: Friday, March 24, 2017 2:33 PM

> > To: Yang, Qiming <qiming.yang@intel.com>; dev@dpdk.org

> > Cc: Wu, Jingjing <jingjing.wu@intel.com>; Yang, Qiming

> > <qiming.yang@intel.com>

> > Subject: Re: [dpdk-dev] [PATCH] doc: move i40e know issue to new file

> >

> >

> >

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

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

> > > Sent: Friday, March 24, 2017 4:41 AM

> > > To: dev@dpdk.org

> > > Cc: Wu, Jingjing <jingjing.wu@intel.com>; Yang, Qiming

> > > <qiming.yang@intel.com>

> > > Subject: [dpdk-dev] [PATCH] doc: move i40e know issue to new file

> > >

> > > This patch moved i40e related know issues from doc/guides/rel_notes/

> > > known_issues.rst to driver/net/i40e/i40e_know_issues.rst, makes us

> > > easy to track the issue about i40e.

> >

> >

> > That's good. Someone should probably check if there are other cases

> > like this in the last 3-4 releases and move them as well.

> >

> 

> Sorry. I missed the fact that this was going to a new, i40e, specific file.

> I don't think that is a good idea. Maybe there could be a new i40e section in

> the known issues doc but I don't think that we should introduce a new file.

> 

> John


You are right, it's no need to introduce a new file, but Wenzhuo told me an exist doc doc/guides/nics/i40e.rst. What do you think to move the i40e relate known issues to this doc? 

Qiming
  
John McNamara March 27, 2017, 10:29 a.m. UTC | #6
> -----Original Message-----

> From: Yang, Qiming

> Sent: Monday, March 27, 2017 2:44 AM

> To: Mcnamara, John <john.mcnamara@intel.com>; dev@dpdk.org

> Cc: Wu, Jingjing <jingjing.wu@intel.com>

> Subject: RE: [dpdk-dev] [PATCH] doc: move i40e know issue to new file

> 

> 

> You are right, it's no need to introduce a new file, but Wenzhuo told me

> an exist doc doc/guides/nics/i40e.rst. What do you think to move the i40e

> relate known issues to this doc?

> 


Yes. There is an existing "Limitations or Known Issues" section that you
could use:

    http://dpdk.org/doc/guides/nics/i40e.html#limitations-or-known-issues

John
  

Patch

diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst
index f149ac7..5b702c5 100644
--- a/doc/guides/rel_notes/known_issues.rst
+++ b/doc/guides/rel_notes/known_issues.rst
@@ -513,25 +513,6 @@  Ethertype filter could receive other packets (non-assigned) in Niantic
    Poll Mode Driver (PMD).
 
 
-Cannot set link speed on Intel® 40G Ethernet controller
--------------------------------------------------------
-
-**Description**:
-   On Intel® 40G Ethernet Controller you cannot set the link to specific speed.
-
-**Implication**:
-   The link speed cannot be changed forcibly, though it can be configured by application.
-
-**Resolution/Workaround**:
-   None
-
-**Affected Environment/Platform**:
-   All.
-
-**Driver/Module**:
-   Poll Mode Driver (PMD).
-
-
 Devices bound to igb_uio with VT-d enabled do not work on Linux kernel 3.15-3.17
 --------------------------------------------------------------------------------
 
@@ -622,52 +603,6 @@  The last EAL argument is replaced by the program name in argv[]
    Environment Abstraction Layer (EAL).
 
 
-I40e VF may not receive packets in the promiscuous mode
--------------------------------------------------------
-
-**Description**:
-   Promiscuous mode is not supported by the DPDK i40e VF driver when using the
-   i40e Linux kernel driver as host driver.
-
-**Implication**:
-   The i40e VF does not receive packets when the destination MAC address is unknown.
-
-**Resolution/Workaround**:
-   Use a explicit destination MAC address that matches the VF.
-
-**Affected Environment/Platform**:
-   All.
-
-**Driver/Module**:
-   Poll Mode Driver (PMD).
-
-
-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 use ``--bind=uio_pci_generic``, the ``uio_pci_generic`` module probes 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 the ``uio_pci_generic`` module in X710/XL710/XXV710 NICs.
-
-**Affected Environment/Platform**:
-   All.
-
-**Driver/Module**:
-   Poll Mode Driver (PMD).
-
-
 virtio tx_burst() function cannot do TSO on shared packets
 ----------------------------------------------------------
 
diff --git a/drivers/net/i40e/i40e_know_issues.rst b/drivers/net/i40e/i40e_know_issues.rst
new file mode 100644
index 0000000..2279eaf
--- /dev/null
+++ b/drivers/net/i40e/i40e_know_issues.rst
@@ -0,0 +1,54 @@ 
+Cannot set link speed on Intel® 40G Ethernet controller
+-------------------------------------------------------
+
+**Description**:
+   On Intel® 40G Ethernet Controller you cannot set the link to specific speed.
+
+**Implication**:
+   The link speed cannot be changed forcibly, though it can be configured by application.
+
+**Resolution/Workaround**:
+   None
+
+**Affected Environment/Platform**:
+   All.
+
+
+I40e VF may not receive packets in the promiscuous mode
+-------------------------------------------------------
+
+**Description**:
+   Promiscuous mode is not supported by the DPDK i40e VF driver when using the
+   i40e Linux kernel driver as host driver.
+
+**Implication**:
+   The i40e VF does not receive packets when the destination MAC address is unknown.
+
+**Resolution/Workaround**:
+   Use a explicit destination MAC address that matches the VF.
+
+**Affected Environment/Platform**:
+   All.
+
+
+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 use ``--bind=uio_pci_generic``, the ``uio_pci_generic`` module probes 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 the ``uio_pci_generic`` module in X710/XL710/XXV710 NICs.
+
+**Affected Environment/Platform**:
+   All.