diff options
Diffstat (limited to 'Documentation/networking/e100.txt')
-rw-r--r-- | Documentation/networking/e100.txt | 158 |
1 files changed, 97 insertions, 61 deletions
diff --git a/Documentation/networking/e100.txt b/Documentation/networking/e100.txt index 4ef9f7cd5dc3..944aa55e79f8 100644 --- a/Documentation/networking/e100.txt +++ b/Documentation/networking/e100.txt | |||
@@ -1,16 +1,17 @@ | |||
1 | Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters | 1 | Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters |
2 | ============================================================== | 2 | ============================================================== |
3 | 3 | ||
4 | November 17, 2004 | 4 | November 15, 2005 |
5 | |||
6 | 5 | ||
7 | Contents | 6 | Contents |
8 | ======== | 7 | ======== |
9 | 8 | ||
10 | - In This Release | 9 | - In This Release |
11 | - Identifying Your Adapter | 10 | - Identifying Your Adapter |
11 | - Building and Installation | ||
12 | - Driver Configuration Parameters | 12 | - Driver Configuration Parameters |
13 | - Additional Configurations | 13 | - Additional Configurations |
14 | - Known Issues | ||
14 | - Support | 15 | - Support |
15 | 16 | ||
16 | 17 | ||
@@ -18,18 +19,30 @@ In This Release | |||
18 | =============== | 19 | =============== |
19 | 20 | ||
20 | This file describes the Linux* Base Driver for the Intel(R) PRO/100 Family of | 21 | 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 | Adapters. This driver includes support for Itanium(R)2-based systems. |
23 | |||
24 | For questions related to hardware requirements, refer to the documentation | ||
25 | supplied with your Intel PRO/100 adapter. | ||
26 | |||
27 | The following features are now available in supported kernels: | ||
28 | - Native VLANs | ||
29 | - Channel Bonding (teaming) | ||
30 | - SNMP | ||
31 | |||
32 | Channel Bonding documentation can be found in the Linux kernel source: | ||
33 | /Documentation/networking/bonding.txt | ||
34 | |||
22 | 35 | ||
23 | Identifying Your Adapter | 36 | Identifying Your Adapter |
24 | ======================== | 37 | ======================== |
25 | 38 | ||
26 | For more information on how to identify your adapter, go to the Adapter & | 39 | For more information on how to identify your adapter, go to the Adapter & |
27 | Driver ID Guide at: | 40 | Driver ID Guide at: |
28 | 41 | ||
29 | http://support.intel.com/support/network/adapter/pro100/21397.htm | 42 | http://support.intel.com/support/network/adapter/pro100/21397.htm |
30 | 43 | ||
31 | For the latest Intel network drivers for Linux, refer to the following | 44 | 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 | 45 | 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: | 46 | networking link on the left to search for your adapter: |
34 | 47 | ||
35 | http://downloadfinder.intel.com/scripts-df/support_intel.asp | 48 | http://downloadfinder.intel.com/scripts-df/support_intel.asp |
@@ -40,73 +53,75 @@ Driver Configuration Parameters | |||
40 | The default value for each parameter is generally the recommended setting, | 53 | The default value for each parameter is generally the recommended setting, |
41 | unless otherwise noted. | 54 | unless otherwise noted. |
42 | 55 | ||
43 | Rx Descriptors: Number of receive descriptors. A receive descriptor is a data | 56 | 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 | 57 | 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 | 58 | 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 | 59 | data from the controller to host memory. In the 3.x.x driver the valid range |
47 | range for this parameter is 64-256. The default value is 64. This parameter | 60 | for this parameter is 64-256. The default value is 64. This parameter can be |
48 | can be changed using the command | 61 | changed using the command: |
49 | 62 | ||
50 | ethtool -G eth? rx n, where n is the number of desired rx descriptors. | 63 | ethtool -G eth? rx n, where n is the number of desired rx descriptors. |
51 | 64 | ||
52 | Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a | 65 | Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a data |
53 | data structure that describes a transmit buffer and its attributes to the | 66 | structure that describes a transmit buffer and its attributes to the network |
54 | network controller. The data in the descriptor is used by the controller to | 67 | controller. The data in the descriptor is used by the controller to read |
55 | read data from the host memory to the controller. In the 3.0.x driver the | 68 | data from the host memory to the controller. In the 3.x.x driver the valid |
56 | valid range for this parameter is 64-256. The default value is 64. This | 69 | range for this parameter is 64-256. The default value is 64. This parameter |
57 | parameter can be changed using the command | 70 | can be changed using the command: |
58 | 71 | ||
59 | ethtool -G eth? tx n, where n is the number of desired tx descriptors. | 72 | ethtool -G eth? tx n, where n is the number of desired tx descriptors. |
60 | 73 | ||
61 | Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by | 74 | 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. | 75 | default. Ethtool can be used as follows to force speed/duplex. |
63 | 76 | ||
64 | ethtool -s eth? autoneg off speed {10|100} duplex {full|half} | 77 | ethtool -s eth? autoneg off speed {10|100} duplex {full|half} |
65 | 78 | ||
66 | NOTE: setting the speed/duplex to incorrect values will cause the link to | 79 | NOTE: setting the speed/duplex to incorrect values will cause the link to |
67 | fail. | 80 | fail. |
68 | 81 | ||
69 | Event Log Message Level: The driver uses the message level flag to log events | 82 | 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 | 83 | to syslog. The message level can be set at driver load time. It can also be |
71 | set using the command | 84 | set using the command: |
72 | 85 | ||
73 | ethtool -s eth? msglvl n | 86 | ethtool -s eth? msglvl n |
74 | 87 | ||
88 | |||
75 | Additional Configurations | 89 | Additional Configurations |
76 | ========================= | 90 | ========================= |
77 | 91 | ||
78 | Configuring the Driver on Different Distributions | 92 | Configuring the Driver on Different Distributions |
79 | ------------------------------------------------- | 93 | ------------------------------------------------- |
80 | 94 | ||
81 | Configuring a network driver to load properly when the system is started is | 95 | Configuring a network driver to load properly when the system is started is |
82 | distribution dependent. Typically, the configuration process involves adding | 96 | distribution dependent. Typically, the configuration process involves adding |
83 | an alias line to /etc/modules.conf as well as editing other system startup | 97 | an alias line to /etc/modules.conf or /etc/modprobe.conf as well as editing |
84 | scripts and/or configuration files. Many popular Linux distributions ship | 98 | other system startup scripts and/or configuration files. Many popular Linux |
85 | with tools to make these changes for you. To learn the proper way to | 99 | distributions ship with tools to make these changes for you. To learn the |
86 | configure a network device for your system, refer to your distribution | 100 | proper way to configure a network device for your system, refer to your |
87 | documentation. If during this process you are asked for the driver or module | 101 | distribution documentation. If during this process you are asked for the |
88 | name, the name for the Linux Base Driver for the Intel PRO/100 Family of | 102 | driver or module name, the name for the Linux Base Driver for the Intel |
89 | Adapters is e100. | 103 | PRO/100 Family of Adapters is e100. |
90 | 104 | ||
91 | As an example, if you install the e100 driver for two PRO/100 adapters | 105 | As an example, if you install the e100 driver for two PRO/100 adapters |
92 | (eth0 and eth1), add the following to modules.conf: | 106 | (eth0 and eth1), add the following to modules.conf or modprobe.conf: |
93 | 107 | ||
94 | alias eth0 e100 | 108 | alias eth0 e100 |
95 | alias eth1 e100 | 109 | alias eth1 e100 |
96 | 110 | ||
97 | Viewing Link Messages | 111 | Viewing Link Messages |
98 | --------------------- | 112 | --------------------- |
99 | In order to see link messages and other Intel driver information on your | 113 | 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 | 114 | 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: | 115 | entering the following on the command line before loading the e100 driver: |
102 | 116 | ||
103 | dmesg -n 8 | 117 | dmesg -n 8 |
104 | 118 | ||
105 | If you wish to see all messages issued by the driver, including debug | 119 | If you wish to see all messages issued by the driver, including debug |
106 | messages, set the dmesg level to eight. | 120 | messages, set the dmesg level to eight. |
107 | 121 | ||
108 | NOTE: This setting is not saved across reboots. | 122 | NOTE: This setting is not saved across reboots. |
109 | 123 | ||
124 | |||
110 | Ethtool | 125 | Ethtool |
111 | ------- | 126 | ------- |
112 | 127 | ||
@@ -114,29 +129,27 @@ Additional Configurations | |||
114 | diagnostics, as well as displaying statistical information. Ethtool | 129 | diagnostics, as well as displaying statistical information. Ethtool |
115 | version 1.6 or later is required for this functionality. | 130 | version 1.6 or later is required for this functionality. |
116 | 131 | ||
117 | The latest release of ethtool can be found at: | 132 | The latest release of ethtool can be found from |
118 | http://sf.net/projects/gkernel. | 133 | http://sourceforge.net/projects/gkernel. |
119 | 134 | ||
120 | NOTE: This driver uses mii support from the kernel. As a result, when | 135 | NOTE: Ethtool 1.6 only supports a limited set of ethtool options. Support |
121 | there is no link, ethtool will report speed/duplex to be 10/half. | 136 | for a more complete ethtool feature set can be enabled by upgrading |
137 | ethtool to ethtool-1.8.1. | ||
122 | 138 | ||
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 | 139 | ||
127 | Enabling Wake on LAN* (WoL) | 140 | Enabling Wake on LAN* (WoL) |
128 | --------------------------- | 141 | --------------------------- |
129 | WoL is provided through the Ethtool* utility. Ethtool is included with Red | 142 | 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 | 143 | Hat* 8.0. For other Linux distributions, download and install Ethtool from |
131 | the following website: http://sourceforge.net/projects/gkernel. | 144 | the following website: http://sourceforge.net/projects/gkernel. |
132 | 145 | ||
133 | For instructions on enabling WoL with Ethtool, refer to the Ethtool man | 146 | For instructions on enabling WoL with Ethtool, refer to the Ethtool man page. |
134 | page. | ||
135 | 147 | ||
136 | WoL will be enabled on the system during the next shut down or reboot. For | 148 | 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 | 149 | this driver version, in order to enable WoL, the e100 driver must be |
138 | loaded when shutting down or rebooting the system. | 150 | loaded when shutting down or rebooting the system. |
139 | 151 | ||
152 | |||
140 | NAPI | 153 | NAPI |
141 | ---- | 154 | ---- |
142 | 155 | ||
@@ -144,6 +157,25 @@ Additional Configurations | |||
144 | 157 | ||
145 | See www.cyberus.ca/~hadi/usenix-paper.tgz for more information on NAPI. | 158 | See www.cyberus.ca/~hadi/usenix-paper.tgz for more information on NAPI. |
146 | 159 | ||
160 | Multiple Interfaces on Same Ethernet Broadcast Network | ||
161 | ------------------------------------------------------ | ||
162 | |||
163 | Due to the default ARP behavior on Linux, it is not possible to have | ||
164 | one system on two IP networks in the same Ethernet broadcast domain | ||
165 | (non-partitioned switch) behave as expected. All Ethernet interfaces | ||
166 | will respond to IP traffic for any IP address assigned to the system. | ||
167 | This results in unbalanced receive traffic. | ||
168 | |||
169 | If you have multiple interfaces in a server, either turn on ARP | ||
170 | filtering by | ||
171 | |||
172 | (1) entering: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter | ||
173 | (this only works if your kernel's version is higher than 2.4.5), or | ||
174 | |||
175 | (2) installing the interfaces in separate broadcast domains (either | ||
176 | in different switches or in a switch partitioned to VLANs). | ||
177 | |||
178 | |||
147 | Support | 179 | Support |
148 | ======= | 180 | ======= |
149 | 181 | ||
@@ -151,20 +183,24 @@ For general information, go to the Intel support website at: | |||
151 | 183 | ||
152 | http://support.intel.com | 184 | http://support.intel.com |
153 | 185 | ||
186 | or the Intel Wired Networking project hosted by Sourceforge at: | ||
187 | |||
188 | http://sourceforge.net/projects/e1000 | ||
189 | |||
154 | If an issue is identified with the released source code on the supported | 190 | 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 | 191 | kernel with a supported adapter, email the specific information related to the |
156 | the issue to linux.nics@intel.com. | 192 | issue to e1000-devel@lists.sourceforge.net. |
157 | 193 | ||
158 | 194 | ||
159 | License | 195 | License |
160 | ======= | 196 | ======= |
161 | 197 | ||
162 | This software program is released under the terms of a license agreement | 198 | 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 | 199 | between you ('Licensee') and Intel. Do not use or load this software or any |
164 | associated materials (collectively, the 'Software') until you have carefully | 200 | associated materials (collectively, the 'Software') until you have carefully |
165 | read the full terms and conditions of the LICENSE located in this software | 201 | read the full terms and conditions of the file COPYING located in this software |
166 | package. By loading or using the Software, you agree to the terms of this | 202 | 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 | 203 | Agreement. If you do not agree with the terms of this Agreement, do not install |
168 | install or use the Software. | 204 | or use the Software. |
169 | 205 | ||
170 | * Other names and brands may be claimed as the property of others. | 206 | * Other names and brands may be claimed as the property of others. |