From patchwork Wed Feb 28 17:50:27 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Kirsher, Jeffrey T" X-Patchwork-Id: 879239 X-Patchwork-Delegate: jeffrey.t.kirsher@intel.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=osuosl.org (client-ip=140.211.166.133; helo=hemlock.osuosl.org; envelope-from=intel-wired-lan-bounces@osuosl.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=intel.com Received: from hemlock.osuosl.org (smtp2.osuosl.org [140.211.166.133]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3zs34c0ysqz9s2K for ; Thu, 1 Mar 2018 04:50:23 +1100 (AEDT) Received: from localhost (localhost [127.0.0.1]) by hemlock.osuosl.org (Postfix) with ESMTP id C7A7B895F6; Wed, 28 Feb 2018 17:50:21 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from hemlock.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id s60QNCKpvCNK; Wed, 28 Feb 2018 17:50:20 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by hemlock.osuosl.org (Postfix) with ESMTP id EF1568924B; Wed, 28 Feb 2018 17:50:20 +0000 (UTC) X-Original-To: intel-wired-lan@lists.osuosl.org Delivered-To: intel-wired-lan@lists.osuosl.org Received: from silver.osuosl.org (smtp3.osuosl.org [140.211.166.136]) by ash.osuosl.org (Postfix) with ESMTP id DB7881C0259 for ; Wed, 28 Feb 2018 17:50:19 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id D79702928E for ; Wed, 28 Feb 2018 17:50:19 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from silver.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id yZeYumtwolth for ; Wed, 28 Feb 2018 17:50:18 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by silver.osuosl.org (Postfix) with ESMTPS id E1A2228005 for ; Wed, 28 Feb 2018 17:50:17 +0000 (UTC) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 28 Feb 2018 09:50:17 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.47,406,1515484800"; d="scan'208";a="20873277" Received: from jtkirshe-nuc.jf.intel.com ([134.134.177.59]) by fmsmga007.fm.intel.com with ESMTP; 28 Feb 2018 09:50:16 -0800 From: Jeff Kirsher To: intel-wired-lan@lists.osuosl.org Date: Wed, 28 Feb 2018 09:50:27 -0800 Message-Id: <20180228175032.11148-3-jeffrey.t.kirsher@intel.com> X-Mailer: git-send-email 2.14.3 In-Reply-To: <20180228175032.11148-1-jeffrey.t.kirsher@intel.com> References: <20180228175032.11148-1-jeffrey.t.kirsher@intel.com> Subject: [Intel-wired-lan] [PATCH 3/8] Documentation: igbvf: Update kernel documentation X-BeenThere: intel-wired-lan@osuosl.org X-Mailman-Version: 2.1.24 Precedence: list List-Id: Intel Wired Ethernet Linux Kernel Driver Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: intel-wired-lan-bounces@osuosl.org Sender: "Intel-wired-lan" Updated the igbvf.txt kernel documentation with the latest information. Signed-off-by: Jeff Kirsher --- Documentation/networking/igbvf.txt | 85 ++++++++++++++++---------------------- 1 file changed, 35 insertions(+), 50 deletions(-) diff --git a/Documentation/networking/igbvf.txt b/Documentation/networking/igbvf.txt index bd404735fb46..1e6a4e1fc6a0 100644 --- a/Documentation/networking/igbvf.txt +++ b/Documentation/networking/igbvf.txt @@ -2,79 +2,64 @@ Linux* Base Driver for Intel(R) Ethernet Network Connection =========================================================== Intel Gigabit Linux driver. -Copyright(c) 1999 - 2013 Intel Corporation. +Copyright(c) 1999-2018 Intel Corporation. Contents ======== - - Identifying Your Adapter - Additional Configurations - Support -This file describes the igbvf Linux* Base Driver for Intel Network Connection. +This virtual function driver supports kernel versions default_kernel_version. -The igbvf driver supports 82576-based virtual function devices that can only -be activated on kernels that support SR-IOV. SR-IOV requires the correct -platform and OS support. +This driver supports default_hw_family-based virtual function devices +that can only be activated on kernels that support SR-IOV. -The igbvf driver requires the igb driver, version 2.0 or later. The igbvf -driver supports virtual functions generated by the igb driver with a max_vfs -value of 1 or greater. For more information on the max_vfs parameter refer -to the README included with the igb driver. +SR-IOV requires the correct platform and OS support. -The guest OS loading the igbvf driver must support MSI-X interrupts. +The guest OS loading this driver must support MSI-X interrupts. -This driver is only supported as a loadable module at this time. Intel is -not supplying patches against the kernel source to allow for static linking -of the driver. For questions related to hardware requirements, refer to the -documentation supplied with your Intel Gigabit adapter. All hardware -requirements listed apply to use with Linux. +This driver is only supported as a loadable module at this time. Intel is not +supplying patches against the kernel source to allow for static linking of the +drivers. -Instructions on updating ethtool can be found in the section "Additional -Configurations" later in this document. +For questions related to hardware requirements, refer to the documentation +supplied with your Intel adapter. All hardware requirements listed apply to use +with Linux. -VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs. +Driver information can be obtained using variable_value_undefined. Instructions +on updating ethtool can be found in the section Additional Configurations later +in this document. -Identifying Your Adapter -======================== - -The igbvf driver supports 82576-based virtual function devices that can only -be activated on kernels that support SR-IOV. +VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs. -For more information on how to identify your adapter, go to the Adapter & -Driver ID Guide at: - http://support.intel.com/support/go/network/adapter/idguide.htm -For the latest Intel network drivers for Linux, refer to the following -website. In the search field, enter your adapter name or type, or use the -networking link on the left to search for your adapter: +Identifying Your Adapter +------------------------ +For information on how to identify your adapter, and for the latest Intel +network drivers, refer to the Intel Support website: +http://www.intel.com/support - http://downloadcenter.intel.com/scripts-df-external/Support_Intel.aspx -Additional Configurations -========================= +Additional Features and Configurations +------------------------------------------- - ethtool - ------- - The driver utilizes the ethtool interface for driver configuration and - diagnostics, as well as displaying statistical information. The ethtool - version 3.0 or later is required for this functionality, although we - strongly recommend downloading the latest version at: +ethtool +------- +The driver utilizes the ethtool interface for driver configuration and +diagnostics, as well as displaying statistical information. The latest ethtool +version is required for this functionality. Download it at: +http://ftp.kernel.org/pub/software/network/ethtool/ - https://www.kernel.org/pub/software/network/ethtool/ Support -======= - +------- For general information, go to the Intel support website at: - - http://support.intel.com +http://www.intel.com/support/ or the Intel Wired Networking project hosted by Sourceforge at: - - http://sourceforge.net/projects/e1000 - -If an issue is identified with the released source code on the supported -kernel with a supported adapter, email the specific information related -to the issue to e1000-devel@lists.sf.net +http://sourceforge.net/projects/e1000 +If an issue is identified with the released source code on a supported kernel +with a supported adapter, email the specific information related to the issue +to e1000-devel@lists.sf.net.