xref: /openbsd-src/share/man/man4/iwm.4 (revision e2e8d1e288d35686aa435f6b239ba9dcdcfd675b)
1.\" $OpenBSD: iwm.4,v 1.45 2023/10/14 06:29:11 jmc Exp $
2.\"
3.\" Copyright (c) 2007,2008
4.\"	Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
5.\"
6.\" Permission to use, copy, modify, and distribute this software for any
7.\" purpose with or without fee is hereby granted, provided that the above
8.\" copyright notice and this permission notice appear in all copies.
9.\"
10.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17.\"
18.Dd $Mdocdate: October 14 2023 $
19.Dt IWM 4
20.Os
21.Sh NAME
22.Nm iwm
23.Nd Intel 7000/8000/9000 IEEE 802.11a/ac/b/g/n wireless network device
24.Sh SYNOPSIS
25.Cd "iwm* at pci?"
26.Sh DESCRIPTION
27The
28.Nm
29driver provides support for Intel Wireless
307260, 7265, 3160, 3165, 3168, 8260, 8265, and 9260
31PCIe Mini Card and M.2 network adapters,
32and for Intel Wireless 9560 Integrated Connectivity (CNVi) network
33adapters with companion RF M.2 modules.
34.Pp
35These are the modes the
36.Nm
37driver can operate in:
38.Bl -tag -width "IBSS-masterXX"
39.It BSS mode
40Also known as
41.Em infrastructure
42mode, this is used when associating with an access point, through
43which all traffic passes.
44This mode is the default.
45.It monitor mode
46In this mode the driver is able to receive packets without
47associating with an access point.
48This disables the internal receive filter and enables the card to
49capture packets from networks which it wouldn't normally have access to,
50or to scan for access points.
51.El
52.Pp
53The
54.Nm
55driver can be configured to use
56Wired Equivalent Privacy (WEP) or
57Wi-Fi Protected Access (WPA1 and WPA2).
58WPA2 is the current encryption standard for wireless networks.
59It is strongly recommended that neither WEP nor WPA1
60are used as the sole mechanism to secure wireless communication,
61due to serious weaknesses.
62WPA1 is disabled by default and may be enabled using the option
63.Qq Cm wpaprotos Ar wpa1,wpa2 .
64For standard WPA networks which use pre-shared keys (PSK),
65keys are configured using the
66.Qq Cm wpakey
67option.
68WPA-Enterprise networks require use of the wpa_supplicant package.
69The
70.Nm
71driver offloads both encryption and decryption of unicast data frames to the
72hardware for the CCMP cipher.
73.Pp
74In BSS mode the driver supports background scanning;
75see
76.Xr ifconfig 8 .
77.Pp
78The
79.Nm
80driver can be configured at runtime with
81.Xr ifconfig 8
82or on boot with
83.Xr hostname.if 5 .
84.Sh FILES
85The driver needs one of the following firmware files,
86which are loaded when an interface is brought up:
87.Pp
88.Bl -tag -width Ds -offset indent -compact
89.It Pa /etc/firmware/iwm-3160-17
90.It Pa /etc/firmware/iwm-3168-29
91.It Pa /etc/firmware/iwm-7260-17
92.It Pa /etc/firmware/iwm-7265-17
93.It Pa /etc/firmware/iwm-7265D-29
94.It Pa /etc/firmware/iwm-8000C-36
95.It Pa /etc/firmware/iwm-8265-36
96.It Pa /etc/firmware/iwm-9000-46
97.It Pa /etc/firmware/iwm-9260-46
98.El
99.Pp
100These firmware files are not free because Intel refuses to grant
101distribution rights without contractual obligations.
102As a result, even though
103.Ox
104includes the driver, the firmware files cannot be included and
105users have to download these files on their own.
106.Pp
107A prepackaged version of the firmware can be installed using
108.Xr fw_update 8 .
109.Sh EXAMPLES
110The following example scans for available networks:
111.Pp
112.Dl # ifconfig iwm0 scan
113.Pp
114The following
115.Xr hostname.if 5
116example configures iwm0 to join network
117.Dq mynwid ,
118using WPA key
119.Dq mywpakey ,
120obtaining an IP address using DHCP:
121.Bd -literal -offset indent
122join mynwid wpakey mywpakey
123inet autoconf
124.Ed
125.Sh DIAGNOSTICS
126.Bl -diag
127.It "iwm0: device timeout"
128A frame dispatched to the hardware for transmission did not complete in time.
129The driver will reset the hardware.
130This should not happen.
131.It "iwm0: fatal firmware error"
132For some reason, the firmware crashed.
133The driver will reset the hardware.
134This should not happen.
135.It "iwm0: radio is disabled by hardware switch"
136The radio transmitter is off and thus no packet can go out.
137The driver will reset the hardware.
138Make sure the laptop radio switch is on.
139.It "iwm0: could not read firmware ... (error N)"
140For some reason, the driver was unable to read the firmware image from the
141filesystem.
142The file might be missing or corrupted.
143.It "iwm0: firmware too short: N bytes"
144The firmware image is corrupted and can't be loaded into the adapter.
145.It "iwm0: could not load firmware"
146An attempt to load the firmware into the adapter failed.
147The driver will reset the hardware.
148.El
149.Sh SEE ALSO
150.Xr arp 4 ,
151.Xr ifmedia 4 ,
152.Xr intro 4 ,
153.Xr netintro 4 ,
154.Xr pci 4 ,
155.Xr hostname.if 5 ,
156.Xr ifconfig 8
157.Sh HISTORY
158The
159.Nm
160device driver first appeared in
161.Ox 5.7 .
162.Sh CAVEATS
163This driver does not support powersave mode.
164