xref: /freebsd/share/man/man4/iwm.4 (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
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.Dd February 20, 2024
27.Dt IWM 4
28.Os
29.Sh NAME
30.Nm iwm
31.Nd Intel IEEE 802.11ac wireless network driver
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34include the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device iwm"
38.Cd "device pci"
39.Cd "device wlan"
40.Cd "device firmware"
41.Ed
42.Pp
43You also need to select a firmware for your device.
44Choose one from:
45.Bd -ragged -offset indent
46.Cd "device iwm3160fw"
47.Cd "device iwm3168fw"
48.Cd "device iwm7260fw"
49.Cd "device iwm7265fw"
50.Cd "device iwm7265Dfw"
51.Cd "device iwm8000Cfw"
52.Cd "device iwm8265fw"
53.Cd "device iwm9000fw"
54.Cd "device iwm9260fw"
55.Ed
56.Pp
57Or you can use
58.Bd -ragged -offset indent
59.Cd "device iwmfw"
60.Ed
61.Pp
62to include them all.
63.Pp
64Alternatively, to load the driver as a
65module at boot time, place the following lines in
66.Xr loader.conf 5 :
67.Bd -literal -offset indent
68if_iwm_load="YES"
69iwm3160fw_load="YES"
70iwm3168fw_load="YES"
71iwm7260fw_load="YES"
72iwm7265fw_load="YES"
73iwm7265Dfw_load="YES"
74iwm8000Cfw_load="YES"
75iwm8265fw_load="YES"
76iwm9000fw_load="YES"
77iwm9260fw_load="YES"
78.Ed
79.Sh DESCRIPTION
80The
81.Nm
82driver provides support for:
83.Pp
84.Bl -tag -width Ds -offset indent -compact
85.It Intel Dual Band Wireless AC 3160
86.It Intel Dual Band Wireless AC 3165
87.It Intel Dual Band Wireless AC 3168
88.It Intel Dual Band Wireless AC 7260
89.It Intel Dual Band Wireless AC 7265
90.It Intel Dual Band Wireless AC 8260
91.It Intel Dual Band Wireless AC 8265
92.It Intel Dual Band Wireless AC 9260
93.It Intel Dual Band Wireless AC 9270
94.It Intel Dual Band Wireless AC 946X
95.It Intel Dual Band Wireless AC 9560
96.El
97.Pp
98.Nm
99supports
100.Cm station
101mode operation.
102Only one virtual interface may be configured at any time.
103For more information on configuring this device, see
104.Xr ifconfig 8 .
105.Pp
106This driver requires the firmware built with the
107.Nm iwmfw
108module to work.
109.Pp
110Currently,
111.Nm
112only supports 802.11b and 802.11g modes.
113It will not associate to access points that are configured to operate only
114in 802.11n or 802.11ac modes.
115.Sh EXAMPLES
116Join an existing BSS network (i.e., connect to an access point):
117.Bd -literal -offset indent
118ifconfig wlan create wlandev iwm0 inet 192.168.0.20 \e
119    netmask 0xffffff00
120.Ed
121.Pp
122Join a specific BSS network with network name
123.Dq Li my_net :
124.Pp
125.Dl "ifconfig wlan create wlandev iwm0 ssid my_net up"
126.Pp
127Join a specific BSS network with 64-bit WEP encryption:
128.Bd -literal -offset indent
129ifconfig wlan create wlandev iwm0 ssid my_net \e
130	wepmode on wepkey 0x1234567890 weptxkey 1 up
131.Ed
132.Pp
133Join a specific BSS network with 128-bit WEP encryption:
134.Bd -literal -offset indent
135ifconfig wlan create wlandev iwm0 wlanmode adhoc ssid my_net \e
136    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
137.Ed
138.Sh DIAGNOSTICS
139.Bl -diag
140.It "iwm%d: device timeout"
141The driver will reset the hardware.
142This should not happen.
143.It "iwm%d: firmware error"
144The onboard microcontroller crashed for some reason.
145The driver will reset the hardware.
146This should not happen.
147.It "iwm%d: timeout waiting for firmware initialization to complete"
148The onboard microcontroller failed to initialize in time.
149This should not happen.
150.It "iwm%d: could not load firmware image '%s'"
151The driver failed to load the firmware image using the
152.Xr firmware 9
153subsystem.
154Verify the
155.Xr iwmfw 4
156firmware module is present.
157.It "iwm%d: could not load boot firmware"
158An attempt to upload the boot firmware image to the onboard microcontroller
159failed.
160This should not happen.
161.It "iwm%d: could not load microcode"
162An attempt to upload the microcode image to the onboard microcontroller failed.
163This should not happen.
164.It "iwm%d: could not load main firmware"
165An attempt to upload the main firmware image to the onboard microcontroller
166failed.
167This should not happen.
168.El
169.Sh SEE ALSO
170.Xr iwlwifi 4 ,
171.Xr iwmfw 4 ,
172.Xr pci 4 ,
173.Xr wlan 4 ,
174.Xr wlan_ccmp 4 ,
175.Xr wlan_tkip 4 ,
176.Xr wlan_wep 4 ,
177.Xr ifconfig 8 ,
178.Xr wpa_supplicant 8
179