diff --git a/README.md b/README.md index 086eff9..78f548d 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ mkbootimg_tools Generating master DTB... completed -### dtbToolCM support dt-tag & dtb v2(https://github.com/CyanogenMod/android_device_qcom_common/tree/cm-11.0/dtbtool): +### dtbToolCM support dt-tag & dtb v2/3(https://github.com/CyanogenMod/android_device_qcom_common/tree/cm-13.0/dtbtool): dtbToolCM -s 2048 -d "htc,project-id = <" -o arch/arm/boot/dt.img -p scripts/dtc/ arch/arm/boot/ diff --git a/dtbToolCM b/dtbToolCM index 822ecae..40c691e 100755 Binary files a/dtbToolCM and b/dtbToolCM differ diff --git a/dtbtool.txt b/dtbtool.txt index 9fcd819..2d5b5e5 100644 --- a/dtbtool.txt +++ b/dtbtool.txt @@ -1,7 +1,4 @@ -Refer to device/*/dtbtool.txt - ---------------------------------------------------------------------- -Copyright (c) 2012, The Linux Foundation. All rights reserved. +Copyright (c) 2012-2014, The Linux Foundation. All rights reserved. Redistribution and use in source form and compiled forms (SGML, HTML, PDF, PostScript, RTF and so forth) with or without modification, are @@ -36,6 +33,7 @@ Android - Table of Device Tree 0) Document revision v1.0 - Initial version (dng) + v1.1 - Add v2 format to allow subtype (dng) 1) Android boot image: ---------------------- @@ -75,16 +73,26 @@ Android - Table of Device Tree x +------------------+ | | MAGIC ("QCDT") | 4B | +------------------+ - header | VERSION | uint32 (initial version 1) + header | VERSION | uint32 (version 3) | +------------------+ | | num of DTBs | uint32 (number of DTB entries) x +------------------+ | | platform id #1 | uint32 (e.g. ID for MSM8974) | +------------------+ | | variant id #1 | uint32 (e.g. ID for CDP, MTP) + | +------------------+ + | | subtype id #1 | uint32 (e.g. ID for subtype) (QCDT v2) device +------------------+ #1 | soc rev #1 | uint32 (e.g. MSM8974 v2) entry +------------------+ + | | pmic0 #1 | uint32 (pmic0-> first smallest SID of existing pmic) + | +------------------+ + | | pmic1 #1 | uint32 (pmic1-> secondary smallest SID of existing pmic) + | +------------------+ + | | pmic2 #1 | uint32 (pmic2-> third smallest SID of existing pmic) + | +------------------+ + | | pmic3 #1 | uint32 (pmic3-> fourth smallest SID of existing pmic) + | +------------------+ | | offset #1 | uint32 (byte offset from start/before MAGIC | +------------------+ to DTB entry) | | size #1 | uint32 (size in bytes of DTB blob) @@ -98,8 +106,18 @@ Android - Table of Device Tree | +------------------+ device | variant id #Z | uint32 (e.g. ID for CDP, MTP) #Z +------------------+ - entry | soc rev #Z | uint32 (e.g. MSM8974 v2) + entry | subtype id #Z | uint32 (e.g. ID for subtype) (QCDT v2) (last) +------------------+ + | | soc rev #Z | uint32 (e.g. MSM8974 v2) + | +------------------+ + | | pmic0 #1 | uint32 (pmic0-> first smallest SID of existing pmic) + | +------------------+ + | | pmic1 #1 | uint32 (pmic1-> secondary smallest SID of existing pmic) + | +------------------+ + | | pmic2 #1 | uint32 (pmic2-> third smallest SID of existing pmic) + | +------------------+ + | | pmic3 #1 | uint32 (pmic3-> fourth smallest SID of existing pmic) + | +------------------+ | | offset #Z | uint32 (byte offset from start/before MAGIC x +------------------+ to DTB entry) | 0 ("zero") | uint32 (end of list delimiter) @@ -125,25 +143,63 @@ Android - Table of Device Tree 3) Operations ------------- 3.1) Build-time: - 1) Each DTS per device will add a "qcom,msm-id" triplet + 1) Each DTS per device will add a "qcom,msm-id" entry e.g. for msm8974-sim.dts, add - qcom,msm-id = ; - x = ID for msm8974 - y = ID for CDP, MTP, etc. - z = ID for soc revision - The triplet can optionally be an array of triplets: - qcom,msm-id = , , ...; + qcom,msm-id = ; + or + qcom,msm-id = ; + qcom,board-id = ; + or + qcom,msm-id = ; + qcom,board-id = ; + qcom,pmic-id = ; + x = ID for msm8974 + y = ID for CDP, MTP, etc. + y' = ID for subtype (assumed zero if absent) + z = ID for soc revision + a = pmic0 + b = pmic1 + c = pmic2 + d = pmic3 + SBL populates the pmic entries always in ascending order of SID, so + pmic0-> SID0, pmic1-> SID1, pmic2-> SID2, pmic3-> SID3. + e.g. for qcom,pmic-id = + Board X = MSM8994 + PM8994 + PMI8994 (Existing boards [ROW]) + Board Y = MSM8994 + PM8994 + PMI8994 + PM8004 (Internal SS board variant) + Board Z = MSM8994 + PM8994 + PM8004 (Boards that SS will be making) + + For all boards X, Y, and Z, PMICs have the following SIDs and REVID SUBTYPEs + (i.e. PMIC Model): + PM8994 - SID 0 and 1; subtype = 9 + PMI8994 - SID 2 and 3; subtype = 10 + PM8004 - SID 4 and 5; subtype = 12 + + LK using SMEM PMIC info(1 as major and 0 as minor version for example): + Board X: qcom,pmic-id = <0x0109 0x010A 0x0 0x0>; + Board Y: qcom,pmic-id = <0x0109 0x010A 0x010C 0x0>; + Board Z: qcom,pmic-id = <0x0109 0x010C 0x0 0x0>; + + The entry can optionally be an array: + qcom,msm-id = , , ...; + or + qcom,msm-id = , , ...; + qcom,board-id = , ...; + or + qcom,msm-id = , , ...; + qcom,board-id = , ...; + qcom,pmic-id = , ...; + Note that qcom,msm-id, qcom,board-id and qcom,pmic-id are not matched pairs. 2) Kernel compile will generate the DTB 3) Android build will run a new tool (dtbTool) a) scan the DTB output directory for all compiled DTB - b) decompile the DTB for "qcom,msm-id" + b) decompile the DTB for "qcom,msm-id"/"qcom,board-id"/"qcom,pmic-id" c) generate the QC table of device tree in sorted - order (platform, variant, soc rev) + order (platform, variant, subtype, soc rev, pmic0, pmic1, pmic2, pmic3) d) modified mkbootimg will merge new table of DT 3.2) Run-time: - 1) LK bootloader will obtain MSM id/variant/soc rev info - either from early bootloaders or via other means + 1) LK bootloader will obtain platform id/variant/subtype/soc rev/major ver/minor ver + /pmic0/pmic1/pmic2/pmic3 info either from early bootloaders or via other means 2) LK bootloader will check entries #10 for non-zero value (set to zero for standard boot.img). If the value is non-zero, refer to page section after @@ -153,9 +209,28 @@ Android - Table of Device Tree QCDT version) 5) LK scans through the QCDT table to look for matching entry. Search order is: - 1) platform ID exact match - 2) variant ID exact match - 3) select the highest soc rev in QCDT that is + 1) msm ID exact match + 2) Platform type exact match + 3) subtype ID exact match + 4) HLOS subtype exact match + 5) Pmic0 model ID exact match + 6) Pmic1 model ID exact match + 7) Pmic2 model ID exact match + 8) Pmic3 model ID exact match + 9) foundry ID, look for exact match, if not found choose + device tree with foundry-id(0x0) + 10) select the highest soc rev in QCDT that is equal to or lower than the runtime detected soc rev + 11) select the highest major&minor ver in QCDT that is + equal to or lower than the runtime detected major ver + 12) select the highest pmic0 major&minor in QCDT that is + equal to or lower than the runtime detected pmic0 + 13) select the highest pmic1 major&minor in QCDT that is + equal to or lower than the runtime detected pmic1 + 14) select the highest pmic2 major&minor in QCDT that is + equal to or lower than the runtime detected pmic2 + 15) select the highest pmic3 major&minor in QCDT that is + equal to or lower than the runtime detected pmic3 6) Load the matching DTB blob to the tags addr 7) LK pass the correct DTB to the kernel + \ No newline at end of file