xref: /freebsd/share/man/man4/ipw.4 (revision 908f215e80fa482aa953c39afa6bb516f561fc00)
1.\"-
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2004-2006
5.\"	Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice unmodified, this list of conditions, and the following
12.\"    disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.Dd November 10, 2024
30.Dt IPW 4
31.Os
32.Sh NAME
33.Nm ipw
34.Nd Intel PRO/Wireless 2100 IEEE 802.11a/b driver
35.Sh SYNOPSIS
36To compile this driver into the kernel,
37place the following lines in your
38kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device ipw"
41.Cd "device ipwfw"
42.Cd "device pci"
43.Cd "device wlan"
44.Cd "device firmware"
45.Ed
46.Pp
47Alternatively, to load the driver as a
48module at boot time, place the following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51if_ipw_load="YES"
52.Ed
53.Pp
54In both cases, place the following line in
55.Xr loader.conf 5
56to acknowledge the firmware license (see below):
57.Bd -literal -offset indent
58legal.intel_ipw.license_ack=1
59.Ed
60.Sh DESCRIPTION
61The
62.Nm
63driver provides support for Intel PRO/Wireless 2100 802.11a/b
64wireless network devices in
65.Cm station ,
66.Cm adhoc ,
67and
68.Cm monitor
69mode operation.
70Only one virtual interface may be configured at any time.
71.Pp
72This driver requires the firmware built with the
73.Nm ipwfw
74module to work.
75For the loaded firmware to be enabled for use the license at
76.Pa /usr/share/doc/legal/intel_ipw.LICENSE
77must be agreed by adding the following line to
78.Xr loader.conf 5 :
79.Pp
80.Dl "legal.intel_ipw.license_ack=1"
81.Pp
82For more information on configuring this device, see
83.Xr ifconfig 8 .
84.Sh HARDWARE
85The
86.Nm
87driver provides support for the
88Intel PRO/Wireless 2100a/b MiniPCI network adapter.
89.Sh FILES
90.Bl -tag -width "/usr/share/doc/legal/intel_ipw.LICENSE" -compact
91.It Pa /usr/share/doc/legal/intel_ipw.LICENSE
92.Nm
93firmware license
94.El
95.Sh EXAMPLES
96Join an existing BSS network (i.e., connect to an access point):
97.Pp
98.Dl ifconfig wlan create wlandev ipw0 inet 192.0.2.20/24
99.Pp
100Join a specific BSS network with network name
101.Ar my_net :
102.Pp
103.Dl ifconfig wlan create wlandev ipw0 ssid my_net up
104.Pp
105Join a specific BSS network with 64-bit WEP encryption:
106.Bd -literal -offset indent
107ifconfig wlan create wlandev ipw0 ssid my_net \e
108    wepmode on wepkey 0x1234567890 weptxkey 1 up
109.Ed
110.Pp
111Join a specific BSS network with 128-bit WEP encryption:
112.Bd -literal -offset indent
113ifconfig wlan create wlandev ipw0 wlanmode adhoc ssid my_net \e
114    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
115.Ed
116.Sh DIAGNOSTICS
117.Bl -diag
118.It "ipw%d: device timeout"
119The driver will reset the hardware.
120This should not happen.
121.It "ipw%d: firmware error"
122The onboard microcontroller crashes for some reason.
123The driver will reset the hardware.
124This should not happen.
125.It "ipw%d: timeout waiting for firmware initialization to complete"
126The onboard microcontroller failed to initialize in time.
127This should not happen.
128.It "ipw%d: could not load firmware image '%s'"
129The driver failed to load the firmware image using the
130.Xr firmware 9
131subsystem.
132Verify the
133.Xr ipwfw 4
134firmware module is installed and the license agreement
135.Xr loader 8
136tunable has been set.
137.It "ipw%d: could not load microcode"
138An attempt to upload the microcode image to the onboard microcontroller failed.
139This should not happen.
140.It "ipw%d: could not load firmware"
141An attempt to upload the firmware image to the onboard microcontroller failed.
142This should not happen.
143.El
144.Sh SEE ALSO
145.Xr ipwfw 4 ,
146.Xr pci 4 ,
147.Xr wlan 4 ,
148.Xr wlan_ccmp 4 ,
149.Xr wlan_tkip 4 ,
150.Xr wlan_wep 4 ,
151.Xr networking 7 ,
152.Xr ifconfig 8 ,
153.Xr wpa_supplicant 8
154.Sh AUTHORS
155The original
156.Nm
157driver was written by
158.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
159