[PATCH] doc: add fm10k driver

[PATCH] doc: add fm10k driver

[Chen Jing D(Mark)]

From: "Chen Jing D(Mark)" <jing.d.chen@intel.com>

This documentation covers introdutions and limitations on Intel
FM10000 series products.

Signed-off-by: Chen Jing D(Mark) <jing.d.chen@intel.com>
---
 doc/guides/nics/fm10k.rst |   54 +++++++++++++++++++++++++++++++++++++++++++++
 doc/guides/nics/index.rst |    1 +
 2 files changed, 55 insertions(+), 0 deletions(-)
 create mode 100644 doc/guides/nics/fm10k.rst

diff --git a/doc/guides/nics/fm10k.rst b/doc/guides/nics/fm10k.rst
new file mode 100644
index 0000000..1c7ca57
--- /dev/null
+++ b/doc/guides/nics/fm10k.rst
@@ -0,0 +1,54 @@
+..  BSD LICENSE
+        Copyright(c) 2010-2015 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.
+
+FM10K Poll Mode Driver
+======================
+The FM10K poll mode driver library provides support for Intel FM10000 family
+of 40GbE/100GbE adapters.
+
+Limitations
+-----------
+Intel FM10000 family of NICs integrate an hardware switch and multiple host
+interfaces. FM10K PMD driver only manages host interfaces. For the switch
+component, another switch driver has to be loaded prior to FM10K PMD driver.
+The switch driver either can be acquired by Intel support or from below link:
+https://github.com/match-interface
+
+CRC strip
+FM10000 family always strip CRC for every packets coming into host interface.
+So, CRC will be stripped even (struct rte_eth_conf).rxmode.hw_strip_crc is set
+to 0.
+
+Max packet length
+FM10000 family support maximum of 15K jumbo frame. The value is fixed and can't
+be changed. So, even (struct rte_eth_conf).rxmode.max_rx_pkt_len is set to a value
+other than 15364, the frames with 15364 byte still can reach to host interface.
+
+
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index 7bf2938..4f2cc6c 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -51,6 +51,7 @@ Network Interface Controller Drivers
     virtio
     vmxnet3
     pcap_ring
+    fm10k
 
 **Figures**
 
-- 
1.7.7.6

Re: [PATCH] doc: add fm10k driver

[Mcnamara, John]

> -----Original Message-----
> From: Chen, Jing D
> Sent: Wednesday, December 9, 2015 8:25 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John; Chen, Jing D
> Subject: [PATCH] doc: add fm10k driver
> 
> From: "Chen Jing D(Mark)" <jing.d.chen@intel.com>
> 
> This documentation covers introdutions and limitations on Intel
> FM10000 series products.

Hi Mark,

Thanks for that. 

The docs build cleanly but there is one whitespace warning on merge.

Minor comments below.



> @@ -0,0 +1,54 @@
> +..  BSD LICENSE
> +        Copyright(c) 2010-2015 Intel Corporation. All rights reserved.

The year should be 2015 only and this line shouldn't be indented in relation
to the next lines.



> +FM10K Poll Mode Driver
> +======================
> +The FM10K poll mode driver library provides support for Intel FM10000
> +family of 40GbE/100GbE adapters.

The DPDK Documentation Guidelines say to leave a blank line after section
headers (here and with the other sections): 

> +FM10K Poll Mode Driver
> +======================
>
> +The FM10K poll mode driver library provides support for Intel FM10000
> +family of 40GbE/100GbE adapters.

 See:  http://dpdk.org/doc/guides/contributing/documentation.html#rst-guidelines


> +The FM10K poll mode driver library provides support for Intel FM10000
> +family of 40GbE/100GbE adapters.

Might be worth introducing the common FM10K name here as well:

The FM10K poll mode driver library provides support for the Intel FM10000
(FM10K) family of 40GbE/100GbE adapters.

> +Intel FM10000 family of NICs integrate an hardware switch and multiple
> +host interfaces. FM10K PMD driver only manages host interfaces. For the

The doc uses FM10000 in some places and FM10K in others. It should use one
or the other consistently.



> +switch component, another switch driver has to be loaded prior to FM10K
> PMD driver.
> +The switch driver either can be acquired by Intel support or from below
> link:
> +https://github.com/match-interface

Better to add an actual link like:

The switch driver can be acquired for Intel support or from the
`Match Interface <https://github.com/match-interface>`_ project.

Also should that be to: https://github.com/match-interface/match



> +
> +CRC strip
> +FM10000 family always strip CRC for every packets coming into host
> interface.


Limitations
-----------

Switch manager
~~~~~~~~~~~~~~

The Intel FM10000 family of NICs integrate a hardware switch and multiple host

Etc.

> +Max packet length
> +FM10000 family support maximum of 15K jumbo frame. The value is fixed
> +and can't be changed. So, even (struct
> +rte_eth_conf).rxmode.max_rx_pkt_len is set to a value other than 15364,
> the frames with 15364 byte still can reach to host interface.

This isn't clear (to me). Maybe something like:

The FM10000 family of NICS support a maximum of a 15K jumbo frame. The value
is fixed and cannot be changed. So, even when the ``rxmode.max_rx_pkt_len``
member of ``struct rte_eth_conf`` is set to a value lower than 15364, frames
up to 15364 bytes can still reach the host interface.


Regards,

John.
-- 

Re: [PATCH] doc: add fm10k driver

[Chen, Jing D]

Hi, John,

Best Regards,
Mark


> -----Original Message-----
> From: Mcnamara, John
> Sent: Wednesday, December 09, 2015 10:21 PM
> To: Chen, Jing D; dev@dpdk.org
> Subject: RE: [PATCH] doc: add fm10k driver
> 
> > -----Original Message-----
> > From: Chen, Jing D
> > Sent: Wednesday, December 9, 2015 8:25 AM
> > To: dev@dpdk.org
> > Cc: Mcnamara, John; Chen, Jing D
> > Subject: [PATCH] doc: add fm10k driver
> >
> > From: "Chen Jing D(Mark)" <jing.d.chen@intel.com>
> >
> > This documentation covers introdutions and limitations on Intel
> > FM10000 series products.
> 
> Hi Mark,
> 
> Thanks for that.
> 
> The docs build cleanly but there is one whitespace warning on merge.
> 
> Minor comments below.
> 
> 
> 
> > @@ -0,0 +1,54 @@
> > +..  BSD LICENSE
> > +        Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
> 
> The year should be 2015 only and this line shouldn't be indented in relation
> to the next lines.
> 
> 
> 
> > +FM10K Poll Mode Driver
> > +======================
> > +The FM10K poll mode driver library provides support for Intel FM10000
> > +family of 40GbE/100GbE adapters.
> 
> The DPDK Documentation Guidelines say to leave a blank line after section
> headers (here and with the other sections):
> 
> > +FM10K Poll Mode Driver
> > +======================
> >
> > +The FM10K poll mode driver library provides support for Intel FM10000
> > +family of 40GbE/100GbE adapters.
> 
>  See:  http://dpdk.org/doc/guides/contributing/documentation.html#rst-
> guidelines
> 
> 
> > +The FM10K poll mode driver library provides support for Intel FM10000
> > +family of 40GbE/100GbE adapters.
> 
> Might be worth introducing the common FM10K name here as well:
> 
> The FM10K poll mode driver library provides support for the Intel FM10000
> (FM10K) family of 40GbE/100GbE adapters.
> 
> > +Intel FM10000 family of NICs integrate an hardware switch and multiple
> > +host interfaces. FM10K PMD driver only manages host interfaces. For the
> 
> The doc uses FM10000 in some places and FM10K in others. It should use one
> or the other consistently.
> 
> 
> 
> > +switch component, another switch driver has to be loaded prior to FM10K
> > PMD driver.
> > +The switch driver either can be acquired by Intel support or from below
> > link:
> > +https://github.com/match-interface
> 
> Better to add an actual link like:
> 
> The switch driver can be acquired for Intel support or from the
> `Match Interface <https://github.com/match-interface>`_ project.
> 
> Also should that be to: https://github.com/match-interface/match
> 
> 
> 
> > +
> > +CRC strip
> > +FM10000 family always strip CRC for every packets coming into host
> > interface.
> 
> 
> Limitations
> -----------
> 
> Switch manager
> ~~~~~~~~~~~~~~
> 
> The Intel FM10000 family of NICs integrate a hardware switch and multiple
> host
> 
> Etc.
> 
> > +Max packet length
> > +FM10000 family support maximum of 15K jumbo frame. The value is fixed
> > +and can't be changed. So, even (struct
> > +rte_eth_conf).rxmode.max_rx_pkt_len is set to a value other than 15364,
> > the frames with 15364 byte still can reach to host interface.
> 
> This isn't clear (to me). Maybe something like:
> 
> The FM10000 family of NICS support a maximum of a 15K jumbo frame. The
> value
> is fixed and cannot be changed. So, even when the
> ``rxmode.max_rx_pkt_len``
> member of ``struct rte_eth_conf`` is set to a value lower than 15364, frames
> up to 15364 bytes can still reach the host interface.
> 
> 
> Regards,
> 
> John.
> --

Many thanks for the comments, I'll change accordingly.

[PATCH v2] doc: add fm10k driver

[Chen Jing D(Mark)]

From: "Chen Jing D(Mark)" <jing.d.chen@intel.com>

This documentation covers introdutions and limitations on Intel
FM10000 series products.

Signed-off-by: Chen Jing D(Mark) <jing.d.chen@intel.com>
---

v2 changes:
 - sync with latest repo.
 - Fix some format and syntax issues.
 - Add descriptions on Testpoint.
 
 doc/guides/nics/fm10k.rst |   67 +++++++++++++++++++++++++++++++++++++++++++++
 doc/guides/nics/index.rst |    1 +
 2 files changed, 68 insertions(+), 0 deletions(-)
 create mode 100644 doc/guides/nics/fm10k.rst

diff --git a/doc/guides/nics/fm10k.rst b/doc/guides/nics/fm10k.rst
new file mode 100644
index 0000000..4206b7f
--- /dev/null
+++ b/doc/guides/nics/fm10k.rst
@@ -0,0 +1,67 @@
+..  BSD LICENSE
+    Copyright(c) 2015 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.
+
+FM10K Poll Mode Driver
+======================
+
+The FM10K poll mode driver library provides support for the Intel FM10000
+(FM10K) family of 40GbE/100GbE adapters.
+
+
+Limitations
+-----------
+
+
+Switch manager
+~~~~~~~~~~~~~~
+
+The Intel FM10000 family of NICs integrate a hardware switch and multiple host
+interfaces. The FM10000 PMD driver only manages host interfaces. For the
+switch component another switch driver has to be loaded prior to to the
+FM10000 PMD driver.  The switch driver can be acquired for Intel support or
+from the `Match Interface <https://github.com/match-interface>`_ project.
+Only Testpoint is validated with DPDK, the latest version that has been
+validated with DPDK2.2 is 4.1.6.
+
+CRC striping
+~~~~~~~~~~~~
+
+The FM10000 family of NICs strip the CRC for every packets coming into the
+host interface.  So, CRC will be stripped even when the
+``rxmode.hw_strip_crc`` member is set to 0 in ``struct rte_eth_conf``.
+
+
+Maximum packet length
+~~~~~~~~~~~~~~~~~~~~~
+
+The FM10000 family of NICS support a maximum of a 15K jumbo frame. The value
+is fixed and cannot be changed. So, even when the ``rxmode.max_rx_pkt_len``
+member of ``struct rte_eth_conf`` is set to a value lower than 15364, frames
+up to 15364 bytes can still reach the host interface.
diff --git a/doc/guides/nics/index.rst b/doc/guides/nics/index.rst
index 7bf2938..4f2cc6c 100644
--- a/doc/guides/nics/index.rst
+++ b/doc/guides/nics/index.rst
@@ -51,6 +51,7 @@ Network Interface Controller Drivers
     virtio
     vmxnet3
     pcap_ring
+    fm10k
 
 **Figures**
 
-- 
1.7.7.6

Re: [PATCH v2] doc: add fm10k driver

[Mcnamara, John]

> -----Original Message-----
> From: Chen, Jing D
> Sent: Thursday, December 10, 2015 7:00 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John; Chen, Jing D
> Subject: [PATCH v2] doc: add fm10k driver
> 
> From: "Chen Jing D(Mark)" <jing.d.chen@intel.com>
> 
> This documentation covers introdutions and limitations on Intel
> FM10000 series products.
> 
> Signed-off-by: Chen Jing D(Mark) <jing.d.chen@intel.com>

Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [PATCH v2] doc: add fm10k driver

[Thomas Monjalon]

> > From: "Chen Jing D(Mark)" <jing.d.chen@intel.com>
> > 
> > This documentation covers introdutions and limitations on Intel
> > FM10000 series products.
> > 
> > Signed-off-by: Chen Jing D(Mark) <jing.d.chen@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks