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