Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

spi: correct kernel-doc inconsistency

Silence documentation build warnings by correcting kernel-doc comment
for spi_transfer struct.

Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
Link: https://lore.kernel.org/r/20200725050242.279548-1-colton.w.lewis@protonmail.com
Signed-off-by: Mark Brown <broonie@kernel.org>

authored by

Colton Lewis and committed by
Mark Brown
cfd97f94 241b8887

+2 -6
+2 -6
include/linux/spi/spi.h
··· 329 329 * every chipselect is connected to a slave. 330 330 * @dma_alignment: SPI controller constraint on DMA buffers alignment. 331 331 * @mode_bits: flags understood by this controller driver 332 + * @buswidth_override_bits: flags to override for this controller driver 332 333 * @bits_per_word_mask: A mask indicating which values of bits_per_word are 333 334 * supported by the driver. Bit n indicates that a bits_per_word n+1 is 334 335 * supported. If set, the SPI core will reject any transfer with an ··· 847 846 * processed the word, i.e. the "pre" timestamp should be taken before 848 847 * transmitting the "pre" word, and the "post" timestamp after receiving 849 848 * transmit confirmation from the controller for the "post" word. 850 - * @timestamped_pre: Set by the SPI controller driver to denote it has acted 851 - * upon the @ptp_sts request. Not set when the SPI core has taken care of 852 - * the task. SPI device drivers are free to print a warning if this comes 853 - * back unset and they need the better resolution. 854 - * @timestamped_post: See above. The reason why both exist is that these 855 - * booleans are also used to keep state in the core SPI logic. 849 + * @timestamped: true if the transfer has been timestamped 856 850 * @error: Error status logged by spi controller driver. 857 851 * 858 852 * SPI transfers always write the same number of bytes as they read.