linux-kernel - Re: [PATCH v2 1/1] dt-bindings: watchdog: convert ziirave-wdt.txt to yaml

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <ZruKpJ08abhe9nwV@lizhi-Precision-Tower-5810>
Date: Tue, 13 Aug 2024 12:32:36 -0400
From: Frank Li <Frank.li@....com>
To: Conor Dooley <conor@...nel.org>
Cc: Wim Van Sebroeck <wim@...ux-watchdog.org>,
	Guenter Roeck <linux@...ck-us.net>, Rob Herring <robh@...nel.org>,
	Krzysztof Kozlowski <krzk+dt@...nel.org>,
	Conor Dooley <conor+dt@...nel.org>,
	"open list:WATCHDOG DEVICE DRIVERS" <linux-watchdog@...r.kernel.org>,
	"open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS" <devicetree@...r.kernel.org>,
	open list <linux-kernel@...r.kernel.org>, imx@...ts.linux.dev
Subject: Re: [PATCH v2 1/1] dt-bindings: watchdog: convert ziirave-wdt.txt to
 yaml

On Tue, Aug 13, 2024 at 05:09:52PM +0100, Conor Dooley wrote:
> On Mon, Aug 12, 2024 at 12:28:09PM -0400, Frank Li wrote:
> > Convert ziirave-wdt.txt to yaml format.
> >
> > Additional change:
> > - Add i2c node in example.
> > - Add ref to watchdog.yaml
> >
> > Fix below warning:
> > arch/arm64/boot/dts/freescale/imx8mq-zii-ultra-rmb3.dtb: /soc@...us@...00000/i2c@...40000/watchdog@38:
> > 	failed to match any schema with compatible: ['zii,rave-wdt']
> >
> > Signed-off-by: Frank Li <Frank.Li@....com>
> > ---
> > Change from v1 to v2
> > - add ref watchdog.yaml
> > - Remove timeout-sec
> > ---
> >  .../bindings/watchdog/zii,rave-wdt.yaml       | 47 +++++++++++++++++++
> >  .../bindings/watchdog/ziirave-wdt.txt         | 19 --------
> >  2 files changed, 47 insertions(+), 19 deletions(-)
> >  create mode 100644 Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
> >  delete mode 100644 Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
> >
> > diff --git a/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml b/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
> > new file mode 100644
> > index 0000000000000..0206d9ddf872d
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/watchdog/zii,rave-wdt.yaml
> > @@ -0,0 +1,47 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/watchdog/zii,rave-wdt.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Zodiac RAVE Watchdog Timer
> > +
> > +maintainers:
> > +  - Frank Li <Frank.Li@....com>
>
> When you're converting bindings, listing yourself as the maintainer only
> really makes sense if you know/care about the hardware IMO.

I faced this problem. I am not sure who I can put as maintainer. How to
decide binding doc maintainer? same as driver maintainer?

Frank

>
> > +
> > +properties:
> > +  compatible:
> > +    const: zii,rave-wdt
> > +
> > +  reg:
> > +    maxItems: 1
> > +    description: i2c slave address of device, usually 0x38
> > +
> > +  reset-duration-ms:
> > +    description:
> > +      Duration of the pulse generated when the watchdog times
> > +      out. Value in milliseconds.
>               ^^^^^^^^^^^^^^^^^^^^^
> This is obvious, and could have been dropped. Keep an eye out for things
> like that while doing conversions.
>
> Reviewed-by: Conor Dooley <conor.dooley@...rochip.com>
>
> Thanks,
> Conor.
>
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +allOf:
> > +  - $ref: watchdog.yaml#
> > +
> > +unevaluatedProperties: false
> > +
> > +examples:
> > +  - |
> > +    i2c {
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +
> > +        watchdog@38 {
> > +            compatible = "zii,rave-wdt";
> > +            reg = <0x38>;
> > +            timeout-sec = <30>;
> > +            reset-duration-ms = <30>;
> > +        };
> > +    };
> > +
> > diff --git a/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt b/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
> > deleted file mode 100644
> > index 3d878184ec3ff..0000000000000
> > --- a/Documentation/devicetree/bindings/watchdog/ziirave-wdt.txt
> > +++ /dev/null
> > @@ -1,19 +0,0 @@
> > -Zodiac RAVE Watchdog Timer
> > -
> > -Required properties:
> > -- compatible: must be "zii,rave-wdt"
> > -- reg: i2c slave address of device, usually 0x38
> > -
> > -Optional Properties:
> > -- timeout-sec: Watchdog timeout value in seconds.
> > -- reset-duration-ms: Duration of the pulse generated when the watchdog times
> > -  out. Value in milliseconds.
> > -
> > -Example:
> > -
> > -	watchdog@38 {
> > -		compatible = "zii,rave-wdt";
> > -		reg = <0x38>;
> > -		timeout-sec = <30>;
> > -		reset-duration-ms = <30>;
> > -	};
> > --
> > 2.34.1
> >
> >