4a5e29c19bd1f55dd0ef15bdf47792a8853a8d68
[linux-2.6.git] / Documentation / networking / igb.txt
1 Linux* Base Driver for Intel(R) Network Connection
2 ==================================================
3
4 Intel Gigabit Linux driver.
5 Copyright(c) 1999 - 2010 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
40 Additional Configurations
41 =========================
42
43   Jumbo Frames
44   ------------
45   Jumbo Frames support is enabled by changing the MTU to a value larger than
46   the default of 1500.  Use the ifconfig command to increase the MTU size.
47   For example:
48
49        ifconfig eth<x> mtu 9000 up
50
51   This setting is not saved across reboots.
52
53   Notes:
54
55   - The maximum MTU setting for Jumbo Frames is 9216.  This value coincides
56     with the maximum Jumbo Frames size of 9234 bytes.
57
58   - Using Jumbo Frames at 10 or 100 Mbps may result in poor performance or
59     loss of link.
60
61   Ethtool
62   -------
63   The driver utilizes the ethtool interface for driver configuration and
64   diagnostics, as well as displaying statistical information. The latest
65   version of Ethtool can be found at:
66
67   http://ftp.kernel.org/pub/software/network/ethtool/
68
69   Enabling Wake on LAN* (WoL)
70   ---------------------------
71   WoL is configured through the Ethtool* utility.
72
73   For instructions on enabling WoL with Ethtool, refer to the Ethtool man page.
74
75   WoL will be enabled on the system during the next shut down or reboot.
76   For this driver version, in order to enable WoL, the igb driver must be
77   loaded when shutting down or rebooting the system.
78
79   Wake On LAN is only supported on port A of multi-port adapters.
80
81   Wake On LAN is not supported for the Intel(R) Gigabit VT Quad Port Server
82   Adapter.
83
84   Multiqueue
85   ----------
86   In this mode, a separate MSI-X vector is allocated for each queue and one
87   for "other" interrupts such as link status change and errors.  All
88   interrupts are throttled via interrupt moderation.  Interrupt moderation
89   must be used to avoid interrupt storms while the driver is processing one
90   interrupt.  The moderation value should be at least as large as the expected
91   time for the driver to process an interrupt. Multiqueue is off by default.
92
93   REQUIREMENTS: MSI-X support is required for Multiqueue. If MSI-X is not
94   found, the system will fallback to MSI or to Legacy interrupts.
95
96 Support
97 =======
98
99 For general information, go to the Intel support website at:
100
101     www.intel.com/support/
102
103 or the Intel Wired Networking project hosted by Sourceforge at:
104
105     http://sourceforge.net/projects/e1000
106
107 If an issue is identified with the released source code on the supported
108 kernel with a supported adapter, email the specific information related
109 to the issue to e1000-devel@lists.sf.net