Documentation/devicetree/bindings/soc/qcom/qcom,glink.txt

   1 Qualcomm RPM GLINK binding
   2
   3 This binding describes the Qualcomm RPM GLINK, a fifo based mechanism for
   4 communication with the Resource Power Management system on various Qualcomm
   5 platforms.
   6
   7 - compatible:
   8         Usage: required
   9         Value type: <stringlist>
  10         Definition: must be "qcom,glink-rpm"
  11
  12 - interrupts:
  13         Usage: required
  14         Value type: <prop-encoded-array>
  15         Definition: should specify the IRQ used by the remote processor to
  16                     signal this processor about communication related events
  17
  18 - qcom,rpm-msg-ram:
  19         Usage: required
  20         Value type: <prop-encoded-array>
  21         Definition: handle to RPM message memory resource
  22
  23 - mboxes:
  24         Usage: required
  25         Value type: <prop-encoded-array>
  26         Definition: reference to the "rpm_hlos" mailbox in APCS, as described
  27                     in mailbox/mailbox.txt
  28
  29 = GLINK DEVICES
  30 Each subnode of the GLINK node represent function tied to a virtual
  31 communication channel. The name of the nodes are not important. The properties
  32 of these nodes are defined by the individual bindings for the specific function
  33 - but must contain the following property:
  34
  35 - qcom,glink-channels:
  36         Usage: required
  37         Value type: <stringlist>
  38         Definition: a list of channels tied to this function, used for matching
  39                     the function to a set of virtual channels
  40
  41 = EXAMPLE
  42 The following example represents the GLINK RPM node on a MSM8996 device, with
  43 the function for the "rpm_request" channel defined, which is used for
  44 regualtors and root clocks.
  45
  46         apcs_glb: mailbox@9820000 {
  47                 compatible = "qcom,msm8996-apcs-hmss-global";
  48                 reg = <0x9820000 0x1000>;
  49
  50                 #mbox-cells = <1>;
  51         };
  52
  53         rpm_msg_ram: memory@68000 {
  54                 compatible = "qcom,rpm-msg-ram";
  55                 reg = <0x68000 0x6000>;
  56         };
  57
  58         rpm-glink {
  59                 compatible = "qcom,glink-rpm";
  60
  61                 interrupts = <GIC_SPI 168 IRQ_TYPE_EDGE_RISING>;
  62
  63                 qcom,rpm-msg-ram = <&rpm_msg_ram>;
  64
  65                 mboxes = <&apcs_glb 0>;
  66
  67                 rpm-requests {
  68                         compatible = "qcom,rpm-msm8996";
  69                         qcom,glink-channels = "rpm_requests";
  70
  71                         ...
  72                 };
  73         };