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

[PATCH v2] 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>
---
Changes for v2:
- replace node name lm87 with sensor
- replace character '\t' with spaces

 .../devicetree/bindings/hwmon/lm87.txt        | 30 ----------
 .../devicetree/bindings/hwmon/lm87.yaml       | 59 +++++++++++++++++++
 2 files changed, 59 insertions(+), 30 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/hwmon/lm87.txt
 create mode 100644 Documentation/devicetree/bindings/hwmon/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/lm87.yaml b/Documentation/devicetree/bindings/hwmon/lm87.yaml
new file mode 100644
index 000000000000..8f4f07845d95
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/lm87.yaml
@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/hwmon/lm87.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: LM87 hwmon sensor
+
+maintainers:
+  - Jean Delvare <jdelvare@suse.com>
+  - Guenter Roeck <linux@roeck-us.net>
+
+properties:
+  compatible:
+    const: ti,lm87
+
+  reg:
+    maxItems: 1
+
+  has-temp3:
+    description: |
+      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:
+    description: |
+      When set, pin 5 is configured to be used as voltage input in6.
+      Otherwise the pin is set as FAN1 input.
+
+  has-in7:
+    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 v2] dt-bindings: hwmon: lm87: convert to YAML

[Rob Herring]

On Thu, 26 Oct 2023 16:02:26 +0800, Li peiyu wrote:
> Convert the lm87 hwmon sensor bindings to DT schema
> 
> Signed-off-by: Li peiyu <579lpy@gmail.com>
> ---
> Changes for v2:
> - replace node name lm87 with sensor
> - replace character '\t' with spaces
> 
>  .../devicetree/bindings/hwmon/lm87.txt        | 30 ----------
>  .../devicetree/bindings/hwmon/lm87.yaml       | 59 +++++++++++++++++++
>  2 files changed, 59 insertions(+), 30 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/hwmon/lm87.txt
>  create mode 100644 Documentation/devicetree/bindings/hwmon/lm87.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/hwmon/lm87.yaml: has-temp3: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/hwmon/lm87.yaml: has-in6: missing type definition
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/hwmon/lm87.yaml: has-in7: missing type definition

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20231026080226.52170-1-579lpy@gmail.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.

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

[Krzysztof Kozlowski]

On 26/10/2023 10:02, Li peiyu wrote:
> Convert the lm87 hwmon sensor bindings to DT schema
> 
> Signed-off-by: Li peiyu <579lpy@gmail.com>
> ---
> Changes for v2:
> - replace node name lm87 with sensor
> - replace character '\t' with spaces
> 
>  .../devicetree/bindings/hwmon/lm87.txt        | 30 ----------
>  .../devicetree/bindings/hwmon/lm87.yaml       | 59 +++++++++++++++++++

...

> -- 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/lm87.yaml b/Documentation/devicetree/bindings/hwmon/lm87.yaml
> new file mode 100644
> index 000000000000..8f4f07845d95
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/lm87.yaml

This is a friendly reminder during the review process.

It seems my previous comments were not fully addressed. Maybe my
feedback got lost between the quotes, maybe you just forgot to apply it.
Please go back to the previous discussion and either implement all
requested changes or keep discussing them.

Thank you.

> @@ -0,0 +1,59 @@

It does not look like you tested the bindings, at least after quick
look. Please run `make dt_binding_check` (see
Documentation/devicetree/bindings/writing-schema.rst for instructions).
Maybe you need to update your dtschema and yamllint.


Best regards,
Krzysztof

[PATCH v3] 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>
---
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/lm87.yaml       | 62 +++++++++++++++++++
 2 files changed, 62 insertions(+), 30 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/hwmon/lm87.txt
 create mode 100644 Documentation/devicetree/bindings/hwmon/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/lm87.yaml b/Documentation/devicetree/bindings/hwmon/lm87.yaml
new file mode 100644
index 000000000000..587191c663d3
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/lm87.yaml
@@ -0,0 +1,62 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/hwmon/lm87.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: LM87 hwmon sensor
+
+maintainers:
+  - Jean Delvare <jdelvare@suse.com>
+  - Guenter Roeck <linux@roeck-us.net>
+
+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 v3] dt-bindings: hwmon: lm87: convert to YAML

[Krzysztof Kozlowski]

On 28/10/2023 10:20, Li peiyu wrote:
> Convert the lm87 hwmon sensor bindings to DT schema
> 
> Signed-off-by: Li peiyu <579lpy@gmail.com>
> ---
> 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/lm87.yaml       | 62 +++++++++++++++++++

Nothing improved.

Stop ignoring feedback. You must respond to it or implement it.

Best regards,
Krzysztof

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

[peiyu li]

>
> On 28/10/2023 10:20, Li peiyu wrote:
> > Convert the lm87 hwmon sensor bindings to DT schema
> >
> > Signed-off-by: Li peiyu <579lpy@gmail.com>
> > ---
> > 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/lm87.yaml       | 62 +++++++++++++++++++
>
> Nothing improved.
>
> Stop ignoring feedback. You must respond to it or implement it.
>
> Best regards,
> Krzysztof
>
I'm so sorry for that.For v3 I just run make dt_binding_check and forget to
run checkpatch.pl,resulting in not finding an extra space.Now running the
dt_binding_check on my computer will cause an error regarding the
ti,ds90ub960.yaml
file when I specify the file to be checked as lm87.yaml. This error will occur
even if I specify other files, I am not sure if it will have an
impact.I'll submit
v4.If there are still issues,please tell me the reason again.Sorry again.

Thanks,
Li peiyu

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

[Krzysztof Kozlowski]

On 28/10/2023 13:59, peiyu li wrote:
>>
>> On 28/10/2023 10:20, Li peiyu wrote:
>>> Convert the lm87 hwmon sensor bindings to DT schema
>>>
>>> Signed-off-by: Li peiyu <579lpy@gmail.com>
>>> ---
>>> 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/lm87.yaml       | 62 +++++++++++++++++++
>>
>> Nothing improved.
>>
>> Stop ignoring feedback. You must respond to it or implement it.
>>
>> Best regards,
>> Krzysztof
>>
> I'm so sorry for that.For v3 I just run make dt_binding_check and forget to

You even removed my address when replying this!

> run checkpatch.pl,resulting in not finding an extra space.Now running the
> dt_binding_check on my computer will cause an error regarding the
> ti,ds90ub960.yaml
> file when I specify the file to be checked as lm87.yaml. This error will occur
> even if I specify other files, I am not sure if it will have an
> impact.I'll submit
> v4.If there are still issues,please tell me the reason again.Sorry again.


v4 did not improve. Please explain me carefully how did you implement
these two feedbacks from first version, so 25th of Oct:

> Please use scripts/get_maintainers.pl to get a list of necessary
people and lists to CC.

> Also, please use filename like compatible.

Best regards,
Krzysztof

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

[peiyu li]

On Sat, Oct 28, 2023 at 10:58 PM Krzysztof Kozlowski <krzk@kernel.org> wrote:
> You even removed my address when replying this!
>
> > run checkpatch.pl,resulting in not finding an extra space.Now running the
> > dt_binding_check on my computer will cause an error regarding the
> > ti,ds90ub960.yaml
> > file when I specify the file to be checked as lm87.yaml. This error will occur
> > even if I specify other files, I am not sure if it will have an
> > impact.I'll submit
> > v4.If there are still issues,please tell me the reason again.Sorry again.
>
>
> v4 did not improve. Please explain me carefully how did you implement
> these two feedbacks from first version, so 25th of Oct:
>
> > Please use scripts/get_maintainers.pl to get a list of necessary
> people and lists to CC.
>

I will send the next patch to all necessary people and cc all necessary lists.

> > Also, please use filename like compatible.
>

In the next version I will change the file name to "ti,lm87.yaml",
which is the same as "compatible".

> Best regards,
> Krzysztof
>

Thanks,
Li peiyu