e1000(1) e1000(1) NAME e1000 -This file describes the Linux* driver, version 4.0.x, for the Intel(R) PRO/1000 Family of Server Adapters. SYNOPSIS modprobe e1000 [options] insmod e1000 [options] DESCRIPTION This driver is intended for 2.2.x and 2.4.x kernels; it is known to build properly on 2.2.x kernels through 2.2.20 and on 2.4.x kernels through 2.4.16. Intel focused testing on Intel processor-based systems running kernels 2.4.7 and 2.2.16. This driver includes support for Itanium(TM)-based systems. The Intel PRO/1000 driver is only supported as a loadable module at this time. Intel is not supplying patches against the kernel source to allow for static linking of the driver. For questions related to hardware require- ments, refer to the documentation supplied with your Intel PRO/1000 adapter. All hardware requirements listed apply to use with Linux. This release version includes the following: - hooks for Intel ANS, the Intel Advanced Networking Services driver. Some base driver versions within specific distributions, including Red Hat*, do not include these hooks. - support for the ethtool 1.4 interface. A third- party application can use the ethtool interface to get and set driver parameters such as speed and duplex. - the zero copy feature to provide faster information throughput. By default, zero copy is on if using a kernel that supports it. Zero copy is not supported on the original PRO/1000 Gigabit Server Adapter. OPTIONS The following parameters are used by entering them on the command line with the modprobe (or insmod) command. For example, with two PRO/1000 PCI adapters, entering: modprobe e1000 TxDescriptors=80,128 loads the e1000 driver with 80 TX resources for the first adapter and 128 TX resources for the second adapter. -AutoNeg[=VAL] Valid Range: 0-0x0F, 0x20-0x2F Default Value: 0x2F bit mask that specifies which speed and duplex set- tings the board advertises. When AutoNeg is not set to the default, the speed and duplex parameters must not be specified. This parameter applies to Intel PRO/1000 T and PRO/1000 XT server adapters only. See the section "Speed and Duplex Configuration" in Readme. -Duplex[=VAL] Valid Range: 0-2 (0=auto-negotiate, 1=half, 2=full) Default Value: 0 defines the direction in which data is allowed to flow -- either one or two-directional. If this parameter is not specified or is set to 0 and the link partner is set to auto-negotiate, the board will auto-detect the correct duplex. If the link partner is forced (either full or half), Duplex defaults to half-duplex. This parameter applies to Intel PRO/1000 T and PRO/1000 XT server adapters only. See the section "Speed and Duplex Configuration" in Readme. -FlowControl[=VAL] Valid Range: 0-3 (0 = none, 1 = Rx only, 2 = Tx only, 3 = Rx and Tx) Default Value: Read flow control settings from the EEPROM controls the automatic generation(Tx) and response(Rx) to Ethernet PAUSE frames. -RxDescriptors[=VAL] Valid Range: 80-256 for 82542 and 82543-based adapters, 80-4096 for 82544-based adapters Default Value: 256 number of receive descriptors allocated by the driver. Increasing this value allows the driver to buffer more incoming packets. Each descriptor is 16 bytes. A receive buffer is also allocated for each descriptor and can be either 2048, 4096, 8192, or 16384 bytes, depending on the MTU setting. -RxIntDelay[=VAL] Valid Range: 0-65535 (0=off) Default Value: 64 delays the generation of receive interrupts in units of 1.024 microseconds. Receive interrupt reduction can improve CPU efficiency if properly tuned for specific network traffic. Increasing this value adds extra latency to frame reception and can end up decreasing the throughput of TCP traffic. If the system is reporting dropped receives, this value may be set too high, causing the driver to run out of available receive descriptors. -Speed[=VAL] Valid Range: 0, 10, 100, 1000 Default Value: 0 (auto-negotiate at all supported speeds) forces the line speed to the specified value in megabits per second (Mbps). If this parameter is not specified or is set to 0 and the link partner is set to auto-negotiate, the board auto-detects the correct speed. The duplex must also be set when the speed parameter is set to either 10 or 100. This parameter applies to Intel PRO/1000 T and PRO/1000 XT server adapters only. See the section "Speed and Duplex Configuration" in Readme. -TxDescriptors[=VAL] Valid Range: 80-256 for 82542 and 82543-based adapters, 80-4096 for 82544-based adapters Default Value: 256 number of transmit descriptors allocated by the driver. Increasing this value allows the driver to queue more transmits. Each descriptor is 16 bytes. -TxIntDelay[=VAL] Valid Range: 0-65535 (0=off) Default Value: 64 delays the generation of transmit interrupts in units of 1.024 microseconds. Transmit interrupt reduction can improve CPU efficiency if properly tuned for specific network traffic. If the system is reporting dropped transmits, this value may be set too high causing the driver to run out of available transmit descriptors. -XsumRX[=VAL] Valid Range: 0-1 Default Value: 1 enables IP checksum offload for received packets (both UDP and TCP) to the adapter hardware when set to 1. This parameter is not available on the PRO/1000 Gigabit Server Adapter. SUPPORT For additional information, including supported adapters, building, and installation, see the Read Me file included with the driver. For general information and support, go to the Intel sup- port website at: http://support.intel.com If an issue is identified with the released source code on the supported kernel with a supported adapter, email the specific information related to the issue to linux.nics@intel.com. LIICENSE Recipient has requested a license and Intel Corporation ("Intel") is willing to grant a license for the software entitled Linux Base Driver for the Intel(R) PRO/1000 Fam- ily of Adapters (e1000) (the "Software") being provided by Intel Corporation. The following definitions apply to this License: "Licensed Patents" means patent claims licensable by Intel Corporation which are necessarily infringed by the use or sale of the Software alone or when combined with the oper- ating system referred to below. "Recipient" means the party to whom Intel delivers this Software. "Licensee" means Recipient and those third parties that receive a license to any operating system available under the GNU Public License version 2.0 or later. Copyright (c) 1999-2002 Intel Corporation All rights reserved. The license is provided to Recipient and Recipient's Licensees under the following terms. Redistribution and use in source and binary forms of the Software, with or without modification, are permitted pro- vided that the following conditions are met: Redistributions of source code of the Software may retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form of the Software may repro- duce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of Intel Corporation nor the names of its contributors shall be used to endorse or promote products derived from this Software without specific prior written permission. Intel hereby grants Recipient and Licensees a non-exclu- sive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Software, if any, in source code and object code form. This license shall include changes to the Software that are error corrections or other minor changes to the Software that do not add func- tionality or features when the Software is incorporated in any version of a operating system that has been dis- tributed under the GNU General Public License 2.0 or later. This patent license shall apply to the combination of the Software and any operating system licensed under the GNU Public License version 2.0 or later if, at the time Intel provides the Software to Recipient, such addi- tion of the Software to the then publicly available versions of such operating system available under the GNU Public License version 2.0 or later (whether in gold, beta or alpha form) causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Software. No hardware per se is licensed hereunder. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WAR- RANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WAR- RANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDEN- TAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUD- ING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABIL- ITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSI- BILITY OF SUCH DAMAGE. * Other names and brands may be claimed as the property of others. January 2002 e1000(1)