diff mbox series

[v3] dt-bindings: watchdog: davinci-wdt: convert txt to yaml

Message ID 20231026195313.76756-1-n2h9z4@gmail.com
State New
Headers show
Series [v3] dt-bindings: watchdog: davinci-wdt: convert txt to yaml | expand

Commit Message

Nik Bune Oct. 26, 2023, 7:53 p.m. UTC
Convert txt file to yaml.
Add maintainers list.
Mark clock as required property, by reviewer's suggestion.
Add power-domains as optional property, by reviewer's suggestion. 

Signed-off-by: Nik Bune <n2h9z4@gmail.com>
---

Changes in 3 (according to review comments):
- Added Andrew Davis <afd@ti.com> into maintainers list.
- Added power-domains property.

v2 patch: https://lore.kernel.org/all/20231024195839.49607-1-n2h9z4@gmail.com/


 .../bindings/watchdog/davinci-wdt.txt         | 24 ---------
 .../bindings/watchdog/ti,davinci-wdt.yaml     | 52 +++++++++++++++++++
 2 files changed, 52 insertions(+), 24 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/watchdog/davinci-wdt.txt
 create mode 100644 Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml

Comments

Conor Dooley Oct. 27, 2023, 2:14 p.m. UTC | #1
Hey,

On Thu, Oct 26, 2023 at 09:53:13PM +0200, Nik Bune wrote:
> Convert txt file to yaml.
> Add maintainers list.
> Mark clock as required property, by reviewer's suggestion.
> Add power-domains as optional property, by reviewer's suggestion. 
> 
> Signed-off-by: Nik Bune <n2h9z4@gmail.com>
> ---
> 
> Changes in 3 (according to review comments):
> - Added Andrew Davis <afd@ti.com> into maintainers list.
> - Added power-domains property.
> 
> v2 patch: https://lore.kernel.org/all/20231024195839.49607-1-n2h9z4@gmail.com/
> 
> 
>  .../bindings/watchdog/davinci-wdt.txt         | 24 ---------
>  .../bindings/watchdog/ti,davinci-wdt.yaml     | 52 +++++++++++++++++++
>  2 files changed, 52 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..17c824f2fc7d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml
> @@ -0,0 +1,52 @@
> +# 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:
> +  - Andrew Davis <afd@ti.com>
> +
> +allOf:
> +  - $ref: watchdog.yaml#
> +
> +properties:
> +  compatible:
> +    enum:
> +      - ti,davinci-wdt
> +      - ti,keystone-wdt
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  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.

I think you missed Rob's comment in reply to Andrew, about constraining
and ordering the power-domains:
https://lore.kernel.org/all/20231026203037.GA327324-robh@kernel.org/

Cheers,
Conor.

> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    watchdog@2320000 {
> +        compatible = "ti,davinci-wdt";
> +        reg = <0x02320000 0x80>;
> +        timeout-sec = <30>;
> +        clocks = <&clkwdtimer0>;
> +    };
> -- 
> 2.34.1
>
Nik Bune Oct. 28, 2023, 5:51 p.m. UTC | #2
Hello! 
Thank you for your review. 

>On Fri, 27 Oct 2023 at 16:14, Conor Dooley <conor@kernel.org> wrote:
>Hey,
>
>On Thu, Oct 26, 2023 at 09:53:13PM +0200, Nik Bune wrote:
>> Convert txt file to yaml.
>> Add maintainers list.
>> Mark clock as required property, by reviewer's suggestion.
>> Add power-domains as optional property, by reviewer's suggestion.
>>
>> Signed-off-by: Nik Bune <n2h9z4@gmail.com>
>> ---
>>
>> Changes in 3 (according to review comments):
>> - Added Andrew Davis <afd@ti.com> into maintainers list.
>> - Added power-domains property.
>>
>> v2 patch: https://lore.kernel.org/all/20231024195839.49607-1-n2h9z4@gmail.com/
>>
>>
>>  .../bindings/watchdog/davinci-wdt.txt         | 24 ---------
>>  .../bindings/watchdog/ti,davinci-wdt.yaml     | 52 +++++++++++++++++++
>>  2 files changed, 52 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..17c824f2fc7d
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml
>> @@ -0,0 +1,52 @@
>> +# 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:
>> +  - Andrew Davis <afd@ti.com>
>> +
>> +allOf:
>> +  - $ref: watchdog.yaml#
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - ti,davinci-wdt
>> +      - ti,keystone-wdt
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  clocks:
>> +    maxItems: 1
>> +
>> +  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.
>
>I think you missed Rob's comment in reply to Andrew, about constraining
>and ordering the power-domains:
>https://lore.kernel.org/all/20231026203037.GA327324-robh@kernel.org/
>
>Cheers,
>Conor.

I didn't get what should be done with respect to the comment above:
Should we wait for the response from Andrew, 
or should we skip and remove the the power-domains definition for this binding, 
or add "maxItems: 1" to power-domains definition?

Thanks, Nik. 

>
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - clocks
>> +
>> +unevaluatedProperties: false
>> +
>> +examples:
>> +  - |
>> +    watchdog@2320000 {
>> +        compatible = "ti,davinci-wdt";
>> +        reg = <0x02320000 0x80>;
>> +        timeout-sec = <30>;
>> +        clocks = <&clkwdtimer0>;
>> +    };
>> --
>> 2.34.1
>>
Krzysztof Kozlowski Oct. 29, 2023, 7:31 a.m. UTC | #3
On 28/10/2023 19:51, Nik Bune wrote:
>>> +  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.
>>
>> I think you missed Rob's comment in reply to Andrew, about constraining
>> and ordering the power-domains:
>> https://lore.kernel.org/all/20231026203037.GA327324-robh@kernel.org/
>>
>> Cheers,
>> Conor.
> 
> I didn't get what should be done with respect to the comment above:
> Should we wait for the response from Andrew, 
> or should we skip and remove the the power-domains definition for this binding, 
> or add "maxItems: 1" to power-domains definition?

None of the options above allow to send the same code without maxItems.
Sending new version without addressing feedback is basically ignoring
the feedback and next time you will have annoyed reviewers...

Best regards,
Krzysztof
diff mbox series

Patch

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..17c824f2fc7d
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/ti,davinci-wdt.yaml
@@ -0,0 +1,52 @@ 
+# 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:
+  - Andrew Davis <afd@ti.com>
+
+allOf:
+  - $ref: watchdog.yaml#
+
+properties:
+  compatible:
+    enum:
+      - ti,davinci-wdt
+      - ti,keystone-wdt
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  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.
+
+required:
+  - compatible
+  - reg
+  - clocks
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    watchdog@2320000 {
+        compatible = "ti,davinci-wdt";
+        reg = <0x02320000 0x80>;
+        timeout-sec = <30>;
+        clocks = <&clkwdtimer0>;
+    };