[dpdk-dev] [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 at 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 at dpdk.org
> > Cc: Mcnamara, John; Chen, Jing D
> > Subject: [PATCH] doc: add fm10k driver
> >
> > From: "Chen Jing D(Mark)" <jing.d.chen at 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.