share/man/man4/wi.4

   1 .\" Copyright (c) 1997, 1998, 1999
   2 .\"     Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD: head/share/man/man4/wi.4 267938 2014-06-26 21:46:14Z bapt $
  32 .\"     $OpenBSD: wi.4tbl,v 1.14 2002/04/29 19:53:50 jsyn Exp $
  33 .\"
  34 .Dd May 26, 2016
  35 .Dt WI 4
  36 .Os
  37 .Sh NAME
  38 .Nm wi
  39 .Nd "Lucent Hermes, and Intersil PRISM IEEE 802.11 driver"
  40 .Sh SYNOPSIS
  41 To compile this driver into the kernel,
  42 place the following lines in your
  43 kernel configuration file:
  44 .Bd -ragged -offset indent
  45 .Cd "device wi"
  46 .Cd "device wlan"
  47 .Ed
  48 .Pp
  49 Alternatively, to load the driver as a
  50 module at boot time, place the following line in
  51 .Xr loader.conf 5 :
  52 .Bd -literal -offset indent
  53 if_wi_load="YES"
  54 .Ed
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 driver provides support for 802.11b wireless network adapters based around
  59 the Lucent Hermes, Intersil PRISM-II, Intersil PRISM-2.5, and Intersil
  60 Prism-3 chipsets.
  61 All chipsets provide a similar interface to the driver.
  62 Only the Intersil chipsets support access point operation or WPA.
  63 Very old versions of firmware are not supported at all.
  64 Older versions of the firmware that are supported may severely limit
  65 the ability to use these cards in newer networks.
  66 Only relatively recent versions of Intersil firmware supports WPA.
  67 See CAVEATS for details.
  68 All host/device interaction is via programmed I/O, even on those cards
  69 that support a DMA interface.
  70 .Pp
  71 For more information on configuring this device, see
  72 .Xr ifconfig 8 .
  73 The
  74 .Nm
  75 driver supports
  76 .Xr polling 4 .
  77 .Pp
  78 .Nm
  79 supports
  80 .Cm station ,
  81 .Cm adhoc ,
  82 .Cm adhoc-demo ,
  83 .Cm hostap ,
  84 and
  85 .Cm monitor
  86 mode operation.
  87 Only one
  88 virtual interface may be configured at a time.
  89 For more information on configuring this device, see
  90 .Xr ifconfig 8 .
  91 .Pp
  92 Cards supported by the
  93 .Nm
  94 driver come in a variety of packages, though the most common
  95 are of the PCMCIA type.
  96 In many cases, the PCI version of a wireless card is simply
  97 a PCMCIA card bundled with a PCI adapter.
  98 The PCI adapters come in two flavors: true PCMCIA bridges and
  99 dumb PCMCIA bridges.
 100 A true PCMCIA bridge (such as those sold by Lucent) will attach
 101 as a real PCMCIA controller.
 102 The wireless card will then attach to the PCMCIA bus.
 103 Wireless cards in PCMCIA slots may be inserted and ejected on the fly.
 104 .Pp
 105 A dumb bridge, on the other hand, does not show up as a true PCMCIA bus.
 106 The wireless card will simply appear to the host as a normal PCI
 107 device and will not require any PCMCIA support.
 108 Cards in this type of adapter should only be removed when the
 109 machine is powered down.
 110 .Pp
 111 The following cards are among those supported by the
 112 .Nm
 113 driver:
 114 .Pp
 115 .Bl -column -compact "Linksys Instant Wireless WPC11 2.5" "Spectrum24" "PCI or PCMCIA"
 116 .Em "Card       Chip    Bus"
 117 3Com AirConnect 3CRWE777A       Prism-II        PCI
 118 Accton airDirect WN3301         PCMCIA
 119 ACTIONTEC HWC01170      Prism-2.5       PCMCIA
 120 Adaptech ANW-8030       Prism-3 PCMCIA
 121 Addtron AWP-100 Prism-II        PCMCIA
 122 Adtec Adlink/340C       Prism-II        PCMCIA
 123 Airvast WN 100  Prism-3 PCMCIA
 124 Airway 802.11 Adapter           PCMCIA
 125 Agere Orinoco   Hermes  PCMCIA
 126 Allied Telesis WR211PCM Prism-II        PCMCIA
 127 ArTem OnAir     Prism?  PCMCIA
 128 Asus WL100      Prism-2.5       PCMCIA
 129 Avaya Wireless  Prism-II        PCMCIA
 130 Bay eMobility 11B       Prism-2.5?      PCMCIA
 131 Blue Concentric Circle WL-379F  Prism-II        CF
 132 BreezeNet Wireless      Prism-II        PCMCIA
 133 Buffalo WLI-PCM-S11     Prism-II        PCMCIA
 134 Buffalo WLI-PCM-L11G    Hermes  PCMCIA
 135 Buffalo WLI-CF-S11G     Prism-II        CF
 136 Buffalo WLI2-CF-S11G    Prism 2.5       CF
 137 Cabletron RoamAbout     Hermes  PCMCIA
 138 Compaq Agency NC5004    Prism-II        PCMCIA
 139 Compaq WL100    Prism-II        PCMCIA
 140 Compaq WL110    Hermes  PCMCIA
 141 Compaq WL200    Prism-II        PCMCIA
 142 Contec FLEXLAN/FX-DS110-PCC     Prism-II        PCMCIA
 143 Corega PCC-11   Prism-II        PCMCIA
 144 Corega PCCA-11  Prism-II        PCMCIA
 145 Corega PCCB-11  Prism-II        PCMCIA
 146 Corega CGWLPCIA11       Prism-II        PCI
 147 Dell TrueMobile 1150    Hermes  PCMCIA
 148 Dlink Air 660   Prism-II        PCMCIA
 149 Dlink DWL520    Prism-2.5       PCI
 150 Dlink DWL650    Prism-2.5       PCMCIA
 151 ELECOM Air@Hawk/LD-WL11/PCC             PCMCIA
 152 ELSA MC-11              PCMCIA
 153 ELSA XI300      Prism-II        PCMCIA
 154 ELSA XI325      Prism-2.5       PCMCIA
 155 ELSA APDL325    Prism-2.5       PCMCIA
 156 ELSA XI330      Prism-3 PCMCIA
 157 ELSA XI800      Prism-II        CF
 158 EMTAC A2424i    Prism-II        PCMCIA
 159 Farallon Skyline        Prism-II        PCMCIA
 160 Gemtek WL-311   Prism-2.5       PCMCIA
 161 Hawking Technology WE110P       Prism-2.5       PCMCIA
 162 Home Wireless Networks  Prism-II        PCMCIA
 163 IBM High Rate Wireless  Hermes  PCMCIA
 164 ICOM SL-1100    Prism-II        PCMCIA
 165 I-O DATA WN-B11/PCM     Prism-II        PCMCIA
 166 Intersil Prism II       Prism-II        PCMCIA
 167 Intersil Mini-PCI       Prism-2.5       PCI
 168 Intersil ISL37100P      Prism-3 PCMCIA
 169 Intersil ISL37110P      Prism-3 PCMCIA
 170 Intersil ISL37300P      Prism-3 PCMCIA
 171 Laneed Wireless         PCMCIA
 172 Linksys Instant Wireless WPC11  Prism-II        PCMCIA
 173 Linksys Instant Wireless WPC11 2.5      Prism-2.5       PCMCIA
 174 Linksys Instant Wireless WPC11 3.0      Prism-3 PCMCIA
 175 Linksys WCF11   Prism-3 PCMCIA
 176 Linksys WCF12   Prism-3 CF
 177 Lucent WaveLAN  Hermes  PCMCIA
 178 Melco Airconnect        Prism-II        PCMCIA
 179 Microsoft MN-520 WLAN   Prism-II        PCMCIA
 180 NANOSPEED ROOT-RZ2000   Prism-II        PCMCIA
 181 NCR WaveLAN/IEEE 802.11         PCMCIA
 182 NDC/Sohoware NCP130     Prism-II        PCI
 183 NEC CMZ-RT-WP   Prism-II        PCMCIA
 184 NEC PK-WL001    Lucent  PCMCIA
 185 NEC PC-WL/11C   Prism-II        PCMCIA
 186 Netgear MA311   Prism-2.5       PCI
 187 Netgear MA401   Prism-II/2.5    PCMCIA
 188 Netgear MA401RA Prism-II        PCMCIA
 189 Netgear MA701   Prism-II        CF
 190 NOKIA C020 WLAN Prism-II        PCMCIA
 191 NOKIA C110 WLAN Prism-2.5       PCMCIA
 192 NTT-ME 11Mbps Wireless LAN      Prism-II        PCMCIA
 193 Planex GeoWave/GW-NS110 Prism-II        PCMCIA
 194 Planex GW-NS11H Prism-II        PCMCIA
 195 Proxim Harmony  Prism-II        PCMCIA
 196 Proxim RangeLAN-DS      Prism-II        PCMCIA
 197 Samsung MagicLAN SWL-2000N      Prism-II        PCMCIA
 198 SENAO SL-2511CD Prism-3 PCMCIA
 199 Siemens SpeedStream SS1021      Prism-II        PCMCIA
 200 Siemens SpeedStream SS1021      Prism-3 PCMCIA
 201 SMC 2532W-B     Prism-II        PCMCIA
 202 SMC 2602 EZ Connect (3.3V)      Prism-II        PCI or PCMCIA
 203 SMC 2632 EZ Connect     Prism-II        PCMCIA
 204 Socket Low Power WLAN-CF        Prism-II        CF
 205 Sony PCWA-C100  Lucent  PCMCIA
 206 Sony PEGA-WL110 Prism-2.5       PCMCIA
 207 TDK LAK-CD011WL Prism-II        PCMCIA
 208 Toshiba Wireless LAN Card       Prism-II        PCMCIA
 209 U.S.\& Robotics Wireless Card 2410      Prism-II        PCMCIA
 210 YIS YWL-11B     Prism-II        PCMCIA
 211 .El
 212 .Pp
 213 Several vendors sell PCI adapters built around the PLX Technology 9050
 214 or 9052 chip.
 215 The following such adapters are supported or expected to work:
 216 .Pp
 217 .Bl -item -compact
 218 .It
 219 3Com AirConnect 3CRWE777A (3.3V)
 220 .It
 221 Belkin F5D6000 (a rebadged WL11000P)
 222 .It
 223 Eumitcom WL11000P
 224 .It
 225 Global Sun Technology GL24110P (untested)
 226 .It
 227 Global Sun Technology GL24110P02
 228 .It
 229 LinkSys WDT11 (a rebadged GL24110P02)
 230 .It
 231 Netgear MA301
 232 .It
 233 US Robotics 2415 (rebadged WL11000P)
 234 .It
 235 Wisecom Wireless LAN PCI Adapter
 236 .El
 237 .Pp
 238 The following adapters have the same model numbers as those listed
 239 above, but might not work if the actual card is after the change away
 240 from the Prism family:
 241 .Pp
 242 .Bl -item -compact
 243 .It
 244 DLink DWL520
 245 .El
 246 .Sh EXAMPLES
 247 Join an existing BSS network (ie: connect to an access point):
 248 .Bd -literal -offset indent
 249 ifconfig wlan create wlandev wi0 inet 192.168.0.20 \e
 250     netmask 0xffffff00
 251 .Ed
 252 .Pp
 253 Join a specific BSS network with network name
 254 .Dq Li my_net :
 255 .Bd -literal -offset indent
 256 ifconfig wlan create wlandev wi0 inet 192.168.0.20 \e
 257     netmask 0xffffff00 ssid my_net
 258 .Ed
 259 .Pp
 260 Join a specific BSS network with WEP encryption:
 261 .Bd -literal -offset indent
 262 ifconfig wlan create wlandev wi0 inet 192.168.0.20 \e
 263     netmask 0xffffff00 ssid my_net \e
 264     wepmode on wepkey 0x8736639624 weptxkey 1
 265 .Ed
 266 .Pp
 267 Join a Lucent legacy demo ad-hoc network with network name
 268 .Dq Li my_net :
 269 .Bd -literal -offset indent
 270 ifconfig wlan create wlandev wi0 wlanmode ahdemo \e
 271     inet 192.168.0.20 netmask 0xffffff00 ssid my_net
 272 .Ed
 273 .Pp
 274 Join/create an IBSS network with network name
 275 .Dq Li my_net :
 276 .Bd -literal -offset indent
 277 ifconfig wlan create wlandev wi0 wlanmode adhoc wi0 \e
 278     inet 192.168.0.22 netmask 0xffffff00 ssid my_net
 279 .Ed
 280 .Pp
 281 Create a host-based access point (Prism only):
 282 .Bd -literal -offset indent
 283 ifconfig wlan create wlandev wi0 wlanmode hostap \e
 284     inet 192.168.0.10 netmask 0xffffff00 ssid my_ap
 285 .Ed
 286 .Pp
 287 Create a host-based access point with WEP enabled (Prism only)
 288 and plumb it into bridge to fxp0:
 289 .Bd -literal -offset indent
 290 ifconfig wlan0 create wlandev wi0 wlanmode hostap \e
 291     inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
 292     wepmode on wepkey 0x1234567890 weptxkey 1
 293 ifconfig bridge0 create
 294 ifconfig bridge0 addm wlan0 addm fxp0 up
 295 .Ed
 296 .Pp
 297 This will give you the same functionality as an access point.
 298 .Sh DIAGNOSTICS
 299 .Bl -diag
 300 .It "wi%d: init failed"
 301 The WaveLAN card failed to become ready after an initialization command
 302 was issued.
 303 .It "wi%d: failed to allocate %d bytes on NIC"
 304 The driver was unable to allocate memory for transmit frames in the
 305 NIC's on-board RAM.
 306 This can also be an indication of an incorrectly configured interrupt.
 307 .It "wi%d: device timeout"
 308 The WaveLAN card failed to generate an interrupt to acknowledge a transmit
 309 command.
 310 .El
 311 .Sh SEE ALSO
 312 .Xr ifmedia 4 ,
 313 .Xr intro 4 ,
 314 .Xr pccard 4 ,
 315 .Xr pccbb 4 ,
 316 .Xr polling 4 ,
 317 .Xr wlan 4 ,
 318 .Xr wlan_ccmp 4 ,
 319 .Xr wlan_tkip 4 ,
 320 .Xr wlan_wep 4 ,
 321 .Xr wlan_xauth 4 ,
 322 .Xr hostapd 8 ,
 323 .Xr ifconfig 8 ,
 324 .Xr wpa_supplicant 8
 325 .Rs
 326 .%T HCF Light programming specification
 327 .%U http://web.archive.org/web/20040130141721/http://wavelan.com/
 328 .Re
 329 .Sh HISTORY
 330 The
 331 .Nm
 332 device driver first appeared in
 333 .Fx 3.0 .
 334 .Sh AUTHORS
 335 The original
 336 .Nm
 337 driver was written by
 338 .An Bill Paul Aq Mt wpaul@ctr.columbia.edu .
 339 This man page comes from
 340 .Ox .
 341 .Sh CAVEATS
 342 The driver will reject devices with old firmware to
 343 avoid dealing with numerous defects.
 344 Unfortunately the driver does not support downloading new firmware
 345 to the card so if new firmware is needed users will have to boot
 346 a different system to accomplish this.
 347 .Pp
 348 Intersil Prism cards must have firmware versions 0.8.0 or later and
 349 version 1.7.0 or later are required to support functionality such as WPA.
 350 Some users of Prism-II and 2.5 based cards report that station firmware
 351 version 1.3.4 works better for them in hostap than 1.4.9.
 352 Older versions of the Prism station firmware have a number of issues
 353 with hostap mode.
 354 The IBSS/adhoc mode appears to work well on station firmware 1.3.1 and
 355 later.
 356 The IBSS/adhoc mode appears to have problems for some people with
 357 older versions of station firmware.
 358 .Pp
 359 Lucent cards prior to firmware version 6.0.6 do not implement IBSS
 360 mode and are not supported.
 361 .Pp
 362 Prior versions of
 363 .Nm
 364 supported Symbol firmware.
 365 That support has been removed due to persistent problems with this
 366 firmware as well as getting proper documentation on this firmware.
 367 .Pp
 368 Hermes 2 and Hermes 3 chips are not supported by this driver.
 369 .Pp
 370 Here's the above requirements in the form of a table
 371 .Pp
 372 .Bl -column -compact "Prims II/2.5" "xxxxxxxx" "xxxxxxxx" "xxxxxxxx" "xxxxxxxx"
 373 .Em "Firmware   Minimum WPA     Host AP Adhoc/IBSS"
 374 Prism II/2.5    0.8.0   1.7.0   1.3.4   1.3.1
 375 Prism 3 0.8.0   1.7.0   1.4.9   1.3.1
 376 Hermes  6.0.6   none    none    6.0.6
 377 Symbol  none    none    none    none
 378 .El
 379 .Sh BUGS
 380 Not all the new messages are documented here, and many of them are
 381 indications of transient errors that are not indications of serious
 382 problems.