spi: axi-spi-engine: fix struct member doc warnings
authorDavid Lechner <dlechner@baylibre.com>
Mon, 18 Dec 2023 14:53:45 +0000 (08:53 -0600)
committerMark Brown <broonie@kernel.org>
Mon, 18 Dec 2023 15:43:00 +0000 (15:43 +0000)
The build bots are complaining that the members of struct
spi_engine_message_state are not described. This adds the
proper @name: syntax to the comments to fix this.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202312182101.QOWovo29-lkp@intel.com/
Signed-off-by: David Lechner <dlechner@baylibre.com>
Link: https://msgid.link/r/20231218145348.339470-1-dlechner@baylibre.com
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/spi/spi-axi-spi-engine.c

index 58280dd1c901ba9b2207843302cd20d05dac4e38..9ace259d2d29d6f9147e2348e9d98c0d707c008b 100644 (file)
@@ -85,25 +85,25 @@ struct spi_engine_program {
  * struct spi_engine_message_state - SPI engine per-message state
  */
 struct spi_engine_message_state {
-       /** Instructions for executing this message. */
+       /** @p: Instructions for executing this message. */
        struct spi_engine_program *p;
-       /** Number of elements in cmd_buf array. */
+       /** @cmd_length: Number of elements in cmd_buf array. */
        unsigned cmd_length;
-       /** Array of commands not yet written to CMD FIFO. */
+       /** @cmd_buf: Array of commands not yet written to CMD FIFO. */
        const uint16_t *cmd_buf;
-       /** Next xfer with tx_buf not yet fully written to TX FIFO. */
+       /** @tx_xfer: Next xfer with tx_buf not yet fully written to TX FIFO. */
        struct spi_transfer *tx_xfer;
-       /** Size of tx_buf in bytes. */
+       /** @tx_length: Size of tx_buf in bytes. */
        unsigned int tx_length;
-       /** Bytes not yet written to TX FIFO. */
+       /** @tx_buf: Bytes not yet written to TX FIFO. */
        const uint8_t *tx_buf;
-       /** Next xfer with rx_buf not yet fully written to RX FIFO. */
+       /** @rx_xfer: Next xfer with rx_buf not yet fully written to RX FIFO. */
        struct spi_transfer *rx_xfer;
-       /** Size of tx_buf in bytes. */
+       /** @rx_length: Size of tx_buf in bytes. */
        unsigned int rx_length;
-       /** Bytes not yet written to the RX FIFO. */
+       /** @rx_buf: Bytes not yet written to the RX FIFO. */
        uint8_t *rx_buf;
-       /** ID to correlate SYNC interrupts with this message. */
+       /** @sync_id: ID to correlate SYNC interrupts with this message. */
        u8 sync_id;
 };