i2c: altera: Fix formatting issue in struct and demote unworthy kernel-doc headers

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

 drivers/i2c/busses/i2c-altera.c:74: warning: cannot understand function prototype: 'struct altr_i2c_dev '
 drivers/i2c/busses/i2c-altera.c:180: warning: Function parameter or member 'idev' not described in 'altr_i2c_transfer'
 drivers/i2c/busses/i2c-altera.c:180: warning: Function parameter or member 'data' not described in 'altr_i2c_transfer'
 drivers/i2c/busses/i2c-altera.c:193: warning: Function parameter or member 'idev' not described in 'altr_i2c_empty_rx_fifo'
 drivers/i2c/busses/i2c-altera.c:209: warning: Function parameter or member 'idev' not described in 'altr_i2c_fill_tx_fifo'

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Wolfram Sang <wsa@kernel.org>
This commit is contained in:
Lee Jones 2021-05-20 20:00:53 +01:00 committed by Wolfram Sang
parent 8124c8a6b3
commit a4931dcab1
1 changed files with 4 additions and 5 deletions

View File

@ -55,7 +55,7 @@
#define ALTR_I2C_XFER_TIMEOUT (msecs_to_jiffies(250)) #define ALTR_I2C_XFER_TIMEOUT (msecs_to_jiffies(250))
/** /**
* altr_i2c_dev - I2C device context * struct altr_i2c_dev - I2C device context
* @base: pointer to register struct * @base: pointer to register struct
* @msg: pointer to current message * @msg: pointer to current message
* @msg_len: number of bytes transferred in msg * @msg_len: number of bytes transferred in msg
@ -172,7 +172,7 @@ static void altr_i2c_init(struct altr_i2c_dev *idev)
altr_i2c_int_enable(idev, ALTR_I2C_ALL_IRQ, false); altr_i2c_int_enable(idev, ALTR_I2C_ALL_IRQ, false);
} }
/** /*
* altr_i2c_transfer - On the last byte to be transmitted, send * altr_i2c_transfer - On the last byte to be transmitted, send
* a Stop bit on the last byte. * a Stop bit on the last byte.
*/ */
@ -185,7 +185,7 @@ static void altr_i2c_transfer(struct altr_i2c_dev *idev, u32 data)
writel(data, idev->base + ALTR_I2C_TFR_CMD); writel(data, idev->base + ALTR_I2C_TFR_CMD);
} }
/** /*
* altr_i2c_empty_rx_fifo - Fetch data from RX FIFO until end of * altr_i2c_empty_rx_fifo - Fetch data from RX FIFO until end of
* transfer. Send a Stop bit on the last byte. * transfer. Send a Stop bit on the last byte.
*/ */
@ -201,9 +201,8 @@ static void altr_i2c_empty_rx_fifo(struct altr_i2c_dev *idev)
} }
} }
/** /*
* altr_i2c_fill_tx_fifo - Fill TX FIFO from current message buffer. * altr_i2c_fill_tx_fifo - Fill TX FIFO from current message buffer.
* @return: Number of bytes left to transfer.
*/ */
static int altr_i2c_fill_tx_fifo(struct altr_i2c_dev *idev) static int altr_i2c_fill_tx_fifo(struct altr_i2c_dev *idev)
{ {