Merge tag 'asoc-fix-v5.4-rc4' of https://git.kernel.org/pub/scm/linux/kernel/git...
[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                     "qcom,msm8998-apcs-hmss-global"
14                     "qcom,qcs404-apcs-apps-global"
15                     "qcom,sc7180-apss-shared"
16                     "qcom,sdm845-apss-shared"
17                     "qcom,sm8150-apss-shared"
18                     "qcom,ipq8074-apcs-apps-global"
19
20 - reg:
21         Usage: required
22         Value type: <prop-encoded-array>
23         Definition: must specify the base address and size of the global block
24 - clocks:
25         Usage: required if #clocks-cells property is present
26         Value type: <phandle>
27         Definition: phandle to the input PLL, which feeds the APCS mux/divider
28
29 - #mbox-cells:
30         Usage: required
31         Value type: <u32>
32         Definition: as described in mailbox.txt, must be 1
33
34 - #clock-cells:
35         Usage: optional
36         Value type: <u32>
37         Definition: as described in clock.txt, must be 0
38
39
40 = EXAMPLE
41 The following example describes the APCS HMSS found in MSM8996 and part of the
42 GLINK RPM referencing the "rpm_hlos" doorbell therein.
43
44         apcs_glb: mailbox@9820000 {
45                 compatible = "qcom,msm8996-apcs-hmss-global";
46                 reg = <0x9820000 0x1000>;
47
48                 #mbox-cells = <1>;
49         };
50
51         rpm-glink {
52                 compatible = "qcom,glink-rpm";
53
54                 interrupts = <GIC_SPI 168 IRQ_TYPE_EDGE_RISING>;
55
56                 qcom,rpm-msg-ram = <&rpm_msg_ram>;
57
58                 mboxes = <&apcs_glb 0>;
59                 mbox-names = "rpm_hlos";
60         };
61
62 Below is another example of the APCS binding on MSM8916 platforms:
63
64         apcs: mailbox@b011000 {
65                 compatible = "qcom,msm8916-apcs-kpss-global";
66                 reg = <0xb011000 0x1000>;
67                 #mbox-cells = <1>;
68                 clocks = <&a53pll>;
69                 #clock-cells = <0>;
70         };