d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
freebsd-skq/share/man/man4/iwm.4

178 lines
5.2 KiB
Groff
Raw Permalink Normal View History

Import OpenBSD's iwm WiFi driver for Intel 3160/7260/7265. There are still several bugs, but I've been using it for a while now. Thanks to all the testers and to Adrian for his help with this driver. This driver isn't connected to the build yet, but it will be soon. There's no MFC planned because the driver isn't very stable yet. Reviewed by: adrian Obtained from: https://github.com/rpaulo/iwm Tested by: adrian, gjb, dumbbell (others that I forgot). Relnotes: yes
2015-08-08 06:06:48 +00:00
.\" Copyright (c) 2004-2006
.\" Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice unmodified, this list of conditions, and the following
.\" disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
Document that Intel Dual Band Wireless AC 8265 is supported by iwm(4) MFC after: 2 weeks
2020-06-28 21:48:56 +00:00
.Dd June 28, 2020
Import OpenBSD's iwm WiFi driver for Intel 3160/7260/7265. There are still several bugs, but I've been using it for a while now. Thanks to all the testers and to Adrian for his help with this driver. This driver isn't connected to the build yet, but it will be soon. There's no MFC planned because the driver isn't very stable yet. Reviewed by: adrian Obtained from: https://github.com/rpaulo/iwm Tested by: adrian, gjb, dumbbell (others that I forgot). Relnotes: yes
2015-08-08 06:06:48 +00:00
.Dt IWM 4
.Os
.Sh NAME
.Nm iwm
.Nd Intel IEEE 802.11ac wireless network driver
.Sh SYNOPSIS
To compile this driver into the kernel,
include the following lines in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device iwm"
.Cd "device pci"
.Cd "device wlan"
.Cd "device firmware"
.Ed
.Pp
You also need to select a firmware for your device.
Choose one from:
.Bd -ragged -offset indent
.Cd "device iwm3160fw"
[iwm] Add support for iwm 3168 cards ``` iwm0@pci0:5:0:0: class=0x028000 card=0x21108086 chip=0x24fb8086 rev=0x10 hdr=0x00 vendor = 'Intel Corporation' device = 'Dual Band Wireless-AC 3168NGW [Stone Peak]' class = network [94829] iwm0: <Intel(R) Dual Band Wireless AC 3168> mem 0xef700000-0xef701fff at device 0.0 on pci5 [94829] iwm0: hw rev 0x220, fw ver 22.361476.0, address 28:c6:3f:15:43:c5 ``` MFC After: 2 weeks Reviewed by: ivadasz (over IRC) PR: 224886 Differential Revision: https://reviews.freebsd.org/D14865
2018-03-28 07:59:16 +00:00
.Cd "device iwm3168fw"
Import OpenBSD's iwm WiFi driver for Intel 3160/7260/7265. There are still several bugs, but I've been using it for a while now. Thanks to all the testers and to Adrian for his help with this driver. This driver isn't connected to the build yet, but it will be soon. There's no MFC planned because the driver isn't very stable yet. Reviewed by: adrian Obtained from: https://github.com/rpaulo/iwm Tested by: adrian, gjb, dumbbell (others that I forgot). Relnotes: yes
2015-08-08 06:06:48 +00:00
.Cd "device iwm7260fw"
.Cd "device iwm7265fw"
Mention AC3165 and AC8260 chipsets in iwm(4) and mention AC3165 in iwmfw(4) - Support for the AC3165 and AC8260 chipsets was added by r303322 and r303327. Approved by: adrian (mentor) Differential Revision: https://reviews.freebsd.org/D7322
2016-07-26 21:27:02 +00:00
.Cd "device iwm8000Cfw"
Reference iwm8265fw support in iwm(4) as well This documentation update is similar to what was done in iwmfw(4) in r325121. MFC after: 1 month MFC with: r325121
2017-10-30 06:43:40 +00:00
.Cd "device iwm8265fw"
Update iwm and iwmfw man pages with info about 9000-series chips. Thanks to bapt, bz, cem, woodsb02, Neel Chauhan and Salvador Martínez Mármol for helping test the initial 9000-series support. MFC after: 2 weeks Sponsored by: The FreeBSD Foundation
2019-11-07 23:39:33 +00:00
.Cd "device iwm9000fw"
.Cd "device iwm9260fw"
Import OpenBSD's iwm WiFi driver for Intel 3160/7260/7265. There are still several bugs, but I've been using it for a while now. Thanks to all the testers and to Adrian for his help with this driver. This driver isn't connected to the build yet, but it will be soon. There's no MFC planned because the driver isn't very stable yet. Reviewed by: adrian Obtained from: https://github.com/rpaulo/iwm Tested by: adrian, gjb, dumbbell (others that I forgot). Relnotes: yes
2015-08-08 06:06:48 +00:00
.Ed
.Pp
Or you can use
.Bd -ragged -offset indent
.Cd "device iwmfw"
.Ed
.Pp
to include them all.
.Pp
Alternatively, to load the driver as a
module at boot time, place the following lines in
.Xr loader.conf 5 :
.Bd -literal -offset indent
if_iwm_load="YES"
iwm3160fw_load="YES"
[iwm] Add support for iwm 3168 cards ``` iwm0@pci0:5:0:0: class=0x028000 card=0x21108086 chip=0x24fb8086 rev=0x10 hdr=0x00 vendor = 'Intel Corporation' device = 'Dual Band Wireless-AC 3168NGW [Stone Peak]' class = network [94829] iwm0: <Intel(R) Dual Band Wireless AC 3168> mem 0xef700000-0xef701fff at device 0.0 on pci5 [94829] iwm0: hw rev 0x220, fw ver 22.361476.0, address 28:c6:3f:15:43:c5 ``` MFC After: 2 weeks Reviewed by: ivadasz (over IRC) PR: 224886 Differential Revision: https://reviews.freebsd.org/D14865
2018-03-28 07:59:16 +00:00
iwm3168fw_load="YES"
Import OpenBSD's iwm WiFi driver for Intel 3160/7260/7265. There are still several bugs, but I've been using it for a while now. Thanks to all the testers and to Adrian for his help with this driver. This driver isn't connected to the build yet, but it will be soon. There's no MFC planned because the driver isn't very stable yet. Reviewed by: adrian Obtained from: https://github.com/rpaulo/iwm Tested by: adrian, gjb, dumbbell (others that I forgot). Relnotes: yes
2015-08-08 06:06:48 +00:00
iwm7260fw_load="YES"
iwm7265fw_load="YES"
Mention AC3165 and AC8260 chipsets in iwm(4) and mention AC3165 in iwmfw(4) - Support for the AC3165 and AC8260 chipsets was added by r303322 and r303327. Approved by: adrian (mentor) Differential Revision: https://reviews.freebsd.org/D7322
2016-07-26 21:27:02 +00:00
iwm8000Cfw_load="YES"
Reference iwm8265fw support in iwm(4) as well This documentation update is similar to what was done in iwmfw(4) in r325121. MFC after: 1 month MFC with: r325121
2017-10-30 06:43:40 +00:00
iwm8265fw_load="YES"
Update iwm and iwmfw man pages with info about 9000-series chips. Thanks to bapt, bz, cem, woodsb02, Neel Chauhan and Salvador Martínez Mármol for helping test the initial 9000-series support. MFC after: 2 weeks Sponsored by: The FreeBSD Foundation
2019-11-07 23:39:33 +00:00
iwm9000fw_load="YES"
iwm9260fw_load="YES"
Import OpenBSD's iwm WiFi driver for Intel 3160/7260/7265. There are still several bugs, but I've been using it for a while now. Thanks to all the testers and to Adrian for his help with this driver. This driver isn't connected to the build yet, but it will be soon. There's no MFC planned because the driver isn't very stable yet. Reviewed by: adrian Obtained from: https://github.com/rpaulo/iwm Tested by: adrian, gjb, dumbbell (others that I forgot). Relnotes: yes
2015-08-08 06:06:48 +00:00
.Ed
.Sh DESCRIPTION
The
.Nm
driver provides support for:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Intel Dual Band Wireless AC 3160
Mention AC3165 and AC8260 chipsets in iwm(4) and mention AC3165 in iwmfw(4) - Support for the AC3165 and AC8260 chipsets was added by r303322 and r303327. Approved by: adrian (mentor) Differential Revision: https://reviews.freebsd.org/D7322
2016-07-26 21:27:02 +00:00
.It Intel Dual Band Wireless AC 3165
[iwm] Add support for iwm 3168 cards ``` iwm0@pci0:5:0:0: class=0x028000 card=0x21108086 chip=0x24fb8086 rev=0x10 hdr=0x00 vendor = 'Intel Corporation' device = 'Dual Band Wireless-AC 3168NGW [Stone Peak]' class = network [94829] iwm0: <Intel(R) Dual Band Wireless AC 3168> mem 0xef700000-0xef701fff at device 0.0 on pci5 [94829] iwm0: hw rev 0x220, fw ver 22.361476.0, address 28:c6:3f:15:43:c5 ``` MFC After: 2 weeks Reviewed by: ivadasz (over IRC) PR: 224886 Differential Revision: https://reviews.freebsd.org/D14865
2018-03-28 07:59:16 +00:00
.It Intel Dual Band Wireless AC 3168
Import OpenBSD's iwm WiFi driver for Intel 3160/7260/7265. There are still several bugs, but I've been using it for a while now. Thanks to all the testers and to Adrian for his help with this driver. This driver isn't connected to the build yet, but it will be soon. There's no MFC planned because the driver isn't very stable yet. Reviewed by: adrian Obtained from: https://github.com/rpaulo/iwm Tested by: adrian, gjb, dumbbell (others that I forgot). Relnotes: yes
2015-08-08 06:06:48 +00:00
.It Intel Dual Band Wireless AC 7260
.It Intel Dual Band Wireless AC 7265
Mention AC3165 and AC8260 chipsets in iwm(4) and mention AC3165 in iwmfw(4) - Support for the AC3165 and AC8260 chipsets was added by r303322 and r303327. Approved by: adrian (mentor) Differential Revision: https://reviews.freebsd.org/D7322
2016-07-26 21:27:02 +00:00
.It Intel Dual Band Wireless AC 8260
Document that Intel Dual Band Wireless AC 8265 is supported by iwm(4) MFC after: 2 weeks
2020-06-28 21:48:56 +00:00
.It Intel Dual Band Wireless AC 8265
Update iwm and iwmfw man pages with info about 9000-series chips. Thanks to bapt, bz, cem, woodsb02, Neel Chauhan and Salvador Martínez Mármol for helping test the initial 9000-series support. MFC after: 2 weeks Sponsored by: The FreeBSD Foundation
2019-11-07 23:39:33 +00:00
.It Intel Dual Band Wireless AC 9260
.It Intel Dual Band Wireless AC 9270
.It Intel Dual Band Wireless AC 946X
.It Intel Dual Band Wireless AC 9560
Import OpenBSD's iwm WiFi driver for Intel 3160/7260/7265. There are still several bugs, but I've been using it for a while now. Thanks to all the testers and to Adrian for his help with this driver. This driver isn't connected to the build yet, but it will be soon. There's no MFC planned because the driver isn't very stable yet. Reviewed by: adrian Obtained from: https://github.com/rpaulo/iwm Tested by: adrian, gjb, dumbbell (others that I forgot). Relnotes: yes
2015-08-08 06:06:48 +00:00
.El
.Pp
.Nm
supports
.Cm station
mode operation.
Only one virtual interface may be configured at any time.
For more information on configuring this device, see
.Xr ifconfig 8 .
.Pp
This driver requires the firmware built with the
.Nm iwmfw
module to work.
iwm(4): Document limitations of the driver Document that iwm(4) currently doesn't support 802.11n and 802.11ac. PR: 247874 Submitted by: Charles Ross <cwr at sdf dot org> Reviewed by: brueffer, markj Approved by: brueffer MFC after: 1 week Differential Revision: https://reviews.freebsd.org/D25666
2020-07-17 21:47:06 +00:00
.Pp
Currently,
.Nm
only supports 802.11b and 802.11g modes.
It will not associate to access points that are configured to operate only
in 802.11n or 802.11ac modes.
Import OpenBSD's iwm WiFi driver for Intel 3160/7260/7265. There are still several bugs, but I've been using it for a while now. Thanks to all the testers and to Adrian for his help with this driver. This driver isn't connected to the build yet, but it will be soon. There's no MFC planned because the driver isn't very stable yet. Reviewed by: adrian Obtained from: https://github.com/rpaulo/iwm Tested by: adrian, gjb, dumbbell (others that I forgot). Relnotes: yes
2015-08-08 06:06:48 +00:00
.Sh EXAMPLES
Join an existing BSS network (i.e., connect to an access point):
.Bd -literal -offset indent
ifconfig wlan create wlandev iwm0 inet 192.168.0.20 \e
netmask 0xffffff00
.Ed
.Pp
Join a specific BSS network with network name
.Dq Li my_net :
.Pp
.Dl "ifconfig wlan create wlandev iwm0 ssid my_net up"
.Pp
Join a specific BSS network with 64-bit WEP encryption:
.Bd -literal -offset indent
ifconfig wlan create wlandev iwm0 ssid my_net \e
wepmode on wepkey 0x1234567890 weptxkey 1 up
.Ed
.Pp
Join a specific BSS network with 128-bit WEP encryption:
.Bd -literal -offset indent
ifconfig wlan create wlandev iwm0 wlanmode adhoc ssid my_net \e
wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
.Ed
.Sh DIAGNOSTICS
.Bl -diag
.It "iwm%d: device timeout"
The driver will reset the hardware.
This should not happen.
.It "iwm%d: firmware error"
The onboard microcontroller crashed for some reason.
The driver will reset the hardware.
This should not happen.
.It "iwm%d: timeout waiting for firmware initialization to complete"
The onboard microcontroller failed to initialize in time.
This should not happen.
.It "iwm%d: could not load firmware image '%s'"
The driver failed to load the firmware image using the
.Xr firmware 9
subsystem.
Verify the
.Xr iwmfw 4
firmware module is present.
.It "iwm%d: could not load boot firmware"
An attempt to upload the boot firmware image to the onboard microcontroller
failed.
This should not happen.
.It "iwm%d: could not load microcode"
An attempt to upload the microcode image to the onboard microcontroller failed.
This should not happen.
.It "iwm%d: could not load main firmware"
An attempt to upload the main firmware image to the onboard microcontroller
failed.
This should not happen.
.El
.Sh SEE ALSO
.Xr iwmfw 4 ,
.Xr pci 4 ,
.Xr wlan 4 ,
.Xr wlan_ccmp 4 ,
.Xr wlan_tkip 4 ,
.Xr wlan_wep 4 ,
.Xr ifconfig 8 ,
.Xr wpa_supplicant 8
Reference in New Issue Copy Permalink