GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / devicetree / bindings / regulator / qcom,smd-rpm-regulator.yaml
1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/regulator/qcom,smd-rpm-regulator.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: QCOM SMD RPM REGULATOR
8
9 description:
10   The Qualcomm RPM over SMD regulator is modelled as a subdevice of the RPM.
11   Because SMD is used as the communication transport mechanism, the RPM
12   resides as a subnode of the SMD.  As such, the SMD-RPM regulator requires
13   that the SMD and RPM nodes be present.
14
15   Please refer to Documentation/devicetree/bindings/soc/qcom/qcom,smd.yaml for
16   information pertaining to the SMD node.
17
18   Please refer to Documentation/devicetree/bindings/soc/qcom/qcom,smd-rpm.yaml
19   for information regarding the RPM node.
20
21   The regulator node houses sub-nodes for each regulator within the device.
22   Each sub-node is identified using the node's name, with valid values listed
23   for each of the pmics below.
24
25   For mp5496, s2
26
27   For pm2250, s1, s2, s3, s4, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11,
28   l12, l13, l14, l15, l16, l17, l18, l19, l20, l21, l22
29
30   For pm6125 s1, s2, s3, s4, s5, s6, s7, s8, l1, l2, l3, l5, l6, l7, l8, l9,
31   l10, l22, l12, l13, l14, l15, l16, l17, l18, l19, l20, l21, l22, l23, l24
32
33   For pm660, s1, s2, s3, s4, s5, s6, l1, l2, l3, l5, l6, l7, l8, l9, l10, l22,
34   l12, l13, l14, l15, l16, l17, l18, l19
35
36   For pm660l s1, s2, s3, s5, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, bob
37
38   For pm8226, s1, s2, s3, s4, s5, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10,
39   l11, l12, l13, l14, l15, l16, l17, l18, l19, l20, l21, l22, l23, l24, l25,
40   l26, l27, l28, lvs1
41
42   For pm8841, s1, s2, s3, s4, s5, s6, s7, s8
43
44   For pm8909, s1, s2, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13,
45   l14, l15, l17, l18
46
47   For pm8916, s1, s2, s3, s4, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11,
48   l12, l13, l14, l15, l16, l17, l18
49
50   For pm8941, s1, s2, s3, s4, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11,
51   l12, l13, l14, l15, l16, l17, l18, l19, l20, l21, l22, l23, l24, lvs1, lvs2,
52   lvs3, 5vs1, 5vs2
53
54   For pm8950 and pm8953, s1, s2, s3, s4, s5, s6, s7, l1, l2, l3, l4, l5, l6,
55   l7, l8, l9, l10, l11, l12, l13, l14, l15, l16, l17, l18, l19, l20, l21, l22,
56   l23
57
58   For pm8994, s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, l1, l2, l3,
59   l4, l5, l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16, l17, l18, l19,
60   l20, l21, l22, l23, l24, l25, l26, l27, l28, l29, l30, l31, l32, lvs1, lvs2
61
62   For pm8998, s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, s13, l1, l2,
63   l3, l4, l5, l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16, l17, l18, l19,
64   l20, l21, l22, l23, l24, l25, l26, l27, l28, lvs1, lvs2
65
66   For pma8084, s1, s2, s3, s4, s5, s6, s7, s8, s9, s10, s11, s12, l1, l2, l3,
67   l4, l5, l6, l7, l8, l9, l10, l11, l12, l13, l14, l15, l16, l17, l18, l19,
68   l20, l21, l22, l23, l24, l25, l26, l27, lvs1, lvs2, lvs3, lvs4, 5vs1
69
70   For pmi8994, s1, s2, s3, boost-bypass
71
72   For pmi8998, bob
73
74   For pms405, s1, s2, s3, s4, s5, l1, l2, l3, l4, l5, l6, l7, l8, l9, l10, l11,
75   l12, l13
76
77 maintainers:
78   - Andy Gross <agross@kernel.org>
79   - Bjorn Andersson <bjorn.andersson@linaro.org>
80
81 properties:
82   compatible:
83     enum:
84       - qcom,rpm-mp5496-regulators
85       - qcom,rpm-pm2250-regulators
86       - qcom,rpm-pm6125-regulators
87       - qcom,rpm-pm660-regulators
88       - qcom,rpm-pm660l-regulators
89       - qcom,rpm-pm8226-regulators
90       - qcom,rpm-pm8841-regulators
91       - qcom,rpm-pm8909-regulators
92       - qcom,rpm-pm8916-regulators
93       - qcom,rpm-pm8941-regulators
94       - qcom,rpm-pm8950-regulators
95       - qcom,rpm-pm8953-regulators
96       - qcom,rpm-pm8994-regulators
97       - qcom,rpm-pm8998-regulators
98       - qcom,rpm-pma8084-regulators
99       - qcom,rpm-pmi8994-regulators
100       - qcom,rpm-pmi8998-regulators
101       - qcom,rpm-pms405-regulators
102
103 patternProperties:
104   ".*-supply$":
105     description: Input supply phandle(s) for this node
106
107   "^((s|l|lvs|5vs)[0-9]*)|(boost-bypass)|(bob)$":
108     description: List of regulators and its properties
109     $ref: regulator.yaml#
110
111 additionalProperties: false
112
113 required:
114   - compatible
115
116 examples:
117   - |
118     pm8941-regulators {
119         compatible = "qcom,rpm-pm8941-regulators";
120         vdd_l13_l20_l23_l24-supply = <&pm8941_boost>;
121
122         pm8941_s3: s3 {
123             regulator-min-microvolt = <1800000>;
124             regulator-max-microvolt = <1800000>;
125         };
126
127         pm8941_boost: s4 {
128             regulator-min-microvolt = <5000000>;
129             regulator-max-microvolt = <5000000>;
130         };
131
132         pm8941_l20: l20 {
133             regulator-min-microvolt = <2950000>;
134             regulator-max-microvolt = <2950000>;
135         };
136     };
137 ...