readme

COPE the first practical network coding scheme which is developped on click

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

August 6, 2002


Contents
========

- In This Release
- Supported Adapters
- Building and Installation
- Command Line Parameters
- Speed and Duplex Configuration
- Additional Configurations
- Known Issues
- Troubleshooting
- Support


In This Release
===============

This file describes the Linux* Base Driver for the Intel(R) PRO/1000 Family 
of Adapters, version 4.3.15. 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.18. Intel focused testing on Intel architectures 
running the 2.4.18 kernel. This driver includes support for Itanium(TM)-based 
systems.

NOTE: This driver version contains the final development set for 2.2.x 
      kernels through 2.2.20. Development will continue for 2.4.x kernels and
      future production kernels.

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.

This release version includes the following:

   - Hooks for Intel ANS, the Intel Advanced Network Services driver. Some
     base driver versions within specific distributions, including Red Hat*, 
     do not include these hooks.

   - Support for the ethtool 1.5 interface. A third-party application can use 
     the ethtool interface to get and set driver parameters.

   - Zero copy. This feature provides faster data throughput. Enabled by 
     default in supporting kernels. It is not supported on the Intel(R) 
     PRO/1000 Gigabit Server Adapter.

   - Wake on LAN* support via ethtool for 82540, 82544, 82545, and 82546-
     based adapters

   - Adaptive IFS for increased performance at half duplex



Supported Adapters
==================

The following Intel network adapters are compatible with the drivers in this 
release:

   Controller  Adapter Name                         Board IDs
   ----------  ------------                         ---------

   82542       PRO/1000 Gigabit Server Adapter      700262-xxx, 717037-xxx

   82543       PRO/1000 F Server Adapter            738640-xxx, A38888-xxx

   82543       PRO/1000 T Server Adapter            A19845-xxx, A33948-xxx

   82544       PRO/1000 XT Server Adapter           A51580-xxx

   82544       PRO/1000 XF Server Adapter           A50484-xxx

   82544       PRO/1000 T Desktop Adapter           A62947-xxx

   82540       PRO/1000 MT Desktop Adapter          A78408-xxx

   82545       PRO/1000 MT Server Adapter           A92165-xxx

   82546       PRO/1000 MT Dual Port Server Adapter A92111-xxx

   82545       PRO/1000 MF Server Adapter           A91622-xxx

   82545       PRO/1000 MF Server Adapter(LX)       A91624-xxx

   82546       PRO/1000 MF Dual Port Server Adapter A91620-xxx


To verify your Intel adapter is supported, find the board ID number on the 
adapter. Look for a label that has a barcode and a number in the format of 
123456-001 (six digits hyphen three digits). Match this to the list of 
numbers above.

For more information on how to identify your adapter, go to the Adapter & 
Driver ID Guide at:

    http://support.intel.com/support/network/adapter/pro100/21397.htm

For the latest Intel network drivers for Linux, go to:

    http://downloadfinder.intel.com/scripts-df/support_intel.asp


Building and Installation
=========================

To build a binary RPM* package of this driver, run 'rpm -tb <filename.tar.gz>'. 
Replace <filename.tar.gz> with the specific filename of the driver.

NOTE: For the build to work properly, the currently running kernel MUST match 
      the version and configuration of the installed kernel sources. If you 
      have just recompiled the kernel reboot the system now.

1. Move the base driver tar file to the directory of your choice. For example,
   use /home/username/e1000 or /usr/local/src/e1000.

2. Untar/unzip archive:

     tar zxf e1000-x.x.x.tar.gz

3. Change to the driver src directory:

     cd e1000-x.x.x/src/

4. Compile the driver module:

     make install

   The binary will be installed as:
     For Linux 2.2.x systems:
        /lib/modules/[KERNEL_VERSION]/net/e1000.o
     For Linux 2.4.x systems:
        /lib/modules/[KERNEL_VERSION]/kernel/drivers/net/e1000.o

   The install locations listed above are the default locations. They may 
   not be correct for certain Linux distributions. For more information, 
   see the ldistrib.txt file included in the driver tar.

5. Install the module:

     insmod e1000 <parameter>=<value>

6. Assign an IP address to the interface by entering the following, where
   x is interface number:

     ifconfig ethx <IP_address>

7. Verify that the interface works. Enter the following, where <IP_address>
   is the IP address for another machine on the same subnet as the interface 
   that is being tested:

     ping  <IP_address>	


Command Line Parameters
=======================

The following optional 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:

    insmod e1000 TxDescriptors=80,128

loads the e1000 driver with 80 TX resources for the first adapter and 128 TX 
resources for the second adapter.

For more information about the AutoNeg, Duplex, and Speed parameters, see the
"Speed and Duplex Configuration" section in this document.


AutoNeg (adapters using copper connections only)
Valid Range: 0x01-0x0F, 0x20-0x2F
Default Value: 0x2F
    This parameter is a bit mask that specifies which speed and duplex
    settings the board advertises. When this parameter is used, the Speed and
    Duplex parameters must not be specified.  

Duplex (adapters using copper connections only)
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-
    negotiate, the board auto-detects the correct duplex. If the link partner
    is forced (either full or half), Duplex defaults to half-duplex.

FlowControl
Valid Range: 0-3 (0=none, 1=Rx only, 2=Tx only, 3=Rx&Tx)
Default: Read flow control settings from the EEPROM
    This parameter controls the automatic generation(Tx) and response(Rx) to 
    Ethernet PAUSE frames.

RxDescriptors
Valid Range: 80-256 for 82542 and 82543-based adapters
             80-4096 for 82540, 82544, 82545, and 82546-based adapters
Default Value: 80
    This value is the number of receive descriptors allocated by the driver. 
    Increasing this value allows the driver to buffer more incoming packets.