Skip to contentSkip to conversation

dt-bindings: watchdog: convert faraday,ftwdt010 to yaml

PATCH Superseded Corentin Labbe 3 participants 3 messages Feb 10, 2022

Subsystems (2)

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 dt-bindings: watchdog: convert faraday,ftwdt010 to yaml

Converts watchdog/faraday,ftwdt010.txt to yaml.
This permits to detect missing properties like clocks and resets or compatible like moxa,moxart-watchdog.

---
Changes since v1:
- Added myself as maintainer as requested by Linus
- Added $ref to watchdog.yaml
- Removed useless quotes
- Added blank lines between properties
- Removed timeout-sec as already provided by watchdog.yaml

Change since v2:
- rewrite compatible section

 .../bindings/watchdog/faraday,ftwdt010.txt    | 22 -------
 .../bindings/watchdog/faraday,ftwdt010.yaml   | 66 +++++++++++++++++++
 2 files changed, 66 insertions(+), 22 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.txt
 create mode 100644 Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml
Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.txt deleted +0 -22
deleted file mode 100644
index 9ecdb502e605..000000000000
@@ -1,22 +0,0 @@
-Faraday Technology FTWDT010 watchdog
-
-This is an IP part from Faraday Technology found in the Gemini
-SoCs and others.
-
-Required properties:
-- compatible : must be one of
-  "faraday,ftwdt010"
-  "cortina,gemini-watchdog", "faraday,ftwdt010"
-- reg : shall contain base register location and length
-- interrupts : shall contain the interrupt for the watchdog
-
-Optional properties:
-- timeout-sec : the default watchdog timeout in seconds.
-
-Example:
-
-watchdog@41000000 {
-	compatible = "faraday,ftwdt010";
-	reg = <0x41000000 0x1000>;
-	interrupts = <3 IRQ_TYPE_LEVEL_HIGH>;
-};
Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml new file +66 -0

66 lines not on this page · raw message

Signature · 1 line
2.34.1
#1 lore raw
Quoted 75 lines · Corentin Labbe

Converts watchdog/faraday,ftwdt010.txt to yaml.
This permits to detect missing properties like clocks and resets or compatible like moxa,moxart-watchdog.

---
Changes since v1:
- Added myself as maintainer as requested by Linus
- Added $ref to watchdog.yaml
- Removed useless quotes
- Added blank lines between properties
- Removed timeout-sec as already provided by watchdog.yaml

Change since v2:
- rewrite compatible section

 .../bindings/watchdog/faraday,ftwdt010.txt    | 22 -------
 .../bindings/watchdog/faraday,ftwdt010.yaml   | 66 +++++++++++++++++++
 2 files changed, 66 insertions(+), 22 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.txt
 create mode 100644 Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml
Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.txt deleted +0 -22
deleted file mode 100644
index 9ecdb502e605..000000000000
@@ -1,22 +0,0 @@
-Faraday Technology FTWDT010 watchdog
-
-This is an IP part from Faraday Technology found in the Gemini
-SoCs and others.
-
-Required properties:
-- compatible : must be one of
-  "faraday,ftwdt010"
-  "cortina,gemini-watchdog", "faraday,ftwdt010"
-- reg : shall contain base register location and length
-- interrupts : shall contain the interrupt for the watchdog
-
-Optional properties:
-- timeout-sec : the default watchdog timeout in seconds.
-
-Example:
-
-watchdog@41000000 {
-	compatible = "faraday,ftwdt010";
-	reg = <0x41000000 0x1000>;
-	interrupts = <3 IRQ_TYPE_LEVEL_HIGH>;
-};
Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml new file +18 -0
new file mode 100644
index 000000000000..e7b90ba41093
@@ -0,0 +1,66 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/faraday,ftwdt010.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Faraday Technology FTWDT010 watchdog
+
+maintainers:
+  - Linus Walleij <[email protected]>
+  - Corentin Labbe <[email protected]>
+
+description: |
+  This is an IP part from Faraday Technology found in the Gemini
+  SoCs and others.
+
+allOf:
+  - $ref: "watchdog.yaml#"

Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml line 28

Quoted 10 lines
Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml new file +10 -0
+
+properties:
+  compatible:
+    oneOf:
+      - const: faraday,ftwdt010
+      - items:
+        - enum:
+          - cortina,gemini-watchdog
+          - moxa,moxart-watchdog
+        - const: faraday,ftwdt010

I think you have indentation warnings.

Quoted 11 lines
Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml new file +11 -0
+
+  reg:
+    maxItems: 1
+
+  resets:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:

Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml line 49

Quoted 10 lines
Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml new file +10 -0
+    const: PCLK
+
+  interrupts:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false

Are you sure your DTSes don't have warnings? You include watchdog.yaml schema (good) so here should be unevaluatedProperties to accept ones mentioned there.

Just add "timeout-sec" to example below to see the error.

Quoted 7 lines
Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml new file +7 -0
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/irq.h>
+    watchdog@41000000 {
+      compatible = "faraday,ftwdt010";
+      reg = <0x41000000 0x1000>;

Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml line 66

Quoted 10 lines
Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml new file +10 -0
+      interrupts = <3 IRQ_TYPE_LEVEL_HIGH>;
+    };
+  - |
+    watchdog: watchdog@98500000 {
+      compatible = "moxa,moxart-watchdog", "faraday,ftwdt010";
+      reg = <0x98500000 0x10>;
+      clocks = <&clk_apb>;
+      clock-names = "PCLK";
+    };
+...

Best regards,
Krzysztof

maintainer
#2 lore raw
In reply to Corentin Labbe
Quoted 14 lines · Corentin Labbe

Converts watchdog/faraday,ftwdt010.txt to yaml.
This permits to detect missing properties like clocks and resets or compatible like moxa,moxart-watchdog.

---
Changes since v1:
- Added myself as maintainer as requested by Linus
- Added $ref to watchdog.yaml
- Removed useless quotes
- Added blank lines between properties
- Removed timeout-sec as already provided by watchdog.yaml

Quoted 9 lines

Change since v2:
- rewrite compatible section

 .../bindings/watchdog/faraday,ftwdt010.txt    | 22 -------
 .../bindings/watchdog/faraday,ftwdt010.yaml   | 66 +++++++++++++++++++
 2 files changed, 66 insertions(+), 22 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.txt
 create mode 100644 Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check' on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:
./Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml:25:9: [warning] wrong indentation: expected 10 but found 8 (indentation) ./Documentation/devicetree/bindings/watchdog/faraday,ftwdt010.yaml:26:11: [warning] wrong indentation: expected 12 but found 10 (indentation)

dtschema/dtc warnings/errors:

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/1591202

This check can fail if there are any dependencies. The base for a patch series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above error(s), then make sure 'yamllint' is installed and dt-schema is up to date:

pip3 install dtschema --upgrade

Please check and re-submit.