From nobody Fri Apr 01 00:32:29 2022 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 545481A4E6E9; Fri, 1 Apr 2022 00:32:30 +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 4KV1Mx599mz3kZC; Fri, 1 Apr 2022 00:32:29 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1648773150; 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=pKleT/Bywe+PhExnqEGOfYM6rurkdWxmXss0MUQ7+WE=; b=gfc6t7XwAjyaVd3KO+bxkG3p7bAcFD4wly30g9koVatzU3L2GvueB7EeJAIJNPirt03LCy Evt3vy3bGTwWFLfCJWET62CT3/bUAwmToQpMLETQ21PFhY9B7nG+nv33lrSIgVVcncSfYW EYuIyf3ZbPvJ1tlGJp19mtCjbik8+b8f8LHJ8w1kah+ccLtyPhJIHsMZVd+uB76frjrNdJ VaPKOl0Vg1OITe720kcrSHZ3oI+XyxIVTv98PJSTQlXwlopZWIG6oC72k9Pu/cpzTmgiOS OJnsnEDi6ascnsKJbUOcA82z0pB6YZjmmzpNXS9ik6dR8wirt0GAvjT/bj6xGA== 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 69E472062; Fri, 1 Apr 2022 00:32:29 +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 2310WTXH082138; Fri, 1 Apr 2022 00:32:29 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 2310WTKs082123; Fri, 1 Apr 2022 00:32:29 GMT (envelope-from git) Date: Fri, 1 Apr 2022 00:32:29 GMT Message-Id: <202204010032.2310WTKs082123@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: 20eeed6844e2 - main - rtw88: add man pages and hook up to build 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: 20eeed6844e2ab82b909e02c720101297e78d916 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1648773150; 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=pKleT/Bywe+PhExnqEGOfYM6rurkdWxmXss0MUQ7+WE=; b=AN7Yeph8LfDByAdQ5J5NMzv7z0vSnkinjq1Jt9RUEBVMi0af6HqsH4AKB808zlRQuNh5BA LyEssGXcJSwg6j4GSx3aoo8E4DV0cmli5xpzomUFgzbsiXNK+vnX+j5urYxnqse2YPYsGQ Ax/JkGqKd3INpzmFYtUCAqoLCRLg3+CobfJ5A5C6gGuAJkmTqqJXqOgtBkkkGRlvClF0bJ VY7FzmbwILJMHuvEEBbv9a29AxtiXwshmV6wtxSG/ONVyQkKtGF1gcG3eR+UqzKi6xUNmQ h37MBDizJUD73dUzLA8SPXhq0qs6YZAk/mLSQb56oE82I/ioOLjdN/ck9kPl6A== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1648773150; a=rsa-sha256; cv=none; b=HYvGgE+3jF9m5uxbxyvF1TliHP5Dj73r1MBu8unHCeAvY0laUdipQH0iNGMx0CEN82odP8 rMkm26iqYzdQTx5xMLFLccglx0405vZIvQ8p0Z76KM8eRdgj098psXnkdkYFbr8ZeIQzlG gWFIvUdCugdIGSNMe+1oEh1REMfzHo2gQH6EUAtLh/jQGunmgJ3suDazYv5N4blPPSAPhH soVJveajowbNdtLzkCcE6v4q6L0TejSoZSGhTsXzq5vQ4KsXxTdt47ntfaUcWdW+xLZH2v LPLt2lZxL1q+Yzx2NUy+Y5O41iAdUOHPuZjdI+MABMPIX9x4GJf/TqQDFf9i3w== 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=20eeed6844e2ab82b909e02c720101297e78d916 commit 20eeed6844e2ab82b909e02c720101297e78d916 Author: Bjoern A. Zeeb AuthorDate: 2022-03-30 22:36:03 +0000 Commit: Bjoern A. Zeeb CommitDate: 2022-04-01 00:07:24 +0000 rtw88: add man pages and hook up to build Add man pages for rtw88 and rtw88fw. Install a copy of the firmware license file and hook up the driver and firmware modules to the build. MFC after: 2 weeks Sponsored by: The FreeBSD Foundation Relnotes: yes --- share/doc/legal/Makefile | 3 +- share/doc/legal/realtek_rtw88/Makefile | 7 +++ share/man/man4/Makefile | 2 + share/man/man4/rtw88.4 | 95 ++++++++++++++++++++++++++++++++++ share/man/man4/rtw88fw.4 | 56 ++++++++++++++++++++ sys/modules/Makefile | 6 +++ 6 files changed, 168 insertions(+), 1 deletion(-) diff --git a/share/doc/legal/Makefile b/share/doc/legal/Makefile index 7a20215305d2..9710bfa48832 100644 --- a/share/doc/legal/Makefile +++ b/share/doc/legal/Makefile @@ -5,7 +5,8 @@ SUBDIR= intel_ipw \ intel_iwlwififw \ intel_iwn \ intel_wpi \ - realtek + realtek \ + realtek_rtw88 SUBDIR_PARALLEL= diff --git a/share/doc/legal/realtek_rtw88/Makefile b/share/doc/legal/realtek_rtw88/Makefile new file mode 100644 index 000000000000..8f1d6d9b9c41 --- /dev/null +++ b/share/doc/legal/realtek_rtw88/Makefile @@ -0,0 +1,7 @@ +# $FreeBSD$ + +FILES= ${SRCTOP}/sys/contrib/dev/rtw88fw/LICENCE.rtlwifi_firmware.txt +FILESDIR= ${SHAREDIR}/doc/legal +FILESNAME= realtek_rtw88_firmware.LICENCE + +.include diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index 251b09081b34..605285816ce3 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -466,6 +466,8 @@ MAN= aac.4 \ rndtest.4 \ route.4 \ rtsx.4 \ + rtw88.4 \ + rtw88fw.4 \ rtwn.4 \ rtwnfw.4 \ rtwn_pci.4 \ diff --git a/share/man/man4/rtw88.4 b/share/man/man4/rtw88.4 new file mode 100644 index 000000000000..b34fbf96c5df --- /dev/null +++ b/share/man/man4/rtw88.4 @@ -0,0 +1,95 @@ +.\"- +.\" Copyright (c) 2022 Bjoern A. Zeeb +.\" +.\" 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 March 31, 2022 +.Dt rtw88 4 +.Os +.Sh NAME +.Nm rtw88 +.Nd Realtek IEEE 802.11n/ac wireless network driver +.Sh SYNOPSIS +The driver will auto-load without any user interaction using +.Xr devmatch 8 +if enabled in +.Xr rc.conf 5 . +.Pp +Only if auto-loading is explicitly disabled, place the following +lines in +.Xr rc.conf 5 +to manually load the driver as a module at boot time: +.Bd -literal -offset indent +kld_list="${kld_list} if_rtw88" +.Ed +.Pp +The driver should automatically load any +.Xr rtw88fw 4 +firmware needed for the particular chipset. +.Pp +It is discouraged to load the driver from +.Xr loader 8 . +.Sh DESCRIPTION +The +.Nm +driver is derived from Realtek's Linux rtw88 driver and provides support for +the following chipsets: +.Pp +.Bl -tag -width Ds -offset indent -compact +.It Realtek 802.11n wireless 8723de (RTL8723DE) +.It Realtek 802.11ac wireless 8821ce (RTL8821CE) +.It Realtek 802.11ac wireless 8822be (RTL8822BE) +.It Realtek 802.11ac wireless 8822ce (RTL8822CE) +.El +.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 as well as to the native +.Xr net80211 4 +wireless stack. +.Pp +While +.Nm +supports all 802.11 a/b/g/n and ac +the compatibility code currently only supports 802.11 a/b/g modes. +Support for 802.11 n/ac is to come. +.Sh BUGS +Certainly. +.Pp +Does not seem to work (reliably) on machines with more than 4GB of +main memory. +.Sh SEE ALSO +.Xr rtw88fw 4 , +.Xr wlan 4 , +.Xr ifconfig 8 , +.Xr wpa_supplicant 8 +.Sh HISTORY +The +.Nm +driver first appeared in +.Fx 14.0 . diff --git a/share/man/man4/rtw88fw.4 b/share/man/man4/rtw88fw.4 new file mode 100644 index 000000000000..1bf756d67e57 --- /dev/null +++ b/share/man/man4/rtw88fw.4 @@ -0,0 +1,56 @@ +.\"- +.\" Copyright (c) 2022 Bjoern A. Zeeb +.\" +.\" 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 March 31, 2022 +.Dt rtw88fw 4 +.Os +.Sh NAME +.Nm rtw88fw +.Nd Firmware modules for Realtek rtw88 wireless network driver +.Sh SYNOPSIS +The +.Xr rtw88 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 +.Xr rtw88 4 +driver. +.Sh FILES +A copy of the +.Xr rtw88 4 +firmware license is installed at +.Em /usr/share/doc/legal/realtek_rtw88_firmware.LICENCE . +.Sh SEE ALSO +.Xr rtw88 4 , +.Xr firmware 9 +.Sh HISTORY +The +.Nm +firmware modules first appeared in +.Fx 14.0 . diff --git a/sys/modules/Makefile b/sys/modules/Makefile index 15f92f04da26..3731e9c1e453 100644 --- a/sys/modules/Makefile +++ b/sys/modules/Makefile @@ -319,6 +319,8 @@ SUBDIR= \ rl \ ${_rockchip} \ rtsx \ + ${_rtw88} \ + ${_rtw88fw} \ rtwn \ rtwn_pci \ rtwn_usb \ @@ -529,6 +531,10 @@ _mlx4ib= mlx4ib _mlx5ib= mlx5ib .endif _ossl= ossl +_rtw88= rtw88 +.if ${MK_SOURCELESS_UCODE} != "no" +_rtw88fw= rtw88fw +.endif _vmware= vmware .endif