This set is part of a larger effort attempting to clean-up W=1
kernel builds, which are currently overwhelmingly riddled with
niggly little warnings.
Lee Jones (16):
i2c: busses: i2c-nomadik: Fix formatting issue pertaining to 'timeout'
i2c: muxes: i2c-arb-gpio-challenge: Demote non-conformant kernel-doc
headers
i2c: busses: i2c-ali1563: File headers are not good candidates for
kernel-doc
i2c: busses: i2c-altera: Fix formatting issue in struct and demote
unworthy kernel-doc headers
i2c: busses: i2c-axxia: Fix formatting issue in struct and demote
unworthy kernel-doc headers
i2c: busses: i2c-cadence: Fix incorrectly documented 'enum
cdns_i2c_slave_mode'
i2c: busses: i2c-designware-master: Fix misnaming of
'i2c_dw_init_master()'
i2c: busses: i2c-eg20t: Fix 'bad line' issue and provide description
for 'msgs' param
i2c: busses: i2c-mxs: Demote barely half complete kernel-doc header
i2c: busses: i2c-ocores: Place the expected function names into the
documentation headers
i2c: busses: i2c-pnx: Provide descriptions for 'alg_data' data
structure
i2c: busses: i2c-rk3x: Demote unworthy headers and help more complete
ones
i2c: busses: i2c-st: Fix copy/paste function misnaming issues
i2c: busses: i2c-stm32f4: Remove incorrectly placed ' ' from function
name
i2c: busses: i2c-tegra-bpmp: Demote kernel-doc abuses
i2c: busses: i2c-st: trivial: Fix spelling issue 'enmpty => empty'
drivers/i2c/busses/i2c-ali1563.c | 2 +-
drivers/i2c/busses/i2c-altera.c | 9 ++++-----
drivers/i2c/busses/i2c-axxia.c | 11 +++++------
drivers/i2c/busses/i2c-cadence.c | 2 +-
drivers/i2c/busses/i2c-designware-master.c | 2 +-
drivers/i2c/busses/i2c-eg20t.c | 3 ++-
drivers/i2c/busses/i2c-mxs.c | 2 +-
drivers/i2c/busses/i2c-nomadik.c | 2 +-
drivers/i2c/busses/i2c-ocores.c | 8 ++++----
drivers/i2c/busses/i2c-pnx.c | 8 ++++----
drivers/i2c/busses/i2c-rk3x.c | 18 +++++++++---------
drivers/i2c/busses/i2c-st.c | 4 ++--
drivers/i2c/busses/i2c-stm32f4.c | 2 +-
drivers/i2c/busses/i2c-tegra-bpmp.c | 4 ++--
drivers/i2c/muxes/i2c-arb-gpio-challenge.c | 4 ++--
15 files changed, 40 insertions(+), 41 deletions(-)
Cc: Alain Volmat <[email protected]>
Cc: Alexandre Torgue <[email protected]>
Cc: Anders Berg <[email protected]>
Cc: Andreas Larsson <[email protected]>
Cc: Andrew Lunn <[email protected]>
Cc: Andy Shevchenko <[email protected]>
Cc: Cedric Madianga <[email protected]>
Cc: Dennis Kovalev <[email protected]>
Cc: Doug Anderson <[email protected]>
Cc: Fabio Estevam <[email protected]>
Cc: Heiko Stuebner <[email protected]>
Cc: Jarkko Nikula <[email protected]>
Cc: Jean Delvare <[email protected]>
Cc: Jonathan Hunter <[email protected]>
Cc: Krzysztof Adamski <[email protected]>
Cc: Linus Walleij <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: Marek Vasut <[email protected]>
Cc: Maxime Coquelin <[email protected]>
Cc: Maxime Coquelin <[email protected]>
Cc: Max Schwarz <[email protected]>
Cc: Michal Simek <[email protected]>
Cc: Mika Westerberg <[email protected]>
Cc: NXP Linux Team <[email protected]>
Cc: Palmer Dabbelt <[email protected]>
Cc: Patrice Chotard <[email protected]>
Cc: Paul Walmsley <[email protected]>
Cc: Pengutronix Kernel Team <[email protected]>
Cc: Peter Korsgaard <[email protected]>
Cc: Peter Rosin <[email protected]>
Cc: Philipp Zabel <[email protected]>
Cc: Pierre-Yves MORDRET <[email protected]>
Cc: Rudolf Marek <[email protected]>
Cc: Sachin Verma <[email protected]>
Cc: Sascha Hauer <[email protected]>
Cc: Shariff Md <[email protected]>
Cc: Shawn Guo <[email protected]>
Cc: Srinidhi Kasagar <[email protected]>
Cc: Thierry Reding <[email protected]>
Cc: Thor Thayer <[email protected]>
Cc: Tomoya MORINAGA <[email protected]>
Cc: Vaibhav Gupta <[email protected]>
Cc: Vitaly Wool <[email protected]>
Cc: Vladimir Zapolskiy <[email protected]>
Cc: Wolfram Sang <[email protected]>
--
2.31.1
Fixes the following W=1 kernel build warning(s):
drivers/i2c/muxes/i2c-arb-gpio-challenge.c:43: warning: Function parameter or member 'muxc' not described in 'i2c_arbitrator_select'
drivers/i2c/muxes/i2c-arb-gpio-challenge.c:43: warning: Function parameter or member 'chan' not described in 'i2c_arbitrator_select'
drivers/i2c/muxes/i2c-arb-gpio-challenge.c:86: warning: Function parameter or member 'muxc' not described in 'i2c_arbitrator_deselect'
drivers/i2c/muxes/i2c-arb-gpio-challenge.c:86: warning: Function parameter or member 'chan' not described in 'i2c_arbitrator_deselect'
Cc: Peter Rosin <[email protected]>
Cc: Doug Anderson <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/i2c/muxes/i2c-arb-gpio-challenge.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/drivers/i2c/muxes/i2c-arb-gpio-challenge.c b/drivers/i2c/muxes/i2c-arb-gpio-challenge.c
index 6dc88902c189f..1c78657631f4f 100644
--- a/drivers/i2c/muxes/i2c-arb-gpio-challenge.c
+++ b/drivers/i2c/muxes/i2c-arb-gpio-challenge.c
@@ -34,7 +34,7 @@ struct i2c_arbitrator_data {
};
-/**
+/*
* i2c_arbitrator_select - claim the I2C bus
*
* Use the GPIO-based signalling protocol; return -EBUSY if we fail.
@@ -77,7 +77,7 @@ static int i2c_arbitrator_select(struct i2c_mux_core *muxc, u32 chan)
return -EBUSY;
}
-/**
+/*
* i2c_arbitrator_deselect - release the I2C bus
*
* Release the I2C bus using the GPIO-based signalling protocol.
--
2.31.1
Fixes the following W=1 kernel build warning(s):
drivers/i2c/busses/i2c-ali1563.c:24: warning: expecting prototype for i2c(). Prototype was for ALI1563_MAX_TIMEOUT() instead
Cc: Jean Delvare <[email protected]>
Cc: Rudolf Marek <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/i2c/busses/i2c-ali1563.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/i2c/busses/i2c-ali1563.c b/drivers/i2c/busses/i2c-ali1563.c
index 4d12e3da12f0d..55a9e93fbfeb5 100644
--- a/drivers/i2c/busses/i2c-ali1563.c
+++ b/drivers/i2c/busses/i2c-ali1563.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
* i2c-ali1563.c - i2c driver for the ALi 1563 Southbridge
*
* Copyright (C) 2004 Patrick Mochel
--
2.31.1
Fixes the following W=1 kernel build warning(s):
drivers/i2c/busses/i2c-stm32f4.c:321: warning: expecting prototype for stm32f4_i2c_write_ byte()(). Prototype was for stm32f4_i2c_write_byte() instead
Cc: Pierre-Yves MORDRET <[email protected]>
Cc: Alain Volmat <[email protected]>
Cc: Maxime Coquelin <[email protected]>
Cc: Alexandre Torgue <[email protected]>
Cc: Philipp Zabel <[email protected]>
Cc: Cedric Madianga <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/i2c/busses/i2c-stm32f4.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/i2c/busses/i2c-stm32f4.c b/drivers/i2c/busses/i2c-stm32f4.c
index 4933fc8ce3fd1..eebce7ecef25b 100644
--- a/drivers/i2c/busses/i2c-stm32f4.c
+++ b/drivers/i2c/busses/i2c-stm32f4.c
@@ -313,7 +313,7 @@ static int stm32f4_i2c_wait_free_bus(struct stm32f4_i2c_dev *i2c_dev)
}
/**
- * stm32f4_i2c_write_ byte() - Write a byte in the data register
+ * stm32f4_i2c_write_byte() - Write a byte in the data register
* @i2c_dev: Controller's private data
* @byte: Data to write in the register
*/
--
2.31.1
Hi,
On Thu, May 20, 2021 at 12:01 PM Lee Jones <[email protected]> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/i2c/muxes/i2c-arb-gpio-challenge.c:43: warning: Function parameter or member 'muxc' not described in 'i2c_arbitrator_select'
> drivers/i2c/muxes/i2c-arb-gpio-challenge.c:43: warning: Function parameter or member 'chan' not described in 'i2c_arbitrator_select'
> drivers/i2c/muxes/i2c-arb-gpio-challenge.c:86: warning: Function parameter or member 'muxc' not described in 'i2c_arbitrator_deselect'
> drivers/i2c/muxes/i2c-arb-gpio-challenge.c:86: warning: Function parameter or member 'chan' not described in 'i2c_arbitrator_deselect'
>
> Cc: Peter Rosin <[email protected]>
> Cc: Doug Anderson <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/i2c/muxes/i2c-arb-gpio-challenge.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
No objections from me.
Acked-by: Douglas Anderson <[email protected]>
-Doug
Fixes the following W=1 kernel build warning(s):
drivers/i2c/busses/i2c-designware-master.c:176: warning: expecting prototype for i2c_dw_init(). Prototype was for i2c_dw_init_master() instead
Cc: Jarkko Nikula <[email protected]>
Cc: Andy Shevchenko <[email protected]>
Cc: Mika Westerberg <[email protected]>
Cc: Philipp Zabel <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/i2c/busses/i2c-designware-master.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/i2c/busses/i2c-designware-master.c b/drivers/i2c/busses/i2c-designware-master.c
index 13be1d678c399..9b08bb5df38d2 100644
--- a/drivers/i2c/busses/i2c-designware-master.c
+++ b/drivers/i2c/busses/i2c-designware-master.c
@@ -165,7 +165,7 @@ static int i2c_dw_set_timings_master(struct dw_i2c_dev *dev)
}
/**
- * i2c_dw_init() - Initialize the designware I2C master hardware
+ * i2c_dw_init_master() - Initialize the designware I2C master hardware
* @dev: device private data
*
* This functions configures and enables the I2C master.
--
2.31.1
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'
Cc: Thor Thayer <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/i2c/busses/i2c-altera.c | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/drivers/i2c/busses/i2c-altera.c b/drivers/i2c/busses/i2c-altera.c
index 7d62cbda6e06c..354cf7e45c4a0 100644
--- a/drivers/i2c/busses/i2c-altera.c
+++ b/drivers/i2c/busses/i2c-altera.c
@@ -55,7 +55,7 @@
#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
* @msg: pointer to current message
* @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_transfer - On the last byte to be transmitted, send
* 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);
}
-/**
+/*
* altr_i2c_empty_rx_fifo - Fetch data from RX FIFO until end of
* 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.
- * @return: Number of bytes left to transfer.
*/
static int altr_i2c_fill_tx_fifo(struct altr_i2c_dev *idev)
{
--
2.31.1
Cc: Patrice Chotard <[email protected]>
Cc: Maxime Coquelin <[email protected]>
Cc: [email protected]
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/i2c/busses/i2c-st.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/i2c/busses/i2c-st.c b/drivers/i2c/busses/i2c-st.c
index 30089b38044b5..88482316d22a0 100644
--- a/drivers/i2c/busses/i2c-st.c
+++ b/drivers/i2c/busses/i2c-st.c
@@ -524,7 +524,7 @@ static void st_i2c_handle_write(struct st_i2c_dev *i2c_dev)
}
/**
- * st_i2c_handle_read() - Handle FIFO enmpty interrupt in case of read
+ * st_i2c_handle_read() - Handle FIFO empty interrupt in case of read
* @i2c_dev: Controller's private data
*/
static void st_i2c_handle_read(struct st_i2c_dev *i2c_dev)
--
2.31.1
Thanks for the patch.
Reviewed-by: Alain Volmat <[email protected]>
On Thu, May 20, 2021 at 08:01:05PM +0100, Lee Jones wrote:
> Cc: Patrice Chotard <[email protected]>
> Cc: Maxime Coquelin <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/i2c/busses/i2c-st.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/i2c/busses/i2c-st.c b/drivers/i2c/busses/i2c-st.c
> index 30089b38044b5..88482316d22a0 100644
> --- a/drivers/i2c/busses/i2c-st.c
> +++ b/drivers/i2c/busses/i2c-st.c
> @@ -524,7 +524,7 @@ static void st_i2c_handle_write(struct st_i2c_dev *i2c_dev)
> }
>
> /**
> - * st_i2c_handle_read() - Handle FIFO enmpty interrupt in case of read
> + * st_i2c_handle_read() - Handle FIFO empty interrupt in case of read
> * @i2c_dev: Controller's private data
> */
> static void st_i2c_handle_read(struct st_i2c_dev *i2c_dev)
> --
> 2.31.1
>
Thanks for the patch. Looks fine for me.
Reviewed-by: Alain Volmat <[email protected]>
On Thu, May 20, 2021 at 08:01:03PM +0100, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/i2c/busses/i2c-stm32f4.c:321: warning: expecting prototype for stm32f4_i2c_write_ byte()(). Prototype was for stm32f4_i2c_write_byte() instead
>
> Cc: Pierre-Yves MORDRET <[email protected]>
> Cc: Alain Volmat <[email protected]>
> Cc: Maxime Coquelin <[email protected]>
> Cc: Alexandre Torgue <[email protected]>
> Cc: Philipp Zabel <[email protected]>
> Cc: Cedric Madianga <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
> ---
> drivers/i2c/busses/i2c-stm32f4.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/i2c/busses/i2c-stm32f4.c b/drivers/i2c/busses/i2c-stm32f4.c
> index 4933fc8ce3fd1..eebce7ecef25b 100644
> --- a/drivers/i2c/busses/i2c-stm32f4.c
> +++ b/drivers/i2c/busses/i2c-stm32f4.c
> @@ -313,7 +313,7 @@ static int stm32f4_i2c_wait_free_bus(struct stm32f4_i2c_dev *i2c_dev)
> }
>
> /**
> - * stm32f4_i2c_write_ byte() - Write a byte in the data register
> + * stm32f4_i2c_write_byte() - Write a byte in the data register
> * @i2c_dev: Controller's private data
> * @byte: Data to write in the register
> */
> --
> 2.31.1
>
On Thu, May 20, 2021 at 08:00:51PM +0100, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/i2c/muxes/i2c-arb-gpio-challenge.c:43: warning: Function parameter or member 'muxc' not described in 'i2c_arbitrator_select'
> drivers/i2c/muxes/i2c-arb-gpio-challenge.c:43: warning: Function parameter or member 'chan' not described in 'i2c_arbitrator_select'
> drivers/i2c/muxes/i2c-arb-gpio-challenge.c:86: warning: Function parameter or member 'muxc' not described in 'i2c_arbitrator_deselect'
> drivers/i2c/muxes/i2c-arb-gpio-challenge.c:86: warning: Function parameter or member 'chan' not described in 'i2c_arbitrator_deselect'
>
> Cc: Peter Rosin <[email protected]>
> Cc: Doug Anderson <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
Applied to for-current, thanks!
On Thu, May 20, 2021 at 08:00:52PM +0100, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/i2c/busses/i2c-ali1563.c:24: warning: expecting prototype for i2c(). Prototype was for ALI1563_MAX_TIMEOUT() instead
>
> Cc: Jean Delvare <[email protected]>
> Cc: Rudolf Marek <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
Applied to for-current, thanks!
On Fri, May 21, 2021 at 04:23:49PM +0200, Alain Volmat wrote:
> Thanks for the patch.
>
> Reviewed-by: Alain Volmat <[email protected]>
>
> On Thu, May 20, 2021 at 08:01:05PM +0100, Lee Jones wrote:
> > Cc: Patrice Chotard <[email protected]>
> > Cc: Maxime Coquelin <[email protected]>
> > Cc: [email protected]
> > Cc: [email protected]
> > Signed-off-by: Lee Jones <[email protected]>
Squashed the patch into the other one for i2c-st. Thanks!
On Thu, May 20, 2021 at 08:01:03PM +0100, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/i2c/busses/i2c-stm32f4.c:321: warning: expecting prototype for stm32f4_i2c_write_ byte()(). Prototype was for stm32f4_i2c_write_byte() instead
>
> Cc: Pierre-Yves MORDRET <[email protected]>
> Cc: Alain Volmat <[email protected]>
> Cc: Maxime Coquelin <[email protected]>
> Cc: Alexandre Torgue <[email protected]>
> Cc: Philipp Zabel <[email protected]>
> Cc: Cedric Madianga <[email protected]>
> Cc: [email protected]
> Cc: [email protected]
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
Applied to for-current, thanks!
On Thu, May 20, 2021 at 08:00:53PM +0100, Lee Jones wrote:
> 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'
>
> Cc: Thor Thayer <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>
Applied to for-current, thanks!