From: Sam Day <[email protected]> This vendor-specific format is used by many bootloaders on older qcom SoCs, such as msm8916. It's a container for N FDTs. Each one is contained in a record that includes metadata about the platform/variant it targets. The previous bootloader picks the "right" record based on this metadata.
This initial impl targets a streamlined v2 path, with no support for different versions or multiple qcom,msm-id/qcom,board-id tuples. If/when that's needed it will be implemented in a follow-up. Signed-off-by: Sam Day <[email protected]> --- tools/binman/etype/android_boot.py | 30 +++++ tools/binman/etype/qcdt.py | 160 +++++++++++++++++++++++++++ tools/binman/ftest.py | 22 ++++ tools/binman/test/vendor/qcdt.dts | 20 ++++ tools/binman/test/vendor/qcdt_bad_msm_id.dts | 17 +++ 5 files changed, 249 insertions(+) diff --git a/tools/binman/etype/android_boot.py b/tools/binman/etype/android_boot.py index fa5dd746411..aa68848f579 100644 --- a/tools/binman/etype/android_boot.py +++ b/tools/binman/etype/android_boot.py @@ -108,6 +108,36 @@ class Entry_android_boot(Entry_section): }; }; }; + + A legacy QCDT abootimg, the kind msm8916 bootloaders expect: + + android-boot { + base = <0x80000000>; + + kernel { + u-boot { + no-expanded; + }; + }; + + ramdisk { + fill { + size = <1>; + }; + }; + + vendor-dt { + qcdt { + dtb-0 { + qcom,msm-id = <206 0>; + qcom,board-id = <0xce08ff01 1>; + + u-boot-dtb { + }; + }; + }; + }; + }; """ def ReadNode(self): diff --git a/tools/binman/etype/qcdt.py b/tools/binman/etype/qcdt.py new file mode 100644 index 00000000000..ddfa72eb8d2 --- /dev/null +++ b/tools/binman/etype/qcdt.py @@ -0,0 +1,160 @@ +# SPDX-License-Identifier: GPL-2.0+ +# Entry-type module for Qualcomm Android device tree tables + +import struct + +from binman.entry import Entry +from binman.etype.section import Entry_section +from dtoc import fdt_util + + +QCDT_MAGIC = b'QCDT' +QCDT_VERSION = 2 + + +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_qcdt(Entry_section): + """Qualcomm Android device tree table + + This creates a QCDT table, the legacy device-tree table format used by + some Qualcomm Android bootloaders. + + Properties / Entry arguments: + - page-size: QCDT page size, defaults to the parent android-boot page + size or 2048 when used elsewhere + + This entry uses the following subnodes: + - dtb-*: DTB records, each containing qcom,msm-id, qcom,board-id and + exactly one DTB payload entry + + Example:: + + qcdt { + dtb-0 { + qcom,msm-id = <206 0>; + qcom,board-id = <0xce08ff01 1>; + + u-boot-dtb { + }; + }; + }; + """ + + @staticmethod + def _DtbEntryName(node): + return '_dtb_%s' % node.name + + def _GetPayloadSubnodes(self, node): + return [subnode for subnode in node.subnodes + if not self.IsSpecialSubnode(subnode)] + + def ReadNode(self): + super().ReadNode() + self._page_size = fdt_util.GetInt(self._node, 'page-size') + if (self._page_size is not None and + (self._page_size <= 0 or + self._page_size & (self._page_size - 1))): + self.Raise('page-size must be a power of two') + + def ReadEntries(self): + for node in self._node.subnodes: + if self.IsSpecialSubnode(node): + continue + + payloads = self._GetPayloadSubnodes(node) + if len(payloads) > 1: + raise ValueError("Node '%s': must contain exactly one DTB " + "payload subnode" % node.path) + if not payloads: + continue + + entry = Entry.Create(self, payloads[0], + expanded=self.GetImage().use_expanded, + missing_etype=self.GetImage().missing_etype) + entry.ReadNode() + entry.SetPrefix(self._name_prefix) + self._entries[self._DtbEntryName(node)] = entry + + @staticmethod + def _GetU32Cells(node, propname): + prop = node.props.get(propname) + if not prop: + raise ValueError("Node '%s': Missing required property '%s'" % + (node.path, propname)) + + values = prop.value if isinstance(prop.value, list) else [prop.value] + return [fdt_util.fdt32_to_cpu(value) for value in values] + + @classmethod + def _GetU32Tuple(cls, node, propname, width): + values = cls._GetU32Cells(node, propname) + if len(values) != width: + raise ValueError("Node '%s': Property '%s' must contain exactly " + "%d cells" % (node.path, propname, width)) + + return tuple(values) + + def _GetPageSize(self): + if self._page_size is not None: + return self._page_size + + return getattr(self.section, 'page_size', 2048) + + def _GetDtbData(self, node, required): + entry = self._entries.get(self._DtbEntryName(node)) + if not entry: + raise ValueError("Node '%s': Missing required DTB payload subnode" % + node.path) + + data = entry.GetData(required) + if data is None and not required: + return None + + return data + + def BuildSectionData(self, required): + if not self._node.subnodes: + raise ValueError("Node '%s': Missing required DTB subnodes" % + self._node.path) + + page_size = self._GetPageSize() + dtbs = [] + for node in self._node.subnodes: + if self.IsSpecialSubnode(node): + continue + + msm_id = self._GetU32Tuple(node, 'qcom,msm-id', 2) + board_id = self._GetU32Tuple(node, 'qcom,board-id', 2) + data = self._GetDtbData(node, required) + if data is None and not required: + return None + + dtbs.append((msm_id, board_id, data)) + + if not dtbs: + raise ValueError("Node '%s': Missing required DTB subnodes" % + self._node.path) + + dtb_offset = _align_up(12 + len(dtbs) * 24, page_size) + records = [] + payloads = bytearray() + for msm_id, board_id, dtb in dtbs: + dtb_size = _align_up(len(dtb), page_size) + records.append((*msm_id, *board_id, dtb_offset, dtb_size)) + payloads += _pad(dtb, page_size) + dtb_offset += dtb_size + + qcdt = bytearray(struct.pack('<4sII', QCDT_MAGIC, QCDT_VERSION, + len(records))) + for platform_id, soc_rev, variant_id, subtype, offset, size in records: + qcdt += struct.pack('<IIIIII', platform_id, variant_id, subtype, + soc_rev, offset, size) + + return _pad(qcdt, page_size) + bytes(payloads) diff --git a/tools/binman/ftest.py b/tools/binman/ftest.py index 80219e519f6..c96748bd1dd 100644 --- a/tools/binman/ftest.py +++ b/tools/binman/ftest.py @@ -5673,6 +5673,28 @@ fdt fdtmap Extract the devicetree blob from the fdtmap vendor_dt), header[13]) self.assertEqual(vendor_dt, data[0x1800:0x1805]) + def testAndroidBootQcdt(self): + """Test that binman can produce a QCDT container""" + data, dtb_data, _map, _dtb = self._DoReadFileDtb( + 'vendor/qcdt.dts', use_real_dtb=True) + + dtb_size = tools.align(len(dtb_data), 0x800) + + self.assertEqual(b'QCDT', data[:4]) + self.assertEqual((2, 1), struct.unpack_from('<II', data, 4)) + self.assertEqual((0xce, 0xce08ff01, 1, 0, 0x800, dtb_size), + struct.unpack_from('<IIIIII', data, 12)) + self.assertEqual(0xd00dfeed, + struct.unpack_from('>I', data, 0x800)[0]) + self.assertEqual(dtb_data, data[0x800:0x800 + len(dtb_data)]) + + def testAndroidBootQcdtBadMsmId(self): + """Test that QCDT rejects invalid msm-id properties""" + with self.assertRaises(ValueError) as exc: + self._DoReadFile('vendor/qcdt_bad_msm_id.dts') + self.assertIn("Property 'qcom,msm-id' must contain exactly 2 cells", + str(exc.exception)) + def testFitFdtOper(self): """Check handling of a specified FIT operation""" entry_args = { diff --git a/tools/binman/test/vendor/qcdt.dts b/tools/binman/test/vendor/qcdt.dts new file mode 100644 index 00000000000..0d6d7f76870 --- /dev/null +++ b/tools/binman/test/vendor/qcdt.dts @@ -0,0 +1,20 @@ +// SPDX-License-Identifier: GPL-2.0+ + +/dts-v1/; + +/ { + #address-cells = <1>; + #size-cells = <1>; + + binman { + qcdt { + dtb-0 { + qcom,msm-id = <0xce 0>; + qcom,board-id = <0xce08ff01 1>; + + u-boot-dtb { + }; + }; + }; + }; +}; diff --git a/tools/binman/test/vendor/qcdt_bad_msm_id.dts b/tools/binman/test/vendor/qcdt_bad_msm_id.dts new file mode 100644 index 00000000000..1c3d4ec1a2e --- /dev/null +++ b/tools/binman/test/vendor/qcdt_bad_msm_id.dts @@ -0,0 +1,17 @@ +// SPDX-License-Identifier: GPL-2.0+ + +/dts-v1/; + +/ { + #address-cells = <1>; + #size-cells = <1>; + + binman { + qcdt { + dtb-0 { + qcom,msm-id = <0xce 0 1>; + qcom,board-id = <0xce08ff01 1>; + }; + }; + }; +}; -- 2.54.0
