dracut: Add firmware loading module

This implements the logic for loading Apple firmware on Asahi systems
using Dracut as the initramfs system.

Signed-off-by: Neal Gompa <[email protected]>

Author: Conan-Kudo

Makefile

@@ -6,6 +6,7 @@ ARCH_SCRIPTS=update-grub first-boot
 UNITS=first-boot.service
 MULTI_USER_WANTS=first-boot.service
 DRACUT_CONF_DIR=$(PREFIX)/lib/dracut/dracut.conf.d
+DRACUT_MODULES_DIR=$(PREFIX)/lib/dracut/modules.d
 BUILD_SCRIPTS=$(addprefix build/,$(SCRIPTS))
 BUILD_ARCH_SCRIPTS=$(addprefix build/,$(ARCH_SCRIPTS))
 
@@ -26,6 +27,7 @@ install: all
 	install -m0644 -t $(DESTDIR)/etc etc/m1n1.conf
 	install -dD $(DESTDIR)$(PREFIX)/share/asahi-scripts
 	install -m0644 -t $(DESTDIR)$(PREFIX)/share/asahi-scripts functions.sh
+	install -dD $(DESTDIR)/lib/firmware/vendor
 
 install-mkinitcpio: install
 	install -dD $(DESTDIR)$(PREFIX)/lib/initcpio/install
@@ -35,7 +37,11 @@ install-mkinitcpio: install
 
 install-dracut: install
 	install -dD $(DESTDIR)$(DRACUT_CONF_DIR)
-	install -m0644 -t $(DESTDIR)$(DRACUT_CONF_DIR) dracut/10-asahi.conf
+	install -m0644 -t $(DESTDIR)$(DRACUT_CONF_DIR) dracut/dracut.conf.d/10-asahi.conf
+	install -dD $(DESTDIR)$(DRACUT_MODULES_DIR)/99asahi-firmware
+	install -m0755 -t $(DESTDIR)$(DRACUT_MODULES_DIR)/99asahi-firmware dracut/modules.d/99asahi-firmware/install-asahi-firmware.sh
+	install -m0755 -t $(DESTDIR)$(DRACUT_MODULES_DIR)/99asahi-firmware dracut/modules.d/99asahi-firmware/load-asahi-firmware.sh
+	install -m0755 -t $(DESTDIR)$(DRACUT_MODULES_DIR)/99asahi-firmware dracut/modules.d/99asahi-firmware/module-setup.sh
 
 install-arch: install install-mkinitcpio
 	install -m0755 -t $(DESTDIR)$(BIN_DIR)/ $(BUILD_ARCH_SCRIPTS)

dracut/10-asahi.conf dracut/dracut.conf.d/10-asahi.confdracut/10-asahi.conf renamed to dracut/dracut.conf.d/10-asahi.conf

@@ -23,3 +23,6 @@ add_drivers+=" rtc-macsmc simple-mfd-spmi spmi-apple-controller nvmem_spmi_mfd "
 
 # For MTP HID
 add_drivers+=" apple-dockchannel dockchannel-hid apple-rtkit-helper "
+
+# For Apple firmware
+add_dracutmodules+=" asahi-firmware "

dracut/modules.d/99asahi-firmware/install-asahi-firmware.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+# SPDX-License-Identifier: MIT
+
+type getarg > /dev/null 2>&1 || . /lib/dracut-lib.sh
+
+info ":: Asahi: Installing vendor firmware to root filesystem..."
+if [ ! -d /sysroot/lib/firmware/vendor ]; then
+    warn ":: Asahi: Vendor firmware directory missing on the root filesystem!"
+    return 1
+fi
+mount -t tmpfs vendorfw /sysroot/lib/firmware/vendor
+cp -pr /vendorfw/* /vendorfw/.vendorfw.manifest /sysroot/lib/firmware/vendor

dracut/modules.d/99asahi-firmware/load-asahi-firmware.sh

@@ -0,0 +1,47 @@
+#!/bin/sh
+# SPDX-License-Identifier: MIT
+
+type getarg > /dev/null 2>&1 || . /lib/dracut-lib.sh
+
+if [ -e /vendorfw ]; then
+    info ":: Asahi: Vendor firmware was loaded by the bootloader"
+    return 0
+fi
+
+if [ ! -e /proc/device-tree/chosen/asahi,efi-system-partition ]; then
+    info ":: Asahi: Missing asahi,efi-system-partition variable, firmware will not be loaded!"
+    return 0
+fi
+
+info ":: Asahi: Triggering early load of NVMe modules..."
+modprobe apple-mailbox
+modprobe nvme-apple
+
+for i in $(seq 0 50); do
+    [ -e /sys/bus/platform/drivers/nvme-apple/*.nvme/nvme/nvme*/nvme*n1/ ] && break
+    sleep 0.1
+done
+
+if [ ! -e /sys/bus/platform/drivers/nvme-apple/*.nvme/nvme/nvme*/nvme*n1/ ]; then
+    warn ":: Asahi: Timed out waiting for NVMe device"
+    return 1
+fi
+
+# If the above exists, hopefully the /dev device exists and this will work
+info ":: Asahi: Unpacking vendor firmware into initramfs..."
+
+VENDORFW="/run/.system-efi/vendorfw/"
+
+(
+    . /usr/share/asahi-scripts/functions.sh
+    mount_sys_esp /run/.system-efi
+)
+
+if [ ! -e "$VENDORFW/firmware.cpio" ]; then
+    warn ":: Asahi: Vendor firmware not found in ESP."
+    umount /run/.system-efi
+    return 1
+fi
+
+( cd /; cpio -i < "$VENDORFW/firmware.cpio" )
+info ":: Asahi firmware unpacked successfully"

dracut/modules.d/99asahi-firmware/module-setup.sh

@@ -0,0 +1,36 @@
+#!/bin/sh
+# SPDX-License-Identifier: MIT
+
+# called by dracut
+check() {
+    if [ -n "$hostonly" ] && [ ! -e /proc/device-tree/chosen/asahi,efi-system-partition ]; then
+       return 0
+    elif [ -z "$hostonly" ]; then
+        return 0
+    else
+       return 255
+    fi
+}
+
+# called by dracut
+depends() {
+    echo fs-lib
+    return 0
+}
+
+# called by dracut
+installkernel() {
+    instmods apple-mailbox nvme-apple
+}
+
+# called by dracut
+install() {
+    inst_dir "/lib/firmware"
+    ln_r "/lib/firmware/vendor" "/vendorfw"
+    asahiscriptsdir="/usr/share/asahi-scripts"
+    inst_dir $asahiscriptsdir
+    $DRACUT_CP -R -L -t "${initdir}/${asahiscriptsdir}" "${dracutsysrootdir}${asahiscriptsdir}"/*
+    inst_multiple cpio cut dirname modprobe mount seq sleep umount
+    inst_hook pre-udev 10 "${moddir}/load-asahi-firmware.sh"
+    inst_hook cleanup 99 "${moddir}/install-asahi-firmware.sh"
+}