Skip to content

Commit 702c0dd

Browse files
rddunlapwsakernel
authored andcommitted
i2c: axxia: eliminate kernel-doc warnings
Add kernel-doc for 'slave' and 'irq' in struct axxia_i2c_dev. Drop kernel-doc notation ("/**") for static functions since they are not usually documented with kernel-doc. Prevents these kernel-doc warnings: i2c-axxia.c:150: warning: Function parameter or member 'slave' not described in 'axxia_i2c_dev' i2c-axxia.c:150: warning: Function parameter or member 'irq' not described in 'axxia_i2c_dev' i2c-axxia.c:172: warning: Function parameter or member 'ns' not described in 'ns_to_clk' i2c-axxia.c:172: warning: Function parameter or member 'clk_mhz' not described in 'ns_to_clk' i2c-axxia.c:172: warning: No description found for return value of 'ns_to_clk' i2c-axxia.c:271: warning: Function parameter or member 'idev' not described in 'axxia_i2c_empty_rx_fifo' i2c-axxia.c:271: warning: No description found for return value of 'axxia_i2c_empty_rx_fifo' i2c-axxia.c:303: warning: Function parameter or member 'idev' not described in 'axxia_i2c_fill_tx_fifo' Signed-off-by: Randy Dunlap <[email protected]> Reported-by: kernel test robot <[email protected]> Closes: https://lore.kernel.org/all/[email protected]/ Reviewed-by: Andi Shyti <[email protected]> Signed-off-by: Wolfram Sang <[email protected]>
1 parent 4411a2c commit 702c0dd

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

drivers/i2c/busses/i2c-axxia.c

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,8 @@
131131
* @i2c_clk: clock reference for i2c input clock
132132
* @bus_clk_rate: current i2c bus clock rate
133133
* @last: a flag indicating is this is last message in transfer
134+
* @slave: associated &i2c_client
135+
* @irq: platform device IRQ number
134136
*/
135137
struct axxia_i2c_dev {
136138
void __iomem *base;
@@ -165,7 +167,7 @@ static void i2c_int_enable(struct axxia_i2c_dev *idev, u32 mask)
165167
writel(int_en | mask, idev->base + MST_INT_ENABLE);
166168
}
167169

168-
/**
170+
/*
169171
* ns_to_clk - Convert time (ns) to clock cycles for the given clock frequency.
170172
*/
171173
static u32 ns_to_clk(u64 ns, u32 clk_mhz)
@@ -263,7 +265,7 @@ static int i2c_m_recv_len(const struct i2c_msg *msg)
263265
return (msg->flags & I2C_M_RECV_LEN) != 0;
264266
}
265267

266-
/**
268+
/*
267269
* axxia_i2c_empty_rx_fifo - Fetch data from RX FIFO and update SMBus block
268270
* transfer length if this is the first byte of such a transfer.
269271
*/
@@ -295,7 +297,7 @@ static int axxia_i2c_empty_rx_fifo(struct axxia_i2c_dev *idev)
295297
return 0;
296298
}
297299

298-
/**
300+
/*
299301
* axxia_i2c_fill_tx_fifo - Fill TX FIFO from current message buffer.
300302
* @return: Number of bytes left to transfer.
301303
*/

0 commit comments

Comments
 (0)