Re: [PATCH v7 1/9] i2c: rk3x: add documentation to fields in "struct rk3x_i2c"

From: Doug Anderson
Date: Wed May 04 2016 - 19:50:32 EST


David,

On Wed, May 4, 2016 at 4:45 PM, Doug Anderson <dianders@xxxxxxxxxxxx> wrote:
> David,
>
> On Wed, May 4, 2016 at 7:13 AM, David Wu <david.wu@xxxxxxxxxxxxxx> wrote:
>> Signed-off-by: David Wu <david.wu@xxxxxxxxxxxxxx>
>> ---
>> Change in v7:
>> - none
>>
>> drivers/i2c/busses/i2c-rk3x.c | 22 +++++++++++++++++++++-
>> 1 file changed, 21 insertions(+), 1 deletion(-)
>>
>> diff --git a/drivers/i2c/busses/i2c-rk3x.c b/drivers/i2c/busses/i2c-rk3x.c
>> index 80bed02..7e45d51 100644
>> --- a/drivers/i2c/busses/i2c-rk3x.c
>> +++ b/drivers/i2c/busses/i2c-rk3x.c
>> @@ -90,6 +90,26 @@ struct rk3x_i2c_soc_data {
>> int grf_offset;
>> };
>>
>> +/**
>> + * struct rk3x_i2c - private data of the controller
>> + * @adap: corresponding I2C adapter
>> + * @dev: device for this controller
>> + * @soc_data: related soc data struct
>> + * @regs: virtual memory area
>> + * @clk: clock of i2c bus
>> + * @clk_rate_nb: i2c clk rate change notify
>> + * @t: I2C known timing information
>
> You're a little ahead of yourself. The @t element doesn't exist as of
> this patch. Instead all the sub-elements are there. This in this
> patch you need to document scl_frequency, scl_rise_ns, .... In a
> later patch you'd change it to t.

Or I'm an idiot and applied to the wrong branch. Your patch is fine.

Reviewed-by: Douglas Anderson <dianders@xxxxxxxxxxxx>