History

spi: correct kernel-doc inconsistency

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

Colton Lewis committed 6 years ago

Commit cfd97f91 parent 241b8881 file · +2 −6Browse files

Showing the changes to include/linux (1 of 1 file). Show all

Unified · Split

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