doc: add igb guide
authorWei Zhao <wei.zhao1@intel.com>
Fri, 2 Feb 2018 03:29:32 +0000 (11:29 +0800)
committerFerruh Yigit <ferruh.yigit@intel.com>
Thu, 8 Feb 2018 17:42:14 +0000 (18:42 +0100)
This patch adds user guide specifically for igb NIC, like ixgbe,
to list all the supported features and known issues.

Signed-off-by: Wei Zhao <wei.zhao1@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
doc/guides/nics/igb.rst [new file with mode: 0644]
doc/guides/nics/index.rst

diff --git a/doc/guides/nics/igb.rst b/doc/guides/nics/igb.rst
new file mode 100644 (file)
index 0000000..0171622
--- /dev/null
@@ -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
index 12bb967..59419f4 100644 (file)
@@ -23,6 +23,7 @@ Network Interface Controller Drivers
     enic
     fm10k
     i40e
+    igb
     ixgbe
     intel_vf
     kni