droid-juicer is a tool for extracting binary firmware files from
vendor partitions on Android devices. It allows importing the needed
firmware into the Linux system's /lib/firmware folder, avoiding the
need to distribute such firmware and the corresponding legal issues.
Please note that droid-juicer is aimed at Debian systems only for the
moment, but can be extended to other systems in the future.
droid-juicer relies on per-device TOML config files named after the
device's DT compatible property.
The config files contain a single section named juicer with a single
firmware key. The expected value for this key is an array of
"objects" with the following attributes:
* partition: the name of the vendor partition containing the firmware
files as it appears under /dev/disk/by-partlabel/.
* origin: the folder of the vendor partition containing the firmware
files
* destination: the /lib/firmware subfolder under which the firmware
files must be copied; this folder will be created if it doesn't exist
* files: an array of filenames; those are the firmware files to be
copied by droid-juicer
* divert (optional): a boolean indicating whether droid-juicer
should create a "diversion" (using dpkg-divert) for this file; this
ensures other packages can't overwrite the extracted firmware and is
recommended for firmware files with "generic" names (i.e. none of the
file itself and the directory tree containing it include the device's
name)
Example configurations can be found in the configs folder.
droid-juicer is started during the device's first boot by a systemd
service. It copies the firmware files according to the corresponding
configuration file, then updates the initramfs and the Android boot
image so extracted firmware are available on subsequent boots. Finally,
it reboots the device.
droid-juicer can also be executed manually (as root). In such
cases, it is however recommended to first run droid-juicer --cleanup
so the existing files and diversions are removed before the new run.
droid-juicer is licensed under the terms of the
MIT license.
Feel free to open issues and/or merge requests on the project's gitlab repo.