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