2024-05-27 06:21:46

by Shresth Prasad

[permalink] [raw]
Subject: [PATCH] dt-bindings: watchdog: img,pdc-wdt: Convert to dtschema

Convert txt bindings of ImgTec's PDC watchdog timer to dtschema to allow
for validation.

Signed-off-by: Shresth Prasad <[email protected]>
---
The binding has been checked and tested against `img/pistachio_marduk.dts`
with no errors or warnings.
---
.../bindings/watchdog/img,pdc-wdt.yaml | 62 +++++++++++++++++++
.../bindings/watchdog/imgpdc-wdt.txt | 19 ------
2 files changed, 62 insertions(+), 19 deletions(-)
create mode 100644 Documentation/devicetree/bindings/watchdog/img,pdc-wdt.yaml
delete mode 100644 Documentation/devicetree/bindings/watchdog/imgpdc-wdt.txt

diff --git a/Documentation/devicetree/bindings/watchdog/img,pdc-wdt.yaml b/Documentation/devicetree/bindings/watchdog/img,pdc-wdt.yaml
new file mode 100644
index 000000000000..8aecbcbd700f
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/img,pdc-wdt.yaml
@@ -0,0 +1,62 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/img,pdc-wdt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ImgTec PowerDown Controller (PDC) Watchdog Timer (WDT)
+
+maintainers:
+ - Shresth Prasad <[email protected]>
+
+
+allOf:
+ - $ref: watchdog.yaml#
+
+properties:
+ compatible:
+ enum:
+ - img,pdc-wdt
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ maxItems: 2
+
+ clock-names:
+ items:
+ - const: wdt
+ - const: sys
+
+ interrupts:
+ description:
+ Should contain WDT interrupt
+ maxItems: 1
+
+ assigned-clocks:
+ maxItems: 2
+
+ assigned-clock-rates:
+ maxItems: 2
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - clock-names
+ - interrupts
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/irq.h>
+
+ watchdog@18102100 {
+ compatible = "img,pdc-wdt";
+ reg = <0x18102100 0x100>;
+ clocks = <&pdc_wdt_clk>, <&sys_clk>;
+ clock-names = "wdt", "sys";
+ interrupts = <0 52 IRQ_TYPE_LEVEL_HIGH>;
+ };
diff --git a/Documentation/devicetree/bindings/watchdog/imgpdc-wdt.txt b/Documentation/devicetree/bindings/watchdog/imgpdc-wdt.txt
deleted file mode 100644
index b2fa11fd43de..000000000000
--- a/Documentation/devicetree/bindings/watchdog/imgpdc-wdt.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-*ImgTec PowerDown Controller (PDC) Watchdog Timer (WDT)
-
-Required properties:
-- compatible : Should be "img,pdc-wdt"
-- reg : Should contain WDT registers location and length
-- clocks: Must contain an entry for each entry in clock-names.
-- clock-names: Should contain "wdt" and "sys"; the watchdog counter
- clock and register interface clock respectively.
-- interrupts : Should contain WDT interrupt
-
-Examples:
-
-watchdog@18102100 {
- compatible = "img,pdc-wdt";
- reg = <0x18102100 0x100>;
- clocks = <&pdc_wdt_clk>, <&sys_clk>;
- clock-names = "wdt", "sys";
- interrupts = <0 52 IRQ_TYPE_LEVEL_HIGH>;
-};
--
2.45.1



2024-05-27 18:47:55

by Krzysztof Kozlowski

[permalink] [raw]
Subject: Re: [PATCH] dt-bindings: watchdog: img,pdc-wdt: Convert to dtschema

On 27/05/2024 08:21, Shresth Prasad wrote:
> Convert txt bindings of ImgTec's PDC watchdog timer to dtschema to allow
> for validation.
>
> Signed-off-by: Shresth Prasad <[email protected]>
> ---
> The binding has been checked and tested against `img/pistachio_marduk.dts`
> with no errors or warnings.
> ---


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


> +
> +maintainers:
> + - Shresth Prasad <[email protected]>
> +
> +

Just one blank line.

> +allOf:
> + - $ref: watchdog.yaml#
> +
> +properties:
> + compatible:
> + enum:
> + - img,pdc-wdt
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 2

Instead of maxItems please list items with description so the items will
be described.

> +
> + clock-names:
> + items:
> + - const: wdt
> + - const: sys
> +
> + interrupts:
> + description:
> + Should contain WDT interrupt

Drop description, redundant.

> + maxItems: 1
> +
> + assigned-clocks:
> + maxItems: 2

Drop property

> +
> + assigned-clock-rates:
> + maxItems: 2

Drop property

> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - clock-names
> + - interrupts
> +
Best regards,
Krzysztof


2024-05-27 19:55:25

by Shresth Prasad

[permalink] [raw]
Subject: Re: [PATCH] dt-bindings: watchdog: img,pdc-wdt: Convert to dtschema

On Tue, May 28, 2024 at 12:17 AM Krzysztof Kozlowski <[email protected]> wrote:
>
> On 27/05/2024 08:21, Shresth Prasad wrote:
> > Convert txt bindings of ImgTec's PDC watchdog timer to dtschema to allow
> > for validation.
> >
> > Signed-off-by: Shresth Prasad <[email protected]>
> > ---
> > The binding has been checked and tested against `img/pistachio_marduk.dts`
> > with no errors or warnings.
> > ---
>
>
> Thank you for your patch. There is something to discuss/improve.
>
>
> > +
> > +maintainers:
> > + - Shresth Prasad <[email protected]>
> > +
> > +
>
> Just one blank line.
>
> > +allOf:
> > + - $ref: watchdog.yaml#
> > +
> > +properties:
> > + compatible:
> > + enum:
> > + - img,pdc-wdt
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + clocks:
> > + maxItems: 2
>
> Instead of maxItems please list items with description so the items will
> be described.
>
> > +
> > + clock-names:
> > + items:
> > + - const: wdt
> > + - const: sys
> > +
> > + interrupts:
> > + description:
> > + Should contain WDT interrupt
>
> Drop description, redundant.
>
> > + maxItems: 1
> > +
> > + assigned-clocks:
> > + maxItems: 2
>
> Drop property
>
> > +
> > + assigned-clock-rates:
> > + maxItems: 2
>
> Drop property
>
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - clocks
> > + - clock-names
> > + - interrupts
> > +
> Best regards,
> Krzysztof
>

Hi,

Thank you for the feedback.
I'll address these and resend the patch.

Regards,
Shresth