324 lines · plain
1.. SPDX-License-Identifier: GPL-2.02.. include:: <isonum.txt>3 4===========================================5Intel(R) PRO/Wireless 2100 Driver for Linux6===========================================7 8Support for:9 10- Intel(R) PRO/Wireless 2100 Network Connection11 12Copyright |copy| 2003-2006, Intel Corporation13 14README.ipw210015 16:Version: git-1.1.517:Date: January 25, 200618 19.. Index20 21 0. IMPORTANT INFORMATION BEFORE USING THIS DRIVER22 1. Introduction23 2. Release git-1.1.5 Current Features24 3. Command Line Parameters25 4. Sysfs Helper Files26 5. Radio Kill Switch27 6. Dynamic Firmware28 7. Power Management29 8. Support30 9. License31 32 330. IMPORTANT INFORMATION BEFORE USING THIS DRIVER34=================================================35 36Important Notice FOR ALL USERS OR DISTRIBUTORS!!!!37 38Intel wireless LAN adapters are engineered, manufactured, tested, and39quality checked to ensure that they meet all necessary local and40governmental regulatory agency requirements for the regions that they41are designated and/or marked to ship into. Since wireless LANs are42generally unlicensed devices that share spectrum with radars,43satellites, and other licensed and unlicensed devices, it is sometimes44necessary to dynamically detect, avoid, and limit usage to avoid45interference with these devices. In many instances Intel is required to46provide test data to prove regional and local compliance to regional and47governmental regulations before certification or approval to use the48product is granted. Intel's wireless LAN's EEPROM, firmware, and49software driver are designed to carefully control parameters that affect50radio operation and to ensure electromagnetic compliance (EMC). These51parameters include, without limitation, RF power, spectrum usage,52channel scanning, and human exposure.53 54For these reasons Intel cannot permit any manipulation by third parties55of the software provided in binary format with the wireless WLAN56adapters (e.g., the EEPROM and firmware). Furthermore, if you use any57patches, utilities, or code with the Intel wireless LAN adapters that58have been manipulated by an unauthorized party (i.e., patches,59utilities, or code (including open source code modifications) which have60not been validated by Intel), (i) you will be solely responsible for61ensuring the regulatory compliance of the products, (ii) Intel will bear62no liability, under any theory of liability for any issues associated63with the modified products, including without limitation, claims under64the warranty and/or issues arising from regulatory non-compliance, and65(iii) Intel will not provide or be required to assist in providing66support to any third parties for such modified products.67 68Note: Many regulatory agencies consider Wireless LAN adapters to be69modules, and accordingly, condition system-level regulatory approval70upon receipt and review of test data documenting that the antennas and71system configuration do not cause the EMC and radio operation to be72non-compliant.73 74The drivers available for download from SourceForge are provided as a75part of a development project. Conformance to local regulatory76requirements is the responsibility of the individual developer. As77such, if you are interested in deploying or shipping a driver as part of78solution intended to be used for purposes other than development, please79obtain a tested driver from Intel Customer Support at:80 81https://www.intel.com/support/wireless/sb/CS-006408.htm82 831. Introduction84===============85 86This document provides a brief overview of the features supported by the87IPW2100 driver project. The main project website, where the latest88development version of the driver can be found, is:89 90 http://ipw2100.sourceforge.net91 92There you can find the not only the latest releases, but also information about93potential fixes and patches, as well as links to the development mailing list94for the driver project.95 96 972. Release git-1.1.5 Current Supported Features98===============================================99 100- Managed (BSS) and Ad-Hoc (IBSS)101- WEP (shared key and open)102- Wireless Tools support103- 802.1x (tested with XSupplicant 1.0.1)104 105Enabled (but not supported) features:106- Monitor/RFMon mode107- WPA/WPA2108 109The distinction between officially supported and enabled is a reflection110on the amount of validation and interoperability testing that has been111performed on a given feature.112 113 1143. Command Line Parameters115==========================116 117If the driver is built as a module, the following optional parameters are used118by entering them on the command line with the modprobe command using this119syntax::120 121 modprobe ipw2100 [<option>=<VAL1><,VAL2>...]122 123For example, to disable the radio on driver loading, enter:124 125 modprobe ipw2100 disable=1126 127The ipw2100 driver supports the following module parameters:128 129========= ============== ============ ==============================130Name Value Example Meaning131========= ============== ============ ==============================132debug 0x0-0xffffffff debug=1024 Debug level set to 1024133mode 0,1,2 mode=1 AdHoc134channel int channel=3 Only valid in AdHoc or Monitor135associate boolean associate=0 Do NOT auto associate136disable boolean disable=1 Do not power the HW137========= ============== ============ ==============================138 139 1404. Sysfs Helper Files141=====================142 143There are several ways to control the behavior of the driver. Many of the144general capabilities are exposed through the Wireless Tools (iwconfig). There145are a few capabilities that are exposed through entries in the Linux Sysfs.146 147 148**Driver Level**149 150For the driver level files, look in /sys/bus/pci/drivers/ipw2100/151 152 debug_level153 This controls the same global as the 'debug' module parameter. For154 information on the various debugging levels available, run the 'dvals'155 script found in the driver source directory.156 157 .. note::158 159 'debug_level' is only enabled if CONFIG_IPW2100_DEBUG is turn on.160 161**Device Level**162 163For the device level files look in::164 165 /sys/bus/pci/drivers/ipw2100/{PCI-ID}/166 167For example::168 169 /sys/bus/pci/drivers/ipw2100/0000:02:01.0170 171For the device level files, see /sys/bus/pci/drivers/ipw2100:172 173 rf_kill174 read175 176 == =========================================177 0 RF kill not enabled (radio on)178 1 SW based RF kill active (radio off)179 2 HW based RF kill active (radio off)180 3 Both HW and SW RF kill active (radio off)181 == =========================================182 183 write184 185 == ==================================================186 0 If SW based RF kill active, turn the radio back on187 1 If radio is on, activate SW based RF kill188 == ==================================================189 190 .. note::191 192 If you enable the SW based RF kill and then toggle the HW193 based RF kill from ON -> OFF -> ON, the radio will NOT come back on194 195 1965. Radio Kill Switch197====================198 199Most laptops provide the ability for the user to physically disable the radio.200Some vendors have implemented this as a physical switch that requires no201software to turn the radio off and on. On other laptops, however, the switch202is controlled through a button being pressed and a software driver then making203calls to turn the radio off and on. This is referred to as a "software based204RF kill switch"205 206See the Sysfs helper file 'rf_kill' for determining the state of the RF switch207on your system.208 209 2106. Dynamic Firmware211===================212 213As the firmware is licensed under a restricted use license, it can not be214included within the kernel sources. To enable the IPW2100 you will need a215firmware image to load into the wireless NIC's processors.216 217You can obtain these images from <http://ipw2100.sf.net/firmware.php>.218 219See INSTALL for instructions on installing the firmware.220 221 2227. Power Management223===================224 225The IPW2100 supports the configuration of the Power Save Protocol226through a private wireless extension interface. The IPW2100 supports227the following different modes:228 229 === ===========================================================230 off No power management. Radio is always on.231 on Automatic power management232 1-5 Different levels of power management. The higher the233 number the greater the power savings, but with an impact to234 packet latencies.235 === ===========================================================236 237Power management works by powering down the radio after a certain238interval of time has passed where no packets are passed through the239radio. Once powered down, the radio remains in that state for a given240period of time. For higher power savings, the interval between last241packet processed to sleep is shorter and the sleep period is longer.242 243When the radio is asleep, the access point sending data to the station244must buffer packets at the AP until the station wakes up and requests245any buffered packets. If you have an AP that does not correctly support246the PSP protocol you may experience packet loss or very poor performance247while power management is enabled. If this is the case, you will need248to try and find a firmware update for your AP, or disable power249management (via ``iwconfig eth1 power off``)250 251To configure the power level on the IPW2100 you use a combination of252iwconfig and iwpriv. iwconfig is used to turn power management on, off,253and set it to auto.254 255 ========================= ====================================256 iwconfig eth1 power off Disables radio power down257 iwconfig eth1 power on Enables radio power management to258 last set level (defaults to AUTO)259 iwpriv eth1 set_power 0 Sets power level to AUTO and enables260 power management if not previously261 enabled.262 iwpriv eth1 set_power 1-5 Set the power level as specified,263 enabling power management if not264 previously enabled.265 ========================= ====================================266 267You can view the current power level setting via::268 269 iwpriv eth1 get_power270 271It will return the current period or timeout that is configured as a string272in the form of xxxx/yyyy (z) where xxxx is the timeout interval (amount of273time after packet processing), yyyy is the period to sleep (amount of time to274wait before powering the radio and querying the access point for buffered275packets), and z is the 'power level'. If power management is turned off the276xxxx/yyyy will be replaced with 'off' -- the level reported will be the active277level if `iwconfig eth1 power on` is invoked.278 279 2808. Support281==========282 283For general development information and support,284go to:285 286 http://ipw2100.sf.net/287 288The ipw2100 1.1.0 driver and firmware can be downloaded from:289 290 http://support.intel.com291 292For installation support on the ipw2100 1.1.0 driver on Linux kernels2932.6.8 or greater, email support is available from:294 295 http://supportmail.intel.com296 2979. License298==========299 300 Copyright |copy| 2003 - 2006 Intel Corporation. All rights reserved.301 302 This program is free software; you can redistribute it and/or modify it303 under the terms of the GNU General Public License (version 2) as304 published by the Free Software Foundation.305 306 This program is distributed in the hope that it will be useful, but WITHOUT307 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or308 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for309 more details.310 311 You should have received a copy of the GNU General Public License along with312 this program; if not, write to the Free Software Foundation, Inc., 59313 Temple Place - Suite 330, Boston, MA 02111-1307, USA.314 315 The full GNU General Public License is included in this distribution in the316 file called LICENSE.317 318 License Contact Information:319 320 James P. Ketrenos <ipw2100-admin@linux.intel.com>321 322 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497323 324