| Message ID | 1462908252-27016-2-git-send-email-david.wu@rock-chips.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
Am Mittwoch, 11. Mai 2016, 03:24:05 schrieb David Wu: In general, all patches should have a commit message (even if it's obvious) and some maintainers even enforce this in a hard way. How about something like: ---- Add kernel-doc documentation for the elements of the previously undocumented struct rk3x_i2c. ---- Some minor nitpicks below, otherwise Reviewed-by: Heiko Stuebner <heiko@sntech.de> > Signed-off-by: David Wu <david.wu@rock-chips.com> > Reviewed-by: Douglas Anderson <dianders@chromium.org> > --- > Change in v8: > - 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 ^ i2c clk rate change notifier block > + * @t: I2C known timing information > + * @lock: spinlock for the i2c bus > + * @wait: the waitqueue to wait for i2c transfer > + * @busy: the condition for the event to wait for > + * @msg: current i2c message > + * @addr: addr of i2c slave device > + * @mode: mode of i2c transfer > + * @is_last_msg: flag determines whether it is the last msg in this > transfer + * @state: state of i2c transfer > + * @processed: byte length which has been send or received ^ sent (with a "t") > + * @error: error code for i2c transfer > + */ > struct rk3x_i2c { > struct i2c_adapter adap; > struct device *dev; > @@ -116,7 +136,7 @@ struct rk3x_i2c { > > /* I2C state machine */ > enum rk3x_i2c_state state; > - unsigned int processed; /* sent/received bytes */ > + unsigned int processed; > int error; > };
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 + * @lock: spinlock for the i2c bus + * @wait: the waitqueue to wait for i2c transfer + * @busy: the condition for the event to wait for + * @msg: current i2c message + * @addr: addr of i2c slave device + * @mode: mode of i2c transfer + * @is_last_msg: flag determines whether it is the last msg in this transfer + * @state: state of i2c transfer + * @processed: byte length which has been send or received + * @error: error code for i2c transfer + */ struct rk3x_i2c { struct i2c_adapter adap; struct device *dev; @@ -116,7 +136,7 @@ struct rk3x_i2c { /* I2C state machine */ enum rk3x_i2c_state state; - unsigned int processed; /* sent/received bytes */ + unsigned int processed; int error; };