[PATCH v2 1/1] dt-bindings: hwmon/regulator: Convert ltc2978.txt to yaml

[PATCH v2 1/1] dt-bindings: hwmon/regulator: Convert ltc2978.txt to yaml

[Frank Li]

Convert binding doc ltc2978.txt to yaml format.
Additional change:
- add i2c node.
- basic it is regulator according to example, move it under regulator.

Fix below warning:
arch/arm64/boot/dts/freescale/fsl-lx2160a-clearfog-cx.dtb: /soc/i2c@2000000/i2c-mux@77/i2c@2/regulator@5c:
	failed to match any schema with compatible: ['lltc,ltc3882']

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
change from v1 to v2
- maintainer change to Mark Brown <broonie@kernel.org> (regulator maintainer)
- update title to (from ltc2978 data sheet).
octal, digital power-supply monitor, supervisor, sequencer, and margin controller.
---
 .../devicetree/bindings/hwmon/ltc2978.txt     | 62 ------------
 .../bindings/regulator/lltc,ltc2972.yaml      | 94 +++++++++++++++++++
 2 files changed, 94 insertions(+), 62 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/hwmon/ltc2978.txt
 create mode 100644 Documentation/devicetree/bindings/regulator/lltc,ltc2972.yaml

diff --git a/Documentation/devicetree/bindings/hwmon/ltc2978.txt b/Documentation/devicetree/bindings/hwmon/ltc2978.txt
deleted file mode 100644
index 4e7f6215a4533..0000000000000
--- a/Documentation/devicetree/bindings/hwmon/ltc2978.txt
+++ /dev/null
@@ -1,62 +0,0 @@
-ltc2978
-
-Required properties:
-- compatible: should contain one of:
-  * "lltc,ltc2972"
-  * "lltc,ltc2974"
-  * "lltc,ltc2975"
-  * "lltc,ltc2977"
-  * "lltc,ltc2978"
-  * "lltc,ltc2979"
-  * "lltc,ltc2980"
-  * "lltc,ltc3880"
-  * "lltc,ltc3882"
-  * "lltc,ltc3883"
-  * "lltc,ltc3884"
-  * "lltc,ltc3886"
-  * "lltc,ltc3887"
-  * "lltc,ltc3889"
-  * "lltc,ltc7880"
-  * "lltc,ltm2987"
-  * "lltc,ltm4664"
-  * "lltc,ltm4675"
-  * "lltc,ltm4676"
-  * "lltc,ltm4677"
-  * "lltc,ltm4678"
-  * "lltc,ltm4680"
-  * "lltc,ltm4686"
-  * "lltc,ltm4700"
-- reg: I2C slave address
-
-Optional properties:
-- regulators: A node that houses a sub-node for each regulator controlled by
-  the device. Each sub-node is identified using the node's name, with valid
-  values listed below. The content of each sub-node is defined by the
-  standard binding for regulators; see regulator.txt.
-
-Valid names of regulators depend on number of supplies supported per device:
-  * ltc2972 vout0 - vout1
-  * ltc2974, ltc2975 : vout0 - vout3
-  * ltc2977, ltc2979, ltc2980, ltm2987 : vout0 - vout7
-  * ltc2978 : vout0 - vout7
-  * ltc3880, ltc3882, ltc3884, ltc3886, ltc3887, ltc3889 : vout0 - vout1
-  * ltc7880 : vout0 - vout1
-  * ltc3883 : vout0
-  * ltm4664 : vout0 - vout1
-  * ltm4675, ltm4676, ltm4677, ltm4678 : vout0 - vout1
-  * ltm4680, ltm4686 : vout0 - vout1
-  * ltm4700 : vout0 - vout1
-
-Example:
-ltc2978@5e {
-	compatible = "lltc,ltc2978";
-	reg = <0x5e>;
-	regulators {
-		vout0 {
-			regulator-name = "FPGA-2.5V";
-		};
-		vout2 {
-			regulator-name = "FPGA-1.5V";
-		};
-	};
-};
diff --git a/Documentation/devicetree/bindings/regulator/lltc,ltc2972.yaml b/Documentation/devicetree/bindings/regulator/lltc,ltc2972.yaml
new file mode 100644
index 0000000000000..712f70da64a55
--- /dev/null
+++ b/Documentation/devicetree/bindings/regulator/lltc,ltc2972.yaml
@@ -0,0 +1,94 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/regulator/lltc,ltc2972.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Octal Digital Power-supply monitor/supervisor/sequencer/margin controller.
+
+maintainers:
+  - Mark Brown <broonie@kernel.org>
+
+properties:
+  compatible:
+    enum:
+      - lltc,ltc2972
+      - lltc,ltc2974
+      - lltc,ltc2975
+      - lltc,ltc2977
+      - lltc,ltc2978
+      - lltc,ltc2979
+      - lltc,ltc2980
+      - lltc,ltc3880
+      - lltc,ltc3882
+      - lltc,ltc3883
+      - lltc,ltc3884
+      - lltc,ltc3886
+      - lltc,ltc3887
+      - lltc,ltc3889
+      - lltc,ltc7880
+      - lltc,ltm2987
+      - lltc,ltm4664
+      - lltc,ltm4675
+      - lltc,ltm4676
+      - lltc,ltm4677
+      - lltc,ltm4678
+      - lltc,ltm4680
+      - lltc,ltm4686
+      - lltc,ltm4700
+
+  reg:
+    maxItems: 1
+
+  regulators:
+    type: object
+    description: |
+      list of regulators provided by this controller.
+      Valid names of regulators depend on number of supplies supported per device:
+      * ltc2972 vout0 - vout1
+      * ltc2974, ltc2975 : vout0 - vout3
+      * ltc2977, ltc2979, ltc2980, ltm2987 : vout0 - vout7
+      * ltc2978 : vout0 - vout7
+      * ltc3880, ltc3882, ltc3884, ltc3886, ltc3887, ltc3889 : vout0 - vout1
+      * ltc7880 : vout0 - vout1
+      * ltc3883 : vout0
+      * ltm4664 : vout0 - vout1
+      * ltm4675, ltm4676, ltm4677, ltm4678 : vout0 - vout1
+      * ltm4680, ltm4686 : vout0 - vout1
+      * ltm4700 : vout0 - vout1
+
+    patternProperties:
+      "^vout[0-7]$":
+        $ref: regulator.yaml#
+        type: object
+        unevaluatedProperties: false
+
+    additionalProperties: false
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        regulator@5e {
+            compatible = "lltc,ltc2978";
+            reg = <0x5e>;
+
+            regulators {
+                vout0 {
+                     regulator-name = "FPGA-2.5V";
+                };
+                vout2 {
+                     regulator-name = "FPGA-1.5V";
+                };
+            };
+        };
+    };
+
-- 
2.34.1

Re: [PATCH v2 1/1] dt-bindings: hwmon/regulator: Convert ltc2978.txt to yaml

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 379 bytes --]

On Mon, Aug 19, 2024 at 03:06:51PM -0400, Frank Li wrote:

> change from v1 to v2
> - maintainer change to Mark Brown <broonie@kernel.org> (regulator maintainer)

I also shouldn't be the maintainer for this specific binding, it should
be someone with knowledge of the devices.  This is a requirement imposed
by the DT people, I'd be happy to just not list a specific maintainer.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH v2 1/1] dt-bindings: hwmon/regulator: Convert ltc2978.txt to yaml

[Frank Li]

On Mon, Aug 19, 2024 at 08:11:46PM +0100, Mark Brown wrote:
> On Mon, Aug 19, 2024 at 03:06:51PM -0400, Frank Li wrote:
>
> > change from v1 to v2
> > - maintainer change to Mark Brown <broonie@kernel.org> (regulator maintainer)
>
> I also shouldn't be the maintainer for this specific binding, it should
> be someone with knowledge of the devices.  This is a requirement imposed
> by the DT people, I'd be happy to just not list a specific maintainer.

I remember 'maintainer' is required property for yaml.
Look like Guenter Roeck contribute many code for this driver.

Frank

Re: [PATCH v2 1/1] dt-bindings: hwmon/regulator: Convert ltc2978.txt to yaml

[Guenter Roeck]

On Mon, Aug 19, 2024 at 03:39:38PM -0400, Frank Li wrote:
> On Mon, Aug 19, 2024 at 08:11:46PM +0100, Mark Brown wrote:
> > On Mon, Aug 19, 2024 at 03:06:51PM -0400, Frank Li wrote:
> >
> > > change from v1 to v2
> > > - maintainer change to Mark Brown <broonie@kernel.org> (regulator maintainer)
> >
> > I also shouldn't be the maintainer for this specific binding, it should
> > be someone with knowledge of the devices.  This is a requirement imposed
> > by the DT people, I'd be happy to just not list a specific maintainer.
> 
> I remember 'maintainer' is required property for yaml.
> Look like Guenter Roeck contribute many code for this driver.
> 

Yes, but I do not maintain code or documentation outside the hardware
monitoring or watchdog subsystems. You want this file attached to the
regulator subsystem, so you'll have to find a maintainer from that
subsystem or sign up to maintain it yourself.

Guenter

Re: [PATCH v2 1/1] dt-bindings: hwmon/regulator: Convert ltc2978.txt to yaml

[Frank Li]

On Mon, Aug 19, 2024 at 02:37:00PM -0700, Guenter Roeck wrote:
> On Mon, Aug 19, 2024 at 03:39:38PM -0400, Frank Li wrote:
> > On Mon, Aug 19, 2024 at 08:11:46PM +0100, Mark Brown wrote:
> > > On Mon, Aug 19, 2024 at 03:06:51PM -0400, Frank Li wrote:
> > >
> > > > change from v1 to v2
> > > > - maintainer change to Mark Brown <broonie@kernel.org> (regulator maintainer)
> > >
> > > I also shouldn't be the maintainer for this specific binding, it should
> > > be someone with knowledge of the devices.  This is a requirement imposed
> > > by the DT people, I'd be happy to just not list a specific maintainer.
> >
> > I remember 'maintainer' is required property for yaml.
> > Look like Guenter Roeck contribute many code for this driver.
> >
>
> Yes, but I do not maintain code or documentation outside the hardware
> monitoring or watchdog subsystems. You want this file attached to the
> regulator subsystem, so you'll have to find a maintainer from that
> subsystem or sign up to maintain it yourself.

How about just leave in origial place? I think you are more familar than
me about this controller!

Frank

>
> Guenter

Re: [PATCH v2 1/1] dt-bindings: hwmon/regulator: Convert ltc2978.txt to yaml

[Guenter Roeck]

On 8/19/24 14:45, Frank Li wrote:
> On Mon, Aug 19, 2024 at 02:37:00PM -0700, Guenter Roeck wrote:
>> On Mon, Aug 19, 2024 at 03:39:38PM -0400, Frank Li wrote:
>>> On Mon, Aug 19, 2024 at 08:11:46PM +0100, Mark Brown wrote:
>>>> On Mon, Aug 19, 2024 at 03:06:51PM -0400, Frank Li wrote:
>>>>
>>>>> change from v1 to v2
>>>>> - maintainer change to Mark Brown <broonie@kernel.org> (regulator maintainer)
>>>>
>>>> I also shouldn't be the maintainer for this specific binding, it should
>>>> be someone with knowledge of the devices.  This is a requirement imposed
>>>> by the DT people, I'd be happy to just not list a specific maintainer.
>>>
>>> I remember 'maintainer' is required property for yaml.
>>> Look like Guenter Roeck contribute many code for this driver.
>>>
>>
>> Yes, but I do not maintain code or documentation outside the hardware
>> monitoring or watchdog subsystems. You want this file attached to the
>> regulator subsystem, so you'll have to find a maintainer from that
>> subsystem or sign up to maintain it yourself.
> 
> How about just leave in origial place? I think you are more familar than
> me about this controller!
> 

I really do not want to be involved in this discussion any further.
You insisted in moving the file, so you should be willing to bear
the consequences (meaning: add yourself as maintainer), or at least
find someone who does. Please keep in mind that the maintainer will have
to coordinate future patch series if changes to both the devicetree
property descriptions and to the driver are needed.

Guenter