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