From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jeff Kirsher Date: Wed, 10 Oct 2018 12:16:08 -0700 Subject: [Intel-wired-lan] [PATCH v2 07/12] Documentation: ixgbevf: Prepare documentation for RST conversion In-Reply-To: <20181010191613.2770-1-jeffrey.t.kirsher@intel.com> References: <20181010191613.2770-1-jeffrey.t.kirsher@intel.com> Message-ID: <20181010191613.2770-8-jeffrey.t.kirsher@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: intel-wired-lan@osuosl.org List-ID: Before making the conversion to the rst (reStructured Text) format, there are changes needed to the documentation so that there are no build errors. Also fixed old/broken URLs to the correct or updated URL. Signed-off-by: Jeff Kirsher --- Documentation/networking/ixgbevf.txt | 62 +++++++++++++++++----------- 1 file changed, 38 insertions(+), 24 deletions(-) diff --git a/Documentation/networking/ixgbevf.txt b/Documentation/networking/ixgbevf.txt index 53d8d2a5a6a3..56cde6366c2f 100644 --- a/Documentation/networking/ixgbevf.txt +++ b/Documentation/networking/ixgbevf.txt @@ -1,52 +1,66 @@ -Linux* Base Driver for Intel(R) Ethernet Network Connection -=========================================================== +.. SPDX-License-Identifier: GPL-2.0+ -Intel Gigabit Linux driver. -Copyright(c) 1999 - 2013 Intel Corporation. +Linux* Base Virtual Function Driver for Intel(R) 10G Ethernet +============================================================= + +Intel 10 Gigabit Virtual Function Linux driver. +Copyright(c) 1999-2018 Intel Corporation. Contents ======== - Identifying Your Adapter -- Known Issues/Troubleshooting +- Known Issues - Support -This file describes the ixgbevf Linux* Base Driver for Intel Network -Connection. - -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. +For questions related to hardware requirements, refer to the documentation +supplied with your Intel adapter. All hardware requirements listed apply to use +with Linux. -The guest OS loading the ixgbevf driver must support MSI-X interrupts. - -VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs. Identifying Your Adapter ======================== +The driver is compatible with devices based on the following: -For more information on how to identify your adapter, go to the Adapter & -Driver ID Guide at: + * Intel(R) Ethernet Controller 82598 + * Intel(R) Ethernet Controller 82599 + * Intel(R) Ethernet Controller X520 + * Intel(R) Ethernet Controller X540 + * Intel(R) Ethernet Controller x550 + * Intel(R) Ethernet Controller X552 + * Intel(R) Ethernet Controller X553 - http://support.intel.com/support/go/network/adapter/idguide.htm +For information on how to identify your adapter, and for the latest Intel +network drivers, refer to the Intel Support website: +https://www.intel.com/support Known Issues/Troubleshooting ============================ +SR-IOV requires the correct platform and OS support. + +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 +drivers. + +VLANs: There is a limit of a total of 64 shared VLANs to 1 or more VFs. + Support ======= - For general information, go to the Intel support website at: - http://support.intel.com +https://www.intel.com/support/ or the Intel Wired Networking project hosted by Sourceforge at: - http://sourceforge.net/projects/e1000 +https://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 at lists.sf.net +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 at lists.sf.net. -- 2.17.1