blob: 71ca9585567144a75e4209f385500080561cd42c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001Linux* Base Driver for the Intel(R) PRO/1000 Family of Adapters
2===============================================================
3
Jeff Kirsher2bff89c2010-10-05 01:17:05 +00004Intel Gigabit Linux driver.
5Copyright(c) 1999 - 2010 Intel Corporation.
Linus Torvalds1da177e2005-04-16 15:20:36 -07006
7Contents
8========
9
Linus Torvalds1da177e2005-04-16 15:20:36 -070010- Identifying Your Adapter
11- Command Line Parameters
12- Speed and Duplex Configuration
13- Additional Configurations
Linus Torvalds1da177e2005-04-16 15:20:36 -070014- Support
15
Linus Torvalds1da177e2005-04-16 15:20:36 -070016Identifying Your Adapter
17========================
18
Jesse Brandeburg55be0622006-03-15 12:18:13 -080019For more information on how to identify your adapter, go to the Adapter &
Linus Torvalds1da177e2005-04-16 15:20:36 -070020Driver ID Guide at:
21
Jeff Kirsher2bff89c2010-10-05 01:17:05 +000022 http://support.intel.com/support/go/network/adapter/idguide.htm
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Jesse Brandeburg55be0622006-03-15 12:18:13 -080024For the latest Intel network drivers for Linux, refer to the following
Auke Kokde3edab2006-11-01 08:48:18 -080025website. In the search field, enter your adapter name or type, or use the
Linus Torvalds1da177e2005-04-16 15:20:36 -070026networking link on the left to search for your adapter:
27
Jeff Kirsher2bff89c2010-10-05 01:17:05 +000028 http://support.intel.com/support/go/network/adapter/home.htm
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Auke Kokde3edab2006-11-01 08:48:18 -080030Command Line Parameters
31=======================
Jesse Brandeburg55be0622006-03-15 12:18:13 -080032
Linus Torvalds1da177e2005-04-16 15:20:36 -070033The default value for each parameter is generally the recommended setting,
Jesse Brandeburg55be0622006-03-15 12:18:13 -080034unless otherwise noted.
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Jesse Brandeburg55be0622006-03-15 12:18:13 -080036NOTES: For more information about the AutoNeg, Duplex, and Speed
37 parameters, see the "Speed and Duplex Configuration" section in
38 this document.
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
Jesse Brandeburg55be0622006-03-15 12:18:13 -080040 For more information about the InterruptThrottleRate,
41 RxIntDelay, TxIntDelay, RxAbsIntDelay, and TxAbsIntDelay
42 parameters, see the application note at:
43 http://www.intel.com/design/network/applnots/ap450.htm
Linus Torvalds1da177e2005-04-16 15:20:36 -070044
Jesse Brandeburg55be0622006-03-15 12:18:13 -080045AutoNeg
46-------
47(Supported only on adapters with copper connections)
48Valid Range: 0x01-0x0F, 0x20-0x2F
Linus Torvalds1da177e2005-04-16 15:20:36 -070049Default Value: 0x2F
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Auke Kokde3edab2006-11-01 08:48:18 -080051This parameter is a bit-mask that specifies the speed and duplex settings
52advertised by the adapter. When this parameter is used, the Speed and
53Duplex parameters must not be specified.
Jesse Brandeburg55be0622006-03-15 12:18:13 -080054
55NOTE: Refer to the Speed and Duplex section of this readme for more
56 information on the AutoNeg parameter.
57
Jesse Brandeburg55be0622006-03-15 12:18:13 -080058Duplex
59------
60(Supported only on adapters with copper connections)
61Valid Range: 0-2 (0=auto-negotiate, 1=half, 2=full)
Linus Torvalds1da177e2005-04-16 15:20:36 -070062Default Value: 0
Jesse Brandeburg55be0622006-03-15 12:18:13 -080063
Auke Kokde3edab2006-11-01 08:48:18 -080064This defines the direction in which data is allowed to flow. Can be
65either one or two-directional. If both Duplex and the link partner are
66set to auto-negotiate, the board auto-detects the correct duplex. If the
67link partner is forced (either full or half), Duplex defaults to half-
68duplex.
Jesse Brandeburg55be0622006-03-15 12:18:13 -080069
Linus Torvalds1da177e2005-04-16 15:20:36 -070070FlowControl
Auke Kokde3edab2006-11-01 08:48:18 -080071-----------
Jesse Brandeburg55be0622006-03-15 12:18:13 -080072Valid Range: 0-3 (0=none, 1=Rx only, 2=Tx only, 3=Rx&Tx)
73Default Value: Reads flow control settings from the EEPROM
74
75This parameter controls the automatic generation(Tx) and response(Rx)
76to Ethernet PAUSE frames.
77
Linus Torvalds1da177e2005-04-16 15:20:36 -070078InterruptThrottleRate
Jesse Brandeburg55be0622006-03-15 12:18:13 -080079---------------------
Auke Kokde3edab2006-11-01 08:48:18 -080080(not supported on Intel(R) 82542, 82543 or 82544-based adapters)
Jeff Kirsher2bff89c2010-10-05 01:17:05 +000081Valid Range: 0,1,3,4,100-100000 (0=off, 1=dynamic, 3=dynamic conservative,
Jeff Kirsher96c3c032010-12-09 23:42:00 -080082 4=simplified balancing)
Auke Kokde3edab2006-11-01 08:48:18 -080083Default Value: 3
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Auke Kokde3edab2006-11-01 08:48:18 -080085The driver can limit the amount of interrupts per second that the adapter
Jeff Kirsher2bff89c2010-10-05 01:17:05 +000086will generate for incoming packets. It does this by writing a value to the
87adapter that is based on the maximum amount of interrupts that the adapter
Auke Kokde3edab2006-11-01 08:48:18 -080088will generate per second.
89
90Setting InterruptThrottleRate to a value greater or equal to 100
91will program the adapter to send out a maximum of that many interrupts
92per second, even if more packets have come in. This reduces interrupt
93load on the system and can lower CPU utilization under heavy load,
94but will increase latency as packets are not processed as quickly.
95
Jeff Kirsher2bff89c2010-10-05 01:17:05 +000096The default behaviour of the driver previously assumed a static
97InterruptThrottleRate value of 8000, providing a good fallback value for
98all traffic types,but lacking in small packet performance and latency.
99The hardware can handle many more small packets per second however, and
Auke Kokde3edab2006-11-01 08:48:18 -0800100for this reason an adaptive interrupt moderation algorithm was implemented.
101
102Since 7.3.x, the driver has two adaptive modes (setting 1 or 3) in which
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000103it dynamically adjusts the InterruptThrottleRate value based on the traffic
Auke Kokde3edab2006-11-01 08:48:18 -0800104that it receives. After determining the type of incoming traffic in the last
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000105timeframe, it will adjust the InterruptThrottleRate to an appropriate value
Auke Kokde3edab2006-11-01 08:48:18 -0800106for that traffic.
107
108The algorithm classifies the incoming traffic every interval into
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000109classes. Once the class is determined, the InterruptThrottleRate value is
110adjusted to suit that traffic type the best. There are three classes defined:
Auke Kokde3edab2006-11-01 08:48:18 -0800111"Bulk traffic", for large amounts of packets of normal size; "Low latency",
112for small amounts of traffic and/or a significant percentage of small
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000113packets; and "Lowest latency", for almost completely small packets or
Auke Kokde3edab2006-11-01 08:48:18 -0800114minimal traffic.
115
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000116In dynamic conservative mode, the InterruptThrottleRate value is set to 4000
117for traffic that falls in class "Bulk traffic". If traffic falls in the "Low
118latency" or "Lowest latency" class, the InterruptThrottleRate is increased
Auke Kokde3edab2006-11-01 08:48:18 -0800119stepwise to 20000. This default mode is suitable for most applications.
120
121For situations where low latency is vital such as cluster or
122grid computing, the algorithm can reduce latency even more when
123InterruptThrottleRate is set to mode 1. In this mode, which operates
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000124the same as mode 3, the InterruptThrottleRate will be increased stepwise to
Auke Kokde3edab2006-11-01 08:48:18 -080012570000 for traffic in class "Lowest latency".
126
Jeff Kirsher96c3c032010-12-09 23:42:00 -0800127In simplified mode the interrupt rate is based on the ratio of TX and
128RX traffic. If the bytes per second rate is approximately equal, the
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000129interrupt rate will drop as low as 2000 interrupts per second. If the
130traffic is mostly transmit or mostly receive, the interrupt rate could
131be as high as 8000.
132
Auke Kokde3edab2006-11-01 08:48:18 -0800133Setting InterruptThrottleRate to 0 turns off any interrupt moderation
134and may improve small packet latency, but is generally not suitable
135for bulk throughput traffic.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800137NOTE: InterruptThrottleRate takes precedence over the TxAbsIntDelay and
Auke Kokde3edab2006-11-01 08:48:18 -0800138 RxAbsIntDelay parameters. In other words, minimizing the receive
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800139 and/or transmit absolute delays does not force the controller to
140 generate more interrupts than what the Interrupt Throttle Rate
141 allows.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Auke Kokde3edab2006-11-01 08:48:18 -0800143CAUTION: If you are using the Intel(R) PRO/1000 CT Network Connection
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800144 (controller 82547), setting InterruptThrottleRate to a value
145 greater than 75,000, may hang (stop transmitting) adapters
Auke Kokde3edab2006-11-01 08:48:18 -0800146 under certain network conditions. If this occurs a NETDEV
147 WATCHDOG message is logged in the system event log. In
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800148 addition, the controller is automatically reset, restoring
Auke Kokde3edab2006-11-01 08:48:18 -0800149 the network connection. To eliminate the potential for the
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800150 hang, ensure that InterruptThrottleRate is set no greater
151 than 75,000 and is not set to 0.
152
153NOTE: When e1000 is loaded with default settings and multiple adapters
154 are in use simultaneously, the CPU utilization may increase non-
Auke Kokde3edab2006-11-01 08:48:18 -0800155 linearly. In order to limit the CPU utilization without impacting
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800156 the overall throughput, we recommend that you load the driver as
157 follows:
158
Auke Kokde3edab2006-11-01 08:48:18 -0800159 modprobe e1000 InterruptThrottleRate=3000,3000,3000
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800160
161 This sets the InterruptThrottleRate to 3000 interrupts/sec for
Auke Kokde3edab2006-11-01 08:48:18 -0800162 the first, second, and third instances of the driver. The range
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800163 of 2000 to 3000 interrupts per second works on a majority of
164 systems and is a good starting point, but the optimal value will
Auke Kokde3edab2006-11-01 08:48:18 -0800165 be platform-specific. If CPU utilization is not a concern, use
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800166 RX_POLLING (NAPI) and default driver settings.
167
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168RxDescriptors
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800169-------------
170Valid Range: 80-256 for 82542 and 82543-based adapters
171 80-4096 for all other supported adapters
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172Default Value: 256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
Auke Kokde3edab2006-11-01 08:48:18 -0800174This value specifies the number of receive buffer descriptors allocated
175by the driver. Increasing this value allows the driver to buffer more
176incoming packets, at the expense of increased system memory utilization.
177
178Each descriptor is 16 bytes. A receive buffer is also allocated for each
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000179descriptor and can be either 2048, 4096, 8192, or 16384 bytes, depending
Auke Kokde3edab2006-11-01 08:48:18 -0800180on the MTU setting. The maximum MTU size is 16110.
181
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000182NOTE: MTU designates the frame size. It only needs to be set for Jumbo
183 Frames. Depending on the available system resources, the request
184 for a higher number of receive descriptors may be denied. In this
Auke Kokde3edab2006-11-01 08:48:18 -0800185 case, use a lower number.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187RxIntDelay
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800188----------
189Valid Range: 0-65535 (0=off)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190Default Value: 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800192This value delays the generation of receive interrupts in units of 1.024
193microseconds. Receive interrupt reduction can improve CPU efficiency if
Auke Kokde3edab2006-11-01 08:48:18 -0800194properly tuned for specific network traffic. Increasing this value adds
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800195extra latency to frame reception and can end up decreasing the throughput
Auke Kokde3edab2006-11-01 08:48:18 -0800196of TCP traffic. If the system is reporting dropped receives, this value
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800197may be set too high, causing the driver to run out of available receive
198descriptors.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800200CAUTION: When setting RxIntDelay to a value other than 0, adapters may
Auke Kokde3edab2006-11-01 08:48:18 -0800201 hang (stop transmitting) under certain network conditions. If
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800202 this occurs a NETDEV WATCHDOG message is logged in the system
Auke Kokde3edab2006-11-01 08:48:18 -0800203 event log. In addition, the controller is automatically reset,
204 restoring the network connection. To eliminate the potential
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800205 for the hang ensure that RxIntDelay is set to 0.
206
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800207RxAbsIntDelay
208-------------
209(This parameter is supported only on 82540, 82545 and later adapters.)
210Valid Range: 0-65535 (0=off)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211Default Value: 128
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800213This value, in units of 1.024 microseconds, limits the delay in which a
Auke Kokde3edab2006-11-01 08:48:18 -0800214receive interrupt is generated. Useful only if RxIntDelay is non-zero,
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800215this value ensures that an interrupt is generated after the initial
216packet is received within the set amount of time. Proper tuning,
217along with RxIntDelay, may improve traffic throughput in specific network
218conditions.
219
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800220Speed
221-----
222(This parameter is supported only on adapters with copper connections.)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223Valid Settings: 0, 10, 100, 1000
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800224Default Value: 0 (auto-negotiate at all supported speeds)
225
226Speed forces the line speed to the specified value in megabits per second
Auke Kokde3edab2006-11-01 08:48:18 -0800227(Mbps). If this parameter is not specified or is set to 0 and the link
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800228partner is set to auto-negotiate, the board will auto-detect the correct
Auke Kokde3edab2006-11-01 08:48:18 -0800229speed. Duplex should also be set when Speed is set to either 10 or 100.
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231TxDescriptors
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800232-------------
233Valid Range: 80-256 for 82542 and 82543-based adapters
234 80-4096 for all other supported adapters
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235Default Value: 256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800237This value is the number of transmit descriptors allocated by the driver.
Auke Kokde3edab2006-11-01 08:48:18 -0800238Increasing this value allows the driver to queue more transmits. Each
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800239descriptor is 16 bytes.
240
241NOTE: Depending on the available system resources, the request for a
242 higher number of transmit descriptors may be denied. In this case,
243 use a lower number.
244
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000245TxDescriptorStep
246----------------
247Valid Range: 1 (use every Tx Descriptor)
Jeff Kirsher96c3c032010-12-09 23:42:00 -0800248 4 (use every 4th Tx Descriptor)
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000249
250Default Value: 1 (use every Tx Descriptor)
251
252On certain non-Intel architectures, it has been observed that intense TX
253traffic bursts of short packets may result in an improper descriptor
254writeback. If this occurs, the driver will report a "TX Timeout" and reset
255the adapter, after which the transmit flow will restart, though data may
256have stalled for as much as 10 seconds before it resumes.
257
258The improper writeback does not occur on the first descriptor in a system
259memory cache-line, which is typically 32 bytes, or 4 descriptors long.
260
261Setting TxDescriptorStep to a value of 4 will ensure that all TX descriptors
262are aligned to the start of a system memory cache line, and so this problem
263will not occur.
264
265NOTES: Setting TxDescriptorStep to 4 effectively reduces the number of
266 TxDescriptors available for transmits to 1/4 of the normal allocation.
267 This has a possible negative performance impact, which may be
268 compensated for by allocating more descriptors using the TxDescriptors
269 module parameter.
270
271 There are other conditions which may result in "TX Timeout", which will
272 not be resolved by the use of the TxDescriptorStep parameter. As the
273 issue addressed by this parameter has never been observed on Intel
274 Architecture platforms, it should not be used on Intel platforms.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
276TxIntDelay
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800277----------
278Valid Range: 0-65535 (0=off)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279Default Value: 64
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800281This value delays the generation of transmit interrupts in units of
Auke Kokde3edab2006-11-01 08:48:18 -08002821.024 microseconds. Transmit interrupt reduction can improve CPU
283efficiency if properly tuned for specific network traffic. If the
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800284system is reporting dropped transmits, this value may be set too high
285causing the driver to run out of available transmit descriptors.
286
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800287TxAbsIntDelay
288-------------
289(This parameter is supported only on 82540, 82545 and later adapters.)
290Valid Range: 0-65535 (0=off)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291Default Value: 64
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800293This value, in units of 1.024 microseconds, limits the delay in which a
Auke Kokde3edab2006-11-01 08:48:18 -0800294transmit interrupt is generated. Useful only if TxIntDelay is non-zero,
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800295this value ensures that an interrupt is generated after the initial
296packet is sent on the wire within the set amount of time. Proper tuning,
297along with TxIntDelay, may improve traffic throughput in specific
298network conditions.
299
300XsumRX
301------
302(This parameter is NOT supported on the 82542-based adapter.)
303Valid Range: 0-1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304Default Value: 1
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800305
306A value of '1' indicates that the driver should enable IP checksum
307offload for received packets (both UDP and TCP) to the adapter hardware.
308
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000309Copybreak
310---------
311Valid Range: 0-xxxxxxx (0=off)
312Default Value: 256
313Usage: insmod e1000.ko copybreak=128
314
Jeff Kirsher96c3c032010-12-09 23:42:00 -0800315Driver copies all packets below or equaling this size to a fresh RX
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000316buffer before handing it up the stack.
317
318This parameter is different than other parameters, in that it is a
319single (not 1,1,1 etc.) parameter applied to all driver instances and
320it is also available during runtime at
321/sys/module/e1000/parameters/copybreak
322
323SmartPowerDownEnable
324--------------------
325Valid Range: 0-1
326Default Value: 0 (disabled)
327
328Allows PHY to turn off in lower power states. The user can turn off
329this parameter in supported chipsets.
330
331KumeranLockLoss
332---------------
333Valid Range: 0-1
334Default Value: 1 (enabled)
335
336This workaround skips resetting the PHY at shutdown for the initial
337silicon releases of ICH8 systems.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
339Speed and Duplex Configuration
340==============================
341
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800342Three keywords are used to control the speed and duplex configuration.
343These keywords are Speed, Duplex, and AutoNeg.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800345If the board uses a fiber interface, these keywords are ignored, and the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346fiber interface board only links at 1000 Mbps full-duplex.
347
348For copper-based boards, the keywords interact as follows:
349
Auke Kokde3edab2006-11-01 08:48:18 -0800350 The default operation is auto-negotiate. The board advertises all
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800351 supported speed and duplex combinations, and it links at the highest
352 common speed and duplex mode IF the link partner is set to auto-negotiate.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800354 If Speed = 1000, limited auto-negotiation is enabled and only 1000 Mbps
355 is advertised (The 1000BaseT spec requires auto-negotiation.)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
Auke Kokde3edab2006-11-01 08:48:18 -0800357 If Speed = 10 or 100, then both Speed and Duplex should be set. Auto-
358 negotiation is disabled, and the AutoNeg parameter is ignored. Partner
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800359 SHOULD also be forced.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800361The AutoNeg parameter is used when more control is required over the
362auto-negotiation process. It should be used when you wish to control which
363speed and duplex combinations are advertised during the auto-negotiation
364process.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
Auke Kokde3edab2006-11-01 08:48:18 -0800366The parameter may be specified as either a decimal or hexadecimal value as
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800367determined by the bitmap below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800369Bit position 7 6 5 4 3 2 1 0
370Decimal Value 128 64 32 16 8 4 2 1
371Hex value 80 40 20 10 8 4 2 1
372Speed (Mbps) N/A N/A 1000 N/A 100 100 10 10
373Duplex Full Full Half Full Half
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800375Some examples of using AutoNeg:
376
377 modprobe e1000 AutoNeg=0x01 (Restricts autonegotiation to 10 Half)
378 modprobe e1000 AutoNeg=1 (Same as above)
379 modprobe e1000 AutoNeg=0x02 (Restricts autonegotiation to 10 Full)
380 modprobe e1000 AutoNeg=0x03 (Restricts autonegotiation to 10 Half or 10 Full)
381 modprobe e1000 AutoNeg=0x04 (Restricts autonegotiation to 100 Half)
382 modprobe e1000 AutoNeg=0x05 (Restricts autonegotiation to 10 Half or 100
383 Half)
384 modprobe e1000 AutoNeg=0x020 (Restricts autonegotiation to 1000 Full)
385 modprobe e1000 AutoNeg=32 (Same as above)
386
387Note that when this parameter is used, Speed and Duplex must not be specified.
388
389If the link partner is forced to a specific speed and duplex, then this
390parameter should not be used. Instead, use the Speed and Duplex parameters
391previously mentioned to force the adapter to the same speed and duplex.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393Additional Configurations
394=========================
395
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 Jumbo Frames
397 ------------
Auke Kokde3edab2006-11-01 08:48:18 -0800398 Jumbo Frames support is enabled by changing the MTU to a value larger than
399 the default of 1500. Use the ifconfig command to increase the MTU size.
400 For example:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800402 ifconfig eth<x> mtu 9000 up
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800404 This setting is not saved across reboots. It can be made permanent if
405 you add:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800407 MTU=9000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800409 to the file /etc/sysconfig/network-scripts/ifcfg-eth<x>. This example
410 applies to the Red Hat distributions; other distributions may store this
411 setting in a different location.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800413 Notes:
Jeff Kirsher2bff89c2010-10-05 01:17:05 +0000414 Degradation in throughput performance may be observed in some Jumbo frames
415 environments. If this is observed, increasing the application's socket buffer
416 size and/or increasing the /proc/sys/net/ipv4/tcp_*mem entry values may help.
417 See the specific application manual and /usr/src/linux*/Documentation/
418 networking/ip-sysctl.txt for more details.
Auke Kokde3edab2006-11-01 08:48:18 -0800419
420 - The maximum MTU setting for Jumbo Frames is 16110. This value coincides
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800421 with the maximum Jumbo Frames size of 16128.
Auke Kokde3edab2006-11-01 08:48:18 -0800422
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800423 - Using Jumbo Frames at 10 or 100 Mbps may result in poor performance or
424 loss of link.
Auke Kokde3edab2006-11-01 08:48:18 -0800425
Auke Kokde3edab2006-11-01 08:48:18 -0800426 - Adapters based on the Intel(R) 82542 and 82573V/E controller do not
427 support Jumbo Frames. These correspond to the following product names:
428 Intel(R) PRO/1000 Gigabit Server Adapter
429 Intel(R) PRO/1000 PM Network Connection
430
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 Ethtool
432 -------
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 The driver utilizes the ethtool interface for driver configuration and
Jeff Kirsher68f20d92010-12-17 12:14:34 +0000434 diagnostics, as well as displaying statistical information. The ethtool
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 version 1.6 or later is required for this functionality.
436
437 The latest release of ethtool can be found from
Jeff Kirsher68f20d92010-12-17 12:14:34 +0000438 http://ftp.kernel.org/pub/software/network/ethtool/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 Enabling Wake on LAN* (WoL)
441 ---------------------------
Jeff Kirsher68f20d92010-12-17 12:14:34 +0000442 WoL is configured through the ethtool* utility.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800444 WoL will be enabled on the system during the next shut down or reboot.
445 For this driver version, in order to enable WoL, the e1000 driver must be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446 loaded when shutting down or rebooting the system.
447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448Support
449=======
450
451For general information, go to the Intel support website at:
452
453 http://support.intel.com
454
Auke Kokde3edab2006-11-01 08:48:18 -0800455or the Intel Wired Networking project hosted by Sourceforge at:
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800456
457 http://sourceforge.net/projects/e1000
458
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459If an issue is identified with the released source code on the supported
Jesse Brandeburg55be0622006-03-15 12:18:13 -0800460kernel with a supported adapter, email the specific information related
Auke Kokde3edab2006-11-01 08:48:18 -0800461to the issue to e1000-devel@lists.sf.net