Convert txt file to yaml.
Add maintainers list, based on the git history.
Mark clock as required property, by reviewer's suggestion.
Signed-off-by: Nik Bune <[email protected]>
---
Changes in v2 (according to review comments):
- Added clocks to the list of required properties.
- Updated clocks property to have only maxItems without $ref and description.
- Removed timeout-sec explicit definition, as it is defined in watchdog.yaml.
- Updated maintainers list from the git history.
v1 patch: https://lore.kernel.org/all/[email protected]/
.../bindings/watchdog/davinci-wdt.txt | 24 ----------
.../bindings/watchdog/ti,davinci-wdt.yaml | 47 +++++++++++++++++++
2 files changed, 47 insertions(+), 24 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/watchdog/davinci-wdt.txt
create mode 100644 Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml
diff --git a/Documentation/devicetree/bindings/watchdog/davinci-wdt.txt b/Documentation/devicetree/bindings/watchdog/davinci-wdt.txt
deleted file mode 100644
index aa10b8ec36e2..000000000000
--- a/Documentation/devicetree/bindings/watchdog/davinci-wdt.txt
+++ /dev/null
@@ -1,24 +0,0 @@
-Texas Instruments DaVinci/Keystone Watchdog Timer (WDT) Controller
-
-Required properties:
-- compatible : Should be "ti,davinci-wdt", "ti,keystone-wdt"
-- reg : Should contain WDT registers location and length
-
-Optional properties:
-- timeout-sec : Contains the watchdog timeout in seconds
-- clocks : the clock feeding the watchdog timer.
- Needed if platform uses clocks.
- See clock-bindings.txt
-
-Documentation:
-Davinci DM646x - https://www.ti.com/lit/ug/spruer5b/spruer5b.pdf
-Keystone - https://www.ti.com/lit/ug/sprugv5a/sprugv5a.pdf
-
-Examples:
-
-wdt: wdt@2320000 {
- compatible = "ti,davinci-wdt";
- reg = <0x02320000 0x80>;
- timeout-sec = <30>;
- clocks = <&clkwdtimer0>;
-};
diff --git a/Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml b/Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml
new file mode 100644
index 000000000000..4747be98b7d9
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/ti,davinci-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/ti,davinci-wdt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments DaVinci/Keystone Watchdog Timer (WDT) Controller
+
+description: |
+ Documentation:
+ Davinci DM646x - https://www.ti.com/lit/ug/spruer5b/spruer5b.pdf
+ Keystone - https://www.ti.com/lit/ug/sprugv5a/sprugv5a
+
+maintainers:
+ - Murali Karicheri <[email protected]>
+ - Ivan Khoronzhuk <[email protected]>
+
+allOf:
+ - $ref: watchdog.yaml#
+
+properties:
+ compatible:
+ enum:
+ - ti,davinci-wdt
+ - ti,keystone-wdt
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ maxItems: 1
+
+required:
+ - compatible
+ - reg
+ - clocks
+
+unevaluatedProperties: false
+
+examples:
+ - |
+ watchdog@2320000 {
+ compatible = "ti,davinci-wdt";
+ reg = <0x02320000 0x80>;
+ timeout-sec = <30>;
+ clocks = <&clkwdtimer0>;
+ };
--
2.34.1
On 10/24/23 2:58 PM, Nik Bune wrote:
> Convert txt file to yaml.
> Add maintainers list, based on the git history.
> Mark clock as required property, by reviewer's suggestion.
>
> Signed-off-by: Nik Bune <[email protected]>
> ---
>
> Changes in v2 (according to review comments):
> - Added clocks to the list of required properties.
> - Updated clocks property to have only maxItems without $ref and description.
> - Removed timeout-sec explicit definition, as it is defined in watchdog.yaml.
> - Updated maintainers list from the git history.
>
> v1 patch: https://lore.kernel.org/all/[email protected]/
>
> .../bindings/watchdog/davinci-wdt.txt | 24 ----------
> .../bindings/watchdog/ti,davinci-wdt.yaml | 47 +++++++++++++++++++
> 2 files changed, 47 insertions(+), 24 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/watchdog/davinci-wdt.txt
> create mode 100644 Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml
>
> diff --git a/Documentation/devicetree/bindings/watchdog/davinci-wdt.txt b/Documentation/devicetree/bindings/watchdog/davinci-wdt.txt
> deleted file mode 100644
> index aa10b8ec36e2..000000000000
> --- a/Documentation/devicetree/bindings/watchdog/davinci-wdt.txt
> +++ /dev/null
> @@ -1,24 +0,0 @@
> -Texas Instruments DaVinci/Keystone Watchdog Timer (WDT) Controller
> -
> -Required properties:
> -- compatible : Should be "ti,davinci-wdt", "ti,keystone-wdt"
> -- reg : Should contain WDT registers location and length
> -
> -Optional properties:
> -- timeout-sec : Contains the watchdog timeout in seconds
> -- clocks : the clock feeding the watchdog timer.
> - Needed if platform uses clocks.
> - See clock-bindings.txt
> -
> -Documentation:
> -Davinci DM646x - https://www.ti.com/lit/ug/spruer5b/spruer5b.pdf
> -Keystone - https://www.ti.com/lit/ug/sprugv5a/sprugv5a.pdf
> -
> -Examples:
> -
> -wdt: wdt@2320000 {
> - compatible = "ti,davinci-wdt";
> - reg = <0x02320000 0x80>;
> - timeout-sec = <30>;
> - clocks = <&clkwdtimer0>;
> -};
> diff --git a/Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml b/Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml
> new file mode 100644
> index 000000000000..4747be98b7d9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/ti,davinci-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/ti,davinci-wdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments DaVinci/Keystone Watchdog Timer (WDT) Controller
> +
> +description: |
> + Documentation:
> + Davinci DM646x - https://www.ti.com/lit/ug/spruer5b/spruer5b.pdf
> + Keystone - https://www.ti.com/lit/ug/sprugv5a/sprugv5a
> +
> +maintainers:
> + - Murali Karicheri <[email protected]>
> + - Ivan Khoronzhuk <[email protected]>
Neither of these folks will be available for this, you can use me if
you want an email that won't bounce for now.
> +
> +allOf:
> + - $ref: watchdog.yaml#
> +
> +properties:
> + compatible:
> + enum:
> + - ti,davinci-wdt
> + - ti,keystone-wdt
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 1
We also have some instances with an optional power-domains prop.
power-domains:
description: A phandle and PM domain specifier as defined by bindings of
the power controller specified by phandle. See
Documentation/devicetree/bindings/power/power-domain.yaml for details.
Andrew
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> +
> +unevaluatedProperties: false
> +
> +examples:
> + - |
> + watchdog@2320000 {
> + compatible = "ti,davinci-wdt";
> + reg = <0x02320000 0x80>;
> + timeout-sec = <30>;
> + clocks = <&clkwdtimer0>;
> + };
On Tue, Oct 24, 2023 at 03:55:23PM -0500, Andrew Davis wrote:
> On 10/24/23 2:58 PM, Nik Bune wrote:
> > Convert txt file to yaml.
> > Add maintainers list, based on the git history.
> > Mark clock as required property, by reviewer's suggestion.
> >
> > Signed-off-by: Nik Bune <[email protected]>
> > ---
> >
> > Changes in v2 (according to review comments):
> > - Added clocks to the list of required properties.
> > - Updated clocks property to have only maxItems without $ref and description.
> > - Removed timeout-sec explicit definition, as it is defined in watchdog.yaml.
> > - Updated maintainers list from the git history.
> >
> > v1 patch: https://lore.kernel.org/all/[email protected]/
> >
> > .../bindings/watchdog/davinci-wdt.txt | 24 ----------
> > .../bindings/watchdog/ti,davinci-wdt.yaml | 47 +++++++++++++++++++
> > 2 files changed, 47 insertions(+), 24 deletions(-)
> > delete mode 100644 Documentation/devicetree/bindings/watchdog/davinci-wdt.txt
> > create mode 100644 Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/watchdog/davinci-wdt.txt b/Documentation/devicetree/bindings/watchdog/davinci-wdt.txt
> > deleted file mode 100644
> > index aa10b8ec36e2..000000000000
> > --- a/Documentation/devicetree/bindings/watchdog/davinci-wdt.txt
> > +++ /dev/null
> > @@ -1,24 +0,0 @@
> > -Texas Instruments DaVinci/Keystone Watchdog Timer (WDT) Controller
> > -
> > -Required properties:
> > -- compatible : Should be "ti,davinci-wdt", "ti,keystone-wdt"
> > -- reg : Should contain WDT registers location and length
> > -
> > -Optional properties:
> > -- timeout-sec : Contains the watchdog timeout in seconds
> > -- clocks : the clock feeding the watchdog timer.
> > - Needed if platform uses clocks.
> > - See clock-bindings.txt
> > -
> > -Documentation:
> > -Davinci DM646x - https://www.ti.com/lit/ug/spruer5b/spruer5b.pdf
> > -Keystone - https://www.ti.com/lit/ug/sprugv5a/sprugv5a.pdf
> > -
> > -Examples:
> > -
> > -wdt: wdt@2320000 {
> > - compatible = "ti,davinci-wdt";
> > - reg = <0x02320000 0x80>;
> > - timeout-sec = <30>;
> > - clocks = <&clkwdtimer0>;
> > -};
> > diff --git a/Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml b/Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml
> > new file mode 100644
> > index 000000000000..4747be98b7d9
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/watchdog/ti,davinci-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/ti,davinci-wdt.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Texas Instruments DaVinci/Keystone Watchdog Timer (WDT) Controller
> > +
> > +description: |
> > + Documentation:
> > + Davinci DM646x - https://www.ti.com/lit/ug/spruer5b/spruer5b.pdf
> > + Keystone - https://www.ti.com/lit/ug/sprugv5a/sprugv5a
> > +
> > +maintainers:
> > + - Murali Karicheri <[email protected]>
> > + - Ivan Khoronzhuk <[email protected]>
>
> Neither of these folks will be available for this, you can use me if
> you want an email that won't bounce for now.
>
> > +
> > +allOf:
> > + - $ref: watchdog.yaml#
> > +
> > +properties:
> > + compatible:
> > + enum:
> > + - ti,davinci-wdt
> > + - ti,keystone-wdt
> > +
> > + reg:
> > + maxItems: 1
> > +
> > + clocks:
> > + maxItems: 1
>
> We also have some instances with an optional power-domains prop.
>
> power-domains:
> description: A phandle and PM domain specifier as defined by bindings of
> the power controller specified by phandle. See
> Documentation/devicetree/bindings/power/power-domain.yaml for details.
But not what the schema should look like here. Same as others. How many
and what order if more than 1.
Rob