spi: correct kernel-doc inconsistency
authorColton Lewis <colton.w.lewis@protonmail.com>
Sat, 25 Jul 2020 05:02:57 +0000 (05:02 +0000)
committerMark Brown <broonie@kernel.org>
Mon, 27 Jul 2020 13:55:22 +0000 (14:55 +0100)
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>
include/linux/spi/spi.h

index f8b721fcd5c61cf9a778ca787927a02b0b562ed7..99380c0825dbe1818460556312fee5d23c9c9fc1 100644 (file)
@@ -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
@@ -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.