-----Original Message-----
From: amit.kucheria at verdurent.com <redacted> On
Behalf Of Amit Kucheria
Sent: Wednesday, May 16, 2018 16:13
To: Ilia Lin <redacted>
Cc: Michael Turquette <mturquette@baylibre.com>; sboyd at kernel.org; Rob
Herring [off-list ref]; Mark Rutland [off-list ref]; Viresh
Kumar [off-list ref]; nm at ti.com; lgirdwood at gmail.com;
broonie at kernel.org; Andy Gross [off-list ref]; David Brown
[off-list ref]; catalin.marinas at arm.com;
will.deacon at arm.com; Rafael J. Wysocki [off-list ref]; linux-
clk at vger.kernel.org; devicetree at vger.kernel.org; LKML <linux-
kernel at vger.kernel.org>; Linux PM list [off-list ref]; linux-
arm-msm at vger.kernel.org; linux-soc at vger.kernel.org; lakml <linux-arm-
kernel at lists.infradead.org>; Rajendra Nayak [off-list ref];
nicolas.dechesne at linaro.org; celster at codeaurora.org;
tfinkel at codeaurora.org
Subject: Re: [PATCH v7 10/14] dt-bindings: qcom_spmi: Add support for SAW
documentation

On Tue, May 15, 2018 at 12:13 PM, Ilia Lin [off-list ref] wrote:

quoted

Add support for SAW controlled regulators.
The regulators defined as SAW controlled in the device tree will be
controlled through special CPU registers instead of direct SPMI
accesses.
This is required especially for CPU supply regulators to synchronize
with clock scaling and for Automatic Voltage Switching.
Document it.

Replace this boiler plate with what this patch actual does. Besides changing
the subject, it could be, for example,

"Document the DT bindings for the SAW regulators.

The saw-slave property allows ganging (grouping) of several regulators so
that their outputs can be combined... blah blah.

The saw-leader is the only one that then is configurable in DT"

Actually, I invested some fantasy to write this explanation. But I'll try to revise it.

quoted

Signed-off-by: Ilia Lin <redacted>
Reviewed-by: Rob Herring <robh@kernel.org>
---
 .../bindings/regulator/qcom,spmi-regulator.txt     | 45

++++++++++++++++++++++

quoted

 1 file changed, 45 insertions(+)

diff --git
a/Documentation/devicetree/bindings/regulator/qcom,spmi-regulator.txt
b/Documentation/devicetree/bindings/regulator/qcom,spmi-regulator.txt
index 57d2c65..406f2e5 100644
---
a/Documentation/devicetree/bindings/regulator/qcom,spmi-regulator.txt

+++ b/Documentation/devicetree/bindings/regulator/qcom,spmi-

regulator.

quoted

+++ txt

@@ -110,6 +110,11 @@ Qualcomm SPMI Regulators
        Definition: Reference to regulator supplying the input pin, as
                    described in the data sheet.

+- qcom,saw-reg:
+       Usage: optional
+       Value type: <phandle>
+       Description: Reference to syscon node defining the SAW registers.
+

 The regulator node houses sub-nodes for each regulator within the

device. Each  sub-node is identified using the node's name, with valid
values listed for each @@ -201,6 +206,17 @@ see regulator.txt - with

additional custom properties described below:

quoted

                        2 = 0.55 uA
                        3 = 0.75 uA

+- qcom,saw-slave:
+       Usage: optional
+       Value type: <boo>
+       Description: SAW controlled gang slave. Will not be configured.
+
+- qcom,saw-leader:
+       Usage: optional
+       Value type: <boo>
+       Description: SAW controlled gang leader. Will be configured as
+                    SAW regulator.
+
 Example:

        regulators {

@@ -221,3 +237,32 @@ Example:

                ....
        };
+
+Example 2:
+
+       saw3: syscon at 9A10000 {
+               compatible = "syscon";
+               reg = <0x9A10000 0x1000>;
+       };
+
+       ...
+
+       spm-regulators {
+               compatible = "qcom,pm8994-regulators";
+               qcom,saw-reg = <&saw3>;
+               s8 {
+                       qcom,saw-slave;
+               };
+               s9 {
+                       qcom,saw-slave;
+               };
+               s10 {
+                       qcom,saw-slave;
+               };
+               pm8994_s11_saw: s11 {
+                       qcom,saw-leader;
+                       regulator-always-on;
+                       regulator-min-microvolt = <900000>;
+                       regulator-max-microvolt = <1140000>;
+               };
+       };
--

1.9.1