[PATCH V2] doc: add ice in-tree driver version for Intel NICs

[PATCH V2] doc: add ice in-tree driver version for Intel NICs

[Yu Jiang]

doc: add ice in-tree driver version for Intel NICs
ice in-tree driver test starts from 22.07, cover vf-tso,vf-checksum_offload,vf-rss,
vf-jumboframe,vm_hotplug etc.. basic vf function.

Signed-off-by: Yu Jiang <yux.jiang@intel.com>
---
v2:
- add detailed commit log
- correct "out-tree" to "out of tree"
---
---
 doc/guides/rel_notes/release_21_11.rst |  2 +-
 doc/guides/rel_notes/release_22_03.rst |  6 +++---
 doc/guides/rel_notes/release_22_07.rst | 16 +++++++++-------
 3 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/doc/guides/rel_notes/release_21_11.rst b/doc/guides/rel_notes/release_21_11.rst
index db09ec01ea..faac5393c5 100644
--- a/doc/guides/rel_notes/release_21_11.rst
+++ b/doc/guides/rel_notes/release_21_11.rst
@@ -680,7 +680,7 @@ Tested Platforms
       * Firmware version: 0x61bf0001
       * Device id (pf/vf): 8086:10fb / 8086:10ed
       * Driver version(in-tree): 5.1.0-k (ixgbe)
-      * Driver version(out-tree): 5.13.4 (ixgbe)
+      * Driver version(out of tree): 5.13.4 (ixgbe)
 
     * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
 
diff --git a/doc/guides/rel_notes/release_22_03.rst b/doc/guides/rel_notes/release_22_03.rst
index 0923707cb8..84753ffea6 100644
--- a/doc/guides/rel_notes/release_22_03.rst
+++ b/doc/guides/rel_notes/release_22_03.rst
@@ -297,7 +297,7 @@ Tested Platforms
          * Firmware version: 0x61bf0001
          * Device id (pf/vf): 8086:10fb / 8086:10ed
          * Driver version(in-tree): 5.1.0-k (ixgbe)
-         * Driver version(out-tree): 5.13.4 (ixgbe)
+         * Driver version(out of tree): 5.13.4 (ixgbe)
 
        * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
 
@@ -310,14 +310,14 @@ Tested Platforms
 
          * Firmware version: 5.50 0x80003327 1.3082.0
          * Device id (pf/vf): 8086:37d0 / 8086:37cd
-         * Driver version(out-tree): 2.17.15 (i40e)
+         * Driver version(out of tree): 2.17.15 (i40e)
          * Driver version(in-tree): 2.8.20-k (i40e)
 
        * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T
 
          * Firmware version: 5.50 0x800032e0 1.2935.0
          * Device id (pf/vf): 8086:37d2 / 8086:37cd
-         * Driver version(out-tree): 2.17.15 (i40e)
+         * Driver version(out of tree): 2.17.15 (i40e)
          * Driver version(in-tree): 2.8.20-k (i40e)
 
        * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
diff --git a/doc/guides/rel_notes/release_22_07.rst b/doc/guides/rel_notes/release_22_07.rst
index b710ac622c..af7c2a3ffd 100644
--- a/doc/guides/rel_notes/release_22_07.rst
+++ b/doc/guides/rel_notes/release_22_07.rst
@@ -276,7 +276,9 @@ Tested Platforms
 
       * Firmware version: 4.00 0x80011845 1.3236.0
       * Device id (pf/vf): 8086:1593 / 8086:1889
-      * Driver version: 1.9.5_dirty (ice)
+      * Driver version(out of tree): 1.9.5_dirty (ice)
+      * Driver version(in-tree): 5.15.0-27-generic (ice/Ubuntu 22.04)
+      * Driver version(in-tree): 4.18.0-305.19.1.el8_4.x86_64 (ice/RHEL8.4)
       * OS Default DDP: 1.3.30.0
       * COMMS DDP: 1.3.37.0
       * Wireless Edge DDP: 1.3.10.0
@@ -302,42 +304,42 @@ Tested Platforms
 
       * Firmware version: 0x61bf0001
       * Device id (pf/vf): 8086:10fb / 8086:10ed
-      * Driver version(out-tree): 5.15.2 (ixgbe)
+      * Driver version(out of tree): 5.15.2 (ixgbe)
       * Driver version(in-tree): 5.15.0-27-generic (ixgbe)
 
     * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
 
       * Firmware version: 8.70 0x8000c3d5 1.3179.0
       * Device id (pf/vf): 8086:1572 / 8086:154c
-      * Driver version(out-tree): 2.19.3 (i40e)
+      * Driver version(out of tree): 2.19.3 (i40e)
       * Driver version(in-tree): 5.15.0-27-generic (i40e)
 
     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (2x10G)
 
       * Firmware version: 5.60 0x800035cb 1.3179.0
       * Device id (pf/vf): 8086:37d0 / 8086:37cd
-      * Driver version(out-tree): 2.19.3 (i40e)
+      * Driver version(out of tree): 2.19.3 (i40e)
       * Driver version(in-tree): 5.13.0-30-generic (i40e)
 
     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T
 
       * Firmware version: 5.60 0x8000357f 1.2935.0
       * Device id (pf/vf): 8086:37d2 / 8086:37cd
-      * Driver version(out-tree): 2.19.3 (i40e)
+      * Driver version(out of tree): 2.19.3 (i40e)
       * Driver version(in-tree): 5.13.0-30-generic (i40e)
 
     * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
 
       * Firmware version: 8.70 0x8000c3eb 1.3179.0
       * Device id (pf/vf): 8086:158b / 8086:154c
-      * Driver version(out-tree): 2.19.3 (i40e)
+      * Driver version(out of tree): 2.19.3 (i40e)
       * Driver version(in-tree): 5.15.0-27-generic (i40e)
 
     * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
 
       * Firmware version(PF): 8.70 0x8000c40f 1.3179.0
       * Device id (pf/vf): 8086:1583 / 8086:154c
-      * Driver version(out-tree): 2.19.3 (i40e)
+      * Driver version(out of tree): 2.19.3 (i40e)
       * Driver version(in-tree): 5.15.0-27-generic (i40e)
 
     * Intel\ |reg| Ethernet Converged Network Adapter X710-T2L
-- 
2.25.1

RE: [PATCH V2] doc: add ice in-tree driver version for Intel NICs

[Lin, Xueqin]

> -----Original Message-----
> From: Yu Jiang <yux.jiang@intel.com>
> Sent: Friday, October 14, 2022 3:12 PM
> To: dev@dpdk.org; Zhang, Qi Z <qi.z.zhang@intel.com>
> Cc: Jiang, YuX <yux.jiang@intel.com>
> Subject: [PATCH V2] doc: add ice in-tree driver version for Intel NICs
> 
> doc: add ice in-tree driver version for Intel NICs ice in-tree driver test starts
> from 22.07, cover vf-tso,vf-checksum_offload,vf-rss,
> vf-jumboframe,vm_hotplug etc.. basic vf function.
> 
> Signed-off-by: Yu Jiang <yux.jiang@intel.com>
Acked-by: Xueqin Lin <xueqin.lin@intel.com>
> ---

Re: [PATCH V2] doc: add ice in-tree driver version for Intel NICs

[David Marchand]

On Fri, Oct 14, 2022 at 9:12 AM Yu Jiang <yux.jiang@intel.com> wrote:
>
> doc: add ice in-tree driver version for Intel NICs
> ice in-tree driver test starts from 22.07, cover vf-tso,vf-checksum_offload,vf-rss,
> vf-jumboframe,vm_hotplug etc.. basic vf function.
>
> Signed-off-by: Yu Jiang <yux.jiang@intel.com>
> ---
> v2:
> - add detailed commit log

Quoting original questions:

"""
- Glad to see Intel is testing with some distribution kernels, but
what about the latest kernel?
"""

I did not get a reply on this part.

"""
- It is still unclear which features are checked / working, and which
are missing.
Having such info for this driver in the DPDK documentation would help everyone.
Do you have a list?
"""

Thanks for adding some more info in the commitlog.
Please convert this commitlog info into a documentation update (I
think doc/guides/nics/ice.rst is the right place).
This way we will have a detailed list of the supported features with
the in-tree driver, and which feature only work with the out of tree
driver.


> - correct "out-tree" to "out of tree"

This is unrelated to ice, please make this change a separate patch.


> ---


-- 
David Marchand

RE: [PATCH V2] doc: add ice in-tree driver version for Intel NICs

[Peng, Yuan]

Hi Marchand,

Tested platform in this document lists all the platforms including CPU, OS and NIC type with SW package version.
We submitted the patch to add our actual tested ice in-tree driver version of E810 NIC in this DPDK release.
I think it should be added here. 
doc/guides/nics/ice.rst is a document for ICE driver introduction. 
The detailed tested platform information should refer to chapter Tested Platforms/Tested NICs in release notes.

And we will make a separate patch to correct typo not relate to ice.

Thank you.
Yuan.

> -----Original Message-----
> From: David Marchand <david.marchand@redhat.com>
> Sent: Wednesday, October 19, 2022 4:47 PM
> To: Jiang, YuX <yux.jiang@intel.com>
> Cc: dev@dpdk.org; Zhang, Qi Z <qi.z.zhang@intel.com>
> Subject: Re: [PATCH V2] doc: add ice in-tree driver version for Intel NICs
> 
> On Fri, Oct 14, 2022 at 9:12 AM Yu Jiang <yux.jiang@intel.com> wrote:
> >
> > doc: add ice in-tree driver version for Intel NICs ice in-tree driver
> > test starts from 22.07, cover vf-tso,vf-checksum_offload,vf-rss,
> > vf-jumboframe,vm_hotplug etc.. basic vf function.
> >
> > Signed-off-by: Yu Jiang <yux.jiang@intel.com>
> > ---
> > v2:
> > - add detailed commit log
> 
> Quoting original questions:
> 
> """
> - Glad to see Intel is testing with some distribution kernels, but what about
> the latest kernel?
> """
> 
> I did not get a reply on this part.
> 
> """
> - It is still unclear which features are checked / working, and which are
> missing.
> Having such info for this driver in the DPDK documentation would help
> everyone.
> Do you have a list?
> """
> 
> Thanks for adding some more info in the commitlog.
> Please convert this commitlog info into a documentation update (I think
> doc/guides/nics/ice.rst is the right place).
> This way we will have a detailed list of the supported features with the in-
> tree driver, and which feature only work with the out of tree driver.
> 
> 
> > - correct "out-tree" to "out of tree"
> 
> This is unrelated to ice, please make this change a separate patch.
> 
> 
> > ---
> 
> 
> --
> David Marchand

Re: [PATCH V2] doc: add ice in-tree driver version for Intel NICs

[David Marchand]

On Tue, Oct 25, 2022 at 4:52 AM Peng, Yuan <yuan.peng@intel.com> wrote:
>
> Hi Marchand,
>
> Tested platform in this document lists all the platforms including CPU, OS and NIC type with SW package version.
> We submitted the patch to add our actual tested ice in-tree driver version of E810 NIC in this DPDK release.
> I think it should be added here.

Ok, you can put the information here, as it was before.
But I am asking for more, see below.

> doc/guides/nics/ice.rst is a document for ICE driver introduction.

- Sorry, I meant iavf.rst.

The dependency on ice PF driver wrt features availability of the iavf
driver must be documented.

We had reports for couple of issues.
Those issues were hard to understand due to really poor (read: absent)
documentation.
After investigating (having to play with differents versions of
kernel, dpdk, firmwares, oot driver ...), we realise it is due to poor
decisions from Intel on implementing features in the ice OOT driver
only.

Because of this, DPDK developers are locked with this OOT driver
instead of relying on the upstream kernel.
This is a bad thing for both DPDK and kernel communities.


- This current patch only shows focus for tests against two
distributions, with a fixed release version.
I insist that Intel QE must validate the iavf dpdk drivers against the
*upstream* ice kernel driver.


-- 
David Marchand