[PATCH v5] dt-bindings: hwmon: lm87: convert to YAML

[PATCH v5] dt-bindings: hwmon: lm87: convert to YAML

[Li peiyu]

Convert the lm87 hwmon sensor bindings to DT schema

Signed-off-by: Li peiyu <579lpy@gmail.com>
---
Change for v5:
- Change the file name to "ti,lm87.yaml"
- Add maintainers get by get_maintainers.pl
Changes for v4:
- remove excess spaces
Changes for v3:
- add type definition of has-temp3, has-in6, has-in7
- Change the description of has-temp3
Changes for v2:
- replace node name lm87 with sensor
- replace character '\t' with spaces

 .../devicetree/bindings/hwmon/lm87.txt        | 30 ---------
 .../devicetree/bindings/hwmon/ti,lm87.yaml    | 63 +++++++++++++++++++
 2 files changed, 63 insertions(+), 30 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/hwmon/lm87.txt
 create mode 100644 Documentation/devicetree/bindings/hwmon/ti,lm87.yaml

diff --git a/Documentation/devicetree/bindings/hwmon/lm87.txt b/Documentation/devicetree/bindings/hwmon/lm87.txt
deleted file mode 100644
index 758ff398b67b..000000000000
--- a/Documentation/devicetree/bindings/hwmon/lm87.txt
+++ /dev/null
@@ -1,30 +0,0 @@
-*LM87 hwmon sensor.
-
-Required properties:
-- compatible: Should be
-	"ti,lm87"
-
-- reg: I2C address
-
-optional properties:
-- has-temp3: This configures pins 18 and 19 to be used as a second
-             remote temperature sensing channel. By default the pins
-             are configured as voltage input pins in0 and in5.
-
-- has-in6: When set, pin 5 is configured to be used as voltage input
-           in6. Otherwise the pin is set as FAN1 input.
-
-- has-in7: When set, pin 6 is configured to be used as voltage input
-           in7. Otherwise the pin is set as FAN2 input.
-
-- vcc-supply: a Phandle for the regulator supplying power, can be
-              configured to measure 5.0V power supply. Default is 3.3V.
-
-Example:
-
-lm87@2e {
-	compatible = "ti,lm87";
-	reg = <0x2e>;
-	has-temp3;
-	vcc-supply = <&reg_5v0>;
-};
diff --git a/Documentation/devicetree/bindings/hwmon/ti,lm87.yaml b/Documentation/devicetree/bindings/hwmon/ti,lm87.yaml
new file mode 100644
index 000000000000..6dadf181c9a6
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/ti,lm87.yaml
@@ -0,0 +1,63 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/hwmon/ti,lm87.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: LM87 hwmon sensor
+
+maintainers:
+  - Jean Delvare <jdelvare@suse.com>
+  - Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
+  - Rob Herring <robh+dt@kernel.org>
+
+properties:
+  compatible:
+    const: ti,lm87
+
+  reg:
+    maxItems: 1
+
+  has-temp3:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      When set, pins 18 and 19 are configured to be used as a second
+      remote temperature sensing channel. Otherwise the pins are
+      configured as voltage input pins in0 and in5.
+
+  has-in6:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      When set, pin 5 is configured to be used as voltage input in6.
+      Otherwise the pin is set as FAN1 input.
+
+  has-in7:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+      When set, pin 6 is configured to be used as voltage input in7.
+      Otherwise the pin is set as FAN2 input.
+
+  vcc-supply:
+    description: |
+      A Phandle for the regulator supplying power, can be configured to
+      measure 5.0V power supply. Default is 3.3V.
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      sensor@2e {
+        compatible = "ti,lm87";
+        reg = <0x2e>;
+        has-temp3;
+        vcc-supply = <&reg_5v0>;
+      };
+    };
-- 
2.34.1

Re: [PATCH v5] dt-bindings: hwmon: lm87: convert to YAML

[Krzysztof Kozlowski]

On 30/10/2023 13:52, Li peiyu wrote:
> Convert the lm87 hwmon sensor bindings to DT schema
> 
> Signed-off-by: Li peiyu <579lpy@gmail.com>
> ---
> Change for v5:
> - Change the file name to "ti,lm87.yaml"
> - Add maintainers get by get_maintainers.pl

Thank you for your patch. There is something to discuss/improve.

...

> diff --git a/Documentation/devicetree/bindings/hwmon/ti,lm87.yaml b/Documentation/devicetree/bindings/hwmon/ti,lm87.yaml
> new file mode 100644
> index 000000000000..6dadf181c9a6
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/ti,lm87.yaml
> @@ -0,0 +1,63 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/hwmon/ti,lm87.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: LM87 hwmon sensor
> +
> +maintainers:
> +  - Jean Delvare <jdelvare@suse.com>
> +  - Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>
> +  - Rob Herring <robh+dt@kernel.org>

Please drop last two entries. We do not maintain this file. This should
be someone interested in the device, like driver maintainer or recent
contributor. As last resort, you can put there subsystem maintainer if
he is okay with this.

> +
> +properties:
> +  compatible:
> +    const: ti,lm87
> +
> +  reg:
> +    maxItems: 1
> +
> +  has-temp3:
> +    $ref: /schemas/types.yaml#/definitions/flag
> +    description: |

Do not need '|' unless you need to preserve formatting.

> +      When set, pins 18 and 19 are configured to be used as a second
> +      remote temperature sensing channel. Otherwise the pins are
> +      configured as voltage input pins in0 and in5.
> +
> +  has-in6:
> +    $ref: /schemas/types.yaml#/definitions/flag
> +    description: |

Do not need '|' unless you need to preserve formatting.

> +      When set, pin 5 is configured to be used as voltage input in6.
> +      Otherwise the pin is set as FAN1 input.
> +
> +  has-in7:
> +    $ref: /schemas/types.yaml#/definitions/flag
> +    description: |

Do not need '|' unless you need to preserve formatting.

> +      When set, pin 6 is configured to be used as voltage input in7.
> +      Otherwise the pin is set as FAN2 input.
> +
> +  vcc-supply:
> +    description: |
> +      A Phandle for the regulator supplying power, can be configured to

Drop "A Phandle for the"

> +      measure 5.0V power supply. Default is 3.3V.
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +

Rest looks good.

Best regards,
Krzysztof