blob: 43d3549366a09d6cfbb7e4b284bb01d04fd314a0 [file] [log] [blame]
Jeff Kirsherd7064f42013-08-23 17:19:23 -07001Linux* Base Driver for Intel(R) Ethernet Network Connection
2===========================================================
Jeff Kirsherb55c52b2010-08-08 15:54:11 +00003
4Intel Gigabit Linux driver.
Jeff Kirsherd7064f42013-08-23 17:19:23 -07005Copyright(c) 1999 - 2013 Intel Corporation.
Jeff Kirsherb55c52b2010-08-08 15:54:11 +00006
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
39Additional 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
Jeff Kirsherd7064f42013-08-23 17:19:23 -070057 - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in
58 poor performance or loss of link.
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000059
Jeff Kirsherd7064f42013-08-23 17:19:23 -070060 ethtool
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000061 -------
62 The driver utilizes the ethtool interface for driver configuration and
Jeff Kirsher1ffd7242010-12-09 23:47:39 -080063 diagnostics, as well as displaying statistical information. The latest
Jeff Kirsher68f20d92010-12-17 12:14:34 +000064 version of ethtool can be found at:
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000065
Jeff Kirsher1ffd7242010-12-09 23:47:39 -080066 http://ftp.kernel.org/pub/software/network/ethtool/
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000067
68 Enabling Wake on LAN* (WoL)
69 ---------------------------
Jeff Kirsher68f20d92010-12-17 12:14:34 +000070 WoL is configured through the ethtool* utility.
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000071
Jeff Kirsher68f20d92010-12-17 12:14:34 +000072 For instructions on enabling WoL with ethtool, refer to the ethtool man page.
Jeff Kirsherb55c52b2010-08-08 15:54:11 +000073
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
Greg Rose7c158392011-03-12 11:56:02 +000095 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
Jeff Kirsherd7064f42013-08-23 17:19:23 -0700108 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
Jeff Kirsherb55c52b2010-08-08 15:54:11 +0000116Support
117=======
118
119For general information, go to the Intel support website at:
120
121 www.intel.com/support/
122
123or the Intel Wired Networking project hosted by Sourceforge at:
124
125 http://sourceforge.net/projects/e1000
126
127If an issue is identified with the released source code on the supported
128kernel with a supported adapter, email the specific information related
129to the issue to e1000-devel@lists.sf.net