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