diff mbox series

[v3,1/2] watchdog: bindings: Add binding documentation for Toshiba Visconti watchdog device

Message ID 20200920051807.288034-2-nobuhiro1.iwamatsu@toshiba.co.jp (mailing list archive)
State Superseded
Headers show
Series Add WDT driver for Toshiba Visconti ARM SoC | expand

Commit Message

Nobuhiro Iwamatsu Sept. 20, 2020, 5:18 a.m. UTC
Add documentation for the binding of Toshiba Visconti SoC's watchdog.

Signed-off-by: Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>
---
 .../watchdog/toshiba,visconti-wdt.yaml        | 49 +++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml

Comments

Punit Agrawal Sept. 21, 2020, 7:27 a.m. UTC | #1
Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp> writes:

> Add documentation for the binding of Toshiba Visconti SoC's watchdog.
>
> Signed-off-by: Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>
> ---
>  .../watchdog/toshiba,visconti-wdt.yaml        | 49 +++++++++++++++++++
>  1 file changed, 49 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml
>
> diff --git a/Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml b/Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml
> new file mode 100644
> index 000000000000..721e38fa5a0f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml
> @@ -0,0 +1,49 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +# Copyright 2020 Toshiba Electronic Devices & Storage Corporation
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/watchdog/toshiba,visconti-wdt.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Toshiba Visconti SoCs PIUWDT Watchdog timer
> +
> +maintainers:
> +  - Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>
> +
> +allOf:
> +  - $ref: watchdog.yaml#
> +
> +properties:
> +  compatible:
> +    enum:
> +      - toshiba,visconti-wdt
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +
> +examples:
> +  - |
> +    soc {
> +        #address-cells = <2>;
> +        #size-cells = <2>;
> +
> +        wdt_clk: wdt-clk {
> +            compatible = "fixed-clock";
> +            clock-frequency = <150000000>;
> +            #clock-cells = <0>;
> +        };
> +
> +        watchdog@28330000 {
> +            compatible = "toshiba,visconti-wdt";
> +            reg = <0 0x28330000 0 0x1000>;
> +            clocks = <&wdt_clk>;
> +        };

I was going to suggest adding the "timeout-sec" property as described in
watchdog.yaml but both code and usage seems to suggest it is optional.

> +    };

So,

Reviewed-by: Punit Agrawal <punit1.agrawal@toshiba.co.jp>

Thanks.
Nobuhiro Iwamatsu Sept. 21, 2020, 8:43 a.m. UTC | #2
Hi,

Thanks for you review.

On Mon, Sep 21, 2020 at 04:27:25PM +0900, Punit Agrawal wrote:
> Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp> writes:
> 
> > Add documentation for the binding of Toshiba Visconti SoC's watchdog.
> >
> > Signed-off-by: Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>
> > ---
> >  .../watchdog/toshiba,visconti-wdt.yaml        | 49 +++++++++++++++++++
> >  1 file changed, 49 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml b/Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml
> > new file mode 100644
> > index 000000000000..721e38fa5a0f
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml
> > @@ -0,0 +1,49 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +# Copyright 2020 Toshiba Electronic Devices & Storage Corporation
> > +%YAML 1.2
> > +---
> > +$id: "http://devicetree.org/schemas/watchdog/toshiba,visconti-wdt.yaml#"
> > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> > +
> > +title: Toshiba Visconti SoCs PIUWDT Watchdog timer
> > +
> > +maintainers:
> > +  - Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>
> > +
> > +allOf:
> > +  - $ref: watchdog.yaml#
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - toshiba,visconti-wdt
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - clocks
> > +
> > +examples:
> > +  - |
> > +    soc {
> > +        #address-cells = <2>;
> > +        #size-cells = <2>;
> > +
> > +        wdt_clk: wdt-clk {
> > +            compatible = "fixed-clock";
> > +            clock-frequency = <150000000>;
> > +            #clock-cells = <0>;
> > +        };
> > +
> > +        watchdog@28330000 {
> > +            compatible = "toshiba,visconti-wdt";
> > +            reg = <0 0x28330000 0 0x1000>;
> > +            clocks = <&wdt_clk>;
> > +        };
> 
> I was going to suggest adding the "timeout-sec" property as described in
> watchdog.yaml but both code and usage seems to suggest it is optional.
> 

I see. I will add about timeout-sec property. 


> > +    };
> 
> So,
> 
> Reviewed-by: Punit Agrawal <punit1.agrawal@toshiba.co.jp>
> 

Thanks!


> Thanks.
>

Best regards,
  Nobuhiro
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml b/Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml
new file mode 100644
index 000000000000..721e38fa5a0f
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/toshiba,visconti-wdt.yaml
@@ -0,0 +1,49 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+# Copyright 2020 Toshiba Electronic Devices & Storage Corporation
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/watchdog/toshiba,visconti-wdt.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Toshiba Visconti SoCs PIUWDT Watchdog timer
+
+maintainers:
+  - Nobuhiro Iwamatsu <nobuhiro1.iwamatsu@toshiba.co.jp>
+
+allOf:
+  - $ref: watchdog.yaml#
+
+properties:
+  compatible:
+    enum:
+      - toshiba,visconti-wdt
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - clocks
+
+examples:
+  - |
+    soc {
+        #address-cells = <2>;
+        #size-cells = <2>;
+
+        wdt_clk: wdt-clk {
+            compatible = "fixed-clock";
+            clock-frequency = <150000000>;
+            #clock-cells = <0>;
+        };
+
+        watchdog@28330000 {
+            compatible = "toshiba,visconti-wdt";
+            reg = <0 0x28330000 0 0x1000>;
+            clocks = <&wdt_clk>;
+        };
+    };