]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | Linux* Base Driver for the Intel(R) PRO/1000 Family of Adapters |
2 | =============================================================== | |
3 | ||
55be062d | 4 | November 15, 2005 |
1da177e4 LT |
5 | |
6 | ||
7 | Contents | |
8 | ======== | |
9 | ||
10 | - In This Release | |
11 | - Identifying Your Adapter | |
12 | - Command Line Parameters | |
13 | - Speed and Duplex Configuration | |
14 | - Additional Configurations | |
15 | - Known Issues | |
16 | - Support | |
17 | ||
18 | ||
19 | In This Release | |
20 | =============== | |
21 | ||
22 | This file describes the Linux* Base Driver for the Intel(R) PRO/1000 Family | |
55be062d | 23 | of Adapters. This driver includes support for Itanium(R)2-based systems. |
1da177e4 | 24 | |
55be062d JB |
25 | For questions related to hardware requirements, refer to the documentation |
26 | supplied with your Intel PRO/1000 adapter. All hardware requirements listed | |
1da177e4 LT |
27 | apply to use with Linux. |
28 | ||
55be062d JB |
29 | The following features are now available in supported kernels: |
30 | - Native VLANs | |
31 | - Channel Bonding (teaming) | |
32 | - SNMP | |
33 | ||
34 | Channel Bonding documentation can be found in the Linux kernel source: | |
35 | /Documentation/networking/bonding.txt | |
36 | ||
37 | The driver information previously displayed in the /proc filesystem is not | |
38 | supported in this release. Alternatively, you can use ethtool (version 1.6 | |
39 | or later), lspci, and ifconfig to obtain the same information. | |
40 | ||
41 | Instructions on updating ethtool can be found in the section "Additional | |
42 | Configurations" later in this document. | |
43 | ||
1da177e4 LT |
44 | |
45 | Identifying Your Adapter | |
46 | ======================== | |
47 | ||
55be062d | 48 | For more information on how to identify your adapter, go to the Adapter & |
1da177e4 LT |
49 | Driver ID Guide at: |
50 | ||
51 | http://support.intel.com/support/network/adapter/pro100/21397.htm | |
52 | ||
55be062d JB |
53 | For the latest Intel network drivers for Linux, refer to the following |
54 | website. In the search field, enter your adapter name or type, or use the | |
1da177e4 LT |
55 | networking link on the left to search for your adapter: |
56 | ||
57 | http://downloadfinder.intel.com/scripts-df/support_intel.asp | |
58 | ||
1da177e4 | 59 | |
55be062d JB |
60 | Command Line Parameters ======================= |
61 | ||
62 | If the driver is built as a module, the following optional parameters | |
63 | are used by entering them on the command line with the modprobe or insmod | |
64 | command using this syntax: | |
1da177e4 LT |
65 | |
66 | modprobe e1000 [<option>=<VAL1>,<VAL2>,...] | |
67 | ||
55be062d | 68 | insmod e1000 [<option>=<VAL1>,<VAL2>,...] |
1da177e4 LT |
69 | |
70 | For example, with two PRO/1000 PCI adapters, entering: | |
71 | ||
72 | insmod e1000 TxDescriptors=80,128 | |
73 | ||
55be062d JB |
74 | loads the e1000 driver with 80 TX descriptors for the first adapter and 128 |
75 | TX descriptors for the second adapter. | |
1da177e4 LT |
76 | |
77 | The default value for each parameter is generally the recommended setting, | |
55be062d JB |
78 | unless otherwise noted. |
79 | ||
80 | NOTES: For more information about the AutoNeg, Duplex, and Speed | |
81 | parameters, see the "Speed and Duplex Configuration" section in | |
82 | this document. | |
1da177e4 | 83 | |
55be062d JB |
84 | For more information about the InterruptThrottleRate, |
85 | RxIntDelay, TxIntDelay, RxAbsIntDelay, and TxAbsIntDelay | |
86 | parameters, see the application note at: | |
87 | http://www.intel.com/design/network/applnots/ap450.htm | |
1da177e4 | 88 | |
55be062d JB |
89 | A descriptor describes a data buffer and attributes related to |
90 | the data buffer. This information is accessed by the hardware. | |
1da177e4 | 91 | |
1da177e4 | 92 | |
55be062d JB |
93 | AutoNeg |
94 | ------- | |
95 | (Supported only on adapters with copper connections) | |
96 | Valid Range: 0x01-0x0F, 0x20-0x2F | |
1da177e4 | 97 | Default Value: 0x2F |
55be062d JB |
98 | |
99 | This parameter is a bit mask that specifies which speed and duplex | |
100 | settings the board advertises. When this parameter is used, the Speed | |
101 | and Duplex parameters must not be specified. | |
102 | ||
103 | NOTE: Refer to the Speed and Duplex section of this readme for more | |
104 | information on the AutoNeg parameter. | |
105 | ||
106 | ||
107 | Duplex | |
108 | ------ | |
109 | (Supported only on adapters with copper connections) | |
110 | Valid Range: 0-2 (0=auto-negotiate, 1=half, 2=full) | |
1da177e4 | 111 | Default Value: 0 |
55be062d JB |
112 | |
113 | Defines the direction in which data is allowed to flow. Can be either | |
114 | one or two-directional. If both Duplex and the link partner are set to | |
115 | auto-negotiate, the board auto-detects the correct duplex. If the link | |
116 | partner is forced (either full or half), Duplex defaults to half-duplex. | |
117 | ||
1da177e4 LT |
118 | |
119 | FlowControl | |
55be062d JB |
120 | ---------- |
121 | Valid Range: 0-3 (0=none, 1=Rx only, 2=Tx only, 3=Rx&Tx) | |
122 | Default Value: Reads flow control settings from the EEPROM | |
123 | ||
124 | This parameter controls the automatic generation(Tx) and response(Rx) | |
125 | to Ethernet PAUSE frames. | |
126 | ||
1da177e4 LT |
127 | |
128 | InterruptThrottleRate | |
55be062d JB |
129 | --------------------- |
130 | (not supported on Intel 82542, 82543 or 82544-based adapters) | |
131 | Valid Range: 100-100000 (0=off, 1=dynamic) | |
1da177e4 | 132 | Default Value: 8000 |
55be062d JB |
133 | |
134 | This value represents the maximum number of interrupts per second the | |
135 | controller generates. InterruptThrottleRate is another setting used in | |
136 | interrupt moderation. Dynamic mode uses a heuristic algorithm to adjust | |
137 | InterruptThrottleRate based on the current traffic load. | |
138 | ||
139 | NOTE: InterruptThrottleRate takes precedence over the TxAbsIntDelay and | |
140 | RxAbsIntDelay parameters. In other words, minimizing the receive | |
141 | and/or transmit absolute delays does not force the controller to | |
142 | generate more interrupts than what the Interrupt Throttle Rate | |
143 | allows. | |
144 | ||
145 | CAUTION: If you are using the Intel PRO/1000 CT Network Connection | |
146 | (controller 82547), setting InterruptThrottleRate to a value | |
147 | greater than 75,000, may hang (stop transmitting) adapters | |
148 | under certain network conditions. If this occurs a NETDEV | |
149 | WATCHDOG message is logged in the system event log. In | |
150 | addition, the controller is automatically reset, restoring | |
151 | the network connection. To eliminate the potential for the | |
152 | hang, ensure that InterruptThrottleRate is set no greater | |
153 | than 75,000 and is not set to 0. | |
154 | ||
155 | NOTE: When e1000 is loaded with default settings and multiple adapters | |
156 | are in use simultaneously, the CPU utilization may increase non- | |
157 | linearly. In order to limit the CPU utilization without impacting | |
158 | the overall throughput, we recommend that you load the driver as | |
159 | follows: | |
160 | ||
161 | insmod e1000.o InterruptThrottleRate=3000,3000,3000 | |
162 | ||
163 | This sets the InterruptThrottleRate to 3000 interrupts/sec for | |
164 | the first, second, and third instances of the driver. The range | |
165 | of 2000 to 3000 interrupts per second works on a majority of | |
166 | systems and is a good starting point, but the optimal value will | |
167 | be platform-specific. If CPU utilization is not a concern, use | |
168 | RX_POLLING (NAPI) and default driver settings. | |
169 | ||
1da177e4 LT |
170 | |
171 | RxDescriptors | |
55be062d JB |
172 | ------------- |
173 | Valid Range: 80-256 for 82542 and 82543-based adapters | |
174 | 80-4096 for all other supported adapters | |
1da177e4 | 175 | Default Value: 256 |
1da177e4 | 176 | |
55be062d JB |
177 | This value specifies the number of receive descriptors allocated by the |
178 | driver. Increasing this value allows the driver to buffer more incoming | |
179 | packets. Each descriptor is 16 bytes. A receive buffer is also | |
180 | allocated for each descriptor and is 2048. | |
1da177e4 | 181 | |
1da177e4 LT |
182 | |
183 | RxIntDelay | |
55be062d JB |
184 | ---------- |
185 | Valid Range: 0-65535 (0=off) | |
1da177e4 | 186 | Default Value: 0 |
55be062d JB |
187 | |
188 | This value delays the generation of receive interrupts in units of 1.024 | |
189 | microseconds. Receive interrupt reduction can improve CPU efficiency if | |
190 | properly tuned for specific network traffic. Increasing this value adds | |
191 | extra latency to frame reception and can end up decreasing the throughput | |
192 | of TCP traffic. If the system is reporting dropped receives, this value | |
193 | may be set too high, causing the driver to run out of available receive | |
194 | descriptors. | |
195 | ||
196 | CAUTION: When setting RxIntDelay to a value other than 0, adapters may | |
197 | hang (stop transmitting) under certain network conditions. If | |
198 | this occurs a NETDEV WATCHDOG message is logged in the system | |
199 | event log. In addition, the controller is automatically reset, | |
200 | restoring the network connection. To eliminate the potential | |
201 | for the hang ensure that RxIntDelay is set to 0. | |
202 | ||
203 | ||
204 | RxAbsIntDelay | |
205 | ------------- | |
206 | (This parameter is supported only on 82540, 82545 and later adapters.) | |
207 | Valid Range: 0-65535 (0=off) | |
1da177e4 | 208 | Default Value: 128 |
55be062d JB |
209 | |
210 | This value, in units of 1.024 microseconds, limits the delay in which a | |
211 | receive interrupt is generated. Useful only if RxIntDelay is non-zero, | |
212 | this value ensures that an interrupt is generated after the initial | |
213 | packet is received within the set amount of time. Proper tuning, | |
214 | along with RxIntDelay, may improve traffic throughput in specific network | |
215 | conditions. | |
216 | ||
217 | ||
218 | Speed | |
219 | ----- | |
220 | (This parameter is supported only on adapters with copper connections.) | |
1da177e4 | 221 | Valid Settings: 0, 10, 100, 1000 |
55be062d JB |
222 | Default Value: 0 (auto-negotiate at all supported speeds) |
223 | ||
224 | Speed forces the line speed to the specified value in megabits per second | |
225 | (Mbps). If this parameter is not specified or is set to 0 and the link | |
226 | partner is set to auto-negotiate, the board will auto-detect the correct | |
227 | speed. Duplex should also be set when Speed is set to either 10 or 100. | |
228 | ||
1da177e4 LT |
229 | |
230 | TxDescriptors | |
55be062d JB |
231 | ------------- |
232 | Valid Range: 80-256 for 82542 and 82543-based adapters | |
233 | 80-4096 for all other supported adapters | |
1da177e4 | 234 | Default Value: 256 |
1da177e4 | 235 | |
55be062d JB |
236 | This value is the number of transmit descriptors allocated by the driver. |
237 | Increasing this value allows the driver to queue more transmits. Each | |
238 | descriptor is 16 bytes. | |
239 | ||
240 | NOTE: Depending on the available system resources, the request for a | |
241 | higher number of transmit descriptors may be denied. In this case, | |
242 | use a lower number. | |
243 | ||
1da177e4 LT |
244 | |
245 | TxIntDelay | |
55be062d JB |
246 | ---------- |
247 | Valid Range: 0-65535 (0=off) | |
1da177e4 | 248 | Default Value: 64 |
55be062d JB |
249 | |
250 | This value delays the generation of transmit interrupts in units of | |
251 | 1.024 microseconds. Transmit interrupt reduction can improve CPU | |
252 | efficiency if properly tuned for specific network traffic. If the | |
253 | system is reporting dropped transmits, this value may be set too high | |
254 | causing the driver to run out of available transmit descriptors. | |
255 | ||
256 | ||
257 | TxAbsIntDelay | |
258 | ------------- | |
259 | (This parameter is supported only on 82540, 82545 and later adapters.) | |
260 | Valid Range: 0-65535 (0=off) | |
1da177e4 | 261 | Default Value: 64 |
55be062d JB |
262 | |
263 | This value, in units of 1.024 microseconds, limits the delay in which a | |
264 | transmit interrupt is generated. Useful only if TxIntDelay is non-zero, | |
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 | ||
1da177e4 LT |
279 | |
280 | Speed and Duplex Configuration | |
281 | ============================== | |
282 | ||
55be062d JB |
283 | Three keywords are used to control the speed and duplex configuration. |
284 | These keywords are Speed, Duplex, and AutoNeg. | |
1da177e4 | 285 | |
55be062d | 286 | If the board uses a fiber interface, these keywords are ignored, and the |
1da177e4 LT |
287 | fiber interface board only links at 1000 Mbps full-duplex. |
288 | ||
289 | For copper-based boards, the keywords interact as follows: | |
290 | ||
55be062d JB |
291 | The default operation is auto-negotiate. The board advertises all |
292 | supported speed and duplex combinations, and it links at the highest | |
293 | common speed and duplex mode IF the link partner is set to auto-negotiate. | |
1da177e4 | 294 | |
55be062d JB |
295 | If Speed = 1000, limited auto-negotiation is enabled and only 1000 Mbps |
296 | is advertised (The 1000BaseT spec requires auto-negotiation.) | |
1da177e4 LT |
297 | |
298 | If Speed = 10 or 100, then both Speed and Duplex should be set. Auto- | |
55be062d JB |
299 | negotiation is disabled, and the AutoNeg parameter is ignored. Partner |
300 | SHOULD also be forced. | |
301 | ||
302 | The AutoNeg parameter is used when more control is required over the | |
303 | auto-negotiation process. It should be used when you wish to control which | |
304 | speed and duplex combinations are advertised during the auto-negotiation | |
305 | process. | |
306 | ||
307 | The parameter may be specified as either a decimal or hexidecimal value as | |
308 | determined by the bitmap below. | |
1da177e4 | 309 | |
55be062d JB |
310 | Bit position 7 6 5 4 3 2 1 0 |
311 | Decimal Value 128 64 32 16 8 4 2 1 | |
312 | Hex value 80 40 20 10 8 4 2 1 | |
313 | Speed (Mbps) N/A N/A 1000 N/A 100 100 10 10 | |
314 | Duplex Full Full Half Full Half | |
1da177e4 | 315 | |
55be062d | 316 | Some examples of using AutoNeg: |
1da177e4 | 317 | |
55be062d JB |
318 | modprobe e1000 AutoNeg=0x01 (Restricts autonegotiation to 10 Half) |
319 | modprobe e1000 AutoNeg=1 (Same as above) | |
320 | modprobe e1000 AutoNeg=0x02 (Restricts autonegotiation to 10 Full) | |
321 | modprobe e1000 AutoNeg=0x03 (Restricts autonegotiation to 10 Half or 10 Full) | |
322 | modprobe e1000 AutoNeg=0x04 (Restricts autonegotiation to 100 Half) | |
323 | modprobe e1000 AutoNeg=0x05 (Restricts autonegotiation to 10 Half or 100 | |
324 | Half) | |
325 | modprobe e1000 AutoNeg=0x020 (Restricts autonegotiation to 1000 Full) | |
326 | modprobe e1000 AutoNeg=32 (Same as above) | |
1da177e4 | 327 | |
55be062d JB |
328 | Note that when this parameter is used, Speed and Duplex must not be specified. |
329 | ||
330 | If the link partner is forced to a specific speed and duplex, then this | |
331 | parameter should not be used. Instead, use the Speed and Duplex parameters | |
332 | previously mentioned to force the adapter to the same speed and duplex. | |
1da177e4 LT |
333 | |
334 | ||
335 | Additional Configurations | |
336 | ========================= | |
337 | ||
338 | Configuring the Driver on Different Distributions | |
339 | ------------------------------------------------- | |
340 | ||
55be062d JB |
341 | Configuring a network driver to load properly when the system is started |
342 | is distribution dependent. Typically, the configuration process involves | |
343 | adding an alias line to /etc/modules.conf or /etc/modprobe.conf as well | |
344 | as editing other system startup scripts and/or configuration files. Many | |
345 | popular Linux distributions ship with tools to make these changes for you. | |
346 | To learn the proper way to configure a network device for your system, | |
347 | refer to your distribution documentation. If during this process you are | |
348 | asked for the driver or module name, the name for the Linux Base Driver | |
349 | for the Intel PRO/1000 Family of Adapters is e1000. | |
1da177e4 | 350 | |
55be062d JB |
351 | As an example, if you install the e1000 driver for two PRO/1000 adapters |
352 | (eth0 and eth1) and set the speed and duplex to 10full and 100half, add | |
353 | the following to modules.conf or or modprobe.conf: | |
1da177e4 LT |
354 | |
355 | alias eth0 e1000 | |
356 | alias eth1 e1000 | |
357 | options e1000 Speed=10,100 Duplex=2,1 | |
358 | ||
359 | Viewing Link Messages | |
360 | --------------------- | |
361 | ||
55be062d JB |
362 | Link messages will not be displayed to the console if the distribution is |
363 | restricting system messages. In order to see network driver link messages | |
364 | on your console, set dmesg to eight by entering the following: | |
1da177e4 LT |
365 | |
366 | dmesg -n 8 | |
367 | ||
368 | NOTE: This setting is not saved across reboots. | |
369 | ||
370 | Jumbo Frames | |
371 | ------------ | |
372 | ||
55be062d JB |
373 | The driver supports Jumbo Frames for all adapters except 82542 and |
374 | 82573-based adapters. Jumbo Frames support is enabled by changing the | |
375 | MTU to a value larger than the default of 1500. Use the ifconfig command | |
376 | to increase the MTU size. For example: | |
377 | ||
378 | ifconfig eth<x> mtu 9000 up | |
379 | ||
380 | This setting is not saved across reboots. It can be made permanent if | |
381 | you add: | |
382 | ||
383 | MTU=9000 | |
1da177e4 | 384 | |
55be062d JB |
385 | to the file /etc/sysconfig/network-scripts/ifcfg-eth<x>. This example |
386 | applies to the Red Hat distributions; other distributions may store this | |
387 | setting in a different location. | |
1da177e4 | 388 | |
55be062d | 389 | Notes: |
1da177e4 | 390 | |
55be062d JB |
391 | - To enable Jumbo Frames, increase the MTU size on the interface beyond |
392 | 1500. | |
393 | - The maximum MTU setting for Jumbo Frames is 16110. This value coincides | |
394 | with the maximum Jumbo Frames size of 16128. | |
395 | - Using Jumbo Frames at 10 or 100 Mbps may result in poor performance or | |
396 | loss of link. | |
397 | - Some Intel gigabit adapters that support Jumbo Frames have a frame size | |
398 | limit of 9238 bytes, with a corresponding MTU size limit of 9216 bytes. | |
399 | The adapters with this limitation are based on the Intel 82571EB and | |
400 | 82572EI controllers, which correspond to these product names: | |
401 |