e100.7

Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters

.\" LICENSE
.\"
.\" This software program is released under the terms of a license agreement between you ('Licensee') and Intel. Do not use or load this software or any associated materials (collectively, the 'Software') until you have carefully read the full terms and conditions of the LICENSE located in this software package. By loading or using the Software, you agree to the terms of this Agreement. If you do not agree with the terms of this Agreement, do not install or use the Software.
.\"
.\" * Other names and brands may be claimed as the property of others.
.\"
.TH e100 1 "July 2003"


.SH NAME
e100 \-This file describes the Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters.


.SH SYNOPSIS
modprobe e100 [<option>=<VAL1>,<VAL2>,...]
.br
insmod e100 [<option>=<VAL1>,<VAL2>,...]
.LP


.SH DESCRIPTION
This driver is intended for \fB2.4.x\fR kernels; it is known to build properly on \fB2.4.x\fR kernels through \fB2.4.20\fR. Intel focused testing on Intel architectures running the \fB2.4.20\fR kernel. This driver includes support for Itanium(TM)-based systems.
.LP
The Intel PRO/100 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 requirements, refer to the documentation supplied with your Intel PRO/100 adapter.
.LP


.SH OPTIONS
The following optional parameters are used by entering them on the command line with the modprobe (or insmod) command. For example, with two Intel PRO/100 PCI adapters, entering:
.IP
.B modprobe e100 TxDescriptors=32,128
.LP
loads the e100 driver with 32 TX resources for the first adapter and 128 TX resources for the second adapter. This configuration favors the second adapter. The driver supports up to 16 network adapters concurrently.
.LP
.B NOTE:
Giving any command line option the value "-1" means that the driver will use the appropriate default value for that option, as if no value was specified.
.LP
.B BundleMax
.IP
.B Valid Range:
1-65535
.br
.B Default Value:
6
.IP
holds the maximum number of small packets (less than 128 bytes) in a bundle. Reasonable values range from 2 to 10. See "CPU Cycle Saver" in README.
.LP
.B BundleSmallFr
.IP
.B Valid Range: 
0-1 (0=off, 1=on)
.br
.B Default Value: 
0
.IP
On means that small packets (less than 128 bytes) will be bundled. See "CPU Cycle Saver" in README.
.LP
.B e100_speed_duplex
.IP
.B Valid Range: 
0-4 (1=10half;2=10full;3=100half;4=100full)
.br
.B Default Value: 
0
.IP
holds speed and duplex values. The default value of 0 sets the adapter to auto-negotiate. Other values set the adapter to forced speed and duplex. 
.IP
Example usage: insmod e100.o e100_speed_duplex=4,4 (for two adapters)
.LP
.B flow_control
.IP
.B Valid Range:
0-1 (0=off, 1=on)
.br
.B Default Value: 
0
.IP
controls the automatic generation(Tx) and response(Rx) to Ethernet PAUSE frames. flow_control should NOT be set to 1 when the adapter is connected to an interface that does not support Ethernet PAUSE frames and when the e100_speed_duplex parameter is NOT set to zero. 
.LP
.B IFS
.IP
.B Valid Range: 
0-1 (0=off, 1=on)
.br
.B Default Value: 
1
.IP
aims to reduce the number of Ethernet frame collisions by altering the time between frame transmissions. When IFS is enabled the driver tries to find an optimal IFS value. It is used only at half duplex.
.LP
.B IntDelay
.IP
.B Valid Range:
0-65535 (0=off)
.br
.B Default Value:
1536
.IP
holds the number of time units (in adapter terminology) until the adapter generates an interrupt in case the bundle is not full. The recommended value for IntDelay is 1536 (upon initialization). Reasonable values range from 512 to 2048. See "CPU Cycle Saver" in README.
.LP
.B RxDescriptors
.IP
.B Valid Range: 
8-1024
.br
.B Default Value: 
64
.IP
defines the number of receive descriptors allocated by the driver. Increasing this value allows the driver to buffer more incoming packets before the driver is required to service an interrupt. 
.IP
.B The maximum value for Itanium-based systems is 64.
.LP
.B TxDescriptors
.IP
.B Valid Range: 
19-1024
.br
.B Default Value: 
64
.IP
defines the number of transmit descriptors allocated by the driver. Increasing this value allows the protocol stack to queue more transmits at the driver level. 
.IP
.B The maximum value for Itanium-based systems is 64.
.LP
.B ucode
.IP
.B Valid Range: 
0-1 (0=off, 1=on)
.br
.B Default Value:
0 for 82558-based adapters, 1 for 82559, 82550, and 82551-based adapters
.IP
uploads the micro code to the adapter when set to 1 -- this enables CPU Cycle Saver. See the section "CPU Cycle Saver" in README. Not available for 82557-based adapters.
.IP
.B Example usage: insmod e100.o ucode=1
.LP
.B XsumRX
.IP
.B Valid Range: 
0-1 (0=off, 1=on)
.br
.B Default Value: 
1
.IP
allows Rx checksum offloading for TCP/UDP packets when set to 1.
.IP
.B Requires that the hardware support this feature (not available on 82557 and 82558-based adapters).
.LP


.SH SUPPORT
.LP
For additional information, including supported adapters, building, and installation, see the README file included with the driver.
.LP
For general information, go to the Intel support Website at:
.IP
.B http://support.intel.com
.LP
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 [e-mail].
.LP