git: cf94672363d6 - main - rtw88/rtw89: remove local firmware.
Date: Tue, 05 Sep 2023 21:16:50 UTC
The branch main has been updated by bz:
URL: https://cgit.FreeBSD.org/src/commit/?id=cf94672363d6638b7268c05b4628b62bbfc8dbe5
commit cf94672363d6638b7268c05b4628b62bbfc8dbe5
Author: Bjoern A. Zeeb <bz@FreeBSD.org>
AuthorDate: 2023-06-08 21:35:09 +0000
Commit: Bjoern A. Zeeb <bz@FreeBSD.org>
CommitDate: 2023-09-05 21:13:18 +0000
rtw88/rtw89: remove local firmware.
Remove firmware from src/ in favor of the ports/packages and fwget(8).
This will allow us to shrink the size of src (and installed modules).
Update the rtw88 man page to reflect the change.
MFC after: 20 days
X-MFC: will see about 14/13
---
ObsoleteFiles.inc | 3 ++
share/doc/legal/Makefile | 3 +-
share/doc/legal/realtek_rtw88/Makefile | 6 ---
share/man/man4/Makefile | 1 -
share/man/man4/rtw88.4 | 21 ++++++--
share/man/man4/rtw88fw.4 | 54 ---------------------
.../dev/rtw88fw/LICENCE.rtlwifi_firmware.txt | 39 ---------------
sys/contrib/dev/rtw88fw/README | 34 -------------
sys/contrib/dev/rtw88fw/WHENCE | 19 --------
sys/contrib/dev/rtw88fw/rtw8723d_fw.bin | Bin 28884 -> 0 bytes
sys/contrib/dev/rtw88fw/rtw8821c_fw.bin | Bin 138984 -> 0 bytes
sys/contrib/dev/rtw88fw/rtw8822b_fw.bin | Bin 150984 -> 0 bytes
sys/contrib/dev/rtw88fw/rtw8822c_fw.bin | Bin 200312 -> 0 bytes
sys/contrib/dev/rtw88fw/rtw8822c_wow_fw.bin | Bin 145224 -> 0 bytes
.../dev/rtw89fw/LICENCE.rtlwifi_firmware.txt | 39 ---------------
sys/contrib/dev/rtw89fw/WHENCE | 8 ---
sys/contrib/dev/rtw89fw/rtw8852a_fw.bin | Bin 1423232 -> 0 bytes
sys/contrib/dev/rtw89fw/rtw8852c_fw.bin | Bin 1340192 -> 0 bytes
18 files changed, 20 insertions(+), 207 deletions(-)
diff --git a/ObsoleteFiles.inc b/ObsoleteFiles.inc
index 98644685d83e..55a198db4d04 100644
--- a/ObsoleteFiles.inc
+++ b/ObsoleteFiles.inc
@@ -51,6 +51,9 @@
# xargs -n1 | sort | uniq -d;
# done
+# 20230905
+OLD_FILES+=usr/share/doc/legal/realtek_rtw88_firmware.LICENCE
+
# 20230828
MOVED_LIBS+=usr/lib/librt.so.1
diff --git a/share/doc/legal/Makefile b/share/doc/legal/Makefile
index 3a17e2f614e5..8e674019e9a2 100644
--- a/share/doc/legal/Makefile
+++ b/share/doc/legal/Makefile
@@ -4,8 +4,7 @@ SUBDIR= intel_ipw \
intel_iwlwififw \
intel_iwn \
intel_wpi \
- realtek \
- realtek_rtw88
+ realtek
SUBDIR_PARALLEL=
diff --git a/share/doc/legal/realtek_rtw88/Makefile b/share/doc/legal/realtek_rtw88/Makefile
deleted file mode 100644
index fa98e7c6094e..000000000000
--- a/share/doc/legal/realtek_rtw88/Makefile
+++ /dev/null
@@ -1,6 +0,0 @@
-
-FILES= ${SRCTOP}/sys/contrib/dev/rtw88fw/LICENCE.rtlwifi_firmware.txt
-FILESDIR= ${SHAREDIR}/doc/legal
-FILESNAME= realtek_rtw88_firmware.LICENCE
-
-.include <bsd.prog.mk>
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 148670072757..98fdfe428d99 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -471,7 +471,6 @@ MAN= aac.4 \
rtnetlink.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
index 6036ad62d84d..01572af8cbd3 100644
--- a/share/man/man4/rtw88.4
+++ b/share/man/man4/rtw88.4
@@ -22,7 +22,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
-.Dd April 22, 2023
+.Dd June 8, 2023
.Dt RTW88 4
.Os
.Sh NAME
@@ -42,10 +42,6 @@ to manually load the driver as a module at boot time:
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
@@ -61,6 +57,20 @@ the following chipsets:
.It Realtek 802.11ac wireless 8822ce (RTL8822CE)
.El
.Pp
+This driver requires firmware to be loaded before it will work.
+The package
+.Pa wifi-firmware-rtw88-kmod
+from the
+.Pa ports/net/wifi-firmware-rtw88-kmod
+port needs to be installed before the driver is loaded.
+Otherwise no
+.Xr wlan 4
+interface can be created using
+.Xr ifconfig 8 .
+One can use
+.Xr fwget 8
+to install the correct firmware package.
+.Pp
The driver uses the
.\" No LinuxKPI man pages so no .Xr here.
.Em linuxkpi_wlan
@@ -102,6 +112,7 @@ section above.
.Sh SEE ALSO
.Xr rtw88fw 4 ,
.Xr wlan 4 ,
+.Xr fwget 8 ,
.Xr ifconfig 8 ,
.Xr wpa_supplicant 8
.Sh HISTORY
diff --git a/share/man/man4/rtw88fw.4 b/share/man/man4/rtw88fw.4
deleted file mode 100644
index 529d283b4697..000000000000
--- a/share/man/man4/rtw88fw.4
+++ /dev/null
@@ -1,54 +0,0 @@
-.\"-
-.\" 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.
-.\"
-.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/contrib/dev/rtw88fw/LICENCE.rtlwifi_firmware.txt b/sys/contrib/dev/rtw88fw/LICENCE.rtlwifi_firmware.txt
deleted file mode 100644
index d70921f49379..000000000000
--- a/sys/contrib/dev/rtw88fw/LICENCE.rtlwifi_firmware.txt
+++ /dev/null
@@ -1,39 +0,0 @@
-Copyright (c) 2010, Realtek Semiconductor Corporation
-All rights reserved.
-
-Redistribution. Redistribution and use in binary form, without
-modification, are permitted provided that the following conditions are
-met:
-
-* Redistributions must reproduce the above copyright notice and the
- following disclaimer in the documentation and/or other materials
- provided with the distribution.
-* Neither the name of Realtek Semiconductor Corporation nor the names of its
- suppliers may be used to endorse or promote products derived from this
- software without specific prior written permission.
-* No reverse engineering, decompilation, or disassembly of this software
- is permitted.
-
-Limited patent license. Realtek Semiconductor Corporation grants a world-wide,
-royalty-free, non-exclusive license under patents it now or hereafter
-owns or controls to make, have made, use, import, offer to sell and
-sell ("Utilize") this software, but solely to the extent that any
-such patent is necessary to Utilize the software alone, or in
-combination with an operating system licensed under an approved Open
-Source license as listed by the Open Source Initiative at
-http://opensource.org/licenses. The patent license shall not apply to
-any other combinations which include this software. No hardware per
-se is licensed hereunder.
-
-DISCLAIMER. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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
-COPYRIGHT OWNER 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.
diff --git a/sys/contrib/dev/rtw88fw/README b/sys/contrib/dev/rtw88fw/README
deleted file mode 100644
index 01449ca72e4c..000000000000
--- a/sys/contrib/dev/rtw88fw/README
+++ /dev/null
@@ -1,34 +0,0 @@
-
- rtw88 firmware
-================
-
-This repository contains firmware images supported by Realtek's wireless
-driver rtw88. And some of the devices run with more than one firmware
-file. Basically, a "normal" firmware is necessary to be downloaded to
-the device.
-And another is called "wowlan" firmware, it should be loaded when a
-device is going to suspend. Which means driver will "re-download/swap"
-the firmware image. The wowlan firmware contains wake up functions that
-can recognize specific events and send a wake up signal to device if
-needed, and the system will resume to running state. During resume,
-driver will then swap the normal firmware back, return to running state.
-
-If any distros or platforms do not require wowlan feature, they can
-_only_ pick the normal firmware. And everything still works fine,
-except that the device cannot be waken from the wireless NICs.
-
-Currently supported devices with corresponding firmwares:
-
-RTL8822BE
- rtw8822b_fw.bin
-
-RTL8821CE
- rtw8821c_fw.bin
-
-RTL8822CE
- rtw8822c_fw.bin
- rtw8822c_wow_fw.bin
-
-RTL8723DE
- rtw8723d_fw.bin
-
diff --git a/sys/contrib/dev/rtw88fw/WHENCE b/sys/contrib/dev/rtw88fw/WHENCE
deleted file mode 100644
index 71cb61f86a1f..000000000000
--- a/sys/contrib/dev/rtw88fw/WHENCE
+++ /dev/null
@@ -1,19 +0,0 @@
-Driver: rtw88 - Realtek 802.11ac WLAN driver for RTL8822BE and RTL8822CE
-
-Info: Sent to Larry Finger by Realtek engineer Yan-Hsuan Chuang <yhchuang@realtek.com>
-File: rtw88/rtw8822b_fw.bin
-File: rtw88/rtw8822c_fw.bin
-File: rtw88/rtw8822c_wow_fw.bin
-File: rtw88/README
-File: rtw88/rtw8723d_fw.bin
-File: rtw88/rtw8821c_fw.bin
-
-Licence: Redistributable. See LICENCE.rtlwifi_firmware.txt for details.
-
- These firmware should be put under /lib/firmware/rtw88/
- And note that the rtw88 driver is able to support wake-on-wireless LAN
- for RTL8822C devices, after kernel v5.6+. So, make sure the firmware
- rtw88/rtw8822c_wow_fw.bin is also packed, otherwise the firmware load
- fail could be a problem.
- Although RTL8723D devices are 802.11n device, they are also supported
- by rtw88 because the hardware arch is similar.
diff --git a/sys/contrib/dev/rtw88fw/rtw8723d_fw.bin b/sys/contrib/dev/rtw88fw/rtw8723d_fw.bin
deleted file mode 100644
index ac2b9250c39e..000000000000
Binary files a/sys/contrib/dev/rtw88fw/rtw8723d_fw.bin and /dev/null differ
diff --git a/sys/contrib/dev/rtw88fw/rtw8821c_fw.bin b/sys/contrib/dev/rtw88fw/rtw8821c_fw.bin
deleted file mode 100644
index 8264e3480cc8..000000000000
Binary files a/sys/contrib/dev/rtw88fw/rtw8821c_fw.bin and /dev/null differ
diff --git a/sys/contrib/dev/rtw88fw/rtw8822b_fw.bin b/sys/contrib/dev/rtw88fw/rtw8822b_fw.bin
deleted file mode 100644
index 0934ffcc77a3..000000000000
Binary files a/sys/contrib/dev/rtw88fw/rtw8822b_fw.bin and /dev/null differ
diff --git a/sys/contrib/dev/rtw88fw/rtw8822c_fw.bin b/sys/contrib/dev/rtw88fw/rtw8822c_fw.bin
deleted file mode 100644
index af894bc10185..000000000000
Binary files a/sys/contrib/dev/rtw88fw/rtw8822c_fw.bin and /dev/null differ
diff --git a/sys/contrib/dev/rtw88fw/rtw8822c_wow_fw.bin b/sys/contrib/dev/rtw88fw/rtw8822c_wow_fw.bin
deleted file mode 100644
index 1ce74fda8bff..000000000000
Binary files a/sys/contrib/dev/rtw88fw/rtw8822c_wow_fw.bin and /dev/null differ
diff --git a/sys/contrib/dev/rtw89fw/LICENCE.rtlwifi_firmware.txt b/sys/contrib/dev/rtw89fw/LICENCE.rtlwifi_firmware.txt
deleted file mode 100644
index d70921f49379..000000000000
--- a/sys/contrib/dev/rtw89fw/LICENCE.rtlwifi_firmware.txt
+++ /dev/null
@@ -1,39 +0,0 @@
-Copyright (c) 2010, Realtek Semiconductor Corporation
-All rights reserved.
-
-Redistribution. Redistribution and use in binary form, without
-modification, are permitted provided that the following conditions are
-met:
-
-* Redistributions must reproduce the above copyright notice and the
- following disclaimer in the documentation and/or other materials
- provided with the distribution.
-* Neither the name of Realtek Semiconductor Corporation nor the names of its
- suppliers may be used to endorse or promote products derived from this
- software without specific prior written permission.
-* No reverse engineering, decompilation, or disassembly of this software
- is permitted.
-
-Limited patent license. Realtek Semiconductor Corporation grants a world-wide,
-royalty-free, non-exclusive license under patents it now or hereafter
-owns or controls to make, have made, use, import, offer to sell and
-sell ("Utilize") this software, but solely to the extent that any
-such patent is necessary to Utilize the software alone, or in
-combination with an operating system licensed under an approved Open
-Source license as listed by the Open Source Initiative at
-http://opensource.org/licenses. The patent license shall not apply to
-any other combinations which include this software. No hardware per
-se is licensed hereunder.
-
-DISCLAIMER. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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
-COPYRIGHT OWNER 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.
diff --git a/sys/contrib/dev/rtw89fw/WHENCE b/sys/contrib/dev/rtw89fw/WHENCE
deleted file mode 100644
index 496ef115ef0b..000000000000
--- a/sys/contrib/dev/rtw89fw/WHENCE
+++ /dev/null
@@ -1,8 +0,0 @@
-
-Driver: rtw89 - Realtek 802.11ax WLAN driver for RTL8852A
-
-File: rtw89/rtw8852a_fw.bin
-File: rtw89/rtw8852c_fw.bin
-
-Licence: Redistributable. See LICENCE.rtlwifi_firmware.txt for details.
-
diff --git a/sys/contrib/dev/rtw89fw/rtw8852a_fw.bin b/sys/contrib/dev/rtw89fw/rtw8852a_fw.bin
deleted file mode 100644
index 00d139b3f2f1..000000000000
Binary files a/sys/contrib/dev/rtw89fw/rtw8852a_fw.bin and /dev/null differ
diff --git a/sys/contrib/dev/rtw89fw/rtw8852c_fw.bin b/sys/contrib/dev/rtw89fw/rtw8852c_fw.bin
deleted file mode 100644
index 86b634aeb69f..000000000000
Binary files a/sys/contrib/dev/rtw89fw/rtw8852c_fw.bin and /dev/null differ