diff mbox series

[v3] doc: add i40e recommended matching list

Message ID 1532416780-23114-1-git-send-email-xiaoyun.li@intel.com (mailing list archive)
State Superseded, archived
Headers
Series [v3] doc: add i40e recommended matching list |

Checks

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

Commit Message

Li, Xiaoyun July 24, 2018, 7:19 a.m. UTC 
  Add suggested DPDK/kernel driver/firmware version matching list for i40e.

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

---
v3:
Polish the title and commit log.
v2:
Polish the title and section name.

Comments

Xing, Beilei July 24, 2018, 7:28 a.m. UTC | #1 
> -----Original Message-----
> From: Li, Xiaoyun
> Sent: Tuesday, July 24, 2018 3:20 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 v3] doc: add i40e recommended matching list
> 
> Add suggested DPDK/kernel driver/firmware version matching list for i40e.
> 
> Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com>
Acked-by: Beilei Xing <beilei.xing@intel.com>
Xu, Qian Q July 24, 2018, 7:32 a.m. UTC | #2 
Good doc, some suggestions
Better to list the exact firmware versions: 6.01 0x80003221
And better to give the NIC name and device id and etc, as below. Thx. 

Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G)
Firmware version: 6.01 0x80003221
Device id (pf/vf): 8086:1572 / 8086:154c
Driver version: 2.4.6 (i40e)
Intel Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
Firmware version: 3.33 0x80000fd5 0.0.0
Device id (pf/vf): 8086:37d0 / 8086:37cd
Driver version: 2.4.3 (i40e)
Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
Firmware version: 6.01 0x80003221
Device id (pf/vf): 8086:158b / 8086:154c
Driver version: 2.4.6 (i40e)
Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
Firmware version: 6.01 0x8000321c
Device id (pf/vf): 8086:1583 / 8086:154c
Driver version: 2.4.6 (i40e)

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Xiaoyun Li
> Sent: Tuesday, July 24, 2018 3:20 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: [dpdk-dev] [PATCH v3] doc: add i40e recommended matching list
> 
> Add suggested DPDK/kernel driver/firmware version matching list for i40e.
> 
> Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com>
> ---
>  doc/guides/nics/i40e.rst | 29 +++++++++++++++++++++++++++++
>  1 file changed, 29 insertions(+)
> 
> ---
> v3:
> Polish the title and commit log.
> v2:
> Polish the title and section name.
> 
> diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index
> d5b02c9..b8c1c1d 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.
> 
> +Recommended Matching List
> +-------------------------
> +
> +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, 7:46 a.m. UTC | #3 
> -----Original Message-----
> From: Xu, Qian Q
> Sent: Tuesday, July 24, 2018 15:32
> To: Li, Xiaoyun <xiaoyun.li@intel.com>; 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: RE: [dpdk-dev] [PATCH v3] doc: add i40e recommended matching list
> 
> Good doc, some suggestions
> Better to list the exact firmware versions: 6.01 0x80003221 And better to give
> the NIC name and device id and etc, as below. Thx.
> 
> Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G) Firmware
> version: 6.01 0x80003221 Device id (pf/vf): 8086:1572 / 8086:154c Driver
> version: 2.4.6 (i40e) Intel Corporation Ethernet Connection X722 for 10GbE
> SFP+ (4x10G) Firmware version: 3.33 0x80000fd5 0.0.0 Device id (pf/vf):
> 8086:37d0 / 8086:37cd Driver version: 2.4.3 (i40e)
> Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G) Firmware
> version: 6.01 0x80003221 Device id (pf/vf): 8086:158b / 8086:154c Driver
> version: 2.4.6 (i40e)
> Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G) Firmware
> version: 6.01 0x8000321c Device id (pf/vf): 8086:1583 / 8086:154c Driver
> version: 2.4.6 (i40e)

These detailed information is already in each release note. Should I add them again?
Or maybe I can just add a statement that the detail information can refer to the release notes.

> 
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Xiaoyun Li
> > Sent: Tuesday, July 24, 2018 3:20 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: [dpdk-dev] [PATCH v3] doc: add i40e recommended matching list
> >
> > Add suggested DPDK/kernel driver/firmware version matching list for i40e.
> >
> > Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com>
> > ---
> >  doc/guides/nics/i40e.rst | 29 +++++++++++++++++++++++++++++
> >  1 file changed, 29 insertions(+)
> >
> > ---
> > v3:
> > Polish the title and commit log.
> > v2:
> > Polish the title and section name.
> >
> > diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst index
> > d5b02c9..b8c1c1d 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.
> >
> > +Recommended Matching List
> > +-------------------------
> > +
> > +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
Qi Zhang July 30, 2018, 1:11 a.m. UTC | #4 
> -----Original Message-----
> From: Xing, Beilei
> Sent: Tuesday, July 24, 2018 3:29 PM
> 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 v3] doc: add i40e recommended matching list
> 
> 
> 
> > -----Original Message-----
> > From: Li, Xiaoyun
> > Sent: Tuesday, July 24, 2018 3:20 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 v3] doc: add i40e recommended matching list
> >
> > Add suggested DPDK/kernel driver/firmware version matching list for i40e.
> >
> > Signed-off-by: Xiaoyun Li <xiaoyun.li@intel.com>
> Acked-by: Beilei Xing <beilei.xing@intel.com>

Applied to dpdk-next-net-intel.

Thanks!
Qi
>
diff mbox series

Patch

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index d5b02c9..b8c1c1d 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.
 
+Recommended Matching List
+-------------------------
+
+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
 ------------------------------