Add documentation for the binding of window watchdog device.
Signed-off-by: Srinivas Neeli <[email protected]>
---
.../bindings/watchdog/xlnx,versal-wwdt.yaml | 49 +++++++++++++++++++
1 file changed, 49 insertions(+)
create mode 100644 Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml
diff --git a/Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml b/Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml
new file mode 100644
index 000000000000..986455efa6f4
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml
@@ -0,0 +1,49 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/xlnx,versal-wwdt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Xilinx Versal window watchdog timer controller
+
+maintainers:
+ - Neeli Srinivas <[email protected]>
+
+description:
+ Versal watchdog driver uses window watchdog mode. Window watchdog
+ timer(WWDT) contains closed(first) and open(second) window with
+ 32 bit width. Write to the watchdog timer within predefined window
+ periods of time. This means a period that is not too soon and a
+ period that is not too late. The WWDT has to be restarted within
+ the open window time. If software tries to restart WWDT outside of
+ the open window time period, it generates a reset.
+
+properties:
+ compatible:
+ enum:
+ - xlnx,versal-wwdt-1.0
+
+ reg:
+ maxItems: 1
+
+ clocks:
+ maxItems: 1
+
+ timeout-sec: true
+
+required:
+ - compatible
+ - reg
+ - clocks
+
+additionalProperties: false
+
+examples:
+ - |
+ watchdog@fd4d0000 {
+ compatible = "xlnx,versal-wwdt-1.0";
+ reg = <0xfd4d0000 0x10000>;
+ clocks = <&clock25>;
+ timeout-sec = <30>;
+ };
+...
--
2.17.1
On Tue, Sep 27, 2022 at 04:32:55PM +0530, Srinivas Neeli wrote:
> Add documentation for the binding of window watchdog device.
Subject space is precious, but you say 'watchdog' and 'binding
documentation' (dt-bindings) twice.
>
> Signed-off-by: Srinivas Neeli <[email protected]>
> ---
> .../bindings/watchdog/xlnx,versal-wwdt.yaml | 49 +++++++++++++++++++
> 1 file changed, 49 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml
>
> diff --git a/Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml b/Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml
> new file mode 100644
> index 000000000000..986455efa6f4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml
> @@ -0,0 +1,49 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/watchdog/xlnx,versal-wwdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Xilinx Versal window watchdog timer controller
> +
> +maintainers:
> + - Neeli Srinivas <[email protected]>
> +
> +description:
> + Versal watchdog driver uses window watchdog mode. Window watchdog
> + timer(WWDT) contains closed(first) and open(second) window with
> + 32 bit width. Write to the watchdog timer within predefined window
> + periods of time. This means a period that is not too soon and a
> + period that is not too late. The WWDT has to be restarted within
> + the open window time. If software tries to restart WWDT outside of
> + the open window time period, it generates a reset.
> +
> +properties:
> + compatible:
> + enum:
> + - xlnx,versal-wwdt-1.0
1.0 versions feel made up. Is this a soft IP, because that is really the
only place we use version numbers. More generally, version numbers need
to correspond to something.
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 1
> +
> + timeout-sec: true
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + watchdog@fd4d0000 {
> + compatible = "xlnx,versal-wwdt-1.0";
> + reg = <0xfd4d0000 0x10000>;
> + clocks = <&clock25>;
> + timeout-sec = <30>;
> + };
> +...
> --
> 2.17.1
>
>
On 27/09/2022 13:02, Srinivas Neeli wrote:
> Add documentation for the binding of window watchdog device.
>
> Signed-off-by: Srinivas Neeli <[email protected]>
> ---
> .../bindings/watchdog/xlnx,versal-wwdt.yaml | 49 +++++++++++++++++++
> 1 file changed, 49 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml
>
> diff --git a/Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml b/Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml
> new file mode 100644
> index 000000000000..986455efa6f4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/xlnx,versal-wwdt.yaml
> @@ -0,0 +1,49 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/watchdog/xlnx,versal-wwdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Xilinx Versal window watchdog timer controller
> +
> +maintainers:
> + - Neeli Srinivas <[email protected]>
> +
> +description:
> + Versal watchdog driver uses window watchdog mode. Window watchdog
> + timer(WWDT) contains closed(first) and open(second) window with
> + 32 bit width. Write to the watchdog timer within predefined window
> + periods of time. This means a period that is not too soon and a
> + period that is not too late. The WWDT has to be restarted within
> + the open window time. If software tries to restart WWDT outside of
> + the open window time period, it generates a reset.
> +
Missing ref to watchdog.
> +properties:
> + compatible:
> + enum:
> + - xlnx,versal-wwdt-1.0
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + maxItems: 1
> +
> + timeout-sec: true
This can be dropped.
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> +
> +additionalProperties: false
and this then can be unevaluatedProperties:false
> +
> +examples:
> + - |
> + watchdog@fd4d0000 {
Use 4 spaces for example indentation.
> + compatible = "xlnx,versal-wwdt-1.0";
> + reg = <0xfd4d0000 0x10000>;
> + clocks = <&clock25>;
> + timeout-sec = <30>;
> + };
> +...
Best regards,
Krzysztof