From: Wolfram Sang <wsa@the-dreams.de>
To: linux-i2c@vger.kernel.org
Cc: linux-renesas-soc@vger.kernel.org,
Phil Reid <preid@electromag.com.au>,
Wolfram Sang <wsa+renesas@sang-engineering.com>
Subject: [PATCH v2 1/6] i2c: make kerneldoc about bus recovery more precise
Date: Tue, 9 Jan 2018 14:58:54 +0100 [thread overview]
Message-ID: <20180109135859.20771-2-wsa@the-dreams.de> (raw)
In-Reply-To: <20180109135859.20771-1-wsa@the-dreams.de>
From: Wolfram Sang <wsa+renesas@sang-engineering.com>
"Used internally" is vague. What it actually means is that those fields
are populated by the core if valid GPIOs are provided. Change the
comments to reflect that.
Tested-by: Phil Reid <preid@electromag.com.au>
Signed-off-by: Wolfram Sang <wsa+renesas@sang-engineering.com>
---
include/linux/i2c.h | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/include/linux/i2c.h b/include/linux/i2c.h
index 5d7f3c1853ae4b..f8a9d81e911e52 100644
--- a/include/linux/i2c.h
+++ b/include/linux/i2c.h
@@ -545,12 +545,12 @@ struct i2c_timings {
* @recover_bus: Recover routine. Either pass driver's recover_bus() routine, or
* i2c_generic_scl_recovery().
* @get_scl: This gets current value of SCL line. Mandatory for generic SCL
- * recovery. Used internally for generic GPIO recovery.
- * @set_scl: This sets/clears SCL line. Mandatory for generic SCL recovery. Used
- * internally for generic GPIO recovery.
+ * recovery. Populated internally for generic GPIO recovery.
+ * @set_scl: This sets/clears the SCL line. Mandatory for generic SCL recovery.
+ * Populated internally for generic GPIO recovery.
* @get_sda: This gets current value of SDA line. Optional for generic SCL
- * recovery. Used internally, if sda_gpio is a valid GPIO, for generic GPIO
- * recovery.
+ * recovery. Populated internally, if sda_gpio is a valid GPIO, for generic
+ * GPIO recovery.
* @prepare_recovery: This will be called before starting recovery. Platform may
* configure padmux here for SDA/SCL line or something else they want.
* @unprepare_recovery: This will be called after completing recovery. Platform
--
2.11.0
next prev parent reply other threads:[~2018-01-09 13:59 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-01-09 13:58 [PATCH v2 0/6] i2c: send STOP after recovery; use it for i2c-rcar Wolfram Sang
2018-01-09 13:58 ` Wolfram Sang [this message]
2018-01-09 13:58 ` [PATCH v2 2/6] i2c: add identifier in declarations for i2c_bus_recovery Wolfram Sang
2018-01-09 13:58 ` [PATCH v2 3/6] i2c: add 'set_sda' to bus_recovery_info Wolfram Sang
2018-01-10 13:43 ` Linus Walleij
2018-01-09 13:58 ` [PATCH v2 4/6] i2c: ensure SDA is released in recovery if SDA is controllable Wolfram Sang
2018-01-09 13:58 ` [PATCH v2 5/6] i2c: send STOP after successful bus recovery Wolfram Sang
2018-01-09 13:58 ` [PATCH v2 6/6] i2c: rcar: implement " Wolfram Sang
2018-01-15 23:08 ` [PATCH v2 0/6] i2c: send STOP after recovery; use it for i2c-rcar Wolfram Sang
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=20180109135859.20771-2-wsa@the-dreams.de \
--to=wsa@the-dreams.de \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-renesas-soc@vger.kernel.org \
--cc=preid@electromag.com.au \
--cc=wsa+renesas@sang-engineering.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