diff mbox series

dt-bindings: watchdog: atmel,at91rm9200-wdt: convert txt to yaml

Message ID 20230916154826.84925-1-n3q5u8@yahoo.com
State Changes Requested
Headers show
Series dt-bindings: watchdog: atmel,at91rm9200-wdt: convert txt to yaml | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 1 warnings, 31 lines checked
robh/patch-applied success
robh/dt-meta-schema fail build log

Commit Message

Nik Bune Sept. 16, 2023, 3:48 p.m. UTC
Convert txt file to yaml. 
Add reg to the list of required properties.
Add mainteiners from ./scripts/get_maintainer.pl output.

Signed-off-by: Nik Bune <n3q5u8@yahoo.com>
---
 .../watchdog/atmel,at91rm9200-wdt.yaml        | 31 +++++++++++++++++++
 .../watchdog/atmel-at91rm9200-wdt.txt         |  9 ------
 2 files changed, 31 insertions(+), 9 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
 delete mode 100644 Documentation/devicetree/bindings/watchdog/atmel-at91rm9200-wdt.txt

Comments

Rob Herring (Arm) Sept. 16, 2023, 4:38 p.m. UTC | #1
On Sat, 16 Sep 2023 17:48:26 +0200, Nik Bune wrote:
> Convert txt file to yaml.
> Add reg to the list of required properties.
> Add mainteiners from ./scripts/get_maintainer.pl output.
> 
> Signed-off-by: Nik Bune <n3q5u8@yahoo.com>
> ---
>  .../watchdog/atmel,at91rm9200-wdt.yaml        | 31 +++++++++++++++++++
>  .../watchdog/atmel-at91rm9200-wdt.txt         |  9 ------
>  2 files changed, 31 insertions(+), 9 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
>  delete mode 100644 Documentation/devicetree/bindings/watchdog/atmel-at91rm9200-wdt.txt
> 

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/watchdog/atmel,at91sam9-wdt.example.dtb: watchdog@fffffd40: Unevaluated properties are not allowed ('atmel,dbg-halt', 'atmel,idle-halt', 'atmel,max-heartbeat-sec', 'atmel,min-heartbeat-sec', 'atmel,reset-type', 'atmel,watchdog-type', 'clocks', 'interrupts', 'timeout-sec' were unexpected)
	from schema $id: http://devicetree.org/schemas/watchdog/atmel,at91rm9200-wdt.yaml#
Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.example.dtb: /example-0/watchdog@fffffd00: failed to match any schema with compatible: ['atmel,at91rm9200-wdt']

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230916154826.84925-1-n3q5u8@yahoo.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.
Krzysztof Kozlowski Sept. 16, 2023, 8:37 p.m. UTC | #2
On 16/09/2023 17:48, Nik Bune wrote:
> Convert txt file to yaml. 
> Add reg to the list of required properties.
> Add mainteiners from ./scripts/get_maintainer.pl output.
> 
> Signed-off-by: Nik Bune <n3q5u8@yahoo.com>
> ---
>  .../watchdog/atmel,at91rm9200-wdt.yaml        | 31 +++++++++++++++++++
>  .../watchdog/atmel-at91rm9200-wdt.txt         |  9 ------
>  2 files changed, 31 insertions(+), 9 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
>  delete mode 100644 Documentation/devicetree/bindings/watchdog/atmel-at91rm9200-wdt.txt
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml b/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
> new file mode 100644
> index 000000000000..e9706b9c1e6b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
> @@ -0,0 +1,31 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries

How this copyright appeared here? Why are you adding some 2022
copyrights of someone else?

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/watchdog/atmel,at91rm9200-wdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Atmel AT91RM9200 System Timer Watchdog
> +
> +maintainers:
> +  - Wim Van Sebroeck <wim@linux-watchdog.org>
> +  - Guenter Roeck <linux@roeck-us.net>
> +

Missing ref to watchdog.yaml. Please open existing files and take a look
how it is done.


> +properties:
> +  compatible:
> +    const: atmel,at91sam9260-wdt

Missing blank line

> +  reg:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +unevaluatedProperties: false

This would not make sense without $ref...

Anyway, you need to also test the DTS.

Best regards,
Krzysztof
Krzysztof Kozlowski Sept. 16, 2023, 8:38 p.m. UTC | #3
On 16/09/2023 17:48, Nik Bune wrote:
> Convert txt file to yaml. 
> Add reg to the list of required properties.
> Add mainteiners from ./scripts/get_maintainer.pl output.


...

> +---
> +$id: http://devicetree.org/schemas/watchdog/atmel,at91rm9200-wdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Atmel AT91RM9200 System Timer Watchdog
> +
> +maintainers:
> +  - Wim Van Sebroeck <wim@linux-watchdog.org>
> +  - Guenter Roeck <linux@roeck-us.net>

No, these should be maintainer of device or subarch, not subsystem.

Best regards,
Krzysztof
Conor Dooley Sept. 17, 2023, 10:02 a.m. UTC | #4
On Sat, Sep 16, 2023 at 10:37:23PM +0200, Krzysztof Kozlowski wrote:
> On 16/09/2023 17:48, Nik Bune wrote:
> > Convert txt file to yaml. 
> > Add reg to the list of required properties.
> > Add mainteiners from ./scripts/get_maintainer.pl output.
> > 
> > Signed-off-by: Nik Bune <n3q5u8@yahoo.com>
> > ---
> >  .../watchdog/atmel,at91rm9200-wdt.yaml        | 31 +++++++++++++++++++
> >  .../watchdog/atmel-at91rm9200-wdt.txt         |  9 ------
> >  2 files changed, 31 insertions(+), 9 deletions(-)
> >  create mode 100644 Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
> >  delete mode 100644 Documentation/devicetree/bindings/watchdog/atmel-at91rm9200-wdt.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml b/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
> > new file mode 100644
> > index 000000000000..e9706b9c1e6b
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
> > @@ -0,0 +1,31 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
> 
> How this copyright appeared here? Why are you adding some 2022
> copyrights of someone else?

It's worth noting that that patch also re-licences the original binding,
and was not written by anyone from microchip in the first place.
Nik Bune Sept. 17, 2023, 7:35 p.m. UTC | #5
Hello, thank you for your review! 

On Sat, Sep 16, 2023 at 10:37:23PM +0200, Krzysztof Kozlowski wrote:

>On 16/09/2023 17:48, Nik Bune wrote:
>> Convert txt file to yaml.
>> Add reg to the list of required properties.
>> Add mainteiners from ./scripts/get_maintainer.pl output.
>>
>> Signed-off-by: Nik Bune <n3q5u8@yahoo.com>
>> ---
>>  .../watchdog/atmel,at91rm9200-wdt.yaml        | 31 +++++++++++++++++++
>>  .../watchdog/atmel-at91rm9200-wdt.txt        |  9 ------
>>  2 files changed, 31 insertions(+), 9 deletions(-)
>>  create mode 100644 Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
>>  delete mode 100644 Documentation/devicetree/bindings/watchdog/atmel-at91rm9200-wdt.txt
>>
>> diff --git a/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml b/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
>> new file mode 100644
>> index 000000000000..e9706b9c1e6b
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
>> @@ -0,0 +1,31 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
>
>How this copyright appeared here? Why are you adding some 2022
>copyrights of someone else?

I copied it from the neighbour file atmel,at91sam9-wdt.yaml.
I assume I should leave only "SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)" here.

Thank you!
Nik Bune Sept. 17, 2023, 7:55 p.m. UTC | #6
>On Saturday, 16 September 2023 at 22:38:17 CEST, Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
>
>
>On 16/09/2023 17:48, Nik Bune wrote:
>
>> Convert txt file to yaml.
>> Add reg to the list of required properties.
>> Add mainteiners from ./scripts/get_maintainer.pl output.
>
>
>...
>
>> +---
>> +$id: http://devicetree.org/schemas/watchdog/atmel,at91rm9200-wdt.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Atmel AT91RM9200 System Timer Watchdog
>> +
>> +maintainers:
>> +  - Wim Van Sebroeck <wim@linux-watchdog.org>
>> +  - Guenter Roeck <linux@roeck-us.net
>>
>
>No, these should be maintainer of device or subarch, not subsystem.
>

Is it a particular way how to determine the mainterners of the device? 

I have checked nearby atmel devices. They have Eugen Hristev <eugen.hristev@microchip.com> in the list of maintainers. 
Also I have found the similar patch, which looks like have never finalised, https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230525125602.640855-5-claudiu.beznea@microchip.com/ 
it has 
maintainers:
  - Nicolas Ferre <nicolas.ferre@microchip.com>
  - Alexandre Belloni <alexandre.belloni@bootlin.com>
  - Claudiu Beznea <claudiu.beznea@microchip.coam>


Thank you.
Conor Dooley Sept. 18, 2023, 5:09 p.m. UTC | #7
On Sun, Sep 17, 2023 at 09:35:56PM +0200, Nik Bune wrote:
> Hello, thank you for your review! 
> 
> On Sat, Sep 16, 2023 at 10:37:23PM +0200, Krzysztof Kozlowski wrote:
> 
> >On 16/09/2023 17:48, Nik Bune wrote:
> >> Convert txt file to yaml.
> >> Add reg to the list of required properties.
> >> Add mainteiners from ./scripts/get_maintainer.pl output.
> >>
> >> Signed-off-by: Nik Bune <n3q5u8@yahoo.com>
> >> ---
> >>  .../watchdog/atmel,at91rm9200-wdt.yaml        | 31 +++++++++++++++++++
> >>  .../watchdog/atmel-at91rm9200-wdt.txt        |  9 ------
> >>  2 files changed, 31 insertions(+), 9 deletions(-)
> >>  create mode 100644 Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
> >>  delete mode 100644 Documentation/devicetree/bindings/watchdog/atmel-at91rm9200-wdt.txt
> >>
> >> diff --git a/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml b/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
> >> new file mode 100644
> >> index 000000000000..e9706b9c1e6b
> >> --- /dev/null
> >> +++ b/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
> >> @@ -0,0 +1,31 @@
> >> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> >> +# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
> >
> >How this copyright appeared here? Why are you adding some 2022
> >copyrights of someone else?
> 
> I copied it from the neighbour file atmel,at91sam9-wdt.yaml.
> I assume I should leave only "SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)" here.

The original file does not contain a license, which means (AFAIU) to
GPL-2.0-only, unless the original author ACKs a relicensing.

> 
> Thank you!
Conor Dooley Sept. 18, 2023, 5:11 p.m. UTC | #8
On Sun, Sep 17, 2023 at 09:55:20PM +0200, Nik Bune wrote:
> 
> >On Saturday, 16 September 2023 at 22:38:17 CEST, Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org> wrote:
> >
> >
> >On 16/09/2023 17:48, Nik Bune wrote:
> >
> >> Convert txt file to yaml.
> >> Add reg to the list of required properties.
> >> Add mainteiners from ./scripts/get_maintainer.pl output.
> >
> >
> >...
> >
> >> +---
> >> +$id: http://devicetree.org/schemas/watchdog/atmel,at91rm9200-wdt.yaml#
> >> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> >> +
> >> +title: Atmel AT91RM9200 System Timer Watchdog
> >> +
> >> +maintainers:
> >> +  - Wim Van Sebroeck <wim@linux-watchdog.org>
> >> +  - Guenter Roeck <linux@roeck-us.net
> >>
> >
> >No, these should be maintainer of device or subarch, not subsystem.
> >
> 
> Is it a particular way how to determine the mainterners of the device? 
> 
> I have checked nearby atmel devices. They have Eugen Hristev <eugen.hristev@microchip.com> in the list of maintainers. 
> Also I have found the similar patch, which looks like have never finalised, https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230525125602.640855-5-claudiu.beznea@microchip.com/ 
> it has 
> maintainers:
>   - Nicolas Ferre <nicolas.ferre@microchip.com>
>   - Alexandre Belloni <alexandre.belloni@bootlin.com>
>   - Claudiu Beznea <claudiu.beznea@microchip.coam>

Neither Claudiu or Eugen work at microchip any more. Nicolas should be
able to volunteer someone to look after it if you don't want to.
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml b/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
new file mode 100644
index 000000000000..e9706b9c1e6b
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/atmel,at91rm9200-wdt.yaml
@@ -0,0 +1,31 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (C) 2022 Microchip Technology, Inc. and its subsidiaries
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/atmel,at91rm9200-wdt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Atmel AT91RM9200 System Timer Watchdog
+
+maintainers:
+  - Wim Van Sebroeck <wim@linux-watchdog.org>
+  - Guenter Roeck <linux@roeck-us.net>
+
+properties:
+  compatible:
+    const: atmel,at91sam9260-wdt
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    watchdog@fffffd00 {
+        compatible = "atmel,at91rm9200-wdt";
+        reg = <0xfffffd00 0x10>;
+    };
diff --git a/Documentation/devicetree/bindings/watchdog/atmel-at91rm9200-wdt.txt b/Documentation/devicetree/bindings/watchdog/atmel-at91rm9200-wdt.txt
deleted file mode 100644
index d4d86cf8f9eb..000000000000
--- a/Documentation/devicetree/bindings/watchdog/atmel-at91rm9200-wdt.txt
+++ /dev/null
@@ -1,9 +0,0 @@ 
-Atmel AT91RM9200 System Timer Watchdog
-
-Required properties:
-- compatible: must be "atmel,at91sam9260-wdt".
-
-Example:
-	watchdog@fffffd00 {
-		compatible = "atmel,at91rm9200-wdt";
-	};