xref: /openbsd/share/man/man4/wpi.4 (revision 91f110e0)
1.\" $OpenBSD: wpi.4,v 1.38 2014/02/15 20:28:19 tedu 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: February 15 2014 $
29.Dt WPI 4
30.Os
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 current 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
77.Nm
78driver can be configured at runtime with
79.Xr ifconfig 8
80or on boot with
81.Xr hostname.if 5 .
82.Sh FILES
83The driver needs at least version 3.1 of the following firmware file,
84which is loaded when an interface is brought up:
85.Pp
86.Bl -tag -width Ds -offset indent -compact
87.It Pa /etc/firmware/wpi-3945abg
88.El
89.Pp
90This firmware file is not free because Intel refuses to grant
91distribution rights without contractual obligations.
92As a result, even though
93.Ox
94includes the driver, the firmware file cannot be included and
95users have to download this file on their own.
96.Pp
97A prepackaged version of the firmware can be installed using
98.Xr fw_update 1 .
99.Sh EXAMPLES
100The following example scans for available networks:
101.Pp
102.Dl # ifconfig wpi0 scan
103.Pp
104The following
105.Xr hostname.if 5
106example configures wpi0 to join network
107.Dq mynwid ,
108using WPA key
109.Dq mywpakey ,
110obtaining an IP address using DHCP:
111.Bd -literal -offset indent
112nwid mynwid
113wpakey mywpakey
114dhcp
115.Ed
116.Sh DIAGNOSTICS
117.Bl -diag
118.It "wpi0: device timeout"
119A frame dispatched to the hardware for transmission did not complete in time.
120The driver will reset the hardware.
121This should not happen.
122.It "wpi0: fatal firmware error"
123For some reason, the firmware crashed.
124The driver will reset the hardware.
125This should not happen.
126.It "wpi0: Radio transmitter is off"
127The radio transmitter is off and thus no packet can go out.
128The driver will reset the hardware.
129Make sure the laptop radio switch is on.
130.It "wpi0: error N, could not read firmware ..."
131For some reason, the driver was unable to read the firmware image from the
132filesystem.
133The file might be missing or corrupted.
134.It "wpi0: firmware file too short: N bytes"
135The firmware image is corrupted and can't be loaded into the adapter.
136.It "wpi0: could not load firmware"
137An attempt to load the firmware into the adapter failed.
138The driver will reset the hardware.
139.El
140.Sh SEE ALSO
141.Xr arp 4 ,
142.Xr ifmedia 4 ,
143.Xr intro 4 ,
144.Xr netintro 4 ,
145.Xr pci 4 ,
146.Xr hostname.if 5 ,
147.Xr ifconfig 8
148.Sh AUTHORS
149The
150.Nm
151driver was written by
152.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
153