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

Path	csiph.com!xmission!news.glorb.com!bofh.it!news.nic.it!robomod
From	David Wu <david.wu@rock-chips.com>
Newsgroups	linux.kernel
Subject	[PATCH v7 1/9] i2c: rk3x: add documentation to fields in "struct rk3x_i2c"
Date	Wed, 04 May 2016 16:20:02 +0200
Message-ID	<rv5OG-5wR-13@gated-at.bofh.it> (permalink)
References	<rv5OG-5wR-9@gated-at.bofh.it>
X-Original-To	heiko@sntech.de, wsa@the-dreams.de
X-263anti-Spam	KSV:0;
X-Mail-Gray	1
X-Abs-Checked	4
X-Rl-Sender	david.wu@rock-chips.com
X-Sender-IP	58.22.7.114
X-Login-Name	david.wu@rock-chips.com
X-Unique-Tag	<ff12b87542f728be23832d152680d771>
X-Sender	wdc@rock-chips.com
X-Mailer	git-send-email 1.9.1
Content-Type	text/plain; charset="utf-8"
Sender	robomod@news.nic.it
List-ID	<linux-kernel.vger.kernel.org>
X-Mailing-List	linux-kernel@vger.kernel.org
Approved	robomod@news.nic.it
Lines	50
Organization	linux.* mail to news gateway
X-Original-Cc	robh+dt@kernel.org, dianders@chromium.org, andy.shevchenko@gmail.com, pawel.moll@arm.com, mark.rutland@arm.com, ijc+devicetree@hellion.org.uk, galak@codeaurora.org, briannorris@google.com, davidriley@google.com, huangtao@rock-chips.com, hl@rock-chips.com, xjq@rock-chips.com, zyw@rock-chips.com, cf@rock-chips.com, linux-arm-kernel@lists.infradead.org, linux-rockchip@lists.infradead.org, linux-i2c@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, David Wu <david.wu@rock-chips.com>
X-Original-Date	Wed, 4 May 2016 22:13:06 +0800
X-Original-Message-ID	<1462371194-5809-2-git-send-email-david.wu@rock-chips.com>
X-Original-References	<1462371194-5809-1-git-send-email-david.wu@rock-chips.com>
X-Original-Sender	linux-kernel-owner@vger.kernel.org
Xref	csiph.com linux.kernel:1394325

Show key headers only | View raw

Signed-off-by: David Wu <david.wu@rock-chips.com>
---
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
+ * @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;
 };
 
-- 
1.9.1

Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

[PATCH v7 1/9] i2c: rk3x: add documentation to fields in "struct rk3x_i2c" David Wu <david.wu@rock-chips.com> - 2016-05-04 16:20 +0200
  Re: [PATCH v7 1/9] i2c: rk3x: add documentation to fields in "struct rk3x_i2c" Doug Anderson <dianders@chromium.org> - 2016-05-05 01:50 +0200
    Re: [PATCH v7 1/9] i2c: rk3x: add documentation to fields in "struct rk3x_i2c" Doug Anderson <dianders@chromium.org> - 2016-05-05 02:00 +0200

csiph-web