Merge tag 'xfs-4.21-merge-3' of git://git.kernel.org/pub/scm/fs/xfs/xfs-linux
[sfrench/cifs-2.6.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-msm8998"
26                     "qcom,rpm-qcs404"
27
28 - qcom,smd-channels:
29         Usage: required
30         Value type: <string>
31         Definition: must be "rpm_requests"
32
33 Refer to Documentation/devicetree/bindings/regulator/qcom,smd-rpm-regulator.txt
34 for information on the regulator subnodes that can exist under the rpm_requests.
35
36 Example:
37
38         soc {
39                 apcs: syscon@f9011000 {
40                         compatible = "syscon";
41                         reg = <0xf9011000 0x1000>;
42                 };
43         };
44
45         smd {
46                 compatible = "qcom,smd";
47
48                 rpm {
49                         interrupts = <0 168 1>;
50                         qcom,ipc = <&apcs 8 0>;
51                         qcom,smd-edge = <15>;
52
53                         rpm_requests {
54                                 compatible = "qcom,rpm-msm8974";
55                                 qcom,smd-channels = "rpm_requests";
56
57                                 ...
58                         };
59                 };
60         };