QCDT
Some Androids only accept boot.img files in the QCDT format, which means the dtb is appended to the end of it (and not at the end of the kernel, as with most other Android devices).
Does my device need a QCDT boot.img file?
Analyze a known working boot.img file with pmbootstrap to find out, if it has the QCDT format or not. You can get such a file from downloading a TWRP image (it is directly in the boot.img format!) or by downloading a full Android ROM for your device and extracting the boot.img file.
$ pmbootstrap bootimg_analyze /path/to/boot.img
If this prints deviceinfo_bootimg_qcdt="true"
, then you have a QCDT device.
Packaging a QCDT device
Running bootimg_analyze should print the option deviceinfo_bootimg_qcdt_type
, which defines what kind of dt.img is supported in your device. It should be either qcom
, exynos
, or sprd
. This option should be present in your deviceinfo, with deviceinfo_bootimg_qcdt="true"
.
Along with the aforementioned option, you also need to include deviceinfo_dtb
with the path to the dtb. This option currently supports
only one devicetree.
For devices with deviceinfo_bootimg_qcdt_type="qcom"
- Add
dtbtool
todepends
in your device APKBUILD.
For devices with deviceinfo_bootimg_qcdt_type="sprd"
- Add
dtbtool-sprd
todepends
in your device APKBUILD.
For devices with deviceinfo_bootimg_qcdt_type="exynos"
- Add
dtbtool-exynos
todepends
in your device APKBUILD.
Reference implementation: samsung-on7xelte
Packaging in the kernel
Usually, dt.img contains multiple devicetrees (for instance, for multiple revisions of the same device) which enables the bootloader to select the suitable devicetree. Here, the above method won't work as it imposes a limitation of only one dtb.
Instead, the dt.img generation can be manually implemented in the kernel package.
- Set
deviceinfo_bootimg_qcdt="true"
in the deviceinfo. - Remove all references of
deviceinfo_bootimg_qcdt_type
. Otherwise, boot-deploy will revert to using the previously mentioned method. - Add the following in
prepare()
in your kernel APKBUILD.
install -Dm644 "$_outdir/arch/$_carch/boot"/dt.img "$pkgdir"/boot/dt.img
- Follow the instructions specific to your device to edit the kernel APKBUILD given below.
For devices with deviceinfo_bootimg_qcdt_type="qcom"
- Add
dtbtool
tomakedepends
. - Add the following in
build()
dtbTool -s 2048 -p "scripts/dtc/" -o "$_outdir/arch/$_carch/boot"/dt.img \ "$_outdir/arch/$_carch/boot/"
For devices with deviceinfo_bootimg_qcdt_type="sprd"
- Add
dtbtool-sprd
tomakedepends
. - Add the following in
build()
dtbTool-sprd -s 2048 -p "scripts/dtc/" -o "$_outdir/arch/$_carch/boot"/dt.img \ "$_outdir/arch/$_carch/boot/dts/"
For devices with deviceinfo_bootimg_qcdt_type="exynos"
- Add
dtbtool-exynos
tomakedepends
. - Add the following in
build()
dtbTool-exynos -o "$_outdir/arch/$_carch/boot"/dt.img \ $(find "$_outdir/arch/$_carch/boot/dts/" -name *.dtb)
Do note that these values don't necessarily have a correlation with their SoC. For example, here's a device with a Mediatek chipset requiring dtbtool-exynos . |
Moreover, there are a lot of devices in pmaports using this method. They may also be studied for implementation.
Debugging
- Hook up the serial UART and see what kind of debug output the bootloader provides
- Repack the boot image with a working
dt.img
from another distribution (stock, Lineage, recovery, etc.)
Compare the appended dtb files
$ pmbootstrap install
$ pmbootstrap chroot -r -- mkdir -p /tmp/extract-dtb-known-working
$ sudo cp known_working_boot.img ~/.local/var/pmbootstrap/chroot_rootfs_*/tmp/extract-dtb-known-working/boot.img
$ pmbootstrap chroot -r
# apk add extract-dtb
# mkdir -p /tmp/extract-dtb-pmOS
# ls /boot/
# cp /boot/boot.img-* /tmp/extract-dtb-pmOS/boot.img
# cd /tmp/extract-dtb-pmOS
# extract-dtb boot.img
# cd /tmp/extract-dtb-known-working
# extract-dtb boot.img
Now compare the output in both temp folders.
Is there the same amount of dtb files, and are the files the same?
If not, then the QCDT generation went wrong.
Repack procedure
Please update these instructions when trying them out as they seem outdated, check the --help pages of the tools for help. |
You need mkbootimg
and unpackbootimg
tools which are already packaged in pmbootstrap.
$ sudo mkdir -p ~/.local/var/pmbootstrap/chroot_native/tmp/bootimg_repack
$ sudo cp pmos-boot.img ~/.local/var/pmbootstrap/chroot_native/tmp/bootimg_repack/
$ sudo cp other-.img ~/.local/var/pmbootstrap/chroot_native/tmp/bootimg_repack/
$ pmbootstrap chroot --add=mkbootimg-osm0sis
# cd /tmp/bootimg_repack
# unpackbootimg -i pmos-boot.img -o pmos
# unpackbootimg -i other-boot.img -o other
$ cp other/boot.img-dt pmos/boot.img-$vendor-$name-dt
$ mkbootimg-osm0sis -o boot.repack.img -r pmos/boot.img-$vendor-$name-
You can also get these from https://github.com/efidroid/build/tree/master/tools
abootimg
is packaged for postmarketOS as well, which allows to repackage the boot.img files without extracting them.
See also
- dtbtool
- #323 related discussion
- !356 first implementation
- dtimgextract
- #1206 debugging session for "FAILED (remote: dtb not found)" (contains a workaround)