linux-kernel - Re: [PATCH net-next 4/4] checkpatch: check for comment explaining rgmii(|-rxid|-txid) PHY modes

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: <800a61d80a2c6cfa4a5a64d904a2127e60eafc29.camel@ew.tq-group.com>
Date: Wed, 16 Apr 2025 09:48:12 +0200
From: Matthias Schiffer <matthias.schiffer@...tq-group.com>
To: Joe Perches <joe@...ches.com>
Cc: Andrew Lunn <andrew+netdev@...n.ch>, "David S. Miller"
 <davem@...emloft.net>,  Eric Dumazet <edumazet@...gle.com>, Jakub Kicinski
 <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>, Rob Herring
 <robh@...nel.org>, Krzysztof Kozlowski <krzk+dt@...nel.org>, Conor Dooley
 <conor+dt@...nel.org>, Andy Whitcroft <apw@...onical.com>, Dwaipayan Ray
 <dwaipayanray1@...il.com>, Lukas Bulwahn <lukas.bulwahn@...il.com>,
 Jonathan Corbet <corbet@....net>, Nishanth Menon <nm@...com>, Vignesh
 Raghavendra <vigneshr@...com>,  Siddharth Vadapalli <s-vadapalli@...com>,
 Roger Quadros <rogerq@...nel.org>, Tero Kristo <kristo@...nel.org>,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, 
 netdev@...r.kernel.org, devicetree@...r.kernel.org, 
 linux-arm-kernel@...ts.infradead.org, linux@...tq-group.com, Andrew Lunn
 <andrew@...n.ch>
Subject: Re: [PATCH net-next 4/4] checkpatch: check for comment explaining
 rgmii(|-rxid|-txid) PHY modes

On Tue, 2025-04-15 at 09:11 -0700, Joe Perches wrote:
> 
> On 2025-04-15 03:18, Matthias Schiffer wrote:
> > Historially, the RGMII PHY modes specified in Device Trees have been
> > used inconsistently, often referring to the usage of delays on the PHY
> > side rather than describing the board; many drivers still implement 
> > this
> > incorrectly.
> > 
> > Require a comment in Devices Trees using these modes (usually 
> > mentioning
> > that the delay is relalized
> 
> realized
> 
> > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> > index 784912f570e9d..57fcbd4b63ede 100755
> > --- a/scripts/checkpatch.pl
> > +++ b/scripts/checkpatch.pl
> > @@ -3735,6 +3735,17 @@ sub process {
> >  			}
> >  		}
> > 
> > +# Check for RGMII phy-mode with delay on PCB
> > +		if ($realfile =~ /\.dtsi?$/ && $line =~ 
> > /^\+\s*(phy-mode|phy-connection-type)\s*=\s*"/ &&
> > +		    !ctx_has_comment($first_line, $linenr)) {
> 
> Not sure where $first_line comes from and unsure if this works on 
> patches rather than complete files.
> 
> Does it?

Yes, it works both with patches and full files. I'm using ctx_has_comment() the
same way existing checks do - I think $first_line refers to the start of the
current context for patch files. I have also verified that it only matches on
comments directly above the phy-mode line in question.

Best,
Matthias

-- 
TQ-Systems GmbH | Mühlstraße 2, Gut Delling | 82229 Seefeld, Germany
Amtsgericht München, HRB 105018
Geschäftsführer: Detlef Schneider, Rüdiger Stahl, Stefan Schneider
https://www.tq-group.com/