Merge tag 'drm-for-v4.16-part2-fixes' of git://people.freedesktop.org/~airlied/linux
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / mailbox / qcom,apcs-kpss-global.txt
1 Binding for the Qualcomm APCS global block
2 ==========================================
3
4 This binding describes the APCS "global" block found in various Qualcomm
5 platforms.
6
7 - compatible:
8         Usage: required
9         Value type: <string>
10         Definition: must be one of:
11                     "qcom,msm8916-apcs-kpss-global",
12                     "qcom,msm8996-apcs-hmss-global"
13
14 - reg:
15         Usage: required
16         Value type: <prop-encoded-array>
17         Definition: must specify the base address and size of the global block
18 - clocks:
19         Usage: required if #clocks-cells property is present
20         Value type: <phandle>
21         Definition: phandle to the input PLL, which feeds the APCS mux/divider
22
23 - #mbox-cells:
24         Usage: required
25         Value type: <u32>
26         Definition: as described in mailbox.txt, must be 1
27
28 - #clock-cells:
29         Usage: optional
30         Value type: <u32>
31         Definition: as described in clock.txt, must be 0
32
33
34 = EXAMPLE
35 The following example describes the APCS HMSS found in MSM8996 and part of the
36 GLINK RPM referencing the "rpm_hlos" doorbell therein.
37
38         apcs_glb: mailbox@9820000 {
39                 compatible = "qcom,msm8996-apcs-hmss-global";
40                 reg = <0x9820000 0x1000>;
41
42                 #mbox-cells = <1>;
43         };
44
45         rpm-glink {
46                 compatible = "qcom,glink-rpm";
47
48                 interrupts = <GIC_SPI 168 IRQ_TYPE_EDGE_RISING>;
49
50                 qcom,rpm-msg-ram = <&rpm_msg_ram>;
51
52                 mboxes = <&apcs_glb 0>;
53                 mbox-names = "rpm_hlos";
54         };
55
56 Below is another example of the APCS binding on MSM8916 platforms:
57
58         apcs: mailbox@b011000 {
59                 compatible = "qcom,msm8916-apcs-kpss-global";
60                 reg = <0xb011000 0x1000>;
61                 #mbox-cells = <1>;
62                 clocks = <&a53pll>;
63                 #clock-cells = <0>;
64         };