[RESEND] dt-bindings: watchdog: brcm,kona-wdt: convert to YAML

Message ID 20230423143951.GA10743@standask-GA-A55M-S2HP
State New
Headers
Series [RESEND] dt-bindings: watchdog: brcm,kona-wdt: convert to YAML |

Commit Message

Stanislav Jakubek April 23, 2023, 2:39 p.m. UTC
  Convert Broadcom Kona family watchdog timer bindings to DT schema.

Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
---
RESEND because I originally sent this to the wrong maintainers and
mailing lists by accident. Sorry for the noise.

 .../bindings/watchdog/brcm,kona-wdt.txt       | 15 --------
 .../bindings/watchdog/brcm,kona-wdt.yaml      | 37 +++++++++++++++++++
 2 files changed, 37 insertions(+), 15 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
 create mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
  

Comments

Guenter Roeck April 23, 2023, 3:28 p.m. UTC | #1
On 4/23/23 07:39, Stanislav Jakubek wrote:
> Convert Broadcom Kona family watchdog timer bindings to DT schema.
> 
> Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
> ---
> RESEND because I originally sent this to the wrong maintainers and
> mailing lists by accident. Sorry for the noise.
> 

Is this patch supposed to replace / compete with the other patch
doing the same ?
https://patchwork.kernel.org/project/linux-watchdog/patch/20230418170341.28805-1-n2h9z4@gmail.com/

What is the difference, and what is the purpose ?

Guenter

>   .../bindings/watchdog/brcm,kona-wdt.txt       | 15 --------
>   .../bindings/watchdog/brcm,kona-wdt.yaml      | 37 +++++++++++++++++++
>   2 files changed, 37 insertions(+), 15 deletions(-)
>   delete mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
>   create mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
> deleted file mode 100644
> index 2b86a00e351d..000000000000
> --- a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
> +++ /dev/null
> @@ -1,15 +0,0 @@
> -Broadcom Kona Family Watchdog Timer
> ------------------------------------
> -
> -This watchdog timer is used in the following Broadcom SoCs:
> -  BCM11130, BCM11140, BCM11351, BCM28145, BCM28155
> -
> -Required properties:
> -  - compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> -  - reg: memory address & range
> -
> -Example:
> -	watchdog@35002f40 {
> -		compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> -		reg = <0x35002f40 0x6c>;
> -	};
> diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> new file mode 100644
> index 000000000000..5de1b022847b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> @@ -0,0 +1,37 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/watchdog/brcm,kona-wdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Broadcom Kona family watchdog timer
> +
> +maintainers:
> +  - Florian Fainelli <f.fainelli@gmail.com>
> +
> +allOf:
> +  - $ref: watchdog.yaml#
> +
> +properties:
> +  compatible:
> +    items:
> +      - enum:
> +          - brcm,bcm11351-wdt
> +      - const: brcm,kona-wdt
> +
> +  reg:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    watchdog@35002f40 {
> +        compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> +        reg = <0x35002f40 0x6c>;
> +    };
> +...
  
Stanislav Jakubek April 23, 2023, 4:14 p.m. UTC | #2
On Sun, Apr 23, 2023 at 08:28:23AM -0700, Guenter Roeck wrote:
> On 4/23/23 07:39, Stanislav Jakubek wrote:
> > Convert Broadcom Kona family watchdog timer bindings to DT schema.
> > 
> > Signed-off-by: Stanislav Jakubek <stano.jakubek@gmail.com>
> > ---
> > RESEND because I originally sent this to the wrong maintainers and
> > mailing lists by accident. Sorry for the noise.
> > 
> 
> Is this patch supposed to replace / compete with the other patch
> doing the same ?
> https://patchwork.kernel.org/project/linux-watchdog/patch/20230418170341.28805-1-n2h9z4@gmail.com/

I simply did not see that patch, thank you for pointing it out.

> 
> What is the difference, and what is the purpose ?

I believe both patches serve the same purpose - get DT validation for the
Broadcom Kona watchdog.

Looking at the two patches, there's very little difference:
 - capitalization of title (*F*amily *W*atchdog *T*imer)
 - maintainers
 - the brcm,bcm11351-wdt compatible listed as const vs. as enum with
   a single entry (I think the enum is better for future additions,
   but no strong opinion on that)
 - the other patch has a description (which IMO is unnecessary)

Since that patch came before mine, you can drop this one if you want.

Stanislav

> 
> Guenter
> 
> >   .../bindings/watchdog/brcm,kona-wdt.txt       | 15 --------
> >   .../bindings/watchdog/brcm,kona-wdt.yaml      | 37 +++++++++++++++++++
> >   2 files changed, 37 insertions(+), 15 deletions(-)
> >   delete mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
> >   create mode 100644 Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
> > deleted file mode 100644
> > index 2b86a00e351d..000000000000
> > --- a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
> > +++ /dev/null
> > @@ -1,15 +0,0 @@
> > -Broadcom Kona Family Watchdog Timer
> > ------------------------------------
> > -
> > -This watchdog timer is used in the following Broadcom SoCs:
> > -  BCM11130, BCM11140, BCM11351, BCM28145, BCM28155
> > -
> > -Required properties:
> > -  - compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> > -  - reg: memory address & range
> > -
> > -Example:
> > -	watchdog@35002f40 {
> > -		compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> > -		reg = <0x35002f40 0x6c>;
> > -	};
> > diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> > new file mode 100644
> > index 000000000000..5de1b022847b
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
> > @@ -0,0 +1,37 @@
> > +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/watchdog/brcm,kona-wdt.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Broadcom Kona family watchdog timer
> > +
> > +maintainers:
> > +  - Florian Fainelli <f.fainelli@gmail.com>
> > +
> > +allOf:
> > +  - $ref: watchdog.yaml#
> > +
> > +properties:
> > +  compatible:
> > +    items:
> > +      - enum:
> > +          - brcm,bcm11351-wdt
> > +      - const: brcm,kona-wdt
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +unevaluatedProperties: false
> > +
> > +examples:
> > +  - |
> > +    watchdog@35002f40 {
> > +        compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
> > +        reg = <0x35002f40 0x6c>;
> > +    };
> > +...
>
  

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
deleted file mode 100644
index 2b86a00e351d..000000000000
--- a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.txt
+++ /dev/null
@@ -1,15 +0,0 @@ 
-Broadcom Kona Family Watchdog Timer
------------------------------------
-
-This watchdog timer is used in the following Broadcom SoCs:
-  BCM11130, BCM11140, BCM11351, BCM28145, BCM28155
-
-Required properties:
-  - compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
-  - reg: memory address & range
-
-Example:
-	watchdog@35002f40 {
-		compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
-		reg = <0x35002f40 0x6c>;
-	};
diff --git a/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
new file mode 100644
index 000000000000..5de1b022847b
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
@@ -0,0 +1,37 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/brcm,kona-wdt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Broadcom Kona family watchdog timer
+
+maintainers:
+  - Florian Fainelli <f.fainelli@gmail.com>
+
+allOf:
+  - $ref: watchdog.yaml#
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - brcm,bcm11351-wdt
+      - const: brcm,kona-wdt
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    watchdog@35002f40 {
+        compatible = "brcm,bcm11351-wdt", "brcm,kona-wdt";
+        reg = <0x35002f40 0x6c>;
+    };
+...