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$
  32 .\"     $OpenBSD: wi.4tbl,v 1.14 2002/04/29 19:53:50 jsyn Exp $
  33 .\"
  34 .Dd August 2, 2008
  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 .Pp
  74 .Nm
  75 supports
  76 .Cm station ,
  77 .Cm adhoc ,
  78 .Cm adhoc-demo ,
  79 .Cm hostap ,
  80 and
  81 .Cm monitor
  82 mode operation.
  83 Only one
  84 virtual interface may be configured at a time.
  85 For more information on configuring this device, see
  86 .Xr ifconfig 8 .
  87 .Pp
  88 Cards supported by the
  89 .Nm
  90 driver come in a variety of packages, though the most common
  91 are of the PCMCIA type.
  92 In many cases, the PCI version of a wireless card is simply
  93 a PCMCIA card bundled with a PCI adapter.
  94 The PCI adapters come in two flavors: true PCMCIA bridges and
  95 dumb PCMCIA bridges.
  96 A true PCMCIA bridge (such as those sold by Lucent) will attach
  97 as a real PCMCIA controller.
  98 The wireless card will then attach to the PCMCIA bus.
  99 Wireless cards in PCMCIA slots may be inserted and ejected on the fly.
 100 .Pp
 101 A dumb bridge, on the other hand, does not show up as a true PCMCIA bus.
 102 The wireless card will simply appear to the host as a normal PCI
 103 device and will not require any PCMCIA support.
 104 Cards in this type of adapter should only be removed when the
 105 machine is powered down.
 106 .Pp
 107 The following cards are among those supported by the
 108 .Nm
 109 driver:
 110 .Pp
 111 .Bl -column -compact "Linksys Instant Wireless WPC11 2.5" "Spectrum24" "PCI or PCMCIA"
 112 .Em "Card       Chip    Bus"
 113 3Com AirConnect 3CRWE777A       Prism-II        PCI
 114 Accton airDirect WN3301         PCMCIA
 115 ACTIONTEC HWC01170      Prism-2.5       PCMCIA
 116 Adaptech ANW-8030       Prism-3 PCMCIA
 117 Addtron AWP-100 Prism-II        PCMCIA
 118 Adtec Adlink/340C       Prism-II        PCMCIA
 119 Airvast WN 100  Prism-3 PCMCIA
 120 Airway 802.11 Adapter           PCMCIA
 121 Agere Orinoco   Hermes  PCMCIA
 122 Allied Telesis WR211PCM Prism-II        PCMCIA
 123 ArTem OnAir     Prism?  PCMCIA
 124 Asus WL100      Prism-2.5       PCMCIA
 125 Avaya Wireless  Prism-II        PCMCIA
 126 Bay eMobility 11B       Prism-2.5?      PCMCIA
 127 Blue Concentric Circle WL-379F  Prism-II        CF
 128 BreezeNet Wireless      Prism-II        PCMCIA
 129 Buffalo WLI-PCM-S11     Prism-II        PCMCIA
 130 Buffalo WLI-PCM-L11G    Hermes  PCMCIA
 131 Buffalo WLI-CF-S11G     Prism-II        CF
 132 Buffalo WLI2-CF-S11G    Prism 2.5       CF
 133 Cabletron RoamAbout     Hermes  PCMCIA
 134 Compaq Agency NC5004    Prism-II        PCMCIA
 135 Compaq WL100    Prism-II        PCMCIA
 136 Compaq WL110    Hermes  PCMCIA
 137 Compaq WL200    Prism-II        PCMCIA
 138 Contec FLEXLAN/FX-DS110-PCC     Prism-II        PCMCIA
 139 Corega PCC-11   Prism-II        PCMCIA
 140 Corega PCCA-11  Prism-II        PCMCIA
 141 Corega PCCB-11  Prism-II        PCMCIA
 142 Corega CGWLPCIA11       Prism-II        PCI
 143 Dell TrueMobile 1150    Hermes  PCMCIA
 144 Dlink Air 660   Prism-II        PCMCIA
 145 Dlink DWL520    Prism-2.5       PCI
 146 Dlink DWL650    Prism-2.5       PCMCIA
 147 ELECOM Air@Hawk/LD-WL11/PCC             PCMCIA
 148 ELSA MC-11              PCMCIA
 149 ELSA XI300      Prism-II        PCMCIA
 150 ELSA XI325      Prism-2.5       PCMCIA
 151 ELSA APDL325    Prism-2.5       PCMCIA
 152 ELSA XI330      Prism-3 PCMCIA
 153 ELSA XI800      Prism-II        CF
 154 EMTAC A2424i    Prism-II        PCMCIA
 155 Farallon Skyline        Prism-II        PCMCIA
 156 Gemtek WL-311   Prism-2.5       PCMCIA
 157 Hawking Technology WE110P       Prism-2.5       PCMCIA
 158 Home Wireless Networks  Prism-II        PCMCIA
 159 IBM High Rate Wireless  Hermes  PCMCIA
 160 ICOM SL-1100    Prism-II        PCMCIA
 161 I-O DATA WN-B11/PCM     Prism-II        PCMCIA
 162 Intersil Prism II       Prism-II        PCMCIA
 163 Intersil Mini-PCI       Prism-2.5       PCI
 164 Intersil ISL37100P      Prism-3 PCMCIA
 165 Intersil ISL37110P      Prism-3 PCMCIA
 166 Intersil ISL37300P      Prism-3 PCMCIA
 167 Laneed Wireless         PCMCIA
 168 Linksys Instant Wireless WPC11  Prism-II        PCMCIA
 169 Linksys Instant Wireless WPC11 2.5      Prism-2.5       PCMCIA
 170 Linksys Instant Wireless WPC11 3.0      Prism-3 PCMCIA
 171 Linksys WCF11   Prism-3 PCMCIA
 172 Linksys WCF12   Prism-3 CF
 173 Lucent WaveLAN  Hermes  PCMCIA
 174 Melco Airconnect        Prism-II        PCMCIA
 175 Microsoft MN-520 WLAN   Prism-II        PCMCIA
 176 NANOSPEED ROOT-RZ2000   Prism-II        PCMCIA
 177 NCR WaveLAN/IEEE 802.11         PCMCIA
 178 NDC/Sohoware NCP130     Prism-II        PCI
 179 NEC CMZ-RT-WP   Prism-II        PCMCIA
 180 NEC PK-WL001    Lucent  PCMCIA
 181 NEC PC-WL/11C   Prism-II        PCMCIA
 182 Netgear MA311   Prism-2.5       PCI
 183 Netgear MA401   Prism-II/2.5    PCMCIA
 184 Netgear MA401RA Prism-II        PCMCIA
 185 Netgear MA701   Prism-II        CF
 186 NOKIA C020 WLAN Prism-II        PCMCIA
 187 NOKIA C110 WLAN Prism-2.5       PCMCIA
 188 NTT-ME 11Mbps Wireless LAN      Prism-II        PCMCIA
 189 Planex GeoWave/GW-NS110 Prism-II        PCMCIA
 190 Planex GW-NS11H Prism-II        PCMCIA
 191 Proxim Harmony  Prism-II        PCMCIA
 192 Proxim RangeLAN-DS      Prism-II        PCMCIA
 193 Samsung MagicLAN SWL-2000N      Prism-II        PCMCIA
 194 SENAO SL-2511CD Prism-3 PCMCIA
 195 Siemens SpeedStream SS1021      Prism-II        PCMCIA
 196 Siemens SpeedStream SS1021      Prism-3 PCMCIA
 197 SMC 2532W-B     Prism-II        PCMCIA
 198 SMC 2602 EZ Connect (3.3V)      Prism-II        PCI or PCMCIA
 199 SMC 2632 EZ Connect     Prism-II        PCMCIA
 200 Socket Low Power WLAN-CF        Prism-II        CF
 201 Sony PCWA-C100  Lucent  PCMCIA
 202 Sony PEGA-WL110 Prism-2.5       PCMCIA
 203 TDK LAK-CD011WL Prism-II        PCMCIA
 204 Toshiba Wireless LAN Card       Prism-II        PCMCIA
 205 U.S.\& Robotics Wireless Card 2410      Prism-II        PCMCIA
 206 YIS YWL-11B     Prism-II        PCMCIA
 207 .El
 208 .Pp
 209 Several vendors sell PCI adapters built around the PLX Technology 9050
 210 or 9052 chip.
 211 The following such adapters are supported or expected to work:
 212 .Pp
 213 .Bl -item -compact
 214 .It
 215 3Com AirConnect 3CRWE777A (3.3V)
 216 .It
 217 Belkin F5D6000 (a rebadged WL11000P)
 218 .It
 219 Eumitcom WL11000P
 220 .It
 221 Global Sun Technology GL24110P (untested)
 222 .It
 223 Global Sun Technology GL24110P02
 224 .It
 225 LinkSys WDT11 (a rebadged GL24110P02)
 226 .It
 227 Netgear MA301
 228 .It
 229 US Robotics 2415 (rebadged WL11000P)
 230 .It
 231 Wisecom Wireless LAN PCI Adapter
 232 .El
 233 .Pp
 234 The following adapters have the same model numbers as those listed
 235 above, but might not work if the actual card is after the change away
 236 from the Prism family:
 237 .Pp
 238 .Bl -item -compact
 239 .It
 240 DLink DWL520
 241 .El
 242 .Sh EXAMPLES
 243 Join an existing BSS network (ie: connect to an access point):
 244 .Pp
 245 .Bd -literal -offset indent
 246 ifconfig wlan create wlandev wi0 inet 192.168.0.20 \e
 247     netmask 0xffffff00
 248 .Ed
 249 .Pp
 250 Join a specific BSS network with network name
 251 .Dq Li my_net :
 252 .Pp
 253 .Bd -literal -offset indent
 254 ifconfig wlan create wlandev wi0 inet 192.168.0.20 \e
 255     netmask 0xffffff00 ssid my_net
 256 .Ed
 257 .Pp
 258 Join a specific BSS network with WEP encryption:
 259 .Bd -literal -offset indent
 260 ifconfig wlan create wlandev wi0 inet 192.168.0.20 \e
 261     netmask 0xffffff00 ssid my_net \e
 262     wepmode on wepkey 0x8736639624 weptxkey 1
 263 .Ed
 264 .Pp
 265 Join a Lucent legacy demo ad-hoc network with network name
 266 .Dq Li my_net :
 267 .Bd -literal -offset indent
 268 ifconfig wlan create wlandev wi0 wlanmode ahdemo \e
 269     inet 192.168.0.20 netmask 0xffffff00 ssid my_net
 270 .Ed
 271 .Pp
 272 Join/create an IBSS network with network name
 273 .Dq Li my_net :
 274 .Bd -literal -offset indent
 275 ifconfig wlan create wlandev wi0 wlanmode adhoc wi0 \e
 276     inet 192.168.0.22 netmask 0xffffff00 ssid my_net
 277 .Ed
 278 .Pp
 279 Create a host-based access point (Prism only):
 280 .Bd -literal -offset indent
 281 ifconfig wlan create wlandev wi0 wlanmode hostap \e
 282     inet 192.168.0.10 netmask 0xffffff00 ssid my_ap
 283 .Ed
 284 .Pp
 285 Create a host-based access point with WEP enabled (Prism only)
 286 and plumb it into bridge to fxp0:
 287 .Bd -literal -offset indent
 288 ifconfig wlan0 create wlandev wi0 wlanmode hostap \e
 289     inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
 290     wepmode on wepkey 0x1234567890 weptxkey 1
 291 ifconfig bridge0 create
 292 ifconfig bridge0 addm wlan0 addm fxp0 up
 293 .Ed
 294 .Pp
 295 This will give you the same functionality as an access point.
 296 .Sh DIAGNOSTICS
 297 .Bl -diag
 298 .It "wi%d: init failed"
 299 The WaveLAN card failed to become ready after an initialization command
 300 was issued.
 301 .It "wi%d: failed to allocate %d bytes on NIC"
 302 The driver was unable to allocate memory for transmit frames in the
 303 NIC's on-board RAM.
 304 This can also be an indication of an incorrectly configured interrupt.
 305 .It "wi%d: device timeout"
 306 The WaveLAN card failed to generate an interrupt to acknowledge a transmit
 307 command.
 308 .El
 309 .Sh SEE ALSO
 310 .Xr intro 4 ,
 311 .Xr pccard 4 ,
 312 .Xr pccbb 4 ,
 313 .Xr pcic 4 ,
 314 .Xr wlan 4 ,
 315 .Xr wlan_ccmp 4 ,
 316 .Xr wlan_tkip 4 ,
 317 .Xr wlan_wep 4 ,
 318 .Xr wlan_xauth 4 ,
 319 .Xr hostapd 8 ,
 320 .Xr ifconfig 8 ,
 321 .Xr wpa_supplicant 8 .
 322 .Rs
 323 .%T HCF Light programming specification
 324 .%O http://www.wavelan.com
 325 .Re
 326 .Sh HISTORY
 327 The
 328 .Nm
 329 device driver first appeared in
 330 .Fx 3.0 .
 331 .Sh AUTHORS
 332 The original
 333 .Nm
 334 driver was written by
 335 .An Bill Paul Aq wpaul@ctr.columbia.edu .
 336 This man page comes from
 337 .Ox .
 338 .Sh CAVEATS
 339 The driver will reject devices with old firmware to
 340 avoid dealing with numerous defects.
 341 Unfortunately the driver does not support downloading new firmware
 342 to the card so if new firmware is needed users will have to boot
 343 a different system to accomplish this.
 344 .Pp
 345 Intersil Prism cards must have firmware versions 0.8.0 or later and
 346 version 1.7.0 or later are required to support functionality such as WPA.
 347 Some users of Prism-II and 2.5 based cards report that station firmware
 348 version 1.3.4 works better for them in hostap than 1.4.9.
 349 Older versions of the Prism station firmware have a number of issues
 350 with hostap mode.
 351 The IBSS/adhoc mode appears to work well on station firmware 1.3.1 and
 352 later.
 353 The IBSS/adhoc mode appears to have problems for some people with
 354 older versions of station firmware.
 355 .Pp
 356 Lucent cards prior to firmware version 6.0.6 do not implement IBSS
 357 mode and are not supported.
 358 .Pp
 359 Prior versions of
 360 .Nm
 361 supported Symbol firmware.
 362 That support has been removed due to persistent problems with this
 363 firmware as well as getting proper documentation on this firmware.
 364 .Pp
 365 Hermes 2 and Hermes 3 chips are not supported by this driver.
 366 .Pp
 367 Here's the above requirements in the form of a table
 368 .Pp
 369 .Bl -column -compact "Prims II/2.5" "xxxxxxxx" "xxxxxxxx" "xxxxxxxx" "xxxxxxxx"
 370 .Em "Firmware   Minimum WPA     Host AP Adhoc/IBSS"
 371 Prism II/2.5    0.8.0   1.7.0   1.3.4   1.3.1
 372 Prism 3 0.8.0   1.7.0   1.4.9   1.3.1
 373 Hermes  6.0.6   none    none    6.0.6
 374 Symbol  none    none    none    none
 375 .El
 376 .Sh BUGS
 377 Not all the new messages are documented here, and many of them are
 378 indications of transient errors that are not indications of serious
 379 problems.
 380 .Pp
 381 WL200 PCI wireless cards are based on a Cirrus Logic CL-PD6729 bridge
 382 chips glued to an Intersil Prism-II PCMCIA chipset w/o the PC Card
 383 form factor being present.
 384 These chips are special and require special care to use properly.
 385 One must set
 386 .Va hw.pcic.pd6729_intr_path Ns = Ns Qq Li 2
 387 in
 388 .Pa /boot/loader.conf .
 389 This tells the PC Card system to use PCI interrupts for this odd beast.
 390 It is not possible to know automatically which kind of interrupts to use.
 391 OLDCARD devices
 392 support this device.
 393 NEWCARD devices
 394 .Xr ( pccbb 4
 395 and
 396 .Xr pccard 4 )
 397 do not support it at this time.