Documentation/networking/README.ipw2100

   1
   2 Intel PRO/Wireless 2100 802.11b Driver for Linux
   3 README.ipw2100
   4
   5 October 13, 2004
   6
   7
   8 Release 0.56 Current Features
   9 ------------ -----   -----       ----       ---       --         -
  10
  11 - IBSS and BSS modes
  12 - 802.11 fragmentation
  13 - WEP (shared key and open)
  14 - wireless extension support
  15 - 802.1x EAP via xsupplicant
  16 - Monitor/RFMon mode
  17 - transmit power control
  18 - long/short preamble support
  19 - power states support (ACPI)
  20
  21 TODO
  22 ------------ -----   -----       ----       ---       --         -
  23 - Fix bugs...  The biggies:
  24   C3 corruption
  25   Fragmentation
  26
  27
  28 Command Line Parameters
  29 ------------ -----   -----       ----       ---       --         -
  30
  31 If the driver is built as a module, the following optional parameters are used
  32 by entering them on the command line with the modprobe command using this
  33 syntax:
  34
  35         modprobe ipw2100 [<option>=<VAL1><,VAL2>...]
  36
  37 For example, to set the interface name for driver, entering:
  38
  39         modprobe ipw2100 if_name=wlan%d
  40
  41 results in the ipw2100 driver defaulting to the wlan prefix, with the system
  42 assigning a unique number in place of %d.  The default interface name is eth%d.
  43
  44 The ipw2100 driver supports the following module parameters:
  45
  46 Name            Value           Example:
  47 debug           0x0-0xffffffff  debug=1024
  48 if_name         string          if_name=wlan%d
  49 mode            0,1,2           mode=1   /* AdHoc */
  50 channel         int             channel=3 /* Only valid in AdHoc or Monitor */
  51 associate       boolean         associate=0 /* Do NOT auto associate */
  52 disable         boolean         disable=1 /* Do not power the HW */
  53
  54
  55 Radio Kill Switch
  56 ------------ -----   -----       ----       ---       --         -
  57 Most laptops provide the ability for the user to physically disable the radio.
  58 Some vendors have implemented this as a physical switch that requires no
  59 software to turn the radio off and on.  On other laptops, however, the switch
  60 is controlled through a button being pressed and a software driver then making
  61 calls to turn the radio off and on.  This is referred to as a "software based
  62 RF kill switch"
  63
  64 To determine if you have such a switch, you can check the contents of:
  65
  66         /sys/bus/pci/drivers/ipw2100/*/rf_kill
  67
  68 A value of:
  69
  70         Radio is {en,dis}abled by RF switch
  71
  72 means that you have an RF switch and the radio is in the state
  73 described.
  74
  75 A value of:
  76
  77         Your hardware does not have an RF switch
  78
  79 is self explanatory.  In this case you should not need to worry about
  80 enabling the radio.
  81
  82
  83 Dynamic Firmware
  84 ------------ -----   -----       ----       ---       --         -
  85 As the firmware is licensed under a restricted use license, it can not be
  86 included within the kernel sources.  To enable the IPW2100 you will need a
  87 firmware image to load into the wireless NIC's processors.
  88
  89 You can obtain these images from <http://ipw2100.sf.net/firmware.php>.
  90
  91 See INSTALL for instructions on installing the firmware.
  92
  93
  94 Power Management
  95 ------------ -----   -----       ----       ---       --         -
  96 The IPW2100 supports the configuration of the Power Save Protocol
  97 through a private wireless extension interface.  The IPW2100 supports
  98 the following different modes:
  99
 100         off     No power management.  Radio is always on.
 101         on      Automatic power management
 102         1-5     Different levels of power management.  The higher the
 103                 number the greater the power savings, but with an impact to
 104                 packet latencies.
 105
 106 Power management works by powering down the radio after a certain
 107 interval of time has passed where no packets are passed through the
 108 radio.  Once powered down, the radio remains in that state for a given
 109 period of time.  For higher power savings, the interval between last
 110 packet processed to sleep is shorter and the sleep period is longer.
 111
 112 When the radio is asleep, the access point sending data to the station
 113 must buffer packets at the AP until the station wakes up and requests
 114 any buffered packets.  If you have an AP that does not correctly support
 115 the PSP protocol you may experience packet loss or very poor performance
 116 while power management is enabled.  If this is the case, you will need
 117 to try and find a firmware update for your AP, or disable power
 118 management (via `iwconfig eth1 power off`)
 119
 120 To configure the power level on the IPW2100 you use a combination of
 121 iwconfig and iwpriv.  iwconfig is used to turn power management on, off,
 122 and set it to auto.
 123
 124         iwconfig eth1 power off    Disables radio power down
 125         iwconfig eth1 power on     Enables radio power management to
 126                                    last set level (defaults to AUTO)
 127         iwpriv eth1 set_power 0    Sets power level to AUTO and enables
 128                                    power management if not previously
 129                                    enabled.
 130         iwpriv eth1 set_power 1-5  Set the power level as specified,
 131                                    enabling power management if not
 132                                    previously enabled.
 133
 134 You can view the current power level setting via:
 135
 136         iwpriv eth1 get_power
 137
 138 It will return the current period or timeout that is configured as a string
 139 in the form of xxxx/yyyy (z) where xxxx is the timeout interval (amount of
 140 time after packet processing), yyyy is the period to sleep (amount of time to
 141 wait before powering the radio and querying the access point for buffered
 142 packets), and z is the 'power level'.  If power management is turned off the
 143 xxxx/yyyy will be replaced with 'off' -- the level reported will be the active
 144 level if `iwconfig eth1 power on` is invoked.
 145
 146
 147 Support
 148 ------------ -----   -----       ----       ---       --         -
 149
 150 For general information and support, go to:
 151
 152     http://ipw2100.sf.net/
 153
 154 License
 155 ------------ -----   -----       ----       ---       --         -
 156
 157   Copyright(c) 2003 - 2004 Intel Corporation. All rights reserved.
 158
 159   This program is free software; you can redistribute it and/or modify it
 160   under the terms of the GNU General Public License as published by the Free
 161   Software Foundation; either version 2 of the License, or (at your option)
 162   any later version.
 163
 164   This program is distributed in the hope that it will be useful, but WITHOUT
 165   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 166   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 167   more details.
 168
 169   You should have received a copy of the GNU General Public License along with
 170   this program; if not, write to the Free Software Foundation, Inc., 59
 171   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 172
 173   The full GNU General Public License is included in this distribution in the
 174   file called LICENSE.
 175
 176   Contact Information:
 177   James P. Ketrenos <ipw2100-admin@linux.intel.com>
 178   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 179