Nuke wicontrol(8).
[dragonfly.git] / 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: src/share/man/man4/wi.4,v 1.9.4.12 2003/03/03 18:59:15 trhodes Exp $
32 .\" $DragonFly: src/share/man/man4/wi.4,v 1.9 2008/02/01 08:18:36 hasso Exp $
33 .\"     $OpenBSD: wi.4tbl,v 1.14 2002/04/29 19:53:50 jsyn Exp $
34 .\"
35 .Dd May 2, 2002
36 .Dt WI 4
37 .Os
38 .Sh NAME
39 .Nm wi
40 .Nd "WaveLAN/IEEE, PRISM-II and Spectrum24 802.11DS wireless network driver"
41 .Sh SYNOPSIS
42 .Cd "device wi"
43 .Sh DESCRIPTION
44 The
45 .Nm
46 driver provides support for wireless network adapters based around
47 the Lucent Hermes, Intersil PRISM-II, Intersil PRISM-2.5, and Symbol
48 Spectrum24 chipsets.
49 All four chipsets provide a similar interface to the driver.
50 .Pp
51 All host/device interaction is via programmed I/O.
52 Supported features include 802.11 and 802.3 frames, power management, BSS,
53 IBSS, WDS and old-style Lucent ad-hoc operation modes.
54 Cards based on the Intersil PRISM-II and PRISM-2.5 chips also support a
55 host-based access point mode which allows a card to act as a normal access
56 point (with some assistance from the
57 .Nm
58 driver).
59 The Lucent Hermes and Symbol Spectrum24 chipsets do not contain this
60 functionality.
61 PRISM-II and PRISM-2.5 chips do not support the WDS functionality.
62 .Pp
63 The
64 .Nm
65 driver encapsulates all IP and ARP traffic as 802.11 frames, however
66 it can receive either 802.11 or 802.3 frames.
67 Transmit speed is selectable between 1Mbps fixed, 2Mbps fixed, 2Mbps
68 with auto fallback, 5.5Mbps, 8Mbps, or 11Mbps depending on your hardware.
69 The Lucent WaveLAN/IEEE Silver and Gold cards as well as the Intersil
70 and Symbol cards have support for WEP encryption.
71 The WaveLAN Gold as well as newer Intersil and Symbol cards support
72 104bit keys, the others only accept 40bit keys.
73 The Lucent WaveLAN/IEEE Bronze cards do not support WEP at all.
74 To enable encryption, use the
75 .Xr ifconfig 8
76 as shown below.
77 .Pp
78 By default, the
79 .Nm
80 driver configures the card for BSS operation (aka infrastructure
81 mode).
82 This mode requires the use of an access point (base station).
83 .Pp
84 The
85 .Nm
86 driver also supports a point-to-point mode where the ssid is
87 ignored and stations can communicate amongst themselves without the
88 aid of an access point.
89 Note that there are two possible point-to-point modes.
90 One mode, referred to as
91 .Dq "ad-hoc demo mode" ,
92 or
93 .Dq "legacy Lucent ad-hoc mode" ,
94 predates the IEEE 802.11 specification and so may not interoperate
95 with cards from different vendors.
96 The standardized point-to-point mode, is called IBSS (or confusingly
97 just ad-hoc mode), but is not supported by cards with very old
98 firmware revisions.
99 If your cards supports IBSS mode, it is recommended that you use it in
100 preference to the
101 .Dq "ad-hoc demo mode"
102 in new installations.
103 .Pp
104 Cards based on the Intersil PRISM-II and PRISM-2.5 chips also
105 have a host-based access point mode which allows the card to
106 act as an access point (base station).
107 Access points are different than operating in IBSS mode.
108 They operate in BSS mode.
109 They allow for easier roaming and bridge all ethernet traffic such
110 that machines connected via an access point appear to be on the local
111 ethernet segment.
112 .Pp
113 For more information on configuring this device, see
114 .Xr ifconfig 8 .
115 .Pp
116 Cards supported by the
117 .Nm
118 driver come in a variety of packages, though the most common
119 are of the PCMCIA type.
120 In many cases, the PCI version of a wireless card is simply
121 a PCMCIA card bundled with a PCI adapter.
122 The PCI adapters come in two flavors: true PCMCIA bridges and
123 dumb PCMCIA bridges.
124 A true PCMCIA bridge (such as those sold by Lucent) will attach
125 as a real PCMCIA controller.
126 The wireless card will then attach to the PCMCIA bus.
127 Wireless cards in PCMCIA slots may be inserted and ejected on the fly.
128 .Pp
129 A dumb bridge, on the other hand, does not show up as a true PCMCIA bus.
130 The wireless card will simply appear to the host as a normal PCI
131 device and will not require any PCMCIA support.
132 Cards in this type of adapter should only be removed when the
133 machine is powered down.
134 .Pp
135 The following cards are among those supported by the
136 .Nm
137 driver:
138 .Pp
139 .Bl -column -compact "Linksys Instant Wireless WPC11 2.5" "Spectrum24" "PCI or PCMCIA"
140 .Em "Card       Chip    Bus"
141 3Com AirConnect 3CRWE737A       Spectrum24      PCMCIA
142 3Com AirConnect 3CRWE777A       Prism-II        PCI
143 ACTIONTEC HWC01170      Prism-2.5       PCMCIA
144 Addtron AWP-100 Prism-II        PCMCIA
145 Adtec Adlink/340C       Prism-II        PCMCIA
146 Agere Orinoco   Hermes  PCMCIA
147 Avaya Wireless  Prism-II        PCMCIA
148 Blue Concentric Circle WL-379F  PRISM-II        CF
149 BreezeNet Wireless      Prism-II        PCMCIA
150 Buffalo WLI-PCM-S11     Prism-II        PCMCIA
151 Buffalo WLI-PCM-L11G    Hermes  PCMCIA
152 Buffalo WLI-CF-S11G     Prism-II        CF
153 Cabletron RoamAbout     Hermes  PCMCIA
154 Compaq Agency NC5004    Prism-II        PCMCIA
155 Compaq WL100    Prism-II        PCMCIA
156 Compaq WL110    Prism-II        PCMCIA
157 Compaq WL200    Prism-II        PCMCIA
158 Contec FLEXLAN/FX-DS110-PCC     Prism-II        PCMCIA
159 Corega PCC-11   Prism-II        PCMCIA
160 Corega PCCA-11  Prism-II        PCMCIA
161 Corega PCCB-11  Prism-II        PCMCIA
162 Corega CGWLPCIA11       Prism-II        PCI
163 Dell TrueMobile 1150    Hermes  PCMCIA
164 Dlink DWL520    Prism-2.5       PCI
165 Dlink DWL650    Prism-2.5       PCMCIA
166 ELSA XI300      Prism-II        PCMCIA
167 ELSA XI800      Prism-II        CF
168 EMTAC A2424i    Prism-II        PCMCIA
169 Ericsson Wireless LAN CARD C11  Spectrum24      PCMCIA
170 Farallon Skyline        Prism-II        PCMCIA
171 Gemtek WL-311   Prism-2.5       PCMCIA
172 Hawking Technology WE110P       Prism-2.5       PCMCIA
173 Home Wireless Networks  Prism-II        PCMCIA
174 IBM High Rate Wireless  Hermes  PCMCIA
175 ICOM SL-1100    Prism-II        PCMCIA
176 I-O DATA WN-B11/PCM     Prism-II        PCMCIA
177 Intel PRO/Wireless 2011 Spectrum24      PCMCIA
178 Intersil Prism II       Prism-II        PCMCIA
179 Intersil Mini-PCI       Prism-2.5       PCI
180 Linksys Instant Wireless WPC11  Prism-II        PCMCIA
181 Linksys Instant Wireless WPC11 2.5      Prism-2.5       PCMCIA
182 Linksys Instant Wireless WPC11 3.0      Prism-3 PCMCIA
183 Lucent WaveLAN  Hermes  PCMCIA
184 Melco Airconnect        Prism-II        PCMCIA
185 NANOSPEED ROOT-RZ2000   Prism-II        PCMCIA
186 NDC/Sohoware NCP130     Prism-II        PCI
187 NEC CMZ-RT-WP   Prism-II        PCMCIA
188 NEC PK-WL001    Prism-II        PCMCIA
189 NEC PC-WL/11C   PRISM-II        PCMCIA
190 Netgear MA401   Prism-II        PCMCIA
191 NTT-ME 11Mbps Wireless LAN      Prism-II        PCMCIA
192 Planex GeoWave/GW-NS110 Prism-II        PCMCIA
193 Planex GW-NS11H Prism-II        PCMCIA
194 Proxim Harmony  Prism-II        PCMCIA
195 Proxim RangeLAN-DS      Prism-II        PCMCIA
196 Samsung MagicLAN SWL-2000N      Prism-II        PCMCIA
197 SMC 2602 EZ Connect (3.3V)      Prism-II        PCI or PCMCIA
198 SMC 2632 EZ Connect     Prism-II        PCMCIA
199 Socket Low Power WLAN-CF        Prism-II        CF
200 Sony PCWA-C100  Lucent  PCMCIA
201 Symbol Spectrum24       Spectrum24      PCMCIA
202 Symbol LA-4100  Spectrum24      CF
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 .El
207 .Pp
208 Several vendors sell PCI adapters built around the PLX Technology 9050
209 or 9052 chip.
210 The following such adapters are supported or expected to work:
211 .Pp
212 .Bl -tag -compact
213 .It 3Com AirConnect 3CRWE777A (3.3V)
214 .It Belkin F5D6000 (a rebadged WL11000P)
215 .It Eumitcom WL11000P
216 .It Global Sun Technology GL24110P (untested)
217 .It Global Sun Technology GL24110P02
218 .It LinkSys WDT11 (a rebadged GL24110P02)
219 .It Netgear MA301
220 .It US Robotics 2415 (rebadged WL11000P)
221 .El
222 .Sh EXAMPLES
223 Join an existing BSS network (ie: connect to an access point):
224 .Pp
225 .Dl "ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00"
226 .Pp
227 Join a specific BSS network with network name
228 .Dq Li my_net :
229 .Pp
230 .Dl "ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
231 .Pp
232 Join a specific BSS network with WEP encryption:
233 .Bd -literal -offset indent
234 ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
235         wepmode on wepkey 0x8736639624
236 .Ed
237 .Pp
238 Join a Lucent legacy demo ad-hoc network with network name
239 .Dq Li my_net :
240 .Bd -literal -offset indent
241 ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
242         mediaopt adhoc
243 .Ed
244 .Pp
245 Create an IBSS network with network name
246 .Dq Li my_net :
247 .Bd -literal -offset indent
248 ifconfig wi0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
249         mediaopt ibss-master
250 .Ed
251 .Pp
252 .Em Note :
253 The infrastructure for
254 .Cm mediaopt ibss-master
255 has not been committed yet.
256 .Pp
257 Join an IBSS network with network name
258 .Dq Li my_net :
259 .Bd -literal -offset indent
260 ifconfig wi0 inet 192.168.0.22 netmask 0xffffff00 ssid my_net \e
261         mediaopt ibss
262 .Ed
263 .Pp
264 .Em Note :
265 The infrastructure for
266 .Cm mediaopt ibss
267 has not been committed yet.
268 .Pp
269 Create a host-based access point (Prism only):
270 .Bd -literal -offset indent
271 ifconfig wi0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
272         mediaopt hostap
273 .Ed
274 .Pp
275 Create a host-based access point with WEP enabled (Prism only):
276 .Bd -literal -offset indent
277 ifconfig wi0 inet 192.168.0.10 netmask 0xffffff00 ssid my_ap \e
278         wepmode on wepkey 0x1234567890 mediaopt hostap
279 .Ed
280 .Pp
281 Create a host-based wireless bridge to fxp0 (Prism only):
282 .Bd -literal -offset indent
283 Add BRIDGE to the kernel config.
284 ifconfig wi0 inet up ssid my_ap mediaopt hostap
285 sysctl net.link.ether.bridge=1
286 sysctl net.link.ether.bridge_cfg="wi0 fxp0"
287 sysctl net.inet.ip.forwarding=1
288 .Ed
289 .Pp
290 This will give you approximately the same functionality as an access
291 point.
292 .Sh DIAGNOSTICS
293 .Bl -diag
294 .It "wi%d: init failed"
295 The WaveLAN card failed to come ready after an initialization command
296 was issued.
297 .It "wi%d: failed to allocate %d bytes on NIC"
298 The driver was unable to allocate memory for transmit frames in the
299 NIC's on-board RAM.
300 .It "wi%d: device timeout"
301 The WaveLAN failed to generate an interrupt to acknowledge a transmit
302 command.
303 .El
304 .Sh SEE ALSO
305 .Xr an 4 ,
306 .Xr arp 4 ,
307 .Xr ifmedia 4 ,
308 .Xr netintro 4 ,
309 .Xr polling 4 ,
310 .Xr hostapd 8 ,
311 .Xr ifconfig 8 ,
312 .Xr wpa_supplicant 8
313 .Rs
314 .%T HCF Light programming specification
315 .%O http://web.archive.org/web/*/http://www.wavelan.com
316 .Re
317 .Sh HISTORY
318 The
319 .Nm
320 device driver first appeared in
321 .Fx 3.0 .
322 .Sh AUTHORS
323 The
324 .Nm
325 driver was written by
326 .An Bill Paul Aq wpaul@ctr.columbia.edu .
327 This man page comes from
328 .Ox .
329 .Sh CAVEATS
330 Different regulatory domains have different default channels for adhoc
331 mode.
332 See
333 .Xr ifconfig 8
334 for information on how to change the channel.
335 .Pp
336 The Intersil Prism family of chips' host-based access point mode has
337 bugs for station firmware versions prior to 0.8.3.
338 The driver currently precludes hostap functionality older station
339 firmware.
340 The best version of the station firmware for the Prism family of chips
341 seems to be 1.4.9.
342 Some users of Prism-II and 2.5 based cards report that station firmware
343 version 1.3.4 works better for them in hostap than 1.4.9.
344 Older versions of the Prism station firmware have a number of issues
345 with hostap mode.
346 The IBSS/adhoc mode appears to work well on station firmware 1.3.1 and
347 later.
348 The IBSS/adhoc mode appears to have problems for some people with
349 older versions of station firmware.
350 .Pp
351 Lucent cards prior to firmware version 6.0.4 do not support IBSS
352 mode.
353 These cards support only the pre 802.11 mode known as
354 .Dq "demo ad-hoc mode"
355 which does not interoperate with stations in IBSS mode.
356 .Sh BUGS
357 Not all the new messages are documented here, and many of them are
358 indications of transient errors that are not indications of serious
359 problems.
360 .Pp
361 WL200 PCI wireless cards are based on a Cirrus Logic CL-PD6729 bridge
362 chips glued to an intersil prism-II pcmcia chipset w/o the PC Card
363 form factor being present.
364 These chips are special and require special care to use properly.
365 One must set
366 .Va hw.pcic.pd6729_intr_path Ns = Ns Qq Li 2
367 in
368 .Pa /boot/loader.conf .
369 This tells the pccard system to use PCI interrupts for this odd beast.
370 It is not possible to know automatically which kind of interrupts to use.
371 OLDCARD devices (pcic and card) support this device.