Install fprintd-tod with support for Broadcom readers on Debian testing

setup.sh

#!/usr/bin/env sh

####################################################################
###  ____  _____ ____ ___    _    _   _    ___  _   _ _  __   __ ###
### |  _ \| ____| __ )_ _|  / \  | \ | |  / _ \| \ | | | \ \ / / ###
### | | | |  _| |  _ \| |  / _ \ |  \| | | | | |  \| | |  \ V /  ###
### | |_| | |___| |_) | | / ___ \| |\  | | |_| | |\  | |___| |   ###
### |____/|_____|____/___/_/   \_\_| \_|  \___/|_| \_|_____|_|   ###
####################################################################
#######  _   _  ___    _   _ ____  _   _ _   _ _____ _   _  ########
####### | \ | |/ _ \  | | | | __ )| | | | \ | |_   _| | | | ########
####### |  \| | | | | | | | |  _ \| | | |  \| | | | | | | | ########
####### | |\  | |_| | | |_| | |_) | |_| | |\  | | | | |_| | ########
####### |_| \_|\___/   \___/|____/ \___/|_| \_| |_|  \___/  ########
####################################################################

TEMPDIR=$(mktemp -d)

# Install build dependencies
sudo DEBIAN_FRONTEND=noninteractive apt -qq build-dep -y libfprint-2-2

# Clone the closed-source library and firmware
cd "${TEMPDIR}" || exit

git clone --depth=1 --branch jammy git://git.launchpad.net/libfprint-2-tod1-broadcom
cd libfprint-2-tod1-broadcom || exit

sudo cp lib/udev/rules.d/60-libfprint-2-device-broadcom.rules /usr/lib/udev/rules.d/60-libfprint-2-device-broadcom.rules
sudo chown -R root:root /usr/lib/udev/rules.d/60-libfprint-2-device-broadcom.rules

sudo mkdir -p /usr/lib/x86_64-linux-gnu/libfprint-2/tod-1
sudo cp usr/lib/x86_64-linux-gnu/libfprint-2/tod-1/libfprint-2-tod-1-broadcom.so /usr/lib/x86_64-linux-gnu/libfprint-2/tod-1/libfprint-2-tod-1-broadcom.so
sudo chown -R root:root /usr/lib/x86_64-linux-gnu/libfprint-2/tod-1/libfprint-2-tod-1-broadcom.so

sudo cp -r var/lib/fprint/fw /var/lib/fprint/
sudo chown -R root:root /var/lib/fprint/fw

# Clone libfprint, switch to the correct tag, patch and build
# LIBFPRINT_VERSION=$(dpkg-query --showformat='${Version}' --show fprintd | cut -d '-' -f 1)
LIBFPRINT_VERSION=$(dpkg-query --showformat='${Version}' --show libfprint-2-2 | cut -d '-' -f 1 | cut -d ":" -f 2)
cd "${TEMPDIR}" || exit
git clone --branch v${LIBFPRINT_VERSION}+tod1 --depth=1 https://gitlab.freedesktop.org/3v1n0/libfprint.git
cd "${TEMPDIR}"/libfprint || exit
sed -e "/subdir('tests')/s/^/#/g" -i meson.build
sed -e "/subdir('examples')/s/^/#/g" -i meson.build
meson build --prefix=/usr
cd build || exit
meson compile

sudo cp libfprint/tod/libfprint-2-tod.so.1 /usr/lib/x86_64-linux-gnu/libfprint-2-tod.so.1
sudo chown root:root /usr/lib/x86_64-linux-gnu/libfprint-2-tod.so.1
sudo ln -sf /usr/lib/x86_64-linux-gnu/libfprint-2-tod.so.1 /usr/lib/x86_64-linux-gnu/libfprint-2-tod.so

sudo cp libfprint/libfprint-2.so.2 /usr/lib/x86_64-linux-gnu/
sudo chown root:root /usr/lib/x86_64-linux-gnu/libfprint-2.so.2

## Remove file incorrectly copied in a previous revision of this gist
sudo rm -f /usr/lib/x86_64-linux-gnu/libfprint-2/tod-1/libfprint-2-tod.so.1

cd "${TEMPDIR}"

# Configure fprintd to not sleep
sudo mkdir -p /etc/systemd/system/fprintd.service.d
cat > override.conf <<EOF
[Service]
ExecStart=
ExecStart=/usr/libexec/fprintd --no-timeout
EOF
sudo cp override.conf /etc/systemd/system/fprintd.service.d/override.conf

sudo udevadm control --reload-rules
sudo systemctl daemon-reload
sudo systemctl restart fprintd

rm -rf "${TEMPDIR}"

On my debian trixie on a Dell Latitude 5420 using branch jammy fails : firmware for ( 0a5c:5843 Broadcom Corp. BCM58200 ControlVault 3 ) was not found :

juil. 08 09:35:35 l5420 fprintd[1690]: In cvif_IsUshThere(), cv_get_ush_ver() status: (0x0)
juil. 08 09:35:35 l5420 fprintd[1690]: Control Vault getting chip type
juil. 08 09:35:35 l5420 fprintd[1690]: Citadel A0 CID7 Chip Found....
juil. 08 09:35:35 l5420 fprintd[1690]: Can not find SBI file (bcmsbiCitadelA0_7.otp)
juil. 08 09:35:35 l5420 fprintd[1690]: Missing files necessary for complete firmware update
juil. 08 09:35:35 l5420 fprintd[1690]:                 FwUpgradeError. Check Firmware Files or CID used or Hardware etc. Error: 0x1c
juil. 08 09:35:35 l5420 fprintd[1690]: Ignoring device due to initialization error: An unspecified error occurred!

It might have been broken by 2024 5th june commit f1d11a05ead73d0284a7e80087a3a610b2583c04 for 'CV3 ans CV3 plus support'.

using branch ubuntu/latest fixed it

-git clone --depth=1 --branch jammy git://git.launchpad.net/libfprint-2-tod1-broadcom
+git clone --depth=1 --branch ubuntu/latest git://git.launchpad.net/libfprint-2-tod1-broadcom

then after ./setup,sh and a reboot i got it working

juil. 08 12:25:28 l5420 fprintd[1670]: In cvif_IsUshThere(), cv_get_ush_ver() status: (0x0)
juil. 08 12:25:28 l5420 fprintd[1670]: Control Vault getting chip type
juil. 08 12:25:28 l5420 fprintd[1670]: Citadel A0 CID7 Chip Found....
juil. 08 12:25:28 l5420 fprintd[1670]: Current AAI Version = 5.14.3.0
juil. 08 12:25:28 l5420 fprintd[1670]: Current SBI Version = 202
juil. 08 12:25:28 l5420 fprintd[1670]: AAI version available for upgrade = 5.14.3.0
juil. 08 12:25:28 l5420 fprintd[1670]: SBI version available for upgrade = 202
juil. 08 12:25:28 l5420 fprintd[1670]: AAI version matches - it is up do date
juil. 08 12:25:28 l5420 fprintd[1670]: SBI version matches - it is up do date
juil. 08 12:25:28 l5420 fprintd[1670]: Citadel A0 CID7 Chip Found....
juil. 08 12:25:28 l5420 fprintd[1670]: Sensor type  : 16 Sensor firmware version on device: GF5288_GM188WNC_APP_10009 length: 25
juil. 08 12:25:28 l5420 fprintd[1670]: Sensor-firmware file signature verification is valid
juil. 08 12:25:28 l5420 fprintd[1670]: Sensor firmware version in file(sensor 16): GF5288_GM188WNC_APP_10009 length: 25
juil. 08 12:25:28 l5420 fprintd[1670]: Sensor firmware versions in file and on device match

Thanks! It works with dell latitude 7330 on debian 13 trixie (so stable, not testing). Thanks to that script I am not forced to switching to ubuntu, but to debian, which in my opinion is better... But there is one line, I had to change: git clone --depth=1 --branch jammy git://git.launchpad.net/libfprint-2-tod1-broadcom must have been changed to git clone --depth=1 --branch ubuntu/jammy git://git.launchpad.net/libfprint-2-tod1-broadcom, because git threw an error, that jammy branch is not found, but after that fix is works perfect! And even after suspend it works (at least in my case).