linux-kernel - [PATCH v2] spi: <linux/spi/spi.h>: add missing struct kernel-doc entry

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-next>] [day] [month] [year] [list]

Message-Id: <20210628210520.5712-1-rdunlap@infradead.org>
Date:   Mon, 28 Jun 2021 14:05:20 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     linux-kernel@...r.kernel.org
Cc:     Randy Dunlap <rdunlap@...radead.org>,
        "William A . Kennington III" <wak@...gle.com>,
        Mark Brown <broonie@...nel.org>, linux-spi@...r.kernel.org,
        Lukas Wunner <lukas@...ner.de>
Subject: [PATCH v2] spi: <linux/spi/spi.h>: add missing struct kernel-doc entry

Fix kernel-doc warning in spi.h by adding the missing kernel-doc entry
and also correct the original comment so that they both indicate the
correct polarity of the flag.

../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 <rdunlap@...radead.org>
Cc: William A. Kennington III <wak@...gle.com>
Cc: Mark Brown <broonie@...nel.org>
Cc: linux-spi@...r.kernel.org
Cc: Lukas Wunner <lukas@...ner.de>
---
v2: correct both comments for @devm_allocated to indicate the correct polarity
    (thanks, Lukas)

 include/linux/spi/spi.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

--- linux-next-20210628.orig/include/linux/spi/spi.h
+++ linux-next-20210628/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: whether the allocation of this struct is devres-managed
  * @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
@@ -511,7 +512,7 @@ struct spi_controller {
 
 #define SPI_MASTER_GPIO_SS		BIT(5)	/* GPIO CS must select slave */
 
-	/* flag indicating this is a non-devres managed controller */
+	/* flag indicating if the allocation of this struct is devres-managed */
 	bool			devm_allocated;
 
 	/* flag indicating this is an SPI slave controller */