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

Wei Zhao wei.zhao1 at intel.com
Wed Jan 31 09:40:14 CET 2018


From: wei zhao <wei.zhao1 at intel.com>

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>
---
 doc/guides/nics/igb.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 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..4a87c19
--- /dev/null
+++ b/doc/guides/nics/igb.rst
@@ -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
-- 
2.9.3



More information about the dev mailing list