Documentation/devicetree/bindings/soc/qcom/qcom,smd-rpm.yaml

   1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
   2 %YAML 1.2
   3 ---
   4 $id: "http://devicetree.org/schemas/soc/qcom/qcom,smd-rpm.yaml#"
   5 $schema: "http://devicetree.org/meta-schemas/core.yaml#"
   6
   7 title: Qualcomm Resource Power Manager (RPM) over SMD
   8
   9 description: |
  10   This driver is used to interface with the Resource Power Manager (RPM) found
  11   in various Qualcomm platforms. The RPM allows each component in the system
  12   to vote for state of the system resources, such as clocks, regulators and bus
  13   frequencies.
  14
  15   The SMD information for the RPM edge should be filled out.  See qcom,smd.txt
  16   for the required edge properties.  All SMD related properties will reside
  17   within the RPM node itself.
  18
  19   The RPM exposes resources to its subnodes.  The rpm_requests node must be
  20   present and this subnode may contain children that designate regulator
  21   resources.
  22
  23   Refer to Documentation/devicetree/bindings/regulator/qcom,smd-rpm-regulator.yaml
  24   for information on the regulator subnodes that can exist under the
  25   rpm_requests.
  26
  27 maintainers:
  28   - Kathiravan T <kathirav@codeaurora.org>
  29
  30 properties:
  31   compatible:
  32     enum:
  33       - qcom,rpm-apq8084
  34       - qcom,rpm-ipq6018
  35       - qcom,rpm-msm8226
  36       - qcom,rpm-msm8916
  37       - qcom,rpm-msm8974
  38       - qcom,rpm-msm8976
  39       - qcom,rpm-msm8996
  40       - qcom,rpm-msm8998
  41       - qcom,rpm-sdm660
  42       - qcom,rpm-sm6125
  43       - qcom,rpm-qcs404
  44
  45   qcom,smd-channels:
  46     $ref: /schemas/types.yaml#/definitions/string-array
  47     description: Channel name used for the RPM communication
  48     items:
  49       - const: rpm_requests
  50
  51 if:
  52   properties:
  53     compatible:
  54       contains:
  55         enum:
  56           - qcom,rpm-apq8084
  57           - qcom,rpm-msm8916
  58           - qcom,rpm-msm8974
  59 then:
  60   required:
  61     - qcom,smd-channels
  62
  63 required:
  64   - compatible
  65
  66 additionalProperties: false
  67
  68 examples:
  69   - |
  70     #include <dt-bindings/interrupt-controller/arm-gic.h>
  71     #include <dt-bindings/interrupt-controller/irq.h>
  72
  73     smd {
  74         compatible = "qcom,smd";
  75
  76         rpm {
  77             interrupts = <GIC_SPI 168 IRQ_TYPE_EDGE_RISING>;
  78             qcom,ipc = <&apcs 8 0>;
  79             qcom,smd-edge = <15>;
  80
  81                 rpm_requests {
  82                         compatible = "qcom,rpm-msm8974";
  83                         qcom,smd-channels = "rpm_requests";
  84
  85                         /* Regulator nodes to follow */
  86                 };
  87             };
  88      };
  89 ...