git: f02c5a4cf950 - stable/13 - iwlwifi: add man pages
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Thu, 30 Dec 2021 19:22:50 UTC
The branch stable/13 has been updated by bz:
URL: https://cgit.FreeBSD.org/src/commit/?id=f02c5a4cf9507e24da4ad868398b2b9b875d4ec0
commit f02c5a4cf9507e24da4ad868398b2b9b875d4ec0
Author: Bjoern A. Zeeb <bz@FreeBSD.org>
AuthorDate: 2021-12-27 17:40:02 +0000
Commit: Bjoern A. Zeeb <bz@FreeBSD.org>
CommitDate: 2021-12-30 18:28:32 +0000
iwlwifi: add man pages
Add and hook up man pages for iwlwifi and iwlwififw and install a copy
of the firmware license to /usr/share/docs/legal so it will always be
shipped with the installed system.
Sponsored by: The FreeBSD Foundation
(cherry picked from commit 5a02ae5e8f2d74b7ac20fa2e0cd98c66d934905b)
---
share/doc/legal/Makefile | 1 +
share/doc/legal/intel_iwlwififw/Makefile | 7 +++
share/man/man4/Makefile | 2 +
share/man/man4/iwlwifi.4 | 81 ++++++++++++++++++++++++++++++++
share/man/man4/iwlwififw.4 | 52 ++++++++++++++++++++
5 files changed, 143 insertions(+)
diff --git a/share/doc/legal/Makefile b/share/doc/legal/Makefile
index 5c0f37bd33d2..7a20215305d2 100644
--- a/share/doc/legal/Makefile
+++ b/share/doc/legal/Makefile
@@ -2,6 +2,7 @@
SUBDIR= intel_ipw \
intel_iwi \
+ intel_iwlwififw \
intel_iwn \
intel_wpi \
realtek
diff --git a/share/doc/legal/intel_iwlwififw/Makefile b/share/doc/legal/intel_iwlwififw/Makefile
new file mode 100644
index 000000000000..a2d806075d1a
--- /dev/null
+++ b/share/doc/legal/intel_iwlwififw/Makefile
@@ -0,0 +1,7 @@
+# $FreeBSD$
+
+FILES= ${SRCTOP}/sys/contrib/dev/iwlwififw/LICENCE.iwlwifi_firmware
+FILESDIR= ${SHAREDIR}/doc/legal
+FILESNAME= intel_iwlwifi_firmware.LICENCE
+
+.include <bsd.prog.mk>
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 655997ebaa31..4a8bb061a3c5 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -255,6 +255,8 @@ MAN= aac.4 \
iwmfw.4 \
iwn.4 \
iwnfw.4 \
+ iwlwifi.4 \
+ iwlwififw.4 \
ixgbe.4 \
ixl.4 \
jedec_dimm.4 \
diff --git a/share/man/man4/iwlwifi.4 b/share/man/man4/iwlwifi.4
new file mode 100644
index 000000000000..5d96b263c9e2
--- /dev/null
+++ b/share/man/man4/iwlwifi.4
@@ -0,0 +1,81 @@
+.\"-
+.\" Copyright (c) 2021 The FreeBSD Foundation
+.\"
+.\" This documentation was written by Bj\xc3\xb6rn Zeeb under sponsorship from
+.\" the FreeBSD Foundation.
+.\"
+.\" 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, 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$
+.\"
+.Dd October 27, 2021
+.Dt iwlwifi 4
+.Os
+.Sh NAME
+.Nm iwlwifi
+.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 :
+.Bd -literal -offset indent
+if_iwlwifi_load="YES"
+.Ed
+.Pp
+The driver should automatically load any
+.Xr iwlwififw 4
+firmware needed for the particular chipset.
+.Sh DESCRIPTION
+The
+.Nm
+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
+.Xr iwm 4
+driver which provided support for a subset of these chipsets and still
+complements the
+.Xr iwn 4
+driver supporting older chipsets.
+.Pp
+The driver uses the
+.\" No LinuxKPI man pages so no .Xr here.
+.Em linuxkpi_wlan
+and
+.Em linuxkpi
+compat framework to bridge between the Linux and
+native FreeBSD driver code.
+.Pp
+While
+.Nm
+supports all 802.11 a/b/g/n/ac/ax
+the compatibility code currently only supports 802.11 a/b/g modes.
+Support for 802.11 n/ac is to come. 802.11ax and 6Ghz support are planned.
+.Sh BUGS
+Certainly.
+.Sh SEE ALSO
+.Xr iwlwififw 4 ,
+.Xr iwm 4 ,
+.Xr iwn 4 ,
+.Xr wlan 4 ,
+.Xr ifconfig 8 ,
+.Xr wpa_supplicant 8
diff --git a/share/man/man4/iwlwififw.4 b/share/man/man4/iwlwififw.4
new file mode 100644
index 000000000000..81daaa02817a
--- /dev/null
+++ b/share/man/man4/iwlwififw.4
@@ -0,0 +1,52 @@
+.\"-
+.\" Copyright (c) 2021 The FreeBSD Foundation
+.\"
+.\" This documentation was written by Bj\xc3\xb6rn Zeeb under sponsorship from
+.\" the FreeBSD Foundation.
+.\"
+.\" 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, 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$
+.\"
+.Dd November 30, 2021
+.Dt iwlwififw 4
+.Os
+.Sh NAME
+.Nm iwlwififw
+.Nd Firmware modules for Intel iwlwifi wireless network driver
+.Sh SYNOPSIS
+The
+.Xr iwlwifi 4
+driver should auto-load any firmware needed.
+.Sh DESCRIPTION
+Multiple modules provide access to firmware for the various chipset
+models supported by the
+.Xr iwlwifi 4
+driver.
+.Sh FILES
+A copy of the
+.Xr iwlwifi 4
+firmware license is installed at
+.Em /usr/share/doc/legal/intel_iwlwifi_firmware.LICENCE .
+.Sh SEE ALSO
+.Xr iwlwifi 4 ,
+.Xr firmware 9