Fix kernel-doc warning in spi.h:
../include/linux/spi/spi.h:673: warning: Function parameter or member 'devm_allocated' not described in 'spi_controller'
Fixes: 794aaf01444d ("spi: Fix use-after-free with devm_spi_alloc_*")
Signed-off-by: Randy Dunlap <[email protected]>
Cc: William A. Kennington III <[email protected]>
Cc: Mark Brown <[email protected]>
Cc: [email protected]
---
include/linux/spi/spi.h | 1 +
1 file changed, 1 insertion(+)
--- linux-next-20210625.orig/include/linux/spi/spi.h
+++ linux-next-20210625/include/linux/spi/spi.h
@@ -339,6 +339,7 @@ extern struct spi_device *spi_new_ancill
* @max_speed_hz: Highest supported transfer speed
* @flags: other constraints relevant to this driver
* @slave: indicates that this is an SPI slave controller
+ * @devm_allocated: flag indicating this is a non-devres managed controller
* @max_transfer_size: function that returns the max transfer size for
* a &spi_device; may be %NULL, so the default %SIZE_MAX will be used.
* @max_message_size: function that returns the max message size for
On Sun, Jun 27, 2021 at 05:40:23PM -0700, Randy Dunlap wrote:
> --- linux-next-20210625.orig/include/linux/spi/spi.h
> +++ linux-next-20210625/include/linux/spi/spi.h
> @@ -339,6 +339,7 @@ extern struct spi_device *spi_new_ancill
> * @max_speed_hz: Highest supported transfer speed
> * @flags: other constraints relevant to this driver
> * @slave: indicates that this is an SPI slave controller
> + * @devm_allocated: flag indicating this is a non-devres managed controller
Actually the flag indicates that the *allocation* of the controller *is*
devres-managed, so instead of the above I'd suggest something along the
lines of:
* @devm_allocated: whether allocation of this struct is devres-managed
Thanks,
Lukas
On 6/28/21 12:05 AM, Lukas Wunner wrote:
> On Sun, Jun 27, 2021 at 05:40:23PM -0700, Randy Dunlap wrote:
>> --- linux-next-20210625.orig/include/linux/spi/spi.h
>> +++ linux-next-20210625/include/linux/spi/spi.h
>> @@ -339,6 +339,7 @@ extern struct spi_device *spi_new_ancill
>> * @max_speed_hz: Highest supported transfer speed
>> * @flags: other constraints relevant to this driver
>> * @slave: indicates that this is an SPI slave controller
>> + * @devm_allocated: flag indicating this is a non-devres managed controller
>
> Actually the flag indicates that the *allocation* of the controller *is*
> devres-managed, so instead of the above I'd suggest something along the
> lines of:
>
> * @devm_allocated: whether allocation of this struct is devres-managed
>
> Thanks,
Hi Lukas,
OK, I'll change it like that.
I had just copied a comment from below in that same file.
I think that I should fix that comment as well.
Thanks.