xref: /freebsd/share/man/man4/iwm.4 (revision d9a42747950146bf03cda7f6e25d219253f8a57a)
1.\" Copyright (c) 2004-2006
2.\"	Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice unmodified, this list of conditions, and the following
9.\"    disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd February 4, 2023
29.Dt IWM 4
30.Os
31.Sh NAME
32.Nm iwm
33.Nd Intel IEEE 802.11ac wireless network driver
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36include the following lines in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device iwm"
40.Cd "device pci"
41.Cd "device wlan"
42.Cd "device firmware"
43.Ed
44.Pp
45You also need to select a firmware for your device.
46Choose one from:
47.Bd -ragged -offset indent
48.Cd "device iwm3160fw"
49.Cd "device iwm3168fw"
50.Cd "device iwm7260fw"
51.Cd "device iwm7265fw"
52.Cd "device iwm7265Dfw"
53.Cd "device iwm8000Cfw"
54.Cd "device iwm8265fw"
55.Cd "device iwm9000fw"
56.Cd "device iwm9260fw"
57.Ed
58.Pp
59Or you can use
60.Bd -ragged -offset indent
61.Cd "device iwmfw"
62.Ed
63.Pp
64to include them all.
65.Pp
66Alternatively, to load the driver as a
67module at boot time, place the following lines in
68.Xr loader.conf 5 :
69.Bd -literal -offset indent
70if_iwm_load="YES"
71iwm3160fw_load="YES"
72iwm3168fw_load="YES"
73iwm7260fw_load="YES"
74iwm7265fw_load="YES"
75iwm7265Dfw_load="YES"
76iwm8000Cfw_load="YES"
77iwm8265fw_load="YES"
78iwm9000fw_load="YES"
79iwm9260fw_load="YES"
80.Ed
81.Sh DESCRIPTION
82The
83.Nm
84driver provides support for:
85.Pp
86.Bl -tag -width Ds -offset indent -compact
87.It Intel Dual Band Wireless AC 3160
88.It Intel Dual Band Wireless AC 3165
89.It Intel Dual Band Wireless AC 3168
90.It Intel Dual Band Wireless AC 7260
91.It Intel Dual Band Wireless AC 7265
92.It Intel Dual Band Wireless AC 8260
93.It Intel Dual Band Wireless AC 8265
94.It Intel Dual Band Wireless AC 9260
95.It Intel Dual Band Wireless AC 9270
96.It Intel Dual Band Wireless AC 946X
97.It Intel Dual Band Wireless AC 9560
98.El
99.Pp
100.Nm
101supports
102.Cm station
103mode operation.
104Only one virtual interface may be configured at any time.
105For more information on configuring this device, see
106.Xr ifconfig 8 .
107.Pp
108This driver requires the firmware built with the
109.Nm iwmfw
110module to work.
111.Pp
112Currently,
113.Nm
114only supports 802.11b and 802.11g modes.
115It will not associate to access points that are configured to operate only
116in 802.11n or 802.11ac modes.
117.Sh EXAMPLES
118Join an existing BSS network (i.e., connect to an access point):
119.Bd -literal -offset indent
120ifconfig wlan create wlandev iwm0 inet 192.168.0.20 \e
121    netmask 0xffffff00
122.Ed
123.Pp
124Join a specific BSS network with network name
125.Dq Li my_net :
126.Pp
127.Dl "ifconfig wlan create wlandev iwm0 ssid my_net up"
128.Pp
129Join a specific BSS network with 64-bit WEP encryption:
130.Bd -literal -offset indent
131ifconfig wlan create wlandev iwm0 ssid my_net \e
132	wepmode on wepkey 0x1234567890 weptxkey 1 up
133.Ed
134.Pp
135Join a specific BSS network with 128-bit WEP encryption:
136.Bd -literal -offset indent
137ifconfig wlan create wlandev iwm0 wlanmode adhoc ssid my_net \e
138    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
139.Ed
140.Sh DIAGNOSTICS
141.Bl -diag
142.It "iwm%d: device timeout"
143The driver will reset the hardware.
144This should not happen.
145.It "iwm%d: firmware error"
146The onboard microcontroller crashed for some reason.
147The driver will reset the hardware.
148This should not happen.
149.It "iwm%d: timeout waiting for firmware initialization to complete"
150The onboard microcontroller failed to initialize in time.
151This should not happen.
152.It "iwm%d: could not load firmware image '%s'"
153The driver failed to load the firmware image using the
154.Xr firmware 9
155subsystem.
156Verify the
157.Xr iwmfw 4
158firmware module is present.
159.It "iwm%d: could not load boot firmware"
160An attempt to upload the boot firmware image to the onboard microcontroller
161failed.
162This should not happen.
163.It "iwm%d: could not load microcode"
164An attempt to upload the microcode image to the onboard microcontroller failed.
165This should not happen.
166.It "iwm%d: could not load main firmware"
167An attempt to upload the main firmware image to the onboard microcontroller
168failed.
169This should not happen.
170.El
171.Sh SEE ALSO
172.Xr iwmfw 4 ,
173.Xr pci 4 ,
174.Xr wlan 4 ,
175.Xr wlan_ccmp 4 ,
176.Xr wlan_tkip 4 ,
177.Xr wlan_wep 4 ,
178.Xr ifconfig 8 ,
179.Xr wpa_supplicant 8
180