e1000(1)                                                 e1000(1)



NAME
       e1000  -This file describes the Linux* Base Driver for the
       Intel(R) PRO/1000 Family of Adapters, version 4.4.x.



SYNOPSIS
       modprobe e1000 [<option>=<VAL1>,<VAL2>,...]
       insmod e1000 [<option>=<VAL1>,<VAL2>,...]




DESCRIPTION
       This driver is intended for 2.4.x kernels; it is known  to
       build  properly  on  2.4.x  kernels  through 2.4.18. Intel
       focused testing on Intel architectures running the  2.4.18
       kernel. This driver includes support for Itanium(TM)-based
       systems.

       This 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/1000  adapter.
       All  hardware requirements listed apply to use with Linux.




OPTIONS
       The following optional parameters  are  used  by  entering
       them  on the command line with the modprobe or insmod com-
       mand.  For example, with two PRO/1000 PCI adapters, enter-
       ing:

              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

              Valid Range: 0x01-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 only applies
              to adapters using copper connections.

              See the section "Speed and Duplex Configuration" in
              Readme.

       Duplex

              Valid Range: 0-2 (0=auto-negotiate, 1=half, 2=full)
              Default Value: 0

              defines the direction in which data is  allowed  to
              flow. Can by either one or two-directional. If both
              Duplex and the link partner are set to auto-negoti-
              ate,  the board auto-detects the correct duplex. If
              the link partner is forced (either full  or  half),
              Duplex defaults to half-duplex. This parameter only
              applies to adapters using copper connections.

              See the section "Speed and Duplex Configuration" in
              Readme.

       FlowControl

              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.

       InterruptThrottleRate

              Valid Range: 100-100000 (0=off)

              Default Value: 8000

              represents the maximum  number  of  interrupts  per
              second  the  controller  generates. InterruptThrot-
              tleRate is another setting used in interrupt moder-
              ation.

              NOTE:  InterruptThrottleRate  takes precedence over
              the TxAbsIntDelay and RxAbsIntDelay parameters.  In
              other words, minimizing the receive and/or transmit
              absolute delays does not force  the  controller  to
              generate  more  interrupts  than what the Interrupt
              Throttle Rate allows.

       RxDescriptors

              Valid  Range:  80-256  for  82542  and  82543-based
              adapters,  80-4096  for  82540,  82544,  82545, and
              82546-based adapters
              Default Value: 80

              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. The
              maximum MTU size is 16110.

              NOTE: MTU designates the frame size. It only  needs
              to be set for Jumbo Frames.

       RxIntDelay

              Valid Range: 0-65535 (0=off)
              Default Value: 0

              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.

              CAUTION:  When  setting RxIntDelay to a value other
              than 0, adapters may hang (stop transmitting) under
              certain network conditions. If this occurs a NETDEV
              WATCHDOG message is logged in the system event log.
              In addition, the controller is automatically reset,
              restoring the network connection. To eliminate  the
              potential  for  the  hang ensure that RxIntDelay is
              set to zero.

       RxAbsIntDelay  (82540,  82545,  and  82546-based  adapters
       only)

              Valid Range: 0-65535 (0=off)
              Default Value: 128

              limits  the  delay in which a transmit interrupt is
              generated (in units of 1.024 microseconds).  Useful
              only  if RxIntDelay is non-zero, this value ensures
              that an interrupt is generated  after  the  initial
              packet  is  received within the set amount of time.
              Proper tuning, along with RxIntDelay,  may  improve
              traffic  throughput in specific network conditions.

       Speed

              Valid Settings: 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.  Duplex  must also be set when
              Speed is set to either 10 or  100.  This  parameter
              only  applies to adapters using copper connections.

              See the section "Speed and Duplex Configuration" in
              Readme.

       TxIntDelay

              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.

       TxAbsIntDelay  (82540,  82545,  and  82546-based  adapters
       only)

              Valid Range: 0-65535 (0=off)
              Default Value: 64

              limits the delay in which a transmit  interrupt  is
              generated  (in units of 1.024 microseconds). Useful
              only if TxIntDelay is non-zero, this value  ensures
              that  an  interrupt  is generated after the initial
              packet is sent on the wire within the set amount of
              time.   Proper  tuning,  along with TxIntDelay, may
              improve traffic throughput in specific network con-
              ditions.

       TxDescriptors

              Valid  Range:  80-256  for  82542  and  82543-based
              adapters, 80-4096  for  82540,  82544,  82545,  and
              82546-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.

       XsumRX

              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
              82542-based adapter.




JUMBO FRAMES
       The  driver  supports Jumbo Frames for all adapters except
       82542-based adapters.  Jumbo Frames support is enabled  by
       changing  the  MTU  to  a value larger than the default of
       1500.  Use the ifconfig command to increase the MTU  size.
       For example:

              ifconfig ethx mtu 9000 up




SUPPORT
       For  additional information, including supported adapters,
       building, and installation, see the Read Me file  included
       with the driver.

       For  general  information, go to the Intel support 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.




                          November 2002                  e1000(1)