[PATCH] i2c: mediatek: Fix i2c_spec_values description

[PATCH] i2c: mediatek: Fix i2c_spec_values description

[Matthias Brugger]

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'

Signed-off-by: Matthias Brugger <matthias.bgg@gmail.com>
---
  drivers/i2c/busses/i2c-mt65xx.c | 8 ++++----
  1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/i2c/busses/i2c-mt65xx.c b/drivers/i2c/busses/i2c-mt65xx.c
index e889f74703e4..f51b35fc400f 100644
--- a/drivers/i2c/busses/i2c-mt65xx.c
+++ b/drivers/i2c/busses/i2c-mt65xx.c
@@ -253,10 +253,10 @@ 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;
-- 
2.27.0

Re: [PATCH] i2c: mediatek: Fix i2c_spec_values description

[Qii Wang]

On Thu, 2020-08-06 at 11:48 +0200, Matthias Brugger wrote:
> 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'
> 
> Signed-off-by: Matthias Brugger <matthias.bgg@gmail.com>
> ---
>   drivers/i2c/busses/i2c-mt65xx.c | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/i2c/busses/i2c-mt65xx.c b/drivers/i2c/busses/i2c-mt65xx.c
> index e889f74703e4..f51b35fc400f 100644
> --- a/drivers/i2c/busses/i2c-mt65xx.c
> +++ b/drivers/i2c/busses/i2c-mt65xx.c
> @@ -253,10 +253,10 @@ struct mtk_i2c {
> 
>   /**
>    * struct i2c_spec_values:
> - * min_low_ns: min LOW period of the SCL clock

Can you help me add a description of min_high_ns. As
@min_high_ns: min HIGH period of the SCL clock
Thanks
 
> - * 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;

Re: [PATCH] i2c: mediatek: Fix i2c_spec_values description

[Matthias Brugger]

On 06/08/2020 13:06, Qii Wang wrote:
> On Thu, 2020-08-06 at 11:48 +0200, Matthias Brugger wrote:
>> 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'
>>
>> Signed-off-by: Matthias Brugger <matthias.bgg@gmail.com>
>> ---
>>    drivers/i2c/busses/i2c-mt65xx.c | 8 ++++----
>>    1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/drivers/i2c/busses/i2c-mt65xx.c b/drivers/i2c/busses/i2c-mt65xx.c
>> index e889f74703e4..f51b35fc400f 100644
>> --- a/drivers/i2c/busses/i2c-mt65xx.c
>> +++ b/drivers/i2c/busses/i2c-mt65xx.c
>> @@ -253,10 +253,10 @@ struct mtk_i2c {
>>
>>    /**
>>     * struct i2c_spec_values:
>> - * min_low_ns: min LOW period of the SCL clock
> 
> Can you help me add a description of min_high_ns. As
> @min_high_ns: min HIGH period of the SCL clock

Right, I forgot about this one.

Actually I don't see any code which uses the value, so I think it should be 
deleted from the struct.

Do you have any thoughts on this.

Regards,
Matthias

Re: [PATCH] i2c: mediatek: Fix i2c_spec_values description

[Qii Wang]

On Thu, 2020-08-06 at 15:35 +0200, Matthias Brugger wrote:
> 
> On 06/08/2020 13:06, Qii Wang wrote:
> > On Thu, 2020-08-06 at 11:48 +0200, Matthias Brugger wrote:
> >> 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'
> >>
> >> Signed-off-by: Matthias Brugger <matthias.bgg@gmail.com>
> >> ---
> >>    drivers/i2c/busses/i2c-mt65xx.c | 8 ++++----
> >>    1 file changed, 4 insertions(+), 4 deletions(-)
> >>
> >> diff --git a/drivers/i2c/busses/i2c-mt65xx.c b/drivers/i2c/busses/i2c-mt65xx.c
> >> index e889f74703e4..f51b35fc400f 100644
> >> --- a/drivers/i2c/busses/i2c-mt65xx.c
> >> +++ b/drivers/i2c/busses/i2c-mt65xx.c
> >> @@ -253,10 +253,10 @@ struct mtk_i2c {
> >>
> >>    /**
> >>     * struct i2c_spec_values:
> >> - * min_low_ns: min LOW period of the SCL clock
> > 
> > Can you help me add a description of min_high_ns. As
> > @min_high_ns: min HIGH period of the SCL clock
> 
> Right, I forgot about this one.
> 
> Actually I don't see any code which uses the value, so I think it should be 
> deleted from the struct.
> 
> Do you have any thoughts on this.
> 

That is right, it is used for internal test before. You can deleted it.

Re: [PATCH] i2c: mediatek: Fix i2c_spec_values description

[wsa]

[-- Attachment #1: Type: text/plain, Size: 422 bytes --]

On Thu, Aug 06, 2020 at 11:48:37AM +0200, Matthias Brugger wrote:
> 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'
> 
> Signed-off-by: Matthias Brugger <matthias.bgg@gmail.com>

Applied to for-next, thanks!


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]