From nobody Mon Dec 27 19:11:49 2021 X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 550F81926D71; Mon, 27 Dec 2021 19:11:53 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4JN6jM1kt1z3vyk; Mon, 27 Dec 2021 19:11:51 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 14D4E23440; Mon, 27 Dec 2021 19:11:50 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 1BRJBnqr037690; Mon, 27 Dec 2021 19:11:49 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 1BRJBnC0037689; Mon, 27 Dec 2021 19:11:49 GMT (envelope-from git) Date: Mon, 27 Dec 2021 19:11:49 GMT Message-Id: <202112271911.1BRJBnC0037689@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: "Bjoern A. Zeeb" Subject: git: 5a02ae5e8f2d - main - iwlwifi: add man pages List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: bz X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 5a02ae5e8f2d74b7ac20fa2e0cd98c66d934905b Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1640632311; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=1sgAPUVWnz3+Td/aIIOlJRTk0KyPkRhFimKxJCDRTHE=; b=VlZv61NdoiTfEwwMoTah/Sy37xYiYq10Q2YjQdoqiJEiMOxFbA0Y+PlbMHaM8sxjlJByW+ Kmoj6keI+cNghNkHJb76shJEniXClWK2QIpZQpPcDxmxmU18ulu1VLXsxpWHl8VDBSOZ5w 5H1fAX/2WAlS0Zu1M5DmcImuy37pL7t8RcZ0CpK7OUrkg1Y1HBOYqMKn+cN163S2cRZ0ud cnkHrqtyPcWwWal1sIM5HqsxQBWB13zAN7o145X6gFw7sI4G15zdIpRT8224eS7CgynVjj nEpL7eKhJaIVBO82jZ24erf/RlcCborgakNGxR2pDlXtzRYQJPzM53T6xT8yWw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1640632311; a=rsa-sha256; cv=none; b=Cq0+vEJvW3MVZ3qJabbQfMiOh77so8uCaOyuk3IMhyTyaz4Nv6XOaPnXV5Vmn/+jpzPjaE O0qAdJZVnkx5kIs1fnyjc2oeEOthPJlfeGxzxm0mwgr9aeiIH+h2suqaqTgY0e5/YnXB2u q+xlTVDKj0Wx+g6R+KPdon4LCe0/SdeG3LkgmvxU2JkFhxiYSFkOH7E/umKsm3VI2KGCmg JTtRos2u8b3+GPghceYSHtFb763WESPdszkDwtc9WTu4EFK5lxCe4EnJ4ckqThknoDRSWO bZOZDiXe9Ko0fq5RWLgz3KfVm284/zkQmsGVUG4IkFb871jaGiWjPLEf/5Ao4w== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by bz: URL: https://cgit.FreeBSD.org/src/commit/?id=5a02ae5e8f2d74b7ac20fa2e0cd98c66d934905b commit 5a02ae5e8f2d74b7ac20fa2e0cd98c66d934905b Author: Bjoern A. Zeeb AuthorDate: 2021-12-27 17:40:02 +0000 Commit: Bjoern A. Zeeb CommitDate: 2021-12-27 18:47:25 +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 MFC after: 3 days --- 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 diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index d1a3258094c4..7b64bad84536 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -251,6 +251,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