Documentation/networking/e100.txt

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