| 1 |
1275 |
phoenix |
Linux* Base Driver for the Intel(R) PRO/1000 Family of Adapters
|
| 2 |
|
|
===============================================================
|
| 3 |
|
|
|
| 4 |
|
|
January 8, 2003
|
| 5 |
|
|
|
| 6 |
|
|
|
| 7 |
|
|
Contents
|
| 8 |
|
|
========
|
| 9 |
|
|
|
| 10 |
|
|
- In This Release
|
| 11 |
|
|
- Supported Adapters
|
| 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
|
| 23 |
|
|
of Adapters, version 5.0.x. This driver includes support for
|
| 24 |
|
|
Itanium(TM)-based systems.
|
| 25 |
|
|
|
| 26 |
|
|
|
| 27 |
|
|
|
| 28 |
|
|
|
| 29 |
|
|
Supported Adapters
|
| 30 |
|
|
==================
|
| 31 |
|
|
|
| 32 |
|
|
The following Intel network adapters are compatible with the drivers in this
|
| 33 |
|
|
release:
|
| 34 |
|
|
|
| 35 |
|
|
Controller Adapter Name Board IDs
|
| 36 |
|
|
---------- ------------ ---------
|
| 37 |
|
|
|
| 38 |
|
|
82542 PRO/1000 Gigabit Server Adapter 700262-xxx, 717037-xxx
|
| 39 |
|
|
|
| 40 |
|
|
82543 PRO/1000 F Server Adapter 738640-xxx, A38888-xxx
|
| 41 |
|
|
|
| 42 |
|
|
82543 PRO/1000 T Server Adapter A19845-xxx, A33948-xxx
|
| 43 |
|
|
|
| 44 |
|
|
82544 PRO/1000 XT Server Adapter A51580-xxx
|
| 45 |
|
|
|
| 46 |
|
|
82544 PRO/1000 XF Server Adapter A50484-xxx
|
| 47 |
|
|
|
| 48 |
|
|
82544 PRO/1000 T Desktop Adapter A62947-xxx
|
| 49 |
|
|
|
| 50 |
|
|
82540 PRO/1000 MT Desktop Adapter A78408-xxx
|
| 51 |
|
|
82541 C91016-xxx
|
| 52 |
|
|
|
| 53 |
|
|
82545 PRO/1000 MT Server Adapter A92165-xxx
|
| 54 |
|
|
|
| 55 |
|
|
82546 PRO/1000 MT Dual Port Server Adapter A92111-xxx
|
| 56 |
|
|
|
| 57 |
|
|
82545 PRO/1000 MF Server Adapter A91622-xxx
|
| 58 |
|
|
|
| 59 |
|
|
82545 PRO/1000 MF Server Adapter(LX) A91624-xxx
|
| 60 |
|
|
|
| 61 |
|
|
82546 PRO/1000 MF Dual Port Server Adapter A91620-xxx
|
| 62 |
|
|
|
| 63 |
|
|
|
| 64 |
|
|
|
| 65 |
|
|
To verify your Intel adapter is supported, find the board ID number on the
|
| 66 |
|
|
adapter. Look for a label that has a barcode and a number in the format
|
| 67 |
|
|
A12345-001. Match this to the list of numbers above.
|
| 68 |
|
|
|
| 69 |
|
|
For more information on how to identify your adapter, go to the Adapter &
|
| 70 |
|
|
Driver ID Guide at:
|
| 71 |
|
|
|
| 72 |
|
|
http://support.intel.com/support/network/adapter/pro100/21397.htm
|
| 73 |
|
|
|
| 74 |
|
|
For the latest Intel network drivers for Linux, refer to the following
|
| 75 |
|
|
|
| 76 |
|
|
http://downloadfinder.intel.com/scripts-df/support_intel.asp
|
| 77 |
|
|
|
| 78 |
|
|
|
| 79 |
|
|
Command Line Parameters
|
| 80 |
|
|
=======================
|
| 81 |
|
|
|
| 82 |
|
|
If the driver is built as a module, the following optional parameters are
|
| 83 |
|
|
used by entering them on the command line with the modprobe or insmod command
|
| 84 |
|
|
using this syntax:
|
| 85 |
|
|
|
| 86 |
|
|
modprobe e1000 [
|
| 87 |
|
|
|
| 88 |
|
|
insmod e1000 [
|
| 89 |
|
|
|
| 90 |
|
|
For example, with two PRO/1000 PCI adapters, entering:
|
| 91 |
|
|
|
| 92 |
|
|
insmod e1000 TxDescriptors=80,128
|
| 93 |
|
|
|
| 94 |
|
|
loads the e1000 driver with 80 TX resources for the first adapter and 128 TX
|
| 95 |
|
|
resources for the second adapter.
|
| 96 |
|
|
|
| 97 |
|
|
The default value for each parameter is generally the recommended setting,
|
| 98 |
|
|
unless otherwise noted.
|
| 99 |
|
|
|
| 100 |
|
|
For more information about the AutoNeg, Duplex, and Speed parameters, see the
|
| 101 |
|
|
"Speed and Duplex Configuration" section in this document.
|
| 102 |
|
|
|
| 103 |
|
|
|
| 104 |
|
|
AutoNeg (adapters using copper connections only)
|
| 105 |
|
|
Valid Range: 0x01-0x0F, 0x20-0x2F
|
| 106 |
|
|
Default Value: 0x2F
|
| 107 |
|
|
This parameter is a bit mask that specifies which speed and duplex
|
| 108 |
|
|
settings the board advertises. When this parameter is used, the Speed and
|
| 109 |
|
|
Duplex parameters must not be specified.
|
| 110 |
|
|
|
| 111 |
|
|
Duplex (adapters using copper connections only)
|
| 112 |
|
|
Valid Range: 0-2 (0=auto-negotiate, 1=half, 2=full)
|
| 113 |
|
|
Default Value: 0
|
| 114 |
|
|
Defines the direction in which data is allowed to flow. Can by either one
|
| 115 |
|
|
or two-directional. If both Duplex and the link partner are set to auto-
|
| 116 |
|
|
negotiate, the board auto-detects the correct duplex. If the link partner
|
| 117 |
|
|
is forced (either full or half), Duplex defaults to half-duplex.
|
| 118 |
|
|
|
| 119 |
|
|
FlowControl
|
| 120 |
|
|
Valid Range: 0-3 (0=none, 1=Rx only, 2=Tx only, 3=Rx&Tx)
|
| 121 |
|
|
Default: Read flow control settings from the EEPROM
|
| 122 |
|
|
This parameter controls the automatic generation(Tx) and response(Rx) to
|
| 123 |
|
|
Ethernet PAUSE frames.
|
| 124 |
|
|
|
| 125 |
|
|
InterruptThrottleRate
|
| 126 |
|
|
Valid Range: 100-100000 (0=off, 1=dynamic)
|
| 127 |
|
|
Default Value: 1
|
| 128 |
|
|
This value represents the maximum number of interrupts per second the
|
| 129 |
|
|
controller generates. InterruptThrottleRate is another setting used in
|
| 130 |
|
|
interrupt moderation. Dynamic mode uses a heuristic algorithm to adjust
|
| 131 |
|
|
InterruptThrottleRate based on the current traffic load.
|
| 132 |
|
|
|
| 133 |
|
|
NOTE: InterruptThrottleRate takes precedence over the TxAbsIntDelay and
|
| 134 |
|
|
RxAbsIntDelay parameters. In other words, minimizing the receive
|
| 135 |
|
|
and/or transmit absolute delays does not force the controller to
|
| 136 |
|
|
generate more interrupts than what the Interrupt Throttle Rate
|
| 137 |
|
|
allows.
|
| 138 |
|
|
|
| 139 |
|
|
RxDescriptors
|
| 140 |
|
|
Valid Range: 80-256 for 82542 and 82543-based adapters
|
| 141 |
|
|
80-4096 for 82540, 82544, 82545, and 82546-based adapters
|
| 142 |
|
|
Default Value: 80
|
| 143 |
|
|
This value is the number of receive descriptors allocated by the driver.
|
| 144 |
|
|
Increasing this value allows the driver to buffer more incoming packets.
|
| 145 |
|
|
Each descriptor is 16 bytes. A receive buffer is also allocated for each
|
| 146 |
|
|
descriptor and can be either 2048, 4096, 8192, or 16384 bytes, depending
|
| 147 |
|
|
on the MTU setting. The maximum MTU size is 16110.
|
| 148 |
|
|
|
| 149 |
|
|
NOTE: MTU designates the frame size. It only needs to be set for Jumbo
|
| 150 |
|
|
Frames.
|
| 151 |
|
|
|
| 152 |
|
|
RxIntDelay
|
| 153 |
|
|
Valid Range: 0-65535 (0=off)
|
| 154 |
|
|
Default Value: 0
|
| 155 |
|
|
This value delays the generation of receive interrupts in units of 1.024
|
| 156 |
|
|
microseconds. Receive interrupt reduction can improve CPU efficiency if
|
| 157 |
|
|
properly tuned for specific network traffic. Increasing this value adds
|
| 158 |
|
|
extra latency to frame reception and can end up decreasing the throughput
|
| 159 |
|
|
of TCP traffic. If the system is reporting dropped receives, this value
|
| 160 |
|
|
may be set too high, causing the driver to run out of available receive
|
| 161 |
|
|
descriptors.
|
| 162 |
|
|
|
| 163 |
|
|
CAUTION: When setting RxIntDelay to a value other than 0, adapters may
|
| 164 |
|
|
hang (stop transmitting) under certain network conditions. If
|
| 165 |
|
|
this occurs a NETDEV WATCHDOG message is logged in the system
|
| 166 |
|
|
event log. In addition, the controller is automatically reset,
|
| 167 |
|
|
restoring the network connection. To eliminate the potential for
|
| 168 |
|
|
the hang ensure that RxIntDelay is set to 0.
|
| 169 |
|
|
|
| 170 |
|
|
RxAbsIntDelay (82540, 82545, and 82546-based adapters only)
|
| 171 |
|
|
Valid Range: 0-65535 (0=off)
|
| 172 |
|
|
Default Value: 128
|
| 173 |
|
|
This value, in units of 1.024 microseconds, limits the delay in which a
|
| 174 |
|
|
transmit interrupt is generated. Useful only if RxIntDelay is non-zero,
|
| 175 |
|
|
this value ensures that an interrupt is generated after the initial
|
| 176 |
|
|
packet is received within the set amount of time. Proper tuning,
|
| 177 |
|
|
along with RxIntDelay, may improve traffic throughput in specific network
|
| 178 |
|
|
conditions.
|
| 179 |
|
|
|
| 180 |
|
|
Speed (adapters using copper connections only)
|
| 181 |
|
|
Valid Settings: 0, 10, 100, 1000
|
| 182 |
|
|
Default Value: 0 (auto-negotiate at all supported speeds)
|
| 183 |
|
|
Speed forces the line speed to the specified value in megabits per second
|
| 184 |
|
|
(Mbps). If this parameter is not specified or is set to 0 and the link
|
| 185 |
|
|
partner is set to auto-negotiate, the board will auto-detect the correct
|
| 186 |
|
|
speed. Duplex should also be set when Speed is set to either 10 or 100.
|
| 187 |
|
|
|
| 188 |
|
|
TxDescriptors
|
| 189 |
|
|
Valid Range: 80-256 for 82542 and 82543-based adapters
|
| 190 |
|
|
80-4096 for 82540, 82544, 82545, and 82546-based adapters
|
| 191 |
|
|
Default Value: 256
|
| 192 |
|
|
This value is the number of transmit descriptors allocated by the driver.
|
| 193 |
|
|
Increasing this value allows the driver to queue more transmits. Each
|
| 194 |
|
|
descriptor is 16 bytes.
|
| 195 |
|
|
|
| 196 |
|
|
TxIntDelay
|
| 197 |
|
|
Valid Range: 0-65535 (0=off)
|
| 198 |
|
|
Default Value: 64
|
| 199 |
|
|
This value delays the generation of transmit interrupts in units of
|
| 200 |
|
|
1.024 microseconds. Transmit interrupt reduction can improve CPU
|
| 201 |
|
|
efficiency if properly tuned for specific network traffic. If the
|
| 202 |
|
|
system is reporting dropped transmits, this value may be set too high
|
| 203 |
|
|
causing the driver to run out of available transmit descriptors.
|
| 204 |
|
|
|
| 205 |
|
|
TxAbsIntDelay (82540, 82545, and 82546-based adapters only)
|
| 206 |
|
|
Valid Range: 0-65535 (0=off)
|
| 207 |
|
|
Default Value: 64
|
| 208 |
|
|
This value, in units of 1.024 microseconds, limits the delay in which a
|
| 209 |
|
|
transmit interrupt is generated. Useful only if TxIntDelay is non-zero,
|
| 210 |
|
|
this value ensures that an interrupt is generated after the initial
|
| 211 |
|
|
packet is sent on the wire within the set amount of time. Proper tuning,
|
| 212 |
|
|
along with TxIntDelay, may improve traffic throughput in specific
|
| 213 |
|
|
network conditions.
|
| 214 |
|
|
|
| 215 |
|
|
XsumRX (not available on the 82542-based adapter)
|
| 216 |
|
|
Valid Range: 0-1
|
| 217 |
|
|
Default Value: 1
|
| 218 |
|
|
A value of '1' indicates that the driver should enable IP checksum
|
| 219 |
|
|
offload for received packets (both UDP and TCP) to the adapter hardware.
|
| 220 |
|
|
|
| 221 |
|
|
|
| 222 |
|
|
Speed and Duplex Configuration
|
| 223 |
|
|
==============================
|
| 224 |
|
|
|
| 225 |
|
|
Three keywords are used to control the speed and duplex configuration. These
|
| 226 |
|
|
keywords are Speed, Duplex, and AutoNeg.
|
| 227 |
|
|
|
| 228 |
|
|
If the board uses a fiber interface, these keywords are ignored, and the
|
| 229 |
|
|
fiber interface board only links at 1000 Mbps full-duplex.
|
| 230 |
|
|
|
| 231 |
|
|
For copper-based boards, the keywords interact as follows:
|
| 232 |
|
|
|
| 233 |
|
|
The default operation is auto-negotiate. The board advertises all supported
|
| 234 |
|
|
speed and duplex combinations, and it links at the highest common speed and
|
| 235 |
|
|
duplex mode IF the link partner is set to auto-negotiate.
|
| 236 |
|
|
|
| 237 |
|
|
If Speed = 1000, limited auto-negotiation is enabled and only 1000 Mbps is
|
| 238 |
|
|
advertised (The 1000BaseT spec requires auto-negotiation.)
|
| 239 |
|
|
|
| 240 |
|
|
If Speed = 10 or 100, then both Speed and Duplex should be set. Auto-
|
| 241 |
|
|
negotiation is disabled, and the AutoNeg parameter is ignored. Partner SHOULD
|
| 242 |
|
|
also be forced.
|
| 243 |
|
|
|
| 244 |
|
|
The AutoNeg parameter is used when more control is required over the auto-
|
| 245 |
|
|
negotiation process. When this parameter is used, Speed and Duplex must not
|
| 246 |
|
|
be specified. This parameter is a bitmap that specifies which speed and
|
| 247 |
|
|
duplex settings are advertised to the link partner.
|
| 248 |
|
|
|
| 249 |
|
|
Bit 7 6 5 4 3 2 1 0
|
| 250 |
|
|
Speed (Mbps) N/A N/A 1000 N/A 100 100 10 10
|
| 251 |
|
|
Duplex Full Full Half Full Half
|
| 252 |
|
|
|
| 253 |
|
|
Note that setting AutoNeg does not guarantee that the board will link at the
|
| 254 |
|
|
highest specified speed or duplex mode, but the board will link at the
|
| 255 |
|
|
highest possible speed/duplex of the link partner IF the link partner is also
|
| 256 |
|
|
set to auto-negotiate. If the link partner is forced speed/duplex, the
|
| 257 |
|
|
adapter MUST be forced to the same speed/duplex.
|
| 258 |
|
|
|
| 259 |
|
|
|
| 260 |
|
|
Additional Configurations
|
| 261 |
|
|
=========================
|
| 262 |
|
|
|
| 263 |
|
|
Jumbo Frames
|
| 264 |
|
|
------------
|
| 265 |
|
|
|
| 266 |
|
|
The driver supports Jumbo Frames for all adapters except 82542-based
|
| 267 |
|
|
adapters. Jumbo Frames support is enabled by changing the MTU to a value
|
| 268 |
|
|
larger than the default of 1500. Use the ifconfig command to increase the
|
| 269 |
|
|
MTU size. For example:
|
| 270 |
|
|
|
| 271 |
|
|
ifconfig ethx mtu 9000 up
|
| 272 |
|
|
|
| 273 |
|
|
The maximum MTU setting for Jumbo Frames is 16110. This value coincides
|
| 274 |
|
|
with the maximum Jumbo Frames size of 16128.
|
| 275 |
|
|
|
| 276 |
|
|
NOTE: Jumbo Frames are supported at 1000 Mbps only. Using Jumbo Frames at
|
| 277 |
|
|
10 or 100 Mbps may result in poor performance or loss of link.
|
| 278 |
|
|
|
| 279 |
|
|
|
| 280 |
|
|
Known Issues
|
| 281 |
|
|
============
|
| 282 |
|
|
|
| 283 |
|
|
Jumbo Frames System Requirement
|
| 284 |
|
|
-------------------------------
|
| 285 |
|
|
|
| 286 |
|
|
Memory allocation failures have been observed on Linux systems with 64 MB
|
| 287 |
|
|
of RAM or less that are running Jumbo Frames. If you are using Jumbo
|
| 288 |
|
|
Frames, your system may require more than the advertised minimum
|
| 289 |
|
|
requirement of 64 MB of system memory.
|
| 290 |
|
|
|
| 291 |
|
|
|
| 292 |
|
|
Support
|
| 293 |
|
|
=======
|
| 294 |
|
|
|
| 295 |
|
|
For general information, go to the Intel support website at:
|
| 296 |
|
|
|
| 297 |
|
|
http://support.intel.com
|
| 298 |
|
|
|
| 299 |
|
|
If an issue is identified with the released source code on the supported
|
| 300 |
|
|
kernel with a supported adapter, email the specific information related to
|
| 301 |
|
|
the issue to linux.nics@intel.com.
|
| 302 |
|
|
|
| 303 |
|
|
|
| 304 |
|
|
License
|
| 305 |
|
|
=======
|
| 306 |
|
|
|
| 307 |
|
|
This software program is released under the terms of a license agreement
|
| 308 |
|
|
between you ('Licensee') and Intel. Do not use or load this software or any
|
| 309 |
|
|
associated materials (collectively, the 'Software') until you have carefully
|
| 310 |
|
|
read the full terms and conditions of the LICENSE located in this software
|
| 311 |
|
|
package. By loading or using the Software, you agree to the terms of this
|
| 312 |
|
|
Agreement. If you do not agree with the terms of this Agreement, do not
|
| 313 |
|
|
install or use the Software.
|
| 314 |
|
|
|
| 315 |
|
|
* Other names and brands may be claimed as the property of others.
|
