]> git.karo-electronics.de Git - karo-tx-linux.git/blob - Documentation/devicetree/bindings/arm/msm/ids.txt
devicetree: bindings: Document qcom,msm-id and qcom,board-id
[karo-tx-linux.git] / Documentation / devicetree / bindings / arm / msm / ids.txt
1 * MSM-ID
2
3 The qcom,msm-id entry specifies the MSM chipset and hardware revision.  It can
4 optionally be an array of these to indicate multiple hardware that use the same
5 device tree.  It is expected that the bootloader will use this information at
6 boot-up to decide which device tree to use when given multiple device trees,
7 some of which may not be compatible with the actual hardware.  It is the
8 bootloader's responsibility to pass the correct device tree to the kernel.
9
10 PROPERTIES
11
12 - qcom,msm-id:
13         Usage: required
14         Value type: <prop-encoded-array> (<chipset_id, rev_id> [, <c2, r2> ..])
15         Definition:
16                 The "chipset_id" consists of three fields as below:
17
18                 bits 0-15  = The unique MSM chipset id.
19                 bits 16-31 = Reserved.  Should be 0
20
21                 chipset_id is an exact match value
22
23                 The "rev_id" is a chipset specific 32-bit id that represents
24                 the version of the chipset.
25
26                 The rev_id is a best match id.  The bootloader will look for
27                 the closest possible patch.
28
29 * BOARD-ID
30
31 The qcom,board-id entry specifies the board type and revision information.  It
32 can optionally be an array of these to indicate multiple boards that use the
33 same device tree.  It is expected that the bootloader will use this information
34 at boot-up to decide which device tree to use when given multiple device trees,
35 some of which may not be compatible with the actual hardware.  It is the
36 bootloader's responsibility to pass the correct device tree to the kernel.
37
38 PROPERTIES
39
40 - qcom,board-id:
41         Usage: required
42         Value type: <prop-encoded-array> (<board_id, subtype_id> [, <b2, s2> ..])
43         Definition:
44                 The "board_id" consists of three fields as below:
45
46                 bits 31-24 = Unusued.
47                 bits 23-16 = Platform Version Major
48                 bits 15-8  = Platfrom Version Minor
49                 bits 7-0   = Platform Type
50
51                 Platform Type field is an exact match value.  The Platform
52                 Major/Minor field is a best match.  The bootloader will look
53                 for the closest possible match.
54
55                 The "subtype_id" is unique to a Platform Type/Chipset ID.  For
56                 a given Platform Type, there will typically only be a single
57                 board and the subtype_id will be 0.  However in some cases board
58                 variants may need to be distinquished by different subtype_id
59                 values.
60
61                 subtype_id is an exact match value.
62
63 EXAMPLE:
64         qcom,board-id = <15 2>;
65         qcom,msm-id = <0x1007e 0>;