xref: /dragonfly/share/man/man4/iwm.4 (revision 0de090e1)
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 June 5, 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 iwm7260fw"
50.\".Cd "device iwm7265fw"
51.\".Cd "device iwm8000Cfw"
52.\".Ed
53.\".Pp
54.\"Or you can use
55Use
56.Bd -ragged -offset indent
57.Cd "device iwmfw"
58.Ed
59.Pp
60to include them all.
61.Pp
62Alternatively, to load the driver as a
63module at boot time, place the following lines in
64.Xr loader.conf 5 :
65.Bd -literal -offset indent
66if_iwm_load="YES"
67iwm3160fw_load="YES"
68iwm7260fw_load="YES"
69iwm7265fw_load="YES"
70iwm8000Cfw_load="YES"
71.Ed
72.Sh DESCRIPTION
73The
74.Nm
75driver provides support for:
76.Pp
77.Bl -tag -width Ds -offset indent -compact
78.It Intel Dual Band Wireless AC 3160
79.It Intel Dual Band Wireless AC 3165
80.It Intel Dual Band Wireless AC 7260
81.It Intel Dual Band Wireless AC 7265
82.It Intel Dual Band Wireless AC 8260
83.El
84.Pp
85.Nm
86supports
87.Cm station
88mode operation.
89Only one virtual interface may be configured at any time.
90For more information on configuring this device, see
91.Xr ifconfig 8 .
92.Pp
93This driver requires the firmware built with the
94.Nm iwmfw
95module to work.
96.Sh LOADER TUNABLES
97.Bl -tag -width indent
98.It Va hw.iwm.msi.enable
99By default, the driver will use MSI if it is supported.
100This behavior can be turned off by setting this tunable to 0.
101.El
102.Sh EXAMPLES
103Join an existing BSS network (i.e., connect to an access point):
104.Bd -literal -offset indent
105ifconfig wlan create wlandev iwm0 inet 192.168.0.20 \e
106    netmask 0xffffff00
107.Ed
108.Pp
109Join a specific BSS network with network name
110.Dq Li my_net :
111.Pp
112.Dl "ifconfig wlan create wlandev iwm0 ssid my_net up"
113.Pp
114Join a specific BSS network with 64-bit WEP encryption:
115.Bd -literal -offset indent
116ifconfig wlan create wlandev iwm0 ssid my_net \e
117	wepmode on wepkey 0x1234567890 weptxkey 1 up
118.Ed
119.Pp
120Join a specific BSS network with 128-bit WEP encryption:
121.Bd -literal -offset indent
122ifconfig wlan create wlandev iwm0 wlanmode adhoc ssid my_net \e
123    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
124.Ed
125.Sh DIAGNOSTICS
126.Bl -diag
127.It "iwm%d: device timeout"
128The driver will reset the hardware.
129This should not happen.
130.It "iwm%d: firmware error"
131The onboard microcontroller crashed for some reason.
132The driver will reset the hardware.
133This should not happen.
134.It "iwm%d: timeout waiting for firmware initialization to complete"
135The onboard microcontroller failed to initialize in time.
136This should not happen.
137.It "iwm%d: could not load firmware image '%s'"
138The driver failed to load the firmware image using the
139.Xr firmware 9
140subsystem.
141Verify the
142.Xr iwmfw 4
143firmware module is present.
144.It "iwm%d: could not load boot firmware"
145An attempt to upload the boot firmware image to the onboard microcontroller
146failed.
147This should not happen.
148.It "iwm%d: could not load microcode"
149An attempt to upload the microcode image to the onboard microcontroller failed.
150This should not happen.
151.It "iwm%d: could not load main firmware"
152An attempt to upload the main firmware image to the onboard microcontroller
153failed.
154This should not happen.
155.El
156.Sh SEE ALSO
157.Xr iwmfw 4 ,
158.Xr pci 4 ,
159.Xr wlan 4 ,
160.Xr wlan_ccmp 4 ,
161.Xr wlan_tkip 4 ,
162.Xr wlan_wep 4 ,
163.Xr ifconfig 8 ,
164.Xr wpa_supplicant 8
165