xref: /freebsd/share/man/man4/iwi.4 (revision b64c5a0ace59af62eff52bfe110a521dc73c937b)
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 IWI 4
31.Os
32.Sh NAME
33.Nm iwi
34.Nd Intel PRO/Wireless 2200BG/2225BG/2915ABG IEEE 802.11 network driver
35.Sh SYNOPSIS
36To compile this driver into the kernel,
37include the following lines in your
38kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device iwi"
41.Cd "device iwifw"
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_iwi_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_iwi.license_ack=1
59.Ed
60.Sh DESCRIPTION
61The
62.Nm
63driver provides support for Intel PRO/Wireless 2200BG/2225BG/2915ABG
64IEEE 802.11a/b/g wireless 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 iwifw
74module to work.
75For the loaded firmware to be enabled for use the license at
76.Pa /usr/share/doc/legal/intel_iwi.LICENSE
77must be agreed by adding the following line to
78.Xr loader.conf 5 :
79.Pp
80.Dl "legal.intel_iwi.license_ack=1"
81.Pp
82For more information on configuring this device, see
83.Xr ifconfig 8 .
84.Sh HARDWARE
85The
86.Nm
87driver supports the following wireless network devices:
88.Pp
89.Bl -bullet -compact
90.It
91Intel PRO/Wireless 2200BG MiniPCI Network Connection
92.It
93Intel PRO/Wireless 2225BG PCI Network Connection
94.It
95Intel PRO/Wireless 2915ABG MiniPCI Network Connection
96.El
97.Sh FILES
98.Bl -tag -width "/usr/share/doc/legal/intel_iwi.LICENSE" -compact
99.It Pa /usr/share/doc/legal/intel_iwi.LICENSE
100.Nm
101firmware license
102.El
103.Sh EXAMPLES
104Join an existing BSS network (i.e., connect to an access point):
105.Pp
106.Dl ifconfig wlan create wlandev iwi0 inet 192.0.2.20/24
107.Pp
108Join a specific BSS network with network name
109.Ar my_net :
110.Pp
111.Dl ifconfig wlan create wlandev iwi0 ssid my_net up
112.Pp
113Join a specific BSS network with 64-bit WEP encryption:
114.Bd -literal -offset indent
115ifconfig wlan create wlandev iwi0 ssid my_net \e
116    wepmode on wepkey 0x1234567890 weptxkey 1 up
117.Ed
118.Pp
119Join a specific BSS network with 128-bit WEP encryption:
120.Bd -literal -offset indent
121ifconfig wlan create wlandev iwi0 wlanmode adhoc ssid my_net \e
122    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
123.Ed
124.Sh DIAGNOSTICS
125.Bl -diag
126.It "iwi%d: device timeout"
127The driver will reset the hardware.
128This should not happen.
129.It "iwi%d: firmware error"
130The onboard microcontroller crashed for some reason.
131The driver will reset the hardware.
132This should not happen.
133.It "iwi%d: timeout waiting for firmware initialization to complete"
134The onboard microcontroller failed to initialize in time.
135This should not happen.
136.It "iwi%d: could not load firmware image '%s'"
137The driver failed to load the firmware image using the
138.Xr firmware 9
139subsystem.
140Verify the
141.Xr iwifw 4
142firmware module is installed and the license agreement
143.Xr loader 8
144tunable has been set.
145.It "iwi%d: could not load boot firmware"
146An attempt to upload the boot firmware image to the onboard microcontroller
147failed.
148This should not happen.
149.It "iwi%d: could not load microcode"
150An attempt to upload the microcode image to the onboard microcontroller failed.
151This should not happen.
152.It "iwi%d: could not load main firmware"
153An attempt to upload the main firmware image to the onboard microcontroller
154failed.
155This should not happen.
156.El
157.Sh SEE ALSO
158.Xr iwifw 4 ,
159.Xr pci 4 ,
160.Xr wlan 4 ,
161.Xr wlan_ccmp 4 ,
162.Xr wlan_tkip 4 ,
163.Xr wlan_wep 4 ,
164.Xr networking 7 ,
165.Xr ifconfig 8 ,
166.Xr wpa_supplicant 8
167.Sh AUTHORS
168The original
169.Nm
170driver was written by
171.An Damien Bergamini Aq Mt damien.bergamini@free.fr .
172