Commit 413548de authored by Jeff Kirsher's avatar Jeff Kirsher

Documentation: igbvf: Prepare documentation for RST conversion

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: default avatarJeff Kirsher <jeffrey.t.kirsher@intel.com>
Tested-by: default avatarAndrew Bowers <andrewx.bowers@intel.com>
Tested-by: default avatarAaron Brown <aaron.f.brown@intel.com>
parent cf673eee
Linux* Base Driver for Intel(R) Ethernet Network Connection .. SPDX-License-Identifier: GPL-2.0+
===========================================================
Intel Gigabit Linux driver. Linux* Base Virtual Function Driver for Intel(R) 1G Ethernet
Copyright(c) 1999 - 2013 Intel Corporation. ============================================================
Intel Gigabit Virtual Function Linux driver.
Copyright(c) 1999-2018 Intel Corporation.
Contents Contents
======== ========
- Identifying Your Adapter - Identifying Your Adapter
- Additional Configurations - Additional Configurations
- Support - Support
This file describes the igbvf Linux* Base Driver for Intel Network Connection. This driver supports Intel 82576-based virtual function devices-based virtual
function devices that can only be activated on kernels that support SR-IOV.
The igbvf driver supports 82576-based virtual function devices that can only SR-IOV requires the correct platform and OS support.
be activated on kernels that support SR-IOV. SR-IOV requires the correct
platform and OS support.
The igbvf driver requires the igb driver, version 2.0 or later. The igbvf The guest OS loading this driver must support MSI-X interrupts.
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.
The guest OS loading the igbvf driver must support MSI-X interrupts. For questions related to hardware requirements, refer to the documentation
supplied with your Intel adapter. All hardware requirements listed apply to use
with Linux.
This driver is only supported as a loadable module at this time. Intel is Driver information can be obtained using ethtool, lspci, and ifconfig.
not supplying patches against the kernel source to allow for static linking Instructions on updating ethtool can be found in the section Additional
of the driver. For questions related to hardware requirements, refer to the Configurations later in this document.
documentation supplied with your Intel Gigabit adapter. All hardware
requirements listed apply to use with Linux.
Instructions on updating ethtool can be found in the section "Additional NOTE: There is a limit of a total of 32 shared VLANs to 1 or more VFs.
Configurations" later in this document.
VLANs: There is a limit of a total of 32 shared VLANs to 1 or more VFs.
Identifying 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
The igbvf driver supports 82576-based virtual function devices that can only
be activated on kernels that support SR-IOV.
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 Additional Features and Configurations
======================================
For the latest Intel network drivers for Linux, refer to the following ethtool
website. In the search field, enter your adapter name or type, or use the -------
networking link on the left to search for your adapter: 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://downloadcenter.intel.com/scripts-df-external/Support_Intel.aspx https://www.kernel.org/pub/software/network/ethtool/
Additional 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:
https://www.kernel.org/pub/software/network/ethtool/
Support Support
======= =======
For general information, go to the Intel support website at: 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: 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 If an issue is identified with the released source code on a supported kernel
kernel with a supported adapter, email the specific information related with a supported adapter, email the specific information related to the issue
to the issue to e1000-devel@lists.sf.net to e1000-devel@lists.sf.net.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment