From patchwork Fri Feb 2 03:29:32 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Zhao1, Wei" X-Patchwork-Id: 34863 X-Patchwork-Delegate: helin.zhang@intel.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id B3A83A496; Fri, 2 Feb 2018 04:37:23 +0100 (CET) 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) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by fmsmga106.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 01 Feb 2018 19:37:19 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.46,445,1511856000"; d="scan'208";a="14758713" Received: from dpdk2.bj.intel.com ([172.16.182.81]) by fmsmga007.fm.intel.com with ESMTP; 01 Feb 2018 19:37:19 -0800 From: Wei Zhao To: dev@dpdk.org Cc: john.mcnamara@intel.com, Wei Zhao Date: Fri, 2 Feb 2018 11:29:32 +0800 Message-Id: <20180202032932.13752-1-wei.zhao1@intel.com> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20180131084710.133820-1-wei.zhao1@intel.com> References: <20180131084710.133820-1-wei.zhao1@intel.com> Subject: [dpdk-dev] [PATCH v3] doc: add a user guidance document for igb X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list 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 Acked-by: John McNamara --- 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