Skip to content

Commit

Permalink
spi: correct kernel-doc inconsistency
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Colton Lewis authored and Mark Brown committed Jul 27, 2020
1 parent 241b888 commit cfd97f9
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions include/linux/spi/spi.h
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,7 @@ static inline void spi_unregister_driver(struct spi_driver *sdrv)
* every chipselect is connected to a slave.
* @dma_alignment: SPI controller constraint on DMA buffers alignment.
* @mode_bits: flags understood by this controller driver
* @buswidth_override_bits: flags to override for this controller driver
* @bits_per_word_mask: A mask indicating which values of bits_per_word are
* supported by the driver. Bit n indicates that a bits_per_word n+1 is
* supported. If set, the SPI core will reject any transfer with an
Expand Down Expand Up @@ -846,12 +847,7 @@ extern void spi_res_release(struct spi_controller *ctlr,
* processed the word, i.e. the "pre" timestamp should be taken before
* transmitting the "pre" word, and the "post" timestamp after receiving
* transmit confirmation from the controller for the "post" word.
* @timestamped_pre: Set by the SPI controller driver to denote it has acted
* upon the @ptp_sts request. Not set when the SPI core has taken care of
* the task. SPI device drivers are free to print a warning if this comes
* back unset and they need the better resolution.
* @timestamped_post: See above. The reason why both exist is that these
* booleans are also used to keep state in the core SPI logic.
* @timestamped: true if the transfer has been timestamped
* @error: Error status logged by spi controller driver.
*
* SPI transfers always write the same number of bytes as they read.
Expand Down

0 comments on commit cfd97f9

Please sign in to comment.