Unverified Commit 5dfac65b authored by David Jander's avatar David Jander Committed by Mark Brown
Browse files

spi: <linux/spi/spi.h>: Add missing documentation for struct members 



Fixes these "make htmldocs" warnings:

include/linux/spi/spi.h:82: warning: Function parameter or member 'syncp' not described in 'spi_statistics'
include/linux/spi/spi.h:213: warning: Function parameter or member 'pcpu_statistics' not described in 'spi_device'
include/linux/spi/spi.h:676: warning: Function parameter or member 'pcpu_statistics' not described in 'spi_controller'

Fixes: 6598b91b ("spi: spi.c: Convert statistics to per-cpu u64_stats_t")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: default avatarDavid Jander <david@protonic.nl>
Reviewed-by: default avatarAndy Shevchenko <andy.shevchenko@gmail.com>
Link: https://lore.kernel.org/r/20220608153309.2899565-1-david@protonic.nl


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 9723070e

include/linux/spi/spi.h

+4 −3
Original line number Diff line number Diff line
@@ -35,7 +35,8 @@ extern struct bus_type spi_bus_type; 


/**

 * struct spi_statistics - statistics for spi transfers

 * @lock:          lock protecting this structure

 * @syncp:         seqcount to protect members in this struct for per-cpu udate

 *                 on 32-bit systems

 *

 * @messages:      number of spi-messages handled

 * @transfers:     number of spi_transfers handled
@@ -155,7 +156,7 @@ extern int spi_delay_exec(struct spi_delay *_delay, struct spi_transfer *xfer); 
 * @cs_inactive: delay to be introduced by the controller after CS is

 *	deasserted. If @cs_change_delay is used from @spi_transfer, then the

 *	two delays will be added up.

 * @statistics: statistics for the spi_device

 * @pcpu_statistics: statistics for the spi_device

 *

 * A @spi_device is used to interchange data between an SPI slave

 * (usually a discrete chip) and CPU memory.
@@ -439,7 +440,7 @@ extern struct spi_device *spi_new_ancillary_device(struct spi_device *spi, u8 ch 
 * @max_native_cs: When cs_gpiods is used, and this field is filled in,

 *	spi_register_controller() will validate all native CS (including the

 *	unused native CS) against this value.

 * @statistics: statistics for the spi_controller

 * @pcpu_statistics: statistics for the spi_controller

 * @dma_tx: DMA transmit channel

 * @dma_rx: DMA receive channel

 * @dummy_rx: dummy receive buffer for full-duplex devices