2021-01-07 22:30:30 +00:00
|
|
|
# Copyright 2021 Oliver Smith
|
2020-02-20 20:07:28 +00:00
|
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
2017-11-19 14:35:23 +00:00
|
|
|
import os
|
|
|
|
import logging
|
|
|
|
import pmb
|
|
|
|
|
|
|
|
|
2019-10-25 15:07:08 +00:00
|
|
|
def is_dtb(path):
|
|
|
|
if not os.path.isfile(path):
|
|
|
|
return False
|
|
|
|
with open(path, 'rb') as f:
|
|
|
|
# Check FDT magic identifier (0xd00dfeed)
|
|
|
|
return f.read(4) == b'\xd0\x0d\xfe\xed'
|
|
|
|
|
|
|
|
|
2020-07-05 19:42:54 +00:00
|
|
|
def has_mtk_header(path, supported_label):
|
|
|
|
with open(path, 'rb') as f:
|
|
|
|
# Check Mediatek header (0x88168858)
|
|
|
|
if not f.read(4) == b'\x88\x16\x88\x58':
|
|
|
|
return False
|
|
|
|
f.seek(8)
|
|
|
|
label = f.read(32).decode("utf-8").rstrip('\0')
|
|
|
|
# We only support hardcoded labels for now as the known devices only
|
|
|
|
# use KERNEL & ROOTFS for kernel and ramdisk respectively. To change
|
|
|
|
# this, deviceinfo would need to store the label and
|
|
|
|
# postmarketos-mkinitfs would need to use that label.
|
|
|
|
if label != supported_label:
|
2021-01-31 18:21:56 +00:00
|
|
|
raise RuntimeError(f"Only '{supported_label}' is supported as"
|
|
|
|
f" label, but your device has '{label}'. Please"
|
|
|
|
f" create an issue and attach your boot.img:"
|
2020-07-05 19:42:54 +00:00
|
|
|
f" https://postmarketos.org/issues")
|
|
|
|
return True
|
|
|
|
|
|
|
|
|
2017-11-19 14:35:23 +00:00
|
|
|
def bootimg(args, path):
|
|
|
|
if not os.path.exists(path):
|
|
|
|
raise RuntimeError("Could not find file '" + path + "'")
|
|
|
|
|
2021-01-31 18:21:56 +00:00
|
|
|
logging.info("NOTE: You will be prompted for your sudo password, so we can"
|
|
|
|
" set up a chroot to extract and analyze your boot.img file")
|
2018-03-08 21:30:55 +00:00
|
|
|
pmb.chroot.apk.install(args, ["file", "unpackbootimg"])
|
2017-11-19 14:35:23 +00:00
|
|
|
|
|
|
|
temp_path = pmb.chroot.other.tempfolder(args, "/tmp/bootimg_parser")
|
2021-01-31 18:21:56 +00:00
|
|
|
bootimg_path = f"{args.work}/chroot_native{temp_path}/boot.img"
|
2017-11-19 14:35:23 +00:00
|
|
|
|
|
|
|
# Copy the boot.img into the chroot temporary folder
|
|
|
|
pmb.helpers.run.root(args, ["cp", path, bootimg_path])
|
|
|
|
|
2018-07-14 01:13:28 +00:00
|
|
|
file_output = pmb.chroot.user(args, ["file", "-b", "boot.img"],
|
|
|
|
working_dir=temp_path,
|
|
|
|
output_return=True).rstrip()
|
2017-11-19 14:35:23 +00:00
|
|
|
if "android bootimg" not in file_output.lower():
|
2018-07-06 19:57:18 +00:00
|
|
|
if "force" in args and args.force:
|
|
|
|
logging.warning("WARNING: boot.img file seems to be invalid, but"
|
|
|
|
" proceeding anyway (-f specified)")
|
2017-11-19 14:35:23 +00:00
|
|
|
else:
|
2018-07-06 19:57:18 +00:00
|
|
|
logging.info("NOTE: If you are sure that your file is a valid"
|
|
|
|
" boot.img file, you could force the analysis"
|
|
|
|
" with: 'pmbootstrap bootimg_analyze " + path +
|
|
|
|
" -f'")
|
2019-12-23 19:16:27 +00:00
|
|
|
if ("linux kernel" in file_output.lower() or
|
|
|
|
"ARM OpenFirmware FORTH Dictionary" in file_output):
|
2018-07-06 19:57:18 +00:00
|
|
|
raise RuntimeError("File is a Kernel image, you might need the"
|
|
|
|
" 'heimdall-isorec' flash method. See also:"
|
|
|
|
" <https://wiki.postmarketos.org/wiki/"
|
|
|
|
"Deviceinfo_flash_methods>")
|
|
|
|
else:
|
|
|
|
raise RuntimeError("File is not an Android boot.img. (" +
|
|
|
|
file_output + ")")
|
2017-11-19 14:35:23 +00:00
|
|
|
|
|
|
|
# Extract all the files
|
2021-01-31 18:21:56 +00:00
|
|
|
pmb.chroot.user(args, ["unpackbootimg", "-i", "boot.img"],
|
|
|
|
working_dir=temp_path)
|
2017-11-19 14:35:23 +00:00
|
|
|
|
|
|
|
output = {}
|
2021-06-19 15:50:27 +00:00
|
|
|
header_version = None
|
2017-11-19 14:35:23 +00:00
|
|
|
# Get base, offsets, pagesize, cmdline and qcdt info
|
2021-06-19 15:50:27 +00:00
|
|
|
# This file does not exist for example for qcdt images
|
|
|
|
if os.path.isfile(f"{bootimg_path}-header_version"):
|
|
|
|
with open(f"{bootimg_path}-header_version", 'r') as f:
|
|
|
|
header_version = int(f.read().replace('\n', ''))
|
|
|
|
|
|
|
|
if header_version is not None and header_version >= 3:
|
|
|
|
output["header_version"] = str(header_version)
|
|
|
|
output["pagesize"] = "4096"
|
|
|
|
else:
|
|
|
|
with open(f"{bootimg_path}-base", 'r') as f:
|
|
|
|
output["base"] = ("0x%08x" % int(f.read().replace('\n', ''), 16))
|
|
|
|
with open(f"{bootimg_path}-kernel_offset", 'r') as f:
|
|
|
|
output["kernel_offset"] = ("0x%08x"
|
|
|
|
% int(f.read().replace('\n', ''), 16))
|
|
|
|
with open(f"{bootimg_path}-ramdisk_offset", 'r') as f:
|
|
|
|
output["ramdisk_offset"] = ("0x%08x"
|
|
|
|
% int(f.read().replace('\n', ''), 16))
|
|
|
|
with open(f"{bootimg_path}-second_offset", 'r') as f:
|
|
|
|
output["second_offset"] = ("0x%08x"
|
|
|
|
% int(f.read().replace('\n', ''), 16))
|
|
|
|
with open(f"{bootimg_path}-tags_offset", 'r') as f:
|
|
|
|
output["tags_offset"] = ("0x%08x"
|
|
|
|
% int(f.read().replace('\n', ''), 16))
|
|
|
|
with open(f"{bootimg_path}-pagesize", 'r') as f:
|
|
|
|
output["pagesize"] = f.read().replace('\n', '')
|
|
|
|
|
2021-01-31 18:21:56 +00:00
|
|
|
output["qcdt"] = ("true" if os.path.isfile(f"{bootimg_path}-dt") and
|
|
|
|
os.path.getsize(f"{bootimg_path}-dt") > 0 else "false")
|
2021-06-02 23:08:48 +00:00
|
|
|
output["mtk_mkimage"] = ("true" if has_mtk_header(f"{bootimg_path}-kernel",
|
2021-01-31 18:21:56 +00:00
|
|
|
"KERNEL") else "false")
|
|
|
|
output["dtb_second"] = ("true" if is_dtb(f"{bootimg_path}-second")
|
|
|
|
else "false")
|
2017-11-19 14:35:23 +00:00
|
|
|
|
2021-06-19 15:50:27 +00:00
|
|
|
with open(f"{bootimg_path}-cmdline", 'r') as f:
|
|
|
|
output["cmdline"] = f.read().replace('\n', '')
|
2020-07-05 19:42:54 +00:00
|
|
|
# Mediatek: Check that the ramdisk also has a known-good label
|
2021-01-31 18:21:56 +00:00
|
|
|
# We don't care about the return value, just whether it throws an exception
|
|
|
|
# or not.
|
2021-06-02 23:08:48 +00:00
|
|
|
has_mtk_header(f"{bootimg_path}-ramdisk", "ROOTFS")
|
2020-07-05 19:42:54 +00:00
|
|
|
|
2017-11-19 14:35:23 +00:00
|
|
|
# Cleanup
|
|
|
|
pmb.chroot.root(args, ["rm", "-r", temp_path])
|
|
|
|
|
|
|
|
return output
|