Merge tag 'v3.15-rc1' into perf/urgent
[sfrench/cifs-2.6.git] / Documentation / networking / igb.txt
1 Linux* Base Driver for Intel(R) Ethernet Network Connection
2 ===========================================================
3
4 Intel Gigabit Linux driver.
5 Copyright(c) 1999 - 2013 Intel Corporation.
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
45   the default of 1500.  Use the ifconfig command to increase the MTU size.
46   For example:
47
48        ifconfig eth<x> mtu 9000 up
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
57   - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in
58     poor performance or loss of link.
59
60   ethtool
61   -------
62   The driver utilizes the ethtool interface for driver configuration and
63   diagnostics, as well as displaying statistical information. The latest
64   version of ethtool can be found at:
65
66   http://ftp.kernel.org/pub/software/network/ethtool/
67
68   Enabling Wake on LAN* (WoL)
69   ---------------------------
70   WoL is configured through the ethtool* utility.
71
72   For instructions on enabling WoL with ethtool, refer to the ethtool man page.
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
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
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
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