xref: /openbsd/share/man/man4/wpi.4 (revision 404b540a)
1.\" $OpenBSD: wpi.4,v 1.25 2009/09/02 07:00:24 jmc Exp $
2.\"
3.\" Copyright (c) 2006, 2007
4.\"	Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice unmodified, this list of conditions, and the following
11.\"    disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd $Mdocdate: September 2 2009 $
29.Os
30.Dt WPI 4
31.Sh NAME
32.Nm wpi
33.Nd Intel PRO/Wireless 3945ABG IEEE 802.11a/b/g wireless network device
34.Sh SYNOPSIS
35.Cd "wpi* at pci?"
36.Sh DESCRIPTION
37The
38.Nm
39driver provides support for
40.Tn Intel
41PRO/Wireless 3945ABG Mini PCI Express network adapters.
42.Pp
43These are the modes the
44.Nm
45driver can operate in:
46.Bl -tag -width "IBSS-masterXX"
47.It BSS mode
48Also known as
49.Em infrastructure
50mode, this is used when associating with an access point, through
51which all traffic passes.
52This mode is the default.
53.It monitor mode
54In this mode the driver is able to receive packets without
55associating with an access point.
56This disables the internal receive filter and enables the card to
57capture packets from networks which it wouldn't normally have access to,
58or to scan for access points.
59.El
60.Pp
61The
62.Nm
63driver can be configured to use
64Wired Equivalent Privacy (WEP) or
65Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
66WPA is the de facto encryption standard for wireless networks.
67It is strongly recommended that WEP
68not be used as the sole mechanism
69to secure wireless communication,
70due to serious weaknesses in it.
71The
72.Nm
73driver offloads both encryption and decryption of unicast data frames to the
74hardware for the CCMP cipher.
75.Pp
76The device has one temperature sensor.
77Its value is in the range from 0 (coolest) to 285 (warmest).
78Sensor data is updated every 500 milliseconds.
79.Pp
80The
81.Nm
82driver can be configured at runtime with
83.Xr ifconfig 8
84or on boot with
85.Xr hostname.if 5 .
86.Sh FILES
87The driver needs at least version 3.1 of the following firmware file,
88which is loaded when an interface is brought up:
89.Pp
90.Bl -tag -width Ds -offset indent -compact
91.It Pa /etc/firmware/wpi-3945abg
92.El
93.Pp
94This firmware file is not free because Intel refuses to grant
95distribution rights without contractual obligations.
96As a result, even though
97.Ox
98includes the driver, the firmware file cannot be included and
99users have to download this file on their own.
100.Pp
101A prepackaged version of the firmware, designed to be used with
102.Xr pkg_add 1 ,
103can be found at:
104.Bd -literal
105http://damien.bergamini.free.fr/packages/openbsd/wpi-firmware-3.2.tgz
106.Ed
107.Sh EXAMPLES
108The following
109.Xr hostname.if 5
110example configures wpi0 to join whatever network is available on boot,
111using WEP key
112.Dq 0x1deadbeef1 ,
113channel 11, obtaining an IP address using DHCP:
114.Bd -literal -offset indent
115dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
116.Ed
117.Pp
118Configure wpi0 to join network
119.Dq my_net
120using WPA-PSK with passphrase
121.Dq my_passphrase :
122.Bd -literal -offset indent
123# ifconfig wpi0 nwid my_net wpa wpapsk \e
124	`wpa-psk my_net my_passphrase`
125.Ed
126.Pp
127Return wpi0 to its default settings:
128.Bd -literal -offset indent
129# ifconfig wpi0 -bssid -chan media autoselect \e
130	nwid "" -nwkey -wpa -wpapsk
131.Ed
132.Pp
133Join an existing BSS network,
134.Dq my_net :
135.Bd -literal -offset indent
136# ifconfig wpi0 192.168.1.1 netmask 0xffffff00 nwid my_net
137.Ed
138.Sh DIAGNOSTICS
139.Bl -diag
140.It "wpi%d: device timeout"
141A frame dispatched to the hardware for transmission did not complete in time.
142The driver will reset the hardware.
143This should not happen.
144.It "wpi%d: fatal firmware error"
145For some reason, the firmware crashed.
146The driver will reset the hardware.
147This should not happen.
148.It "wpi%d: Radio transmitter is off"
149The radio transmitter is off and thus no packet can go out.
150The driver will reset the hardware.
151Make sure the laptop radio switch is on.
152.It "wpi%d: error %d, could not read firmware %s"
153For some reason, the driver was unable to read the firmware image from the
154filesystem.
155The file might be missing or corrupted.
156.It "wpi%d: firmware file too short: %d bytes"
157The firmware image is corrupted and can't be loaded into the adapter.
158.It "wpi%d: could not load firmware"
159An attempt to load the firmware into the adapter failed.
160The driver will reset the hardware.
161.El
162.Sh SEE ALSO
163.Xr pkg_add 1 ,
164.Xr arp 4 ,
165.Xr ifmedia 4 ,
166.Xr intro 4 ,
167.Xr netintro 4 ,
168.Xr pci 4 ,
169.Xr hostname.if 5 ,
170.Xr ifconfig 8 ,
171.Xr wpa-psk 8
172.Sh AUTHORS
173The
174.Nm
175driver was written by
176.An Damien Bergamini Aq damien@openbsd.org .
177