blob: 98953c0d5342f603ed7bdfe74a67af29ebd61c3d [file] [log] [blame]
Jeff Kirsherb55c52b2010-08-08 15:54:11 +00001Linux* Base Driver for Intel(R) Network Connection
2==================================================
3
4Intel Gigabit Linux driver.
5Copyright(c) 1999 - 2010 Intel Corporation.
6
7Contents
8========
9
10- Identifying Your Adapter
11- Additional Configurations
12- Support
13
14Identifying Your Adapter
15========================
16
17This driver supports all 82575, 82576 and 82580-based Intel (R) gigabit network
18connections.
19
20For specific information on how to identify your adapter, go to the Adapter &
21Driver ID Guide at:
22
23 http://support.intel.com/support/go/network/adapter/idguide.htm
24
25Command Line Parameters
26=======================
27
28The default value for each parameter is generally the recommended setting,
29unless otherwise noted.
30
31max_vfs
32-------
33Valid Range: 0-7
34Default Value: 0
35
36This parameter adds support for SR-IOV. It causes the driver to spawn up to
37max_vfs worth of virtual function.
38
Jeff Kirsher1ffd7242010-12-09 23:47:39 -080039
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000040Additional 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
Jeff Kirsher1ffd7242010-12-09 23:47:39 -080064 diagnostics, as well as displaying statistical information. The latest
Jeff Kirsher68f20d92010-12-17 12:14:34 +000065 version of ethtool can be found at:
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000066
Jeff Kirsher1ffd7242010-12-09 23:47:39 -080067 http://ftp.kernel.org/pub/software/network/ethtool/
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000068
69 Enabling Wake on LAN* (WoL)
70 ---------------------------
Jeff Kirsher68f20d92010-12-17 12:14:34 +000071 WoL is configured through the ethtool* utility.
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000072
Jeff Kirsher68f20d92010-12-17 12:14:34 +000073 For instructions on enabling WoL with ethtool, refer to the ethtool man page.
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000074
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
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000096Support
97=======
98
99For general information, go to the Intel support website at:
100
101 www.intel.com/support/
102
103or the Intel Wired Networking project hosted by Sourceforge at:
104
105 http://sourceforge.net/projects/e1000
106
107If an issue is identified with the released source code on the supported
108kernel with a supported adapter, email the specific information related
109to the issue to e1000-devel@lists.sf.net