From: David Wu <david.wu@rock-chips.com>
To: heiko@sntech.de, wsa@the-dreams.de
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>
Subject: [PATCH v10 1/8] i2c: rk3x: add documentation to fields in "struct rk3x_i2c"
Date: Mon, 16 May 2016 21:57:36 +0800 [thread overview]
Message-ID: <1463407063-41218-2-git-send-email-david.wu@rock-chips.com> (raw)
In-Reply-To: <1463407063-41218-1-git-send-email-david.wu@rock-chips.com>
Add kernel-doc documentation for the elements of the previously
undocumented struct rk3x_i2c.
Signed-off-by: David Wu <david.wu@rock-chips.com>
Reviewed-by: Douglas Anderson <dianders@chromium.org>
Reviewed-by: Heiko Stuebner <heiko@sntech.de>
Tested-by: Heiko Stuebner <heiko@sntech.de>
---
Change in v10:
- none
Change in v9:
- add commit description.
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
+ * @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
next prev parent reply other threads:[~2016-05-16 14:14 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-16 13:57 [PATCH v10 0/8] add i2c driver supported for rk3399 David Wu
2016-05-16 13:57 ` David Wu [this message]
2016-05-16 13:57 ` [PATCH v10 2/8] i2c: rk3x: use struct "rk3x_i2c_calced_timings" David Wu
2016-05-16 13:57 ` [PATCH v10 3/8] i2c: rk3x: Remove redundant rk3x_i2c_clean_ipd() David Wu
2016-05-16 13:57 ` [PATCH v10 4/8] i2c: rk3x: Change SoC data to not use array David Wu
2016-05-16 14:03 ` [PATCH v10 5/8] i2c: rk3x: Move spec timing data to "static const" structs David Wu
2016-05-16 14:04 ` [PATCH v10 6/8] dt-bindings: i2c: rk3x: add support for rk3399 David Wu
2016-05-16 16:45 ` Rob Herring
2016-05-16 14:05 ` [PATCH v10 7/8] i2c: rk3x: add i2c support for rk3399 soc David Wu
2016-05-16 17:22 ` Doug Anderson
2016-05-16 14:06 ` [PATCH v10 8/8] i2c: rk3x: support fast-mode plus for rk3399 David Wu
2016-05-16 20:17 ` [PATCH v10 0/8] add i2c driver supported " Doug Anderson
2016-06-08 15:47 ` Heiko Stübner
2016-06-09 7:47 ` Wolfram Sang
2016-06-09 14:12 ` Heiko Stübner
2016-06-17 11:56 ` Wolfram Sang
2016-06-20 2:18 ` David.Wu
2016-06-20 2:18 ` David.Wu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1463407063-41218-2-git-send-email-david.wu@rock-chips.com \
--to=david.wu@rock-chips.com \
--cc=andy.shevchenko@gmail.com \
--cc=briannorris@google.com \
--cc=cf@rock-chips.com \
--cc=davidriley@google.com \
--cc=devicetree@vger.kernel.org \
--cc=dianders@chromium.org \
--cc=galak@codeaurora.org \
--cc=heiko@sntech.de \
--cc=hl@rock-chips.com \
--cc=huangtao@rock-chips.com \
--cc=ijc+devicetree@hellion.org.uk \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-rockchip@lists.infradead.org \
--cc=mark.rutland@arm.com \
--cc=pawel.moll@arm.com \
--cc=robh+dt@kernel.org \
--cc=wsa@the-dreams.de \
--cc=xjq@rock-chips.com \
--cc=zyw@rock-chips.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).