i2c: i2c-st: fix missing struct parameter description
diff mbox series

Message ID 20200326212243.17363-1-avolmat@me.com
State Mainlined
Commit f491c6687332920e296d0209e366fe2ca7eab1c6
Headers show
Series
  • i2c: i2c-st: fix missing struct parameter description
Related show

Commit Message

Alain Volmat March 26, 2020, 9:22 p.m. UTC
Fix a missing struct parameter description to allow
warning free W=1 compilation.

Signed-off-by: Alain Volmat <avolmat@me.com>
---
 drivers/i2c/busses/i2c-st.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Patrice CHOTARD March 27, 2020, 8:47 a.m. UTC | #1
Hi Alain

On 3/26/20 10:22 PM, Alain Volmat wrote:
> Fix a missing struct parameter description to allow
> warning free W=1 compilation.
>
> Signed-off-by: Alain Volmat <avolmat@me.com>
> ---
>  drivers/i2c/busses/i2c-st.c | 1 +
>  1 file changed, 1 insertion(+)
>
> diff --git a/drivers/i2c/busses/i2c-st.c b/drivers/i2c/busses/i2c-st.c
> index 54e1fc8a495e..f7f7b5b64720 100644
> --- a/drivers/i2c/busses/i2c-st.c
> +++ b/drivers/i2c/busses/i2c-st.c
> @@ -434,6 +434,7 @@ static void st_i2c_wr_fill_tx_fifo(struct st_i2c_dev *i2c_dev)
>  /**
>   * st_i2c_rd_fill_tx_fifo() - Fill the Tx FIFO in read mode
>   * @i2c_dev: Controller's private data
> + * @max: Maximum amount of data to fill into the Tx FIFO
>   *
>   * This functions fills the Tx FIFO with fixed pattern when
>   * in read mode to trigger clock.

Reviewed-by: Patrice Chotard <patrice.chotard@st.com>

Thanks
Wolfram Sang March 28, 2020, 4:02 a.m. UTC | #2
On Thu, Mar 26, 2020 at 10:22:43PM +0100, Alain Volmat wrote:
> Fix a missing struct parameter description to allow
> warning free W=1 compilation.
> 
> Signed-off-by: Alain Volmat <avolmat@me.com>

Applied to for-current, thanks! Please note that the 'i2c-' prefix of
the driver is dropped because it is redundant in $ubject.

Patch
diff mbox series

diff --git a/drivers/i2c/busses/i2c-st.c b/drivers/i2c/busses/i2c-st.c
index 54e1fc8a495e..f7f7b5b64720 100644
--- a/drivers/i2c/busses/i2c-st.c
+++ b/drivers/i2c/busses/i2c-st.c
@@ -434,6 +434,7 @@  static void st_i2c_wr_fill_tx_fifo(struct st_i2c_dev *i2c_dev)
 /**
  * st_i2c_rd_fill_tx_fifo() - Fill the Tx FIFO in read mode
  * @i2c_dev: Controller's private data
+ * @max: Maximum amount of data to fill into the Tx FIFO
  *
  * This functions fills the Tx FIFO with fixed pattern when
  * in read mode to trigger clock.