From: Sam Day Date: Sat, 06 Jun 2026 10:52:35 +1000 Subject: [PATCH 01/13] binman: Android boot image support MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Message-Id: <20260606-android-binman-v1-1-c7a3c14b8a3d@samcday.com> References: <20260606-android-binman-v1-0-c7a3c14b8a3d@samcday.com> In-Reply-To: <20260606-android-binman-v1-0-c7a3c14b8a3d@samcday.com> To: u-boot@lists.denx.de, Sumit Garg , u-boot-qcom@groups.io Cc: Tom Rini , Simon Glass , Alper Nebi Yasak , Quentin Schulz , Bryan Brattlof , Yannic Moog , Wojciech Dubowik , Yegor Yefremov , Denis Mukhin , Rasmus Villemoes , Heinrich Schuchardt , Javier Tia , Rayagonda Kokatanur , Casey Connolly , Neil Armstrong , Tien Fong Chee , Peng Fan , Anshul Dalal , Alif Zakuan Yuslaimi , Marek Vasut , Tingting Meng , Alice Guo , Ilias Apalodimas , Aswin Murugan , Luca Weiss , Varadarajan Narayanan , Minkyu Kang , Kaustabh Chakraborty , Henrik Grimler , Sam Day X-Mailer: b4 0.14.3 X-Developer-Signature: v=1; a=ed25519-sha256; t=1780707158; l=19454; i=me@samcday.com; s=20240502; h=from:subject:message-id; bh=yuVLY8MAUAkmt0erq0eQjYaAN4jKDbG++C9AbZFyHjI=; b=gscowGUeBNoo0Dr2yfXMb+BKjjEg4oD973GjUlDB6DOxyzqubJKNCiRFwf6yY4zETMFV7Uoyv PVDTTRcTQAYD+M7Nx5qhTyrHqKa2GuCjX6XK54xyi3WzKYztW4FPtIZ X-Developer-Key: i=me@samcday.com; a=ed25519; pk=bzyS0akxWMqr9+AXzgBRIp28KKpEOs+GjYMc2yf+aeU= X-Endpoint-Received: by B4 Relay for me@samcday.com/20240502 with auth_id=595 List-Id: B4 Relay Submissions Introduce initial support for Android boot images (abootimgs). This initial stab supports both v0 and v2 headers. The AOSP implementation was used as a reference. Since we're targeting U-Boot use cases here, a couple of things were omitted from this impl, namely "second" and recovery_dtbo support. Link: https://android.googlesource.com/platform/system/tools/mkbootimg/ Signed-off-by: Sam Day --- tools/binman/etype/android_boot.py | 337 +++++++++++++++++++++++++++ tools/binman/ftest.py | 66 ++++++ tools/binman/test/vendor/android_boot_v0.dts | 29 +++ tools/binman/test/vendor/android_boot_v2.dts | 46 ++++ 4 files changed, 478 insertions(+) diff --git a/tools/binman/etype/android_boot.py b/tools/binman/etype/android_boot.py new file mode 100644 index 00000000000..adf8248ee12 --- /dev/null +++ b/tools/binman/etype/android_boot.py @@ -0,0 +1,337 @@ +# SPDX-License-Identifier: GPL-2.0+ +# Entry-type module for Android boot images + +import hashlib +import struct + +from binman.entry import Entry +from binman.etype.section import Entry_section +from dtoc import fdt_util + + +BOOT_MAGIC = b'ANDROID!' +BOOT_NAME_SIZE = 16 +BOOT_ARGS_SIZE = 512 +IMAGE_ID_SIZE = 32 +BOOT_EXTRA_ARGS_SIZE = 1024 + +BOOT_IMAGE_HEADER_V0 = '<{}s10I{}s{}s{}s'.format(len(BOOT_MAGIC), + BOOT_NAME_SIZE, + BOOT_ARGS_SIZE, + IMAGE_ID_SIZE) +BOOT_IMAGE_HEADER_V0_SIZE = struct.calcsize(BOOT_IMAGE_HEADER_V0) +BOOT_IMAGE_HEADER_V2 = (BOOT_IMAGE_HEADER_V0 + + '{}sIQIIQ'.format(BOOT_EXTRA_ARGS_SIZE)) +BOOT_IMAGE_HEADER_V2_SIZE = struct.calcsize(BOOT_IMAGE_HEADER_V2) + +def _align_up(value, align): + return (value + align - 1) & ~(align - 1) + + +def _pad(data, align): + return data + b'\0' * (_align_up(len(data), align) - len(data)) + + +class Entry_android_boot(Entry_section): + """Android boot image + + This creates an Android v0 or v2 boot image. + + A kernel payload, optional ramdisk payload can be supplied. A DTB payload + can also be provided when header_version == v2. + + Properties / Entry arguments: + - header-version: Android boot image header version, must be 0 or 2, + defaults to 0 + - page-size: Image page size, defaults to 2048 + - base: Base address added to the offsets below, defaults to 0x10000000 + - kernel-offset: Kernel load offset from base, defaults to 0x00008000 + - ramdisk-offset: Ramdisk load offset from base, defaults to 0x01000000 + - tags-offset: ATAGS/FDT offset from base, defaults to 0x00000100 + - dtb-offset: DTB load offset from base, defaults to 0x01f00000 + - os-version: Encoded Android OS version and patch level, defaults to 0 + - boot-name: Android boot image board name + - cmdline: Android boot command line + + This entry uses the following subnodes: + - kernel: section containing the executable payload + - dtb: section containing the DTB payload, used by header version 2 only + - ramdisk: optional section containing a ramdisk payload + + Example:: + A v2 abootimg with control FDT placed in the DTB section: + + android-boot { + header-version = <2>; + page-size = <4096>; + base = <0x12345678>; + kernel-offset = <0xCAFED00D>; + ramdisk-offset = <0xBEEFBABE>; + tags-offset = <0xFEEDDEAD>; + dtb-offset = <0x06660666>; + cmdline = "foo bar"; + + kernel { + u-boot-nodtb { + # Many Android bootloaders support gzipped kernels + compress = "gzip"; + }; + }; + + dtb { + u-boot-dtb { + }; + }; + }; + + A v0 abootimg with embedded control FDT (v0 doesn't support DTBs) and + an empty ramdisk (some bootloaders insist on a ramdisk being present): + android-boot { + header-version = <0>; + page-size = <2048>; + base = <0x80200000>; + + kernel { + u-boot { + no-expanded; + }; + }; + + ramdisk { + fill { + size = <1>; + }; + }; + }; + """ + + def ReadNode(self): + super().ReadNode() + self.header_version = fdt_util.GetInt(self._node, 'header-version', 0) + self.page_size = fdt_util.GetInt(self._node, 'page-size', 2048) + self.base = self._GetIntCells('base', 0x10000000) + self.kernel_offset = self._GetIntCells('kernel-offset', 0x00008000) + self.ramdisk_offset = self._GetIntCells('ramdisk-offset', 0x01000000) + self.tags_offset = self._GetIntCells('tags-offset', 0x00000100) + self.dtb_offset = self._GetIntCells('dtb-offset', 0x01f00000) + self.os_version = fdt_util.GetInt(self._node, 'os-version', 0) + self.boot_name = fdt_util.GetString(self._node, 'boot-name', '') + self.cmdline = fdt_util.GetString(self._node, 'cmdline', '') + + if self.header_version not in (0, 2): + self.Raise('Only Android boot image header versions 0 and 2 are ' + 'supported') + if self.page_size <= 0 or self.page_size & (self.page_size - 1): + self.Raise('page-size must be a power of two') + if 'kernel' not in self._entries: + self.Raise("Missing required subnode 'kernel'") + + if self.header_version == 0: + if self.page_size < BOOT_IMAGE_HEADER_V0_SIZE: + self.Raise('page-size must fit the Android boot image header') + if 'dtb' in self._entries: + self.Raise("Subnode 'dtb' requires header-version 2") + else: + # v2 + if self.page_size < BOOT_IMAGE_HEADER_V2_SIZE: + self.Raise('page-size must fit the Android boot image header') + if 'dtb' not in self._entries: + self.Raise("Missing required subnode 'dtb'") + + def ReadEntries(self): + for node in self._node.subnodes: + if self.IsSpecialSubnode(node): + continue + if node.name not in ('kernel', 'ramdisk', 'dtb'): + self.Raise("Unexpected subnode '%s'" % node.name) + + entry = Entry.Create(self, node, etype='section', + expanded=self.GetImage().use_expanded, + missing_etype=self.GetImage().missing_etype) + entry.ReadNode() + entry.SetPrefix(self._name_prefix) + self._entries[node.name] = entry + + def _GetIntCells(self, propname, default): + prop = self._node.props.get(propname) + if not prop: + return default + + values = prop.value if isinstance(prop.value, list) else [prop.value] + if len(values) > 2: + self.Raise("Property '%s' must contain one or two cells" % + propname) + + value = 0 + for cell in values: + value = value << 32 | fdt_util.fdt32_to_cpu(cell) + + return value + + def _GetAddr(self, offset, name, size=32): + addr = self.base + offset + if addr >= 1 << size: + self.Raise('%s address %#x does not fit in %d bits' % + (name, addr, size)) + + return addr + + @staticmethod + def _CheckFit(name, data, size): + if len(data) > size: + raise ValueError('%s is %d bytes, maximum is %d' % + (name, len(data), size)) + + return data + b'\0' * (size - len(data)) + + @staticmethod + def _BootId(*payloads): + digest = hashlib.sha1() + for data in payloads: + digest.update(data) + digest.update(struct.pack('; + #size-cells = <1>; + + binman { + android-boot { + header-version = <0>; + page-size = <0x800>; + base = <0x80200000>; + cmdline = "foo"; + + kernel { + u-boot { + no-expanded; + }; + }; + + ramdisk { + fill { + size = <1>; + }; + }; + }; + }; +}; diff --git a/tools/binman/test/vendor/android_boot_v2.dts b/tools/binman/test/vendor/android_boot_v2.dts new file mode 100644 index 00000000000..20de6e2f1af --- /dev/null +++ b/tools/binman/test/vendor/android_boot_v2.dts @@ -0,0 +1,46 @@ +// SPDX-License-Identifier: GPL-2.0+ + +/dts-v1/; + +#define CMDLINE(...) #__VA_ARGS__ + +/ { + #address-cells = <1>; + #size-cells = <1>; + + binman { + android-boot { + header-version = <2>; + page-size = <0x800>; + base = <0x80000000>; + kernel-offset = <0x00008000>; + ramdisk-offset = <0x01000000>; + second-offset = <0x00f00000>; + tags-offset = <0x00000100>; + dtb-offset = <0x01f00000>; + boot-name = "test-board"; + cmdline = CMDLINE( + This is a very long commandline that is sure to exceed the + 512 chars that is allotted to the cmdline and this should + spillover into extra_cmdline which is useful from a + function testing standpoint. Gosh, it sure it hard to come + up with enough filler text here to get over the 512 char + limit though, huh? Even for someone as loquacious as + myself. So anyway. How's your day going? I wrote a binman + functional test today. It was fun. Did you know that + binman is great. I like binman. I also like functional + tests.. sup); + + kernel { + u-boot { + no-expanded; + }; + }; + + dtb { + u-boot-dtb { + }; + }; + }; + }; +}; -- 2.54.0