[dpdk-dev] [PATCH v1] doc:add tested platforms and nics

[dpdk-dev] [PATCH v1] doc:add tested platforms and nics

[Qian Xu]

add a new file about tested platforms and nics in doc/guides/nics
Signed-off-by: Qian Xu <qian.q.xu@intel.com>

diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index 769f677..d34040b 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -36,6 +36,7 @@ Network Interface Controller Drivers
     :numbered:
 
     overview
+    test_platforms
     bnx2x
     cxgbe
     e1000em
diff --git a/doc/guides/nics/test_platforms.rst b/doc/guides/nics/test_platforms.rst
new file mode 100644
index 0000000..00a4fd5
--- /dev/null
+++ b/doc/guides/nics/test_platforms.rst
@@ -0,0 +1,151 @@
+..  BSD LICENSE
+    Copyright(c) 2016 Intel Corporation. All rights reserved.
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+    * Neither the name of Intel Corporation nor the names of its
+    contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+    LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+    DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Tested Platforms and Nics
+=========================
+
+Tested Platforms
+----------------
+
+Platform#1: SuperMicro 1U
+
+- BIOS: 1.0c
+- Processor: Intel(R) Atom(TM) CPU  C2758  @ 2.40GHz
+
+Platform#2: SuperMicro 1U
+
+- BIOS: 1.0a
+- Processor: Intel(R) Xeon(R) CPU D-1540 @ 2.00GHz
+- Onboard NIC: Intel(R) X552/X557-AT(2x10G) 
+  - firmware-version: 0x800001cf; 
+  - device ID(PF/VF): 8086:15ad /8086:15a8; 
+  - kernel driver version: 4.2.5(ixgbe)
+
+Platform#3: SuperMicro 1U
+
+- BIOS: 1.0a
+- Processor: Intel(R) Xeon(R) CPU E5-4667 v3 @ 2.00GHz
+
+Platform#4: Intel(R) Server board S2600GZ
+
+- BIOS: SE5C600.86B.02.02.0002.122320131210	
+- Processor: Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
+
+Platform#5: Intel(R) Server board W2600CR
+
+- BIOS: SE5C600.86B.02.01.0002.082220131453
+- Processor: Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
+
+Platform#6: Intel(R) Server board S2600CWT
+
+- BIOS: SE5C610.86B.01.01.0009.060120151350
+- Processor: Intel(R) Xeon(R) CPU E5-2699 v3 @ 2.30GHz
+
+Platform#7: Intel® Server board S2600WTT
+
+- BIOS: SE5C610.86B.01.01.0005.101720141054
+- Processor: Intel(R) Xeon(R) CPU E5-2699 v3 @ 2.30GHz
+
+Platform#8: Intel® Server board S2600WTT	
+
+- BIOS: SE5C610.86B.11.01.0044.090120151156	
+- Processor: Intel(R) Xeon(R) CPU E5-2695 v4 @ 2.10GHz
+
+Tested NICs
+-----------
+
+NIC#1: Intel® Ethernet Controller X540-AT2
+
+- firmware version: 0x80000389
+- device id(pf): 8086:1528
+- driver version: 3.23.2 (ixgbe)
+
+NIC#2: Intel® 82599ES 10 Gigabit Ethernet Controller
+
+- firmware version: 0x61bf0001
+- device id(pf/vf): 8086:10fb / 8086:10ed
+- driver version: 4.0.1-k (ixgbe)
+
+NIC#3: Intel Corporation Ethernet Connection X552/X557-AT 10GBASE-T
+
+- firmware version: 0x800001cf
+- device id(pf/vf): 8086:15ad / 8086:15a8
+- driver version: 4.2.5(ixgbe)
+
+NIC#4: Intel® Ethernet Converged Network Adapter X710-DA4(4x10G) 
+
+- firmware version: 5.02 0x80002284
+- device id(pf/vf): 8086:1572 / 8086:154c
+- driver version: 1.4.26(i40e)
+
+NIC#4: Intel® Ethernet Converged Network Adapter X710-DA2(2x10G)
+
+- firmware version: 5.02 0x80002282
+- device id(pf/vf): 8086:1572 / 8086:154c
+- driver version: 1.4.25(i40e)
+		
+NIC#5: Intel® Ethernet Converged Network Adapter XL710-QDA1(1x40G)
+
+- firmware version: 5.02 0x80002281
+- device id(pf/vf): 8086:1584 / 8086:154c
+- driver version: 1.4.25(i40e)
+
+NIC#6: Intel® Ethernet Converged Network Adapter XL710-QDA2(2X40G)
+
+- firmware version: 5.02 0x80002285
+- device id(pf/vf): 8086:1583 / 8086:154c
+- driver version: 1.4.25(i40e)
+
+NIC#7: Intel® 82576EB Gigabit Ethernet Controller
+
+- firmware version: 1.2.1
+- device id(pf): 8086:1526
+- driver version: 5.2.13-k (igb)
+
+NIC#8: Intel® Ethernet Controller I210
+
+- firmware version: 3.16, 0x80000500, 1.304.0
+- device id(pf): 8086:1533
+- driver version: 5.2.13-k (igb)
+
+NIC#9: Intel Corporation I350 Gigabit Network Connection
+
+- firmware version: 1.48, 0x800006e7
+- device id(pf/vf): 8086:1521 / 8086:1520
+- driver version: 5.2.13-k (igb)	
+		
+
+NIC#10: Intel® Ethernet Multi-host Controller FM10000
+
+- firmware version: N/A
+- device id(pf/vf): 8086:15d0
+- driver version: 0.17.0.9(fm10k)
+
+	
-- 
2.1.0

Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics

[Thomas Monjalon]

2016-04-08 16:57, Qian Xu:
> add a new file about tested platforms and nics in doc/guides/nics
> Signed-off-by: Qian Xu <qian.q.xu@intel.com>
> 
> diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
> index 769f677..d34040b 100644
> --- a/doc/guides/nics/index.rst
> +++ b/doc/guides/nics/index.rst
> @@ -36,6 +36,7 @@ Network Interface Controller Drivers
>      :numbered:
>  
>      overview
> +    test_platforms

I think it would be better suited to integrate this information
in the existing pages for e1000, ixgbe, i40e and fm10k.

Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics

[Mcnamara, John]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Friday, April 8, 2016 10:06 AM
> To: Xu, Qian Q <qian.q.xu@intel.com>
> Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics
> 
> >      overview
> > +    test_platforms
> 
> I think it would be better suited to integrate this information in the
> existing pages for e1000, ixgbe, i40e and fm10k.

Hi,

I think that this is better in one section where it can be reviewed together. I think it should be the last chapter in the section though.

John.
-- 

Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics

[Xu, Qian Q]

Agreed, and others can add their NICs info into the tested NICs and platforms. One question about the release version, the NICs and platforms may change with the release version, for example, for each release, the information may be different, so we need mention the release version for the tested nics and platforms. Then how about putting them in one session of release notes? 

Thanks
Qian


-----Original Message-----
From: Mcnamara, John 
Sent: Friday, April 08, 2016 6:05 PM
To: Thomas Monjalon; Xu, Qian Q
Cc: dev@dpdk.org
Subject: RE: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Friday, April 8, 2016 10:06 AM
> To: Xu, Qian Q <qian.q.xu@intel.com>
> Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics
> 
> >      overview
> > +    test_platforms
> 
> I think it would be better suited to integrate this information in the 
> existing pages for e1000, ixgbe, i40e and fm10k.

Hi,

I think that this is better in one section where it can be reviewed together. I think it should be the last chapter in the section though.

John.
-- 

Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics

[Thomas Monjalon]

2016-04-08 14:29, Xu, Qian Q:
> Agreed, and others can add their NICs info into the tested NICs and platforms. One question about the release version, the NICs and platforms may change with the release version, for example, for each release, the information may be different, so we need mention the release version for the tested nics and platforms. Then how about putting them in one session of release notes? 

Please do at your convenience but do it quickly.
Thanks


> -----Original Message-----
> From: Mcnamara, John 
> Sent: Friday, April 08, 2016 6:05 PM
> To: Thomas Monjalon; Xu, Qian Q
> Cc: dev@dpdk.org
> Subject: RE: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics
> 
> > -----Original Message-----
> > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > Sent: Friday, April 8, 2016 10:06 AM
> > To: Xu, Qian Q <qian.q.xu@intel.com>
> > Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>
> > Subject: Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics
> > 
> > >      overview
> > > +    test_platforms
> > 
> > I think it would be better suited to integrate this information in the 
> > existing pages for e1000, ixgbe, i40e and fm10k.
> 
> Hi,
> 
> I think that this is better in one section where it can be reviewed together. I think it should be the last chapter in the section though.
> 
> John.
> 

Re: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics

[Mcnamara, John]

Hi,

Thanks for that, some comments below.

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Qian Xu
> Sent: Friday, April 8, 2016 9:57 AM
> To: dev@dpdk.org
> Cc: Xu, Qian Q <qian.q.xu@intel.com>
> Subject: [dpdk-dev] [PATCH v1] doc:add tested platforms and nics
> 
> add a new file about tested platforms and nics in doc/guides/nics
> Signed-off-by: Qian Xu <qian.q.xu@intel.com>
> 
> diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst index
> 769f677..d34040b 100644
> --- a/doc/guides/nics/index.rst
> +++ b/doc/guides/nics/index.rst
> @@ -36,6 +36,7 @@ Network Interface Controller Drivers
>      :numbered:
> 
>      overview
> +    test_platforms
>      bnx2x
>      cxgbe
>      e1000em

I would suggest adding this as the last chapter in the NICs guide.



> +
> +Tested Platforms
> +----------------
> +
> +Platform#1: SuperMicro 1U
> +

Instead of using "Platform#1" I would suggest omitting "Platform" and just use a simple numbered list using the RST directive "#." like this:

#. SuperMicro 1U



> +- BIOS: 1.0c
> +- Processor: Intel(R) Atom(TM) CPU  C2758  @ 2.40GHz

Some parts of the doc use (R) and (TM) and some use the symbols. I suggest using one or the other in all places.



> +
> +Platform#2: SuperMicro 1U
> +
> +- BIOS: 1.0a
> +- Processor: Intel(R) Xeon(R) CPU D-1540 @ 2.00GHz
> +- Onboard NIC: Intel(R) X552/X557-AT(2x10G)
> +  - firmware-version: 0x800001cf;
> +  - device ID(PF/VF): 8086:15ad /8086:15a8;
> +  - kernel driver version: 4.2.5(ixgbe)

Apart from (R) and (TM) there should be a space between before all other parentheses, like this: 4.2.5 (ixgbe).

This is in several places in the docs.



> +Tested NICs
> +-----------
> +
> +NIC#1: Intel® Ethernet Controller X540-AT2

Same comment about using a numbered list as above.


Also, there are several checkpatch warnings about trailing whitespace and some tabs that should be fixed.

Thanks,

John