[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-ID: <20240704100450.67182233@fedora-2.home>
Date: Thu, 4 Jul 2024 10:04:50 +0200
From: Maxime Chevallier <maxime.chevallier@...tlin.com>
To: "Russell King (Oracle)" <linux@...linux.org.uk>
Cc: davem@...emloft.net, netdev@...r.kernel.org,
linux-kernel@...r.kernel.org, thomas.petazzoni@...tlin.com, Andrew Lunn
<andrew@...n.ch>, Jakub Kicinski <kuba@...nel.org>, Eric Dumazet
<edumazet@...gle.com>, Paolo Abeni <pabeni@...hat.com>,
linux-arm-kernel@...ts.infradead.org, Christophe Leroy
<christophe.leroy@...roup.eu>, Herve Codina <herve.codina@...tlin.com>,
Florian Fainelli <f.fainelli@...il.com>, Heiner Kallweit
<hkallweit1@...il.com>, Vladimir Oltean <vladimir.oltean@....com>,
Köry Maincent <kory.maincent@...tlin.com>, Jesse Brandeburg
<jesse.brandeburg@...el.com>, Marek Behún
<kabel@...nel.org>, Piergiorgio Beruto <piergiorgio.beruto@...il.com>,
Oleksij Rempel <o.rempel@...gutronix.de>, Nicolò Veronese
<nicveronese@...il.com>, Simon Horman <horms@...nel.org>,
mwojtas@...omium.org, Nathan Chancellor <nathan@...nel.org>, Antoine Tenart
<atenart@...nel.org>, Marc Kleine-Budde <mkl@...gutronix.de>, Dan Carpenter
<dan.carpenter@...aro.org>
Subject: Re: [PATCH net-next v15 04/14] net: sfp: Add helper to return the
SFP bus name
Hello Russell,
On Wed, 3 Jul 2024 16:36:20 +0100
"Russell King (Oracle)" <linux@...linux.org.uk> wrote:
> On Wed, Jul 03, 2024 at 04:07:54PM +0200, Maxime Chevallier wrote:
> > Knowing the bus name is helpful when we want to expose the link topology
> > to userspace, add a helper to return the SFP bus name.
>
> I think it's worth mentioning about the use case in this patch as well,
> something like:
>
> "This call will always be made while holding the RTNL which ensures
> that the SFP driver won't unbind from the device. The returned pointer
> to the bus name will only be used while RTNL is held."
I'll add that in both the commit log and the documentation for the
function.
[...]
> > +EXPORT_SYMBOL_GPL(sfp_get_name);
>
> Please move this to just below sfp_bus_del_upstream() since the
> functions in this file are organised as:
>
> - internal functions
> - upstream callable functions
> - downstream (sfp driver) callable functions.
>
> Note also that the upstream callable functions are all documented with
> kerneldoc, and sfp_get_name() is clearly a function called from the
> upstream side.
No problem, I'll move it and a some proper documentation. Thanks for
the review,
Maxime
Powered by blists - more mailing lists