From mboxrd@z Thu Jan 1 00:00:00 1970 From: Wei Zhao Subject: [PATCH v3] doc: add a user guidance document for igb Date: Fri, 2 Feb 2018 11:29:32 +0800 Message-ID: <20180202032932.13752-1-wei.zhao1@intel.com> References: <20180131084710.133820-1-wei.zhao1@intel.com> Cc: john.mcnamara@intel.com, Wei Zhao To: dev@dpdk.org Return-path: Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by dpdk.org (Postfix) with ESMTP id F1AED532C for ; Fri, 2 Feb 2018 04:37:21 +0100 (CET) In-Reply-To: <20180131084710.133820-1-wei.zhao1@intel.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- 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