[dpdk-dev,v3] 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 code indentation style.
v3:
-add more details for igb feature.
---
doc/guides/nics/igb.rst | 38 ++++++++++++++++++++++++++++++++++++++
1 file changed, 38 insertions(+)
create mode 100644 doc/guides/nics/igb.rst
Comments
> -----Original Message-----
> From: Zhao1, Wei
> Sent: Friday, February 2, 2018 3:30 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Zhao1, Wei
> <wei.zhao1@intel.com>
> Subject: [PATCH v3] 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.
>
Acked-by: John McNamara <john.mcnamara@intel.com>
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John
> Sent: Monday, February 5, 2018 5:35 PM
> To: Zhao1, Wei; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb
>
>
>
> > -----Original Message-----
> > From: Zhao1, Wei
> > Sent: Friday, February 2, 2018 3:30 AM
> > To: dev@dpdk.org
> > Cc: Mcnamara, John <john.mcnamara@intel.com>; Zhao1, Wei
> > <wei.zhao1@intel.com>
> > Subject: [PATCH v3] 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.
> >
>
>
> Acked-by: John McNamara <john.mcnamara@intel.com>
Applied to dpdk-next-net-intel, with commit log modifications. Thanks!
/Helin
>
On 2/2/2018 3:29 AM, Wei Zhao wrote:
> 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 code indentation style.
>
> v3:
> -add more details for igb feature.
> ---
> doc/guides/nics/igb.rst | 38 ++++++++++++++++++++++++++++++++++++++
This file is not in the index, so you won't able select file from side bar and
will be very hard to access this document unless you know the url, also
producing a warning for same thing:
.../doc/guides/nics/igb.rst: WARNING: document isn't included in any toctree
> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Thursday, February 8, 2018 11:39 AM
> To: Zhao1, Wei <wei.zhao1@intel.com>; dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for
> igb
>
> On 2/2/2018 3:29 AM, Wei Zhao wrote:
> > 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 code indentation style.
> >
> > v3:
> > -add more details for igb feature.
> > ---
> > doc/guides/nics/igb.rst | 38 ++++++++++++++++++++++++++++++++++++++
>
> This file is not in the index, so you won't able select file from side bar
> and will be very hard to access this document unless you know the url,
> also producing a warning for same thing:
>
> .../doc/guides/nics/igb.rst: WARNING: document isn't included in any
> toctree
I missed that in the review. Can you fix that in the merge?
John
On 2/8/2018 12:27 PM, Mcnamara, John wrote:
>> -----Original Message-----
>> From: Yigit, Ferruh
>> Sent: Thursday, February 8, 2018 11:39 AM
>> To: Zhao1, Wei <wei.zhao1@intel.com>; dev@dpdk.org
>> Cc: Mcnamara, John <john.mcnamara@intel.com>
>> Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for
>> igb
>>
>> On 2/2/2018 3:29 AM, Wei Zhao wrote:
>>> 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 code indentation style.
>>>
>>> v3:
>>> -add more details for igb feature.
>>> ---
>>> doc/guides/nics/igb.rst | 38 ++++++++++++++++++++++++++++++++++++++
>>
>> This file is not in the index, so you won't able select file from side bar
>> and will be very hard to access this document unless you know the url,
>> also producing a warning for same thing:
>>
>> .../doc/guides/nics/igb.rst: WARNING: document isn't included in any
>> toctree
>
>
> I missed that in the review. Can you fix that in the merge?
I can, let me do it.
>
> John
>
On 2/7/2018 7:12 AM, Zhang, Helin wrote:
>
>
>> -----Original Message-----
>> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Mcnamara, John
>> Sent: Monday, February 5, 2018 5:35 PM
>> To: Zhao1, Wei; dev@dpdk.org
>> Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb
>>
>>
>>
>>> -----Original Message-----
>>> From: Zhao1, Wei
>>> Sent: Friday, February 2, 2018 3:30 AM
>>> To: dev@dpdk.org
>>> Cc: Mcnamara, John <john.mcnamara@intel.com>; Zhao1, Wei
>>> <wei.zhao1@intel.com>
>>> Subject: [PATCH v3] 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.
>>>
>>
>>
>> Acked-by: John McNamara <john.mcnamara@intel.com>
> Applied to dpdk-next-net-intel, with commit log modifications. Thanks!
Pulled from next-net-intel, "igb" added to index.rst while merging to next-net.
> -----Original Message-----
> From: Mcnamara, John
> Sent: Thursday, February 8, 2018 8:27 PM
> To: Yigit, Ferruh <ferruh.yigit@intel.com>; Zhao1, Wei
> <wei.zhao1@intel.com>; dev@dpdk.org
> Subject: RE: [dpdk-dev] [PATCH v3] doc: add a user guidance document for
> igb
>
> > -----Original Message-----
> > From: Yigit, Ferruh
> > Sent: Thursday, February 8, 2018 11:39 AM
> > To: Zhao1, Wei <wei.zhao1@intel.com>; dev@dpdk.org
> > Cc: Mcnamara, John <john.mcnamara@intel.com>
> > Subject: Re: [dpdk-dev] [PATCH v3] doc: add a user guidance document
> > for igb
> >
> > On 2/2/2018 3:29 AM, Wei Zhao wrote:
> > > 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 code indentation style.
> > >
> > > v3:
> > > -add more details for igb feature.
> > > ---
> > > doc/guides/nics/igb.rst | 38
> ++++++++++++++++++++++++++++++++++++++
> >
> > This file is not in the index, so you won't able select file from side
> > bar and will be very hard to access this document unless you know the
> > url, also producing a warning for same thing:
> >
> > .../doc/guides/nics/igb.rst: WARNING: document isn't included in any
> > toctree
>
>
> I missed that in the review. Can you fix that in the merge?
>
> John
Oh, I know the process of upload document this time, I have missed that.
new file mode 100644
@@ -0,0 +1,38 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2017 Intel Corporation.
+
+IGB Poll Mode Driver
+====================
+
+The IGB PMD (``librte_pmd_e1000``) provides poll mode driver
+support for Intel 1GbE nics.
+
+Features
+--------
+
+Features of the IGB PMD are:
+
+* Multiple queues for TX and RX
+* Receiver Side Scaling (RSS)
+* MAC/VLAN filtering
+* Packet type information
+* Double VLAN
+* IEEE 1588
+* TSO offload
+* Checksum offload
+* TCP segmentation offload
+* Jumbo frames supported
+
+
+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