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