commit: df7daea6e021ab74a4ff7d0c662e428b5cf2b995 Author: Mike Pagano <mpagano <AT> gentoo <DOT> org> AuthorDate: Sat Jan 20 20:00:08 2024 +0000 Commit: Mike Pagano <mpagano <AT> gentoo <DOT> org> CommitDate: Sat Jan 20 20:01:25 2024 +0000 URL: https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=df7daea6
sys-kernel/linux-firmware: Modifications to USE=savedconfig Modified to only install files from the config file instead of deleting them afterwards. Bug: https://bugs.gentoo.org/913049 Signed-off-by: Mike Pagano <mpagano <AT> gentoo.org> .../files/linux-firmware-copy-firmware.patch | 59 +++ .../linux-firmware-20240115-r1.ebuild | 403 +++++++++++++++++++++ 2 files changed, 462 insertions(+) diff --git a/sys-kernel/linux-firmware/files/linux-firmware-copy-firmware.patch b/sys-kernel/linux-firmware/files/linux-firmware-copy-firmware.patch new file mode 100644 index 000000000000..b6ff69d1f577 --- /dev/null +++ b/sys-kernel/linux-firmware/files/linux-firmware-copy-firmware.patch @@ -0,0 +1,59 @@ +From 4eee756fa1e02c3e8ea168ac0efa16b30dae3b25 Mon Sep 17 00:00:00 2001 +From: Mike Pagano <mpag...@gentoo.org> +Date: Sat, 23 Dec 2023 13:14:58 -0500 +Subject: [PATCH] [PATCH] copy-firmware.sh: Support passing in firmware files + to install +Cc: mpag...@gentoo.org + +This change adds support to copy-firmware.sh to accept a space separated +list of firmware files to install. + +This allows our users to define a small subset of needed firmware files +their system requires without installing every firmware file included +from the repository. + +Signed-off-by: Mike Pagano <mpag...@gentoo.org> +--- + copy-firmware.sh | 12 ++++++++++++ + 1 file changed, 12 insertions(+) + +diff --git a/copy-firmware.sh b/copy-firmware.sh +index 6757c6ce..d954230d 100755 +--- a/copy-firmware.sh ++++ b/copy-firmware.sh +@@ -50,6 +50,16 @@ while test $# -gt 0; do + shift + ;; + ++ --firmware-list) ++ if [ -n "$2" ]; then ++ FIRMWARE_LIST=$2 ++ shift 2 ++ else ++ echo "ERROR: '--firmware-list' requires a non-empty option argument of firmware files to install" ++ exit 1 ++ fi ++ ;; ++ + -*) + if test "$compress" = "cat"; then + echo "ERROR: unknown command-line option: $1" +@@ -85,6 +95,7 @@ fi + # shellcheck disable=SC2162 # file/folder name can include escaped symbols + grep -E '^(RawFile|File):' WHENCE | sed -E -e 's/^(RawFile|File): */\1 /;s/"//g' | while read k f; do + test -f "$f" || continue ++ [ -n "${FIRMWARE_LIST##*"$f"*}" ] && continue + install -d "$destdir/$(dirname "$f")" + $verbose "copying/compressing file $f$compext" + if test "$compress" != "cat" && test "$k" = "RawFile"; then +@@ -107,6 +118,7 @@ fi + + # shellcheck disable=SC2162 # file/folder name can include escaped symbols + grep -E '^Link:' WHENCE | sed -e 's/^Link: *//g;s/-> //g' | while read f d; do ++ [ -n "${FIRMWARE_LIST##*"$f"*}" ] && continue + if test -L "$f$compext"; then + test -f "$destdir/$f$compext" && continue + $verbose "copying link $f$compext" +-- +2.41.0 + diff --git a/sys-kernel/linux-firmware/linux-firmware-20240115-r1.ebuild b/sys-kernel/linux-firmware/linux-firmware-20240115-r1.ebuild new file mode 100644 index 000000000000..25d02e4a4f38 --- /dev/null +++ b/sys-kernel/linux-firmware/linux-firmware-20240115-r1.ebuild @@ -0,0 +1,403 @@ +# Copyright 1999-2024 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +EAPI=8 +inherit linux-info mount-boot savedconfig multiprocessing + +# In case this is a real snapshot, fill in commit below. +# For normal, tagged releases, leave blank +MY_COMMIT="" + +if [[ ${PV} == 99999999* ]]; then + inherit git-r3 + EGIT_REPO_URI="https://git.kernel.org/pub/scm/linux/kernel/git/firmware/${PN}.git"; +else + if [[ -n "${MY_COMMIT}" ]]; then + SRC_URI="https://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/snapshot/${MY_COMMIT}.tar.gz -> ${P}.tar.gz" + S="${WORKDIR}/${MY_COMMIT}" + else + SRC_URI="https://mirrors.edge.kernel.org/pub/linux/kernel/firmware/${P}.tar.xz"; + fi + + KEYWORDS="~alpha ~amd64 ~arm ~arm64 ~hppa ~ia64 ~loong ~m68k ~mips ~ppc ~ppc64 ~riscv ~s390 ~sparc ~x86" +fi + +DESCRIPTION="Linux firmware files" +HOMEPAGE="https://git.kernel.org/?p=linux/kernel/git/firmware/linux-firmware.git"; + +LICENSE="GPL-2 GPL-2+ GPL-3 BSD MIT || ( MPL-1.1 GPL-2 ) + redistributable? ( linux-fw-redistributable BSD-2 BSD BSD-4 ISC MIT ) + unknown-license? ( all-rights-reserved )" +SLOT="0" +IUSE="compress-xz compress-zstd deduplicate initramfs +redistributable savedconfig unknown-license" +REQUIRED_USE="initramfs? ( redistributable ) + ?? ( compress-xz compress-zstd ) + savedconfig? ( !deduplicate )" + +RESTRICT="binchecks strip test + unknown-license? ( bindist )" + +BDEPEND="initramfs? ( app-arch/cpio ) + compress-xz? ( app-arch/xz-utils ) + compress-zstd? ( app-arch/zstd ) + deduplicate? ( app-misc/rdfind )" + +#add anything else that collides to this +RDEPEND="!savedconfig? ( + redistributable? ( + !sys-firmware/alsa-firmware[alsa_cards_ca0132] + !sys-block/qla-fc-firmware + !sys-firmware/iwl1000-ucode + !sys-firmware/iwl6005-ucode + !sys-firmware/iwl6030-ucode + !sys-firmware/iwl3160-ucode + !sys-firmware/iwl7260-ucode + !sys-firmware/iwl3160-7260-bt-ucode + !sys-firmware/raspberrypi-wifi-ucode + ) + unknown-license? ( + !sys-firmware/alsa-firmware[alsa_cards_korg1212] + !sys-firmware/alsa-firmware[alsa_cards_maestro3] + !sys-firmware/alsa-firmware[alsa_cards_sb16] + !sys-firmware/alsa-firmware[alsa_cards_ymfpci] + ) + )" + +QA_PREBUILT="*" +PATCHES=( "${FILESDIR}"/${PN}-copy-firmware.patch ) + +pkg_pretend() { + use initramfs && mount-boot_pkg_pretend +} + +pkg_setup() { + if use compress-xz || use compress-zstd ; then + local CONFIG_CHECK + + if kernel_is -ge 5 19; then + use compress-xz && CONFIG_CHECK="~FW_LOADER_COMPRESS_XZ" + use compress-zstd && CONFIG_CHECK="~FW_LOADER_COMPRESS_ZSTD" + else + use compress-xz && CONFIG_CHECK="~FW_LOADER_COMPRESS" + if use compress-zstd; then + eerror "Kernels <5.19 do not support ZSTD-compressed firmware files" + fi + fi + linux-info_pkg_setup + fi +} + +src_unpack() { + if [[ ${PV} == 99999999* ]]; then + git-r3_src_unpack + else + default + # rename directory from git snapshot tarball + if [[ ${#GIT_COMMIT} -gt 8 ]]; then + mv ${PN}-*/ ${P} || die + fi + fi +} + +src_prepare() { + + default + + find . -type f -not -perm 0644 -print0 \ + | xargs --null --no-run-if-empty chmod 0644 \ + || die + + chmod +x copy-firmware.sh || die + + if use initramfs; then + if [[ -d "${S}/amd-ucode" ]]; then + local UCODETMP="${T}/ucode_tmp" + local UCODEDIR="${UCODETMP}/kernel/x86/microcode" + mkdir -p "${UCODEDIR}" || die + echo 1 > "${UCODETMP}/early_cpio" + + local amd_ucode_file="${UCODEDIR}/AuthenticAMD.bin" + cat "${S}"/amd-ucode/*.bin > "${amd_ucode_file}" || die "Failed to concat amd cpu ucode" + + if [[ ! -s "${amd_ucode_file}" ]]; then + die "Sanity check failed: '${amd_ucode_file}' is empty!" + fi + + pushd "${UCODETMP}" &>/dev/null || die + find . -print0 | cpio --quiet --null -o -H newc -R 0:0 > "${S}"/amd-uc.img + popd &>/dev/null || die + if [[ ! -s "${S}/amd-uc.img" ]]; then + die "Failed to create '${S}/amd-uc.img'!" + fi + else + # If this will ever happen something has changed which + # must be reviewed + die "'${S}/amd-ucode' not found!" + fi + fi + + # whitelist of misc files + local misc_files=( + copy-firmware.sh + WHENCE + README + ) + + # whitelist of images with a free software license + local free_software=( + # keyspan_pda (GPL-2+) + keyspan_pda/keyspan_pda.fw + keyspan_pda/xircom_pgs.fw + # dsp56k (GPL-2+) + dsp56k/bootstrap.bin + # ath9k_htc (BSD GPL-2+ MIT) + ath9k_htc/htc_7010-1.4.0.fw + ath9k_htc/htc_9271-1.4.0.fw + # pcnet_cs, 3c589_cs, 3c574_cs, serial_cs (dual GPL-2/MPL-1.1) + cis/LA-PCM.cis + cis/PCMLM28.cis + cis/DP83903.cis + cis/NE2K.cis + cis/tamarack.cis + cis/PE-200.cis + cis/PE520.cis + cis/3CXEM556.cis + cis/3CCFEM556.cis + cis/MT5634ZLX.cis + cis/RS-COM-2P.cis + cis/COMpad2.cis + cis/COMpad4.cis + # serial_cs (GPL-3) + cis/SW_555_SER.cis + cis/SW_7xx_SER.cis + cis/SW_8xx_SER.cis + # dvb-ttpci (GPL-2+) + av7110/bootcode.bin + # usbdux, usbduxfast, usbduxsigma (GPL-2+) + usbdux_firmware.bin + usbduxfast_firmware.bin + usbduxsigma_firmware.bin + # brcmfmac (GPL-2+) + brcm/brcmfmac4330-sdio.Prowise-PT301.txt + brcm/brcmfmac43340-sdio.meegopad-t08.txt + brcm/brcmfmac43362-sdio.cubietech,cubietruck.txt + brcm/brcmfmac43362-sdio.lemaker,bananapro.txt + brcm/brcmfmac43430a0-sdio.jumper-ezpad-mini3.txt + "brcm/brcmfmac43430a0-sdio.ONDA-V80 PLUS.txt" + brcm/brcmfmac43430-sdio.AP6212.txt + brcm/brcmfmac43430-sdio.Hampoo-D2D3_Vi8A1.txt + brcm/brcmfmac43430-sdio.MUR1DX.txt + brcm/brcmfmac43430-sdio.raspberrypi,3-model-b.txt + brcm/brcmfmac43455-sdio.raspberrypi,3-model-b-plus.txt + brcm/brcmfmac4356-pcie.gpd-win-pocket.txt + # isci (GPL-2) + isci/isci_firmware.bin + # carl9170 (GPL-2+) + carl9170-1.fw + # atusb (GPL-2+) + atusb/atusb-0.2.dfu + atusb/atusb-0.3.dfu + atusb/rzusb-0.3.bin + # mlxsw_spectrum (dual BSD/GPL-2) + mellanox/mlxsw_spectrum-13.1420.122.mfa2 + mellanox/mlxsw_spectrum-13.1530.152.mfa2 + mellanox/mlxsw_spectrum-13.1620.192.mfa2 + mellanox/mlxsw_spectrum-13.1702.6.mfa2 + mellanox/mlxsw_spectrum-13.1703.4.mfa2 + mellanox/mlxsw_spectrum-13.1910.622.mfa2 + mellanox/mlxsw_spectrum-13.2000.1122.mfa2 + ) + + # blacklist of images with unknown license + local unknown_license=( + korg/k1212.dsp + ess/maestro3_assp_kernel.fw + ess/maestro3_assp_minisrc.fw + yamaha/ds1_ctrl.fw + yamaha/ds1_dsp.fw + yamaha/ds1e_ctrl.fw + ttusb-budget/dspbootcode.bin + emi62/bitstream.fw + emi62/loader.fw + emi62/midi.fw + emi62/spdif.fw + ti_3410.fw + ti_5052.fw + mts_mt9234mu.fw + mts_mt9234zba.fw + whiteheat.fw + whiteheat_loader.fw + cpia2/stv0672_vp4.bin + vicam/firmware.fw + edgeport/boot.fw + edgeport/boot2.fw + edgeport/down.fw + edgeport/down2.fw + edgeport/down3.bin + sb16/mulaw_main.csp + sb16/alaw_main.csp + sb16/ima_adpcm_init.csp + sb16/ima_adpcm_playback.csp + sb16/ima_adpcm_capture.csp + sun/cassini.bin + acenic/tg1.bin + acenic/tg2.bin + adaptec/starfire_rx.bin + adaptec/starfire_tx.bin + yam/1200.bin + yam/9600.bin + ositech/Xilinx7OD.bin + qlogic/isp1000.bin + myricom/lanai.bin + yamaha/yss225_registers.bin + lgs8g75.fw + ) + + if use !unknown-license; then + einfo "Removing files with unknown license ..." + rm -v "${unknown_license[@]}" || die + fi + + if use !redistributable; then + # remove files _not_ in the free_software or unknown_license lists + # everything else is confirmed (or assumed) to be redistributable + # based on upstream acceptance policy + einfo "Removing non-redistributable files ..." + local OLDIFS="${IFS}" + local IFS=$'\n' + set -o pipefail + find ! -type d -printf "%P\n" \ + | grep -Fvx -e "${misc_files[*]}" -e "${free_software[*]}" -e "${unknown_license[*]}" \ + | xargs -d '\n' --no-run-if-empty rm -v + + [[ ${?} -ne 0 ]] && die "Failed to remove non-redistributable files" + + IFS="${OLDIFS}" + fi + + restore_config ${PN}.conf +} + +src_install() { + + local LINUX_FIRMWARE_SAVED_CONFIG_FILES= + local FW_OPTIONS=( "-v" ) + + if use savedconfig; then + if [[ -s "${S}/${PN}.conf" ]]; then + files_to_keep="${T}/files_to_keep.lst" + grep -v '^#' "${S}/${PN}.conf" 2>/dev/null > "${files_to_keep}" || die + [[ -s "${files_to_keep}" ]] || die "grep failed, empty config file?" + LINUX_FIRMWARE_SAVED_CONFIG_FILES=$(<${files_to_keep}) + LINUX_FIRMWARE_SAVED_CONFIG_FILES="${LINUX_FIRMWARE_SAVED_CONFIG_FILES//$'\n'/ }" + FW_OPTIONS+=( "--firmware-list" "${LINUX_FIRMWARE_SAVED_CONFIG_FILES[@]}" ) + fi + fi + + ! use deduplicate && FW_OPTIONS+=( "--ignore-duplicates" ) + FW_OPTIONS+=( "${ED}/lib/firmware" ) + ./copy-firmware.sh "${FW_OPTIONS[@]}" + + echo "calling copy-firmwaare.sh ${FW_OPTIONS[@]}" + + pushd "${ED}/lib/firmware" &>/dev/null || die + + # especially use !redistributable will cause some broken symlinks + einfo "Removing broken symlinks ..." + find * -xtype l -print -delete || die + + # remove empty directories, bug #396073 + find -type d -empty -delete || die + + # sanity check + if ! ( shopt -s failglob; : * ) 2>/dev/null; then + eerror "No files to install. Check your USE flag settings" + eerror "and the list of files in your saved configuration." + die "Refusing to install an empty package" + fi + + # create config file + echo "# Remove files that shall not be installed from this list." > "${S}"/${PN}.conf || die + find * ! -type d >> "${S}"/${PN}.conf || die + save_config "${S}"/${PN}.conf + + if use compress-xz || use compress-zstd; then + einfo "Compressing firmware ..." + local target + local ext + local compressor + + if use compress-xz; then + ext=xz + compressor="xz -T1 -C crc32" + elif use compress-zstd; then + ext=zst + compressor="zstd -15 -T1 -C -q --rm" + fi + + # rename symlinks + while IFS= read -r -d '' f; do + # skip symlinks pointing to directories + [[ -d ${f} ]] && continue + + target=$(readlink "${f}") + [[ $? -eq 0 ]] || die + ln -sf "${target}".${ext} "${f}" || die + mv -T "${f}" "${f}".${ext} || die + done < <(find . -type l -print0) || die + + find . -type f ! -path "./amd-ucode/*" -print0 | \ + xargs -0 -P $(makeopts_jobs) -I'{}' ${compressor} '{}' || die + + fi + + popd &>/dev/null || die + + if use initramfs ; then + insinto /boot + doins "${S}"/amd-uc.img + fi +} + +pkg_preinst() { + if use savedconfig; then + ewarn "USE=savedconfig is active. You must handle file collisions manually." + fi + + # Fix 'symlink is blocked by a directory' Bug #871315 + if has_version "<${CATEGORY}/${PN}-20220913-r2" ; then + rm -rf "${EROOT}"/lib/firmware/qcom/LENOVO/21BX + fi + + # Make sure /boot is available if needed. + use initramfs && mount-boot_pkg_preinst +} + +pkg_postinst() { + elog "If you are only interested in particular firmware files, edit the saved" + elog "configfile and remove those that you do not want." + + local ver + for ver in ${REPLACING_VERSIONS}; do + if ver_test ${ver} -lt 20190514; then + elog + elog 'Starting with version 20190514, installation of many firmware' + elog 'files is controlled by USE flags. Please review your USE flag' + elog 'and package.license settings if you are missing some files.' + break + fi + done + + # Don't forget to umount /boot if it was previously mounted by us. + use initramfs && mount-boot_pkg_postinst +} + +pkg_prerm() { + # Make sure /boot is mounted so that we can remove /boot/amd-uc.img! + use initramfs && mount-boot_pkg_prerm +} + +pkg_postrm() { + # Don't forget to umount /boot if it was previously mounted by us. + use initramfs && mount-boot_pkg_postrm +}
