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