doc: add tested NICs in i40e guide

Message ID 1532327644-21715-1-git-send-email-xiaoyun.li@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Qi Zhang
Headers
Series doc: add tested NICs in i40e guide |

Checks

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

Commit Message

Li, Xiaoyun July 23, 2018, 6:34 a.m. UTC
  Add suggested kernel driver and firmware version for i40e PMD.

Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com>
---
 doc/guides/nics/i40e.rst | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
  

Comments

Xing, Beilei July 24, 2018, 5:26 a.m. UTC | #1
> -----Original Message-----
> From: Li, Xiaoyun
> Sent: Monday, July 23, 2018 2:34 PM
> To: Mcnamara, John <john.mcnamara@intel.com>; Xing, Beilei
> <beilei.xing@intel.com>; Zhang, Qi Z <qi.z.zhang@intel.com>
> Cc: dev@dpdk.org; Li, Xiaoyun <xiaoyun.li@intel.com>
> Subject: [PATCH] doc: add tested NICs in i40e guide
> 
> Add suggested kernel driver and firmware version for i40e PMD.
> 
> Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com>
> ---
>  doc/guides/nics/i40e.rst | 29 +++++++++++++++++++++++++++++
>  1 file changed, 29 insertions(+)
> 
> diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index
> d5b02c9..d377d92 100644
> --- a/doc/guides/nics/i40e.rst
> +++ b/doc/guides/nics/i40e.rst
> @@ -58,6 +58,35 @@ Prerequisites
>  - Upgrade the NVM/FW version following the `Intel® Ethernet NVM Update
> Tool Quick Usage Guide for Linux
>    <https://www-
> ssl.intel.com/content/www/us/en/embedded/products/networking/nvm-
> update-tool-quick-linux-usage-guide.html>`_ and `Intel® Ethernet NVM
> Update Tool: Quick Usage Guide for EFI
> <https://www.intel.com/content/www/us/en/embedded/products/network
> ing/nvm-update-tool-quick-efi-usage-guide.html>`_ if needed.
> 
> +Tested NICs

The guide is only for i40e, so we'd better change the title, how about recommended matching list?
Also the patch title also needs to be changed.

> +-----------
> +
> +It is highly recommended to upgrade the i40e kernel driver and firmware
> +to avoid the compatibility issues with i40e PMD. Here is the suggested
> +matching list which has been tested and verified.
> +
> +   +--------------+-----------------------+------------------+
> +   | DPDK version | Kernel driver version | Firmware version |
> +   +==============+=======================+==================+
> +   |    18.05     |         2.4.6         |       6.01       |
> +   +--------------+-----------------------+------------------+
> +   |    18.02     |         2.4.3         |       6.01       |
> +   +--------------+-----------------------+------------------+
> +   |    17.11     |         2.1.26        |       6.01       |
> +   +--------------+-----------------------+------------------+
> +   |    17.08     |         2.0.19        |       6.01       |
> +   +--------------+-----------------------+------------------+
> +   |    17.05     |         1.5.23        |       5.05       |
> +   +--------------+-----------------------+------------------+
> +   |    17.02     |         1.5.23        |       5.05       |
> +   +--------------+-----------------------+------------------+
> +   |    16.11     |         1.5.23        |       5.05       |
> +   +--------------+-----------------------+------------------+
> +   |    16.07     |         1.4.25        |       5.04       |
> +   +--------------+-----------------------+------------------+
> +   |    16.04     |         1.4.25        |       5.02       |
> +   +--------------+-----------------------+------------------+
> +
>  Pre-Installation Configuration
>  ------------------------------
> 
> --
> 2.7.4
  
Li, Xiaoyun July 24, 2018, 6:45 a.m. UTC | #2
> -----Original Message-----
> From: Xing, Beilei
> Sent: Tuesday, July 24, 2018 13:27
> To: Li, Xiaoyun <xiaoyun.li@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Zhang, Qi Z <qi.z.zhang@intel.com>
> Cc: dev@dpdk.org
> Subject: RE: [PATCH] doc: add tested NICs in i40e guide
> 
> 
> 
> > -----Original Message-----
> > From: Li, Xiaoyun
> > Sent: Monday, July 23, 2018 2:34 PM
> > To: Mcnamara, John <john.mcnamara@intel.com>; Xing, Beilei
> > <beilei.xing@intel.com>; Zhang, Qi Z <qi.z.zhang@intel.com>
> > Cc: dev@dpdk.org; Li, Xiaoyun <xiaoyun.li@intel.com>
> > Subject: [PATCH] doc: add tested NICs in i40e guide
> >
> > Add suggested kernel driver and firmware version for i40e PMD.
> >
> > Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com>
> > ---
> >  doc/guides/nics/i40e.rst | 29 +++++++++++++++++++++++++++++
> >  1 file changed, 29 insertions(+)
> >
> > diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index
> > d5b02c9..d377d92 100644
> > --- a/doc/guides/nics/i40e.rst
> > +++ b/doc/guides/nics/i40e.rst
> > @@ -58,6 +58,35 @@ Prerequisites
> >  - Upgrade the NVM/FW version following the `Intel® Ethernet NVM
> > Update Tool Quick Usage Guide for Linux
> >    <https://www-
> > ssl.intel.com/content/www/us/en/embedded/products/networking/nvm-
> > update-tool-quick-linux-usage-guide.html>`_ and `Intel® Ethernet NVM
> > Update Tool: Quick Usage Guide for EFI
> >
> <https://www.intel.com/content/www/us/en/embedded/products/network
> > ing/nvm-update-tool-quick-efi-usage-guide.html>`_ if needed.
> >
> > +Tested NICs
> 
> The guide is only for i40e, so we'd better change the title, how about
> recommended matching list?
> Also the patch title also needs to be changed.

OK. Will send v2 later. Thanks!

> 
> > +-----------
> > +
> > +It is highly recommended to upgrade the i40e kernel driver and
> > +firmware to avoid the compatibility issues with i40e PMD. Here is the
> > +suggested matching list which has been tested and verified.
> > +
> > +   +--------------+-----------------------+------------------+
> > +   | DPDK version | Kernel driver version | Firmware version |
> > +   +==============+=======================+==================+
> > +   |    18.05     |         2.4.6         |       6.01       |
> > +   +--------------+-----------------------+------------------+
> > +   |    18.02     |         2.4.3         |       6.01       |
> > +   +--------------+-----------------------+------------------+
> > +   |    17.11     |         2.1.26        |       6.01       |
> > +   +--------------+-----------------------+------------------+
> > +   |    17.08     |         2.0.19        |       6.01       |
> > +   +--------------+-----------------------+------------------+
> > +   |    17.05     |         1.5.23        |       5.05       |
> > +   +--------------+-----------------------+------------------+
> > +   |    17.02     |         1.5.23        |       5.05       |
> > +   +--------------+-----------------------+------------------+
> > +   |    16.11     |         1.5.23        |       5.05       |
> > +   +--------------+-----------------------+------------------+
> > +   |    16.07     |         1.4.25        |       5.04       |
> > +   +--------------+-----------------------+------------------+
> > +   |    16.04     |         1.4.25        |       5.02       |
> > +   +--------------+-----------------------+------------------+
> > +
> >  Pre-Installation Configuration
> >  ------------------------------
> >
> > --
> > 2.7.4
  

Patch

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index d5b02c9..d377d92 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -58,6 +58,35 @@  Prerequisites
 - Upgrade the NVM/FW version following the `Intel® Ethernet NVM Update Tool Quick Usage Guide for Linux
   <https://www-ssl.intel.com/content/www/us/en/embedded/products/networking/nvm-update-tool-quick-linux-usage-guide.html>`_ and `Intel® Ethernet NVM Update Tool: Quick Usage Guide for EFI <https://www.intel.com/content/www/us/en/embedded/products/networking/nvm-update-tool-quick-efi-usage-guide.html>`_ if needed.
 
+Tested NICs
+-----------
+
+It is highly recommended to upgrade the i40e kernel driver and firmware to
+avoid the compatibility issues with i40e PMD. Here is the suggested matching
+list which has been tested and verified.
+
+   +--------------+-----------------------+------------------+
+   | DPDK version | Kernel driver version | Firmware version |
+   +==============+=======================+==================+
+   |    18.05     |         2.4.6         |       6.01       |
+   +--------------+-----------------------+------------------+
+   |    18.02     |         2.4.3         |       6.01       |
+   +--------------+-----------------------+------------------+
+   |    17.11     |         2.1.26        |       6.01       |
+   +--------------+-----------------------+------------------+
+   |    17.08     |         2.0.19        |       6.01       |
+   +--------------+-----------------------+------------------+
+   |    17.05     |         1.5.23        |       5.05       |
+   +--------------+-----------------------+------------------+
+   |    17.02     |         1.5.23        |       5.05       |
+   +--------------+-----------------------+------------------+
+   |    16.11     |         1.5.23        |       5.05       |
+   +--------------+-----------------------+------------------+
+   |    16.07     |         1.4.25        |       5.04       |
+   +--------------+-----------------------+------------------+
+   |    16.04     |         1.4.25        |       5.02       |
+   +--------------+-----------------------+------------------+
+
 Pre-Installation Configuration
 ------------------------------