xref: /openbsd/share/man/man4/ipw.4 (revision 3bef86f7)
1.\" $OpenBSD: ipw.4,v 1.51 2022/01/05 17:39:24 jmc Exp $
2.\"
3.\" Copyright (c) 2004
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: January 5 2022 $
29.Dt IPW 4
30.Os
31.Sh NAME
32.Nm ipw
33.Nd Intel PRO/Wireless 2100 IEEE 802.11b wireless network device
34.Sh SYNOPSIS
35.Cd "ipw* at pci?"
36.Sh DESCRIPTION
37The
38.Nm
39driver provides support for the Intel PRO/Wireless 2100 Mini PCI
40network adapter.
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 IBSS mode
53Also known as
54.Em IEEE ad-hoc
55mode or
56.Em peer-to-peer
57mode.
58This is the standardized method of operating without an access point.
59Stations associate with a service set.
60However, actual connections between stations are peer-to-peer.
61.It monitor mode
62In this mode the driver is able to receive packets without
63associating with an access point.
64This disables the internal receive filter and enables the card to
65capture packets from networks which it wouldn't normally have access to,
66or to scan for access points.
67.El
68.Pp
69The
70.Nm
71driver can be configured to use
72Wired Equivalent Privacy (WEP) or
73Wi-Fi Protected Access (WPA1 and WPA2).
74WPA2 is the current encryption standard for wireless networks.
75It is strongly recommended that neither WEP nor WPA1
76are used as the sole mechanism to secure wireless communication,
77due to serious weaknesses.
78WPA1 is disabled by default and may be enabled using the option
79.Qq Cm wpaprotos Ar wpa1,wpa2 .
80For standard WPA networks which use pre-shared keys (PSK),
81keys are configured using the
82.Qq Cm wpakey
83option.
84WPA-Enterprise networks require use of the wpa_supplicant package.
85The
86.Nm
87driver relies on the software 802.11 stack for both encryption and decryption
88of data frames.
89.Pp
90The
91.Nm
92driver can be configured at runtime with
93.Xr ifconfig 8
94or on boot with
95.Xr hostname.if 5 .
96.Sh FILES
97The driver needs at least version 1.3 of the following firmware files,
98which are loaded when an interface is brought up:
99.Pp
100.Bl -tag -width Ds -offset indent -compact
101.It Pa /etc/firmware/ipw-bss
102.It Pa /etc/firmware/ipw-ibss
103.It Pa /etc/firmware/ipw-monitor
104.El
105.Pp
106These firmware files are not free because Intel refuses to grant
107distribution rights without contractual obligations.
108As a result, even though
109.Ox
110includes the driver, the firmware files cannot be included and
111users have to find these files on their own.
112The official person to state your views to about this issue is
113.Mt majid.awad@intel.com .
114.Pp
115A prepackaged version of the firmware can be installed using
116.Xr fw_update 8 .
117.Sh EXAMPLES
118The following example scans for available networks:
119.Pp
120.Dl # ifconfig ipw0 scan
121.Pp
122The following
123.Xr hostname.if 5
124example configures ipw0 to join network
125.Dq mynwid ,
126using WPA key
127.Dq mywpakey ,
128obtaining an IP address using DHCP:
129.Bd -literal -offset indent
130join mynwid wpakey mywpakey
131inet autoconf
132.Ed
133.Sh DIAGNOSTICS
134.Bl -diag
135.It "ipw0: device timeout"
136The driver will reset the hardware.
137This should not happen.
138.It "ipw0: error N, could not read firmware ..."
139For some reason, the driver was unable to read the firmware image from the
140filesystem.
141The file might be missing or corrupted.
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 3.7 .
156.Sh AUTHORS
157The
158.Nm
159driver was written by
160.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
161.Sh CAVEATS
162This driver does not support powersave mode.
163