[PATCH] dt-bindings: watchdog: migrate rt2880 text bindings to YAML

[PATCH] dt-bindings: watchdog: migrate rt2880 text bindings to YAML

[Sergio Paracuellos]

Ralink RT2880 Watchdog bindings used text format, so migrate them to YAML.
There are some additions to the binding that were not in the original
txt file. This binding is used in RT2880, RT3050, RT3352, RT3883, RT5350,
and MT7620 SoCs. To properly match all dts nodes included in openWRT git
trees we need to add to the schema 'reset' and 'reset-names'. 'reset-names'
property is always string 'wdt' so maintain that as const in the schema.

Signed-off-by: Sergio Paracuellos <sergio.paracuellos@gmail.com>
---
 .../bindings/watchdog/ralink,rt2880-wdt.yaml  | 47 +++++++++++++++++++
 .../bindings/watchdog/rt2880-wdt.txt          | 18 -------
 2 files changed, 47 insertions(+), 18 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml
 delete mode 100644 Documentation/devicetree/bindings/watchdog/rt2880-wdt.txt

diff --git a/Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml b/Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml
new file mode 100644
index 000000000000..c96bf2e61364
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml
@@ -0,0 +1,47 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/ralink,rt2880-wdt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Ralink Watchdog Timers
+
+maintainers:
+  - Sergio Paracuellos <sergio.paracuellos@gmail.com>
+
+allOf:
+  - $ref: watchdog.yaml#
+
+properties:
+  compatible:
+    const: ralink,rt2880-wdt
+
+  reg:
+    maxItems: 1
+
+  resets:
+    maxItems: 1
+
+  reset-names:
+    items:
+      - const: wdt
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    watchdog@100 {
+      compatible = "ralink,rt2880-wdt";
+      reg = <0x100 0x100>;
+      resets = <&rstctrl 8>;
+      reset-names = "wdt";
+      interrupt-parent = <&intc>;
+      interrupts = <1>;
+    };
diff --git a/Documentation/devicetree/bindings/watchdog/rt2880-wdt.txt b/Documentation/devicetree/bindings/watchdog/rt2880-wdt.txt
deleted file mode 100644
index 05b95bfa2a89..000000000000
--- a/Documentation/devicetree/bindings/watchdog/rt2880-wdt.txt
+++ /dev/null
@@ -1,18 +0,0 @@
-Ralink Watchdog Timers
-
-Required properties:
-- compatible: must be "ralink,rt2880-wdt"
-- reg: physical base address of the controller and length of the register range
-
-Optional properties:
-- interrupts: Specify the INTC interrupt number
-
-Example:
-
-	watchdog@120 {
-		compatible = "ralink,rt2880-wdt";
-		reg = <0x120 0x10>;
-
-		interrupt-parent = <&intc>;
-		interrupts = <1>;
-	};
-- 
2.25.1

Re: [PATCH] dt-bindings: watchdog: migrate rt2880 text bindings to YAML

[Krzysztof Kozlowski]

On 01/03/2023 10:19, Sergio Paracuellos wrote:
> Ralink RT2880 Watchdog bindings used text format, so migrate them to YAML.
> There are some additions to the binding that were not in the original
> txt file. This binding is used in RT2880, RT3050, RT3352, RT3883, RT5350,
> and MT7620 SoCs. To properly match all dts nodes included in openWRT git
> trees we need to add to the schema 'reset' and 'reset-names'. 'reset-names'

Sorry, but out of tree undocumented properties cannot be added just
"because they exist". Otherwise what would be the point of
documentation? It would be enough to add any stuff anywhere and claim -
it's used in my xxxyyyzzz, so we must support it".

> property is always string 'wdt' so maintain that as const in the schema.
> 
> Signed-off-by: Sergio Paracuellos <sergio.paracuellos@gmail.com>
> ---
>  .../bindings/watchdog/ralink,rt2880-wdt.yaml  | 47 +++++++++++++++++++
>  .../bindings/watchdog/rt2880-wdt.txt          | 18 -------
>  2 files changed, 47 insertions(+), 18 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml
>  delete mode 100644 Documentation/devicetree/bindings/watchdog/rt2880-wdt.txt
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml b/Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml
> new file mode 100644
> index 000000000000..c96bf2e61364
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml
> @@ -0,0 +1,47 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/watchdog/ralink,rt2880-wdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Ralink Watchdog Timers
> +
> +maintainers:
> +  - Sergio Paracuellos <sergio.paracuellos@gmail.com>
> +
> +allOf:
> +  - $ref: watchdog.yaml#
> +
> +properties:
> +  compatible:
> +    const: ralink,rt2880-wdt
> +
> +  reg:
> +    maxItems: 1
> +
> +  resets:
> +    maxItems: 1
> +
> +  reset-names:
> +    items:
> +      - const: wdt

Drop reset names.

> +
> +  interrupts:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false

unevaluatedProperties instead, because you want properties from
watchdog.yaml.



Best regards,
Krzysztof

Re: [PATCH] dt-bindings: watchdog: migrate rt2880 text bindings to YAML

[Sergio Paracuellos]

Hi Krzysztof,

On Thu, Mar 2, 2023 at 9:22 AM Krzysztof Kozlowski
<krzysztof.kozlowski@linaro.org> wrote:
>
> On 01/03/2023 10:19, Sergio Paracuellos wrote:
> > Ralink RT2880 Watchdog bindings used text format, so migrate them to YAML.
> > There are some additions to the binding that were not in the original
> > txt file. This binding is used in RT2880, RT3050, RT3352, RT3883, RT5350,
> > and MT7620 SoCs. To properly match all dts nodes included in openWRT git
> > trees we need to add to the schema 'reset' and 'reset-names'. 'reset-names'
>
> Sorry, but out of tree undocumented properties cannot be added just
> "because they exist". Otherwise what would be the point of
> documentation? It would be enough to add any stuff anywhere and claim -
> it's used in my xxxyyyzzz, so we must support it".

Pretty clear, thanks. Will re-do this commit message, then in v3.

>
> > property is always string 'wdt' so maintain that as const in the schema.
> >
> > Signed-off-by: Sergio Paracuellos <sergio.paracuellos@gmail.com>
> > ---
> >  .../bindings/watchdog/ralink,rt2880-wdt.yaml  | 47 +++++++++++++++++++
> >  .../bindings/watchdog/rt2880-wdt.txt          | 18 -------
> >  2 files changed, 47 insertions(+), 18 deletions(-)
> >  create mode 100644 Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml
> >  delete mode 100644 Documentation/devicetree/bindings/watchdog/rt2880-wdt.txt
> >
> > diff --git a/Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml b/Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml
> > new file mode 100644
> > index 000000000000..c96bf2e61364
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/watchdog/ralink,rt2880-wdt.yaml
> > @@ -0,0 +1,47 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/watchdog/ralink,rt2880-wdt.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Ralink Watchdog Timers
> > +
> > +maintainers:
> > +  - Sergio Paracuellos <sergio.paracuellos@gmail.com>
> > +
> > +allOf:
> > +  - $ref: watchdog.yaml#
> > +
> > +properties:
> > +  compatible:
> > +    const: ralink,rt2880-wdt
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  resets:
> > +    maxItems: 1
> > +
> > +  reset-names:
> > +    items:
> > +      - const: wdt
>
> Drop reset names.

Will do.

>
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +additionalProperties: false
>
> unevaluatedProperties instead, because you want properties from
> watchdog.yaml.

Sure, thanks.

>
>
>
> Best regards,
> Krzysztof
>

Best regards,
    Sergio Paracuellos