Skip to content

Commit c7cd1df

Browse files
Lee Jonesbroonie
authored andcommitted
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: Lee Jones <[email protected]> Acked-by: Linus Walleij <[email protected]> Cc: Sachin Verma <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Mark Brown <[email protected]>
1 parent 6b8d1e4 commit c7cd1df

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

drivers/spi/spi-pl022.c

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ enum ssp_reading {
298298
READING_U32
299299
};
300300

301-
/**
301+
/*
302302
* The type of writing going on on this chip
303303
*/
304304
enum ssp_writing {
@@ -317,6 +317,7 @@ enum ssp_writing {
317317
* @extended_cr: 32 bit wide control register 0 with extra
318318
* features and extra features in CR1 as found in the ST variants
319319
* @pl023: supports a subset of the ST extensions called "PL023"
320+
* @loopback: supports loopback mode
320321
* @internal_cs_ctrl: supports chip select control register
321322
*/
322323
struct vendor_data {
@@ -353,11 +354,14 @@ struct vendor_data {
353354
* @read: the type of read currently going on
354355
* @write: the type of write currently going on
355356
* @exp_fifo_level: expected FIFO level
357+
* @rx_lev_trig: receive FIFO watermark level which triggers IRQ
358+
* @tx_lev_trig: transmit FIFO watermark level which triggers IRQ
356359
* @dma_rx_channel: optional channel for RX DMA
357360
* @dma_tx_channel: optional channel for TX DMA
358361
* @sgt_rx: scattertable for the RX transfer
359362
* @sgt_tx: scattertable for the TX transfer
360363
* @dummypage: a dummy page used for driving data on the bus with DMA
364+
* @dma_running: indicates whether DMA is in operation
361365
* @cur_cs: current chip select (gpio)
362366
* @chipselects: list of chipselects (gpios)
363367
*/
@@ -662,7 +666,7 @@ static void load_ssp_default_config(struct pl022 *pl022)
662666
writew(CLEAR_ALL_INTERRUPTS, SSP_ICR(pl022->virtbase));
663667
}
664668

665-
/**
669+
/*
666670
* This will write to TX and read from RX according to the parameters
667671
* set in pl022.
668672
*/
@@ -1237,6 +1241,8 @@ static inline void pl022_dma_remove(struct pl022 *pl022)
12371241

12381242
/**
12391243
* pl022_interrupt_handler - Interrupt handler for SSP controller
1244+
* @irq: IRQ number
1245+
* @dev_id: Local device data
12401246
*
12411247
* This function handles interrupts generated for an interrupt based transfer.
12421248
* 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)
13341340
return IRQ_HANDLED;
13351341
}
13361342

1337-
/**
1343+
/*
13381344
* This sets up the pointers to memory for the next message to
13391345
* send out on the SPI bus.
13401346
*/

0 commit comments

Comments
 (0)