doc: update for ice

Message ID 20200520060009.98785-1-xiaolong.ye@intel.com (mailing list archive)
State Superseded, archived
Delegated to: xiaolong ye
Headers
Series doc: update for ice |

Checks

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

Commit Message

Xiaolong Ye May 20, 2020, 6 a.m. UTC
  Update the description and limitation about ice PMD according to the
product release strategy.

Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
---
 doc/guides/nics/ice.rst | 29 +++++------------------------
 1 file changed, 5 insertions(+), 24 deletions(-)
  

Comments

Qiming Yang May 21, 2020, 3:07 a.m. UTC | #1
> -----Original Message-----
> From: Ye, Xiaolong <xiaolong.ye@intel.com>
> Sent: Wednesday, May 20, 2020 14:00
> To: Yang, Qiming <qiming.yang@intel.com>; Zhang, Qi Z
> <qi.z.zhang@intel.com>; Mcnamara, John <john.mcnamara@intel.com>;
> Kovacevic, Marko <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org; Ye, Xiaolong <xiaolong.ye@intel.com>
> Subject: [PATCH] doc: update for ice
> 
> Update the description and limitation about ice PMD according to the
> product release strategy.
> 
> Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
> ---
>  doc/guides/nics/ice.rst | 29 +++++------------------------
>  1 file changed, 5 insertions(+), 24 deletions(-)
> 
> diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst index
> c5278fc757..b698790440 100644
> --- a/doc/guides/nics/ice.rst
> +++ b/doc/guides/nics/ice.rst
> @@ -12,33 +12,14 @@ the Intel Ethernet Controller E810.
>  Prerequisites
>  -------------
> 
> -- Identifying your adapter using `Intel Support
> -  <http://www.intel.com/support>`_ and get the latest NVM/FW images.
> +- The E810 B0 is currently in sampling state only. To obtain early
> +samples and/or get further information
> +  about kernel drivers, firmware and DDP support, please speak to your Intel
> representative.
> 
>  - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup
> the basic DPDK environment.
> 
>  - 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>`.
> 
> -Recommended Matching List
> --------------------------
> -
> -It is highly recommended to upgrade the ice kernel driver and firmware and
> -DDP packages to avoid the compatibility issues with ice PMD. Here is the -
> suggested matching list.
> -
> -   +----------------------+-----------------------+------------------+----------------+----
> ---------------+
> -   |     DPDK version     | Kernel driver version | Firmware version | DDP OS
> Package | DDP COMMS Package |
> -
> +======================+=======================+==========
> ========+================+===================+
> -   |        20.02         |        0.12.25        |     1.1.16.39    |      1.3.4     |       1.3.10      |
> -   +----------------------+-----------------------+------------------+----------------+----
> ---------------+
> -   |        19.11         |        0.12.25        |     1.1.16.39    |      1.3.4     |       1.3.10      |
> -   +----------------------+-----------------------+------------------+----------------+----
> ---------------+
> -   | 19.08 (experimental) |        0.10.1         |     1.1.12.7     |      1.2.0     |        N/A
> |
> -   +----------------------+-----------------------+------------------+----------------+----
> ---------------+
> -   | 19.05 (experimental) |        0.9.4          |     1.1.10.16    |      1.1.0     |        N/A
> |
> -   +----------------------+-----------------------+------------------+----------------+----
> ---------------+
> -
>  Pre-Installation Configuration
>  ------------------------------
> 
> @@ -330,7 +311,7 @@ is stored in ``ice_adapter->active_pkg_type``.
>  A symbolic link to the DDP package file is also ok. The same package  file is
> used by both the kernel driver and the DPDK PMD.
> 
> -19.02 limitation
> -~~~~~~~~~~~~~~~~
> +limitation
> +~~~~~~~~~~
> 
> -Ice code released in 19.02 is for evaluation only.
> +Ice code released is for evaluation only before E810 C0 is released.
> --
> 2.17.1

Acked-by: Qiming Yang <qiming.yang@intel.com>
  
Xiaolong Ye May 21, 2020, 11:40 p.m. UTC | #2
On 05/20, Xiaolong Ye wrote:
>Update the description and limitation about ice PMD according to the
>product release strategy.
>
>Signed-off-by: Xiaolong Ye <xiaolong.ye@intel.com>
>---
> doc/guides/nics/ice.rst | 29 +++++------------------------
> 1 file changed, 5 insertions(+), 24 deletions(-)
>
>diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
>index c5278fc757..b698790440 100644
>--- a/doc/guides/nics/ice.rst
>+++ b/doc/guides/nics/ice.rst
>@@ -12,33 +12,14 @@ the Intel Ethernet Controller E810.
> Prerequisites
> -------------
> 
>-- Identifying your adapter using `Intel Support
>-  <http://www.intel.com/support>`_ and get the latest NVM/FW images.
>+- The E810 B0 is currently in sampling state only. To obtain early samples and/or get further information
>+  about kernel drivers, firmware and DDP support, please speak to your Intel representative.
> 
> - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
> 
> - 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>`.
> 
>-Recommended Matching List
>--------------------------
>-
>-It is highly recommended to upgrade the ice kernel driver and firmware and
>-DDP packages to avoid the compatibility issues with ice PMD. Here is the
>-suggested matching list.
>-
>-   +----------------------+-----------------------+------------------+----------------+-------------------+
>-   |     DPDK version     | Kernel driver version | Firmware version | DDP OS Package | DDP COMMS Package |
>-   +======================+=======================+==================+================+===================+
>-   |        20.02         |        0.12.25        |     1.1.16.39    |      1.3.4     |       1.3.10      |
>-   +----------------------+-----------------------+------------------+----------------+-------------------+
>-   |        19.11         |        0.12.25        |     1.1.16.39    |      1.3.4     |       1.3.10      |
>-   +----------------------+-----------------------+------------------+----------------+-------------------+
>-   | 19.08 (experimental) |        0.10.1         |     1.1.12.7     |      1.2.0     |        N/A        |
>-   +----------------------+-----------------------+------------------+----------------+-------------------+
>-   | 19.05 (experimental) |        0.9.4          |     1.1.10.16    |      1.1.0     |        N/A        |
>-   +----------------------+-----------------------+------------------+----------------+-------------------+
>-
> Pre-Installation Configuration
> ------------------------------
> 
>@@ -330,7 +311,7 @@ is stored in ``ice_adapter->active_pkg_type``.
> A symbolic link to the DDP package file is also ok. The same package
> file is used by both the kernel driver and the DPDK PMD.
> 
>-19.02 limitation
>-~~~~~~~~~~~~~~~~
>+limitation
>+~~~~~~~~~~
> 
>-Ice code released in 19.02 is for evaluation only.
>+Ice code released is for evaluation only before E810 C0 is released.
>-- 
>2.17.1
>

Applied to dpdk-next-net-intel with qiming's ack, Thanks.
  

Patch

diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index c5278fc757..b698790440 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -12,33 +12,14 @@  the Intel Ethernet Controller E810.
 Prerequisites
 -------------
 
-- Identifying your adapter using `Intel Support
-  <http://www.intel.com/support>`_ and get the latest NVM/FW images.
+- The E810 B0 is currently in sampling state only. To obtain early samples and/or get further information
+  about kernel drivers, firmware and DDP support, please speak to your Intel representative.
 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
 - 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>`.
 
-Recommended Matching List
--------------------------
-
-It is highly recommended to upgrade the ice kernel driver and firmware and
-DDP packages to avoid the compatibility issues with ice PMD. Here is the
-suggested matching list.
-
-   +----------------------+-----------------------+------------------+----------------+-------------------+
-   |     DPDK version     | Kernel driver version | Firmware version | DDP OS Package | DDP COMMS Package |
-   +======================+=======================+==================+================+===================+
-   |        20.02         |        0.12.25        |     1.1.16.39    |      1.3.4     |       1.3.10      |
-   +----------------------+-----------------------+------------------+----------------+-------------------+
-   |        19.11         |        0.12.25        |     1.1.16.39    |      1.3.4     |       1.3.10      |
-   +----------------------+-----------------------+------------------+----------------+-------------------+
-   | 19.08 (experimental) |        0.10.1         |     1.1.12.7     |      1.2.0     |        N/A        |
-   +----------------------+-----------------------+------------------+----------------+-------------------+
-   | 19.05 (experimental) |        0.9.4          |     1.1.10.16    |      1.1.0     |        N/A        |
-   +----------------------+-----------------------+------------------+----------------+-------------------+
-
 Pre-Installation Configuration
 ------------------------------
 
@@ -330,7 +311,7 @@  is stored in ``ice_adapter->active_pkg_type``.
 A symbolic link to the DDP package file is also ok. The same package
 file is used by both the kernel driver and the DPDK PMD.
 
-19.02 limitation
-~~~~~~~~~~~~~~~~
+limitation
+~~~~~~~~~~
 
-Ice code released in 19.02 is for evaluation only.
+Ice code released is for evaluation only before E810 C0 is released.