Merge tag 'asoc-fix-v5.5-rc6' into asoc-5.6
[linux-2.6-microblaze.git] / Documentation / devicetree / bindings / soc / qcom / qcom,smd-rpm.txt
1 Qualcomm Resource Power Manager (RPM) over SMD
2
3 This driver is used to interface with the Resource Power Manager (RPM) found in
4 various Qualcomm platforms. The RPM allows each component in the system to vote
5 for state of the system resources, such as clocks, regulators and bus
6 frequencies.
7
8 The SMD information for the RPM edge should be filled out.  See qcom,smd.txt for
9 the required edge properties.  All SMD related properties will reside within the
10 RPM node itself.
11
12 = SUBDEVICES
13
14 The RPM exposes resources to its subnodes.  The rpm_requests node must be
15 present and this subnode may contain children that designate regulator
16 resources.
17
18 - compatible:
19         Usage: required
20         Value type: <string>
21         Definition: must be one of:
22                     "qcom,rpm-apq8084"
23                     "qcom,rpm-msm8916"
24                     "qcom,rpm-msm8974"
25                     "qcom,rpm-msm8976"
26                     "qcom,rpm-msm8998"
27                     "qcom,rpm-sdm660"
28                     "qcom,rpm-qcs404"
29
30 - qcom,smd-channels:
31         Usage: required
32         Value type: <string>
33         Definition: must be "rpm_requests"
34
35 Refer to Documentation/devicetree/bindings/regulator/qcom,smd-rpm-regulator.txt
36 for information on the regulator subnodes that can exist under the rpm_requests.
37
38 Example:
39
40         soc {
41                 apcs: syscon@f9011000 {
42                         compatible = "syscon";
43                         reg = <0xf9011000 0x1000>;
44                 };
45         };
46
47         smd {
48                 compatible = "qcom,smd";
49
50                 rpm {
51                         interrupts = <0 168 1>;
52                         qcom,ipc = <&apcs 8 0>;
53                         qcom,smd-edge = <15>;
54
55                         rpm_requests {
56                                 compatible = "qcom,rpm-msm8974";
57                                 qcom,smd-channels = "rpm_requests";
58
59                                 ...
60                         };
61                 };
62         };