Skip to content

Commit 15009a1

Browse files
dlechbroonie
authored andcommitted
spi: axi-spi-engine: fix struct member doc warnings
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>
1 parent 644f315 commit 15009a1

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

drivers/spi/spi-axi-spi-engine.c

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -85,25 +85,25 @@ struct spi_engine_program {
8585
* struct spi_engine_message_state - SPI engine per-message state
8686
*/
8787
struct spi_engine_message_state {
88-
/** Instructions for executing this message. */
88+
/** @p: Instructions for executing this message. */
8989
struct spi_engine_program *p;
90-
/** Number of elements in cmd_buf array. */
90+
/** @cmd_length: Number of elements in cmd_buf array. */
9191
unsigned cmd_length;
92-
/** Array of commands not yet written to CMD FIFO. */
92+
/** @cmd_buf: Array of commands not yet written to CMD FIFO. */
9393
const uint16_t *cmd_buf;
94-
/** Next xfer with tx_buf not yet fully written to TX FIFO. */
94+
/** @tx_xfer: Next xfer with tx_buf not yet fully written to TX FIFO. */
9595
struct spi_transfer *tx_xfer;
96-
/** Size of tx_buf in bytes. */
96+
/** @tx_length: Size of tx_buf in bytes. */
9797
unsigned int tx_length;
98-
/** Bytes not yet written to TX FIFO. */
98+
/** @tx_buf: Bytes not yet written to TX FIFO. */
9999
const uint8_t *tx_buf;
100-
/** Next xfer with rx_buf not yet fully written to RX FIFO. */
100+
/** @rx_xfer: Next xfer with rx_buf not yet fully written to RX FIFO. */
101101
struct spi_transfer *rx_xfer;
102-
/** Size of tx_buf in bytes. */
102+
/** @rx_length: Size of tx_buf in bytes. */
103103
unsigned int rx_length;
104-
/** Bytes not yet written to the RX FIFO. */
104+
/** @rx_buf: Bytes not yet written to the RX FIFO. */
105105
uint8_t *rx_buf;
106-
/** ID to correlate SYNC interrupts with this message. */
106+
/** @sync_id: ID to correlate SYNC interrupts with this message. */
107107
u8 sync_id;
108108
};
109109

0 commit comments

Comments
 (0)