debianito-post-install/modules/firmware.sh

#!/usr/bin/env bash

# ── Global arrays ──
PCI_NET_DEVS=()
USB_WIFI_DEVS=()
PCI_BT_DEVS=()
USB_BT_DEVS=()
_DETECTED_FW_PKGS=()
_FW_PLAN_HW_LINES=()
_FW_PLAN_PKG_LINES=()

# ── Network device detection (PCI + USB) ──
_detect_all_network_devices() {
    ! is_installed pciutils && _run_install_pkg pciutils
    ! is_installed usbutils && _run_install_pkg usbutils

    PCI_NET_DEVS=()
    while IFS= read -r line; do
        PCI_NET_DEVS+=("$line")
    done < <(lspci -nn 2>/dev/null | grep -iE 'network controller|ethernet controller' || true)

    USB_WIFI_DEVS=()
    while IFS= read -r line; do
        if echo "$line" | grep -qiE 'wireless|wifi|802\.11|bluetooth|wlan'; then
            USB_WIFI_DEVS+=("$line")
        fi
    done < <(lsusb 2>/dev/null || true)

    PCI_BT_DEVS=()
    while IFS= read -r line; do
        PCI_BT_DEVS+=("$line")
    done < <(lspci -nn 2>/dev/null | grep -i 'Bluetooth controller' || true)

    USB_BT_DEVS=()
    while IFS= read -r line; do
        if echo "$line" | grep -qi 'bluetooth'; then
            if ! echo "$line" | grep -qiE 'wireless|wifi|802\.11|wlan'; then
                USB_BT_DEVS+=("$line")
            fi
        fi
    done < <(lsusb 2>/dev/null || true)

    _FW_PLAN_HW_LINES=()
    for dev in "${PCI_NET_DEVS[@]}"; do
        local desc dev_type
        desc=$(echo "$dev" | sed -E 's/^[^ ]+ [^:]+: //; s/ \[[0-9a-fA-F]{4}:[0-9a-fA-F]{4}\]//; s/ \(rev.*\)//')
        if echo "$dev" | grep -qiE 'network controller|wireless|wi-fi|wlan|802\.11'; then
            dev_type="WiFi PCI"
        else
            dev_type="Ethernet PCI"
        fi
        _FW_PLAN_HW_LINES+=("  \xe2\x97\x8f ${desc} (${dev_type})")
    done
    for dev in "${USB_WIFI_DEVS[@]}"; do
        local desc
        desc=$(echo "$dev" | sed 's/^.*ID //')
        _FW_PLAN_HW_LINES+=("  \xe2\x97\x8f ${desc} (USB)")
    done

    for dev in "${PCI_BT_DEVS[@]}"; do
        local desc
        desc=$(echo "$dev" | sed -E 's/^[^ ]+ [^:]+: //; s/ \[[0-9a-fA-F]{4}:[0-9a-fA-F]{4}\]//; s/ \(rev.*\)//')
        _FW_PLAN_HW_LINES+=("  \xe2\x97\x8f ${desc} (Bluetooth PCI)")
    done
    for dev in "${USB_BT_DEVS[@]}"; do
        local desc
        desc=$(echo "$dev" | sed 's/^.*ID //')
        _FW_PLAN_HW_LINES+=("  \xe2\x97\x8f ${desc} (Bluetooth USB)")
    done
}

# ── Firmware package mapping ──
_detect_firmware_needs() {
    local -A pkg_info
    _DETECTED_FW_PKGS=()
    _FW_PLAN_PKG_LINES=()

    local dev_list
    dev_list=("${PCI_NET_DEVS[@]}" "${USB_WIFI_DEVS[@]}")

    for dev in "${dev_list[@]}"; do
        local raw_desc vendor_lc pkg
        raw_desc=$(echo "$dev" | sed -E 's/^[^ ]+ [^:]+: //; s/ \[[0-9a-fA-F]{4}:[0-9a-fA-F]{4}\]//; s/ \(rev.*\)//')
        vendor_lc=$(echo "$dev" | sed -n 's/^.*]: //p' | awk '{print $1}' | tr '[:upper:]' '[:lower:]')

        [[ "$vendor_lc" != *intel* && "$vendor_lc" != *realtek* && "$vendor_lc" != *atheros* && "$vendor_lc" != *qualcomm* && "$vendor_lc" != *mediatek* ]] && continue

        case "$vendor_lc" in
            *intel*)
                if echo "$dev" | grep -qiE 'wireless|wi-fi|wlan|802\.11'; then
                    pkg="firmware-iwlwifi"
                else
                    pkg="firmware-intel-misc"
                fi
                ;;
            *realtek*)       pkg="firmware-realtek" ;;
            *atheros*|*qualcomm*) pkg="firmware-atheros" ;;
            *mediatek*)      pkg="firmware-mediatek" ;;
        esac

        local short_dev
        short_dev=$(echo "$raw_desc" | sed 's/ *\[[^]]*\]//g; s/  */ /g')
        if [ -z "${pkg_info[$pkg]-}" ]; then
            pkg_info[$pkg]="$short_dev"
        else
            pkg_info[$pkg]+=", $short_dev"
        fi
    done

    for pkg in "${!pkg_info[@]}"; do
        _DETECTED_FW_PKGS+=("$pkg")
        _FW_PLAN_PKG_LINES+=("  [+] ${pkg}  \xe2\x86\x90 ${pkg_info[$pkg]}")
    done

    mapfile -t _DETECTED_FW_PKGS < <(printf '%s\n' "${_DETECTED_FW_PKGS[@]}" | sort -u)
}

# ── Broadcom chip classification helpers ──
_is_broadcom_brcm() {
    local id="$1"
    for supported in 4357 4358 4360 4727 43a0 43a1 43a2 43b1; do
        [ "$id" = "$supported" ] && return 0
    done
    return 1
}

_is_broadcom_b43() {
    local id="$1"
    _is_broadcom_brcm "$id" && return 1
    local dec=$((16#$id))
    if [ "$dec" -ge $((16#4301)) ] && [ "$dec" -le $((16#4331)) ]; then return 0; fi
    if [ "$dec" -ge $((16#4336)) ] && [ "$dec" -le $((16#4338)) ]; then return 0; fi
    case "$id" in 4352) return 0 ;; esac
    return 1
}

_is_broadcom_b43legacy() {
    [ "$1" = "4302" ] || [ "$1" = "4306" ]
}

# ── Build plan string ──
_build_firmware_plan() {
    local plan=""
    plan+="This section installs the essential non-free firmware stack\n"
    plan+="for Debian (including CPU microcode, GPU, network, and core\n"
    plan+="drivers). The script has scanned your hardware to prepare\n"
    plan+="the setup:\n\n"

    plan+="Detected controllers:\n"
    if [ ${#_FW_PLAN_HW_LINES[@]} -eq 0 ]; then
        plan+="  (none detected)\n"
    else
        for line in "${_FW_PLAN_HW_LINES[@]}"; do
            plan+="${line}\n"
        done
    fi

    plan+="\nPlanned firmware packages:\n"
    local fw_line
    if is_installed firmware-linux-nonfree; then
        local cur_ver
        cur_ver=$(dpkg -l firmware-linux-nonfree 2>/dev/null | awk '/^ii/{print $3}')
        fw_line="  [+] firmware-linux-nonfree ${cur_ver} (already installed)"
    else
        fw_line="  [+] firmware-linux-nonfree (base meta-package)"
    fi
    plan+="${fw_line}\n"

    for line in "${_FW_PLAN_PKG_LINES[@]}"; do
        plan+="${line}\n"
    done

    local has_bt=false
    [ ${#PCI_BT_DEVS[@]} -gt 0 ] && has_bt=true
    [ ${#USB_BT_DEVS[@]} -gt 0 ] && has_bt=true
    if ! $has_bt; then
        for dev in "${USB_WIFI_DEVS[@]}"; do
            if echo "$dev" | grep -qi 'bluetooth'; then
                has_bt=true; break
            fi
        done
    fi

    plan+="\nBluetooth:\n"
    if $has_bt; then
        if is_installed bluez; then
            plan+="  [+] bluez (already installed)\n"
        else
            plan+="  [+] bluez + bluez-tools + bluez-obexd (base stack)\n"
        fi
        case "${DESKTOP_ENV:-other}" in
            kde)   plan+="  [+] bluedevil (KDE applet)\n"
                   if [ "${AUDIO_SERVER:-}" = "pipewire" ]; then
                       plan+="  → pipewire-pulse + wireplumber (if missing)\n"
                   fi
                   ;;
            gnome) plan+="  (already in gnome-control-center)\n" ;;
            *)     plan+="  [+] blueman (GTK Bluetooth manager)\n" ;;
        esac
        plan+="  → Bluetooth service will be enabled\n"
    else
        plan+="  (no Bluetooth hardware detected)\n"
    fi

    plan+="\nInstallation order:\n"
    plan+="  1. Base firmware (firmware-linux-nonfree)\n"
    plan+="  2. Network firmware (realtek, iwlwifi, ...)\n"
    plan+="  3. Broadcom / Bluetooth firmware\n"

    echo -e "$plan"
}

# ── Install detected firmware packages ──
_install_detected_firmware() {
    local to_install=()
    for pkg in "${_DETECTED_FW_PKGS[@]}"; do
        if is_installed "$pkg"; then
            echo "  --> $pkg already installed."
            continue
        fi
        local ver
        ver=$(apt-cache policy "$pkg" 2>/dev/null | awk 'NR==3 {print $2; exit}')
        if [ -z "$ver" ] || [ "$ver" = "(none)" ]; then
            echo "  --> $pkg not available in repositories, skipping."
            continue
        fi
        to_install+=("$pkg")
    done
    if [ ${#to_install[@]} -gt 0 ]; then
        _run_cmd "Firmware" "sudo DEBIAN_FRONTEND=noninteractive apt install -y ${to_install[*]}" \
            "Installing network firmware packages..."
    fi
}

# ── Wireless handler (Broadcom 3-tier) ──
_handle_wireless() {
    local installed_any=false
    if [ ${#PCI_NET_DEVS[@]} -eq 0 ] && [ ${#USB_WIFI_DEVS[@]} -eq 0 ]; then
        _detect_all_network_devices
    fi

    for dev in "${PCI_NET_DEVS[@]}"; do
        local bcm_id
        bcm_id=$(echo "$dev" | grep -oP '14e4:[0-9a-fA-F]+' || true)
        [ -z "$bcm_id" ] && continue
        local dev_id
        dev_id=$(echo "$bcm_id" | cut -d: -f2 | tr '[:upper:]' '[:lower:]')

        if _is_broadcom_brcm "$dev_id"; then
            if ! is_installed "firmware-brcm80211"; then
                _run_cmd "Broadcom" "sudo DEBIAN_FRONTEND=noninteractive apt install -y firmware-brcm80211" \
                    "Installing firmware-brcm80211..."
            else
                echo "  --> firmware-brcm80211 already installed."
            fi
            installed_any=true
        elif _is_broadcom_b43 "$dev_id"; then
            if ! dpkg -l firmware-b43-installer >/dev/null 2>&1; then
                _run_install_pkg firmware-b43-installer
            fi

            if [ ! -d /lib/firmware/b43 ] || [ -z "$(ls -A /lib/firmware/b43 2>/dev/null)" ]; then
                _msg "b43 Firmware Warning" \
                    "The firmware-b43-installer package was installed, but the\n\
proprietary firmware download appears to have failed\n\
(no files found in /lib/firmware/b43).\n\n\
To fix this, connect a wired network and run:\n\
  sudo dpkg-reconfigure firmware-b43-installer\n\n\
After the firmware is downloaded, reboot the system." 14 75
                _pause
            else
                installed_any=true
            fi
        elif _is_broadcom_b43legacy "$dev_id"; then
            _run_install_pkg firmware-b43legacy-installer
            installed_any=true
        else
            local bcm_ver header_ver
            bcm_ver=$(apt-cache policy broadcom-sta-dkms 2>/dev/null | awk 'NR==3 {print $2; exit}')
            header_ver=$(apt-cache policy linux-headers-$(uname -r) 2>/dev/null | awk 'NR==3 {print $2; exit}')

            if ! apt-cache policy "linux-headers-$(uname -r)" 2>/dev/null | grep -q "Candidate: [^ (none)]"; then
                _msg "Broadcom Error" \
                    "linux-headers-$(uname -r) not available.\n\nCannot compile broadcom-sta-dkms without kernel headers." 10 60
                _pause
                continue
            fi

            if _confirm "Broadcom WiFi" "Install Broadcom driver?\n\nRequired for this chipset. Compiles a kernel module.\n\n  broadcom-sta-dkms          ${bcm_ver:-unknown}\n  linux-headers-$(uname -r)  ${header_ver:-unknown}\n\nProceed?"; then
                _run_cmd "Broadcom" "sudo DEBIAN_FRONTEND=noninteractive apt install -y linux-headers-$(uname -r) broadcom-sta-dkms" \
                    "Installing Broadcom driver..."

                local has_broadcom_bt=false
                for btdev in "${PCI_BT_DEVS[@]}"; do
                    if echo "$btdev" | grep -qi 'broadcom'; then
                        has_broadcom_bt=true
                        break
                    fi
                done
                if $has_broadcom_bt; then
                    echo -e "${YELLOW}Broadcom combo card (WiFi + Bluetooth) detected.${NC}"
                    cat > /etc/modprobe.d/broadcom-combo.conf <<'EOF'
# Broadcom combo: ensure btusb loads after wl
softdep wl post: btusb
EOF
                    echo -e "${YELLOW}A reboot may be required for Bluetooth to work correctly.${NC}"
                fi

                echo "Broadcom proprietary driver installed. A reboot may be required."
                _pause
                installed_any=true
            fi
        fi
    done

    for dev in "${USB_WIFI_DEVS[@]}"; do
        if echo "$dev" | grep -qi '0a5c'; then
            _msg "USB Broadcom" "USB Broadcom adapter detected:\n\n  ${dev}\n\nIf the adapter is not recognized after base firmware\ninstallation, ndiswrapper may be needed as a last\nresort.\n\nNote: Linux 5.15+ has improved support for many\nUSB Broadcom adapters." 12 65
        fi
    done

    if ! $installed_any; then
        echo "No special WiFi firmware needed -- base firmware-linux-nonfree covers this system."
        _pause
    fi
}

# ── Ensure non-free repository is enabled ──
_ensure_nonfree_repo() {
    local nonfree_found=false
    if [ -f /etc/apt/sources.list ] && grep -Eq '^[^#]*\bnon-free\b' /etc/apt/sources.list 2>/dev/null; then
        nonfree_found=true
    fi
    if ! $nonfree_found && [ -d /etc/apt/sources.list.d ]; then
        if grep -qr 'Components:.*\bnon-free\b' /etc/apt/sources.list.d/*.sources 2>/dev/null; then
            nonfree_found=true
        fi
    fi
    if $nonfree_found; then
        return 0
    fi

    if _confirm "non-free Repository" "Component 'non-free' (and 'non-free-firmware') is required for WiFi/Bluetooth/GPU firmware.\n\nAdd them to your APT repositories?"; then
        if [ -f /etc/apt/sources.list ]; then
            sudo sed -i '/^deb / { /non-free/! s/\(main[^ ]*\)/\1 non-free non-free-firmware/ }' /etc/apt/sources.list
        fi
        if [ -d /etc/apt/sources.list.d ]; then
            for f in /etc/apt/sources.list.d/*.sources; do
                [ -f "$f" ] || continue
                sudo sed -i '/^Components:/ { /non-free/! s/$/ non-free non-free-firmware/ }' "$f"
            done
        fi
        sudo apt update
        echo -e "${GREEN}non-free repository enabled.${NC}"
        return 0
    fi
    return 1
}

# ── Main entry point ──
install_firmware() {
    echo -e "${YELLOW}Base firmware check...${NC}"

    if ! _ensure_nonfree_repo; then
        _msg "Error" "No 'non-free' repositories were enabled and the user declined to add them.\nPlease enable non-free manually or accept the prompt in the Firmware option." 10 65
        return 1
    fi

    # 1. Detect
    _detect_all_network_devices
    _detect_firmware_needs

    # 2. Plan
    local plan
    plan=$(_build_firmware_plan)
    _msg "Firmware, Wireless & Bluetooth Setup" "$plan" 22 72

    # 3. Confirm
    if ! _confirm "Firmware" "Apply the network & firmware plan?"; then
        echo "Firmware installation skipped."
        return
    fi

    # 4. Install base firmware meta-package (unchanged logic)
    local fw_pkg="firmware-linux-nonfree"
    local fw_bpo
    fw_bpo=$(apt-cache madison "$fw_pkg" 2>/dev/null | \
        grep "${DEBIAN_CODENAME}-backports" | awk '{print $3}' | head -1)

    local fw_stable
    fw_stable=$(apt-cache policy "$fw_pkg" 2>/dev/null | awk 'NR==3 {print $2; exit}')

    if is_installed "$fw_pkg"; then
        if [ -n "$fw_bpo" ]; then
            local current_ver
            current_ver=$(dpkg -l "$fw_pkg" 2>/dev/null | awk '/^ii/{print $3}')
            if _confirm "Firmware" "firmware-linux-nonfree ${current_ver} already installed.\n\nUpgrade to backports version ${fw_bpo}?\n\nBackports often includes newer hardware support."; then
                _run_cmd "Firmware" "sudo apt install -y -t ${DEBIAN_CODENAME}-backports $fw_pkg" "Upgrading firmware..."
            fi
        else
            echo "$fw_pkg already installed."
        fi
    else
        local msg="firmware-linux-nonfree provides hardware drivers for:\n"
        msg+="  WiFi, Bluetooth, GPU, audio, webcams, and more.\n\n"
        if [ -n "$fw_bpo" ]; then
            msg+="  ● Stable:        ${fw_stable}\n"
            msg+="                     Ultra tested, but may lack support for\n"
            msg+="                     very recent hardware.\n\n"
            msg+="  ● Backports:     ${fw_bpo} (Recommended)\n"
            msg+="                     Updated firmware for modern hardware from\n"
            msg+="                     2025/2026: recent GPUs, processors, WiFi.\n\n"
            msg+="Choose version:"
            if _confirm_custom "Firmware" "$msg" "Backports" "Stable"; then
                _run_cmd "Firmware" "sudo apt install -y -t ${DEBIAN_CODENAME}-backports $fw_pkg" "Installing firmware from backports..."
            else
                _run_cmd "Firmware" "sudo apt install -y $fw_pkg" "Installing firmware from stable..."
            fi
        else
            msg+="  Version: ${fw_stable}\n\n"
            msg+="Install it?"
            if _confirm "Firmware" "$msg"; then
                _run_cmd "Firmware" "sudo apt install -y $fw_pkg" "Installing firmware..."
            fi
        fi
        echo -e "${GREEN}Base firmware installed.${NC}"
    fi

    # 5. Install specific network firmware packages
    _install_detected_firmware

    # 6. Broadcom wireless handler
    _handle_wireless

    # 7. Bluetooth stack
    _install_bluetooth_stack

    # 8. Summary
    echo -e "${GREEN}Network & firmware setup complete.${NC}"
    _pause
}