iwm.4: move hardware list to .Sh HARDWARE and minor cleanup
Some checks are pending
Cross-build Kernel / ${{ matrix.target_arch }} ${{ matrix.os }} (${{ matrix.compiler }}) (clang-14, /usr/lib/llvm-14/bin, ubuntu-22.04, bmake libarchive-dev clang-14 lld-14, amd64, amd64) (push) Waiting to run
Cross-build Kernel / ${{ matrix.target_arch }} ${{ matrix.os }} (${{ matrix.compiler }}) (clang-14, /usr/lib/llvm-14/bin, ubuntu-22.04, bmake libarchive-dev clang-14 lld-14, arm64, aarch64) (push) Waiting to run
Cross-build Kernel / ${{ matrix.target_arch }} ${{ matrix.os }} (${{ matrix.compiler }}) (clang-18, /opt/homebrew/opt/llvm@18/bin, macos-latest, bmake libarchive llvm@18, amd64, amd64) (push) Waiting to run
Cross-build Kernel / ${{ matrix.target_arch }} ${{ matrix.os }} (${{ matrix.compiler }}) (clang-18, /opt/homebrew/opt/llvm@18/bin, macos-latest, bmake libarchive llvm@18, arm64, aarch64) (push) Waiting to run
Cross-build Kernel / ${{ matrix.target_arch }} ${{ matrix.os }} (${{ matrix.compiler }}) (clang-18, /usr/lib/llvm-18/bin, ubuntu-24.04, bmake libarchive-dev clang-18 lld-18, amd64, amd64) (push) Waiting to run
Cross-build Kernel / ${{ matrix.target_arch }} ${{ matrix.os }} (${{ matrix.compiler }}) (clang-18, /usr/lib/llvm-18/bin, ubuntu-24.04, bmake libarchive-dev clang-18 lld-18, arm64, aarch64) (push) Waiting to run

Add devices supported by this driver to a HARDWARE section
for inclusion in the Release Hardware Compatibility Notes.

While here:
- license: add spdx license identifier tag
- synopsis: join a line for grep/brevity
- description: reflow for consistency, xref iwmfw(4)
- examples: use test-net-1 in cidr notation as example IPv4 address
- see also: add networking(7) quick start guide
- bugs: move 'incompatible modes' here for consistency/flow
- mention 802.11a support

MFC after:	3 days
Reported by:	bz (relnotes generation, cidr, test-net-1 ip4addr)
Reported by:	Graham Percival <gperciva@tarsnap.com> (no prompt)
Reviewed by:	bz
Differential Revision: https://reviews.freebsd.org/D47171
This commit is contained in:
Alexander Ziaee 2024-11-10 19:28:22 +00:00 committed by Bjoern A. Zeeb
parent 2483a2d368
commit 8f1a2d507e

View File

@ -1,3 +1,6 @@
.\"-
.\" SPDX-License-Identifier: BSD-2-Clause
.\"
.\" Copyright (c) 2004-2006
.\" Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
.\"
@ -31,8 +34,7 @@
.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:
include the following lines in your kernel configuration file:
.Bd -ragged -offset indent
.Cd "device iwm"
.Cd "device pci"
@ -79,55 +81,59 @@ iwm9260fw_load="YES"
.Sh DESCRIPTION
The
.Nm
driver provides support for:
.Pp
.Bl -tag -width Ds -offset indent -compact
.It Intel Dual Band Wireless AC 3160
.It Intel Dual Band Wireless AC 3165
.It Intel Dual Band Wireless AC 3168
.It Intel Dual Band Wireless AC 7260
.It Intel Dual Band Wireless AC 7265
.It Intel Dual Band Wireless AC 8260
.It Intel Dual Band Wireless AC 8265
.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
.El
.Pp
.Nm
supports
driver supports running most Intel Wireless AC series network devices in
.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
.Xr iwmfw 4
module to work.
.Pp
Currently,
For more information on configuring this device, see
.Xr ifconfig 8 .
.Sh HARDWARE
The
.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.
driver supports the following PCIe Wi-Fi devices:
.Pp
.Bl -bullet -compact
.It
Intel Dual Band Wireless AC 3160
.It
Intel Dual Band Wireless AC 3165
.It
Intel Dual Band Wireless AC 3168
.It
Intel Dual Band Wireless AC 7260
.It
Intel Dual Band Wireless AC 7265
.It
Intel Dual Band Wireless AC 8260
.It
Intel Dual Band Wireless AC 8265
.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
.El
.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
.Dl ifconfig wlan create wlandev iwm0 inet 192.0.2.20/24
.Pp
Join a specific BSS network with network name
.Dq Li my_net :
.Ar my_net :
.Pp
.Dl "ifconfig wlan create wlandev iwm0 ssid my_net up"
.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
wepmode on wepkey 0x1234567890 weptxkey 1 up
.Ed
.Pp
Join a specific BSS network with 128-bit WEP encryption:
@ -155,15 +161,16 @@ 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.
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.
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.
An attempt to upload the main firmware image
to the onboard microcontroller failed.
This should not happen.
.El
.Sh SEE ALSO
@ -174,5 +181,12 @@ This should not happen.
.Xr wlan_ccmp 4 ,
.Xr wlan_tkip 4 ,
.Xr wlan_wep 4 ,
.Xr networking 7 ,
.Xr ifconfig 8 ,
.Xr wpa_supplicant 8
.Sh BUGS
Currently,
.Nm
only supports 802.11a/b/g modes.
It will not associate to access points that are configured to operate
only in 802.11n/ac modes.