[v2] doc: update ice user guide
diff mbox series

Message ID 20201118235607.291109-1-qi.z.zhang@intel.com
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • [v2] doc: update ice user guide
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch warning coding style issues

Commit Message

Zhang, Qi Z Nov. 18, 2020, 11:56 p.m. UTC
Add link for firmware/OOT kernel driver/DDP download
Add matching List.

Signed-off-by: Qi Zhang <qi.z.zhang@intel.com>
---

v2:
- correct the DDP version number

 doc/guides/nics/ice.rst | 28 +++++++++++++++++++++++++---
 1 file changed, 25 insertions(+), 3 deletions(-)

Comments

Ferruh Yigit Nov. 23, 2020, 4:51 p.m. UTC | #1
On 11/18/2020 11:56 PM, Qi Zhang wrote:
> Add link for firmware/OOT kernel driver/DDP download
> Add matching List.
> 
> Signed-off-by: Qi Zhang <qi.z.zhang@intel.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Thomas Monjalon Nov. 26, 2020, 5:24 p.m. UTC | #2
23/11/2020 17:51, Ferruh Yigit:
> On 11/18/2020 11:56 PM, Qi Zhang wrote:
> > Add link for firmware/OOT kernel driver/DDP download
> > Add matching List.
> > 
> > Signed-off-by: Qi Zhang <qi.z.zhang@intel.com>
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied, thanks


Few minor comments about the formatting:

|reg| can be used for the (R) sign
with this line on top of file:
.. include:: <isonum.txt>

Tables are more digest in simple syntax
using only horizontal lines
and a single space to split columns:

https://docutils.sourceforge.io/docs/user/rst/quickref.html#tables

Patch
diff mbox series

diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index c5a76a2a21..1406b8aa88 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -5,9 +5,8 @@  ICE Poll Mode Driver
 ======================
 
 The ice PMD (**librte_net_ice**) provides poll mode driver support for
-10/25/50/100 Gbps Intel® Ethernet 810 Series Network Adapters based on
-the Intel Ethernet Controller E810.
-
+10/25/50/100 Gbps Intel® Ethernet 800 Series Network Adapters based on
+the Intel Ethernet Controller E810 and Intel Ethernet Connection E822/E823.
 
 Prerequisites
 -------------
@@ -17,6 +16,29 @@  Prerequisites
 - To get better performance on Intel platforms, please follow the "How to get best performance with NICs on Intel platforms"
   section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.
 
+- Please follow the matching list to download specific kernel driver, firmware and DDP package from
+  `https://www.intel.com/content/www/us/en/search.html?ws=text#q=e810&t=Downloads&layout=table`.
+
+- To understand what is DDP package and how it works, please review `Intel® Ethernet Controller E810 Dynamic
+  Device Personalization (DDP) for Telecommunications Technology Guide <https://cdrdv2.intel.com/v1/dl/getContent/617015>`_.
+
+- To understand DDP for COMMs usage with DPDK, please review `Intel® Ethernet 800 Series Telecommunication (Comms)
+  Dynamic Device Personalization (DDP) Package <https://cdrdv2.intel.com/v1/dl/getContent/618651>`_.
+
+
+Recommended Matching List
+-------------------------
+
+It is highly recommended to upgrade the ice kernel driver, firmware and DDP package
+to avoid the compatibility issues with ice PMD. Here is the suggested matching list which has been tested and verified.
+The detailed information can refer to chapter Tested Platforms/Tested NICs in release notes.
+
+   +-----------+---------------+-----------------+-----------+-----------+
+   |    DPDK   | Kernel Driver | OS Default DDP  | COMMS DDP | Firmware  |
+   +===========+===============+=================+===========+===========+
+   |    20.11  |     1.3.0     |      1.3.20     |  1.3.24   |    2.3    |
+   +-----------+---------------+-----------------+-----------+-----------+
+
 Pre-Installation Configuration
 ------------------------------