Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters |
| 2 | ============================================================== |
| 3 | |
Jeff Kirsher | d7064f4 | 2013-08-23 17:19:23 -0700 | [diff] [blame] | 4 | March 15, 2011 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 5 | |
| 6 | Contents |
| 7 | ======== |
| 8 | |
| 9 | - In This Release |
| 10 | - Identifying Your Adapter |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 11 | - Building and Installation |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 12 | - Driver Configuration Parameters |
| 13 | - Additional Configurations |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 14 | - Known Issues |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 15 | - Support |
| 16 | |
| 17 | |
| 18 | In This Release |
| 19 | =============== |
| 20 | |
| 21 | This file describes the Linux* Base Driver for the Intel(R) PRO/100 Family of |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 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 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 35 | |
| 36 | Identifying Your Adapter |
| 37 | ======================== |
| 38 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 39 | For more information on how to identify your adapter, go to the Adapter & |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 40 | Driver ID Guide at: |
| 41 | |
| 42 | http://support.intel.com/support/network/adapter/pro100/21397.htm |
| 43 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 44 | For the latest Intel network drivers for Linux, refer to the following |
| 45 | website. In the search field, enter your adapter name or type, or use the |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 46 | networking link on the left to search for your adapter: |
| 47 | |
| 48 | http://downloadfinder.intel.com/scripts-df/support_intel.asp |
| 49 | |
| 50 | Driver Configuration Parameters |
| 51 | =============================== |
| 52 | |
| 53 | The default value for each parameter is generally the recommended setting, |
| 54 | unless otherwise noted. |
| 55 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 56 | Rx 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 63 | ethtool -G eth? rx n, where n is the number of desired rx descriptors. |
| 64 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 65 | Tx 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 71 | |
| 72 | ethtool -G eth? tx n, where n is the number of desired tx descriptors. |
| 73 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 74 | Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by |
Jeff Kirsher | 68f20d9 | 2010-12-17 12:14:34 +0000 | [diff] [blame] | 75 | default. The ethtool utility can be used as follows to force speed/duplex. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 76 | |
| 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 Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 82 | Event 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 85 | |
| 86 | ethtool -s eth? msglvl n |
| 87 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 88 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 89 | Additional Configurations |
| 90 | ========================= |
| 91 | |
| 92 | Configuring the Driver on Different Distributions |
| 93 | ------------------------------------------------- |
| 94 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 95 | Configuring a network driver to load properly when the system is started is |
| 96 | distribution dependent. Typically, the configuration process involves adding |
Lucas De Marchi | 970e248 | 2012-03-30 13:37:16 -0700 | [diff] [blame] | 97 | 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 Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 99 | 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 104 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 105 | As an example, if you install the e100 driver for two PRO/100 adapters |
Lucas De Marchi | 970e248 | 2012-03-30 13:37:16 -0700 | [diff] [blame] | 106 | (eth0 and eth1), add the following to a configuraton file in /etc/modprobe.d/ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 107 | |
| 108 | alias eth0 e100 |
| 109 | alias eth1 e100 |
| 110 | |
| 111 | Viewing Link Messages |
| 112 | --------------------- |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 113 | 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | |
| 117 | dmesg -n 8 |
| 118 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 119 | If you wish to see all messages issued by the driver, including debug |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 120 | messages, set the dmesg level to eight. |
| 121 | |
| 122 | NOTE: This setting is not saved across reboots. |
| 123 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 124 | |
Jeff Kirsher | d7064f4 | 2013-08-23 17:19:23 -0700 | [diff] [blame] | 125 | ethtool |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 126 | ------- |
| 127 | |
| 128 | The driver utilizes the ethtool interface for driver configuration and |
Jeff Kirsher | 68f20d9 | 2010-12-17 12:14:34 +0000 | [diff] [blame] | 129 | diagnostics, as well as displaying statistical information. The ethtool |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 | version 1.6 or later is required for this functionality. |
| 131 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 132 | The latest release of ethtool can be found from |
Jeff Kirsher | 68f20d9 | 2010-12-17 12:14:34 +0000 | [diff] [blame] | 133 | http://ftp.kernel.org/pub/software/network/ethtool/ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 134 | |
| 135 | Enabling Wake on LAN* (WoL) |
| 136 | --------------------------- |
Jeff Kirsher | 68f20d9 | 2010-12-17 12:14:34 +0000 | [diff] [blame] | 137 | WoL is provided through the ethtool* utility. For instructions on enabling |
| 138 | WoL with ethtool, refer to the ethtool man page. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 139 | |
| 140 | WoL will be enabled on the system during the next shut down or reboot. For |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 141 | this driver version, in order to enable WoL, the e100 driver must be |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 142 | 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 Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 151 | 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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 170 | Support |
| 171 | ======= |
| 172 | |
| 173 | For general information, go to the Intel support website at: |
| 174 | |
| 175 | http://support.intel.com |
| 176 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 177 | or the Intel Wired Networking project hosted by Sourceforge at: |
| 178 | |
| 179 | http://sourceforge.net/projects/e1000 |
| 180 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 181 | If an issue is identified with the released source code on the supported |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 182 | kernel with a supported adapter, email the specific information related to the |
| 183 | issue to e1000-devel@lists.sourceforge.net. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 184 | |
| 185 | |
| 186 | License |
| 187 | ======= |
| 188 | |
Jesse Brandeburg | 823f8dd | 2006-03-14 15:51:07 -0800 | [diff] [blame] | 189 | This software program is released under the terms of a license agreement |
| 190 | between you ('Licensee') and Intel. Do not use or load this software or any |
| 191 | associated materials (collectively, the 'Software') until you have carefully |
| 192 | read the full terms and conditions of the file COPYING located in this software |
| 193 | package. By loading or using the Software, you agree to the terms of this |
| 194 | Agreement. If you do not agree with the terms of this Agreement, do not install |
| 195 | or use the Software. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 196 | |
| 197 | * Other names and brands may be claimed as the property of others. |