xref: /freebsd/share/man/man4/wpi.4 (revision fcb560670601b2a4d87bb31d7531c8dcc37ee71b)
1.\" Copyright (c) 2004-2007
2.\"	Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
3.\"	Benjamin Close <Benjamin.Close@clearchain.com>. All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice unmodified, this list of conditions, and the following
10.\"    disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" $FreeBSD$
28.\"
29.Dd October 5, 2008
30.Dt WPI 4
31.Os
32.Sh NAME
33.Nm wpi
34.Nd "Intel 3945ABG Wireless LAN IEEE 802.11 driver"
35.Sh SYNOPSIS
36To compile this driver into the kernel,
37place the following lines in your
38kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device wpi"
41.Cd "device wpifw"
42.Cd "device pci"
43.Cd "device wlan"
44.Cd "device wlan_amrr"
45.Cd "device firmware"
46.Ed
47.Pp
48Alternatively, to load the driver as a
49module at boot time, place the following line in
50.Xr loader.conf 5 :
51.Bd -literal -offset indent
52if_wpi_load="YES"
53.Ed
54.Sh DESCRIPTION
55The
56.Nm
57driver provides support for the
58.Tn Intel
593945ABG Wireless network adapter.
60.Nm
61supports
62.Cm station ,
63.Cm adhoc ,
64and
65.Cm monitor
66mode operation.
67Only one virtual interface may be configured at any time.
68For more information on configuring this device, see
69.Xr ifconfig 8 .
70.Pp
71This driver requires the firmware built with the
72.Nm wpifw
73module to work.
74.Sh FILES
75.Bl -tag -width ".Pa /usr/share/doc/legal/intel_wpi/LICENSE" -compact
76.It Pa /usr/share/doc/legal/intel_wpi/LICENSE
77.Nm
78firmware license
79.El
80.Sh EXAMPLES
81Join an existing BSS network (i.e., connect to an access point):
82.Bd -literal -offset indent
83ifconfig wlan0 create wlandev wpi0 inet 192.168.0.20 \e
84    netmask 0xffffff00
85.Ed
86.Pp
87Join a specific BSS network with network name
88.Dq Li my_net :
89.Pp
90.Dl "ifconfig wlan0 create wlandev wpi0 ssid my_net up"
91.Pp
92Join a specific BSS network with 64-bit WEP encryption:
93.Bd -literal -offset indent
94ifconfig wlan0 create wlandev wpi0 ssid my_net \e
95	wepmode on wepkey 0x1234567890 weptxkey 1 up
96.Ed
97.Pp
98Join a specific BSS network with 128-bit WEP encryption:
99.Bd -literal -offset indent
100ifconfig wlan0 create wlandev wpi0 wlanmode adhoc ssid my_net \e
101    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
102.Ed
103.Sh DIAGNOSTICS
104.Bl -diag
105.It "wpi%d: could not load firmware image '%s'"
106The driver failed to load the firmware image using the
107.Xr firmware 9
108subsystem.
109Verify the
110.Xr wpifw
111firmware module is installed.
112.It "wpi%d: fatal firmware error"
113An unknown error has occurred in the uploaded firmware, you may have to
114unload/reload the driver to continue.
115.It "wpi%d: Radio transmitter is switched off"
116The hardware switch controlling the radio is currently turned off.
117Data transmission is not possible in this state.
118.El
119.Sh SEE ALSO
120.Xr pci 4 ,
121.Xr wlan 4 ,
122.Xr wlan_ccmp 4 ,
123.Xr wlan_tkip 4 ,
124.Xr wlan_wep 4 ,
125.Xr wpifw 4 ,
126.Xr ifconfig 8 ,
127.Xr wpa_supplicant 8
128.Sh AUTHORS
129.An -nosplit
130The original
131.Nm
132driver was written for
133.Ox
134by
135.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
136.An Benjamin Close Aq Mt benjsc@FreeBSD.org
137ported
138.Nm
139to
140.Fx .
141.Sh BUGS
142Not all the error messages are documented here.
143.Pp
144Background scanning is not currently supported.
145