linux-kernel - Re: [RFC PATCH 1/2] dt: bindings: as3645a: Update dt node example with standard

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: <4192002.yKJgEXTVKE@avalon>
Date:   Wed, 13 Dec 2017 10:09:04 +0200
From:   Laurent Pinchart <laurent.pinchart@...asonboard.com>
To:     Dan Murphy <dmurphy@...com>
Cc:     robh+dt@...nel.org, mark.rutland@....com, rpurdie@...ys.net,
        jacek.anaszewski@...il.com, pavel@....cz, sakari.ailus@....fi,
        devicetree@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-leds@...r.kernel.org
Subject: Re: [RFC PATCH 1/2] dt: bindings: as3645a: Update dt node example with standard

Hi Dan,

Thank you for the patch.

On Tuesday, 12 December 2017 23:50:23 EET Dan Murphy wrote:
> Update the DT binding to remove the device name from
> the DT parent node as well as removing the device
> name from the label.  The LED label will be generated
> based off the id name stored in the local driver so
> the LED function can be indicated in the label DT
> entry.
> 
> Also removed the indentation on the example.

This makes the patch a bit harder to review and seems to be a matter of style.

> Signed-off-by: Dan Murphy <dmurphy@...com>
> ---
>  .../devicetree/bindings/leds/ams,as3645a.txt       | 36 ++++++++++---------
>  1 file changed, 18 insertions(+), 18 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/leds/ams,as3645a.txt
> b/Documentation/devicetree/bindings/leds/ams,as3645a.txt index
> fc7f5f9f234c..122aa7165cf3 100644
> --- a/Documentation/devicetree/bindings/leds/ams,as3645a.txt
> +++ b/Documentation/devicetree/bindings/leds/ams,as3645a.txt
> @@ -58,22 +58,22 @@ label		: The label of the indicator LED.

I believe you should expand the documentation of the label property to detail 
how it should be formed. It's nice to update the example, but the bindings 
should be understandable without it.

>  Example
>  =======
> 
> -	as3645a@30 {
> -		compatible = "ams,as3645a";
> -		#address-cells = <1>;
> -		#size-cells = <0>;
> -		reg = <0x30>;
> -		flash@0 {
> -			reg = <0x0>;
> -			flash-timeout-us = <150000>;
> -			flash-max-microamp = <320000>;
> -			led-max-microamp = <60000>;
> -			ams,input-max-microamp = <1750000>;
> -			label = "as3645a:flash";
> -		};
> -		indicator@1 {
> -			reg = <0x1>;
> -			led-max-microamp = <10000>;
> -			label = "as3645a:indicator";
> -		};
> +led-controller@30 {

This change looks fine to me.

> +	compatible = "ams,as3645a";
> +	#address-cells = <1>;
> +	#size-cells = <0>;
> +	reg = <0x30>;
> +	led@0 {

What's the rationale for changing the node name here ? It should be explained 
in the commit message, and in the DT bindings documentation.

> +		reg = <0x0>;
> +		flash-timeout-us = <150000>;
> +		flash-max-microamp = <320000>;
> +		led-max-microamp = <60000>;
> +		ams,input-max-microamp = <1750000>;
> +		label = "flash";
>  	};
> +	led@1 {
> +		reg = <0x1>;
> +		led-max-microamp = <10000>;
> +		label = "indicator";
> +	};
> +};

-- 
Regards,

Laurent Pinchart