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 July 16, 2005
  35 .Dt WI 4
  36 .Os
  37 .Sh NAME
  38 .Nm wi
  39 .Nd "Lucent Hermes, Intersil PRISM and Spectrum24 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 wireless network adapters based around
  59 the Lucent Hermes, Intersil PRISM-II, Intersil PRISM-2.5, Intersil
  60 Prism-3, and Symbol Spectrum24 chipsets.
  61 All five chipsets provide a similar interface to the driver.
  62 .Pp
  63 Supported features include 802.11 and 802.3 frames, power management, BSS,
  64 IBSS, WDS and old-style Lucent ad-hoc operation modes.
  65 Cards based on the Intersil PRISM chips also support a host-based
  66 access point mode which allows a card to act as a normal access point
  67 (with some assistance from the
  68 .Nm
  69 driver).
  70 The Lucent Hermes and Symbol Spectrum24 chipsets do not contain this
  71 functionality.
  72 The PRISM family of chips do not support the WDS functionality.
  73 All host/device interaction is via programmed I/O, even on those cards
  74 that support a DMA interface.
  75 .Pp
  76 The
  77 .Nm
  78 driver encapsulates all IP and ARP traffic as 802.11 frames, however
  79 it can receive either 802.11 or 802.3 frames.
  80 Transmit speed is selectable between 1Mbps, 2Mbps, 5.5 Mbps and 11Mbps
  81 depending on your hardware.
  82 Most hardware supports 11Mbps where the signal quality allows, but
  83 falls back to slower speeds when it does not.
  84 Except for the Lucent WaveLAN Bronze cards, all cards supported by the
  85 .Nm
  86 driver support WEP for encryption.
  87 To enable encryption, use
  88 .Xr ifconfig 8
  89 as shown below.
  90 .Pp
  91 By default, the
  92 .Nm
  93 driver configures the card for BSS operation (aka infrastructure
  94 mode).
  95 This mode requires the use of an access point (base station).
  96 .Pp
  97 The
  98 .Nm
  99 driver also supports a point-to-point mode
 100 where stations can communicate amongst themselves without the
 101 aid of an access point.
 102 Note that there are two possible point-to-point modes.
 103 One mode, referred to as
 104 .Dq "ad-hoc demo mode" ,
 105 or
 106 .Dq "legacy Lucent ad-hoc mode" ,
 107 predates the IEEE 802.11 specification and so may not interoperate
 108 with cards from different vendors.
 109 The standardized point-to-point mode is called IBSS (or confusingly
 110 just ad-hoc mode), but is not supported by cards with very old
 111 firmware revisions.
 112 If your cards supports IBSS mode, it is recommended that you use it in
 113 preference to the
 114 .Dq "ad-hoc demo mode"
 115 in new installations.
 116 .Pp
 117 Cards supported by the driver based on the Intersil PRISM family of chips also
 118 have a host-based access point mode which allows the card to
 119 act as an access point (base station).
 120 Access points are different than operating in IBSS mode.
 121 They operate in BSS mode.
 122 They allow for easier roaming and bridge all Ethernet traffic such
 123 that machines connected via an access point appear to be on the local
 124 Ethernet segment.
 125 .Pp
 126 For more information on configuring this device, see
 127 .Xr ifconfig 8 .
 128 .Pp
 129 Cards supported by the
 130 .Nm
 131 driver come in a variety of packages, though the most common
 132 are of the PCMCIA type.
 133 In many cases, the PCI version of a wireless card is simply
 134 a PCMCIA card bundled with a PCI adapter.
 135 The PCI adapters come in two flavors: true PCMCIA bridges and
 136 dumb PCMCIA bridges.
 137 A true PCMCIA bridge (such as those sold by Lucent) will attach
 138 as a real PCMCIA controller.
 139 The wireless card will then attach to the PCMCIA bus.
 140 Wireless cards in PCMCIA slots may be inserted and ejected on the fly.
 141 .Pp
 142 A dumb bridge, on the other hand, does not show up as a true PCMCIA bus.
 143 The wireless card will simply appear to the host as a normal PCI
 144 device and will not require any PCMCIA support.
 145 Cards in this type of adapter should only be removed when the
 146 machine is powered down.
 147 .Pp
 148 The following cards are among those supported by the
 149 .Nm
 150 driver:
 151 .Pp
 152 .Bl -column -compact "Linksys Instant Wireless WPC11 2.5" "Spectrum24" "PCI or PCMCIA"
 153 .Em "Card       Chip    Bus"
 154 3Com AirConnect 3CRWE737A       Spectrum24      PCMCIA
 155 3Com AirConnect 3CRWE777A       Prism-II        PCI
 156 Accton airDirect WN3301         PCMCIA
 157 ACTIONTEC HWC01170      Prism-2.5       PCMCIA
 158 Adaptech ANW-8030       Prism-3 PCMCIA
 159 Addtron AWP-100 Prism-II        PCMCIA
 160 Adtec Adlink/340C       Prism-II        PCMCIA
 161 Airvast WN 100  Prism-3 PCMCIA
 162 Airway 802.11 Adapter           PCMCIA
 163 Agere Orinoco   Hermes  PCMCIA
 164 Allied Telesis WR211PCM Prism-II        PCMCIA
 165 ArTem OnAir     Prism?  PCMCIA
 166 Asus WL100      Prism-2.5       PCMCIA
 167 Avaya Wireless  Prism-II        PCMCIA
 168 Bay eMobility 11B       Prism-2.5?      PCMCIA
 169 Blue Concentric Circle WL-379F  Prism-II        CF
 170 BreezeNet Wireless      Prism-II        PCMCIA
 171 Buffalo WLI-PCM-S11     Prism-II        PCMCIA
 172 Buffalo WLI-PCM-L11G    Hermes  PCMCIA
 173 Buffalo WLI-CF-S11G     Prism-II        CF
 174 Buffalo WLI2-CF-S11G    Prism 2.5       CF
 175 Cabletron RoamAbout     Hermes  PCMCIA
 176 Compaq Agency NC5004    Prism-II        PCMCIA
 177 Compaq WL100    Prism-II        PCMCIA
 178 Compaq WL110    Hermes  PCMCIA
 179 Compaq WL200    Prism-II        PCMCIA
 180 Contec FLEXLAN/FX-DS110-PCC     Prism-II        PCMCIA
 181 Corega PCC-11   Prism-II        PCMCIA
 182 Corega PCCA-11  Prism-II        PCMCIA
 183 Corega PCCB-11  Prism-II        PCMCIA
 184 Corega CGWLPCIA11       Prism-II        PCI
 185 Dell TrueMobile 1150    Hermes  PCMCIA
 186 Dlink Air 660   Prism-II        PCMCIA
 187 Dlink DWL520    Prism-2.5       PCI
 188 Dlink DWL650    Prism-2.5       PCMCIA
 189 ELECOM Air@Hawk/LD-WL11/PCC             PCMCIA
 190 ELSA MC-11              PCMCIA
 191 ELSA XI300      Prism-II        PCMCIA
 192 ELSA XI800      Prism-II        CF
 193 EMTAC A2424i    Prism-II        PCMCIA
 194 Ericsson Wireless LAN CARD C11  Spectrum24      PCMCIA
 195 Farallon Skyline        Prism-II        PCMCIA
 196 Gemtek WL-311   Prism-2.5       PCMCIA
 197 Hawking Technology WE110P       Prism-2.5       PCMCIA
 198 Home Wireless Networks  Prism-II        PCMCIA
 199 IBM High Rate Wireless  Hermes  PCMCIA
 200 ICOM SL-1100    Prism-II        PCMCIA
 201 I-O DATA WN-B11/PCM     Prism-II        PCMCIA
 202 Intel PRO/Wireless 2011 Spectrum24      PCMCIA
 203 Intersil Prism II       Prism-II        PCMCIA
 204 Intersil Mini-PCI       Prism-2.5       PCI
 205 Intersil ISL37100P      Prism-3         PCMCIA
 206 Intersil ISL37110P      Prism-3         PCMCIA
 207 Intersil ISL37300P      Prism-3         PCMCIA
 208 Laneed Wireless         PCMCIA
 209 Linksys Instant Wireless WPC11  Prism-II        PCMCIA
 210 Linksys Instant Wireless WPC11 2.5      Prism-2.5       PCMCIA
 211 Linksys Instant Wireless WPC11 3.0      Prism-3 PCMCIA
 212 Linksys WCF11   Prism-3 PCMCIA
 213 Linksys WCF12   Prism-3 CF
 214 Lucent WaveLAN  Hermes  PCMCIA
 215 Melco Airconnect        Prism-II        PCMCIA
 216 Microsoft MN-520 WLAN   Prism-II        PCMCIA
 217 NANOSPEED ROOT-RZ2000   Prism-II        PCMCIA
 218 NCR WaveLAN/IEEE 802.11         PCMCIA
 219 NDC/Sohoware NCP130     Prism-II        PCI
 220 NEC CMZ-RT-WP   Prism-II        PCMCIA
 221 NEC PK-WL001    Lucent  PCMCIA
 222 NEC PC-WL/11C   Prism-II        PCMCIA
 223 Netgear MA311   Prism-2.5       PCI
 224 Netgear MA401   Prism-II/2.5    PCMCIA
 225 Netgear MA401RA Prism-II        PCMCIA
 226 Netgear MA701   Prism-II        CF
 227 NOKIA C020 WLAN Prism-II        PCMCIA
 228 NOKIA C110 WLAN Prism-2.5       PCMCIA
 229 NTT-ME 11Mbps Wireless LAN      Prism-II        PCMCIA
 230 Planex GeoWave/GW-NS110 Prism-II        PCMCIA
 231 Planex GW-NS11H Prism-II        PCMCIA
 232 Proxim Harmony  Prism-II        PCMCIA
 233 Proxim RangeLAN-DS      Prism-II        PCMCIA
 234 Samsung MagicLAN SWL-2000N      Prism-II        PCMCIA
 235 SENAO SL-2511CD Prism-3 PCMCIA
 236 Siemens SpeedStream SS1021      Prism-II        PCMCIA
 237 SMC 2602 EZ Connect (3.3V)      Prism-II        PCI or PCMCIA
 238 SMC 2632 EZ Connect     Prism-II        PCMCIA
 239 Socket Low Power WLAN-CF        Prism-II        CF
 240 Sony PCWA-C100  Lucent  PCMCIA
 241 Sony PEGA-WL110 Prism-2.5       PCMCIA
 242 Symbol Spectrum24       Spectrum24      PCMCIA
 243 Symbol LA-4100  Spectrum24      CF
 244 TDK LAK-CD011WL Prism-II        PCMCIA
 245 Toshiba Wireless LAN Card       Prism-II        PCMCIA
 246 U.S.\& Robotics Wireless Card 2410      Prism-II        PCMCIA
 247 YIS YWL-11B     Prism-II        PCMCIA
 248 .El
 249 .Pp
 250 Several vendors sell PCI adapters built around the PLX Technology 9050
 251 or 9052 chip.
 252 The following such adapters are supported or expected to work:
 253 .Pp
 254 .Bl -item -compact
 255 .It
 256 3Com AirConnect 3CRWE777A (3.3V)
 257 .It
 258 Belkin F5D6000 (a rebadged WL11000P)
 259 .It
 260 Eumitcom WL11000P
 261 .It
 262 Global Sun Technology GL24110P (untested)
 263 .It
 264 Global Sun Technology GL24110P02
 265 .It
 266 LinkSys WDT11 (a rebadged GL24110P02)
 267 .It
 268 Netgear MA301
 269 .It
 270 US Robotics 2415 (rebadged WL11000P)
 271 .It
 272 Wisecom Wireless LAN PCI Adapter
 273 .El
 274 .Pp
 275 The following adapters have the same model numbers as those listed
 276 above, but might not work if the actual card is after the change away
 277 from the Prism family:
 278 .Pp
 279 .Bl -item -compact
 280 .It
 281 DLink DWL520
 282 .El
 283 .Sh EXAMPLES
 284 Join an existing BSS network (ie: connect to an access point):
 285 .Pp
 286 .Dl "ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00"
 287 .Pp
 288 Join a specific BSS network with network name
 289 .Dq Li my_net :
 290 .Pp
 291 .Dl "ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
 292 .Pp
 293 Join a specific BSS network with WEP encryption:
 294 .Bd -literal -offset indent
 295 ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 296         wepmode on wepkey 0x8736639624
 297 .Ed
 298 .Pp
 299 Join a Lucent legacy demo ad-hoc network with network name
 300 .Dq Li my_net :
 301 .Bd -literal -offset indent
 302 ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
 303         media DS/11Mbps mediaopt adhoc,link0
 304 .Ed
 305 .Pp
 306 Join/create an IBSS network with network name
 307 .Dq Li my_net :
 308 .Bd -literal -offset indent
 309 ifconfig wi0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e
 310         media DS/11Mbps mediaopt adhoc
 311 .Ed
 312 .Pp
 313 Create a host-based access point (Prism only):
 314 .Bd -literal -offset indent
 315 ifconfig wi0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
 316         media DS/11Mbps mediaopt hostap
 317 .Ed
 318 .Pp
 319 Create a host-based access point with WEP enabled (Prism only):
 320 .Bd -literal -offset indent
 321 ifconfig wi0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
 322         wepmode on wepkey 0x1234567890 media DS/11Mbps \e
 323         mediaopt hostap
 324 .Ed
 325 .Pp
 326 Create a host-based wireless bridge to fxp0 (Prism only):
 327 .Bd -literal -offset indent
 328 ifconfig wi0 inet up ssid my_ap media DS/11Mbps mediaopt hostap
 329 sysctl net.inet.ip.check_interface=0
 330 ifconfig bridge0 create
 331 ifconfig bridge0 addm wi0 addm fxp0 up
 332 .Ed
 333 .Pp
 334 This will give you the same functionality as an access point.
 335 .Sh DIAGNOSTICS
 336 .Bl -diag
 337 .It "wi%d: init failed"
 338 The WaveLAN card failed to become ready after an initialization command
 339 was issued.
 340 .It "wi%d: failed to allocate %d bytes on NIC"
 341 The driver was unable to allocate memory for transmit frames in the
 342 NIC's on-board RAM.
 343 This can also be an indication of an incorrectly configured interrupt.
 344 .It "wi%d: device timeout"
 345 The WaveLAN card failed to generate an interrupt to acknowledge a transmit
 346 command.
 347 .El
 348 .Sh SEE ALSO
 349 .Xr altq 4 ,
 350 .Xr an 4 ,
 351 .Xr arp 4 ,
 352 .Xr ath 4 ,
 353 .Xr card 4 ,
 354 .Xr netintro 4 ,
 355 .Xr pccard 4 ,
 356 .Xr pccbb 4 ,
 357 .Xr pcic 4 ,
 358 .Xr wlan 4 ,
 359 .Xr ifconfig 8 ,
 360 .Xr wicontrol 8
 361 .Rs
 362 .%T HCF Light programming specification
 363 .%O http://www.wavelan.com
 364 .Re
 365 .Sh HISTORY
 366 The
 367 .Nm
 368 device driver first appeared in
 369 .Fx 3.0 .
 370 .Sh AUTHORS
 371 The
 372 .Nm
 373 driver was written by
 374 .An Bill Paul Aq wpaul@ctr.columbia.edu .
 375 This man page comes from
 376 .Ox .
 377 .Sh CAVEATS
 378 Different regulatory domains have different default channels for adhoc
 379 mode.
 380 See
 381 .Xr ifconfig 8
 382 for information on how to change the channel.
 383 See
 384 .Xr wicontrol 8
 385 for information on different regulatory domains.
 386 .Pp
 387 The Intersil Prism family of chips' host-based access point mode has
 388 bugs for station firmware versions prior to 0.8.3.
 389 The driver currently precludes hostap functionality with older station
 390 firmware.
 391 The best version of the station firmware for the Prism family of chips
 392 seems to be 1.4.9.
 393 Some users of Prism-II and 2.5 based cards report that station firmware
 394 version 1.3.4 works better for them in hostap than 1.4.9.
 395 Older versions of the Prism station firmware have a number of issues
 396 with hostap mode.
 397 The IBSS/adhoc mode appears to work well on station firmware 1.3.1 and
 398 later.
 399 The IBSS/adhoc mode appears to have problems for some people with
 400 older versions of station firmware.
 401 .Pp
 402 Lucent cards prior to firmware version 6.0.6 do not support IBSS
 403 mode.
 404 These cards support only the pre-802.11 mode known as
 405 .Dq "demo ad-hoc mode"
 406 which does not interoperate with stations in IBSS mode.
 407 .Pp
 408 Prism cards prior to version 0.8.0 do not support IBSS mode.
 409 .Pp
 410 Symbol cards prior to version 2.50.00 do not support IBSS mode.
 411 .Sh BUGS
 412 Not all the new messages are documented here, and many of them are
 413 indications of transient errors that are not indications of serious
 414 problems.
 415 .Pp
 416 WL200 PCI wireless cards are based on a Cirrus Logic CL-PD6729 bridge
 417 chips glued to an Intersil Prism-II PCMCIA chipset w/o the PC Card
 418 form factor being present.
 419 These chips are special and require special care to use properly.
 420 One must set
 421 .Va hw.pcic.pd6729_intr_path Ns = Ns Qq Li 2
 422 in
 423 .Pa /boot/loader.conf .
 424 This tells the PC Card system to use PCI interrupts for this odd beast.
 425 It is not possible to know automatically which kind of interrupts to use.
 426 OLDCARD devices
 427 .Xr ( pcic 4
 428 and
 429 .Xr card 4 )
 430 support this device.
 431 NEWCARD devices
 432 .Xr ( pccbb 4
 433 and
 434 .Xr pccard 4 )
 435 do not support it at this time.