diff mbox series

[v2,04/11] dt-bindings: thermal: Convert da906{1,2} thermal to json-schema

Message ID 20231202192536.266885-5-biju.das.jz@bp.renesas.com (mailing list archive)
State New, archived
Delegated to: Daniel Lezcano
Headers show
Series Convert DA906{1,2} bindings to json-schema | expand

Commit Message

Biju Das Dec. 2, 2023, 7:25 p.m. UTC
Convert the da906{1,2} thermal device tree binding documentation to
json-schema.

Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
---
 .../bindings/thermal/da9062-thermal.txt       | 36 ------------
 .../bindings/thermal/dlg,da9062-thermal.yaml  | 58 +++++++++++++++++++
 2 files changed, 58 insertions(+), 36 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/thermal/da9062-thermal.txt
 create mode 100644 Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yaml

Comments

Rob Herring (Arm) Dec. 2, 2023, 9:39 p.m. UTC | #1
On Sat, 02 Dec 2023 19:25:28 +0000, Biju Das wrote:
> Convert the da906{1,2} thermal device tree binding documentation to
> json-schema.
> 
> Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
> ---
>  .../bindings/thermal/da9062-thermal.txt       | 36 ------------
>  .../bindings/thermal/dlg,da9062-thermal.yaml  | 58 +++++++++++++++++++
>  2 files changed, 58 insertions(+), 36 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/thermal/da9062-thermal.txt
>  create mode 100644 Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.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:
Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.example.dtb: /example-0/i2c/pmic@58: failed to match any schema with compatible: ['dlg,da9062']

doc reference errors (make refcheckdocs):
Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/thermal/da90??-thermal.txt
MAINTAINERS: Documentation/devicetree/bindings/thermal/da90??-thermal.txt

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20231202192536.266885-5-biju.das.jz@bp.renesas.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.
Biju Das Dec. 3, 2023, 10:07 a.m. UTC | #2
Hi Rob Herring,

Thanks for the feedback,

> Subject: Re: [PATCH v2 04/11] dt-bindings: thermal: Convert da906{1,2}
> thermal to json-schema
> 
> 
> On Sat, 02 Dec 2023 19:25:28 +0000, Biju Das wrote:
> > Convert the da906{1,2} thermal device tree binding documentation to
> > json-schema.
> >
> > Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
> > ---
> >  .../bindings/thermal/da9062-thermal.txt       | 36 ------------
> >  .../bindings/thermal/dlg,da9062-thermal.yaml  | 58
> > +++++++++++++++++++
> >  2 files changed, 58 insertions(+), 36 deletions(-)  delete mode
> > 100644 Documentation/devicetree/bindings/thermal/da9062-thermal.txt
> >  create mode 100644
> > Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.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:
> Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.example.dtb:
> /example-0/i2c/pmic@58: failed to match any schema with compatible:
> ['dlg,da9062']

Looks validation is not checking compatible defines in the mfd/da9062.txt file. 
So will merge this patch with patch #11 to fix this error.

> 
> doc reference errors (make refcheckdocs):
> Warning: MAINTAINERS references a file that doesn't exist:
> Documentation/devicetree/bindings/thermal/da90??-thermal.txt
> MAINTAINERS: Documentation/devicetree/bindings/thermal/da90??-thermal.txt

Also, will fix the MAINTAINERS entry.

Cheers,
Biju
Rob Herring (Arm) Dec. 4, 2023, 3:09 p.m. UTC | #3
On Sun, Dec 03, 2023 at 10:07:19AM +0000, Biju Das wrote:
> Hi Rob Herring,
> 
> Thanks for the feedback,
> 
> > Subject: Re: [PATCH v2 04/11] dt-bindings: thermal: Convert da906{1,2}
> > thermal to json-schema
> > 
> > 
> > On Sat, 02 Dec 2023 19:25:28 +0000, Biju Das wrote:
> > > Convert the da906{1,2} thermal device tree binding documentation to
> > > json-schema.
> > >
> > > Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
> > > ---
> > >  .../bindings/thermal/da9062-thermal.txt       | 36 ------------
> > >  .../bindings/thermal/dlg,da9062-thermal.yaml  | 58
> > > +++++++++++++++++++
> > >  2 files changed, 58 insertions(+), 36 deletions(-)  delete mode
> > > 100644 Documentation/devicetree/bindings/thermal/da9062-thermal.txt
> > >  create mode 100644
> > > Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.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:
> > Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.example.dtb:
> > /example-0/i2c/pmic@58: failed to match any schema with compatible:
> > ['dlg,da9062']
> 
> Looks validation is not checking compatible defines in the mfd/da9062.txt file. 
> So will merge this patch with patch #11 to fix this error.

No need to merge it. Just note below the '---' the warning is expected.

Rob
Rob Herring (Arm) Dec. 4, 2023, 3:13 p.m. UTC | #4
On Sat, Dec 02, 2023 at 07:25:28PM +0000, Biju Das wrote:
> Convert the da906{1,2} thermal device tree binding documentation to
> json-schema.
> 
> Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
> ---
>  .../bindings/thermal/da9062-thermal.txt       | 36 ------------
>  .../bindings/thermal/dlg,da9062-thermal.yaml  | 58 +++++++++++++++++++
>  2 files changed, 58 insertions(+), 36 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/thermal/da9062-thermal.txt
>  create mode 100644 Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yaml
> 
> diff --git a/Documentation/devicetree/bindings/thermal/da9062-thermal.txt b/Documentation/devicetree/bindings/thermal/da9062-thermal.txt
> deleted file mode 100644
> index e241bb5a5584..000000000000
> --- a/Documentation/devicetree/bindings/thermal/da9062-thermal.txt
> +++ /dev/null
> @@ -1,36 +0,0 @@
> -* Dialog DA9062/61 TJUNC Thermal Module
> -
> -This module is part of the DA9061/DA9062. For more details about entire
> -DA9062 and DA9061 chips see Documentation/devicetree/bindings/mfd/da9062.txt
> -
> -Junction temperature thermal module uses an interrupt signal to identify
> -high THERMAL_TRIP_HOT temperatures for the PMIC device.
> -
> -Required properties:
> -
> -- compatible: should be one of the following valid compatible string lines:
> -        "dlg,da9061-thermal", "dlg,da9062-thermal"
> -        "dlg,da9062-thermal"
> -
> -Optional properties:
> -
> -- polling-delay-passive : Specify the polling period, measured in
> -    milliseconds, between thermal zone device update checks.
> -
> -Example: DA9062
> -
> -	pmic0: da9062@58 {
> -		thermal {
> -			compatible = "dlg,da9062-thermal";
> -			polling-delay-passive = <3000>;
> -		};
> -	};
> -
> -Example: DA9061 using a fall-back compatible for the DA9062 onkey driver
> -
> -	pmic0: da9061@58 {
> -		thermal {
> -			compatible = "dlg,da9061-thermal", "dlg,da9062-thermal";
> -			polling-delay-passive = <3000>;
> -		};
> -	};
> diff --git a/Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yaml b/Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yaml
> new file mode 100644
> index 000000000000..0021ebdd83a0
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yaml
> @@ -0,0 +1,58 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/thermal/dlg,da9062-thermal.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Dialog DA9062/61 TJUNC Thermal Module
> +
> +description:
> +  This module is part of the DA9061/DA9062. For more details about entire
> +  DA9062 and DA9061 chips see Documentation/devicetree/bindings/mfd/da9062.txt
> +
> +  Junction temperature thermal module uses an interrupt signal to identify
> +  high THERMAL_TRIP_HOT temperatures for the PMIC device.
> +
> +maintainers:
> +  - Biju Das <biju.das.jz@bp.renesas.com>
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - items:
> +          - enum:
> +              - dlg,da9062-thermal
> +      - items:
> +          - enum:
> +              - dlg,da9061-thermal
> +          - const: dlg,da9062-thermal # da9062-thermal fallback
> +
> +  polling-delay-passive:
> +    description:
> +      Specify the polling period, measured in milliseconds, between
> +      thermal zone device update checks.
> +
> +required:
> +  - compatible
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/irq.h>
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      pmic@58 {
> +        compatible = "dlg,da9062";
> +        reg = <0x58>;
> +        interrupt-parent = <&gpio6>;
> +        interrupts = <11 IRQ_TYPE_LEVEL_LOW>;
> +        interrupt-controller;
> +
> +        thermal {
> +          compatible = "dlg,da9062-thermal";
> +          polling-delay-passive = <3000>;
> +        };
> +      };
> +    };

Just drop the example here. No need for 2 examples, just provide 1 
complete example in the MFD schema.

With that,

Reviewed-by: Rob Herring <robh@kernel.org>

Rob
Biju Das Dec. 4, 2023, 3:49 p.m. UTC | #5
Hi Rob Herring,

Thanks for the feedback.

> -----Original Message-----
> From: Rob Herring <robh@kernel.org>
> Sent: Monday, December 4, 2023 3:13 PM
> Subject: Re: [PATCH v2 04/11] dt-bindings: thermal: Convert da906{1,2}
> thermal to json-schema
> 
> On Sat, Dec 02, 2023 at 07:25:28PM +0000, Biju Das wrote:
> > Convert the da906{1,2} thermal device tree binding documentation to
> > json-schema.
> >
> > Signed-off-by: Biju Das <biju.das.jz@bp.renesas.com>
> > ---
> >  .../bindings/thermal/da9062-thermal.txt       | 36 ------------
> >  .../bindings/thermal/dlg,da9062-thermal.yaml  | 58
> > +++++++++++++++++++
> >  2 files changed, 58 insertions(+), 36 deletions(-)  delete mode
> > 100644 Documentation/devicetree/bindings/thermal/da9062-thermal.txt
> >  create mode 100644
> > Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yaml
> >
> > diff --git
> > a/Documentation/devicetree/bindings/thermal/da9062-thermal.txt
> > b/Documentation/devicetree/bindings/thermal/da9062-thermal.txt
> > deleted file mode 100644
> > index e241bb5a5584..000000000000
> > --- a/Documentation/devicetree/bindings/thermal/da9062-thermal.txt
> > +++ /dev/null
> > @@ -1,36 +0,0 @@
> > -* Dialog DA9062/61 TJUNC Thermal Module
> > -
> > -This module is part of the DA9061/DA9062. For more details about
> > entire
> > -DA9062 and DA9061 chips see
> > Documentation/devicetree/bindings/mfd/da9062.txt
> > -
> > -Junction temperature thermal module uses an interrupt signal to
> > identify -high THERMAL_TRIP_HOT temperatures for the PMIC device.
> > -
> > -Required properties:
> > -
> > -- compatible: should be one of the following valid compatible string
> lines:
> > -        "dlg,da9061-thermal", "dlg,da9062-thermal"
> > -        "dlg,da9062-thermal"
> > -
> > -Optional properties:
> > -
> > -- polling-delay-passive : Specify the polling period, measured in
> > -    milliseconds, between thermal zone device update checks.
> > -
> > -Example: DA9062
> > -
> > -	pmic0: da9062@58 {
> > -		thermal {
> > -			compatible = "dlg,da9062-thermal";
> > -			polling-delay-passive = <3000>;
> > -		};
> > -	};
> > -
> > -Example: DA9061 using a fall-back compatible for the DA9062 onkey
> > driver
> > -
> > -	pmic0: da9061@58 {
> > -		thermal {
> > -			compatible = "dlg,da9061-thermal", "dlg,da9062-thermal";
> > -			polling-delay-passive = <3000>;
> > -		};
> > -	};
> > diff --git
> > a/Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yaml
> > b/Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yaml
> > new file mode 100644
> > index 000000000000..0021ebdd83a0
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yam
> > +++ l
> > @@ -0,0 +1,58 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id:
> > +
> > +title: Dialog DA9062/61 TJUNC Thermal Module
> > +
> > +description:
> > +  This module is part of the DA9061/DA9062. For more details about
> > +entire
> > +  DA9062 and DA9061 chips see
> > +Documentation/devicetree/bindings/mfd/da9062.txt
> > +
> > +  Junction temperature thermal module uses an interrupt signal to
> > + identify  high THERMAL_TRIP_HOT temperatures for the PMIC device.
> > +
> > +maintainers:
> > +  - Biju Das <biju.das.jz@bp.renesas.com>
> > +
> > +properties:
> > +  compatible:
> > +    oneOf:
> > +      - items:
> > +          - enum:
> > +              - dlg,da9062-thermal
> > +      - items:
> > +          - enum:
> > +              - dlg,da9061-thermal
> > +          - const: dlg,da9062-thermal # da9062-thermal fallback
> > +
> > +  polling-delay-passive:
> > +    description:
> > +      Specify the polling period, measured in milliseconds, between
> > +      thermal zone device update checks.
> > +
> > +required:
> > +  - compatible
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    #include <dt-bindings/interrupt-controller/irq.h>
> > +    i2c {
> > +      #address-cells = <1>;
> > +      #size-cells = <0>;
> > +      pmic@58 {
> > +        compatible = "dlg,da9062";
> > +        reg = <0x58>;
> > +        interrupt-parent = <&gpio6>;
> > +        interrupts = <11 IRQ_TYPE_LEVEL_LOW>;
> > +        interrupt-controller;
> > +
> > +        thermal {
> > +          compatible = "dlg,da9062-thermal";
> > +          polling-delay-passive = <3000>;
> > +        };
> > +      };
> > +    };
> 
> Just drop the example here. No need for 2 examples, just provide 1
> complete example in the MFD schema.
> 
> With that,

OK, will drop example in the next version.

Cheers,
Biju

> 
> Reviewed-by: Rob Herring <robh@kernel.org>
> 
> Rob
kernel test robot Dec. 6, 2023, 4:34 a.m. UTC | #6
Hi Biju,

kernel test robot noticed the following build warnings:

[auto build test WARNING on lee-mfd/for-mfd-next]
[also build test WARNING on robh/for-next rafael-pm/thermal groeck-staging/hwmon-next linus/master v6.7-rc4 next-20231205]
[cannot apply to dtor-input/next dtor-input/for-linus lee-mfd/for-mfd-fixes]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/Biju-Das/dt-bindings-watchdog-dlg-da9062-watchdog-Document-DA9063-watchdog/20231203-042557
base:   https://git.kernel.org/pub/scm/linux/kernel/git/lee/mfd.git for-mfd-next
patch link:    https://lore.kernel.org/r/20231202192536.266885-5-biju.das.jz%40bp.renesas.com
patch subject: [PATCH v2 04/11] dt-bindings: thermal: Convert da906{1,2} thermal to json-schema
reproduce: (https://download.01.org/0day-ci/archive/20231206/202312061242.lKDoAY9g-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202312061242.lKDoAY9g-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> Warning: MAINTAINERS references a file that doesn't exist: Documentation/devicetree/bindings/thermal/da90??-thermal.txt
Biju Das Dec. 6, 2023, 9:37 a.m. UTC | #7
Hi kernel test robot,


> -----Original Message-----
> From: kernel test robot <lkp@intel.com>
> Sent: Wednesday, December 6, 2023 4:34 AM
> To: Biju Das <biju.das.jz@bp.renesas.com>; Rob Herring
> Subject: Re: [PATCH v2 04/11] dt-bindings: thermal: Convert da906{1,2}
> thermal to json-schema
> 
> Hi Biju,
> 
> kernel test robot noticed the following build warnings:
> 
> 
> If you fix the issue in a separate patch/commit (i.e. not just a new
> version of the same patch/commit), kindly add following tags
> | Reported-by: kernel test robot <lkp@intel.com>
> | Closes:
> 
> All warnings (new ones prefixed by >>):
> 
> >> Warning: MAINTAINERS references a file that doesn't exist:
> >> Documentation/devicetree/bindings/thermal/da90??-thermal.txt
> 

There is an updated patch series available[1] and Please retest and provide feedback if any?

[1] https://lore.kernel.org/all/20231204172510.35041-1-biju.das.jz@bp.renesas.com/

Cheers,
Biju
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/thermal/da9062-thermal.txt b/Documentation/devicetree/bindings/thermal/da9062-thermal.txt
deleted file mode 100644
index e241bb5a5584..000000000000
--- a/Documentation/devicetree/bindings/thermal/da9062-thermal.txt
+++ /dev/null
@@ -1,36 +0,0 @@ 
-* Dialog DA9062/61 TJUNC Thermal Module
-
-This module is part of the DA9061/DA9062. For more details about entire
-DA9062 and DA9061 chips see Documentation/devicetree/bindings/mfd/da9062.txt
-
-Junction temperature thermal module uses an interrupt signal to identify
-high THERMAL_TRIP_HOT temperatures for the PMIC device.
-
-Required properties:
-
-- compatible: should be one of the following valid compatible string lines:
-        "dlg,da9061-thermal", "dlg,da9062-thermal"
-        "dlg,da9062-thermal"
-
-Optional properties:
-
-- polling-delay-passive : Specify the polling period, measured in
-    milliseconds, between thermal zone device update checks.
-
-Example: DA9062
-
-	pmic0: da9062@58 {
-		thermal {
-			compatible = "dlg,da9062-thermal";
-			polling-delay-passive = <3000>;
-		};
-	};
-
-Example: DA9061 using a fall-back compatible for the DA9062 onkey driver
-
-	pmic0: da9061@58 {
-		thermal {
-			compatible = "dlg,da9061-thermal", "dlg,da9062-thermal";
-			polling-delay-passive = <3000>;
-		};
-	};
diff --git a/Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yaml b/Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yaml
new file mode 100644
index 000000000000..0021ebdd83a0
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/dlg,da9062-thermal.yaml
@@ -0,0 +1,58 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/thermal/dlg,da9062-thermal.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Dialog DA9062/61 TJUNC Thermal Module
+
+description:
+  This module is part of the DA9061/DA9062. For more details about entire
+  DA9062 and DA9061 chips see Documentation/devicetree/bindings/mfd/da9062.txt
+
+  Junction temperature thermal module uses an interrupt signal to identify
+  high THERMAL_TRIP_HOT temperatures for the PMIC device.
+
+maintainers:
+  - Biju Das <biju.das.jz@bp.renesas.com>
+
+properties:
+  compatible:
+    oneOf:
+      - items:
+          - enum:
+              - dlg,da9062-thermal
+      - items:
+          - enum:
+              - dlg,da9061-thermal
+          - const: dlg,da9062-thermal # da9062-thermal fallback
+
+  polling-delay-passive:
+    description:
+      Specify the polling period, measured in milliseconds, between
+      thermal zone device update checks.
+
+required:
+  - compatible
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      pmic@58 {
+        compatible = "dlg,da9062";
+        reg = <0x58>;
+        interrupt-parent = <&gpio6>;
+        interrupts = <11 IRQ_TYPE_LEVEL_LOW>;
+        interrupt-controller;
+
+        thermal {
+          compatible = "dlg,da9062-thermal";
+          polling-delay-passive = <3000>;
+        };
+      };
+    };