Documentation/networking/e100.txt

   1 Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters
   2 ==============================================================
   3
   4 November 17, 2004
   5
   6
   7 Contents
   8 ========
   9
  10 - In This Release
  11 - Identifying Your Adapter
  12 - Driver Configuration Parameters
  13 - Additional Configurations
  14 - Support
  15
  16
  17 In This Release
  18 ===============
  19
  20 This file describes the Linux* Base Driver for the Intel(R) PRO/100 Family of
  21 Adapters, version 3.3.x.  This driver supports 2.4.x and 2.6.x kernels.
  22
  23 Identifying Your Adapter
  24 ========================
  25
  26 For more information on how to identify your adapter, go to the Adapter &
  27 Driver ID Guide at:
  28
  29   http://support.intel.com/support/network/adapter/pro100/21397.htm
  30
  31 For the latest Intel network drivers for Linux, refer to the following
  32 website. In the search field, enter your adapter name or type, or use the
  33 networking link on the left to search for your adapter:
  34
  35   http://downloadfinder.intel.com/scripts-df/support_intel.asp
  36
  37 Driver Configuration Parameters
  38 ===============================
  39
  40 The default value for each parameter is generally the recommended setting,
  41 unless otherwise noted.
  42
  43 Rx Descriptors: Number of receive descriptors. A receive descriptor is a data
  44    structure that describes a receive buffer and its attributes to the network
  45    controller. The data in the descriptor is used by the controller to write
  46    data from the controller to host memory. In the 3.0.x driver the valid
  47    range for this parameter is 64-256. The default value is 64. This parameter
  48    can be changed using the command
  49
  50    ethtool -G eth? rx n, where n is the number of desired rx descriptors.
  51
  52 Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a
  53    data structure that describes a transmit buffer and its attributes to the
  54    network controller. The data in the descriptor is used by the controller to
  55    read data from the host memory to the controller. In the 3.0.x driver the
  56    valid range for this parameter is 64-256. The default value is 64. This
  57    parameter can be changed using the command
  58
  59    ethtool -G eth? tx n, where n is the number of desired tx descriptors.
  60
  61 Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by
  62    default. Ethtool can be used as follows to force speed/duplex.
  63
  64    ethtool -s eth?  autoneg off speed {10|100} duplex {full|half}
  65
  66    NOTE: setting the speed/duplex to incorrect values will cause the link to
  67    fail.
  68
  69 Event Log Message Level:  The driver uses the message level flag to log events
  70    to syslog. The message level can be set at driver load time. It can also be
  71    set using the command
  72
  73    ethtool -s eth? msglvl n
  74
  75 Additional Configurations
  76 =========================
  77
  78   Configuring the Driver on Different Distributions
  79   -------------------------------------------------
  80
  81   Configuring a network driver to load properly when the system is started is
  82   distribution dependent. Typically, the configuration process involves adding
  83   an alias line to /etc/modules.conf as well as editing other system startup
  84   scripts and/or configuration files.  Many popular Linux distributions ship
  85   with tools to make these changes for you. To learn the proper way to
  86   configure a network device for your system, refer to your distribution
  87   documentation. If during this process you are asked for the driver or module
  88   name, the name for the Linux Base Driver for the Intel PRO/100 Family of
  89   Adapters is e100.
  90
  91   As an example, if you install the e100 driver for two PRO/100 adapters
  92   (eth0 and eth1), add the following to modules.conf:
  93
  94        alias eth0 e100
  95        alias eth1 e100
  96
  97   Viewing Link Messages
  98   ---------------------
  99   In order to see link messages and other Intel driver information on your
 100   console, you must set the dmesg level up to six. This can be done by
 101   entering the following on the command line before loading the e100 driver:
 102
 103        dmesg -n 8
 104
 105   If you wish to see all messages issued by the driver, including debug
 106   messages, set the dmesg level to eight.
 107
 108   NOTE: This setting is not saved across reboots.
 109
 110   Ethtool
 111   -------
 112
 113   The driver utilizes the ethtool interface for driver configuration and
 114   diagnostics, as well as displaying statistical information.  Ethtool
 115   version 1.6 or later is required for this functionality.
 116
 117   The latest release of ethtool can be found at:
 118   http://sf.net/projects/gkernel.
 119
 120   NOTE: This driver uses mii support from the kernel. As a result, when
 121   there is no link, ethtool will report speed/duplex to be 10/half.
 122
 123   NOTE: Ethtool 1.6 only supports a limited set of ethtool options. Support
 124   for a more complete ethtool feature set can be enabled by upgrading
 125   ethtool to ethtool-1.8.1.
 126
 127   Enabling Wake on LAN* (WoL)
 128   ---------------------------
 129   WoL is provided through the Ethtool* utility. Ethtool is included with Red
 130   Hat* 8.0. For other Linux distributions, download and install Ethtool from
 131   the following website: http://sourceforge.net/projects/gkernel.
 132
 133   For instructions on enabling WoL with Ethtool, refer to the Ethtool man
 134   page.
 135
 136   WoL will be enabled on the system during the next shut down or reboot. For
 137   this driver version, in order to enable WoL, the e100 driver must be
 138   loaded when shutting down or rebooting the system.
 139
 140   NAPI
 141   ----
 142
 143   NAPI (Rx polling mode) is supported in the e100 driver.
 144
 145   See www.cyberus.ca/~hadi/usenix-paper.tgz for more information on NAPI.
 146
 147 Support
 148 =======
 149
 150 For general information, go to the Intel support website at:
 151
 152     http://support.intel.com
 153
 154 If an issue is identified with the released source code on the supported
 155 kernel with a supported adapter, email the specific information related to
 156 the issue to linux.nics@intel.com.
 157
 158
 159 License
 160 =======
 161
 162 This software program is released under the terms of a license agreement
 163 between you ('Licensee') and Intel. Do not use or load this software or any
 164 associated materials (collectively, the 'Software') until you have carefully
 165 read the full terms and conditions of the LICENSE located in this software
 166 package. By loading or using the Software, you agree to the terms of this
 167 Agreement. If you do not agree with the terms of this Agreement, do not
 168 install or use the Software.
 169
 170 * Other names and brands may be claimed as the property of others.