Blame view

Documentation/networking/e100.txt 6.99 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
  Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters
  ==============================================================
823f8dd17   Jesse Brandeburg   e100: update e100...
3
  November 15, 2005
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
4
5
6
7
8
9
  
  Contents
  ========
  
  - In This Release
  - Identifying Your Adapter
823f8dd17   Jesse Brandeburg   e100: update e100...
10
  - Building and Installation
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
11
12
  - Driver Configuration Parameters
  - Additional Configurations
823f8dd17   Jesse Brandeburg   e100: update e100...
13
  - Known Issues
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
14
15
16
17
18
19
20
  - Support
  
  
  In This Release
  ===============
  
  This file describes the Linux* Base Driver for the Intel(R) PRO/100 Family of
823f8dd17   Jesse Brandeburg   e100: update e100...
21
22
23
24
25
26
27
28
29
30
31
32
  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
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
33
34
35
  
  Identifying Your Adapter
  ========================
823f8dd17   Jesse Brandeburg   e100: update e100...
36
  For more information on how to identify your adapter, go to the Adapter &
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
37
38
39
  Driver ID Guide at:
  
    http://support.intel.com/support/network/adapter/pro100/21397.htm
823f8dd17   Jesse Brandeburg   e100: update e100...
40
41
  For the latest Intel network drivers for Linux, refer to the following
  website. In the search field, enter your adapter name or type, or use the
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
42
43
44
45
46
47
48
49
50
  networking link on the left to search for your adapter:
  
    http://downloadfinder.intel.com/scripts-df/support_intel.asp
  
  Driver Configuration Parameters
  ===============================
  
  The default value for each parameter is generally the recommended setting,
  unless otherwise noted.
823f8dd17   Jesse Brandeburg   e100: update e100...
51
52
53
54
55
56
  Rx Descriptors: Number of receive descriptors. A receive descriptor is a data
     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
     data from the controller to host memory. In the 3.x.x driver the valid range
     for this parameter is 64-256. The default value is 64. This parameter can be
     changed using the command:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
57
     ethtool -G eth? rx n, where n is the number of desired rx descriptors.
823f8dd17   Jesse Brandeburg   e100: update e100...
58
59
60
61
62
63
  Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a data
     structure that describes a transmit buffer and its attributes to the network
     controller. The data in the descriptor is used by the controller to read
     data from the host memory to the controller. In the 3.x.x driver the valid
     range for this parameter is 64-256. The default value is 64. This parameter
     can be changed using the command:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
64
65
  
     ethtool -G eth? tx n, where n is the number of desired tx descriptors.
823f8dd17   Jesse Brandeburg   e100: update e100...
66
  Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by
68f20d948   Jeff Kirsher   Documentation/net...
67
     default. The ethtool utility can be used as follows to force speed/duplex.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
68
69
70
71
72
  
     ethtool -s eth?  autoneg off speed {10|100} duplex {full|half}
  
     NOTE: setting the speed/duplex to incorrect values will cause the link to
     fail.
823f8dd17   Jesse Brandeburg   e100: update e100...
73
74
75
  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
     set using the command:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
76
77
  
     ethtool -s eth? msglvl n
823f8dd17   Jesse Brandeburg   e100: update e100...
78

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
79
80
81
82
83
  Additional Configurations
  =========================
  
    Configuring the Driver on Different Distributions
    -------------------------------------------------
823f8dd17   Jesse Brandeburg   e100: update e100...
84
85
86
87
88
89
90
91
92
    Configuring a network driver to load properly when the system is started is
    distribution dependent. Typically, the configuration process involves adding
    an alias line to /etc/modules.conf or /etc/modprobe.conf as well as editing
    other system startup scripts and/or configuration files.  Many popular Linux
    distributions ship with tools to make these changes for you. To learn the
    proper way to configure a network device for your system, refer to your
    distribution documentation.  If during this process you are asked for the
    driver or module name, the name for the Linux Base Driver for the Intel
    PRO/100 Family of Adapters is e100.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
93

823f8dd17   Jesse Brandeburg   e100: update e100...
94
95
    As an example, if you install the e100 driver for two PRO/100 adapters
    (eth0 and eth1), add the following to modules.conf or modprobe.conf:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
96
97
98
99
100
101
  
         alias eth0 e100
         alias eth1 e100
  
    Viewing Link Messages
    ---------------------
823f8dd17   Jesse Brandeburg   e100: update e100...
102
103
104
    In order to see link messages and other Intel driver information on your
    console, you must set the dmesg level up to six. This can be done by
    entering the following on the command line before loading the e100 driver:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
105
106
  
         dmesg -n 8
823f8dd17   Jesse Brandeburg   e100: update e100...
107
    If you wish to see all messages issued by the driver, including debug
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
108
109
110
    messages, set the dmesg level to eight.
  
    NOTE: This setting is not saved across reboots.
823f8dd17   Jesse Brandeburg   e100: update e100...
111

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
112
113
114
115
    Ethtool
    -------
  
    The driver utilizes the ethtool interface for driver configuration and
68f20d948   Jeff Kirsher   Documentation/net...
116
    diagnostics, as well as displaying statistical information.  The ethtool
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
117
    version 1.6 or later is required for this functionality.
823f8dd17   Jesse Brandeburg   e100: update e100...
118
    The latest release of ethtool can be found from
68f20d948   Jeff Kirsher   Documentation/net...
119
    http://ftp.kernel.org/pub/software/network/ethtool/
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
120
121
122
  
    Enabling Wake on LAN* (WoL)
    ---------------------------
68f20d948   Jeff Kirsher   Documentation/net...
123
124
    WoL is provided through the ethtool* utility.  For instructions on enabling
    WoL with ethtool, refer to the ethtool man page.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
125
126
  
    WoL will be enabled on the system during the next shut down or reboot. For
823f8dd17   Jesse Brandeburg   e100: update e100...
127
    this driver version, in order to enable WoL, the e100 driver must be
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
128
129
130
131
132
133
134
135
    loaded when shutting down or rebooting the system.
  
    NAPI
    ----
  
    NAPI (Rx polling mode) is supported in the e100 driver.
  
    See www.cyberus.ca/~hadi/usenix-paper.tgz for more information on NAPI.
823f8dd17   Jesse Brandeburg   e100: update e100...
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
    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).
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
153
154
155
156
157
158
  Support
  =======
  
  For general information, go to the Intel support website at:
  
      http://support.intel.com
823f8dd17   Jesse Brandeburg   e100: update e100...
159
160
161
      or the Intel Wired Networking project hosted by Sourceforge at:
  
      http://sourceforge.net/projects/e1000
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
162
  If an issue is identified with the released source code on the supported
823f8dd17   Jesse Brandeburg   e100: update e100...
163
164
  kernel with a supported adapter, email the specific information related to the
  issue to e1000-devel@lists.sourceforge.net.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
165
166
167
168
  
  
  License
  =======
823f8dd17   Jesse Brandeburg   e100: update e100...
169
170
171
172
173
174
175
  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
  associated materials (collectively, the 'Software') until you have carefully
  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
  Agreement. If you do not agree with the terms of this Agreement, do not install
  or use the Software.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
176
177
  
  * Other names and brands may be claimed as the property of others.