Unverified Commit c7cd1dfb authored by Lee Jones's avatar Lee Jones Committed by Mark Brown
Browse files

spi: spi-pl022: Provide missing struct attribute/function param docs 



Also demote non-worthy kerneldoc headers to standard comment blocks.

Fixes the following W=1 kernel build warning(s):

 drivers/spi/spi-pl022.c:304: warning: cannot understand function prototype: 'enum ssp_writing '
 drivers/spi/spi-pl022.c:330: warning: Function parameter or member 'loopback' not described in 'vendor_data'
 drivers/spi/spi-pl022.c:398: warning: Function parameter or member 'rx_lev_trig' not described in 'pl022'
 drivers/spi/spi-pl022.c:398: warning: Function parameter or member 'tx_lev_trig' not described in 'pl022'
 drivers/spi/spi-pl022.c:398: warning: Function parameter or member 'dma_running' not described in 'pl022'
 drivers/spi/spi-pl022.c:670: warning: Function parameter or member 'pl022' not described in 'readwriter'
 drivers/spi/spi-pl022.c:1250: warning: Function parameter or member 'irq' not described in 'pl022_interrupt_handler'
 drivers/spi/spi-pl022.c:1250: warning: Function parameter or member 'dev_id' not described in 'pl022_interrupt_handler'
 drivers/spi/spi-pl022.c:1343: warning: Function parameter or member 'pl022' not described in 'set_up_next_transfer'
 drivers/spi/spi-pl022.c:1343: warning: Function parameter or member 'transfer' not described in 'set_up_next_transfer'

Signed-off-by: default avatarLee Jones <lee.jones@linaro.org>
Acked-by: default avatarLinus Walleij <linus.walleij@linaro.org>
Cc: Sachin Verma <sachin.verma@st.com>
Link: https://lore.kernel.org/r/20200717135424.2442271-9-lee.jones@linaro.org


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 6b8d1e47

drivers/spi/spi-pl022.c

+9 −3
Original line number Diff line number Diff line
@@ -298,7 +298,7 @@ enum ssp_reading { 
	READING_U32

};



/**

/*

 * The type of writing going on on this chip

 */

enum ssp_writing {
@@ -317,6 +317,7 @@ enum ssp_writing { 
 * @extended_cr: 32 bit wide control register 0 with extra

 * features and extra features in CR1 as found in the ST variants

 * @pl023: supports a subset of the ST extensions called "PL023"

 * @loopback: supports loopback mode

 * @internal_cs_ctrl: supports chip select control register

 */

struct vendor_data {
@@ -353,11 +354,14 @@ struct vendor_data { 
 * @read: the type of read currently going on

 * @write: the type of write currently going on

 * @exp_fifo_level: expected FIFO level

 * @rx_lev_trig: receive FIFO watermark level which triggers IRQ

 * @tx_lev_trig: transmit FIFO watermark level which triggers IRQ

 * @dma_rx_channel: optional channel for RX DMA

 * @dma_tx_channel: optional channel for TX DMA

 * @sgt_rx: scattertable for the RX transfer

 * @sgt_tx: scattertable for the TX transfer

 * @dummypage: a dummy page used for driving data on the bus with DMA

 * @dma_running: indicates whether DMA is in operation

 * @cur_cs: current chip select (gpio)

 * @chipselects: list of chipselects (gpios)

 */
@@ -662,7 +666,7 @@ static void load_ssp_default_config(struct pl022 *pl022) 
	writew(CLEAR_ALL_INTERRUPTS, SSP_ICR(pl022->virtbase));

}



/**

/*

 * This will write to TX and read from RX according to the parameters

 * set in pl022.

 */
@@ -1237,6 +1241,8 @@ static inline void pl022_dma_remove(struct pl022 *pl022) 


/**

 * pl022_interrupt_handler - Interrupt handler for SSP controller

 * @irq: IRQ number

 * @dev_id: Local device data

 *

 * This function handles interrupts generated for an interrupt based transfer.

 * If a receive overrun (ROR) interrupt is there then we disable SSP, flag the
@@ -1334,7 +1340,7 @@ static irqreturn_t pl022_interrupt_handler(int irq, void *dev_id) 
	return IRQ_HANDLED;

}



/**

/*

 * This sets up the pointers to memory for the next message to

 * send out on the SPI bus.

 */