Documentation/networking/README.ipw2200

   1
   2 Intel PRO/Wireless 2200 802.11bg Driver for Linux
   3 README.ipw2200
   4
   5 October 13, 2004
   6
   7 Release 0.12 Current Features
   8 ------------ -----   -----       ----       ---       --         -
   9 - BSS mode (Infrastructure, Managed)
  10 - IBSS mode (Ad-Hoc)
  11 - WEP (OPEN and SHARED KEY mode)
  12 - 802.1x EAP via xsupplicant
  13 - Wireless Extension support
  14 - long/short preamble support
  15 - Full B and G rate support (2200 and 2915)
  16 - Full A rate support (2915 only)
  17 - Transmit power control
  18 - S state support (ACPI suspend/resume)
  19
  20 TODO
  21 ------------ -----   -----       ----       ---       --         -
  22 - Fix statistics returned by iwconfig and /proc/net/wireless
  23 - Add firmware restart backoff algorithm (see ipw2100 project)
  24 - Look into (and hopefully enable) Monitor/RFMon mode
  25 - Add WPA support
  26
  27
  28 Command Line Parameters
  29 ------------ -----   -----       ----       ---       --         -
  30   associate
  31         Set to 0 to disable the auto scan-and-associate functionality of the
  32         driver.  Default is 1 (auto-associate)
  33
  34   auto_create
  35         Set to 0 to disable the auto creation of an Ad-Hoc network
  36         matching the channel and network name parameters provided.
  37         Default is 1.
  38
  39   channel
  40         channel number for association.  The normal method for setting
  41         the channel would be to use the standard wireless tools
  42         (i.e. `iwconfig eth1 channel 10`), but it is useful sometimes
  43         to set this while debugging.  Channel 0 means 'ANY'
  44
  45   debug
  46         If using a debug build, this is used to control the amount of debug
  47         info is logged.  See the 'dval' and 'load' script for more info on
  48         how to use this.
  49
  50   ifname
  51         Can be used to override the default interface name of eth%.  For
  52         example:
  53
  54                 modprobe ipw2200 ifname=wlan%d
  55
  56         You can also specify a specific interface number -- be warned
  57         that if that number conflicts with an already assigned interface
  58         the driver will not load correctly.
  59
  60   mode
  61         Can be used to set the default mode of the adapter.
  62         0 = Managed, 1 = Ad-Hoc
  63
  64 Wireless Extension Private Methods
  65 ------------ -----   -----       ----       ---       --         -
  66   get_mode
  67         Can be used to report out which IEEE mode the driver is
  68         configured to support.  Example:
  69
  70         % iwpriv eth1 get_mode
  71         eth1    get_mode:802.11bg (6)
  72
  73   set_mode
  74         Can be used to configure which IEEE mode the driver will
  75         support.
  76
  77         Usage:
  78         % iwpriv eth1 set_mode {mode}
  79         Where {mode} is a number in the range 1-7:
  80         1       802.11a (2915 only)
  81         2       802.11b
  82         3       802.11ab (2915 only)
  83         4       802.11g
  84         5       802.11ag (2915 only)
  85         6       802.11bg
  86         7       802.11abg (2915 only)
  87
  88
  89 Sysfs Helper Files: (NOTE: All of these are only useful for developers)
  90 ------------ -----   -----       ----       ---       --         -
  91
  92 ----- Driver Level ------
  93 For the driver level files, look in /sys/bus/pci/drivers/ipw2200/
  94
  95   debug_level
  96
  97         This controls the same global as the 'debug' module parameter
  98
  99 ----- Device Level ------
 100 For the device level files, look in
 101
 102         /sys/bus/pci/drivers/ipw2200/{PCI-ID}/
 103
 104 For example:
 105         /sys/bus/pci/drivers/ipw2200/0000:02:01.0
 106
 107 For the device level files, see /sys/bus/pci/[drivers/ipw2200:
 108
 109   command_event_reg
 110         read access to the the Command Event register
 111
 112   eeprom
 113         reading from this fill will cause our private copy of the
 114         contents of the EEPROM to be flushed to the log
 115
 116   eeprom_sram
 117         reading this file will behave like the 'eeprom' file, except
 118         that instead of pulling from the device's cached copy of the
 119         eeprom data, the region of the device's sram that should
 120         hold eeprom data is dumped.
 121
 122   eeprom_clear
 123         reading from this file will cause the eeprom info in sram to be
 124         cleared.
 125
 126   error_log
 127         reading this file will cause the contents of the device's error
 128         log to be flushed to our log.  normally the event_log is empty,
 129         but if the device's fw get's into an odd state, this log contains
 130         some hints.
 131
 132   fw_date
 133         read-only access to the firmware release date
 134
 135   fw_version
 136         read-only access to the firmware release version
 137
 138   rf_kill
 139         read -
 140         0 = RF kill not enabled (radio on)
 141         1 = HW based RF kill active (radio off)
 142         2 = SW based RF kill active (radio off)
 143         write -
 144         0 = If SW based RF kill active, turn the radio back on
 145         1 = If radio is on, activate SW based RF kill
 146
 147         NOTE: If you enable the SW based RF kill and then toggle the HW
 148         based RF kill from ON -> OFF -> ON, the radio will come back on
 149         (resetting the SW based RF kill to the 'radio on' state)
 150
 151   ucode
 152         read-only access to the ucode version number
 153
 154   rtc
 155         read-only access the the device's real-time clock
 156
 157   [in]direct_byte
 158   [in]direct_word
 159         enables read-only access to the device's sram by first writing
 160         the address of the data to read, and then reading from the file
 161         will return the word/byte the address points to.
 162
 163 Support
 164 ------------ -----   -----       ----       ---       --         -
 165
 166 For general information and support, go to:
 167
 168     http://ipw2200.sf.net/
 169
 170 License
 171 ------------ -----   -----       ----       ---       --         -
 172
 173   Copyright(c) 2003 - 2004 Intel Corporation. All rights reserved.
 174
 175   This program is free software; you can redistribute it and/or modify it
 176   under the terms of the GNU General Public License as published by the Free
 177   Software Foundation; either version 2 of the License.
 178
 179   This program is distributed in the hope that it will be useful, but WITHOUT
 180   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 181   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 182   more details.
 183
 184   You should have received a copy of the GNU General Public License along with
 185   this program; if not, write to the Free Software Foundation, Inc., 59
 186   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 187
 188   The full GNU General Public License is included in this distribution in the
 189   file called LICENSE.
 190
 191   Contact Information:
 192   James P. Ketrenos <ipw2100-admin@linux.intel.com>
 193   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 194