On 2/27/12, Viresh Kumar <viresh.kumar@xxxxxx> wrote:
> we can give generalized function inside i2c framework for this, so that
> multiple
> drivers can use it.
>
> Secondly there are drivers/devices where control of pins is available. For
> them
> we can provide driver hooks.
>
> I would try to provide a patch for this ASAP. Other suggestions are welcome.
>
Here we go, please provide your feedbacks.:
From: Viresh Kumar <viresh.kumar@xxxxxx>
Date: Tue, 28 Feb 2012 18:26:31 +0530
Subject: [PATCH] i2c/adapter: Add bus recovery infrastructure
Add i2c bus recovery infrastructure to i2c adapters as specified in the i2c
protocol Rev. 03 section 3.16 titled "Bus clear".
Sometimes during operation i2c bus hangs and we need to give dummy clocks to
slave device to start the transfer again. Now we may have capability in the bus
controller to generate these clocks or platform may have gpio pins which can be
toggled to generate dummy clocks.
This patch also adds in generic bus recovery routines gpio or scl line based
which can be used by bus controller. In addition controller driver may provide
its own version of the bus recovery routine.
Signed-off-by: Viresh Kumar <viresh.kumar@xxxxxx>
---
drivers/i2c/i2c-core.c | 56 ++++++++++++++++++++++++++++++++++++++++++++++++
include/linux/i2c.h | 22 ++++++++++++++++++
2 files changed, 78 insertions(+), 0 deletions(-)
diff --git a/drivers/i2c/i2c-core.c b/drivers/i2c/i2c-core.c
index e9c1893..c9f0daf 100644
--- a/drivers/i2c/i2c-core.c
+++ b/drivers/i2c/i2c-core.c
@@ -26,7 +26,9 @@
#include <linux/module.h>
#include <linux/kernel.h>
+#include <linux/delay.h>
#include <linux/errno.h>
+#include <linux/gpio.h>
#include <linux/slab.h>
#include <linux/i2c.h>
#include <linux/init.h>
@@ -103,6 +105,47 @@ static int i2c_device_uevent(struct device *dev,
struct kobj_uevent_env *env)
#define i2c_device_uevent NULL
#endif /* CONFIG_HOTPLUG */
+/* i2c bus recovery routines */
+static int i2c_gpio_recover_bus(struct i2c_adapter *adap)
+{
+ int tmp, val = 1;
+ unsigned long delay = 1000000;
+
+ tmp = gpio_request_one(adap->scl_gpio, GPIOF_DIR_OUT |
+ GPIOF_INIT_LOW, "i2c-bus-recover");
+ if (tmp < 0) {
+ dev_warn(&adap->dev, "gpio request one fail: %d\n",
+ adap->scl_gpio);
+ return tmp;
+ }
+
+ delay /= adap->clock_rate * 2;
+
+ for (tmp = 0; tmp < adap->clock_cnt * 2; tmp++, val = !val) {
+ ndelay(delay);
+ gpio_set_value(adap->scl_gpio, val);
+ }
+
+ gpio_free(adap->clock_cnt);
+
+ return 0;
+}
+
+static int i2c_scl_recover_bus(struct i2c_adapter *adap)
+{
+ int i, val = 0;
+ unsigned long delay = 1000000;
+
+ delay /= adap->clock_rate * 2;
+
+ for (i = 0; i < adap->clock_cnt * 2; i++, val = !val) {
+ adap->set_scl(adap, val);
+ ndelay(delay);
+ }
+
+ return 0;
+}
+
static int i2c_device_probe(struct device *dev)
{
struct i2c_client *client = i2c_verify_client(dev);
@@ -861,6 +904,19 @@ static int i2c_register_adapter(struct i2c_adapter *adap)
"Failed to create compatibility class link\n");
#endif
+ /* bus recovery specific initialization */
+ if (!adap->recover_bus) {
+ if (!adap->clock_cnt || !adap->clock_rate)
+ goto warn_no_recovery;
+ else if (adap->is_gpio_recovery)
+ adap->recover_bus = i2c_gpio_recover_bus;
+ else if (adap->set_scl)
+ adap->recover_bus = i2c_scl_recover_bus;
+
+warn_no_recovery:
+ dev_warn(&adap->dev, "doesn't have recovery method\n");
+ }
+
/* create pre-declared device nodes */
if (adap->nr < __i2c_first_dynamic_bus_num)
i2c_scan_static_board_info(adap);
diff --git a/include/linux/i2c.h b/include/linux/i2c.h
index 8e25a91..b2a6d97 100644
--- a/include/linux/i2c.h
+++ b/include/linux/i2c.h
@@ -388,6 +388,28 @@ struct i2c_adapter {
struct mutex userspace_clients_lock;
struct list_head userspace_clients;
+
+ /*
+ * bus recovery specific fields: Either pass driver's recover_bus()
+ * routine, or pass it NULL to use generic ones. There are two type of
+ * generic one's available:
+ * - controlling scl line as gpio, pass is_gpio_recovery as true
+ * and valid scl_gpio number
+ * - controlling scl line directly via controller, pass
+ * is_gpio_recovery as false and valid set_scl routine's pointer
+ *
+ * Both schemes require valid values of
+ * - clock_cnt: total number of dummy clocks to be generated
+ * - clock_rate: rate of dummy clock
+ *
+ * scl_gpio.
+ */
+ int (*recover_bus)(struct i2c_adapter *);
+ void (*set_scl)(struct i2c_adapter *, int val);
+ bool is_gpio_recovery;
+ u8 scl_gpio;
+ u8 clock_cnt;
+ u32 clock_rate; /* In KHz */
};
#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
--
viresh
--
To unsubscribe from this list: send the line "unsubscribe linux-i2c" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
