linux-kernel - [PATCH v2] spi: spi.h: add missing kernel-doc for @last_cs_index

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: <20240328223340.17159-1-rdunlap@infradead.org>
Date: Thu, 28 Mar 2024 15:33:40 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Mark Brown <broonie@...nel.org>,
	Andy Shevchenko <andy@...nel.org>,
	linux-spi@...r.kernel.org,
	Amit Kumar Mahapatra <amit.kumar-mahapatra@....com>
Subject: [PATCH v2] spi: spi.h: add missing kernel-doc for @last_cs_index_mask

kernel-doc complains about last_cs_index_mask not described, so add its
description.

spi.h:778: warning: Function parameter or struct member 'last_cs_index_mask' not described in 'spi_controller'

Fixes: 4d8ff6b0991d ("spi: Add multi-cs memories support in SPI core")
Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
---
Cc: Mark Brown <broonie@...nel.org>
Cc: Andy Shevchenko <andy@...nel.org>
Cc: linux-spi@...r.kernel.org
Cc: Amit Kumar Mahapatra <amit.kumar-mahapatra@....com>

v2: fix spello in commit message (Andy)
    add Fixes: tag (Andy)

 include/linux/spi/spi.h |    1 +
 1 file changed, 1 insertion(+)

diff -- a/include/linux/spi/spi.h b/include/linux/spi/spi.h
--- a/include/linux/spi/spi.h
+++ b/include/linux/spi/spi.h
@@ -453,6 +453,7 @@ extern struct spi_device *spi_new_ancill
  * @last_cs_mode_high: was (mode & SPI_CS_HIGH) true on the last call to set_cs.
  * @last_cs: the last chip_select that is recorded by set_cs, -1 on non chip
  *           selected
+ * @last_cs_index_mask: bit mask the last chip selects that were used
  * @xfer_completion: used by core transfer_one_message()
  * @busy: message pump is busy
  * @running: message pump is running