git: e9016c0be83f - main - iwlwifi: clarify page update
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Sat, 01 Jan 2022 21:05:00 UTC
The branch main has been updated by bz:
URL: https://cgit.FreeBSD.org/src/commit/?id=e9016c0be83f9b1d9cf7c2460ee3b041967bb75f
commit e9016c0be83f9b1d9cf7c2460ee3b041967bb75f
Author: Bjoern A. Zeeb <bz@FreeBSD.org>
AuthorDate: 2022-01-01 18:08:31 +0000
Commit: Bjoern A. Zeeb <bz@FreeBSD.org>
CommitDate: 2022-01-01 20:57:13 +0000
iwlwifi: clarify page update
Based on some feedback clarify the man page for
- how to load the driver currently
- status of the driver with respect to iwm(4)
and leave a comment to (automatically) add a full list of chipsets
to the man page.
Sponsored by: The FreeBSD Foundation
MFC after: 3 days
Reviewed by: debdrup
Differential Revision: https://reviews.freebsd.org/D33713
---
share/man/man4/iwlwifi.4 | 29 ++++++++++++++++++++---------
share/man/man4/iwlwififw.4 | 4 +++-
2 files changed, 23 insertions(+), 10 deletions(-)
diff --git a/share/man/man4/iwlwifi.4 b/share/man/man4/iwlwifi.4
index 5d96b263c9e2..1f79319aad61 100644
--- a/share/man/man4/iwlwifi.4
+++ b/share/man/man4/iwlwifi.4
@@ -27,7 +27,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd October 27, 2021
+.Dd January 1, 2022
.Dt iwlwifi 4
.Os
.Sh NAME
@@ -35,14 +35,21 @@
.Nd Intel IEEE 802.11a/b/g/n/ac/ax wireless network driver
.Sh SYNOPSIS
To load the driver as a module at boot time, place the following lines in
-.Xr loader.conf 5 :
+.Xr rc.conf 5 :
.Bd -literal -offset indent
-if_iwlwifi_load="YES"
+kld_list="${kld_list} if_iwlwifi"
.Ed
.Pp
The driver should automatically load any
.Xr iwlwififw 4
-firmware needed for the particular chipset.
+firmware needed for the particular chipset in that case.
+.Pp
+It is anticipated that the driver will support auto-loading via
+.Xr devmatch 8
+in the future and will need no configuration at all.
+.Pp
+It is discouraged to load the driver from
+.Xr loader 8 .
.Sh DESCRIPTION
The
.Nm
@@ -50,12 +57,14 @@ driver is derived from Intel's Linux iwlwifi driver and provides support for
all chipsets supported by the
.Em mvm
part of that driver.
-This superseeds the
+.\" XXX-BZ find way to add full list of chipsets automatically
+.Nm
+will be a successor to
.Xr iwm 4
-driver which provided support for a subset of these chipsets and still
-complements the
+and may superseed that driver in the future.
+It still complements the
.Xr iwn 4
-driver supporting older chipsets.
+driver which supports older chipsets.
.Pp
The driver uses the
.\" No LinuxKPI man pages so no .Xr here.
@@ -63,7 +72,9 @@ The driver uses the
and
.Em linuxkpi
compat framework to bridge between the Linux and
-native FreeBSD driver code.
+native FreeBSD driver code as well as to the native
+.Xr net80211 4
+wireless stack.
.Pp
While
.Nm
diff --git a/share/man/man4/iwlwififw.4 b/share/man/man4/iwlwififw.4
index 81daaa02817a..d38d38f28695 100644
--- a/share/man/man4/iwlwififw.4
+++ b/share/man/man4/iwlwififw.4
@@ -27,7 +27,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 30, 2021
+.Dd January 1, 2022
.Dt iwlwififw 4
.Os
.Sh NAME
@@ -37,6 +37,8 @@
The
.Xr iwlwifi 4
driver should auto-load any firmware needed.
+It is discouraged to load the driver or firmware manually from
+.Xr loader 8 .
.Sh DESCRIPTION
Multiple modules provide access to firmware for the various chipset
models supported by the