xref: /dragonfly/share/man/man4/iwm.4 (revision e89cf083)
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: head/share/man/man4/iwm.4 354517 2019-11-07 23:39:33Z markj $
27.\"
28.Dd March 20, 2020
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.
46.\"Choose 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
59.\"Or you can use
60Use
61.Bd -ragged -offset indent
62.Cd "device iwmfw"
63.Ed
64.Pp
65to include them all.
66.Pp
67Alternatively, to load the driver as a
68module at boot time, place the following lines in
69.Xr loader.conf 5 :
70.Bd -literal -offset indent
71if_iwm_load="YES"
72iwm3160fw_load="YES"
73iwm3168fw_load="YES"
74iwm7260fw_load="YES"
75iwm7265fw_load="YES"
76iwm7265Dfw_load="YES"
77iwm8000Cfw_load="YES"
78iwm8265fw_load="YES"
79iwm9000fw_load="YES"
80iwm9260fw_load="YES"
81.Ed
82.Sh DESCRIPTION
83The
84.Nm
85driver provides support for:
86.Pp
87.Bl -tag -width Ds -offset indent -compact
88.It Intel Dual Band Wireless AC 3160
89.It Intel Dual Band Wireless AC 3165
90.It Intel Dual Band Wireless AC 3168
91.It Intel Dual Band Wireless AC 7260
92.It Intel Dual Band Wireless AC 7265
93.It Intel Dual Band Wireless AC 8260
94.It Intel Dual Band Wireless AC 8265
95.It Intel Dual Band Wireless AC 9260
96.It Intel Dual Band Wireless AC 9270
97.It Intel Dual Band Wireless AC 946X
98.It Intel Dual Band Wireless AC 9560
99.El
100.Pp
101.Nm
102supports
103.Cm station
104mode operation.
105Only one virtual interface may be configured at any time.
106For more information on configuring this device, see
107.Xr ifconfig 8 .
108.Pp
109This driver requires the firmware built with the
110.Nm iwmfw
111module to work.
112.Sh LOADER TUNABLES
113.Bl -tag -width indent
114.It Va hw.iwm.msi.enable
115By default, the driver will use MSI if it is supported.
116This behavior can be turned off by setting this tunable to 0.
117.It Va hw.iwm.power_scheme
118Power management scheme:
1191 = active, 2 = balanced (default), 3 = low power
120.It Va hw.iwm.lar.disable
121Allows disabling LAR (Location Aware Regulatory) feature:
1220 = LAR enabled if available (default), 1 = LAR disabled
123.El
124.Sh EXAMPLES
125Join an existing BSS network (i.e., connect to an access point):
126.Bd -literal -offset indent
127ifconfig wlan create wlandev iwm0 inet 192.168.0.20 \e
128    netmask 0xffffff00
129.Ed
130.Pp
131Join a specific BSS network with network name
132.Dq Li my_net :
133.Pp
134.Dl "ifconfig wlan create wlandev iwm0 ssid my_net up"
135.Pp
136Join a specific BSS network with 64-bit WEP encryption:
137.Bd -literal -offset indent
138ifconfig wlan create wlandev iwm0 ssid my_net \e
139	wepmode on wepkey 0x1234567890 weptxkey 1 up
140.Ed
141.Pp
142Join a specific BSS network with 128-bit WEP encryption:
143.Bd -literal -offset indent
144ifconfig wlan create wlandev iwm0 wlanmode adhoc ssid my_net \e
145    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
146.Ed
147.Sh DIAGNOSTICS
148.Bl -diag
149.It "iwm%d: device timeout"
150The driver will reset the hardware.
151This should not happen.
152.It "iwm%d: firmware error"
153The onboard microcontroller crashed for some reason.
154The driver will reset the hardware.
155This should not happen.
156.It "iwm%d: fw chunk addr 0x%x len %d failed to load"
157Timed out waiting for a segment of the firmware to load.
158This should not happen.
159.It "iwm%d: could not read firmware %s (error %d)"
160The driver failed to load the firmware image using the
161.Xr firmware 9
162subsystem.
163Verify the
164.Xr iwmfw 4
165firmware module is present.
166.It "iwm%d: Failed to start INIT ucode: %d"
167An attempt to upload the INIT firmware image to the onboard microcontroller
168failed.
169This should not happen.
170.It "iwm%d: could not load firmware"
171An attempt to upload the REGULAR firmware image to the onboard microcontroller
172failed.
173This should not happen.
174.El
175.Sh SEE ALSO
176.Xr iwmfw 4 ,
177.Xr pci 4 ,
178.Xr wlan 4 ,
179.Xr wlan_ccmp 4 ,
180.Xr wlan_tkip 4 ,
181.Xr wlan_wep 4 ,
182.Xr ifconfig 8 ,
183.Xr wpa_supplicant 8
184.Sh HISTORY
185The
186.Nm
187device driver first appeared in
188.Ox 5.7 .
189