[PATCH v2] dt-bindings: watchdog: brcm,kona-wdt: convert txt file to yaml

[PATCH v2] dt-bindings: watchdog: brcm,kona-wdt: convert txt file to yaml

[Nikita Bondarenko]

Remove device tree binding in txt
Add device tree binding in json-schema


Signed-off-by: Nikita Bondarenko <n2h9z4@gmail.com>
---

Changes in v2, according to review comments:
- use subject prefixes matching the subsystem in patch subject
- add commit message
- update the list of maintainers: add here all maintainers returned by scripts/get_maintainer.p who are marked as "maintainer:BROADCOM BCM281XX/BCM11XXX/BCM216XX"
- remove quotes in - $ref: watchdog.yaml#
- remove description for reg
- leave one example
- add all SoCs mentioned in txt file description to compatible enum values 

Both checks (dtbs_check, dt_binding_check) return no error:

make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dtbs_check
  LINT    Documentation/devicetree/bindings
  CHKDT   Documentation/devicetree/bindings/processed-schema.json
  SCHEMA  Documentation/devicetree/bindings/processed-schema.json

make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dt_binding_check
  LINT    Documentation/devicetree/bindings
  CHKDT   Documentation/devicetree/bindings/processed-schema.json
  SCHEMA  Documentation/devicetree/bindings/processed-schema.json
  DTEX    Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dts
  DTC_CHK Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dtb

 .../bindings/watchdog/brcm,kona-wdt.txt       | 15 -------
 .../bindings/watchdog/brcm,kona-wdt.yaml      | 45 +++++++++++++++++++
 2 files changed, 45 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..c7627c00556a
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml
@@ -0,0 +1,45 @@
+# 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
+
+description: |
+  This watchdog timer is used in the following Broadcom SoCs:
+  BCM11130, BCM11140, BCM11351, BCM28145, BCM28155
+
+maintainers:
+  - Florian Fainelli <f.fainelli@gmail.com>
+  - Ray Jui <rjui@broadcom.com>
+  - Scott Branden <sbranden@broadcom.com>
+
+allOf:
+  - $ref: watchdog.yaml#
+
+properties:
+  compatible:
+    enum:
+      - brcm,bcm11130-wdt
+      - brcm,bcm11140-wdt
+      - brcm,bcm11351-wdt
+      - brcm,bcm28145-wdt
+      - brcm,bcm28155-wdt
+      - brcm,kona-wdt
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    watchdog@35002f40 {
+      compatible = "brcm,bcm11130-wdt";
+      reg = <0x35002f40 0x6c>;
+    };
-- 
2.34.1

Re: [PATCH v2] dt-bindings: watchdog: brcm,kona-wdt: convert txt file to yaml

[Rob Herring]

On Sun, 02 Apr 2023 15:55:55 +0200, Nikita Bondarenko wrote:
> Remove device tree binding in txt
> Add device tree binding in json-schema

Write complete sentences. The commit msg purpose is not to explain the 
diff, we can read that. The purpose is to explain why though we don't 
need much reasoning why for conversions. What is useful is any fixes or 
changes you made to the binding (only because the existing binding 
didn't match reality). For example, there's a mismatch in the 
compatible. If you aren't adjusting the schema, then it means you think 
the .dts file is wrong and it needs to be fixed.

> 
> 

Single blank line here.

> Signed-off-by: Nikita Bondarenko <n2h9z4@gmail.com>
> ---
> 
> Changes in v2, according to review comments:
> - use subject prefixes matching the subsystem in patch subject
> - add commit message
> - update the list of maintainers: add here all maintainers returned by scripts/get_maintainer.p who are marked as "maintainer:BROADCOM BCM281XX/BCM11XXX/BCM216XX"
> - remove quotes in - $ref: watchdog.yaml#
> - remove description for reg
> - leave one example
> - add all SoCs mentioned in txt file description to compatible enum values
> 
> Both checks (dtbs_check, dt_binding_check) return no error:
> 
> make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dtbs_check
>   LINT    Documentation/devicetree/bindings
>   CHKDT   Documentation/devicetree/bindings/processed-schema.json
>   SCHEMA  Documentation/devicetree/bindings/processed-schema.json

Doesn't match what I get below...

> 
> make  DT_SCHEMA_FILES=Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.yaml ARCH=arm dt_binding_check
>   LINT    Documentation/devicetree/bindings
>   CHKDT   Documentation/devicetree/bindings/processed-schema.json
>   SCHEMA  Documentation/devicetree/bindings/processed-schema.json
>   DTEX    Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dts
>   DTC_CHK Documentation/devicetree/bindings/watchdog/brcm,kona-wdt.example.dtb
> 
>  .../bindings/watchdog/brcm,kona-wdt.txt       | 15 -------
>  .../bindings/watchdog/brcm,kona-wdt.yaml      | 45 +++++++++++++++++++
>  2 files changed, 45 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
> 

Running 'make dtbs_check' with the schema in this patch gives the
following warnings. Consider if they are expected or the schema is
incorrect. These may not be new warnings.

Note that it is not yet a requirement to have 0 warnings for dtbs_check.
This will change in the future.

Full log is available here: https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230402135555.62507-1-n2h9z4@gmail.com


watchdog@35002f40: compatible: ['brcm,bcm11351-wdt', 'brcm,kona-wdt'] is too long
	arch/arm/boot/dts/bcm28155-ap.dtb

watchdog@35002f40: Unevaluated properties are not allowed ('compatible' was unexpected)
	arch/arm/boot/dts/bcm28155-ap.dtb