diff options
Diffstat (limited to 'Documentation/networking')
-rw-r--r-- | Documentation/networking/README.ipw2100 | 132 | ||||
-rw-r--r-- | Documentation/networking/README.ipw2200 | 196 | ||||
-rw-r--r-- | Documentation/networking/bonding.txt | 5 | ||||
-rw-r--r-- | Documentation/networking/dccp.txt | 56 | ||||
-rw-r--r-- | Documentation/networking/decnet.txt | 2 | ||||
-rw-r--r-- | Documentation/networking/driver.txt | 5 | ||||
-rw-r--r-- | Documentation/networking/ifenslave.c | 9 | ||||
-rw-r--r-- | Documentation/networking/ip-sysctl.txt | 17 | ||||
-rw-r--r-- | Documentation/networking/iphase.txt | 2 | ||||
-rw-r--r-- | Documentation/networking/irda.txt | 8 | ||||
-rw-r--r-- | Documentation/networking/ray_cs.txt | 3 | ||||
-rw-r--r-- | Documentation/networking/s2io.txt | 199 | ||||
-rw-r--r-- | Documentation/networking/vortex.txt | 28 |
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 | =========================== | 2 | Intel(R) PRO/Wireless 2100 Driver for Linux in support of: |
3 | Intel(R) PRO/Wireless 2100 Network Connection Driver for Linux | 3 | |
4 | Intel(R) PRO/Wireless 2100 Network Connection | ||
5 | |||
6 | Copyright (C) 2003-2005, Intel Corporation | ||
7 | |||
4 | README.ipw2100 | 8 | README.ipw2100 |
5 | 9 | ||
6 | March 14, 2005 | 10 | Version: 1.1.3 |
11 | Date : October 17, 2005 | ||
7 | 12 | ||
8 | =========================== | ||
9 | Index | 13 | Index |
10 | --------------------------- | 14 | ----------------------------------------------- |
11 | 0. Introduction | 15 | 0. IMPORTANT INFORMATION BEFORE USING THIS DRIVER |
12 | 1. Release 1.1.0 Current Features | 16 | 1. Introduction |
13 | 2. Command Line Parameters | 17 | 2. Release 1.1.3 Current Features |
14 | 3. Sysfs Helper Files | 18 | 3. Command Line Parameters |
15 | 4. Radio Kill Switch | 19 | 4. Sysfs Helper Files |
16 | 5. Dynamic Firmware | 20 | 5. Radio Kill Switch |
17 | 6. Power Management | 21 | 6. Dynamic Firmware |
18 | 7. Support | 22 | 7. Power Management |
19 | 8. License | 23 | 8. Support |
20 | 24 | 9. License | |
21 | 25 | ||
22 | =========================== | 26 | |
23 | 0. Introduction | 27 | 0. IMPORTANT INFORMATION BEFORE USING THIS DRIVER |
24 | ------------ ----- ----- ---- --- -- - | 28 | ----------------------------------------------- |
29 | |||
30 | Important Notice FOR ALL USERS OR DISTRIBUTORS!!!! | ||
31 | |||
32 | Intel wireless LAN adapters are engineered, manufactured, tested, and | ||
33 | quality checked to ensure that they meet all necessary local and | ||
34 | governmental regulatory agency requirements for the regions that they | ||
35 | are designated and/or marked to ship into. Since wireless LANs are | ||
36 | generally unlicensed devices that share spectrum with radars, | ||
37 | satellites, and other licensed and unlicensed devices, it is sometimes | ||
38 | necessary to dynamically detect, avoid, and limit usage to avoid | ||
39 | interference with these devices. In many instances Intel is required to | ||
40 | provide test data to prove regional and local compliance to regional and | ||
41 | governmental regulations before certification or approval to use the | ||
42 | product is granted. Intel's wireless LAN's EEPROM, firmware, and | ||
43 | software driver are designed to carefully control parameters that affect | ||
44 | radio operation and to ensure electromagnetic compliance (EMC). These | ||
45 | parameters include, without limitation, RF power, spectrum usage, | ||
46 | channel scanning, and human exposure. | ||
47 | |||
48 | For these reasons Intel cannot permit any manipulation by third parties | ||
49 | of the software provided in binary format with the wireless WLAN | ||
50 | adapters (e.g., the EEPROM and firmware). Furthermore, if you use any | ||
51 | patches, utilities, or code with the Intel wireless LAN adapters that | ||
52 | have been manipulated by an unauthorized party (i.e., patches, | ||
53 | utilities, or code (including open source code modifications) which have | ||
54 | not been validated by Intel), (i) you will be solely responsible for | ||
55 | ensuring the regulatory compliance of the products, (ii) Intel will bear | ||
56 | no liability, under any theory of liability for any issues associated | ||
57 | with the modified products, including without limitation, claims under | ||
58 | the warranty and/or issues arising from regulatory non-compliance, and | ||
59 | (iii) Intel will not provide or be required to assist in providing | ||
60 | support to any third parties for such modified products. | ||
61 | |||
62 | Note: Many regulatory agencies consider Wireless LAN adapters to be | ||
63 | modules, and accordingly, condition system-level regulatory approval | ||
64 | upon receipt and review of test data documenting that the antennas and | ||
65 | system configuration do not cause the EMC and radio operation to be | ||
66 | non-compliant. | ||
67 | |||
68 | The drivers available for download from SourceForge are provided as a | ||
69 | part of a development project. Conformance to local regulatory | ||
70 | requirements is the responsibility of the individual developer. As | ||
71 | such, if you are interested in deploying or shipping a driver as part of | ||
72 | solution intended to be used for purposes other than development, please | ||
73 | obtain a tested driver from Intel Customer Support at: | ||
74 | |||
75 | http://support.intel.com/support/notebook/sb/CS-006408.htm | ||
76 | |||
77 | |||
78 | 1. Introduction | ||
79 | ----------------------------------------------- | ||
25 | 80 | ||
26 | This document provides a brief overview of the features supported by the | 81 | This document provides a brief overview of the features supported by the |
27 | IPW2100 driver project. The main project website, where the latest | 82 | IPW2100 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 | |||
34 | for the driver project. | 89 | for the driver project. |
35 | 90 | ||
36 | 91 | ||
37 | =========================== | 92 | 2. Release 1.1.3 Current Supported Features |
38 | 1. 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 | |||
51 | performed on a given feature. | 105 | performed on a given feature. |
52 | 106 | ||
53 | 107 | ||
54 | =========================== | 108 | 3. Command Line Parameters |
55 | 2. Command Line Parameters | 109 | ----------------------------------------------- |
56 | --------------------------- | ||
57 | 110 | ||
58 | If the driver is built as a module, the following optional parameters are used | 111 | If the driver is built as a module, the following optional parameters are used |
59 | by entering them on the command line with the modprobe command using this | 112 | by entering them on the command line with the modprobe command using this |
@@ -75,9 +128,9 @@ associate boolean associate=0 /* Do NOT auto associate */ | |||
75 | disable boolean disable=1 /* Do not power the HW */ | 128 | disable boolean disable=1 /* Do not power the HW */ |
76 | 129 | ||
77 | 130 | ||
78 | =========================== | 131 | 4. Sysfs Helper Files |
79 | 3. Sysfs Helper Files | ||
80 | --------------------------- | 132 | --------------------------- |
133 | ----------------------------------------------- | ||
81 | 134 | ||
82 | There are several ways to control the behavior of the driver. Many of the | 135 | There are several ways to control the behavior of the driver. Many of the |
83 | general capabilities are exposed through the Wireless Tools (iwconfig). There | 136 | general 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 | =========================== | 176 | 5. Radio Kill Switch |
124 | 4. Radio Kill Switch | 177 | ----------------------------------------------- |
125 | --------------------------- | ||
126 | Most laptops provide the ability for the user to physically disable the radio. | 178 | Most laptops provide the ability for the user to physically disable the radio. |
127 | Some vendors have implemented this as a physical switch that requires no | 179 | Some vendors have implemented this as a physical switch that requires no |
128 | software to turn the radio off and on. On other laptops, however, the switch | 180 | software 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 | |||
134 | on your system. | 186 | on your system. |
135 | 187 | ||
136 | 188 | ||
137 | =========================== | 189 | 6. Dynamic Firmware |
138 | 5. Dynamic Firmware | 190 | ----------------------------------------------- |
139 | --------------------------- | ||
140 | As the firmware is licensed under a restricted use license, it can not be | 191 | As the firmware is licensed under a restricted use license, it can not be |
141 | included within the kernel sources. To enable the IPW2100 you will need a | 192 | included within the kernel sources. To enable the IPW2100 you will need a |
142 | firmware image to load into the wireless NIC's processors. | 193 | firmware 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>. | |||
146 | See INSTALL for instructions on installing the firmware. | 197 | See INSTALL for instructions on installing the firmware. |
147 | 198 | ||
148 | 199 | ||
149 | =========================== | 200 | 7. Power Management |
150 | 6. Power Management | 201 | ----------------------------------------------- |
151 | --------------------------- | ||
152 | The IPW2100 supports the configuration of the Power Save Protocol | 202 | The IPW2100 supports the configuration of the Power Save Protocol |
153 | through a private wireless extension interface. The IPW2100 supports | 203 | through a private wireless extension interface. The IPW2100 supports |
154 | the following different modes: | 204 | the following different modes: |
@@ -200,9 +250,8 @@ xxxx/yyyy will be replaced with 'off' -- the level reported will be the active | |||
200 | level if `iwconfig eth1 power on` is invoked. | 250 | level if `iwconfig eth1 power on` is invoked. |
201 | 251 | ||
202 | 252 | ||
203 | =========================== | 253 | 8. Support |
204 | 7. Support | 254 | ----------------------------------------------- |
205 | --------------------------- | ||
206 | 255 | ||
207 | For general development information and support, | 256 | For general development information and support, |
208 | go to: | 257 | go 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 | =========================== | 270 | 9. License |
222 | 8. 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 | ||
2 | Intel(R) PRO/Wireless 2915ABG Driver for Linux in support of: | 2 | Intel(R) PRO/Wireless 2915ABG Driver for Linux in support of: |
3 | 3 | ||
4 | Intel(R) PRO/Wireless 2200BG Network Connection | 4 | Intel(R) PRO/Wireless 2200BG Network Connection |
5 | Intel(R) PRO/Wireless 2915ABG Network Connection | 5 | Intel(R) PRO/Wireless 2915ABG Network Connection |
6 | 6 | ||
7 | Note: The Intel(R) PRO/Wireless 2915ABG Driver for Linux and Intel(R) | 7 | Note: The Intel(R) PRO/Wireless 2915ABG Driver for Linux and Intel(R) |
8 | PRO/Wireless 2200BG Driver for Linux is a unified driver that works on | 8 | PRO/Wireless 2200BG Driver for Linux is a unified driver that works on |
9 | both hardware adapters listed above. In this document the Intel(R) | 9 | both hardware adapters listed above. In this document the Intel(R) |
10 | PRO/Wireless 2915ABG Driver for Linux will be used to reference the | 10 | PRO/Wireless 2915ABG Driver for Linux will be used to reference the |
11 | unified driver. | 11 | unified driver. |
12 | 12 | ||
13 | Copyright (C) 2004-2005, Intel Corporation | 13 | Copyright (C) 2004-2005, Intel Corporation |
14 | 14 | ||
15 | README.ipw2200 | 15 | README.ipw2200 |
16 | 16 | ||
17 | Version: 1.0.0 | 17 | Version: 1.0.8 |
18 | Date : January 31, 2005 | 18 | Date : October 20, 2005 |
19 | 19 | ||
20 | 20 | ||
21 | Index | 21 | Index |
22 | ----------------------------------------------- | 22 | ----------------------------------------------- |
23 | 0. IMPORTANT INFORMATION BEFORE USING THIS DRIVER | ||
23 | 1. Introduction | 24 | 1. Introduction |
24 | 1.1. Overview of features | 25 | 1.1. Overview of features |
25 | 1.2. Module parameters | 26 | 1.2. Module parameters |
26 | 1.3. Wireless Extension Private Methods | 27 | 1.3. Wireless Extension Private Methods |
27 | 1.4. Sysfs Helper Files | 28 | 1.4. Sysfs Helper Files |
28 | 2. About the Version Numbers | 29 | 2. Ad-Hoc Networking |
29 | 3. Support | 30 | 3. Interacting with Wireless Tools |
30 | 4. License | 31 | 3.1. iwconfig mode |
32 | 4. About the Version Numbers | ||
33 | 5. Firmware installation | ||
34 | 6. Support | ||
35 | 7. License | ||
36 | |||
37 | |||
38 | 0. IMPORTANT INFORMATION BEFORE USING THIS DRIVER | ||
39 | ----------------------------------------------- | ||
40 | |||
41 | Important Notice FOR ALL USERS OR DISTRIBUTORS!!!! | ||
42 | |||
43 | Intel wireless LAN adapters are engineered, manufactured, tested, and | ||
44 | quality checked to ensure that they meet all necessary local and | ||
45 | governmental regulatory agency requirements for the regions that they | ||
46 | are designated and/or marked to ship into. Since wireless LANs are | ||
47 | generally unlicensed devices that share spectrum with radars, | ||
48 | satellites, and other licensed and unlicensed devices, it is sometimes | ||
49 | necessary to dynamically detect, avoid, and limit usage to avoid | ||
50 | interference with these devices. In many instances Intel is required to | ||
51 | provide test data to prove regional and local compliance to regional and | ||
52 | governmental regulations before certification or approval to use the | ||
53 | product is granted. Intel's wireless LAN's EEPROM, firmware, and | ||
54 | software driver are designed to carefully control parameters that affect | ||
55 | radio operation and to ensure electromagnetic compliance (EMC). These | ||
56 | parameters include, without limitation, RF power, spectrum usage, | ||
57 | channel scanning, and human exposure. | ||
58 | |||
59 | For these reasons Intel cannot permit any manipulation by third parties | ||
60 | of the software provided in binary format with the wireless WLAN | ||
61 | adapters (e.g., the EEPROM and firmware). Furthermore, if you use any | ||
62 | patches, utilities, or code with the Intel wireless LAN adapters that | ||
63 | have been manipulated by an unauthorized party (i.e., patches, | ||
64 | utilities, or code (including open source code modifications) which have | ||
65 | not been validated by Intel), (i) you will be solely responsible for | ||
66 | ensuring the regulatory compliance of the products, (ii) Intel will bear | ||
67 | no liability, under any theory of liability for any issues associated | ||
68 | with the modified products, including without limitation, claims under | ||
69 | the warranty and/or issues arising from regulatory non-compliance, and | ||
70 | (iii) Intel will not provide or be required to assist in providing | ||
71 | support to any third parties for such modified products. | ||
72 | |||
73 | Note: Many regulatory agencies consider Wireless LAN adapters to be | ||
74 | modules, and accordingly, condition system-level regulatory approval | ||
75 | upon receipt and review of test data documenting that the antennas and | ||
76 | system configuration do not cause the EMC and radio operation to be | ||
77 | non-compliant. | ||
78 | |||
79 | The drivers available for download from SourceForge are provided as a | ||
80 | part of a development project. Conformance to local regulatory | ||
81 | requirements is the responsibility of the individual developer. As | ||
82 | such, if you are interested in deploying or shipping a driver as part of | ||
83 | solution intended to be used for purposes other than development, please | ||
84 | obtain a tested driver from Intel Customer Support at: | ||
85 | |||
86 | http://support.intel.com/support/notebook/sb/CS-006408.htm | ||
31 | 87 | ||
32 | 88 | ||
33 | 1. Introduction | 89 | 1. Introduction |
@@ -45,7 +101,7 @@ file. | |||
45 | 101 | ||
46 | 1.1. Overview of Features | 102 | 1.1. Overview of Features |
47 | ----------------------------------------------- | 103 | ----------------------------------------------- |
48 | The current release (1.0.0) supports the following features: | 104 | The 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 | |||
116 | The following features are currently enabled, but not officially | ||
117 | supported: | ||
118 | |||
119 | + WPA | ||
59 | + long/short preamble support | 120 | + long/short preamble support |
121 | + Monitor mode (aka RFMon) | ||
122 | |||
123 | The distinction between officially supported and enabled is a reflection | ||
124 | on the amount of validation and interoperability testing that has been | ||
125 | performed on a given feature. | ||
60 | 126 | ||
61 | 127 | ||
62 | 128 | ||
63 | 1.2. Command Line Parameters | 129 | 1.2. Command Line Parameters |
64 | ----------------------------------------------- | 130 | ----------------------------------------------- |
65 | 131 | ||
66 | Like many modules used in the Linux kernel, the Intel(R) PRO/Wireless | 132 | Like many modules used in the Linux kernel, the Intel(R) PRO/Wireless |
67 | 2915ABG Driver for Linux allows certain configuration options to be | 133 | 2915ABG Driver for Linux allows configuration options to be provided |
68 | provided as module parameters. The most common way to specify a module | 134 | as module parameters. The most common way to specify a module parameter |
69 | parameter is via the command line. | 135 | is via the command line. |
70 | 136 | ||
71 | The general form is: | 137 | The 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 | ||
109 | 1.3. Wireless Extension Private Methods | 179 | 1.3. Wireless Extension Private Methods |
@@ -164,8 +234,8 @@ The supported private methods are: | |||
164 | ----------------------------------------------- | 234 | ----------------------------------------------- |
165 | 235 | ||
166 | The Linux kernel provides a pseudo file system that can be used to | 236 | The Linux kernel provides a pseudo file system that can be used to |
167 | access various components of the operating system. The Intel(R) | 237 | access various components of the operating system. The Intel(R) |
168 | PRO/Wireless 2915ABG Driver for Linux exposes several configuration | 238 | PRO/Wireless 2915ABG Driver for Linux exposes several configuration |
169 | parameters through this mechanism. | 239 | parameters through this mechanism. |
170 | 240 | ||
171 | An entry in the sysfs can support reading and/or writing. You can | 241 | An 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 | ||
185 | Where $VALUE would be a number in the case of this sysfs entry. The | 255 | Where $VALUE would be a number in the case of this sysfs entry. The |
186 | input to sysfs files does not have to be a number. For example, the | 256 | input to sysfs files does not have to be a number. For example, the |
187 | firmware loader used by hotplug utilizes sysfs entries for transferring | 257 | firmware loader used by hotplug utilizes sysfs entries for transfering |
188 | the firmware image from user space into the driver. | 258 | the firmware image from user space into the driver. |
189 | 259 | ||
190 | The Intel(R) PRO/Wireless 2915ABG Driver for Linux exposes sysfs entries | 260 | The Intel(R) PRO/Wireless 2915ABG Driver for Linux exposes sysfs entries |
191 | at two levels -- driver level, which apply to all instances of the | 261 | at two levels -- driver level, which apply to all instances of the driver |
192 | driver (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 |
193 | device level, which applies only to the single specific instance. | 263 | level, which applies only to the single specific instance. |
194 | 264 | ||
195 | 265 | ||
196 | 1.4.1 Driver Level Sysfs Helper Files | 266 | 1.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 | |||
206 | 1.4.2 Device Level Sysfs Helper Files | 277 | 1.4.2 Device Level Sysfs Helper Files |
207 | ----------------------------------------------- | 278 | ----------------------------------------------- |
208 | 279 | ||
@@ -213,7 +284,7 @@ For the device level files, look in | |||
213 | For example: | 284 | For example: |
214 | /sys/bus/pci/drivers/ipw2200/0000:02:01.0 | 285 | /sys/bus/pci/drivers/ipw2200/0000:02:01.0 |
215 | 286 | ||
216 | For the device level files, see /sys/bus/pci/[drivers/ipw2200: | 287 | For 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 | |||
317 | 2. Ad-Hoc Networking | ||
318 | ----------------------------------------------- | ||
319 | |||
320 | When using a device in an Ad-Hoc network, it is useful to understand the | ||
321 | sequence and requirements for the driver to be able to create, join, or | ||
322 | merge networks. | ||
323 | |||
324 | The following attempts to provide enough information so that you can | ||
325 | have a consistent experience while using the driver as a member of an | ||
326 | Ad-Hoc network. | ||
327 | |||
328 | 2.1. Joining an Ad-Hoc Network | ||
329 | ----------------------------------------------- | ||
330 | |||
331 | The easiest way to get onto an Ad-Hoc network is to join one that | ||
332 | already exists. | ||
234 | 333 | ||
235 | 2. About the Version Numbers | 334 | 2.2. Creating an Ad-Hoc Network |
335 | ----------------------------------------------- | ||
336 | |||
337 | An Ad-Hoc networks is created using the syntax of the Wireless tool. | ||
338 | |||
339 | For Example: | ||
340 | iwconfig eth1 mode ad-hoc essid testing channel 2 | ||
341 | |||
342 | 2.3. Merging Ad-Hoc Networks | ||
343 | ----------------------------------------------- | ||
344 | |||
345 | |||
346 | 3. Interaction with Wireless Tools | ||
347 | ----------------------------------------------- | ||
348 | |||
349 | 3.1 iwconfig mode | ||
350 | ----------------------------------------------- | ||
351 | |||
352 | When configuring the mode of the adapter, all run-time configured parameters | ||
353 | are reset to the value used when the module was loaded. This includes | ||
354 | channels, rates, ESSID, etc. | ||
355 | |||
356 | |||
357 | 4. About the Version Numbers | ||
236 | ----------------------------------------------- | 358 | ----------------------------------------------- |
237 | 359 | ||
238 | Due to the nature of open source development projects, there are | 360 | Due to the nature of open source development projects, there are |
@@ -259,12 +381,23 @@ available as quickly as possible, unknown anomalies should be expected. | |||
259 | The major version number will be incremented when significant changes | 381 | The major version number will be incremented when significant changes |
260 | are made to the driver. Currently, there are no major changes planned. | 382 | are made to the driver. Currently, there are no major changes planned. |
261 | 383 | ||
384 | 5. Firmware installation | ||
385 | ---------------------------------------------- | ||
386 | |||
387 | The driver requires a firmware image, download it and extract the | ||
388 | files under /lib/firmware (or wherever your hotplug's firmware.agent | ||
389 | will look for firmware files) | ||
390 | |||
391 | The firmware can be downloaded from the following URL: | ||
262 | 392 | ||
263 | 3. Support | 393 | http://ipw2200.sf.net/ |
394 | |||
395 | |||
396 | 6. Support | ||
264 | ----------------------------------------------- | 397 | ----------------------------------------------- |
265 | 398 | ||
266 | For installation support of the 1.0.0 version, you can contact | 399 | For direct support of the 1.0.0 version, you can contact |
267 | http://supportmail.intel.com, or you can use the open source project | 400 | http://supportmail.intel.com, or you can use the open source project |
268 | support. | 401 | support. |
269 | 402 | ||
270 | For general information and support, go to: | 403 | For 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 | ||
275 | 4. License | 408 | 7. 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 | |||
777 | Manually" section, below. | 777 | Manually" 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 |
780 | are apparently unable to rename modules at load time (the "-obonding1" | 780 | are apparently unable to rename modules at load time (the "-o bond1" |
781 | part). Attempts to pass that option to modprobe will produce an | 781 | part). 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 |
783 | Fedora Core kernels, and has been seen on RHEL 4 as well. On kernels | 783 | Fedora 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 | |||
883 | its options. In that case, the second options line can be substituted | 883 | its options. In that case, the second options line can be substituted |
884 | as follows: | 884 | as follows: |
885 | 885 | ||
886 | install bonding1 /sbin/modprobe bonding -obond1 mode=balance-alb miimon=50 | 886 | install 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 |
889 | unique name in place of bond1 for each subsequent instance. | 890 | unique 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 @@ | |||
1 | DCCP protocol | ||
2 | ============ | ||
3 | |||
4 | Last updated: 10 November 2005 | ||
5 | |||
6 | Contents | ||
7 | ======== | ||
8 | |||
9 | - Introduction | ||
10 | - Missing features | ||
11 | - Socket options | ||
12 | - Notes | ||
13 | |||
14 | Introduction | ||
15 | ============ | ||
16 | |||
17 | Datagram Congestion Control Protocol (DCCP) is an unreliable, connection | ||
18 | based protocol designed to solve issues present in UDP and TCP particularly | ||
19 | for real time and multimedia traffic. | ||
20 | |||
21 | It has a base protocol and pluggable congestion control IDs (CCIDs). | ||
22 | |||
23 | It is at draft RFC status and the homepage for DCCP as a protocol is at: | ||
24 | http://www.icir.org/kohler/dcp/ | ||
25 | |||
26 | Missing features | ||
27 | ================ | ||
28 | |||
29 | The DCCP implementation does not currently have all the features that are in | ||
30 | the draft RFC. | ||
31 | |||
32 | In particular the following are missing: | ||
33 | - CCID2 support | ||
34 | - feature negotiation | ||
35 | |||
36 | When testing against other implementations it appears that elapsed time | ||
37 | options are not coded compliant to the specification. | ||
38 | |||
39 | Socket options | ||
40 | ============== | ||
41 | |||
42 | DCCP_SOCKOPT_PACKET_SIZE is used for CCID3 to set default packet size for | ||
43 | calculations. | ||
44 | |||
45 | DCCP_SOCKOPT_SERVICE sets the service. This is compulsory as per the | ||
46 | specification. If you don't set it you will get EPROTO. | ||
47 | |||
48 | Notes | ||
49 | ===== | ||
50 | |||
51 | SELinux does not yet have support for DCCP. You will need to turn it off or | ||
52 | else you will get EACCES. | ||
53 | |||
54 | DCCP does not travel through NAT successfully at present. This is because | ||
55 | the checksum covers the psuedo-header as per TCP and UDP. It should be | ||
56 | relatively 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 @@ | |||
1 | Documents about softnet driver issues in general can be found | 1 | Document about softnet driver issues |
2 | at: | ||
3 | |||
4 | http://www.firstfloor.org/~andi/softnet/ | ||
5 | 2 | ||
6 | Transmit path guidelines: | 3 | Transmit 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 | ||
79 | TCP variables: | 79 | TCP variables: |
80 | 80 | ||
81 | tcp_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 | |||
81 | tcp_syn_retries - INTEGER | 86 | tcp_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 | ||
314 | tcp_frto - BOOLEAN | 319 | tcp_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 | ||
357 | icmp_echo_ignore_all - BOOLEAN | 362 | icmp_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 | |||
358 | icmp_echo_ignore_broadcasts - BOOLEAN | 367 | icmp_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 | ||
363 | icmp_ratelimit - INTEGER | 372 | icmp_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 | |||
3 | programs can be found on http://irda.sourceforge.net/ | 3 | programs can be found on http://irda.sourceforge.net/ |
4 | 4 | ||
5 | For more information about how to use the IrDA protocol stack, see the | 5 | For more information about how to use the IrDA protocol stack, see the |
6 | Linux Infared HOWTO (http://www.tuxmobil.org/Infrared-HOWTO/Infrared-HOWTO.html) | 6 | Linux Infrared HOWTO by Werner Heuser <wehe@tuxmobil.org>: |
7 | by Werner Heuser <wehe@tuxmobil.org> | 7 | <http://www.tuxmobil.org/Infrared-HOWTO/Infrared-HOWTO.html> |
8 | 8 | ||
9 | There is an active mailing list for discussing Linux-IrDA matters called | 9 | There 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 | |||
29 | will find them all. | 29 | will find them all. |
30 | 30 | ||
31 | Information on card services is available at: | 31 | Information 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 | ||
36 | Card services user programs are still required for PCMCIA devices. | 35 | Card 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 @@ | |||
1 | S2IO Technologies XFrame 10 Gig adapter. | 1 | Release notes for Neterion's (Formerly S2io) Xframe I/II PCI-X 10GbE driver. |
2 | ------------------------------------------- | 2 | |
3 | 3 | Contents | |
4 | I. Module loadable parameters. | 4 | ======= |
5 | When loaded as a module, the driver provides a host of Module loadable | 5 | - 1. Introduction |
6 | parameters, so the device can be tuned as per the users needs. | 6 | - 2. Identifying the adapter/interface |
7 | A 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 | 13 | 1. Introduction: |
14 | be steered into the corrsponding receive ring. | 14 | This 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 | 15 | Xframe II PCI-X 2.0 adapters. It supports several features |
16 | the driver. | 16 | such as jumbo frames, MSI/MSI-X, checksum offloads, TSO, UFO and so on. |
17 | (v) fifo_len: Each element defines the number of | 17 | See below for complete list of features. |
18 | Tx descriptors that can be associated with each | 18 | All 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 | 20 | 2. Identifying the adapter/interface: |
21 | value for tx_prio multi FIFO scheme is activated. | 21 | a. Insert the adapter(s) in your system. |
22 | (vii) rx_prio: This is a bool, if module is loaded with a non-zero | 22 | b. 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 | 24 | c. 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. | 26 | You will see messages similar to: |
27 | 27 | eth3: Neterion Xframe I 10GbE adapter (rev 3), Version 2.0.9.1, Intr type INTA | |
28 | II. Performance tuning. | 28 | eth4: Neterion Xframe II 10GbE adapter (rev 2), Version 2.0.9.1, Intr type INTA |
29 | By changing a few sysctl parameters. | 29 | eth4: 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>" | 31 | The above messages identify the adapter type(Xframe I/II), adapter revision, |
32 | ### IPV4 specific settings | 32 | driver version, interface name(eth3, eth4), Interrupt type(INTA, MSI, MSI-X). |
33 | net.ipv4.tcp_timestamps = 0 # turns TCP timestamp support off, default 1, reduces CPU use | 33 | In case of Xframe II, the PCI/PCI-X bus width and frequency are displayed |
34 | net.ipv4.tcp_sack = 0 # turn SACK support off, default on | 34 | as well. |
35 | # on systems with a VERY fast bus -> memory interface this is the big gainer | 35 | |
36 | net.ipv4.tcp_rmem = 10000000 10000000 10000000 # sets min/default/max TCP read buffer, default 4096 87380 174760 | 36 | To associate an interface with a physical adapter use "ethtool -p <ethX>". |
37 | net.ipv4.tcp_wmem = 10000000 10000000 10000000 # sets min/pressure/max TCP write buffer, default 4096 16384 131072 | 37 | The corresponding adapter's LED will blink multiple times. |
38 | net.ipv4.tcp_mem = 10000000 10000000 10000000 # sets min/pressure/max TCP buffer space, default 31744 32256 32768 | 38 | |
39 | 39 | 3. Features supported: | |
40 | ### CORE settings (mostly for socket and UDP effect) | 40 | a. Jumbo frames. Xframe I/II supports MTU upto 9600 bytes, |
41 | net.core.rmem_max = 524287 # maximum receive socket buffer size, default 131071 | 41 | modifiable using ifconfig command. |
42 | net.core.wmem_max = 524287 # maximum send socket buffer size, default 131071 | 42 | |
43 | net.core.rmem_default = 524287 # default receive socket buffer size, default 65535 | 43 | b. Offloads. Supports checksum offload(TCP/UDP/IP) on transmit |
44 | net.core.wmem_default = 524287 # default send socket buffer size, default 65535 | 44 | and receive, TSO. |
45 | net.core.optmem_max = 524287 # maximum amount of option memory buffers, default 10240 | 45 | |
46 | net.core.netdev_max_backlog = 300000 # number of unprocessed input packets before kernel starts dropping them, default 300 | 46 | c. Multi-buffer receive mode. Scattering of packet across multiple |
47 | ---End of performance tuning file--- | 47 | buffers. Currently driver supports 2-buffer mode which yields |
48 | significant performance improvement on certain platforms(SGI Altix, | ||
49 | IBM xSeries). | ||
50 | |||
51 | d. MSI/MSI-X. Can be enabled on platforms which support this feature | ||
52 | (IA64, Xeon) resulting in noticeable performance improvement(upto 7% | ||
53 | on certain platforms). | ||
54 | |||
55 | e. NAPI. Compile-time option(CONFIG_S2IO_NAPI) for better Rx interrupt | ||
56 | moderation. | ||
57 | |||
58 | f. Statistics. Comprehensive MAC-level and software statistics displayed | ||
59 | using "ethtool -S" option. | ||
60 | |||
61 | g. Multi-FIFO/Ring. Supports up to 8 transmit queues and receive rings, | ||
62 | with multiple steering options. | ||
63 | |||
64 | 4. Command line parameters | ||
65 | a. tx_fifo_num | ||
66 | Number of transmit queues | ||
67 | Valid range: 1-8 | ||
68 | Default: 1 | ||
69 | |||
70 | b. rx_ring_num | ||
71 | Number of receive rings | ||
72 | Valid range: 1-8 | ||
73 | Default: 1 | ||
74 | |||
75 | c. tx_fifo_len | ||
76 | Size of each transmit queue | ||
77 | Valid range: Total length of all queues should not exceed 8192 | ||
78 | Default: 4096 | ||
79 | |||
80 | d. rx_ring_sz | ||
81 | Size of each receive ring(in 4K blocks) | ||
82 | Valid range: Limited by memory on system | ||
83 | Default: 30 | ||
84 | |||
85 | e. intr_type | ||
86 | Specifies interrupt type. Possible values 1(INTA), 2(MSI), 3(MSI-X) | ||
87 | Valid range: 1-3 | ||
88 | Default: 1 | ||
89 | |||
90 | 5. Performance suggestions | ||
91 | General: | ||
92 | a. Set MTU to maximum(9000 for switch setup, 9600 in back-to-back configuration) | ||
93 | b. Set TCP windows size to optimal value. | ||
94 | For instance, for MTU=1500 a value of 210K has been observed to result in | ||
95 | good performance. | ||
96 | # sysctl -w net.ipv4.tcp_rmem="210000 210000 210000" | ||
97 | # sysctl -w net.ipv4.tcp_wmem="210000 210000 210000" | ||
98 | For 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 | |||
102 | Transmit performance: | ||
103 | a. By default, the driver respects BIOS settings for PCI bus parameters. | ||
104 | However, you may want to experiment with PCI bus parameters | ||
105 | max-split-transactions(MOST) and MMRBC (use setpci command). | ||
106 | A MOST value of 2 has been found optimal for Opterons and 3 for Itanium. | ||
107 | It could be different for your hardware. | ||
108 | Set MMRBC to 4K**. | ||
109 | |||
110 | For example you can set | ||
111 | For opteron | ||
112 | #setpci -d 17d5:* 62=1d | ||
113 | For Itanium | ||
114 | #setpci -d 17d5:* 62=3d | ||
115 | |||
116 | For detailed description of the PCI registers, please see Xframe User Guide. | ||
117 | |||
118 | b. Ensure Transmit Checksum offload is enabled. Use ethtool to set/verify this | ||
119 | parameter. | ||
120 | c. Turn on TSO(using "ethtool -K") | ||
121 | # ethtool -K <ethX> tso on | ||
122 | |||
123 | Receive performance: | ||
124 | a. By default, the driver respects BIOS settings for PCI bus parameters. | ||
125 | However, you may want to set PCI latency timer to 248. | ||
126 | #setpci -d 17d5:* LATENCY_TIMER=f8 | ||
127 | For detailed description of the PCI registers, please see Xframe User Guide. | ||
128 | b. Use 2-buffer mode. This results in large performance boost on | ||
129 | on certain platforms(eg. SGI Altix, IBM xSeries). | ||
130 | c. Ensure Receive Checksum offload is enabled. Use "ethtool -K ethX" command to | ||
131 | set/verify this option. | ||
132 | d. Enable NAPI feature(in kernel configuration Device Drivers ---> Network | ||
133 | device support ---> Ethernet (10000 Mbit) ---> S2IO 10Gbe Xframe NIC) to | ||
134 | bring down CPU utilization. | ||
135 | |||
136 | ** For AMD opteron platforms with 8131 chipset, MMRBC=1 and MOST=1 are | ||
137 | recommended as safe parameters. | ||
138 | For more information, please review the AMD8131 errata at | ||
139 | http://www.amd.com/us-en/assets/content_type/white_papers_and_tech_docs/26310.pdf | ||
140 | |||
141 | 6. Available Downloads | ||
142 | Neterion "s2io" driver in Red Hat and Suse 2.6-based distributions is kept up | ||
143 | to date, also the latest "s2io" code (including support for 2.4 kernels) is | ||
144 | available via "Support" link on the Neterion site: http://www.neterion.com. | ||
145 | |||
146 | For Xframe User Guide (Programming manual), visit ftp site ns1.s2io.com, | ||
147 | user: linuxdocs password: HALdocs | ||
148 | |||
149 | 7. Support | ||
150 | For further support please contact either your 10GbE Xframe NIC vendor (IBM, | ||
151 | HP, SGI etc.) or click on the "Support" link on the Neterion site: | ||
152 | http://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> | |||
11 | Don is no longer the prime maintainer of this version of the driver. | 11 | Don is no longer the prime maintainer of this version of the driver. |
12 | Please report problems to one or more of: | 12 | Please 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 | ||
275 | Additional documentation is available at Don Becker's Linux Drivers site: | 275 | Additional 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 | ||
279 | Donald Becker's driver development site: | 279 | Donald Becker's driver development site: |
280 | 280 | ||
281 | http://www.scyld.com/network | 281 | http://www.scyld.com/network.html |
282 | 282 | ||
283 | Donald's vortex-diag program is useful for inspecting the NIC's state: | 283 | Donald'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 | ||
287 | Donald's mii-diag program may be used for inspecting and manipulating | 287 | Donald's mii-diag program may be used for inspecting and manipulating |
288 | the NIC's Media Independent Interface subsystem: | 288 | the 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 | ||
292 | Donald's wake-on-LAN page: | 292 | Donald'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 | ||
296 | 3Com's documentation for many NICs, including the ones supported by | 296 | 3Com's documentation for many NICs, including the ones supported by |
297 | this driver is available at | 297 | this driver is available at |
@@ -305,7 +305,7 @@ this driver is available at | |||
305 | Driver updates and a detailed changelog for the modifications which | 305 | Driver updates and a detailed changelog for the modifications which |
306 | were made for the 2.3/2,4 series kernel is available at | 306 | were 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 | ||
311 | Autonegotiation notes | 311 | Autonegotiation 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 | ||
446 | Finally, please be patient and be prepared to do some work. You may end up working on | 446 | Finally, please be patient and be prepared to do some work. You may |
447 | this problem for a week or more as the maintainer asks more questions, asks for more | 447 | end up working on this problem for a week or more as the maintainer |
448 | tests, asks for patches to be applied, etc. At the end of it all, the problem may even | 448 | asks more questions, asks for more tests, asks for patches to be |
449 | remain unresolved. | 449 | applied, etc. At the end of it all, the problem may even remain |
450 | 450 | unresolved. | |