spi: spi-topcliff-pch: Add missing descriptions to 'struct pch_spi_data'
authorLee Jones <lee.jones@linaro.org>
Fri, 17 Jul 2020 13:54:21 +0000 (14:54 +0100)
committerMark Brown <broonie@kernel.org>
Fri, 17 Jul 2020 15:38:53 +0000 (16:38 +0100)
Fixes the following W=1 kernel build warning(s):

 drivers/spi/spi-topcliff-pch.c:184: warning: Function parameter or member 'io_base_addr' not described in 'pch_spi_data'
 drivers/spi/spi-topcliff-pch.c:184: warning: Function parameter or member 'pkt_tx_buff' not described in 'pch_spi_data'
 drivers/spi/spi-topcliff-pch.c:184: warning: Function parameter or member 'pkt_rx_buff' not described in 'pch_spi_data'
 drivers/spi/spi-topcliff-pch.c:184: warning: Function parameter or member 'dma' not described in 'pch_spi_data'
 drivers/spi/spi-topcliff-pch.c:184: warning: Function parameter or member 'use_dma' not described in 'pch_spi_data'
 drivers/spi/spi-topcliff-pch.c:184: warning: Function parameter or member 'save_total_len' not described in 'pch_spi_data'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200717135424.2442271-12-lee.jones@linaro.org
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/spi/spi-topcliff-pch.c

index d7ea6af..baadd38 100644 (file)
@@ -122,6 +122,7 @@ struct pch_spi_dma_ctrl {
 /**
  * struct pch_spi_data - Holds the SPI channel specific details
  * @io_remap_addr:             The remapped PCI base address
+ * @io_base_addr:              Base address
  * @master:                    Pointer to the SPI master structure
  * @work:                      Reference to work queue handler
  * @wait:                      Wait queue for waking up upon receiving an
@@ -138,8 +139,8 @@ struct pch_spi_dma_ctrl {
  *                             transfer
  * @rx_index:                  Receive data count; for bookkeeping during
  *                             transfer
- * @tx_buff:                   Buffer for data to be transmitted
- * @rx_index:                  Buffer for Received data
+ * @pkt_tx_buff:               Buffer for data to be transmitted
+ * @pkt_rx_buff:               Buffer for received data
  * @n_curnt_chip:              The chip number that this SPI driver currently
  *                             operates on
  * @current_chip:              Reference to the current chip that this SPI
@@ -151,7 +152,10 @@ struct pch_spi_dma_ctrl {
  * @board_dat:                 Reference to the SPI device data structure
  * @plat_dev:                  platform_device structure
  * @ch:                                SPI channel number
+ * @dma:                       Local DMA information
+ * @use_dma:                   True if DMA is to be used
  * @irq_reg_sts:               Status of IRQ registration
+ * @save_total_len:            Save length while data is being transferred
  */
 struct pch_spi_data {
        void __iomem *io_remap_addr;