2023-11-04 18:29:40

by Nik Bune

Subject: [PATCH] dt-bindings: watchdog: nxp,pnx4008-wdt: convert txt to yaml

Convert txt file to yaml. Add maintainers from git blame.

Signed-off-by: Nik Bune <[email protected]>
---
.../bindings/watchdog/nxp,pnx4008-wdt.yaml | 34 +++++++++++++++++++
.../bindings/watchdog/pnx4008-wdt.txt | 17 ----------
2 files changed, 34 insertions(+), 17 deletions(-)
create mode 100644 Documentation/devicetree/bindings/watchdog/nxp,pnx4008-wdt.yaml
delete mode 100644 Documentation/devicetree/bindings/watchdog/pnx4008-wdt.txt

diff --git a/Documentation/devicetree/bindings/watchdog/nxp,pnx4008-wdt.yaml b/Documentation/devicetree/bindings/watchdog/nxp,pnx4008-wdt.yaml
new file mode 100644
index 000000000000..86b691a339b5
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/nxp,pnx4008-wdt.yaml
@@ -0,0 +1,34 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/nxp,pnx4008-wdt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP PNX watchdog timer
+
+allOf:
+ - $ref: watchdog.yaml#
+
+maintainers:
+ - Roland Stigge <[email protected]>
+
+properties:
+ compatible:
+ const: nxp,pnx4008-wdt
+
+ reg:
+ maxItems: 1
+
+unevaluatedProperties: false
+
+required:
+ - compatible
+ - reg
+
+examples:
+ - |
+ watchdog@4003c000 {
+ compatible = "nxp,pnx4008-wdt";
+ reg = <0x4003C000 0x1000>;
+ timeout-sec = <10>;
+ };
diff --git a/Documentation/devicetree/bindings/watchdog/pnx4008-wdt.txt b/Documentation/devicetree/bindings/watchdog/pnx4008-wdt.txt
deleted file mode 100644
index 4b76bec62af9..000000000000
--- a/Documentation/devicetree/bindings/watchdog/pnx4008-wdt.txt
+++ /dev/null
@@ -1,17 +0,0 @@
-* NXP PNX watchdog timer
-
-Required properties:
-- compatible: must be "nxp,pnx4008-wdt"
-- reg: physical base address of the controller and length of memory mapped
- region.
-
-Optional properties:
-- timeout-sec: contains the watchdog timeout in seconds.
-
-Example:
-
- watchdog@4003c000 {
- compatible = "nxp,pnx4008-wdt";
- reg = <0x4003C000 0x1000>;
- timeout-sec = <10>;
- };
--
2.34.1

2023-11-05 18:30:59

by Krzysztof Kozlowski

Subject: Re: [PATCH] dt-bindings: watchdog: nxp,pnx4008-wdt: convert txt to yaml

On 04/11/2023 19:28, Nik Bune wrote:
> Convert txt file to yaml. Add maintainers from git blame.
>
> Signed-off-by: Nik Bune <[email protected]>

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


> ---
> .../bindings/watchdog/nxp,pnx4008-wdt.yaml | 34 +++++++++++++++++++
> .../bindings/watchdog/pnx4008-wdt.txt | 17 ----------
> 2 files changed, 34 insertions(+), 17 deletions(-)
> create mode 100644 Documentation/devicetree/bindings/watchdog/nxp,pnx4008-wdt.yaml
> delete mode 100644 Documentation/devicetree/bindings/watchdog/pnx4008-wdt.txt
>
> diff --git a/Documentation/devicetree/bindings/watchdog/nxp,pnx4008-wdt.yaml b/Documentation/devicetree/bindings/watchdog/nxp,pnx4008-wdt.yaml
> new file mode 100644
> index 000000000000..86b691a339b5
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/nxp,pnx4008-wdt.yaml
> @@ -0,0 +1,34 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/watchdog/nxp,pnx4008-wdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: NXP PNX watchdog timer
> +
> +allOf:
> + - $ref: watchdog.yaml#

Put allOf: after maintainers: block. I know that many files do not
follow this convention...

> +
> +maintainers:
> + - Roland Stigge <[email protected]>
> +
> +properties:
> + compatible:
> + const: nxp,pnx4008-wdt
> +
> + reg:
> + maxItems: 1
> +
> +unevaluatedProperties: false

And this goes after required: block.

> +
> +required:
> + - compatible
> + - reg
> +
> +examples:
> + - |
> + watchdog@4003c000 {
> + compatible = "nxp,pnx4008-wdt";
> + reg = <0x4003C000 0x1000>;

Lower-case hex please.

> + timeout-sec = <10>;
> + };


Best regards,
Krzysztof