[5/8] Documentation: ixgbevf: Update kernel documentation

Message ID 20180228175032.11148-5-jeffrey.t.kirsher@intel.com
State Changes Requested
Delegated to: Jeff Kirsher
Headers show
Series
  • Untitled series #31074
Related show

Commit Message

Jeff Kirsher Feb. 28, 2018, 5:50 p.m.
Updated the ixgbevf.txt kernel documentation with the latest information.

Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
---
 Documentation/networking/ixgbevf.txt | 66 ++++++++++++++++++++++--------------
 1 file changed, 41 insertions(+), 25 deletions(-)

Comments

Bowers, AndrewX March 1, 2018, 9:14 p.m. | #1
> -----Original Message-----
> From: Intel-wired-lan [mailto:intel-wired-lan-bounces@osuosl.org] On
> Behalf Of Jeff Kirsher
> Sent: Wednesday, February 28, 2018 9:50 AM
> To: intel-wired-lan@lists.osuosl.org
> Subject: [Intel-wired-lan] [PATCH 5/8] Documentation: ixgbevf: Update
> kernel documentation
> 
> Updated the ixgbevf.txt kernel documentation with the latest information.
> 
> Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
> ---
>  Documentation/networking/ixgbevf.txt | 66 ++++++++++++++++++++++---
> -----------
>  1 file changed, 41 insertions(+), 25 deletions(-)

Tested-by: Andrew Bowers <andrewx.bowers@intel.com>

Patch

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.