xref: /freebsd/share/man/man4/iwm.4 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
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 IWM 4
31.Os
32.Sh NAME
33.Nm iwm
34.Nd Intel IEEE 802.11ac wireless network driver
35.Sh SYNOPSIS
36To compile this driver into the kernel,
37include the following lines in your kernel 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 supports running most Intel Wireless AC series network devices in
85.Cm station
86mode operation.
87Only one virtual interface may be configured at any time.
88This driver requires the firmware built with the
89.Xr iwmfw 4
90module to work.
91.Pp
92For more information on configuring this device, see
93.Xr ifconfig 8 .
94.Sh HARDWARE
95The
96.Nm
97driver supports the following PCIe Wi-Fi devices:
98.Pp
99.Bl -bullet -compact
100.It
101Intel Dual Band Wireless AC 3160
102.It
103Intel Dual Band Wireless AC 3165
104.It
105Intel Dual Band Wireless AC 3168
106.It
107Intel Dual Band Wireless AC 7260
108.It
109Intel Dual Band Wireless AC 7265
110.It
111Intel Dual Band Wireless AC 8260
112.It
113Intel Dual Band Wireless AC 8265
114.It
115Intel Dual Band Wireless AC 9260
116.It
117Intel Dual Band Wireless AC 9270
118.It
119Intel Dual Band Wireless AC 946X
120.It
121Intel Dual Band Wireless AC 9560
122.El
123.Sh EXAMPLES
124Join an existing BSS network (i.e., connect to an access point):
125.Pp
126.Dl ifconfig wlan create wlandev iwm0 inet 192.0.2.20/24
127.Pp
128Join a specific BSS network with network name
129.Ar my_net :
130.Pp
131.Dl ifconfig wlan create wlandev iwm0 ssid my_net up
132.Pp
133Join a specific BSS network with 64-bit WEP encryption:
134.Bd -literal -offset indent
135ifconfig wlan create wlandev iwm0 ssid my_net \e
136    wepmode on wepkey 0x1234567890 weptxkey 1 up
137.Ed
138.Pp
139Join a specific BSS network with 128-bit WEP encryption:
140.Bd -literal -offset indent
141ifconfig wlan create wlandev iwm0 wlanmode adhoc ssid my_net \e
142    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
143.Ed
144.Sh DIAGNOSTICS
145.Bl -diag
146.It "iwm%d: device timeout"
147The driver will reset the hardware.
148This should not happen.
149.It "iwm%d: firmware error"
150The onboard microcontroller crashed for some reason.
151The driver will reset the hardware.
152This should not happen.
153.It "iwm%d: timeout waiting for firmware initialization to complete"
154The onboard microcontroller failed to initialize in time.
155This should not happen.
156.It "iwm%d: could not load firmware image '%s'"
157The driver failed to load the firmware image using the
158.Xr firmware 9
159subsystem.
160Verify the
161.Xr iwmfw 4
162firmware module is present.
163.It "iwm%d: could not load boot firmware"
164An attempt to upload the boot firmware image
165to the onboard microcontroller failed.
166This should not happen.
167.It "iwm%d: could not load microcode"
168An attempt to upload the microcode image
169to the onboard microcontroller failed.
170This should not happen.
171.It "iwm%d: could not load main firmware"
172An attempt to upload the main firmware image
173to the onboard microcontroller failed.
174This should not happen.
175.El
176.Sh SEE ALSO
177.Xr iwlwifi 4 ,
178.Xr iwmfw 4 ,
179.Xr pci 4 ,
180.Xr wlan 4 ,
181.Xr wlan_ccmp 4 ,
182.Xr wlan_tkip 4 ,
183.Xr wlan_wep 4 ,
184.Xr networking 7 ,
185.Xr ifconfig 8 ,
186.Xr wpa_supplicant 8
187.Sh BUGS
188Currently,
189.Nm
190only supports 802.11a/b/g modes.
191It will not associate to access points that are configured to operate
192only in 802.11n/ac modes.
193