linux-kernel - Re: [PATCH 01/19] amba: store owner from modules with amba_driver

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]

Date: Thu, 28 Mar 2024 10:09:57 +0100
From: Andi Shyti <andi.shyti@...nel.org>
To: Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>
Cc: Russell King <linux@...linux.org.uk>, 
	Suzuki K Poulose <suzuki.poulose@....com>, Mike Leach <mike.leach@...aro.org>, 
	James Clark <james.clark@....com>, Alexander Shishkin <alexander.shishkin@...ux.intel.com>, 
	Maxime Coquelin <mcoquelin.stm32@...il.com>, Alexandre Torgue <alexandre.torgue@...s.st.com>, 
	Linus Walleij <linus.walleij@...aro.org>, Olivia Mackall <olivia@...enic.com>, 
	Herbert Xu <herbert@...dor.apana.org.au>, Vinod Koul <vkoul@...nel.org>, 
	Dmitry Torokhov <dmitry.torokhov@...il.com>, Miquel Raynal <miquel.raynal@...tlin.com>, 
	Michal Simek <michal.simek@....com>, Eric Auger <eric.auger@...hat.com>, 
	Alex Williamson <alex.williamson@...hat.com>, linux-kernel@...r.kernel.org, coresight@...ts.linaro.org, 
	linux-arm-kernel@...ts.infradead.org, linux-stm32@...md-mailman.stormreply.com, 
	linux-i2c@...r.kernel.org, linux-crypto@...r.kernel.org, dmaengine@...r.kernel.org, 
	linux-input@...r.kernel.org, kvm@...r.kernel.org
Subject: Re: [PATCH 01/19] amba: store owner from modules with
 amba_driver_register()

Hi Krzysztof,

> >>  /**
> >> - *	amba_driver_register - register an AMBA device driver
> >> + *	__amba_driver_register - register an AMBA device driver
> >>   *	@drv: amba device driver structure
> >> + *	@owner: owning module/driver
> >>   *
> >>   *	Register an AMBA device driver with the Linux device model
> >>   *	core.  If devices pre-exist, the drivers probe function will
> >>   *	be called.
> >>   */
> >> -int amba_driver_register(struct amba_driver *drv)
> >> +int __amba_driver_register(struct amba_driver *drv,
> > 
> > ...
> > 
> >> +/*
> >> + * use a macro to avoid include chaining to get THIS_MODULE
> >> + */
> > 
> > Should the documentation be moved here? Well... I don't see any
> > documentation linking this file yet, but in case it comes we want
> > documented amba_driver_register() rather than
> > __amba_driver_register().
> > 
> 
> That's just a wrapper, not API... why would we care to have kerneldoc
> for it?

Because everyone should use the wrapper while the real function
will be used only once or twice.

I see also that this is a common practice which I don't surely
like.

In any case there is no documentation exported for AMBA so that
this discussion does not bring any tangible benefit.

So that, considering that it's a good improvement,

Reviewed-by: Andi Shyti <andi.shyti@...nel.org>

Andi