]>
Commit | Line | Data |
---|---|---|
3be40e54 | 1 | =========================================================== |
d7064f4c JK |
2 | Linux* Base Driver for Intel(R) Ethernet Network Connection |
3 | =========================================================== | |
1da177e4 | 4 | |
2bff89c3 | 5 | Intel Gigabit Linux driver. |
d7064f4c | 6 | Copyright(c) 1999 - 2013 Intel Corporation. |
1da177e4 LT |
7 | |
8 | Contents | |
9 | ======== | |
10 | ||
1da177e4 LT |
11 | - Identifying Your Adapter |
12 | - Command Line Parameters | |
13 | - Speed and Duplex Configuration | |
14 | - Additional Configurations | |
1da177e4 LT |
15 | - Support |
16 | ||
1da177e4 LT |
17 | Identifying Your Adapter |
18 | ======================== | |
19 | ||
55be062d | 20 | For more information on how to identify your adapter, go to the Adapter & |
1da177e4 LT |
21 | Driver ID Guide at: |
22 | ||
2bff89c3 | 23 | http://support.intel.com/support/go/network/adapter/idguide.htm |
1da177e4 | 24 | |
55be062d | 25 | For the latest Intel network drivers for Linux, refer to the following |
de3edab4 | 26 | website. In the search field, enter your adapter name or type, or use the |
1da177e4 LT |
27 | networking link on the left to search for your adapter: |
28 | ||
2bff89c3 | 29 | http://support.intel.com/support/go/network/adapter/home.htm |
1da177e4 | 30 | |
de3edab4 AK |
31 | Command Line Parameters |
32 | ======================= | |
55be062d | 33 | |
1da177e4 | 34 | The default value for each parameter is generally the recommended setting, |
55be062d JB |
35 | unless otherwise noted. |
36 | ||
37 | NOTES: For more information about the AutoNeg, Duplex, and Speed | |
38 | parameters, see the "Speed and Duplex Configuration" section in | |
39 | this document. | |
1da177e4 | 40 | |
55be062d JB |
41 | For more information about the InterruptThrottleRate, |
42 | RxIntDelay, TxIntDelay, RxAbsIntDelay, and TxAbsIntDelay | |
43 | parameters, see the application note at: | |
44 | http://www.intel.com/design/network/applnots/ap450.htm | |
1da177e4 | 45 | |
55be062d JB |
46 | AutoNeg |
47 | ------- | |
48 | (Supported only on adapters with copper connections) | |
49 | Valid Range: 0x01-0x0F, 0x20-0x2F | |
1da177e4 | 50 | Default Value: 0x2F |
55be062d | 51 | |
de3edab4 AK |
52 | This parameter is a bit-mask that specifies the speed and duplex settings |
53 | advertised by the adapter. When this parameter is used, the Speed and | |
54 | Duplex parameters must not be specified. | |
55be062d JB |
55 | |
56 | NOTE: Refer to the Speed and Duplex section of this readme for more | |
57 | information on the AutoNeg parameter. | |
58 | ||
55be062d JB |
59 | Duplex |
60 | ------ | |
61 | (Supported only on adapters with copper connections) | |
62 | Valid Range: 0-2 (0=auto-negotiate, 1=half, 2=full) | |
1da177e4 | 63 | Default Value: 0 |
55be062d | 64 | |
de3edab4 AK |
65 | This defines the direction in which data is allowed to flow. Can be |
66 | either one or two-directional. If both Duplex and the link partner are | |
67 | set to auto-negotiate, the board auto-detects the correct duplex. If the | |
68 | link partner is forced (either full or half), Duplex defaults to half- | |
69 | duplex. | |
55be062d | 70 | |
1da177e4 | 71 | FlowControl |
de3edab4 | 72 | ----------- |
55be062d JB |
73 | Valid Range: 0-3 (0=none, 1=Rx only, 2=Tx only, 3=Rx&Tx) |
74 | Default Value: Reads flow control settings from the EEPROM | |
75 | ||
76 | This parameter controls the automatic generation(Tx) and response(Rx) | |
77 | to Ethernet PAUSE frames. | |
78 | ||
1da177e4 | 79 | InterruptThrottleRate |
55be062d | 80 | --------------------- |
de3edab4 | 81 | (not supported on Intel(R) 82542, 82543 or 82544-based adapters) |
2bff89c3 | 82 | Valid Range: 0,1,3,4,100-100000 (0=off, 1=dynamic, 3=dynamic conservative, |
96c3c033 | 83 | 4=simplified balancing) |
de3edab4 AK |
84 | Default Value: 3 |
85 | ||
86 | The driver can limit the amount of interrupts per second that the adapter | |
2bff89c3 JK |
87 | will generate for incoming packets. It does this by writing a value to the |
88 | adapter that is based on the maximum amount of interrupts that the adapter | |
de3edab4 AK |
89 | will generate per second. |
90 | ||
91 | Setting InterruptThrottleRate to a value greater or equal to 100 | |
92 | will program the adapter to send out a maximum of that many interrupts | |
93 | per second, even if more packets have come in. This reduces interrupt | |
94 | load on the system and can lower CPU utilization under heavy load, | |
95 | but will increase latency as packets are not processed as quickly. | |
96 | ||
2bff89c3 JK |
97 | The default behaviour of the driver previously assumed a static |
98 | InterruptThrottleRate value of 8000, providing a good fallback value for | |
99 | all traffic types,but lacking in small packet performance and latency. | |
100 | The hardware can handle many more small packets per second however, and | |
de3edab4 AK |
101 | for this reason an adaptive interrupt moderation algorithm was implemented. |
102 | ||
103 | Since 7.3.x, the driver has two adaptive modes (setting 1 or 3) in which | |
2bff89c3 | 104 | it dynamically adjusts the InterruptThrottleRate value based on the traffic |
de3edab4 | 105 | that it receives. After determining the type of incoming traffic in the last |
2bff89c3 | 106 | timeframe, it will adjust the InterruptThrottleRate to an appropriate value |
de3edab4 AK |
107 | for that traffic. |
108 | ||
109 | The algorithm classifies the incoming traffic every interval into | |
2bff89c3 JK |
110 | classes. Once the class is determined, the InterruptThrottleRate value is |
111 | adjusted to suit that traffic type the best. There are three classes defined: | |
de3edab4 AK |
112 | "Bulk traffic", for large amounts of packets of normal size; "Low latency", |
113 | for small amounts of traffic and/or a significant percentage of small | |
2bff89c3 | 114 | packets; and "Lowest latency", for almost completely small packets or |
de3edab4 AK |
115 | minimal traffic. |
116 | ||
2bff89c3 JK |
117 | In dynamic conservative mode, the InterruptThrottleRate value is set to 4000 |
118 | for traffic that falls in class "Bulk traffic". If traffic falls in the "Low | |
119 | latency" or "Lowest latency" class, the InterruptThrottleRate is increased | |
de3edab4 AK |
120 | stepwise to 20000. This default mode is suitable for most applications. |
121 | ||
122 | For situations where low latency is vital such as cluster or | |
123 | grid computing, the algorithm can reduce latency even more when | |
124 | InterruptThrottleRate is set to mode 1. In this mode, which operates | |
2bff89c3 | 125 | the same as mode 3, the InterruptThrottleRate will be increased stepwise to |
de3edab4 AK |
126 | 70000 for traffic in class "Lowest latency". |
127 | ||
96c3c033 JK |
128 | In simplified mode the interrupt rate is based on the ratio of TX and |
129 | RX traffic. If the bytes per second rate is approximately equal, the | |
2bff89c3 JK |
130 | interrupt rate will drop as low as 2000 interrupts per second. If the |
131 | traffic is mostly transmit or mostly receive, the interrupt rate could | |
132 | be as high as 8000. | |
133 | ||
de3edab4 AK |
134 | Setting InterruptThrottleRate to 0 turns off any interrupt moderation |
135 | and may improve small packet latency, but is generally not suitable | |
136 | for bulk throughput traffic. | |
55be062d JB |
137 | |
138 | NOTE: InterruptThrottleRate takes precedence over the TxAbsIntDelay and | |
de3edab4 | 139 | RxAbsIntDelay parameters. In other words, minimizing the receive |
55be062d JB |
140 | and/or transmit absolute delays does not force the controller to |
141 | generate more interrupts than what the Interrupt Throttle Rate | |
142 | allows. | |
143 | ||
de3edab4 | 144 | CAUTION: If you are using the Intel(R) PRO/1000 CT Network Connection |
55be062d JB |
145 | (controller 82547), setting InterruptThrottleRate to a value |
146 | greater than 75,000, may hang (stop transmitting) adapters | |
de3edab4 AK |
147 | under certain network conditions. If this occurs a NETDEV |
148 | WATCHDOG message is logged in the system event log. In | |
55be062d | 149 | addition, the controller is automatically reset, restoring |
de3edab4 | 150 | the network connection. To eliminate the potential for the |
55be062d JB |
151 | hang, ensure that InterruptThrottleRate is set no greater |
152 | than 75,000 and is not set to 0. | |
153 | ||
154 | NOTE: When e1000 is loaded with default settings and multiple adapters | |
155 | are in use simultaneously, the CPU utilization may increase non- | |
de3edab4 | 156 | linearly. In order to limit the CPU utilization without impacting |
55be062d | 157 | the overall throughput, we recommend that you load the driver as |
228046e7 | 158 | follows:: |
55be062d | 159 | |
de3edab4 | 160 | modprobe e1000 InterruptThrottleRate=3000,3000,3000 |
55be062d JB |
161 | |
162 | This sets the InterruptThrottleRate to 3000 interrupts/sec for | |
de3edab4 | 163 | the first, second, and third instances of the driver. The range |
55be062d JB |
164 | of 2000 to 3000 interrupts per second works on a majority of |
165 | systems and is a good starting point, but the optimal value will | |
de3edab4 | 166 | be platform-specific. If CPU utilization is not a concern, use |
55be062d JB |
167 | RX_POLLING (NAPI) and default driver settings. |
168 | ||
1da177e4 | 169 | RxDescriptors |
55be062d | 170 | ------------- |
228046e7 JK |
171 | Valid Range: 48-256 for 82542 and 82543-based adapters |
172 | 48-4096 for all other supported adapters | |
1da177e4 | 173 | Default Value: 256 |
1da177e4 | 174 | |
de3edab4 AK |
175 | This value specifies the number of receive buffer descriptors allocated |
176 | by the driver. Increasing this value allows the driver to buffer more | |
177 | incoming packets, at the expense of increased system memory utilization. | |
178 | ||
179 | Each descriptor is 16 bytes. A receive buffer is also allocated for each | |
2bff89c3 | 180 | descriptor and can be either 2048, 4096, 8192, or 16384 bytes, depending |
de3edab4 AK |
181 | on the MTU setting. The maximum MTU size is 16110. |
182 | ||
2bff89c3 JK |
183 | NOTE: MTU designates the frame size. It only needs to be set for Jumbo |
184 | Frames. Depending on the available system resources, the request | |
185 | for a higher number of receive descriptors may be denied. In this | |
de3edab4 | 186 | case, use a lower number. |
1da177e4 | 187 | |
1da177e4 | 188 | RxIntDelay |
55be062d JB |
189 | ---------- |
190 | Valid Range: 0-65535 (0=off) | |
1da177e4 | 191 | Default Value: 0 |
55be062d JB |
192 | |
193 | This value delays the generation of receive interrupts in units of 1.024 | |
194 | microseconds. Receive interrupt reduction can improve CPU efficiency if | |
de3edab4 | 195 | properly tuned for specific network traffic. Increasing this value adds |
55be062d | 196 | extra latency to frame reception and can end up decreasing the throughput |
de3edab4 | 197 | of TCP traffic. If the system is reporting dropped receives, this value |
55be062d JB |
198 | may be set too high, causing the driver to run out of available receive |
199 | descriptors. | |
200 | ||
201 | CAUTION: When setting RxIntDelay to a value other than 0, adapters may | |
de3edab4 | 202 | hang (stop transmitting) under certain network conditions. If |
55be062d | 203 | this occurs a NETDEV WATCHDOG message is logged in the system |
de3edab4 AK |
204 | event log. In addition, the controller is automatically reset, |
205 | restoring the network connection. To eliminate the potential | |
55be062d JB |
206 | for the hang ensure that RxIntDelay is set to 0. |
207 | ||
55be062d JB |
208 | RxAbsIntDelay |
209 | ------------- | |
210 | (This parameter is supported only on 82540, 82545 and later adapters.) | |
211 | Valid Range: 0-65535 (0=off) | |
1da177e4 | 212 | Default Value: 128 |
55be062d JB |
213 | |
214 | This value, in units of 1.024 microseconds, limits the delay in which a | |
de3edab4 | 215 | receive interrupt is generated. Useful only if RxIntDelay is non-zero, |
55be062d JB |
216 | this value ensures that an interrupt is generated after the initial |
217 | packet is received within the set amount of time. Proper tuning, | |
218 | along with RxIntDelay, may improve traffic throughput in specific network | |
219 | conditions. | |
220 | ||
55be062d JB |
221 | Speed |
222 | ----- | |
223 | (This parameter is supported only on adapters with copper connections.) | |
1da177e4 | 224 | Valid Settings: 0, 10, 100, 1000 |
55be062d JB |
225 | Default Value: 0 (auto-negotiate at all supported speeds) |
226 | ||
227 | Speed forces the line speed to the specified value in megabits per second | |
de3edab4 | 228 | (Mbps). If this parameter is not specified or is set to 0 and the link |
55be062d | 229 | partner is set to auto-negotiate, the board will auto-detect the correct |
de3edab4 | 230 | speed. Duplex should also be set when Speed is set to either 10 or 100. |
55be062d | 231 | |
1da177e4 | 232 | TxDescriptors |
55be062d | 233 | ------------- |
228046e7 JK |
234 | Valid Range: 48-256 for 82542 and 82543-based adapters |
235 | 48-4096 for all other supported adapters | |
1da177e4 | 236 | Default Value: 256 |
1da177e4 | 237 | |
55be062d | 238 | This value is the number of transmit descriptors allocated by the driver. |
de3edab4 | 239 | Increasing this value allows the driver to queue more transmits. Each |
55be062d JB |
240 | descriptor is 16 bytes. |
241 | ||
242 | NOTE: Depending on the available system resources, the request for a | |
243 | higher number of transmit descriptors may be denied. In this case, | |
244 | use a lower number. | |
245 | ||
1da177e4 | 246 | TxIntDelay |
55be062d JB |
247 | ---------- |
248 | Valid Range: 0-65535 (0=off) | |
228046e7 | 249 | Default Value: 8 |
55be062d JB |
250 | |
251 | This value delays the generation of transmit interrupts in units of | |
de3edab4 AK |
252 | 1.024 microseconds. Transmit interrupt reduction can improve CPU |
253 | efficiency if properly tuned for specific network traffic. If the | |
55be062d JB |
254 | system is reporting dropped transmits, this value may be set too high |
255 | causing the driver to run out of available transmit descriptors. | |
256 | ||
55be062d JB |
257 | TxAbsIntDelay |
258 | ------------- | |
259 | (This parameter is supported only on 82540, 82545 and later adapters.) | |
260 | Valid Range: 0-65535 (0=off) | |
228046e7 | 261 | Default Value: 32 |
55be062d JB |
262 | |
263 | This value, in units of 1.024 microseconds, limits the delay in which a | |
de3edab4 | 264 | transmit interrupt is generated. Useful only if TxIntDelay is non-zero, |
55be062d JB |
265 | this value ensures that an interrupt is generated after the initial |
266 | packet is sent on the wire within the set amount of time. Proper tuning, | |
267 | along with TxIntDelay, may improve traffic throughput in specific | |
268 | network conditions. | |
269 | ||
270 | XsumRX | |
271 | ------ | |
272 | (This parameter is NOT supported on the 82542-based adapter.) | |
273 | Valid Range: 0-1 | |
1da177e4 | 274 | Default Value: 1 |
55be062d JB |
275 | |
276 | A value of '1' indicates that the driver should enable IP checksum | |
277 | offload for received packets (both UDP and TCP) to the adapter hardware. | |
278 | ||
2bff89c3 JK |
279 | Copybreak |
280 | --------- | |
281 | Valid Range: 0-xxxxxxx (0=off) | |
282 | Default Value: 256 | |
228046e7 | 283 | Usage: modprobe e1000.ko copybreak=128 |
2bff89c3 | 284 | |
96c3c033 | 285 | Driver copies all packets below or equaling this size to a fresh RX |
2bff89c3 JK |
286 | buffer before handing it up the stack. |
287 | ||
288 | This parameter is different than other parameters, in that it is a | |
289 | single (not 1,1,1 etc.) parameter applied to all driver instances and | |
290 | it is also available during runtime at | |
291 | /sys/module/e1000/parameters/copybreak | |
292 | ||
293 | SmartPowerDownEnable | |
294 | -------------------- | |
295 | Valid Range: 0-1 | |
296 | Default Value: 0 (disabled) | |
297 | ||
298 | Allows PHY to turn off in lower power states. The user can turn off | |
299 | this parameter in supported chipsets. | |
300 | ||
1da177e4 LT |
301 | Speed and Duplex Configuration |
302 | ============================== | |
303 | ||
55be062d JB |
304 | Three keywords are used to control the speed and duplex configuration. |
305 | These keywords are Speed, Duplex, and AutoNeg. | |
1da177e4 | 306 | |
55be062d | 307 | If the board uses a fiber interface, these keywords are ignored, and the |
1da177e4 LT |
308 | fiber interface board only links at 1000 Mbps full-duplex. |
309 | ||
310 | For copper-based boards, the keywords interact as follows: | |
311 | ||
de3edab4 | 312 | The default operation is auto-negotiate. The board advertises all |
55be062d JB |
313 | supported speed and duplex combinations, and it links at the highest |
314 | common speed and duplex mode IF the link partner is set to auto-negotiate. | |
1da177e4 | 315 | |
55be062d JB |
316 | If Speed = 1000, limited auto-negotiation is enabled and only 1000 Mbps |
317 | is advertised (The 1000BaseT spec requires auto-negotiation.) | |
1da177e4 | 318 | |
de3edab4 AK |
319 | If Speed = 10 or 100, then both Speed and Duplex should be set. Auto- |
320 | negotiation is disabled, and the AutoNeg parameter is ignored. Partner | |
55be062d JB |
321 | SHOULD also be forced. |
322 | ||
323 | The AutoNeg parameter is used when more control is required over the | |
324 | auto-negotiation process. It should be used when you wish to control which | |
325 | speed and duplex combinations are advertised during the auto-negotiation | |
326 | process. | |
327 | ||
de3edab4 | 328 | The parameter may be specified as either a decimal or hexadecimal value as |
55be062d | 329 | determined by the bitmap below. |
1da177e4 | 330 | |
55be062d JB |
331 | Bit position 7 6 5 4 3 2 1 0 |
332 | Decimal Value 128 64 32 16 8 4 2 1 | |
333 | Hex value 80 40 20 10 8 4 2 1 | |
334 | Speed (Mbps) N/A N/A 1000 N/A 100 100 10 10 | |
335 | Duplex Full Full Half Full Half | |
1da177e4 | 336 | |
55be062d | 337 | Some examples of using AutoNeg: |
1da177e4 | 338 | |
55be062d JB |
339 | modprobe e1000 AutoNeg=0x01 (Restricts autonegotiation to 10 Half) |
340 | modprobe e1000 AutoNeg=1 (Same as above) | |
341 | modprobe e1000 AutoNeg=0x02 (Restricts autonegotiation to 10 Full) | |
342 | modprobe e1000 AutoNeg=0x03 (Restricts autonegotiation to 10 Half or 10 Full) | |
343 | modprobe e1000 AutoNeg=0x04 (Restricts autonegotiation to 100 Half) | |
344 | modprobe e1000 AutoNeg=0x05 (Restricts autonegotiation to 10 Half or 100 | |
345 | Half) | |
346 | modprobe e1000 AutoNeg=0x020 (Restricts autonegotiation to 1000 Full) | |
347 | modprobe e1000 AutoNeg=32 (Same as above) | |
1da177e4 | 348 | |
55be062d JB |
349 | Note that when this parameter is used, Speed and Duplex must not be specified. |
350 | ||
351 | If the link partner is forced to a specific speed and duplex, then this | |
352 | parameter should not be used. Instead, use the Speed and Duplex parameters | |
353 | previously mentioned to force the adapter to the same speed and duplex. | |
1da177e4 | 354 | |
1da177e4 LT |
355 | Additional Configurations |
356 | ========================= | |
357 | ||
1da177e4 LT |
358 | Jumbo Frames |
359 | ------------ | |
de3edab4 AK |
360 | Jumbo Frames support is enabled by changing the MTU to a value larger than |
361 | the default of 1500. Use the ifconfig command to increase the MTU size. | |
228046e7 | 362 | For example:: |
55be062d JB |
363 | |
364 | ifconfig eth<x> mtu 9000 up | |
365 | ||
366 | This setting is not saved across reboots. It can be made permanent if | |
228046e7 | 367 | you add:: |
55be062d JB |
368 | |
369 | MTU=9000 | |
1da177e4 | 370 | |
55be062d JB |
371 | to the file /etc/sysconfig/network-scripts/ifcfg-eth<x>. This example |
372 | applies to the Red Hat distributions; other distributions may store this | |
373 | setting in a different location. | |
1da177e4 | 374 | |
55be062d | 375 | Notes: |
2bff89c3 JK |
376 | Degradation in throughput performance may be observed in some Jumbo frames |
377 | environments. If this is observed, increasing the application's socket buffer | |
378 | size and/or increasing the /proc/sys/net/ipv4/tcp_*mem entry values may help. | |
379 | See the specific application manual and /usr/src/linux*/Documentation/ | |
380 | networking/ip-sysctl.txt for more details. | |
de3edab4 AK |
381 | |
382 | - The maximum MTU setting for Jumbo Frames is 16110. This value coincides | |
55be062d | 383 | with the maximum Jumbo Frames size of 16128. |
de3edab4 | 384 | |
d7064f4c JK |
385 | - Using Jumbo frames at 10 or 100 Mbps is not supported and may result in |
386 | poor performance or loss of link. | |
de3edab4 | 387 | |
de3edab4 AK |
388 | - Adapters based on the Intel(R) 82542 and 82573V/E controller do not |
389 | support Jumbo Frames. These correspond to the following product names: | |
390 | Intel(R) PRO/1000 Gigabit Server Adapter | |
391 | Intel(R) PRO/1000 PM Network Connection | |
392 | ||
d7064f4c | 393 | ethtool |
1da177e4 | 394 | ------- |
1da177e4 | 395 | The driver utilizes the ethtool interface for driver configuration and |
68f20d94 | 396 | diagnostics, as well as displaying statistical information. The ethtool |
1da177e4 LT |
397 | version 1.6 or later is required for this functionality. |
398 | ||
399 | The latest release of ethtool can be found from | |
3bdadc86 | 400 | https://www.kernel.org/pub/software/network/ethtool/ |
1da177e4 | 401 | |
1da177e4 LT |
402 | Enabling Wake on LAN* (WoL) |
403 | --------------------------- | |
68f20d94 | 404 | WoL is configured through the ethtool* utility. |
1da177e4 | 405 | |
55be062d JB |
406 | WoL will be enabled on the system during the next shut down or reboot. |
407 | For this driver version, in order to enable WoL, the e1000 driver must be | |
1da177e4 LT |
408 | loaded when shutting down or rebooting the system. |
409 | ||
1da177e4 LT |
410 | Support |
411 | ======= | |
412 | ||
413 | For general information, go to the Intel support website at: | |
414 | ||
415 | http://support.intel.com | |
416 | ||
de3edab4 | 417 | or the Intel Wired Networking project hosted by Sourceforge at: |
55be062d JB |
418 | |
419 | http://sourceforge.net/projects/e1000 | |
420 | ||
1da177e4 | 421 | If an issue is identified with the released source code on the supported |
55be062d | 422 | kernel with a supported adapter, email the specific information related |
de3edab4 | 423 | to the issue to e1000-devel@lists.sf.net |