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