i2c: meson: update doc description to fix build warnings
authorYixun Lan <yixun.lan@amlogic.com>
Wed, 24 Jan 2018 07:05:14 +0000 (15:05 +0800)
committerWolfram Sang <wsa@the-dreams.de>
Fri, 26 Jan 2018 17:33:44 +0000 (18:33 +0100)
Add description for 'data' parameter and drop unused 'irq' memeber.

Here is the warnings:
drivers/i2c/busses/i2c-meson.c:103: warning: No description found for
parameter 'data'
drivers/i2c/busses/i2c-meson.c:103: warning: Excess struct member 'irq'
description in 'meson_i2c'

Reported-by: Wolfram Sang <wsa@the-dreams.de>
Signed-off-by: Yixun Lan <yixun.lan@amlogic.com>
Signed-off-by: Wolfram Sang <wsa@the-dreams.de>
drivers/i2c/busses/i2c-meson.c

index 37c4aa76f37a9639acc3ed95dd6ec79e6745fa67..90f5d0407d7323c3d183dbdf9508f8fac061c58c 100644 (file)
@@ -69,7 +69,6 @@ struct meson_i2c_data {
  * @dev:       Pointer to device structure
  * @regs:      Base address of the device memory mapped registers
  * @clk:       Pointer to clock structure
- * @irq:       IRQ number
  * @msg:       Pointer to the current I2C message
  * @state:     Current state in the driver state machine
  * @last:      Flag set for the last message in the transfer
@@ -80,6 +79,7 @@ struct meson_i2c_data {
  * @done:      Completion used to wait for transfer termination
  * @tokens:    Sequence of tokens to be written to the device
  * @num_tokens:        Number of tokens
+ * @data:      Pointer to the controlller's platform data
  */
 struct meson_i2c {
        struct i2c_adapter      adap;