Skip to contentSkip to conversation

i2c: imx: implement bus recovery

PATCH Superseded Gao Pan 3 participants 5 messages Sep 21, 2015 – Sep 25, 2015

Subsystems (4)

v6 of 8 Superseded Latest is v8 →

lore
Share & tools
lore

Gao Pan

author
#0 lore raw

PATCH v6 1/1 i2c: imx: implement bus recovery

Implement bus recovery methods for i2c-imx so we can recover from situations where SCL/SDA are stuck low.

Once i2c bus SCL/SDA are stuck low during transfer, config the i2c pinctrl to gpio mode by calling pinctrl sleep set function, and then use GPIO to emulate the i2c protocol to send nine dummy clock to recover i2c device. After recovery, set i2c pinctrl to default group setting.

---
V2:
As Uwe Kleine-König's suggestion, the version do below changes:
-replace of_get_named_gpio() with devm_gpiod_get_optional() -move gpio_direction_input() and gpio_direction_output() call to the
prepare callback
-use 0 and 1 as return value for the get_scl and get_sda callbacks

V3:
-replace "...-gpio" with "...-gpios" in i2c binding doc -document the requirement of using sleep state to configure
the pins as gpio in i2c binding doc
-remove i2c_recover_bus() in i2c_imx_trx_complete() -use GPIOD_OUT_HIGH as the parameter of devm_gpiod_get_optional to
config the gpios as output high
-add error disposal as devm_gpiod_get_optional meets error

V4:
-remove include <linux/of_gpio.h>
-call i2c_recover_bus under the condition of the existing of
both sda and scl. Drop the sda and scl check in i2c_imx_get_scl, i2c_imx_get_sda, i2c_imx_set_scl, i2c_imx_prepare_recovery and i2c_imx_prepare_recovery
-use GPIOD_OUT_IN as the parameter of devm_gpiod_get_optional -remove documenting the requirement of using sleep state to configure
the pins as gpio in i2c binding doc

V5:
-introduce a dedicated gpio state for bus recovery.
-assign adapter.bus_recovery_info after the two gpios were aquired successfully.

V6:
-assign adapter.bus_recovery_info under the condition that gpios are acquired successfully -not try the recovery when pinctrl_lookup_state returns an error

 Documentation/devicetree/bindings/i2c/i2c-imx.txt |   9 ++
 drivers/i2c/busses/i2c-imx.c                      | 124 ++++++++++++++++++++--
 2 files changed, 126 insertions(+), 7 deletions(-)
Documentation/devicetree/bindings/i2c/i2c-imx.txt +9 -0
index ce4311d..eab5836 100644
@@ -14,6 +14,10 @@ Optional properties:
   The absence of the propoerty indicates the default frequency 100 kHz.
 - dmas: A list of two dma specifiers, one for each entry in dma-names.
 - dma-names: should contain "tx" and "rx".
+- scl-gpios: specify the gpio related to SCL pin
+- sda-gpios: specify the gpio related to SDA pin
+- pinctrl: add extra pinctrl to configure i2c pins to gpio function for i2c
+  bus recovery, call it "gpio" state
 
 Examples:
 
@@ -37,4 +41,9 @@ i2c0: i2c@40066000 { /* i2c0 on vf610 */
 	dmas = <&edma0 0 50>,
 		<&edma0 0 51>;
 	dma-names = "rx","tx";
+	pinctrl-names = "default", "gpio";
+	pinctrl-0 = <&pinctrl_i2c1>;
+	pinctrl-1 = <&pinctrl_i2c1_gpio>;
+	scl-gpios = <&gpio5 26 GPIO_ACTIVE_HIGH>;
+	sda-gpios = <&gpio5 27 GPIO_ACTIVE_HIGH>;
 };
drivers/i2c/busses/i2c-imx.c +117 -7

180 lines not on this page · raw message

Signature · 1 line
1.9.1
maintainer
#1 lore raw

Gao,

You completely ignored my review, so I resend it here. The context may not fit exactly since it's from the v5 patch.

Sascha

Quoted 7 lines · Gao Pan

Implement bus recovery methods for i2c-imx so we can recover from situations where SCL/SDA are stuck low.

Once i2c bus SCL/SDA are stuck low during transfer, config the i2c pinctrl to gpio mode by calling pinctrl sleep set function, and then use GPIO to emulate the i2c protocol to send nine dummy clock to recover i2c device. After recovery, set i2c pinctrl to default group setting.

If SCL/SDA a stuck low *during* a transfer that transfer went wrong and we have to return an error and the caller must repeat the transfer. We can't just recover the bus in the middle of a transfer and claim the transfer worked.
We can only do bus recovery on the start of a transfer.

Review static int i2c_imx_bus_busy(struct imx_i2c_struct *i2c_imx, int for_busy) · line 458

Quoted 9 lines
(quoted diff) +4 -1
@@ -439,7 +452,10 @@ static int i2c_imx_bus_busy(struct imx_i2c_struct *i2c_imx, int for_busy)
 		if (time_after(jiffies, orig_jiffies + msecs_to_jiffies(500))) {
 			dev_dbg(&i2c_imx->adapter.dev,
 				"<%s> I2C bus is busy\n", __func__);
-			return -ETIMEDOUT;
+			if (i2c_imx->adapter.bus_recovery_info)
+				return i2c_recover_bus(&i2c_imx->adapter);
+			else
+				return -ETIMEDOUT;

In my tests with a stuck i2c bus this didn't work because this code is not executed due to the arbitration lost check done before. The I2SR_IAL bit was always set when the bus was stuck.

Also as mentioned above I think we should only execute the bus recovery once in a transfer, when the controller fails to start. i2c_imx_bus_busy() is called from far too many places.

Quoted 5 lines
(quoted diff) +0 -0
 		}
 		schedule();
 	}
@@ -963,6 +979,62 @@ out:
 	return (result < 0) ? result : num;

Review out: · line 989

Quoted 10 lines
(quoted diff) +8 -0
 }
 
+static int i2c_imx_get_scl(struct i2c_adapter *adap)
+{
+	struct imx_i2c_struct *i2c_imx;
+
+	i2c_imx = container_of(adap, struct imx_i2c_struct, adapter);
+
+	return gpiod_get_value(i2c_imx->pins.scl);
+}

There's a generic i2c_generic_gpio_recovery() which handles the bus recovery using gpios. We should use it.

Review static int i2c_imx_probe(struct platform_device *pdev) · line 1153

Quoted 9 lines
(quoted diff) +5 -0
@@ -1057,6 +1146,24 @@ static int i2c_imx_probe(struct platform_device *pdev)
 	if (ret < 0)
 		goto rpm_disable;
 
+	/* Init recover pins */
+	i2c_imx->pins.sda =
+		devm_gpiod_get_optional(&pdev->dev, "sda-gpios", GPIOD_IN);
+	i2c_imx->pins.scl =
+		devm_gpiod_get_optional(&pdev->dev, "scl-gpios", GPIOD_IN);

This cannot work. devm_gpiod_get_optional already appends "-gpios".

See my alternative approach below based on your code.

Sascha

---------------------------8<---------------------------

Quoted 1 line

From 32dcaeb4488d8311f68179adf261a909adc660a0 Mon Sep 17 00:00:00 2001

From: Gao Pan <[email protected]>
Date: Fri, 11 Sep 2015 18:42:34 +0800
Subject: [PATCH] i2c: imx: implement bus recovery

Implement bus recovery methods for i2c-imx so we can recover from situations where SCL/SDA are stuck low.

Once i2c bus SCL/SDA are stuck low during transfer, config the i2c pinctrl to gpio mode by calling pinctrl sleep set function, and then use GPIO to emulate the i2c protocol to send nine dummy clock to recover i2c device. After recovery, set i2c pinctrl to default group setting.

---
 Documentation/devicetree/bindings/i2c/i2c-imx.txt |  9 +++
 drivers/i2c/busses/i2c-imx.c                      | 69 +++++++++++++++++++++++
 2 files changed, 78 insertions(+)
Documentation/devicetree/bindings/i2c/i2c-imx.txt +9 -0
index ce4311d..eab5836 100644
@@ -14,6 +14,10 @@ Optional properties:
   The absence of the propoerty indicates the default frequency 100 kHz.
 - dmas: A list of two dma specifiers, one for each entry in dma-names.
 - dma-names: should contain "tx" and "rx".
+- scl-gpios: specify the gpio related to SCL pin
+- sda-gpios: specify the gpio related to SDA pin
+- pinctrl: add extra pinctrl to configure i2c pins to gpio function for i2c
+  bus recovery, call it "gpio" state
 
 Examples:
 
@@ -37,4 +41,9 @@ i2c0: i2c@40066000 { /* i2c0 on vf610 */
 	dmas = <&edma0 0 50>,
 		<&edma0 0 51>;
 	dma-names = "rx","tx";
+	pinctrl-names = "default", "gpio";
+	pinctrl-0 = <&pinctrl_i2c1>;
+	pinctrl-1 = <&pinctrl_i2c1_gpio>;
+	scl-gpios = <&gpio5 26 GPIO_ACTIVE_HIGH>;
+	sda-gpios = <&gpio5 27 GPIO_ACTIVE_HIGH>;
 };
drivers/i2c/busses/i2c-imx.c +69 -0

105 lines not on this page · raw message

Signature · 14 lines
2.5.1


-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |


Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |
#2 lore raw
In reply to Gao Pan

Ping...
From: Gao Pan <mailto:[email protected]> Sent: Monday, September 21, 2015 4:39 PM

Quoted 281 lines

To: [email protected]; [email protected]
Cc: [email protected]; Li Frank-B20596; Duan Fugang-B38611; Gao Pan-B54642; [email protected]; [email protected]
Subject: [Patch V6] i2c: imx: implement bus recovery

Implement bus recovery methods for i2c-imx so we can recover from situations where SCL/SDA are stuck low.

Once i2c bus SCL/SDA are stuck low during transfer, config the i2c pinctrl to gpio mode by calling pinctrl sleep set function, and then use GPIO to emulate the i2c protocol to send nine dummy clock to recover i2c device. After recovery, set i2c pinctrl to default group setting.

---
V2:
As Uwe Kleine-König's suggestion, the version do below changes:
-replace of_get_named_gpio() with devm_gpiod_get_optional() -move
gpio_direction_input() and gpio_direction_output() call to the
prepare callback
-use 0 and 1 as return value for the get_scl and get_sda callbacks

V3:
-replace "...-gpio" with "...-gpios" in i2c binding doc -document the
requirement of using sleep state to configure
the pins as gpio in i2c binding doc
-remove i2c_recover_bus() in i2c_imx_trx_complete() -use GPIOD_OUT_HIGH
as the parameter of devm_gpiod_get_optional to
config the gpios as output high
-add error disposal as devm_gpiod_get_optional meets error

V4:
-remove include <linux/of_gpio.h>
-call i2c_recover_bus under the condition of the existing of
both sda and scl. Drop the sda and scl check in i2c_imx_get_scl, i2c_imx_get_sda, i2c_imx_set_scl, i2c_imx_prepare_recovery and i2c_imx_prepare_recovery
-use GPIOD_OUT_IN as the parameter of devm_gpiod_get_optional -remove
documenting the requirement of using sleep state to configure
the pins as gpio in i2c binding doc

V5:
-introduce a dedicated gpio state for bus recovery. -assign adapter.bus_recovery_info after the two gpios were aquired
successfully.

V6:
-assign adapter.bus_recovery_info under the condition that gpios are
acquired successfully -not try the recovery when pinctrl_lookup_state returns an error

 Documentation/devicetree/bindings/i2c/i2c-imx.txt |   9 ++
 drivers/i2c/busses/i2c-imx.c                      | 124
++++++++++++++++++++--
 2 files changed, 126 insertions(+), 7 deletions(-)
Documentation/devicetree/bindings/i2c/i2c-imx.txt +10 -0
index ce4311d..eab5836 100644
@@ -14,6 +14,10 @@ Optional properties:
   The absence of the propoerty indicates the default frequency 100 kHz.
 - dmas: A list of two dma specifiers, one for each entry in dma-names.
 - dma-names: should contain "tx" and "rx".
+- scl-gpios: specify the gpio related to SCL pin
+- sda-gpios: specify the gpio related to SDA pin
+- pinctrl: add extra pinctrl to configure i2c pins to gpio function for
+i2c
+  bus recovery, call it "gpio" state
 
 Examples:
@@ -37,4 +41,9 @@ i2c0: i2c@40066000 { /* i2c0 on vf610 */
 	dmas = <&edma0 0 50>,
 		<&edma0 0 51>;
 	dma-names = "rx","tx";
+	pinctrl-names = "default", "gpio";
+	pinctrl-0 = <&pinctrl_i2c1>;
+	pinctrl-1 = <&pinctrl_i2c1_gpio>;
+	scl-gpios = <&gpio5 26 GPIO_ACTIVE_HIGH>;
+	sda-gpios = <&gpio5 27 GPIO_ACTIVE_HIGH>;
 };
drivers/i2c/busses/i2c-imx.c +18 -1
index 91bdf28..0773ed1 100644
@@ -40,6 +40,7 @@
 #include <linux/dmapool.h>
 #include <linux/err.h>
 #include <linux/errno.h>
+#include <linux/gpio.h>
 #include <linux/i2c.h>
 #include <linux/init.h>
 #include <linux/interrupt.h>
@@ -64,6 +65,8 @@
 /* Default value */
 #define IMX_I2C_BIT_RATE	100000	/* 100kHz */
 
+#define I2C_PINCTRL_STATE_GPIO	"gpio"
+
 /*
  * Enable DMA if transfer byte size is bigger than this threshold.
  * As the hardware request, it must bigger than 4 bytes.\ @@ -178,6
+181,11 @@ enum imx_i2c_type {
 	VF610_I2C,
 };
 
+struct imx_i2c_pinctrl {
+	struct gpio_desc *sda;
+	struct gpio_desc *scl;
+};
+
 struct imx_i2c_hwdata {
 	enum imx_i2c_type	devtype;
 	unsigned		regshift;
@@ -209,8 +217,13 @@ struct imx_i2c_struct {
 	unsigned int		ifdr; /* IMX_I2C_IFDR */
 	unsigned int		cur_clk;
 	unsigned int		bitrate;
+	struct imx_i2c_pinctrl	pins;
 	const struct imx_i2c_hwdata	*hwdata;
 
+	struct pinctrl *pinctrl;
+	struct pinctrl_state *pinctrl_pins_default;
+	struct pinctrl_state *pinctrl_pins_gpio;
+
 	struct imx_i2c_dma	*dma;
 };
 
@@ -439,7 +452,10 @@ static int i2c_imx_bus_busy(struct imx_i2c_struct
 *i2c_imx, int for_busy)
 		if (time_after(jiffies, orig_jiffies + msecs_to_jiffies(500)))
 {
 			dev_dbg(&i2c_imx->adapter.dev,
 				"<%s> I2C bus is busy\n", __func__);
-			return -ETIMEDOUT;
+			if (i2c_imx->adapter.bus_recovery_info)
+				return i2c_recover_bus(&i2c_imx->adapter);
+			else
+				return -ETIMEDOUT;
 		}
drivers/i2c/busses/i2c-imx.c +48 -0
 		schedule();
 	}
@@ -963,6 +979,62 @@ out:
 	return (result < 0) ? result : num;
 }
 
+static int i2c_imx_get_scl(struct i2c_adapter *adap) {
+	struct imx_i2c_struct *i2c_imx;
+
+	i2c_imx = container_of(adap, struct imx_i2c_struct, adapter);
+
+	return gpiod_get_value(i2c_imx->pins.scl);
+}
+
+static int i2c_imx_get_sda(struct i2c_adapter *adap) {
+	struct imx_i2c_struct *i2c_imx;
+
+	i2c_imx = container_of(adap, struct imx_i2c_struct, adapter);
+
+	return gpiod_get_value(i2c_imx->pins.sda);
+}
+
+static void i2c_imx_set_scl(struct i2c_adapter *adap, int val) {
+	struct imx_i2c_struct *i2c_imx;
+
+	i2c_imx = container_of(adap, struct imx_i2c_struct, adapter);
+
+	gpiod_set_value(i2c_imx->pins.scl, val); }
+
+static void i2c_imx_prepare_recovery(struct i2c_adapter *adap) {
+	struct imx_i2c_struct *i2c_imx;
+
+	i2c_imx = container_of(adap, struct imx_i2c_struct, adapter);
+
+	pinctrl_select_state(i2c_imx->pinctrl, i2c_imx->pinctrl_pins_gpio);
+	gpiod_direction_input(i2c_imx->pins.sda);
+	gpiod_direction_output(i2c_imx->pins.scl, 1); }
+
+static void i2c_imx_unprepare_recovery(struct i2c_adapter *adap) {
+	struct imx_i2c_struct *i2c_imx;
+
+	i2c_imx = container_of(adap, struct imx_i2c_struct, adapter);
+
+	pinctrl_select_state(i2c_imx->pinctrl, i2c_imx-
 >pinctrl_pins_default);
+}
+
+static struct i2c_bus_recovery_info i2c_imx_bus_recovery_info = {
+	.get_scl = i2c_imx_get_scl,
+	.get_sda = i2c_imx_get_sda,
+	.set_scl = i2c_imx_set_scl,
+	.prepare_recovery = i2c_imx_prepare_recovery,
+	.unprepare_recovery = i2c_imx_unprepare_recovery,
+	.recover_bus = i2c_generic_scl_recovery, };
+
 static u32 i2c_imx_func(struct i2c_adapter *adapter)  {
 	return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL @@ -1011,12 +1083,12 @@

static int i2c_imx_probe(struct platform_device *pdev)

drivers/i2c/busses/i2c-imx.c +0 -0
 	/* Setup i2c_imx driver structure */
 	strlcpy(i2c_imx->adapter.name, pdev->name, sizeof(i2c_imx-
Quoted 1 line

adapter.name));

drivers/i2c/busses/i2c-imx.c +6 -6
-	i2c_imx->adapter.owner		= THIS_MODULE;
-	i2c_imx->adapter.algo		= &i2c_imx_algo;
-	i2c_imx->adapter.dev.parent	= &pdev->dev;
-	i2c_imx->adapter.nr		= pdev->id;
-	i2c_imx->adapter.dev.of_node	= pdev->dev.of_node;
-	i2c_imx->base			= base;
+	i2c_imx->adapter.owner = THIS_MODULE;
+	i2c_imx->adapter.algo = &i2c_imx_algo;
+	i2c_imx->adapter.dev.parent = &pdev->dev;
+	i2c_imx->adapter.nr = pdev->id;
+	i2c_imx->adapter.dev.of_node = pdev->dev.of_node;
+	i2c_imx->base = base;
 
 	/* Get I2C clock */
 	i2c_imx->clk = devm_clk_get(&pdev->dev, NULL); @@ -1031,6 +1103,23

@@ static int i2c_imx_probe(struct platform_device *pdev)

drivers/i2c/busses/i2c-imx.c +7 -0
 		return ret;
 	}
 
+	i2c_imx->pinctrl = devm_pinctrl_get(&pdev->dev);
+	if (IS_ERR(i2c_imx->pinctrl)) {
+		ret = PTR_ERR(i2c_imx->pinctrl);
+		goto clk_disable;
+	}
+
+	i2c_imx->pinctrl_pins_default = pinctrl_lookup_state(i2c_imx-
Quoted 1 line

pinctrl,

drivers/i2c/busses/i2c-imx.c +5 -0
+						PINCTRL_STATE_DEFAULT);
+	if (IS_ERR(i2c_imx->pinctrl_pins_default))
+		dev_warn(&pdev->dev, "could not get default state\n");
+	else {
+		i2c_imx->pinctrl_pins_gpio = pinctrl_lookup_state(i2c_imx-
Quoted 1 line

pinctrl,

drivers/i2c/busses/i2c-imx.c +11 -0
+						I2C_PINCTRL_STATE_GPIO);
+		if (IS_ERR(i2c_imx->pinctrl_pins_gpio))
+			dev_warn(&pdev->dev, "could not get gpio state\n");
+	}
+
 	/* Request IRQ */
 	ret = devm_request_irq(&pdev->dev, irq, i2c_imx_isr, 0,
 				pdev->name, i2c_imx);
@@ -1057,6 +1146,27 @@ static int i2c_imx_probe(struct platform_device
 *pdev)
 	if (ret < 0)
 		goto rpm_disable;
 
+	/* Init recover pins */
+	if (!IS_ERR(i2c_imx->pinctrl_pins_default) && !IS_ERR(i2c_imx-
 >pinctrl_pins_gpio)) {
+		i2c_imx->pins.sda =
+			devm_gpiod_get_optional(&pdev->dev, "sda-gpios",
 GPIOD_IN);
+		i2c_imx->pins.scl =
+			devm_gpiod_get_optional(&pdev->dev, "scl-gpios",

GPIOD_IN);

drivers/i2c/busses/i2c-imx.c +13 -0
+
+		if (IS_ERR(i2c_imx->pins.sda)) {
+			ret = PTR_ERR(i2c_imx->pins.sda);
+			goto clk_disable;
+		}
+
+		if (IS_ERR(i2c_imx->pins.scl)) {
+			ret = PTR_ERR(i2c_imx->pins.scl);
+			goto clk_disable;
+		}
+
+		if (i2c_imx->pins.scl && i2c_imx->pins.sda)
+			i2c_imx->adapter.bus_recovery_info =

&i2c_imx_bus_recovery_info;

drivers/i2c/busses/i2c-imx.c +2 -1
+	}
+
 	/* Set up clock divider */
 	i2c_imx->bitrate = IMX_I2C_BIT_RATE;
 	ret = of_property_read_u32(pdev->dev.of_node,
--

1.9.1

maintainer
#3 lore raw
Quoted 1 line · Gao Pandy

Ping...

No need to ping when there are outstanding reviews which by now I have sent twice:

http://www.spinics.net/lists/arm-kernel/msg445986.html
http://comments.gmane.org/gmane.linux.drivers.i2c/24567

Anyway, as you haven't read the last two mails you probably won't read this one either.

Could anyone tell Gao to have a look in his junk folder?

Sascha

Signature · 4 lines
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |
#4 lore raw

From: Sascha Hauer <mailto:[email protected]> Sent: Friday, September 25, 2015 5:41 PM

Quoted 15 lines

To: Gao Pan-B54642
Cc: [email protected]; [email protected]; Duan Fugang-B38611; Li Frank-B20596; [email protected]; [email protected]; [email protected]
Subject: Re: [Patch V6] i2c: imx: implement bus recovery

Quoted 1 line · Gao Pandy

Ping...

No need to ping when there are outstanding reviews which by now I have sent twice:

http://www.spinics.net/lists/arm-kernel/msg445986.html
http://comments.gmane.org/gmane.linux.drivers.i2c/24567

Quoted 6 lines

Anyway, as you haven't read the last two mails you probably won't read this one either.

Could anyone tell Gao to have a look in his junk folder?

Sascha

Sorry for missing your reviews, I will read your reviews seriously. Thank you very much.

Best Regards
Gao Pan

Quoted 9 lines

--
Pengutronix e.K. |
|
Industrial Linux Solutions | http://www.pengutronix.de/
|
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555
|