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