[dpdk-dev] [PATCH v3] doc: add a user guidance document for igb

Wei Zhao wei.zhao1 at intel.com
Fri Feb 2 04:29:32 CET 2018


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 at 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

diff --git a/doc/guides/nics/igb.rst b/doc/guides/nics/igb.rst
new file mode 100644
index 0000000..0171622
--- /dev/null
+++ b/doc/guides/nics/igb.rst
@@ -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
-- 
2.9.3



More information about the dev mailing list