linux-kernel - Re: [PATCH] docs: dt-bindings: add DTS Coding Style document

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: <3266223.44csPzL39Z@phil>
Date:   Thu, 16 Nov 2023 21:03:12 +0100
From:   Heiko Stuebner <heiko@...ech.de>
To:     Rob Herring <robh+dt@...nel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@...aro.org>,
        Conor Dooley <conor+dt@...nel.org>, devicetree@...r.kernel.org,
        linux-kernel@...r.kernel.org,
        Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
Cc:     AngeloGioacchino Del Regno 
        <angelogioacchino.delregno@...labora.com>,
        Arnd Bergmann <arnd@...db.de>,
        Bjorn Andersson <andersson@...nel.org>,
        Geert Uytterhoeven <geert+renesas@...der.be>,
        Konrad Dybcio <konrad.dybcio@...aro.org>,
        Matthias Brugger <matthias.bgg@...il.com>,
        Michal Simek <michal.simek@....com>,
        Neil Armstrong <neil.armstrong@...aro.org>,
        Nishanth Menon <nm@...com>, Olof Johansson <olof@...om.net>
Subject: Re: [PATCH] docs: dt-bindings: add DTS Coding Style document

Am Donnerstag, 16. November 2023, 20:51:24 CET schrieb Krzysztof Kozlowski:
> On 16/11/2023 20:26, Heiko Stuebner wrote:
> > Hi Krzysztof,
> > Am Donnerstag, 16. November 2023, 19:12:18 CET schrieb Krzysztof Kozlowski:
> >> Document preferred coding style for Devicetree sources (DTS and DTSI),
> >> to bring consistency among all (sub)architectures and ease in reviews.
> >>
> >> Cc: AngeloGioacchino Del Regno <angelogioacchino.delregno@...labora.com>
> >> Cc: Arnd Bergmann <arnd@...db.de>
> >> Cc: Bjorn Andersson <andersson@...nel.org>
> >> Cc: Geert Uytterhoeven <geert+renesas@...der.be>
> >> Cc: Heiko Stuebner <heiko@...ech.de>
> >> Cc: Konrad Dybcio <konrad.dybcio@...aro.org>
> >> Cc: Matthias Brugger <matthias.bgg@...il.com>
> >> Cc: Michal Simek <michal.simek@....com>
> >> Cc: Neil Armstrong <neil.armstrong@...aro.org>
> >> Cc: Nishanth Menon <nm@...com>
> >> Cc: Olof Johansson <olof@...om.net>
> >> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
> >>
> > 
> >> +Order of Properties in Device Node
> >> +----------------------------------
> >> +
> >> +Following order of properties in device nodes is preferred:
> >> +
> >> +1. compatible
> >> +2. reg
> >> +3. ranges
> >> +4. All properties with values
> >> +5. Boolean properties
> > 
> > I guess the only thing I do have questions about is the part
> > 
> >> +4. All properties with values
> >> +5. Boolean properties
> > 
> > Is there a rationale for it? Because with it things like regulator-*
> > properties then end up in two different blocks.
> 
> Good point. It is only a matter of style that this:
> 
> foo {
> 	compatible = "foo";
> 	reg = <0x1>;
> 	clocks = <&clk>;
> 	wakeup-source;
> 	key-autorepeat;
> }
> 
> looks better to me than:
> 
> 
> foo {
> 	compatible = "foo";
> 	reg = <0x1>;
> 	key-autorepeat;
> 	wakeup-source;
> 	clocks = <&clk>;
> }
> 
> But you have good point that similar properties should be usually
> grouped together.
> 
> About which regulator properties are you thinking now? You mean the
> supplies or the provider?

I was thinking about the provider. There are 
	regulator-min-microvolt = <>;
and friends, but also
	regulator-boot-on;


I guess I would just go with

1. compatible
2. reg
3. ranges
4. All other properties
5. status (if applicable)
6. Child nodes

aka grouping the old 4+5 together. The difference is probably minimal
but doesn't create corner cases and you don't need to know if a property
has a value or is boolean when looking for it.


Heiko