diff mbox series

[1/2] dt-bindings: watchdog: marvell octeonTX2 GTI watchdog driver

Message ID 20230324145652.19221-1-bbhushan2@marvell.com (mailing list archive)
State Rejected
Headers show
Series [1/2] dt-bindings: watchdog: marvell octeonTX2 GTI watchdog driver | expand

Commit Message

Bharat Bhushan March 24, 2023, 2:56 p.m. UTC 
Add binding documentation for the Marvell octeonTX2
GTI watchdog driver.

Signed-off-by: Bharat Bhushan <bbhushan2@marvell.com>
---
 .../watchdog/marvel-octeontx2-wdt.yaml        | 43 +++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml

Comments

Rob Herring March 24, 2023, 8:17 p.m. UTC | #1 
On Fri, 24 Mar 2023 20:26:51 +0530, Bharat Bhushan wrote:
> Add binding documentation for the Marvell octeonTX2
> GTI watchdog driver.
> 
> Signed-off-by: Bharat Bhushan <bbhushan2@marvell.com>
> ---
>  .../watchdog/marvel-octeontx2-wdt.yaml        | 43 +++++++++++++++++++
>  1 file changed, 43 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.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/marvel-octeontx2-wdt.yaml:28:2: [warning] wrong indentation: expected 2 but found 1 (indentation)

dtschema/dtc warnings/errors:
/builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.example.dtb: watch-dog@802000040000: $nodename:0: 'watch-dog@802000040000' does not match '^(timer|watchdog)(@.*|-[0-9a-f])?$'
	From schema: /builds/robherring/dt-review-ci/linux/Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20230324145652.19221-1-bbhushan2@marvell.com

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

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 after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
Rob Herring March 24, 2023, 8:34 p.m. UTC | #2 
On Fri, Mar 24, 2023 at 08:26:51PM +0530, Bharat Bhushan wrote:
> Add binding documentation for the Marvell octeonTX2
> GTI watchdog driver.
> 
> Signed-off-by: Bharat Bhushan <bbhushan2@marvell.com>
> ---
>  .../watchdog/marvel-octeontx2-wdt.yaml        | 43 +++++++++++++++++++

The comics?

Use compatible string for filename.

>  1 file changed, 43 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml
> 
> diff --git a/Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml b/Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml
> new file mode 100644
> index 000000000000..586b3c1bd780
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml
> @@ -0,0 +1,43 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/watchdog/marvel-octeontx2-wdt.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Marvell OcteonTX2 GTI watchdog
> +
> +allOf:
> +  - $ref: "watchdog.yaml#"

Drop quotes

> +
> +maintainers:
> +  - Bharat Bhushan <bbhushan2@marvell.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - mrvl,octeontx2-gti-wdt

'mrvl' is deprecated. Use 'marvell'

> +
> +  reg:
> +    maxItems: 2

Need to define what each entry is.

> +
> +  interrupts:
> +    minItems: 1
> +    maxItems: 36

Need to define what each entry is. How does the h/w have a variable 
number of interrupts?

> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    watch-dog@802000040000 {

watchdog@...

> +      compatible = "mrvl,octeontx2-gti-wdt";
> +      reg = <0x8020 0x40000 0x0 0x20000>;
> +      interrupts = <0 38 1>, /* Core-0 */
> +                   <0 39 1>; /* Core-1 */
> +    };
> +
> +...
> -- 
> 2.17.1
>
Bharat Bhushan April 13, 2023, 10:14 a.m. UTC | #3 
Please see inline

> -----Original Message-----
> From: Rob Herring <robh@kernel.org>
> Sent: Saturday, March 25, 2023 2:05 AM
> To: Bharat Bhushan <bbhushan2@marvell.com>
> Cc: wim@linux-watchdog.org; linux@roeck-us.net;
> krzysztof.kozlowski+dt@linaro.org; linux-watchdog@vger.kernel.org;
> devicetree@vger.kernel.org; linux-kernel@vger.kernel.org
> Subject: [EXT] Re: [PATCH 1/2] dt-bindings: watchdog: marvell octeonTX2 GTI
> watchdog driver
> 
> External Email
> 
> ----------------------------------------------------------------------
> On Fri, Mar 24, 2023 at 08:26:51PM +0530, Bharat Bhushan wrote:
> > Add binding documentation for the Marvell octeonTX2 GTI watchdog
> > driver.
> >
> > Signed-off-by: Bharat Bhushan <bbhushan2@marvell.com>
> > ---
> >  .../watchdog/marvel-octeontx2-wdt.yaml        | 43 +++++++++++++++++++
> 
> The comics?
> 
> Use compatible string for filename.

Sorry for late reply, just returned from vacation. Thanks for review.

Will fix all these issues. Also run "make dt_binding_check".

Thanks
-Bharat

> 
> >  1 file changed, 43 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml
> >
> > diff --git
> > a/Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml
> > b/Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml
> > new file mode 100644
> > index 000000000000..586b3c1bd780
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.
> > +++ yaml
> > @@ -0,0 +1,43 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id:
> > +https://urldefense.proofpoint.com/v2/url?u=http-3A__devicetree.org_sc
> > +hemas_watchdog_marvel-2Docteontx2-2Dwdt.yaml-
> 23&d=DwIBAg&c=nKjWec2b6R
> >
> +0mOyPaz7xtfQ&r=PAAlWswPe7d8gHlGbCLmy2YezyK7O3Hv_t2heGnouBw&m=
> Ut_moFc_
> >
> +jI4JG2ZlRAaLIL9HLPOI2Thz6WmALCu5SENmtKrGa0M4tN0m5TP0eBw5&s=J3P7a
> QnYY3
> > +pKqoGp1-eiSsINlof1pAh3u-aLn4tfrLk&e=
> > +$schema:
> > +https://urldefense.proofpoint.com/v2/url?u=http-3A__devicetree.org_me
> > +ta-2Dschemas_core.yaml-
> 23&d=DwIBAg&c=nKjWec2b6R0mOyPaz7xtfQ&r=PAAlWsw
> >
> +Pe7d8gHlGbCLmy2YezyK7O3Hv_t2heGnouBw&m=Ut_moFc_jI4JG2ZlRAaLIL9HL
> POI2T
> >
> +hz6WmALCu5SENmtKrGa0M4tN0m5TP0eBw5&s=GdtkUc3_hrJV0gvS1Eviv1mxf
> KMLIv7Y
> > +IohR76Dtkmc&e=
> > +
> > +title: Marvell OcteonTX2 GTI watchdog
> > +
> > +allOf:
> > +  - $ref: "watchdog.yaml#"
> 
> Drop quotes
> 
> > +
> > +maintainers:
> > +  - Bharat Bhushan <bbhushan2@marvell.com>
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - mrvl,octeontx2-gti-wdt
> 
> 'mrvl' is deprecated. Use 'marvell'
> 
> > +
> > +  reg:
> > +    maxItems: 2
> 
> Need to define what each entry is.
> 
> > +
> > +  interrupts:
> > +    minItems: 1
> > +    maxItems: 36
> 
> Need to define what each entry is. How does the h/w have a variable number of
> interrupts?
> 
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - interrupts
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    watch-dog@802000040000 {
> 
> watchdog@...
> 
> > +      compatible = "mrvl,octeontx2-gti-wdt";
> > +      reg = <0x8020 0x40000 0x0 0x20000>;
> > +      interrupts = <0 38 1>, /* Core-0 */
> > +                   <0 39 1>; /* Core-1 */
> > +    };
> > +
> > +...
> > --
> > 2.17.1
> >
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml b/Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml
new file mode 100644
index 000000000000..586b3c1bd780
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/marvel-octeontx2-wdt.yaml
@@ -0,0 +1,43 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/marvel-octeontx2-wdt.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Marvell OcteonTX2 GTI watchdog
+
+allOf:
+  - $ref: "watchdog.yaml#"
+
+maintainers:
+  - Bharat Bhushan <bbhushan2@marvell.com>
+
+properties:
+  compatible:
+    enum:
+      - mrvl,octeontx2-gti-wdt
+
+  reg:
+    maxItems: 2
+
+  interrupts:
+    minItems: 1
+    maxItems: 36
+
+required:
+ - compatible
+ - reg
+ - interrupts
+
+additionalProperties: false
+
+examples:
+  - |
+    watch-dog@802000040000 {
+      compatible = "mrvl,octeontx2-gti-wdt";
+      reg = <0x8020 0x40000 0x0 0x20000>;
+      interrupts = <0 38 1>, /* Core-0 */
+                   <0 39 1>; /* Core-1 */
+    };
+
+...