aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/networking
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/networking')
-rw-r--r--Documentation/networking/README.ipw2100132
-rw-r--r--Documentation/networking/README.ipw2200196
-rw-r--r--Documentation/networking/bonding.txt5
-rw-r--r--Documentation/networking/dccp.txt56
-rw-r--r--Documentation/networking/decnet.txt2
-rw-r--r--Documentation/networking/driver.txt5
-rw-r--r--Documentation/networking/ifenslave.c9
-rw-r--r--Documentation/networking/ip-sysctl.txt17
-rw-r--r--Documentation/networking/iphase.txt2
-rw-r--r--Documentation/networking/irda.txt8
-rw-r--r--Documentation/networking/ray_cs.txt3
-rw-r--r--Documentation/networking/s2io.txt199
-rw-r--r--Documentation/networking/vortex.txt28
13 files changed, 498 insertions, 164 deletions
diff --git a/Documentation/networking/README.ipw2100 b/Documentation/networking/README.ipw2100
index 2046948b020d..3ab40379d1cf 100644
--- a/Documentation/networking/README.ipw2100
+++ b/Documentation/networking/README.ipw2100
@@ -1,27 +1,82 @@
1 1
2=========================== 2Intel(R) PRO/Wireless 2100 Driver for Linux in support of:
3Intel(R) PRO/Wireless 2100 Network Connection Driver for Linux 3
4Intel(R) PRO/Wireless 2100 Network Connection
5
6Copyright (C) 2003-2005, Intel Corporation
7
4README.ipw2100 8README.ipw2100
5 9
6March 14, 2005 10Version: 1.1.3
11Date : October 17, 2005
7 12
8===========================
9Index 13Index
10--------------------------- 14-----------------------------------------------
110. Introduction 150. IMPORTANT INFORMATION BEFORE USING THIS DRIVER
121. Release 1.1.0 Current Features 161. Introduction
132. Command Line Parameters 172. Release 1.1.3 Current Features
143. Sysfs Helper Files 183. Command Line Parameters
154. Radio Kill Switch 194. Sysfs Helper Files
165. Dynamic Firmware 205. Radio Kill Switch
176. Power Management 216. Dynamic Firmware
187. Support 227. Power Management
198. License 238. Support
20 249. License
21 25
22=========================== 26
230. Introduction 270. IMPORTANT INFORMATION BEFORE USING THIS DRIVER
24------------ ----- ----- ---- --- -- - 28-----------------------------------------------
29
30Important Notice FOR ALL USERS OR DISTRIBUTORS!!!!
31
32Intel wireless LAN adapters are engineered, manufactured, tested, and
33quality checked to ensure that they meet all necessary local and
34governmental regulatory agency requirements for the regions that they
35are designated and/or marked to ship into. Since wireless LANs are
36generally unlicensed devices that share spectrum with radars,
37satellites, and other licensed and unlicensed devices, it is sometimes
38necessary to dynamically detect, avoid, and limit usage to avoid
39interference with these devices. In many instances Intel is required to
40provide test data to prove regional and local compliance to regional and
41governmental regulations before certification or approval to use the
42product is granted. Intel's wireless LAN's EEPROM, firmware, and
43software driver are designed to carefully control parameters that affect
44radio operation and to ensure electromagnetic compliance (EMC). These
45parameters include, without limitation, RF power, spectrum usage,
46channel scanning, and human exposure.
47
48For these reasons Intel cannot permit any manipulation by third parties
49of the software provided in binary format with the wireless WLAN
50adapters (e.g., the EEPROM and firmware). Furthermore, if you use any
51patches, utilities, or code with the Intel wireless LAN adapters that
52have been manipulated by an unauthorized party (i.e., patches,
53utilities, or code (including open source code modifications) which have
54not been validated by Intel), (i) you will be solely responsible for
55ensuring the regulatory compliance of the products, (ii) Intel will bear
56no liability, under any theory of liability for any issues associated
57with the modified products, including without limitation, claims under
58the warranty and/or issues arising from regulatory non-compliance, and
59(iii) Intel will not provide or be required to assist in providing
60support to any third parties for such modified products.
61
62Note: Many regulatory agencies consider Wireless LAN adapters to be
63modules, and accordingly, condition system-level regulatory approval
64upon receipt and review of test data documenting that the antennas and
65system configuration do not cause the EMC and radio operation to be
66non-compliant.
67
68The drivers available for download from SourceForge are provided as a
69part of a development project. Conformance to local regulatory
70requirements is the responsibility of the individual developer. As
71such, if you are interested in deploying or shipping a driver as part of
72solution intended to be used for purposes other than development, please
73obtain a tested driver from Intel Customer Support at:
74
75http://support.intel.com/support/notebook/sb/CS-006408.htm
76
77
781. Introduction
79-----------------------------------------------
25 80
26This document provides a brief overview of the features supported by the 81This document provides a brief overview of the features supported by the
27IPW2100 driver project. The main project website, where the latest 82IPW2100 driver project. The main project website, where the latest
@@ -34,9 +89,8 @@ potential fixes and patches, as well as links to the development mailing list
34for the driver project. 89for the driver project.
35 90
36 91
37=========================== 922. Release 1.1.3 Current Supported Features
381. Release 1.1.0 Current Supported Features 93-----------------------------------------------
39---------------------------
40- Managed (BSS) and Ad-Hoc (IBSS) 94- Managed (BSS) and Ad-Hoc (IBSS)
41- WEP (shared key and open) 95- WEP (shared key and open)
42- Wireless Tools support 96- Wireless Tools support
@@ -51,9 +105,8 @@ on the amount of validation and interoperability testing that has been
51performed on a given feature. 105performed on a given feature.
52 106
53 107
54=========================== 1083. Command Line Parameters
552. Command Line Parameters 109-----------------------------------------------
56---------------------------
57 110
58If the driver is built as a module, the following optional parameters are used 111If the driver is built as a module, the following optional parameters are used
59by entering them on the command line with the modprobe command using this 112by entering them on the command line with the modprobe command using this
@@ -75,9 +128,9 @@ associate boolean associate=0 /* Do NOT auto associate */
75disable boolean disable=1 /* Do not power the HW */ 128disable boolean disable=1 /* Do not power the HW */
76 129
77 130
78=========================== 1314. Sysfs Helper Files
793. Sysfs Helper Files
80--------------------------- 132---------------------------
133-----------------------------------------------
81 134
82There are several ways to control the behavior of the driver. Many of the 135There are several ways to control the behavior of the driver. Many of the
83general capabilities are exposed through the Wireless Tools (iwconfig). There 136general capabilities are exposed through the Wireless Tools (iwconfig). There
@@ -120,9 +173,8 @@ For the device level files, see /sys/bus/pci/drivers/ipw2100:
120 based RF kill from ON -> OFF -> ON, the radio will NOT come back on 173 based RF kill from ON -> OFF -> ON, the radio will NOT come back on
121 174
122 175
123=========================== 1765. Radio Kill Switch
1244. Radio Kill Switch 177-----------------------------------------------
125---------------------------
126Most laptops provide the ability for the user to physically disable the radio. 178Most laptops provide the ability for the user to physically disable the radio.
127Some vendors have implemented this as a physical switch that requires no 179Some vendors have implemented this as a physical switch that requires no
128software to turn the radio off and on. On other laptops, however, the switch 180software to turn the radio off and on. On other laptops, however, the switch
@@ -134,9 +186,8 @@ See the Sysfs helper file 'rf_kill' for determining the state of the RF switch
134on your system. 186on your system.
135 187
136 188
137=========================== 1896. Dynamic Firmware
1385. Dynamic Firmware 190-----------------------------------------------
139---------------------------
140As the firmware is licensed under a restricted use license, it can not be 191As the firmware is licensed under a restricted use license, it can not be
141included within the kernel sources. To enable the IPW2100 you will need a 192included within the kernel sources. To enable the IPW2100 you will need a
142firmware image to load into the wireless NIC's processors. 193firmware image to load into the wireless NIC's processors.
@@ -146,9 +197,8 @@ You can obtain these images from <http://ipw2100.sf.net/firmware.php>.
146See INSTALL for instructions on installing the firmware. 197See INSTALL for instructions on installing the firmware.
147 198
148 199
149=========================== 2007. Power Management
1506. Power Management 201-----------------------------------------------
151---------------------------
152The IPW2100 supports the configuration of the Power Save Protocol 202The IPW2100 supports the configuration of the Power Save Protocol
153through a private wireless extension interface. The IPW2100 supports 203through a private wireless extension interface. The IPW2100 supports
154the following different modes: 204the following different modes:
@@ -200,9 +250,8 @@ xxxx/yyyy will be replaced with 'off' -- the level reported will be the active
200level if `iwconfig eth1 power on` is invoked. 250level if `iwconfig eth1 power on` is invoked.
201 251
202 252
203=========================== 2538. Support
2047. Support 254-----------------------------------------------
205---------------------------
206 255
207For general development information and support, 256For general development information and support,
208go to: 257go to:
@@ -218,9 +267,8 @@ For installation support on the ipw2100 1.1.0 driver on Linux kernels
218 267
219 http://supportmail.intel.com 268 http://supportmail.intel.com
220 269
221=========================== 2709. License
2228. License 271-----------------------------------------------
223---------------------------
224 272
225 Copyright(c) 2003 - 2005 Intel Corporation. All rights reserved. 273 Copyright(c) 2003 - 2005 Intel Corporation. All rights reserved.
226 274
diff --git a/Documentation/networking/README.ipw2200 b/Documentation/networking/README.ipw2200
index 6916080c5f03..c6492d3839fa 100644
--- a/Documentation/networking/README.ipw2200
+++ b/Documentation/networking/README.ipw2200
@@ -1,33 +1,89 @@
1 1
2Intel(R) PRO/Wireless 2915ABG Driver for Linux in support of: 2Intel(R) PRO/Wireless 2915ABG Driver for Linux in support of:
3 3
4Intel(R) PRO/Wireless 2200BG Network Connection 4Intel(R) PRO/Wireless 2200BG Network Connection
5Intel(R) PRO/Wireless 2915ABG Network Connection 5Intel(R) PRO/Wireless 2915ABG Network Connection
6 6
7Note: The Intel(R) PRO/Wireless 2915ABG Driver for Linux and Intel(R) 7Note: The Intel(R) PRO/Wireless 2915ABG Driver for Linux and Intel(R)
8PRO/Wireless 2200BG Driver for Linux is a unified driver that works on 8PRO/Wireless 2200BG Driver for Linux is a unified driver that works on
9both hardware adapters listed above. In this document the Intel(R) 9both hardware adapters listed above. In this document the Intel(R)
10PRO/Wireless 2915ABG Driver for Linux will be used to reference the 10PRO/Wireless 2915ABG Driver for Linux will be used to reference the
11unified driver. 11unified driver.
12 12
13Copyright (C) 2004-2005, Intel Corporation 13Copyright (C) 2004-2005, Intel Corporation
14 14
15README.ipw2200 15README.ipw2200
16 16
17Version: 1.0.0 17Version: 1.0.8
18Date : January 31, 2005 18Date : October 20, 2005
19 19
20 20
21Index 21Index
22----------------------------------------------- 22-----------------------------------------------
230. IMPORTANT INFORMATION BEFORE USING THIS DRIVER
231. Introduction 241. Introduction
241.1. Overview of features 251.1. Overview of features
251.2. Module parameters 261.2. Module parameters
261.3. Wireless Extension Private Methods 271.3. Wireless Extension Private Methods
271.4. Sysfs Helper Files 281.4. Sysfs Helper Files
282. About the Version Numbers 292. Ad-Hoc Networking
293. Support 303. Interacting with Wireless Tools
304. License 313.1. iwconfig mode
324. About the Version Numbers
335. Firmware installation
346. Support
357. License
36
37
380. IMPORTANT INFORMATION BEFORE USING THIS DRIVER
39-----------------------------------------------
40
41Important Notice FOR ALL USERS OR DISTRIBUTORS!!!!
42
43Intel wireless LAN adapters are engineered, manufactured, tested, and
44quality checked to ensure that they meet all necessary local and
45governmental regulatory agency requirements for the regions that they
46are designated and/or marked to ship into. Since wireless LANs are
47generally unlicensed devices that share spectrum with radars,
48satellites, and other licensed and unlicensed devices, it is sometimes
49necessary to dynamically detect, avoid, and limit usage to avoid
50interference with these devices. In many instances Intel is required to
51provide test data to prove regional and local compliance to regional and
52governmental regulations before certification or approval to use the
53product is granted. Intel's wireless LAN's EEPROM, firmware, and
54software driver are designed to carefully control parameters that affect
55radio operation and to ensure electromagnetic compliance (EMC). These
56parameters include, without limitation, RF power, spectrum usage,
57channel scanning, and human exposure.
58
59For these reasons Intel cannot permit any manipulation by third parties
60of the software provided in binary format with the wireless WLAN
61adapters (e.g., the EEPROM and firmware). Furthermore, if you use any
62patches, utilities, or code with the Intel wireless LAN adapters that
63have been manipulated by an unauthorized party (i.e., patches,
64utilities, or code (including open source code modifications) which have
65not been validated by Intel), (i) you will be solely responsible for
66ensuring the regulatory compliance of the products, (ii) Intel will bear
67no liability, under any theory of liability for any issues associated
68with the modified products, including without limitation, claims under
69the warranty and/or issues arising from regulatory non-compliance, and
70(iii) Intel will not provide or be required to assist in providing
71support to any third parties for such modified products.
72
73Note: Many regulatory agencies consider Wireless LAN adapters to be
74modules, and accordingly, condition system-level regulatory approval
75upon receipt and review of test data documenting that the antennas and
76system configuration do not cause the EMC and radio operation to be
77non-compliant.
78
79The drivers available for download from SourceForge are provided as a
80part of a development project. Conformance to local regulatory
81requirements is the responsibility of the individual developer. As
82such, if you are interested in deploying or shipping a driver as part of
83solution intended to be used for purposes other than development, please
84obtain a tested driver from Intel Customer Support at:
85
86http://support.intel.com/support/notebook/sb/CS-006408.htm
31 87
32 88
331. Introduction 891. Introduction
@@ -45,7 +101,7 @@ file.
45 101
461.1. Overview of Features 1021.1. Overview of Features
47----------------------------------------------- 103-----------------------------------------------
48The current release (1.0.0) supports the following features: 104The current release (1.0.8) supports the following features:
49 105
50+ BSS mode (Infrastructure, Managed) 106+ BSS mode (Infrastructure, Managed)
51+ IBSS mode (Ad-Hoc) 107+ IBSS mode (Ad-Hoc)
@@ -56,17 +112,27 @@ The current release (1.0.0) supports the following features:
56+ Full A rate support (2915 only) 112+ Full A rate support (2915 only)
57+ Transmit power control 113+ Transmit power control
58+ S state support (ACPI suspend/resume) 114+ S state support (ACPI suspend/resume)
115
116The following features are currently enabled, but not officially
117supported:
118
119+ WPA
59+ long/short preamble support 120+ long/short preamble support
121+ Monitor mode (aka RFMon)
122
123The distinction between officially supported and enabled is a reflection
124on the amount of validation and interoperability testing that has been
125performed on a given feature.
60 126
61 127
62 128
631.2. Command Line Parameters 1291.2. Command Line Parameters
64----------------------------------------------- 130-----------------------------------------------
65 131
66Like many modules used in the Linux kernel, the Intel(R) PRO/Wireless 132Like many modules used in the Linux kernel, the Intel(R) PRO/Wireless
672915ABG Driver for Linux allows certain configuration options to be 1332915ABG Driver for Linux allows configuration options to be provided
68provided as module parameters. The most common way to specify a module 134as module parameters. The most common way to specify a module parameter
69parameter is via the command line. 135is via the command line.
70 136
71The general form is: 137The general form is:
72 138
@@ -96,14 +162,18 @@ Where the supported parameter are:
96 162
97 debug 163 debug
98 If using a debug build, this is used to control the amount of debug 164 If using a debug build, this is used to control the amount of debug
99 info is logged. See the 'dval' and 'load' script for more info on 165 info is logged. See the 'dvals' and 'load' script for more info on
100 how to use this (the dval and load scripts are provided as part 166 how to use this (the dvals and load scripts are provided as part
101 of the ipw2200 development snapshot releases available from the 167 of the ipw2200 development snapshot releases available from the
102 SourceForge project at http://ipw2200.sf.net) 168 SourceForge project at http://ipw2200.sf.net)
169
170 led
171 Can be used to turn on experimental LED code.
172 0 = Off, 1 = On. Default is 0.
103 173
104 mode 174 mode
105 Can be used to set the default mode of the adapter. 175 Can be used to set the default mode of the adapter.
106 0 = Managed, 1 = Ad-Hoc 176 0 = Managed, 1 = Ad-Hoc, 2 = Monitor
107 177
108 178
1091.3. Wireless Extension Private Methods 1791.3. Wireless Extension Private Methods
@@ -164,8 +234,8 @@ The supported private methods are:
164----------------------------------------------- 234-----------------------------------------------
165 235
166The Linux kernel provides a pseudo file system that can be used to 236The Linux kernel provides a pseudo file system that can be used to
167access various components of the operating system. The Intel(R) 237access various components of the operating system. The Intel(R)
168PRO/Wireless 2915ABG Driver for Linux exposes several configuration 238PRO/Wireless 2915ABG Driver for Linux exposes several configuration
169parameters through this mechanism. 239parameters through this mechanism.
170 240
171An entry in the sysfs can support reading and/or writing. You can 241An entry in the sysfs can support reading and/or writing. You can
@@ -184,13 +254,13 @@ You can set the debug level via:
184 254
185Where $VALUE would be a number in the case of this sysfs entry. The 255Where $VALUE would be a number in the case of this sysfs entry. The
186input to sysfs files does not have to be a number. For example, the 256input to sysfs files does not have to be a number. For example, the
187firmware loader used by hotplug utilizes sysfs entries for transferring 257firmware loader used by hotplug utilizes sysfs entries for transfering
188the firmware image from user space into the driver. 258the firmware image from user space into the driver.
189 259
190The Intel(R) PRO/Wireless 2915ABG Driver for Linux exposes sysfs entries 260The Intel(R) PRO/Wireless 2915ABG Driver for Linux exposes sysfs entries
191at two levels -- driver level, which apply to all instances of the 261at two levels -- driver level, which apply to all instances of the driver
192driver (in the event that there are more than one device installed) and 262(in the event that there are more than one device installed) and device
193device level, which applies only to the single specific instance. 263level, which applies only to the single specific instance.
194 264
195 265
1961.4.1 Driver Level Sysfs Helper Files 2661.4.1 Driver Level Sysfs Helper Files
@@ -203,6 +273,7 @@ For the driver level files, look in /sys/bus/pci/drivers/ipw2200/
203 This controls the same global as the 'debug' module parameter 273 This controls the same global as the 'debug' module parameter
204 274
205 275
276
2061.4.2 Device Level Sysfs Helper Files 2771.4.2 Device Level Sysfs Helper Files
207----------------------------------------------- 278-----------------------------------------------
208 279
@@ -213,7 +284,7 @@ For the device level files, look in
213For example: 284For example:
214 /sys/bus/pci/drivers/ipw2200/0000:02:01.0 285 /sys/bus/pci/drivers/ipw2200/0000:02:01.0
215 286
216For the device level files, see /sys/bus/pci/[drivers/ipw2200: 287For the device level files, see /sys/bus/pci/drivers/ipw2200:
217 288
218 rf_kill 289 rf_kill
219 read - 290 read -
@@ -231,8 +302,59 @@ For the device level files, see /sys/bus/pci/[drivers/ipw2200:
231 ucode 302 ucode
232 read-only access to the ucode version number 303 read-only access to the ucode version number
233 304
305 led
306 read -
307 0 = LED code disabled
308 1 = LED code enabled
309 write -
310 0 = Disable LED code
311 1 = Enable LED code
312
313 NOTE: The LED code has been reported to hang some systems when
314 running ifconfig and is therefore disabled by default.
315
316
3172. Ad-Hoc Networking
318-----------------------------------------------
319
320When using a device in an Ad-Hoc network, it is useful to understand the
321sequence and requirements for the driver to be able to create, join, or
322merge networks.
323
324The following attempts to provide enough information so that you can
325have a consistent experience while using the driver as a member of an
326Ad-Hoc network.
327
3282.1. Joining an Ad-Hoc Network
329-----------------------------------------------
330
331The easiest way to get onto an Ad-Hoc network is to join one that
332already exists.
234 333
2352. About the Version Numbers 3342.2. Creating an Ad-Hoc Network
335-----------------------------------------------
336
337An Ad-Hoc networks is created using the syntax of the Wireless tool.
338
339For Example:
340iwconfig eth1 mode ad-hoc essid testing channel 2
341
3422.3. Merging Ad-Hoc Networks
343-----------------------------------------------
344
345
3463. Interaction with Wireless Tools
347-----------------------------------------------
348
3493.1 iwconfig mode
350-----------------------------------------------
351
352When configuring the mode of the adapter, all run-time configured parameters
353are reset to the value used when the module was loaded. This includes
354channels, rates, ESSID, etc.
355
356
3574. About the Version Numbers
236----------------------------------------------- 358-----------------------------------------------
237 359
238Due to the nature of open source development projects, there are 360Due to the nature of open source development projects, there are
@@ -259,12 +381,23 @@ available as quickly as possible, unknown anomalies should be expected.
259The major version number will be incremented when significant changes 381The major version number will be incremented when significant changes
260are made to the driver. Currently, there are no major changes planned. 382are made to the driver. Currently, there are no major changes planned.
261 383
3845. Firmware installation
385----------------------------------------------
386
387The driver requires a firmware image, download it and extract the
388files under /lib/firmware (or wherever your hotplug's firmware.agent
389will look for firmware files)
390
391The firmware can be downloaded from the following URL:
262 392
2633. Support 393 http://ipw2200.sf.net/
394
395
3966. Support
264----------------------------------------------- 397-----------------------------------------------
265 398
266For installation support of the 1.0.0 version, you can contact 399For direct support of the 1.0.0 version, you can contact
267http://supportmail.intel.com, or you can use the open source project 400http://supportmail.intel.com, or you can use the open source project
268support. 401support.
269 402
270For general information and support, go to: 403For general information and support, go to:
@@ -272,7 +405,7 @@ For general information and support, go to:
272 http://ipw2200.sf.net/ 405 http://ipw2200.sf.net/
273 406
274 407
2754. License 4087. License
276----------------------------------------------- 409-----------------------------------------------
277 410
278 Copyright(c) 2003 - 2005 Intel Corporation. All rights reserved. 411 Copyright(c) 2003 - 2005 Intel Corporation. All rights reserved.
@@ -297,4 +430,3 @@ For general information and support, go to:
297 James P. Ketrenos <ipw2100-admin@linux.intel.com> 430 James P. Ketrenos <ipw2100-admin@linux.intel.com>
298 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 431 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
299 432
300
diff --git a/Documentation/networking/bonding.txt b/Documentation/networking/bonding.txt
index a55f0f95b171..b0fe41da007b 100644
--- a/Documentation/networking/bonding.txt
+++ b/Documentation/networking/bonding.txt
@@ -777,7 +777,7 @@ doing so is the same as described in the "Configuring Multiple Bonds
777Manually" section, below. 777Manually" section, below.
778 778
779 NOTE: It has been observed that some Red Hat supplied kernels 779 NOTE: It has been observed that some Red Hat supplied kernels
780are apparently unable to rename modules at load time (the "-obonding1" 780are apparently unable to rename modules at load time (the "-o bond1"
781part). Attempts to pass that option to modprobe will produce an 781part). Attempts to pass that option to modprobe will produce an
782"Operation not permitted" error. This has been reported on some 782"Operation not permitted" error. This has been reported on some
783Fedora Core kernels, and has been seen on RHEL 4 as well. On kernels 783Fedora Core kernels, and has been seen on RHEL 4 as well. On kernels
@@ -883,7 +883,8 @@ the above does not work, and the second bonding instance never sees
883its options. In that case, the second options line can be substituted 883its options. In that case, the second options line can be substituted
884as follows: 884as follows:
885 885
886install bonding1 /sbin/modprobe bonding -obond1 mode=balance-alb miimon=50 886install bond1 /sbin/modprobe --ignore-install bonding -o bond1 \
887 mode=balance-alb miimon=50
887 888
888 This may be repeated any number of times, specifying a new and 889 This may be repeated any number of times, specifying a new and
889unique name in place of bond1 for each subsequent instance. 890unique name in place of bond1 for each subsequent instance.
diff --git a/Documentation/networking/dccp.txt b/Documentation/networking/dccp.txt
new file mode 100644
index 000000000000..c45daabd3bfe
--- /dev/null
+++ b/Documentation/networking/dccp.txt
@@ -0,0 +1,56 @@
1DCCP protocol
2============
3
4Last updated: 10 November 2005
5
6Contents
7========
8
9- Introduction
10- Missing features
11- Socket options
12- Notes
13
14Introduction
15============
16
17Datagram Congestion Control Protocol (DCCP) is an unreliable, connection
18based protocol designed to solve issues present in UDP and TCP particularly
19for real time and multimedia traffic.
20
21It has a base protocol and pluggable congestion control IDs (CCIDs).
22
23It is at draft RFC status and the homepage for DCCP as a protocol is at:
24 http://www.icir.org/kohler/dcp/
25
26Missing features
27================
28
29The DCCP implementation does not currently have all the features that are in
30the draft RFC.
31
32In particular the following are missing:
33- CCID2 support
34- feature negotiation
35
36When testing against other implementations it appears that elapsed time
37options are not coded compliant to the specification.
38
39Socket options
40==============
41
42DCCP_SOCKOPT_PACKET_SIZE is used for CCID3 to set default packet size for
43calculations.
44
45DCCP_SOCKOPT_SERVICE sets the service. This is compulsory as per the
46specification. If you don't set it you will get EPROTO.
47
48Notes
49=====
50
51SELinux does not yet have support for DCCP. You will need to turn it off or
52else you will get EACCES.
53
54DCCP does not travel through NAT successfully at present. This is because
55the checksum covers the psuedo-header as per TCP and UDP. It should be
56relatively trivial to add Linux NAT support for DCCP.
diff --git a/Documentation/networking/decnet.txt b/Documentation/networking/decnet.txt
index c6bd25f5d61d..e6c39c5831f5 100644
--- a/Documentation/networking/decnet.txt
+++ b/Documentation/networking/decnet.txt
@@ -176,8 +176,6 @@ information (_most_ of which _is_ _essential_) includes:
176 - Which client caused the problem ? 176 - Which client caused the problem ?
177 - How much data was being transferred ? 177 - How much data was being transferred ?
178 - Was the network congested ? 178 - Was the network congested ?
179 - If there was a kernel panic, please run the output through ksymoops
180 before sending it to me, otherwise its _useless_.
181 - How can the problem be reproduced ? 179 - How can the problem be reproduced ?
182 - Can you use tcpdump to get a trace ? (N.B. Most (all?) versions of 180 - Can you use tcpdump to get a trace ? (N.B. Most (all?) versions of
183 tcpdump don't understand how to dump DECnet properly, so including 181 tcpdump don't understand how to dump DECnet properly, so including
diff --git a/Documentation/networking/driver.txt b/Documentation/networking/driver.txt
index 11fd0ef5ff57..a9ad58b49cc5 100644
--- a/Documentation/networking/driver.txt
+++ b/Documentation/networking/driver.txt
@@ -1,7 +1,4 @@
1Documents about softnet driver issues in general can be found 1Document about softnet driver issues
2at:
3
4 http://www.firstfloor.org/~andi/softnet/
5 2
6Transmit path guidelines: 3Transmit path guidelines:
7 4
diff --git a/Documentation/networking/ifenslave.c b/Documentation/networking/ifenslave.c
index f315d20d3867..545447ac503a 100644
--- a/Documentation/networking/ifenslave.c
+++ b/Documentation/networking/ifenslave.c
@@ -693,13 +693,7 @@ static int enslave(char *master_ifname, char *slave_ifname)
693 /* Older bonding versions would panic if the slave has no IP 693 /* Older bonding versions would panic if the slave has no IP
694 * address, so get the IP setting from the master. 694 * address, so get the IP setting from the master.
695 */ 695 */
696 res = set_if_addr(master_ifname, slave_ifname); 696 set_if_addr(master_ifname, slave_ifname);
697 if (res) {
698 fprintf(stderr,
699 "Slave '%s': Error: set address failed\n",
700 slave_ifname);
701 return res;
702 }
703 } else { 697 } else {
704 res = clear_if_addr(slave_ifname); 698 res = clear_if_addr(slave_ifname);
705 if (res) { 699 if (res) {
@@ -1085,7 +1079,6 @@ static int set_if_addr(char *master_ifname, char *slave_ifname)
1085 slave_ifname, ifra[i].req_name, 1079 slave_ifname, ifra[i].req_name,
1086 strerror(saved_errno)); 1080 strerror(saved_errno));
1087 1081
1088 return res;
1089 } 1082 }
1090 1083
1091 ipaddr = ifr.ifr_addr.sa_data; 1084 ipaddr = ifr.ifr_addr.sa_data;
diff --git a/Documentation/networking/ip-sysctl.txt b/Documentation/networking/ip-sysctl.txt
index ab65714d95fc..ebc09a159f62 100644
--- a/Documentation/networking/ip-sysctl.txt
+++ b/Documentation/networking/ip-sysctl.txt
@@ -78,6 +78,11 @@ inet_peer_gc_maxtime - INTEGER
78 78
79TCP variables: 79TCP variables:
80 80
81tcp_abc - INTEGER
82 Controls Appropriate Byte Count defined in RFC3465. If set to
83 0 then does congestion avoid once per ack. 1 is conservative
84 value, and 2 is more agressive.
85
81tcp_syn_retries - INTEGER 86tcp_syn_retries - INTEGER
82 Number of times initial SYNs for an active TCP connection attempt 87 Number of times initial SYNs for an active TCP connection attempt
83 will be retransmitted. Should not be higher than 255. Default value 88 will be retransmitted. Should not be higher than 255. Default value
@@ -309,7 +314,7 @@ tcp_tso_win_divisor - INTEGER
309 can be consumed by a single TSO frame. 314 can be consumed by a single TSO frame.
310 The setting of this parameter is a choice between burstiness and 315 The setting of this parameter is a choice between burstiness and
311 building larger TSO frames. 316 building larger TSO frames.
312 Default: 8 317 Default: 3
313 318
314tcp_frto - BOOLEAN 319tcp_frto - BOOLEAN
315 Enables F-RTO, an enhanced recovery algorithm for TCP retransmission 320 Enables F-RTO, an enhanced recovery algorithm for TCP retransmission
@@ -355,10 +360,14 @@ ip_dynaddr - BOOLEAN
355 Default: 0 360 Default: 0
356 361
357icmp_echo_ignore_all - BOOLEAN 362icmp_echo_ignore_all - BOOLEAN
363 If set non-zero, then the kernel will ignore all ICMP ECHO
364 requests sent to it.
365 Default: 0
366
358icmp_echo_ignore_broadcasts - BOOLEAN 367icmp_echo_ignore_broadcasts - BOOLEAN
359 If either is set to true, then the kernel will ignore either all 368 If set non-zero, then the kernel will ignore all ICMP ECHO and
360 ICMP ECHO requests sent to it or just those to broadcast/multicast 369 TIMESTAMP requests sent to it via broadcast/multicast.
361 addresses, respectively. 370 Default: 1
362 371
363icmp_ratelimit - INTEGER 372icmp_ratelimit - INTEGER
364 Limit the maximal rates for sending ICMP packets whose type matches 373 Limit the maximal rates for sending ICMP packets whose type matches
diff --git a/Documentation/networking/iphase.txt b/Documentation/networking/iphase.txt
index 39ccb8595bf1..493203a080a8 100644
--- a/Documentation/networking/iphase.txt
+++ b/Documentation/networking/iphase.txt
@@ -22,7 +22,7 @@ The features and limitations of this driver are as follows:
22 - All variants of Interphase ATM PCI (i)Chip adapter cards are supported, 22 - All variants of Interphase ATM PCI (i)Chip adapter cards are supported,
23 including x575 (OC3, control memory 128K , 512K and packet memory 128K, 23 including x575 (OC3, control memory 128K , 512K and packet memory 128K,
24 512K and 1M), x525 (UTP25) and x531 (DS3 and E3). See 24 512K and 1M), x525 (UTP25) and x531 (DS3 and E3). See
25 http://www.iphase.com/products/ClassSheet.cfm?ClassID=ATM 25 http://www.iphase.com/site/iphase-web/?epi_menuItemID=e196f04b4b3b40502f150882e21046a0
26 for details. 26 for details.
27 - Only x86 platforms are supported. 27 - Only x86 platforms are supported.
28 - SMP is supported. 28 - SMP is supported.
diff --git a/Documentation/networking/irda.txt b/Documentation/networking/irda.txt
index 9e5b8e66d6a5..bff26c138be6 100644
--- a/Documentation/networking/irda.txt
+++ b/Documentation/networking/irda.txt
@@ -3,12 +3,8 @@ of the IrDA Utilities. More detailed information about these and associated
3programs can be found on http://irda.sourceforge.net/ 3programs can be found on http://irda.sourceforge.net/
4 4
5For more information about how to use the IrDA protocol stack, see the 5For more information about how to use the IrDA protocol stack, see the
6Linux Infared HOWTO (http://www.tuxmobil.org/Infrared-HOWTO/Infrared-HOWTO.html) 6Linux Infrared HOWTO by Werner Heuser <wehe@tuxmobil.org>:
7by Werner Heuser <wehe@tuxmobil.org> 7<http://www.tuxmobil.org/Infrared-HOWTO/Infrared-HOWTO.html>
8 8
9There is an active mailing list for discussing Linux-IrDA matters called 9There is an active mailing list for discussing Linux-IrDA matters called
10 irda-users@lists.sourceforge.net 10 irda-users@lists.sourceforge.net
11
12
13
14
diff --git a/Documentation/networking/ray_cs.txt b/Documentation/networking/ray_cs.txt
index b1def00bc4a3..5427f8c7df95 100644
--- a/Documentation/networking/ray_cs.txt
+++ b/Documentation/networking/ray_cs.txt
@@ -29,8 +29,7 @@ with nondefault parameters, they can be edited in
29will find them all. 29will find them all.
30 30
31Information on card services is available at: 31Information on card services is available at:
32 ftp://hyper.stanford.edu/pub/pcmcia/doc 32 http://pcmcia-cs.sourceforge.net/
33 http://hyper.stanford.edu/HyperNews/get/pcmcia/home.html
34 33
35 34
36Card services user programs are still required for PCMCIA devices. 35Card services user programs are still required for PCMCIA devices.
diff --git a/Documentation/networking/s2io.txt b/Documentation/networking/s2io.txt
index 6726b524ec45..bd528ffbeb4b 100644
--- a/Documentation/networking/s2io.txt
+++ b/Documentation/networking/s2io.txt
@@ -1,48 +1,153 @@
1S2IO Technologies XFrame 10 Gig adapter. 1Release notes for Neterion's (Formerly S2io) Xframe I/II PCI-X 10GbE driver.
2------------------------------------------- 2
3 3Contents
4I. Module loadable parameters. 4=======
5When loaded as a module, the driver provides a host of Module loadable 5- 1. Introduction
6parameters, so the device can be tuned as per the users needs. 6- 2. Identifying the adapter/interface
7A list of the Module params is given below. 7- 3. Features supported
8(i) ring_num: This can be used to program the number of 8- 4. Command line parameters
9 receive rings used in the driver. 9- 5. Performance suggestions
10(ii) ring_len: This defines the number of descriptors each ring 10- 6. Available Downloads
11 can have. There can be a maximum of 8 rings. 11
12(iii) frame_len: This is an array of size 8. Using this we can 12
13 set the maximum size of the received frame that can 131. Introduction:
14 be steered into the corrsponding receive ring. 14This Linux driver supports Neterion's Xframe I PCI-X 1.0 and
15(iv) fifo_num: This defines the number of Tx FIFOs thats used in 15Xframe II PCI-X 2.0 adapters. It supports several features
16 the driver. 16such as jumbo frames, MSI/MSI-X, checksum offloads, TSO, UFO and so on.
17(v) fifo_len: Each element defines the number of 17See below for complete list of features.
18 Tx descriptors that can be associated with each 18All features are supported for both IPv4 and IPv6.
19 corresponding FIFO. There are a maximum of 8 FIFOs. 19
20(vi) tx_prio: This is a bool, if module is loaded with a non-zero 202. Identifying the adapter/interface:
21 value for tx_prio multi FIFO scheme is activated. 21a. Insert the adapter(s) in your system.
22(vii) rx_prio: This is a bool, if module is loaded with a non-zero 22b. Build and load driver
23 value for tx_prio multi RING scheme is activated. 23# insmod s2io.ko
24(viii) latency_timer: The value given against this param will be 24c. View log messages
25 loaded into the latency timer register in PCI Config 25# dmesg | tail -40
26 space, else the register is left with its reset value. 26You will see messages similar to:
27 27eth3: Neterion Xframe I 10GbE adapter (rev 3), Version 2.0.9.1, Intr type INTA
28II. Performance tuning. 28eth4: Neterion Xframe II 10GbE adapter (rev 2), Version 2.0.9.1, Intr type INTA
29 By changing a few sysctl parameters. 29eth4: Device is on 64 bit 133MHz PCIX(M1) bus
30 Copy the following lines into a file and run the following command, 30
31 "sysctl -p <file_name>" 31The above messages identify the adapter type(Xframe I/II), adapter revision,
32### IPV4 specific settings 32driver version, interface name(eth3, eth4), Interrupt type(INTA, MSI, MSI-X).
33net.ipv4.tcp_timestamps = 0 # turns TCP timestamp support off, default 1, reduces CPU use 33In case of Xframe II, the PCI/PCI-X bus width and frequency are displayed
34net.ipv4.tcp_sack = 0 # turn SACK support off, default on 34as well.
35# on systems with a VERY fast bus -> memory interface this is the big gainer 35
36net.ipv4.tcp_rmem = 10000000 10000000 10000000 # sets min/default/max TCP read buffer, default 4096 87380 174760 36To associate an interface with a physical adapter use "ethtool -p <ethX>".
37net.ipv4.tcp_wmem = 10000000 10000000 10000000 # sets min/pressure/max TCP write buffer, default 4096 16384 131072 37The corresponding adapter's LED will blink multiple times.
38net.ipv4.tcp_mem = 10000000 10000000 10000000 # sets min/pressure/max TCP buffer space, default 31744 32256 32768 38
39 393. Features supported:
40### CORE settings (mostly for socket and UDP effect) 40a. Jumbo frames. Xframe I/II supports MTU upto 9600 bytes,
41net.core.rmem_max = 524287 # maximum receive socket buffer size, default 131071 41modifiable using ifconfig command.
42net.core.wmem_max = 524287 # maximum send socket buffer size, default 131071 42
43net.core.rmem_default = 524287 # default receive socket buffer size, default 65535 43b. Offloads. Supports checksum offload(TCP/UDP/IP) on transmit
44net.core.wmem_default = 524287 # default send socket buffer size, default 65535 44and receive, TSO.
45net.core.optmem_max = 524287 # maximum amount of option memory buffers, default 10240 45
46net.core.netdev_max_backlog = 300000 # number of unprocessed input packets before kernel starts dropping them, default 300 46c. Multi-buffer receive mode. Scattering of packet across multiple
47---End of performance tuning file--- 47buffers. Currently driver supports 2-buffer mode which yields
48significant performance improvement on certain platforms(SGI Altix,
49IBM xSeries).
50
51d. MSI/MSI-X. Can be enabled on platforms which support this feature
52(IA64, Xeon) resulting in noticeable performance improvement(upto 7%
53on certain platforms).
54
55e. NAPI. Compile-time option(CONFIG_S2IO_NAPI) for better Rx interrupt
56moderation.
57
58f. Statistics. Comprehensive MAC-level and software statistics displayed
59using "ethtool -S" option.
60
61g. Multi-FIFO/Ring. Supports up to 8 transmit queues and receive rings,
62with multiple steering options.
63
644. Command line parameters
65a. tx_fifo_num
66Number of transmit queues
67Valid range: 1-8
68Default: 1
69
70b. rx_ring_num
71Number of receive rings
72Valid range: 1-8
73Default: 1
74
75c. tx_fifo_len
76Size of each transmit queue
77Valid range: Total length of all queues should not exceed 8192
78Default: 4096
79
80d. rx_ring_sz
81Size of each receive ring(in 4K blocks)
82Valid range: Limited by memory on system
83Default: 30
84
85e. intr_type
86Specifies interrupt type. Possible values 1(INTA), 2(MSI), 3(MSI-X)
87Valid range: 1-3
88Default: 1
89
905. Performance suggestions
91General:
92a. Set MTU to maximum(9000 for switch setup, 9600 in back-to-back configuration)
93b. Set TCP windows size to optimal value.
94For instance, for MTU=1500 a value of 210K has been observed to result in
95good performance.
96# sysctl -w net.ipv4.tcp_rmem="210000 210000 210000"
97# sysctl -w net.ipv4.tcp_wmem="210000 210000 210000"
98For MTU=9000, TCP window size of 10 MB is recommended.
99# sysctl -w net.ipv4.tcp_rmem="10000000 10000000 10000000"
100# sysctl -w net.ipv4.tcp_wmem="10000000 10000000 10000000"
101
102Transmit performance:
103a. By default, the driver respects BIOS settings for PCI bus parameters.
104However, you may want to experiment with PCI bus parameters
105max-split-transactions(MOST) and MMRBC (use setpci command).
106A MOST value of 2 has been found optimal for Opterons and 3 for Itanium.
107It could be different for your hardware.
108Set MMRBC to 4K**.
109
110For example you can set
111For opteron
112#setpci -d 17d5:* 62=1d
113For Itanium
114#setpci -d 17d5:* 62=3d
115
116For detailed description of the PCI registers, please see Xframe User Guide.
117
118b. Ensure Transmit Checksum offload is enabled. Use ethtool to set/verify this
119parameter.
120c. Turn on TSO(using "ethtool -K")
121# ethtool -K <ethX> tso on
122
123Receive performance:
124a. By default, the driver respects BIOS settings for PCI bus parameters.
125However, you may want to set PCI latency timer to 248.
126#setpci -d 17d5:* LATENCY_TIMER=f8
127For detailed description of the PCI registers, please see Xframe User Guide.
128b. Use 2-buffer mode. This results in large performance boost on
129on certain platforms(eg. SGI Altix, IBM xSeries).
130c. Ensure Receive Checksum offload is enabled. Use "ethtool -K ethX" command to
131set/verify this option.
132d. Enable NAPI feature(in kernel configuration Device Drivers ---> Network
133device support ---> Ethernet (10000 Mbit) ---> S2IO 10Gbe Xframe NIC) to
134bring down CPU utilization.
135
136** For AMD opteron platforms with 8131 chipset, MMRBC=1 and MOST=1 are
137recommended as safe parameters.
138For more information, please review the AMD8131 errata at
139http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/26310.pdf
140
1416. Available Downloads
142Neterion "s2io" driver in Red Hat and Suse 2.6-based distributions is kept up
143to date, also the latest "s2io" code (including support for 2.4 kernels) is
144available via "Support" link on the Neterion site: http://www.neterion.com.
145
146For Xframe User Guide (Programming manual), visit ftp site ns1.s2io.com,
147user: linuxdocs password: HALdocs
148
1497. Support
150For further support please contact either your 10GbE Xframe NIC vendor (IBM,
151HP, SGI etc.) or click on the "Support" link on the Neterion site:
152http://www.neterion.com.
48 153
diff --git a/Documentation/networking/vortex.txt b/Documentation/networking/vortex.txt
index 80e1cb19609f..3759acf95b29 100644
--- a/Documentation/networking/vortex.txt
+++ b/Documentation/networking/vortex.txt
@@ -11,7 +11,7 @@ The driver was written by Donald Becker <becker@scyld.com>
11Don is no longer the prime maintainer of this version of the driver. 11Don is no longer the prime maintainer of this version of the driver.
12Please report problems to one or more of: 12Please report problems to one or more of:
13 13
14 Andrew Morton <andrewm@uow.edu.au> 14 Andrew Morton <akpm@osdl.org>
15 Netdev mailing list <netdev@vger.kernel.org> 15 Netdev mailing list <netdev@vger.kernel.org>
16 Linux kernel mailing list <linux-kernel@vger.kernel.org> 16 Linux kernel mailing list <linux-kernel@vger.kernel.org>
17 17
@@ -274,24 +274,24 @@ Details of the device driver implementation are at the top of the source file.
274 274
275Additional documentation is available at Don Becker's Linux Drivers site: 275Additional documentation is available at Don Becker's Linux Drivers site:
276 276
277 http://www.scyld.com/network/vortex.html 277 http://www.scyld.com/vortex.html
278 278
279Donald Becker's driver development site: 279Donald Becker's driver development site:
280 280
281 http://www.scyld.com/network 281 http://www.scyld.com/network.html
282 282
283Donald's vortex-diag program is useful for inspecting the NIC's state: 283Donald's vortex-diag program is useful for inspecting the NIC's state:
284 284
285 http://www.scyld.com/diag/#pci-diags 285 http://www.scyld.com/ethercard_diag.html
286 286
287Donald's mii-diag program may be used for inspecting and manipulating 287Donald's mii-diag program may be used for inspecting and manipulating
288the NIC's Media Independent Interface subsystem: 288the NIC's Media Independent Interface subsystem:
289 289
290 http://www.scyld.com/diag/#mii-diag 290 http://www.scyld.com/ethercard_diag.html#mii-diag
291 291
292Donald's wake-on-LAN page: 292Donald's wake-on-LAN page:
293 293
294 http://www.scyld.com/expert/wake-on-lan.html 294 http://www.scyld.com/wakeonlan.html
295 295
2963Com's documentation for many NICs, including the ones supported by 2963Com's documentation for many NICs, including the ones supported by
297this driver is available at 297this driver is available at
@@ -305,7 +305,7 @@ this driver is available at
305Driver updates and a detailed changelog for the modifications which 305Driver updates and a detailed changelog for the modifications which
306were made for the 2.3/2,4 series kernel is available at 306were made for the 2.3/2,4 series kernel is available at
307 307
308 http://www.uow.edu.au/~andrewm/linux/#3c59x-2.3 308 http://www.zip.com.au/~akpm/linux/#3c59x-bc
309 309
310 310
311Autonegotiation notes 311Autonegotiation notes
@@ -434,8 +434,8 @@ steps you should take:
434 send all logs to the maintainer. 434 send all logs to the maintainer.
435 435
436 3) Download you card's diagnostic tool from Donald 436 3) Download you card's diagnostic tool from Donald
437 Backer's website http://www.scyld.com/diag. Download 437 Becker's website <http://www.scyld.com/ethercard_diag.html>.
438 mii-diag.c as well. Build these. 438 Download mii-diag.c as well. Build these.
439 439
440 a) Run 'vortex-diag -aaee' and 'mii-diag -v' when the card is 440 a) Run 'vortex-diag -aaee' and 'mii-diag -v' when the card is
441 working correctly. Save the output. 441 working correctly. Save the output.
@@ -443,8 +443,8 @@ steps you should take:
443 b) Run the above commands when the card is malfunctioning. Send 443 b) Run the above commands when the card is malfunctioning. Send
444 both sets of output. 444 both sets of output.
445 445
446Finally, please be patient and be prepared to do some work. You may end up working on 446Finally, please be patient and be prepared to do some work. You may
447this problem for a week or more as the maintainer asks more questions, asks for more 447end up working on this problem for a week or more as the maintainer
448tests, asks for patches to be applied, etc. At the end of it all, the problem may even 448asks more questions, asks for more tests, asks for patches to be
449remain unresolved. 449applied, etc. At the end of it all, the problem may even remain
450 450unresolved.