aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/networking
diff options
context:
space:
mode:
authorJames Ketrenos <jketreno@linux.intel.com>2005-11-07 19:56:59 -0500
committerJames Ketrenos <jketreno@linux.intel.com>2005-11-07 19:56:59 -0500
commit826d2abe9945372c8838398bfd88a1caa5844d41 (patch)
tree253d053207da60d8321574291debf159c90f849c /Documentation/networking
parentcf1b479b6922c6736d9f00d90c2b78e977692c93 (diff)
Updated READMEs and MAINTAINERS for the ipw2100 and ipw2200 drivers.
Signed-off-by: James Ketrenos <jketreno@linux.intel.com>
Diffstat (limited to 'Documentation/networking')
-rw-r--r--Documentation/networking/README.ipw2100132
-rw-r--r--Documentation/networking/README.ipw2200196
2 files changed, 254 insertions, 74 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