summaryrefslogtreecommitdiffstats
path: root/Documentation/networking
diff options
context:
space:
mode:
authorJeff Kirsher <jeffrey.t.kirsher@intel.com>2018-05-10 15:20:13 -0400
committerJeff Kirsher <jeffrey.t.kirsher@intel.com>2018-06-04 12:48:54 -0400
commit85d63445f41125dafeddda74e5b13b7eefac9407 (patch)
tree40dfa3c1267d4d4c1197e0a03adf71719e788286 /Documentation/networking
parentfff200caf6f9179dd9a7fc67acd659e614c3f72f (diff)
Documentation: e100: Update the Intel 10/100 driver doc
Over the years, several of the links have changed or are no longer valid so update them. In addition, the default values were incorrect for a couple of parameters. Converted the text file to the reStructuredText (RST) format, since the Linux kernel documentation now uses this format for documentation. Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com> Tested-by: Aaron Brown <aaron.f.brown@intel.com>
Diffstat (limited to 'Documentation/networking')
-rw-r--r--Documentation/networking/e100.rst (renamed from Documentation/networking/e100.txt)60
-rw-r--r--Documentation/networking/index.rst1
2 files changed, 28 insertions, 33 deletions
diff --git a/Documentation/networking/e100.txt b/Documentation/networking/e100.rst
index 54810b82c01a..d4d837027925 100644
--- a/Documentation/networking/e100.txt
+++ b/Documentation/networking/e100.rst
@@ -1,7 +1,7 @@
1Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters 1Linux* Base Driver for the Intel(R) PRO/100 Family of Adapters
2============================================================== 2==============================================================
3 3
4March 15, 2011 4June 1, 2018
5 5
6Contents 6Contents
7======== 7========
@@ -36,16 +36,9 @@ Channel Bonding documentation can be found in the Linux kernel source:
36Identifying Your Adapter 36Identifying Your Adapter
37======================== 37========================
38 38
39For more information on how to identify your adapter, go to the Adapter & 39For information on how to identify your adapter, and for the latest Intel
40Driver ID Guide at: 40network drivers, refer to the Intel Support website:
41 41http://www.intel.com/support
42 http://support.intel.com/support/network/adapter/pro100/21397.htm
43
44For 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
46networking link on the left to search for your adapter:
47
48 http://downloadfinder.intel.com/scripts-df/support_intel.asp
49 42
50Driver Configuration Parameters 43Driver Configuration Parameters
51=============================== 44===============================
@@ -57,22 +50,26 @@ 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 50 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 51 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 52 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 53 for this parameter is 64-256. The default value is 256. This parameter can be
61 changed using the command: 54 changed using the command::
62 55
63 ethtool -G eth? rx n, where n is the number of desired rx descriptors. 56 ethtool -G eth? rx n
57
58 Where n is the number of desired Rx descriptors.
64 59
65Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a data 60Tx Descriptors: Number of transmit descriptors. A transmit descriptor is a data
66 structure that describes a transmit buffer and its attributes to the network 61 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 62 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 63 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 64 range for this parameter is 64-256. The default value is 128. This parameter
70 can be changed using the command: 65 can be changed using the command::
66
67 ethtool -G eth? tx n
71 68
72 ethtool -G eth? tx n, where n is the number of desired tx descriptors. 69 Where n is the number of desired Tx descriptors.
73 70
74Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by 71Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by
75 default. The ethtool utility can be used as follows to force speed/duplex. 72 default. The ethtool utility can be used as follows to force speed/duplex.::
76 73
77 ethtool -s eth? autoneg off speed {10|100} duplex {full|half} 74 ethtool -s eth? autoneg off speed {10|100} duplex {full|half}
78 75
@@ -81,7 +78,7 @@ Speed/Duplex: The driver auto-negotiates the link speed and duplex settings by
81 78
82Event Log Message Level: The driver uses the message level flag to log events 79Event 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 80 to syslog. The message level can be set at driver load time. It can also be
84 set using the command: 81 set using the command::
85 82
86 ethtool -s eth? msglvl n 83 ethtool -s eth? msglvl n
87 84
@@ -112,9 +109,9 @@ Additional Configurations
112 --------------------- 109 ---------------------
113 In order to see link messages and other Intel driver information on your 110 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 111 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: 112 entering the following on the command line before loading the e100 driver::
116 113
117 dmesg -n 8 114 dmesg -n 6
118 115
119 If you wish to see all messages issued by the driver, including debug 116 If you wish to see all messages issued by the driver, including debug
120 messages, set the dmesg level to eight. 117 messages, set the dmesg level to eight.
@@ -146,7 +143,8 @@ Additional Configurations
146 143
147 NAPI (Rx polling mode) is supported in the e100 driver. 144 NAPI (Rx polling mode) is supported in the e100 driver.
148 145
149 See www.cyberus.ca/~hadi/usenix-paper.tgz for more information on NAPI. 146 See https://wiki.linuxfoundation.org/networking/napi for more information
147 on NAPI.
150 148
151 Multiple Interfaces on Same Ethernet Broadcast Network 149 Multiple Interfaces on Same Ethernet Broadcast Network
152 ------------------------------------------------------ 150 ------------------------------------------------------
@@ -160,7 +158,7 @@ Additional Configurations
160 If you have multiple interfaces in a server, either turn on ARP 158 If you have multiple interfaces in a server, either turn on ARP
161 filtering by 159 filtering by
162 160
163 (1) entering: echo 1 > /proc/sys/net/ipv4/conf/all/arp_filter 161 (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 162 (this only works if your kernel's version is higher than 2.4.5), or
165 163
166 (2) installing the interfaces in separate broadcast domains (either 164 (2) installing the interfaces in separate broadcast domains (either
@@ -169,15 +167,11 @@ Additional Configurations
169 167
170Support 168Support
171======= 169=======
172
173For general information, go to the Intel support website at: 170For general information, go to the Intel support website at:
171http://www.intel.com/support/
174 172
175 http://support.intel.com 173or the Intel Wired Networking project hosted by Sourceforge at:
176 174http://sourceforge.net/projects/e1000
177 or the Intel Wired Networking project hosted by Sourceforge at: 175If an issue is identified with the released source code on a supported kernel
178 176with a supported adapter, email the specific information related to the issue
179 http://sourceforge.net/projects/e1000 177to e1000-devel@lists.sf.net.
180
181If an issue is identified with the released source code on the supported
182kernel with a supported adapter, email the specific information related to the
183issue to e1000-devel@lists.sourceforge.net.
diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
index cbd9bdd4a79e..d11a62977edd 100644
--- a/Documentation/networking/index.rst
+++ b/Documentation/networking/index.rst
@@ -10,6 +10,7 @@ Contents:
10 batman-adv 10 batman-adv
11 can 11 can
12 dpaa2/index 12 dpaa2/index
13 e100
13 kapi 14 kapi
14 z8530book 15 z8530book
15 msg_zerocopy 16 msg_zerocopy