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