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