[dpdk-dev,v2] doc: add a user guidance document for igb
Checks
Commit Message
This patch add a user guidance document specific for igb nic.
By now, a doc like ixgbe.rst is also needed by igb nic. So this
patch add igb.rst to record important information about igb, like
feature supported and known issues.
Signed-off-by: Wei Zhao <wei.zhao1@intel.com>
---
v2:
change the length of punctuation style for comment.
---
doc/guides/nics/igb.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 53 insertions(+)
create mode 100644 doc/guides/nics/igb.rst
Comments
> -----Original Message-----
> From: Zhao1, Wei
> Sent: Wednesday, January 31, 2018 8:47 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Lu, Wenzhuo
> <wenzhuo.lu@intel.com>; Zhao1, Wei <wei.zhao1@intel.com>
> Subject: [PATCH v2] doc: add a user guidance document for igb
>
> This patch add a user guidance document specific for igb nic.
> By now, a doc like ixgbe.rst is also needed by igb nic. So this patch add
> igb.rst to record important information about igb, like feature supported
> and known issues.
Hi,
Thanks for the doc. It is something we should have had a while ago.
Some comments below.
> +.. BSD LICENSE
> + Copyright(c) 2018 Intel Corporation. All rights reserved.
> + All rights reserved.
> +
You should probably use an SPDX header here.
> +IGB Poll Mode Driver
> +====================
> +
> +The IGB PMD (librte_pmd_e1000) provides poll mode driver support.
Maybe use something a bit more descriptive here like:
The IGB PMD (``librte_pmd_e1000``) provides poll mode driver support for
Intel 1GbE nics.
> +
> +Features
> +--------
> +
> +Features of the IGB PMD are:
Could you fill in some of these as a bullet list like:
Features of the IGB PMD are:
* VLAN
* VxLAN
* IEEE 1588
* etc.
The rest of the doc looks good.
John
Hi, John
A new v3 commit.
https://dpdk.org/dev/patchwork/patch/34863/
> -----Original Message-----
> From: Mcnamara, John
> Sent: Thursday, February 1, 2018 5:14 PM
> To: Zhao1, Wei <wei.zhao1@intel.com>; dev@dpdk.org
> Cc: Lu, Wenzhuo <wenzhuo.lu@intel.com>
> Subject: RE: [PATCH v2] doc: add a user guidance document for igb
>
>
>
> > -----Original Message-----
> > From: Zhao1, Wei
> > Sent: Wednesday, January 31, 2018 8:47 AM
> > To: dev@dpdk.org
> > Cc: Mcnamara, John <john.mcnamara@intel.com>; Lu, Wenzhuo
> > <wenzhuo.lu@intel.com>; Zhao1, Wei <wei.zhao1@intel.com>
> > Subject: [PATCH v2] doc: add a user guidance document for igb
> >
> > This patch add a user guidance document specific for igb nic.
> > By now, a doc like ixgbe.rst is also needed by igb nic. So this patch
> > add igb.rst to record important information about igb, like feature
> > supported and known issues.
>
> Hi,
>
> Thanks for the doc. It is something we should have had a while ago.
> Some comments below.
>
> > +.. BSD LICENSE
> > + Copyright(c) 2018 Intel Corporation. All rights reserved.
> > + All rights reserved.
> > +
>
> You should probably use an SPDX header here.
>
>
>
> > +IGB Poll Mode Driver
> > +====================
> > +
> > +The IGB PMD (librte_pmd_e1000) provides poll mode driver support.
>
> Maybe use something a bit more descriptive here like:
>
> The IGB PMD (``librte_pmd_e1000``) provides poll mode driver support for
> Intel 1GbE nics.
>
>
>
> > +
> > +Features
> > +--------
> > +
> > +Features of the IGB PMD are:
>
> Could you fill in some of these as a bullet list like:
>
> Features of the IGB PMD are:
>
> * VLAN
> * VxLAN
> * IEEE 1588
> * etc.
>
> The rest of the doc looks good.
>
> John
>
new file mode 100644
@@ -0,0 +1,53 @@
+.. BSD LICENSE
+ Copyright(c) 2018 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.
+
+IGB Poll Mode Driver
+====================
+
+The IGB PMD (librte_pmd_e1000) provides poll mode driver support.
+
+Features
+--------
+
+Features of the IGB PMD are:
+
+
+Limitations or Known issues
+---------------------------
+
+
+Supported Chipsets and NICs
+---------------------------
+
+- Intel 82576EB 10 Gigabit Ethernet Controller
+- Intel 82580EB 10 Gigabit Ethernet Controller
+- Intel 82580DB 10 Gigabit Ethernet Controller
+- Intel Ethernet Controller I210
+- Intel Ethernet Controller I350