From patchwork Wed Feb 28 17:50:29 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: 879240 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.137; helo=fraxinus.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 fraxinus.osuosl.org (smtp4.osuosl.org [140.211.166.137]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3zs34c6Nt2z9rxq for ; Thu, 1 Mar 2018 04:50:24 +1100 (AEDT) Received: from localhost (localhost [127.0.0.1]) by fraxinus.osuosl.org (Postfix) with ESMTP id 7DA3A87161; Wed, 28 Feb 2018 17:50:23 +0000 (UTC) X-Virus-Scanned: amavisd-new at osuosl.org Received: from fraxinus.osuosl.org ([127.0.0.1]) by localhost (.osuosl.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id fb3TI47H5TS0; Wed, 28 Feb 2018 17:50:21 +0000 (UTC) Received: from ash.osuosl.org (ash.osuosl.org [140.211.166.34]) by fraxinus.osuosl.org (Postfix) with ESMTP id 5053787177; Wed, 28 Feb 2018 17:50:21 +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 0FED71C0259 for ; Wed, 28 Feb 2018 17:50:21 +0000 (UTC) Received: from localhost (localhost [127.0.0.1]) by silver.osuosl.org (Postfix) with ESMTP id 0CFDF28005 for ; Wed, 28 Feb 2018 17:50:21 +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 MnXOBmwYEwxV 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 3257828ECC for ; Wed, 28 Feb 2018 17:50:18 +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="20873283" Received: from jtkirshe-nuc.jf.intel.com ([134.134.177.59]) by fmsmga007.fm.intel.com with ESMTP; 28 Feb 2018 09:50:17 -0800 From: Jeff Kirsher To: intel-wired-lan@lists.osuosl.org Date: Wed, 28 Feb 2018 09:50:29 -0800 Message-Id: <20180228175032.11148-5-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 5/8] Documentation: ixgbevf: 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 ixgbevf.txt kernel documentation with the latest information. Signed-off-by: Jeff Kirsher Tested-by: Andrew Bowers --- Documentation/networking/ixgbevf.txt | 66 ++++++++++++++++++++++-------------- 1 file changed, 41 insertions(+), 25 deletions(-) diff --git a/Documentation/networking/ixgbevf.txt b/Documentation/networking/ixgbevf.txt index 53d8d2a5a6a3..cc1c009c4c35 100644 --- a/Documentation/networking/ixgbevf.txt +++ b/Documentation/networking/ixgbevf.txt @@ -2,7 +2,7 @@ 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 ======== @@ -11,42 +11,58 @@ Contents - Known Issues/Troubleshooting - Support -This file describes the ixgbevf Linux* Base Driver for Intel Network -Connection. +This virtual function driver supports kernel versions 2.6.x and newer. -The ixgbevf driver supports 82599-based virtual function devices that can only -be activated on kernels with CONFIG_PCI_IOV enabled. +This driver supports 82599, X540, X550, and X552-based virtual function devices +that can only be activated on kernels that support SR-IOV. -The ixgbevf driver supports virtual functions generated by the ixgbe driver -with a max_vfs value of 1 or greater. +SR-IOV requires the correct platform and OS support. -The guest OS loading the ixgbevf driver must support MSI-X interrupts. +The guest OS loading this driver must support MSI-X interrupts. -VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs. +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. -Identifying Your Adapter -======================== +For questions related to hardware requirements, refer to the documentation +supplied with your Intel adapter. All hardware requirements listed apply to use +with Linux. -For more information on how to identify your adapter, go to the Adapter & -Driver ID Guide at: +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. - http://support.intel.com/support/go/network/adapter/idguide.htm +VLANs: There is a limit of a total of 64 shared VLANs to 1 or more VFs. -Known Issues/Troubleshooting -============================ +A version of the driver may already be included by your +distribution and/or the kernel.org kernel. -Support -======= +Identifying Your Adapter +------------------------ +The driver is compatible with devices based on the following: + * Intel(R) Ethernet Controller 82598 + * Intel(R) Ethernet Controller 82599 + * Intel(R) Ethernet Controller X540 + * Intel(R) Ethernet Controller x550 + * Intel(R) Ethernet Controller X552 + * Intel(R) Ethernet Controller X553 -For general information, go to the Intel support website at: +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://support.intel.com -or the Intel Wired Networking project hosted by Sourceforge at: +Known Issues/Troubleshooting +---------------------------- - http://sourceforge.net/projects/e1000 +Support +------- +For general information, go to the Intel support website at: +http://www.intel.com/support/ -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 +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 a supported kernel +with a supported adapter, email the specific information related to the issue +to e1000-devel@lists.sf.net.