2020-08-07 13:20:19

by Matthias Brugger

Subject: [v2] i2c: mediatek: Fix i2c_spec_values description

From: Matthias Brugger <[email protected]>

The struct i2c_spec_values have it's members documented but is
missing the starting '@', which leads to warings like:

drivers/i2c/busses/i2c-mt65xx.c:267: warning: Function parameter or member 'min_low_ns' not described in 'i2c_spec_values'

We also delete min_high_ns member as it is not used in the code.

Signed-off-by: Matthias Brugger <[email protected]>
---

Changes since v1:
delete mint_high_ns member

drivers/i2c/busses/i2c-mt65xx.c | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/drivers/i2c/busses/i2c-mt65xx.c b/drivers/i2c/busses/i2c-mt65xx.c
index e889f74703e4..efc14041d45b 100644
--- a/drivers/i2c/busses/i2c-mt65xx.c
+++ b/drivers/i2c/busses/i2c-mt65xx.c
@@ -253,14 +253,13 @@ struct mtk_i2c {

/**
* struct i2c_spec_values:
- * min_low_ns: min LOW period of the SCL clock
- * min_su_sta_ns: min set-up time for a repeated START condition
- * max_hd_dat_ns: max data hold time
- * min_su_dat_ns: min data set-up time
+ * @min_low_ns: min LOW period of the SCL clock
+ * @min_su_sta_ns: min set-up time for a repeated START condition
+ * @max_hd_dat_ns: max data hold time
+ * @min_su_dat_ns: min data set-up time
*/
struct i2c_spec_values {
unsigned int min_low_ns;
- unsigned int min_high_ns;
unsigned int min_su_sta_ns;
unsigned int max_hd_dat_ns;
unsigned int min_su_dat_ns;
--
2.28.0

2020-08-08 01:00:09

by Qii Wang (王琪)

Subject: Re: [v2] i2c: mediatek: Fix i2c_spec_values description

On Fri, 2020-08-07 at 15:19 +0200, [email protected] wrote:
> From: Matthias Brugger <[email protected]>
>
> The struct i2c_spec_values have it's members documented but is
> missing the starting '@', which leads to warings like:
>
> drivers/i2c/busses/i2c-mt65xx.c:267: warning: Function parameter or member 'min_low_ns' not described in 'i2c_spec_values'
>
> We also delete min_high_ns member as it is not used in the code.
>
> Signed-off-by: Matthias Brugger <[email protected]>

Reviewed-by: Qii Wang <[email protected]>

> ---
>
> Changes since v1:
> delete mint_high_ns member
>
> drivers/i2c/busses/i2c-mt65xx.c | 9 ++++-----
> 1 file changed, 4 insertions(+), 5 deletions(-)
>
> diff --git a/drivers/i2c/busses/i2c-mt65xx.c b/drivers/i2c/busses/i2c-mt65xx.c
> index e889f74703e4..efc14041d45b 100644
> --- a/drivers/i2c/busses/i2c-mt65xx.c
> +++ b/drivers/i2c/busses/i2c-mt65xx.c
> @@ -253,14 +253,13 @@ struct mtk_i2c {
>
> /**
> * struct i2c_spec_values:
> - * min_low_ns: min LOW period of the SCL clock
> - * min_su_sta_ns: min set-up time for a repeated START condition
> - * max_hd_dat_ns: max data hold time
> - * min_su_dat_ns: min data set-up time
> + * @min_low_ns: min LOW period of the SCL clock
> + * @min_su_sta_ns: min set-up time for a repeated START condition
> + * @max_hd_dat_ns: max data hold time
> + * @min_su_dat_ns: min data set-up time
> */
> struct i2c_spec_values {
> unsigned int min_low_ns;
> - unsigned int min_high_ns;
> unsigned int min_su_sta_ns;
> unsigned int max_hd_dat_ns;
> unsigned int min_su_dat_ns;