GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / arm / qcom.txt
1 QCOM device tree bindings
2 -------------------------
3
4 Some qcom based bootloaders identify the dtb blob based on a set of
5 device properties like SoC and platform and revisions of those components.
6 To support this scheme, we encode this information into the board compatible
7 string.
8
9 Each board must specify a top-level board compatible string with the following
10 format:
11
12         compatible = "qcom,<SoC>[-<soc_version>][-<foundry_id>]-<board>[/<subtype>][-<board_version>]"
13
14 The 'SoC' and 'board' elements are required. All other elements are optional.
15
16 The 'SoC' element must be one of the following strings:
17
18         apq8016
19         apq8074
20         apq8084
21         apq8096
22         msm8916
23         msm8974
24         msm8992
25         msm8994
26         msm8996
27         mdm9615
28         ipq8074
29
30 The 'board' element must be one of the following strings:
31
32         cdp
33         liquid
34         dragonboard
35         mtp
36         sbc
37         hk01
38
39 The 'soc_version' and 'board_version' elements take the form of v<Major>.<Minor>
40 where the minor number may be omitted when it's zero, i.e.  v1.0 is the same
41 as v1. If all versions of the 'board_version' elements match, then a
42 wildcard '*' should be used, e.g. 'v*'.
43
44 The 'foundry_id' and 'subtype' elements are one or more digits from 0 to 9.
45
46 Examples:
47
48         "qcom,msm8916-v1-cdp-pm8916-v2.1"
49
50 A CDP board with an msm8916 SoC, version 1 paired with a pm8916 PMIC of version
51 2.1.
52
53         "qcom,apq8074-v2.0-2-dragonboard/1-v0.1"
54
55 A dragonboard board v0.1 of subtype 1 with an apq8074 SoC version 2, made in
56 foundry 2.