blob: fcb6c71cdb69e7c0e643abb8124309adf4061b24 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters
2==============================================================
3
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -08004November 15, 2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07005
6Contents
7========
8
9- In This Release
10- Identifying Your Adapter
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080011- Building and Installation
Linus Torvalds1da177e2005-04-16 15:20:36 -070012- Driver Configuration Parameters
13- Additional Configurations
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080014- Known Issues
Linus Torvalds1da177e2005-04-16 15:20:36 -070015- Support
16
17
18In This Release
19===============
20
21This file describes the Linux* Base Driver for the Intel(R) PRO/100 Family of
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080022Adapters. This driver includes support for Itanium(R)2-based systems.
23
24For questions related to hardware requirements, refer to the documentation
25supplied with your Intel PRO/100 adapter.
26
27The following features are now available in supported kernels:
28 - Native VLANs
29 - Channel Bonding (teaming)
30 - SNMP
31
32Channel Bonding documentation can be found in the Linux kernel source:
33/Documentation/networking/bonding.txt
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
36Identifying Your Adapter
37========================
38
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080039For more information on how to identify your adapter, go to the Adapter &
Linus Torvalds1da177e2005-04-16 15:20:36 -070040Driver ID Guide at:
41
42 http://support.intel.com/support/network/adapter/pro100/21397.htm
43
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080044For the latest Intel network drivers for Linux, refer to the following
45website. In the search field, enter your adapter name or type, or use the
Linus Torvalds1da177e2005-04-16 15:20:36 -070046networking link on the left to search for your adapter:
47
48 http://downloadfinder.intel.com/scripts-df/support_intel.asp
49
50Driver Configuration Parameters
51===============================
52
53The default value for each parameter is generally the recommended setting,
54unless otherwise noted.
55
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080056Rx Descriptors: Number of receive descriptors. A receive descriptor is a data
57 structure that describes a receive buffer and its attributes to the network
58 controller. The data in the descriptor is used by the controller to write
59 data from the controller to host memory. In the 3.x.x driver the valid range
60 for this parameter is 64-256. The default value is 64. This parameter can be
61 changed using the command:
62
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 ethtool -G eth? rx n, where n is the number of desired rx descriptors.
64
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080065Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a data
66 structure that describes a transmit buffer and its attributes to the network
67 controller. The data in the descriptor is used by the controller to read
68 data from the host memory to the controller. In the 3.x.x driver the valid
69 range for this parameter is 64-256. The default value is 64. This parameter
70 can be changed using the command:
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
72 ethtool -G eth? tx n, where n is the number of desired tx descriptors.
73
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080074Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by
Jeff Kirsher68f20d92010-12-17 12:14:34 +000075 default. The ethtool utility can be used as follows to force speed/duplex.
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77 ethtool -s eth? autoneg off speed {10|100} duplex {full|half}
78
79 NOTE: setting the speed/duplex to incorrect values will cause the link to
80 fail.
81
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080082Event Log Message Level: The driver uses the message level flag to log events
83 to syslog. The message level can be set at driver load time. It can also be
84 set using the command:
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86 ethtool -s eth? msglvl n
87
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080088
Linus Torvalds1da177e2005-04-16 15:20:36 -070089Additional Configurations
90=========================
91
92 Configuring the Driver on Different Distributions
93 -------------------------------------------------
94
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080095 Configuring a network driver to load properly when the system is started is
96 distribution dependent. Typically, the configuration process involves adding
Lucas De Marchi970e2482012-03-30 13:37:16 -070097 an alias line to /etc/modprobe.d/*.conf as well as editing other system
98 startup scripts and/or configuration files. Many popular Linux
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -080099 distributions ship with tools to make these changes for you. To learn the
100 proper way to configure a network device for your system, refer to your
101 distribution documentation. If during this process you are asked for the
102 driver or module name, the name for the Linux Base Driver for the Intel
103 PRO/100 Family of Adapters is e100.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -0800105 As an example, if you install the e100 driver for two PRO/100 adapters
Lucas De Marchi970e2482012-03-30 13:37:16 -0700106 (eth0 and eth1), add the following to a configuraton file in /etc/modprobe.d/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108 alias eth0 e100
109 alias eth1 e100
110
111 Viewing Link Messages
112 ---------------------
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -0800113 In order to see link messages and other Intel driver information on your
114 console, you must set the dmesg level up to six. This can be done by
115 entering the following on the command line before loading the e100 driver:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
117 dmesg -n 8
118
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -0800119 If you wish to see all messages issued by the driver, including debug
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 messages, set the dmesg level to eight.
121
122 NOTE: This setting is not saved across reboots.
123
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -0800124
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 Ethtool
126 -------
127
128 The driver utilizes the ethtool interface for driver configuration and
Jeff Kirsher68f20d92010-12-17 12:14:34 +0000129 diagnostics, as well as displaying statistical information. The ethtool
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130 version 1.6 or later is required for this functionality.
131
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -0800132 The latest release of ethtool can be found from
Jeff Kirsher68f20d92010-12-17 12:14:34 +0000133 http://ftp.kernel.org/pub/software/network/ethtool/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134
135 Enabling Wake on LAN* (WoL)
136 ---------------------------
Jeff Kirsher68f20d92010-12-17 12:14:34 +0000137 WoL is provided through the ethtool* utility. For instructions on enabling
138 WoL with ethtool, refer to the ethtool man page.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140 WoL will be enabled on the system during the next shut down or reboot. For
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -0800141 this driver version, in order to enable WoL, the e100 driver must be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 loaded when shutting down or rebooting the system.
143
144 NAPI
145 ----
146
147 NAPI (Rx polling mode) is supported in the e100 driver.
148
149 See www.cyberus.ca/~hadi/usenix-paper.tgz for more information on NAPI.
150
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -0800151 Multiple Interfaces on Same Ethernet Broadcast Network
152 ------------------------------------------------------
153
154 Due to the default ARP behavior on Linux, it is not possible to have
155 one system on two IP networks in the same Ethernet broadcast domain
156 (non-partitioned switch) behave as expected. All Ethernet interfaces
157 will respond to IP traffic for any IP address assigned to the system.
158 This results in unbalanced receive traffic.
159
160 If you have multiple interfaces in a server, either turn on ARP
161 filtering by
162
163 (1) entering: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter
164 (this only works if your kernel's version is higher than 2.4.5), or
165
166 (2) installing the interfaces in separate broadcast domains (either
167 in different switches or in a switch partitioned to VLANs).
168
169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170Support
171=======
172
173For general information, go to the Intel support website at:
174
175 http://support.intel.com
176
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -0800177 or the Intel Wired Networking project hosted by Sourceforge at:
178
179 http://sourceforge.net/projects/e1000
180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181If an issue is identified with the released source code on the supported
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -0800182kernel with a supported adapter, email the specific information related to the
183issue to e1000-devel@lists.sourceforge.net.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
185
186License
187=======
188
Jesse Brandeburg823f8dd2006-03-14 15:51:07 -0800189This software program is released under the terms of a license agreement
190between you ('Licensee') and Intel. Do not use or load this software or any
191associated materials (collectively, the 'Software') until you have carefully
192read the full terms and conditions of the file COPYING located in this software
193package. By loading or using the Software, you agree to the terms of this
194Agreement. If you do not agree with the terms of this Agreement, do not install
195or use the Software.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
197* Other names and brands may be claimed as the property of others.