freebsd-dev/share/man/man4/wi.4
Warner Losh 00e416592e Add a bunch of cards that we've added IDs for in the past few months:
+Allied Telesis WR211PCM        Prism?  PCMCIA
+ArTem OnAir    Prism?  PCMCIA
+Bay eMobility 11B      Prism-2.5?      PCMCIA
+Blue Concentric Circle WL-379F Prism-II        CF
+Linksys WCF11  Prism-3 PCMCIA
+YIS TWL-11B    Prism-II        PCMCIA
2003-02-17 18:21:51 +00:00

336 lines
11 KiB
Groff

.\" Copyright (c) 1997, 1998, 1999
.\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Bill Paul.
.\" 4. Neither the name of the author nor the names of any co-contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\" $OpenBSD: wi.4tbl,v 1.14 2002/04/29 19:53:50 jsyn Exp $
.\"
.Dd January
.Dt WI 4
.Os
.Sh NAME
.Nm wi
.Nd "Lucent Heremes, Intersil PRISM and Spectrum24 IEEE 802.11 driver"
.Sh SYNOPSIS
.Cd "device wi"
.Sh DESCRIPTION
The
.Nm
driver provides support for wireless network adapters based around
the Lucent Hermes, Intersil PRISM-II, Intersil PRISM-2.5, Intersil
Prism-3, and Symbol Spectrum24 chipsets.
All five chipsets provide a similar interface to the driver.
.Pp
Supported features include 802.11 and 802.3 frames, power management, BSS,
IBSS, WDS and old-style Lucent ad-hoc operation modes.
Cards based on the Intersil PRISM chips also support a host-based
access point mode which allows a card to act as a normal access point
(with some assistance from the
.Nm
driver).
The Lucent Hermes and Symbol Spectrum24 chipsets do not contain this
functionality.
The PRISM family of chips do not support the WDS functionality.
All host/device interaction is via programmed I/O, even on those cards
that support a DMA interface.
.Pp
The
.Nm
driver encapsulates all IP and ARP traffic as 802.11 frames, however
it can receive either 802.11 or 802.3 frames.
Transmit speed is selectable between 1Mbps, 2Mbps, 5.5 Mbps and 11Mbps
depending on your hardware.
Most hardware supports 11Mbps where the signal quality allows, but
falls back to slower speeds when it does not.
Except for the Lucent WaveLAN Bronze cards, all cards supported by the
.Nm
driver support WEP for encryption.
To enable encryption, use the
.Xr ifconfig 8
as shown below.
.Pp
By default, the
.Nm
driver configures the card for BSS operation (aka infrastructure
mode).
This mode requires the use of an access point (base station).
.Pp
The
.Nm
driver also supports a point-to-point mode
where stations can communicate amongst themselves without the
aid of an access point.
Note that there are two possible point-to-point modes.
One mode, referred to as
.Dq "ad-hoc demo mode" ,
or
.Dq "legacy Lucent ad-hoc mode" ,
predates the IEEE 802.11 specification and so may not interoperate
with cards from different vendors.
The standardized point-to-point mode, is called IBSS (or confusingly
just ad-hoc mode), but is not supported by cards with very old
firmware revisions.
If your cards supports IBSS mode, it is recommended that you use it in
preference to the
.Dq "ad-hoc demo mode"
in new installations.
.Pp
Cards based on the Intersil PRISM family of chips also
have a host-based access point mode which allows the card to
act as an access point (base station).
Access points are different than operating in IBSS mode.
They operate in BSS mode.
They allow for easier roaming and bridge all ethernet traffic such
that machines connected via an access point appear to be on the local
ethernet segment.
.Pp
For more information on configuring this device, see
.Xr ifconfig 8 .
.Pp
Cards supported by the
.Nm
driver come in a variety of packages, though the most common
are of the PCMCIA type.
In many cases, the PCI version of a wireless card is simply
a PCMCIA card bundled with a PCI adapter.
The PCI adapters come in two flavors: true PCMCIA bridges and
dumb PCMCIA bridges.
A true PCMCIA bridge (such as those sold by Lucent) will attach
as a real PCMCIA controller.
The wireless card will then attach to the PCMCIA bus.
Wireless cards in PCMCIA slots may be inserted and ejected on the fly.
.Pp
A dumb bridge, on the other hand, does not show up as a true PCMCIA bus.
The wireless card will simply appear to the host as a normal PCI
device and will not require any PCMCIA support.
Cards in this type of adapter should only be removed when the
machine is powered down.
.Pp
The following cards are among those supported by the
.Nm
driver:
.Pp
.Bl -column -compact "Linksys Instant Wireless WPC11 2.5" "Spectrum24" "PCI or PCMCIA"
.Em "Card Chip Bus"
3Com AirConnect 3CRWE737A Spectrum24 PCMCIA
3Com AirConnect 3CRWE777A Prism-II PCI
ACTIONTEC HWC01170 Prism-2.5 PCMCIA
Addtron AWP-100 Prism-II PCMCIA
Adtec Adlink/340C Prism-II PCMCIA
Agere Orinoco Hermes PCMCIA
Allied Telesis WR211PCM Prism? PCMCIA
ArTem OnAir Prism? PCMCIA
Avaya Wireless Prism-II PCMCIA
Bay eMobility 11B Prism-2.5? PCMCIA
Blue Concentric Circle WL-379F Prism-II CF
BreezeNet Wireless Prism-II PCMCIA
Buffalo WLI-PCM-S11 Prism-II PCMCIA
Buffalo WLI-PCM-L11G Hermes PCMCIA
Buffalo WLI-CF-S11G Prism-II CF
Cabletron RoamAbout Hermes PCMCIA
Compaq Agency NC5004 Prism-II PCMCIA
Compaq WL100 Prism-II PCMCIA
Compaq WL110 Prism-II PCMCIA
Compaq WL200 Prism-II PCMCIA
Contec FLEXLAN/FX-DS110-PCC Prism-II PCMCIA
Corega PCC-11 Prism-II PCMCIA
Corega PCCA-11 Prism-II PCMCIA
Corega PCCB-11 Prism-II PCMCIA
Corega CGWLPCIA11 Prism-II PCI
Dell TrueMobile 1150 Hermes PCMCIA
Dlink Air 660 Prism-II PCMCIA
Dlink DWL520 Prism-2.5 PCI
Dlink DWL650 Prism-2.5 PCMCIA
ELSA XI300 Prism-II PCMCIA
ELSA XI800 Prism-II CF
EMTAC A2424i Prism-II PCMCIA
Ericsson Wireless LAN CARD C11 Spectrum24 PCMCIA
Farallon Skyline Prism-II PCMCIA
Gemtek WL-311 Prism-2.5 PCMCIA
Hawking Technology WE110P Prism-2.5 PCMCIA
Home Wireless Networks Prism-II PCMCIA
IBM High Rate Wireless Hermes PCMCIA
ICOM SL-1100 Prism-II PCMCIA
I-O DATA WN-B11/PCM Prism-II PCMCIA
Intel PRO/Wireless 2011 Spectrum24 PCMCIA
Intersil Prism II Prism-II PCMCIA
Intersil Mini-PCI Prism-2.5 PCI
Linksys Instant Wireless WPC11 Prism-II PCMCIA
Linksys Instant Wireless WPC11 2.5 Prism-2.5 PCMCIA
Linksys Instant Wireless WPC11 3.0 Prism-3 PCMCIA
Linksys WCF11 Prism-3 PCMCIA
Lucent WaveLAN Hermes PCMCIA
Melco Airconnect Prism-II PCMCIA
NANOSPEED ROOT-RZ2000 Prism-II PCMCIA
NDC/Sohoware NCP130 Prism-II PCI
NEC CMZ-RT-WP Prism-II PCMCIA
NEC PK-WL001 Prism-II PCMCIA
NEC PC-WL/11C Prism-II PCMCIA
Netgear MA401 Prism-II PCMCIA
NTT-ME 11Mbps Wireless LAN Prism-II PCMCIA
Planex GeoWave/GW-NS110 Prism-II PCMCIA
Planex GW-NS11H Prism-II PCMCIA
Proxim Harmony Prism-II PCMCIA
Proxim RangeLAN-DS Prism-II PCMCIA
Samsung MagicLAN SWL-2000N Prism-II PCMCIA
SMC 2602 EZ Connect (3.3V) Prism-II PCI or PCMCIA
SMC 2632 EZ Connect Prism-II PCMCIA
Socket Low Power WLAN-CF Prism-II CF
Sony PCWA-C100 Lucent PCMCIA
Symbol Spectrum24 Spectrum24 PCMCIA
Symbol LA-4100 Spectrum24 CF
TDK LAK-CD011WL Prism-II PCMCIA
Toshiba Wireless LAN Card Prism-II PCMCIA
U.S. Robotics Wireless Card 2410 Prism-II PCMCIA
YIS TWL-11B Prism-II PCMCIA
.El
.Pp
Several vendors sell PCI adapters built around the PLX Technology 9050
or 9052 chip.
The following such adapters are supported or expected to work:
.Pp
.Bl -tag -compact
.It 3Com AirConnect 3CRWE777A (3.3V)
.It Belkin F5D6000 (a rebadged WL11000P)
.It Eumitcom WL11000P
.It Global Sun Technology GL24110P (untested)
.It Global Sun Technology GL24110P02
.It LinkSys WDT11 (a rebadged GL24110P02)
.It Netgear MA301
.It US Robotics 2415 (rebadged WL11000P)
.It Wisecom Wireless LAN PCI Adapter
.El
.Sh EXAMPLES
Join an existing BSS network (ie: connect to an access point):
.Pp
.Dl "ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00"
.Pp
Join a specific BSS network with network name
.Dq Li my_net :
.Pp
.Dl "ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
.Pp
Join a specific BSS network with WEP encryption:
.Bd -literal -offset indent
ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
wepmode on wepkey 0x8736639624
.Ed
.Pp
Join a Lucent legacy demo ad-hoc network with network name
.Dq Li my_net :
.Bd -literal -offset indent
ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
media DS/11Mbps mediaopt adhoc,link0
.Ed
.Pp
Join/create an IBSS network with network name
.Dq Li my_net :
.Bd -literal -offset indent
ifconfig wi0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e
media DS/11Mbps mediaopt adhoc
.Ed
.Pp
Create a host-based access point (Prism only):
.Bd -literal -offset indent
ifconfig wi0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
media DS/11Mbps mediaopt hostap
.Ed
.Pp
Create a host-based access point with WEP enabled (Prism only):
.Bd -literal -offset indent
ifconfig wi0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
wepmode on wepkey 0x1234567890 media DS/11Mbps mediaopt hostap
.Ed
.Pp
Create a host-based wireless bridge to fxp0 (Prism only):
.Bd -literal -offset indent
Add BRIDGE to the kernel config.
ifconfig wi0 inet up ssid my_ap media DS/11Mbps mediaopt hostap
sysctl net.link.ether.bridge=1
sysctl net.link.ether.bridge_cfg="wi0 fxp0"
sysctl net.inet.ip.forwarding=1
.Ed
.Pp
This will give you the same functionality as an access point.
.Sh DIAGNOSTICS
.Bl -diag
.It "wi%d: init failed"
The WaveLAN card failed to come ready after an initialization command
was issued.
.It "wi%d: failed to allocate %d bytes on NIC"
The driver was unable to allocate memory for transmit frames in the
NIC's on-board RAM.
This can also be an indication of an incorrectly configured interrupt.
.It "wi%d: device timeout"
The WaveLAN failed to generate an interrupt to acknowledge a transmit
command.
.El
.Sh SEE ALSO
.Xr an 4 ,
.Xr arp 4 ,
.Xr netintro 4 ,
.Xr ifconfig 8 ,
.Xr wicontrol 8
.Rs
.%T HCF Light programming specification
.%O http://www.wavelan.com
.Re
.Sh HISTORY
The
.Nm
device driver first appeared in
.Fx 3.0 .
.Sh AUTHORS
The
.Nm
driver was written by
.An Bill Paul Aq wpaul@ctr.columbia.edu .
This man page comes from
.Ox .
.Sh CAVEATS
Different regulatory domains have different default channels for adhoc
mode.
See
.Xr ifconfig 8
for information on how to change the channel.
See
.Xr wicontrol 8
for information on different regulatory domains.
.Pp
The Intersil Prism family of chips' host-based access point mode has
bugs for firmware versions prior to 0.8.3.
The driver currently precludes hostap functionality on old firmware.
.Pp
Lucent cards prior to firmware version 6.0.4 do not support IBSS
mode.
.Sh BUGS
Not all the new messages are documented here, and many of them are
indications of transient errors that are not indications of serious
problems.