xref: /openbsd-src/share/man/man4/wpi.4 (revision 4b70baf6e17fc8b27fc1f7fa7929335753fa94c3)
1.\" $OpenBSD: wpi.4,v 1.41 2019/03/29 07:07:05 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: March 29 2019 $
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 Intel
40PRO/Wireless 3945ABG Mini PCI Express network adapters.
41.Pp
42These are the modes the
43.Nm
44driver can operate in:
45.Bl -tag -width "IBSS-masterXX"
46.It BSS mode
47Also known as
48.Em infrastructure
49mode, this is used when associating with an access point, through
50which all traffic passes.
51This mode is the default.
52.It monitor mode
53In this mode the driver is able to receive packets without
54associating with an access point.
55This disables the internal receive filter and enables the card to
56capture packets from networks which it wouldn't normally have access to,
57or to scan for access points.
58.El
59.Pp
60The
61.Nm
62driver can be configured to use
63Wired Equivalent Privacy (WEP) or
64Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
65WPA is the current encryption standard for wireless networks.
66It is strongly recommended that WEP
67not be used as the sole mechanism
68to secure wireless communication,
69due to serious weaknesses in it.
70The
71.Nm
72driver offloads both encryption and decryption of unicast data frames to the
73hardware for the CCMP cipher.
74.Pp
75In BSS mode,
76the driver supports powersave mode,
77which can be enabled via
78.Xr ifconfig 8 .
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 can be installed using
102.Xr fw_update 1 .
103.Sh EXAMPLES
104The following example scans for available networks:
105.Pp
106.Dl # ifconfig wpi0 scan
107.Pp
108The following
109.Xr hostname.if 5
110example configures wpi0 to join network
111.Dq mynwid ,
112using WPA key
113.Dq mywpakey ,
114obtaining an IP address using DHCP:
115.Bd -literal -offset indent
116nwid mynwid wpakey mywpakey
117dhcp
118.Ed
119.Sh DIAGNOSTICS
120.Bl -diag
121.It "wpi0: device timeout"
122A frame dispatched to the hardware for transmission did not complete in time.
123The driver will reset the hardware.
124This should not happen.
125.It "wpi0: fatal firmware error"
126For some reason, the firmware crashed.
127The driver will reset the hardware.
128This should not happen.
129.It "wpi0: Radio transmitter is off"
130The radio transmitter is off and thus no packet can go out.
131The driver will reset the hardware.
132Make sure the laptop radio switch is on.
133.It "wpi0: error N, could not read firmware ..."
134For some reason, the driver was unable to read the firmware image from the
135filesystem.
136The file might be missing or corrupted.
137.It "wpi0: firmware file too short: N bytes"
138The firmware image is corrupted and can't be loaded into the adapter.
139.It "wpi0: could not load firmware"
140An attempt to load the firmware into the adapter failed.
141The driver will reset the hardware.
142.El
143.Sh SEE ALSO
144.Xr arp 4 ,
145.Xr ifmedia 4 ,
146.Xr intro 4 ,
147.Xr netintro 4 ,
148.Xr pci 4 ,
149.Xr hostname.if 5 ,
150.Xr ifconfig 8
151.Sh HISTORY
152The
153.Nm
154driver first appeared in
155.Ox 4.0 .
156.Sh AUTHORS
157The
158.Nm
159driver was written by
160.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
161