0001 .. SPDX-License-Identifier: GPL-2.0+
0002
0003 =============================================================
0004 Linux Base Driver for the Intel(R) PRO/100 Family of Adapters
0005 =============================================================
0006
0007 June 1, 2018
0008
0009 Contents
0010 ========
0011
0012 - In This Release
0013 - Identifying Your Adapter
0014 - Building and Installation
0015 - Driver Configuration Parameters
0016 - Additional Configurations
0017 - Known Issues
0018 - Support
0019
0020
0021 In This Release
0022 ===============
0023
0024 This file describes the Linux Base Driver for the Intel(R) PRO/100 Family of
0025 Adapters. This driver includes support for Itanium(R)2-based systems.
0026
0027 For questions related to hardware requirements, refer to the documentation
0028 supplied with your Intel PRO/100 adapter.
0029
0030 The following features are now available in supported kernels:
0031 - Native VLANs
0032 - Channel Bonding (teaming)
0033 - SNMP
0034
0035 Channel Bonding documentation can be found in the Linux kernel source:
0036 /Documentation/networking/bonding.rst
0037
0038
0039 Identifying Your Adapter
0040 ========================
0041
0042 For information on how to identify your adapter, and for the latest Intel
0043 network drivers, refer to the Intel Support website:
0044 https://www.intel.com/support
0045
0046 Driver Configuration Parameters
0047 ===============================
0048
0049 The default value for each parameter is generally the recommended setting,
0050 unless otherwise noted.
0051
0052 Rx Descriptors:
0053 Number of receive descriptors. A receive descriptor is a data
0054 structure that describes a receive buffer and its attributes to the network
0055 controller. The data in the descriptor is used by the controller to write
0056 data from the controller to host memory. In the 3.x.x driver the valid range
0057 for this parameter is 64-256. The default value is 256. This parameter can be
0058 changed using the command::
0059
0060 ethtool -G eth? rx n
0061
0062 Where n is the number of desired Rx descriptors.
0063
0064 Tx Descriptors:
0065 Number of transmit descriptors. A transmit descriptor is a data
0066 structure that describes a transmit buffer and its attributes to the network
0067 controller. The data in the descriptor is used by the controller to read
0068 data from the host memory to the controller. In the 3.x.x driver the valid
0069 range for this parameter is 64-256. The default value is 128. This parameter
0070 can be changed using the command::
0071
0072 ethtool -G eth? tx n
0073
0074 Where n is the number of desired Tx descriptors.
0075
0076 Speed/Duplex:
0077 The driver auto-negotiates the link speed and duplex settings by
0078 default. The ethtool utility can be used as follows to force speed/duplex.::
0079
0080 ethtool -s eth? autoneg off speed {10|100} duplex {full|half}
0081
0082 NOTE: setting the speed/duplex to incorrect values will cause the link to
0083 fail.
0084
0085 Event Log Message Level:
0086 The driver uses the message level flag to log events
0087 to syslog. The message level can be set at driver load time. It can also be
0088 set using the command::
0089
0090 ethtool -s eth? msglvl n
0091
0092
0093 Additional Configurations
0094 =========================
0095
0096 Configuring the Driver on Different Distributions
0097 -------------------------------------------------
0098
0099 Configuring a network driver to load properly when the system is started
0100 is distribution dependent. Typically, the configuration process involves
0101 adding an alias line to `/etc/modprobe.d/*.conf` as well as editing other
0102 system startup scripts and/or configuration files. Many popular Linux
0103 distributions ship with tools to make these changes for you. To learn
0104 the proper way to configure a network device for your system, refer to
0105 your distribution documentation. If during this process you are asked
0106 for the driver or module name, the name for the Linux Base Driver for
0107 the Intel PRO/100 Family of Adapters is e100.
0108
0109 As an example, if you install the e100 driver for two PRO/100 adapters
0110 (eth0 and eth1), add the following to a configuration file in
0111 /etc/modprobe.d/::
0112
0113 alias eth0 e100
0114 alias eth1 e100
0115
0116 Viewing Link Messages
0117 ---------------------
0118
0119 In order to see link messages and other Intel driver information on your
0120 console, you must set the dmesg level up to six. This can be done by
0121 entering the following on the command line before loading the e100
0122 driver::
0123
0124 dmesg -n 6
0125
0126 If you wish to see all messages issued by the driver, including debug
0127 messages, set the dmesg level to eight.
0128
0129 NOTE: This setting is not saved across reboots.
0130
0131 ethtool
0132 -------
0133
0134 The driver utilizes the ethtool interface for driver configuration and
0135 diagnostics, as well as displaying statistical information. The ethtool
0136 version 1.6 or later is required for this functionality.
0137
0138 The latest release of ethtool can be found from
0139 https://www.kernel.org/pub/software/network/ethtool/
0140
0141 Enabling Wake on LAN (WoL)
0142 --------------------------
0143 WoL is provided through the ethtool utility. For instructions on
0144 enabling WoL with ethtool, refer to the ethtool man page. WoL will be
0145 enabled on the system during the next shut down or reboot. For this
0146 driver version, in order to enable WoL, the e100 driver must be loaded
0147 when shutting down or rebooting the system.
0148
0149 NAPI
0150 ----
0151
0152 NAPI (Rx polling mode) is supported in the e100 driver.
0153
0154 See https://wiki.linuxfoundation.org/networking/napi for more
0155 information on NAPI.
0156
0157 Multiple Interfaces on Same Ethernet Broadcast Network
0158 ------------------------------------------------------
0159
0160 Due to the default ARP behavior on Linux, it is not possible to have one
0161 system on two IP networks in the same Ethernet broadcast domain
0162 (non-partitioned switch) behave as expected. All Ethernet interfaces
0163 will respond to IP traffic for any IP address assigned to the system.
0164 This results in unbalanced receive traffic.
0165
0166 If you have multiple interfaces in a server, either turn on ARP
0167 filtering by
0168
0169 (1) entering::
0170
0171 echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter
0172
0173 (this only works if your kernel's version is higher than 2.4.5), or
0174
0175 (2) installing the interfaces in separate broadcast domains (either
0176 in different switches or in a switch partitioned to VLANs).
0177
0178
0179 Support
0180 =======
0181 For general information, go to the Intel support website at:
0182 https://www.intel.com/support/
0183
0184 or the Intel Wired Networking project hosted by Sourceforge at:
0185 http://sourceforge.net/projects/e1000
0186 If an issue is identified with the released source code on a supported kernel
0187 with a supported adapter, email the specific information related to the issue
0188 to e1000-devel@lists.sf.net.
