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