[mirror_ubuntu-bionic-kernel.git] / Documentation / networking / igb.txt

Linux* Base Driver for Intel(R) Ethernet Network Connection
===========================================================

Intel Gigabit Linux driver.
Copyright(c) 1999 - 2013 Intel Corporation.

Contents
========

- Identifying Your Adapter
- Additional Configurations
- Support

Identifying Your Adapter
========================

This driver supports all 82575, 82576 and 82580-based Intel (R) gigabit network
connections.

For specific 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

Command Line Parameters
=======================

The default value for each parameter is generally the recommended setting,
unless otherwise noted.

max_vfs
-------
Valid Range:   0-7
Default Value: 0

This parameter adds support for SR-IOV.  It causes the driver to spawn up to
max_vfs worth of virtual function.

Additional Configurations
=========================

  Jumbo Frames
  ------------
  Jumbo Frames support is enabled by changing the MTU to a value larger than
  the default of 1500.  Use the ip command to increase the MTU size.
  For example:

       ip link set dev eth<x> mtu 9000

  This setting is not saved across reboots.

  Notes:

  - The maximum MTU setting for Jumbo Frames is 9216.  This value coincides
    with the maximum Jumbo Frames size of 9234 bytes.

  - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in
    poor performance or loss of link.

  ethtool
  -------
  The driver utilizes the ethtool interface for driver configuration and
  diagnostics, as well as displaying statistical information. The latest
  version of ethtool can be found at:

  http://ftp.kernel.org/pub/software/network/ethtool/

  Enabling Wake on LAN* (WoL)
  ---------------------------
  WoL is configured through the ethtool* utility.

  For instructions on enabling WoL with ethtool, refer to the ethtool man page.

  WoL will be enabled on the system during the next shut down or reboot.
  For this driver version, in order to enable WoL, the igb driver must be
  loaded when shutting down or rebooting the system.

  Wake On LAN is only supported on port A of multi-port adapters.

  Wake On LAN is not supported for the Intel(R) Gigabit VT Quad Port Server
  Adapter.

  Multiqueue
  ----------
  In this mode, a separate MSI-X vector is allocated for each queue and one
  for "other" interrupts such as link status change and errors.  All
  interrupts are throttled via interrupt moderation.  Interrupt moderation
  must be used to avoid interrupt storms while the driver is processing one
  interrupt.  The moderation value should be at least as large as the expected
  time for the driver to process an interrupt. Multiqueue is off by default.

  REQUIREMENTS: MSI-X support is required for Multiqueue. If MSI-X is not
  found, the system will fallback to MSI or to Legacy interrupts.

  MAC and VLAN anti-spoofing feature
  ----------------------------------
  When a malicious driver attempts to send a spoofed packet, it is dropped by
  the hardware and not transmitted.  An interrupt is sent to the PF driver
  notifying it of the spoof attempt.

  When a spoofed packet is detected the PF driver will send the following
  message to the system log (displayed by  the "dmesg" command):

  Spoof event(s) detected on VF(n)

  Where n=the VF that attempted to do the spoofing.

  Setting MAC Address, VLAN and Rate Limit Using IProute2 Tool
  ------------------------------------------------------------
  You can set a MAC address of a Virtual Function (VF), a default VLAN and the
  rate limit using the IProute2 tool. Download the latest version of the
  iproute2 tool from Sourceforge if your version does not have all the
  features you require.


Support
=======

For general information, go to the Intel support website at:

    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
Commit	Line	Data
d7064f4c JK	1	Linux* Base Driver for Intel(R) Ethernet Network Connection
d7064f4c JK	2	===========================================================
b55c52b1 JK	3
b55c52b1 JK	4	Intel Gigabit Linux driver.
d7064f4c	5	Copyright(c) 1999 - 2013 Intel Corporation.
b55c52b1 JK	6
	7	Contents
	8	========
	9
	10	- Identifying Your Adapter
	11	- Additional Configurations
	12	- Support
	13
	14	Identifying Your Adapter
	15	========================
	16
	17	This driver supports all 82575, 82576 and 82580-based Intel (R) gigabit network
	18	connections.
	19
	20	For specific information on how to identify your adapter, go to the Adapter &
	21	Driver ID Guide at:
	22
	23	http://support.intel.com/support/go/network/adapter/idguide.htm
	24
	25	Command Line Parameters
	26	=======================
	27
	28	The default value for each parameter is generally the recommended setting,
	29	unless otherwise noted.
	30
	31	max_vfs
	32	-------
	33	Valid Range: 0-7
	34	Default Value: 0
	35
	36	This parameter adds support for SR-IOV. It causes the driver to spawn up to
	37	max_vfs worth of virtual function.
	38
	39	Additional Configurations
	40	=========================
	41
	42	Jumbo Frames
	43	------------
	44	Jumbo Frames support is enabled by changing the MTU to a value larger than
c0a34ebd	45	the default of 1500. Use the ip command to increase the MTU size.
b55c52b1 JK	46	For example:
b55c52b1 JK	47
c0a34ebd	48	ip link set dev eth<x> mtu 9000
b55c52b1 JK	49
	50	This setting is not saved across reboots.
	51
	52	Notes:
	53
	54	- The maximum MTU setting for Jumbo Frames is 9216. This value coincides
	55	with the maximum Jumbo Frames size of 9234 bytes.
	56
d7064f4c JK	57	- Using Jumbo frames at 10 or 100 Mbps is not supported and may result in
d7064f4c JK	58	poor performance or loss of link.
b55c52b1	59
d7064f4c	60	ethtool
b55c52b1 JK	61	-------
b55c52b1 JK	62	The driver utilizes the ethtool interface for driver configuration and
1ffd7246	63	diagnostics, as well as displaying statistical information. The latest
68f20d94	64	version of ethtool can be found at:
b55c52b1	65
1ffd7246	66	http://ftp.kernel.org/pub/software/network/ethtool/
b55c52b1 JK	67
	68	Enabling Wake on LAN* (WoL)
	69	---------------------------
68f20d94	70	WoL is configured through the ethtool* utility.
b55c52b1	71
68f20d94	72	For instructions on enabling WoL with ethtool, refer to the ethtool man page.
b55c52b1 JK	73
	74	WoL will be enabled on the system during the next shut down or reboot.
	75	For this driver version, in order to enable WoL, the igb driver must be
	76	loaded when shutting down or rebooting the system.
	77
	78	Wake On LAN is only supported on port A of multi-port adapters.
	79
	80	Wake On LAN is not supported for the Intel(R) Gigabit VT Quad Port Server
	81	Adapter.
	82
	83	Multiqueue
	84	----------
	85	In this mode, a separate MSI-X vector is allocated for each queue and one
	86	for "other" interrupts such as link status change and errors. All
	87	interrupts are throttled via interrupt moderation. Interrupt moderation
	88	must be used to avoid interrupt storms while the driver is processing one
	89	interrupt. The moderation value should be at least as large as the expected
	90	time for the driver to process an interrupt. Multiqueue is off by default.
	91
	92	REQUIREMENTS: MSI-X support is required for Multiqueue. If MSI-X is not
	93	found, the system will fallback to MSI or to Legacy interrupts.
	94
7c158399 GR	95	MAC and VLAN anti-spoofing feature
	96	----------------------------------
	97	When a malicious driver attempts to send a spoofed packet, it is dropped by
	98	the hardware and not transmitted. An interrupt is sent to the PF driver
	99	notifying it of the spoof attempt.
	100
	101	When a spoofed packet is detected the PF driver will send the following
	102	message to the system log (displayed by the "dmesg" command):
	103
	104	Spoof event(s) detected on VF(n)
	105
	106	Where n=the VF that attempted to do the spoofing.
	107
d7064f4c JK	108	Setting MAC Address, VLAN and Rate Limit Using IProute2 Tool
	109	------------------------------------------------------------
	110	You can set a MAC address of a Virtual Function (VF), a default VLAN and the
	111	rate limit using the IProute2 tool. Download the latest version of the
	112	iproute2 tool from Sourceforge if your version does not have all the
	113	features you require.
	114
	115
b55c52b1 JK	116	Support
	117	=======
	118
	119	For general information, go to the Intel support website at:
	120
	121	www.intel.com/support/
	122
	123	or the Intel Wired Networking project hosted by Sourceforge at:
	124
	125	http://sourceforge.net/projects/e1000
	126
	127	If an issue is identified with the released source code on the supported
	128	kernel with a supported adapter, email the specific information related
	129	to the issue to e1000-devel@lists.sf.net