xref: /freebsd/share/man/man4/iwm.4 (revision 732a02b4e77866604a120a275c082bb6221bd2ff)
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 November 7, 2019
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 iwm8000Cfw"
53.Cd "device iwm8265fw"
54.Cd "device iwm9000fw"
55.Cd "device iwm9260fw"
56.Ed
57.Pp
58Or you can use
59.Bd -ragged -offset indent
60.Cd "device iwmfw"
61.Ed
62.Pp
63to include them all.
64.Pp
65Alternatively, to load the driver as a
66module at boot time, place the following lines in
67.Xr loader.conf 5 :
68.Bd -literal -offset indent
69if_iwm_load="YES"
70iwm3160fw_load="YES"
71iwm3168fw_load="YES"
72iwm7260fw_load="YES"
73iwm7265fw_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 9260
92.It Intel Dual Band Wireless AC 9270
93.It Intel Dual Band Wireless AC 946X
94.It Intel Dual Band Wireless AC 9560
95.El
96.Pp
97.Nm
98supports
99.Cm station
100mode operation.
101Only one virtual interface may be configured at any time.
102For more information on configuring this device, see
103.Xr ifconfig 8 .
104.Pp
105This driver requires the firmware built with the
106.Nm iwmfw
107module to work.
108.Sh EXAMPLES
109Join an existing BSS network (i.e., connect to an access point):
110.Bd -literal -offset indent
111ifconfig wlan create wlandev iwm0 inet 192.168.0.20 \e
112    netmask 0xffffff00
113.Ed
114.Pp
115Join a specific BSS network with network name
116.Dq Li my_net :
117.Pp
118.Dl "ifconfig wlan create wlandev iwm0 ssid my_net up"
119.Pp
120Join a specific BSS network with 64-bit WEP encryption:
121.Bd -literal -offset indent
122ifconfig wlan create wlandev iwm0 ssid my_net \e
123	wepmode on wepkey 0x1234567890 weptxkey 1 up
124.Ed
125.Pp
126Join a specific BSS network with 128-bit WEP encryption:
127.Bd -literal -offset indent
128ifconfig wlan create wlandev iwm0 wlanmode adhoc ssid my_net \e
129    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
130.Ed
131.Sh DIAGNOSTICS
132.Bl -diag
133.It "iwm%d: device timeout"
134The driver will reset the hardware.
135This should not happen.
136.It "iwm%d: firmware error"
137The onboard microcontroller crashed for some reason.
138The driver will reset the hardware.
139This should not happen.
140.It "iwm%d: timeout waiting for firmware initialization to complete"
141The onboard microcontroller failed to initialize in time.
142This should not happen.
143.It "iwm%d: could not load firmware image '%s'"
144The driver failed to load the firmware image using the
145.Xr firmware 9
146subsystem.
147Verify the
148.Xr iwmfw 4
149firmware module is present.
150.It "iwm%d: could not load boot firmware"
151An attempt to upload the boot firmware image to the onboard microcontroller
152failed.
153This should not happen.
154.It "iwm%d: could not load microcode"
155An attempt to upload the microcode image to the onboard microcontroller failed.
156This should not happen.
157.It "iwm%d: could not load main firmware"
158An attempt to upload the main firmware image to the onboard microcontroller
159failed.
160This should not happen.
161.El
162.Sh SEE ALSO
163.Xr iwmfw 4 ,
164.Xr pci 4 ,
165.Xr wlan 4 ,
166.Xr wlan_ccmp 4 ,
167.Xr wlan_tkip 4 ,
168.Xr wlan_wep 4 ,
169.Xr ifconfig 8 ,
170.Xr wpa_supplicant 8
171