Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 823f8dd1 authored by Jesse Brandeburg's avatar Jesse Brandeburg
Browse files

e100: update e100.txt

parent add18784
Loading
Loading
Loading
Loading
+97 −61
Original line number Original line Diff line number Diff line
Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters
Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters
==============================================================
==============================================================


November 17, 2004
November 15, 2005



Contents
Contents
========
========


- In This Release
- In This Release
- Identifying Your Adapter
- Identifying Your Adapter
- Building and Installation
- Driver Configuration Parameters
- Driver Configuration Parameters
- Additional Configurations
- Additional Configurations
- Known Issues
- Support
- Support




@@ -18,7 +19,19 @@ In This Release
===============
===============


This file describes the Linux* Base Driver for the Intel(R) PRO/100 Family of
This file describes the Linux* Base Driver for the Intel(R) PRO/100 Family of
Adapters, version 3.3.x.  This driver supports 2.4.x and 2.6.x kernels. 
Adapters. This driver includes support for Itanium(R)2-based systems.

For questions related to hardware requirements, refer to the documentation
supplied with your Intel PRO/100 adapter.

The following features are now available in supported kernels:
 - Native VLANs
 - Channel Bonding (teaming)
 - SNMP

Channel Bonding documentation can be found in the Linux kernel source:
/Documentation/networking/bonding.txt



Identifying Your Adapter
Identifying Your Adapter
========================
========================
@@ -43,18 +56,18 @@ unless otherwise noted.
Rx Descriptors: Number of receive descriptors. A receive descriptor is a data
Rx Descriptors: Number of receive descriptors. A receive descriptor is a data
   structure that describes a receive buffer and its attributes to the network
   structure that describes a receive buffer and its attributes to the network
   controller. The data in the descriptor is used by the controller to write
   controller. The data in the descriptor is used by the controller to write
   data from the controller to host memory. In the 3.0.x driver the valid
   data from the controller to host memory. In the 3.x.x driver the valid range
   range for this parameter is 64-256. The default value is 64. This parameter 
   for this parameter is 64-256. The default value is 64. This parameter can be
   can be changed using the command 
   changed using the command:


   ethtool -G eth? rx n, where n is the number of desired rx descriptors.
   ethtool -G eth? rx n, where n is the number of desired rx descriptors.


Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a
Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a data
   data structure that describes a transmit buffer and its attributes to the
   structure that describes a transmit buffer and its attributes to the network
   network controller. The data in the descriptor is used by the controller to 
   controller. The data in the descriptor is used by the controller to read
   read data from the host memory to the controller. In the 3.0.x driver the 
   data from the host memory to the controller. In the 3.x.x driver the valid
   valid range for this parameter is 64-256. The default value is 64. This 
   range for this parameter is 64-256. The default value is 64. This parameter
   parameter can be changed using the command 
   can be changed using the command:


   ethtool -G eth? tx n, where n is the number of desired tx descriptors.
   ethtool -G eth? tx n, where n is the number of desired tx descriptors.


@@ -68,10 +81,11 @@ Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by


Event Log Message Level:  The driver uses the message level flag to log events
Event Log Message Level:  The driver uses the message level flag to log events
   to syslog. The message level can be set at driver load time. It can also be
   to syslog. The message level can be set at driver load time. It can also be
   set using the command
   set using the command:


   ethtool -s eth? msglvl n
   ethtool -s eth? msglvl n



Additional Configurations
Additional Configurations
=========================
=========================


@@ -80,16 +94,16 @@ Additional Configurations


  Configuring a network driver to load properly when the system is started is
  Configuring a network driver to load properly when the system is started is
  distribution dependent. Typically, the configuration process involves adding
  distribution dependent. Typically, the configuration process involves adding
  an alias line to /etc/modules.conf as well as editing other system startup 
  an alias line to /etc/modules.conf or /etc/modprobe.conf as well as editing
  scripts and/or configuration files.  Many popular Linux distributions ship 
  other system startup scripts and/or configuration files.  Many popular Linux
  with tools to make these changes for you. To learn the proper way to 
  distributions ship with tools to make these changes for you. To learn the
  configure a network device for your system, refer to your distribution 
  proper way to configure a network device for your system, refer to your
  documentation. If during this process you are asked for the driver or module 
  distribution documentation.  If during this process you are asked for the
  name, the name for the Linux Base Driver for the Intel PRO/100 Family of 
  driver or module name, the name for the Linux Base Driver for the Intel
  Adapters is e100.
  PRO/100 Family of Adapters is e100.


  As an example, if you install the e100 driver for two PRO/100 adapters
  As an example, if you install the e100 driver for two PRO/100 adapters
  (eth0 and eth1), add the following to modules.conf:
  (eth0 and eth1), add the following to modules.conf or modprobe.conf:


       alias eth0 e100
       alias eth0 e100
       alias eth1 e100
       alias eth1 e100
@@ -107,6 +121,7 @@ Additional Configurations


  NOTE: This setting is not saved across reboots.
  NOTE: This setting is not saved across reboots.



  Ethtool
  Ethtool
  -------
  -------


@@ -114,29 +129,27 @@ Additional Configurations
  diagnostics, as well as displaying statistical information.  Ethtool
  diagnostics, as well as displaying statistical information.  Ethtool
  version 1.6 or later is required for this functionality.
  version 1.6 or later is required for this functionality.


  The latest release of ethtool can be found at:
  The latest release of ethtool can be found from
  http://sf.net/projects/gkernel.  
  http://sourceforge.net/projects/gkernel.

  NOTE: This driver uses mii support from the kernel. As a result, when 
  there is no link, ethtool will report speed/duplex to be 10/half.


  NOTE: Ethtool 1.6 only supports a limited set of ethtool options. Support
  NOTE: Ethtool 1.6 only supports a limited set of ethtool options. Support
  for a more complete ethtool feature set can be enabled by upgrading
  for a more complete ethtool feature set can be enabled by upgrading
  ethtool to ethtool-1.8.1.
  ethtool to ethtool-1.8.1.



  Enabling Wake on LAN* (WoL)
  Enabling Wake on LAN* (WoL)
  ---------------------------
  ---------------------------
  WoL is provided through the Ethtool* utility. Ethtool is included with Red
  WoL is provided through the Ethtool* utility. Ethtool is included with Red
  Hat* 8.0. For other Linux distributions, download and install Ethtool from
  Hat* 8.0. For other Linux distributions, download and install Ethtool from
  the following website: http://sourceforge.net/projects/gkernel.
  the following website: http://sourceforge.net/projects/gkernel.


  For instructions on enabling WoL with Ethtool, refer to the Ethtool man
  For instructions on enabling WoL with Ethtool, refer to the Ethtool man page.
  page.


  WoL will be enabled on the system during the next shut down or reboot. For
  WoL will be enabled on the system during the next shut down or reboot. For
  this driver version, in order to enable WoL, the e100 driver must be
  this driver version, in order to enable WoL, the e100 driver must be
  loaded when shutting down or rebooting the system.
  loaded when shutting down or rebooting the system.



  NAPI
  NAPI
  ----
  ----


@@ -144,6 +157,25 @@ Additional Configurations


  See www.cyberus.ca/~hadi/usenix-paper.tgz for more information on NAPI.
  See www.cyberus.ca/~hadi/usenix-paper.tgz for more information on NAPI.


  Multiple Interfaces on Same Ethernet Broadcast Network
  ------------------------------------------------------

  Due to the default ARP behavior on Linux, it is not possible to have
  one system on two IP networks in the same Ethernet broadcast domain
  (non-partitioned switch) behave as expected. All Ethernet interfaces
  will respond to IP traffic for any IP address assigned to the system.
  This results in unbalanced receive traffic.

  If you have multiple interfaces in a server, either turn on ARP
  filtering by

  (1) entering: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter
      (this only works if your kernel's version is higher than 2.4.5), or

  (2) installing the interfaces in separate broadcast domains (either
      in different switches or in a switch partitioned to VLANs).


Support
Support
=======
=======


@@ -151,9 +183,13 @@ For general information, go to the Intel support website at:


    http://support.intel.com
    http://support.intel.com


    or the Intel Wired Networking project hosted by Sourceforge at:

    http://sourceforge.net/projects/e1000

If an issue is identified with the released source code on the supported
If an issue is identified with the released source code on the supported
kernel with a supported adapter, email the specific information related to 
kernel with a supported adapter, email the specific information related to the
the issue to linux.nics@intel.com.
issue to e1000-devel@lists.sourceforge.net.




License
License
@@ -162,9 +198,9 @@ License
This software program is released under the terms of a license agreement
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
between you ('Licensee') and Intel. Do not use or load this software or any
associated materials (collectively, the 'Software') until you have carefully
associated materials (collectively, the 'Software') until you have carefully
read the full terms and conditions of the LICENSE located in this software 
read the full terms and conditions of the file COPYING located in this software
package. By loading or using the Software, you agree to the terms of this
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 
Agreement. If you do not agree with the terms of this Agreement, do not install
install or use the Software.
or use the Software.


* Other names and brands may be claimed as the property of others.
* Other names and brands may be claimed as the property of others.