diff mbox

[v2,1/5] i2c: Don't start transfers when suspended

Message ID 1405608520-5644-1-git-send-email-hechtb@gmail.com (mailing list archive)
State New, archived
Headers show

Commit Message

Bastian Hecht July 17, 2014, 2:48 p.m. UTC
i2c transfer requests come in very uncontrolled, like from interrupt routines.
We might be suspended when this happens. To avoid i2c timeouts caused by
powered down busses we check for suspension.

Several bus drivers handle this problem on their own. We can clean things up
by moving the protection mechanism into the core.

Signed-off-by: Bastian Hecht <hechtb@gmail.com>
---
changelog v2:

- commit message extended.
- initialization added for adap->suspended
- swapped branch for increased performance


 drivers/i2c/i2c-core.c | 25 ++++++++++++++++++++++++-
 include/linux/i2c.h    |  1 +
 2 files changed, 25 insertions(+), 1 deletion(-)

Comments

Bastian Hecht July 17, 2014, 2:58 p.m. UTC | #1
I want to add the remark that I can't help further on the patch series
in the next month about. So this is free to be taken/ignored/modified
without any approval by my side.

Have fun coding,

 Bastian


2014-07-17 16:48 GMT+02:00 Bastian Hecht <hechtb@gmail.com>:
> i2c transfer requests come in very uncontrolled, like from interrupt routines.
> We might be suspended when this happens. To avoid i2c timeouts caused by
> powered down busses we check for suspension.
>
> Several bus drivers handle this problem on their own. We can clean things up
> by moving the protection mechanism into the core.
>
> Signed-off-by: Bastian Hecht <hechtb@gmail.com>
> ---
> changelog v2:
>
> - commit message extended.
> - initialization added for adap->suspended
> - swapped branch for increased performance
>
>
>  drivers/i2c/i2c-core.c | 25 ++++++++++++++++++++++++-
>  include/linux/i2c.h    |  1 +
>  2 files changed, 25 insertions(+), 1 deletion(-)
>
> diff --git a/drivers/i2c/i2c-core.c b/drivers/i2c/i2c-core.c
> index 7c7f4b8..b15dc20 100644
> --- a/drivers/i2c/i2c-core.c
> +++ b/drivers/i2c/i2c-core.c
> @@ -343,6 +343,13 @@ static int i2c_legacy_resume(struct device *dev)
>  static int i2c_device_pm_suspend(struct device *dev)
>  {
>         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
> +       struct i2c_adapter *adap = i2c_verify_adapter(dev);
> +
> +       if (adap) {
> +               i2c_lock_adapter(adap);
> +               adap->suspended = true;
> +               i2c_unlock_adapter(adap);
> +       }
>
>         if (pm)
>                 return pm_generic_suspend(dev);
> @@ -353,6 +360,13 @@ static int i2c_device_pm_suspend(struct device *dev)
>  static int i2c_device_pm_resume(struct device *dev)
>  {
>         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
> +       struct i2c_adapter *adap = i2c_verify_adapter(dev);
> +
> +       if (adap) {
> +               i2c_lock_adapter(adap);
> +               adap->suspended = false;
> +               i2c_unlock_adapter(adap);
> +       }
>
>         if (pm)
>                 return pm_generic_resume(dev);
> @@ -1243,6 +1257,7 @@ static int i2c_register_adapter(struct i2c_adapter *adap)
>         dev_set_name(&adap->dev, "i2c-%d", adap->nr);
>         adap->dev.bus = &i2c_bus_type;
>         adap->dev.type = &i2c_adapter_type;
> +       adap->suspended = false;
>         res = device_register(&adap->dev);
>         if (res)
>                 goto out_list;
> @@ -1819,7 +1834,10 @@ int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
>                         i2c_lock_adapter(adap);
>                 }
>
> -               ret = __i2c_transfer(adap, msgs, num);
> +               if (!adap->suspended)
> +                       ret = __i2c_transfer(adap, msgs, num);
> +               else
> +                       ret = -EIO;
>                 i2c_unlock_adapter(adap);
>
>                 return ret;
> @@ -2577,6 +2595,10 @@ s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
>
>         if (adapter->algo->smbus_xfer) {
>                 i2c_lock_adapter(adapter);
> +               if (adapter->suspended) {
> +                       res = -EIO;
> +                       goto unlock;
> +               }
>
>                 /* Retry automatically on arbitration loss */
>                 orig_jiffies = jiffies;
> @@ -2590,6 +2612,7 @@ s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
>                                        orig_jiffies + adapter->timeout))
>                                 break;
>                 }
> +unlock:
>                 i2c_unlock_adapter(adapter);
>
>                 if (res != -EOPNOTSUPP || !adapter->algo->master_xfer)
> diff --git a/include/linux/i2c.h b/include/linux/i2c.h
> index b556e0a..af08c75 100644
> --- a/include/linux/i2c.h
> +++ b/include/linux/i2c.h
> @@ -434,6 +434,7 @@ struct i2c_adapter {
>         int timeout;                    /* in jiffies */
>         int retries;
>         struct device dev;              /* the adapter device */
> +       unsigned int suspended:1;
>
>         int nr;
>         char name[48];
> --
> 1.9.1
>
Wolfram Sang July 17, 2014, 3:09 p.m. UTC | #2
On Thu, Jul 17, 2014 at 04:58:17PM +0200, Bastian Hecht wrote:
> I want to add the remark that I can't help further on the patch series
> in the next month about. So this is free to be taken/ignored/modified
> without any approval by my side.

Good to know. I'd like to get some Tested-by tags before applying to
make sure we have no regressions. So, with you being away, let's just
schedule this for 3.18 and we have all the time we need. Thanks for
finishing this code before you left. Have a great month!

   Wolfram
Grygorii Strashko July 22, 2014, 6:46 p.m. UTC | #3
Hi

On 07/17/2014 05:48 PM, Bastian Hecht wrote:
> i2c transfer requests come in very uncontrolled, like from interrupt routines.
> We might be suspended when this happens. To avoid i2c timeouts caused by
> powered down busses we check for suspension.
> 
> Several bus drivers handle this problem on their own. We can clean things up
> by moving the protection mechanism into the core.

 I'm not sure, this optimization is safe  (
Because, in many cases the access to PMIC IC needs to be allowed till late
stages of suspending (at least till suspend_noirq stage or even later).
For example, on some OMAP SoC Voltage management code need to use services
provided by PMIC IC, which is connected to I2C.

As result, it may cause regression and break PM functionality on some SoCs
if i2c-core will block I2c transfers unconditionally at device's
suspending stage.

May be it will be useful to add just "suspended" field in i2c adapter
structure and provide corresponding accessors.

> 
> Signed-off-by: Bastian Hecht <hechtb@gmail.com>
> ---
> changelog v2:
> 
> - commit message extended.
> - initialization added for adap->suspended
> - swapped branch for increased performance
> 
> 
>   drivers/i2c/i2c-core.c | 25 ++++++++++++++++++++++++-
>   include/linux/i2c.h    |  1 +
>   2 files changed, 25 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/i2c/i2c-core.c b/drivers/i2c/i2c-core.c
> index 7c7f4b8..b15dc20 100644
> --- a/drivers/i2c/i2c-core.c
> +++ b/drivers/i2c/i2c-core.c
> @@ -343,6 +343,13 @@ static int i2c_legacy_resume(struct device *dev)
>   static int i2c_device_pm_suspend(struct device *dev)
>   {
>   	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
> +	struct i2c_adapter *adap = i2c_verify_adapter(dev);
> +
> +	if (adap) {
> +		i2c_lock_adapter(adap);
> +		adap->suspended = true;
> +		i2c_unlock_adapter(adap);
> +	}
>   
>   	if (pm)
>   		return pm_generic_suspend(dev);
> @@ -353,6 +360,13 @@ static int i2c_device_pm_suspend(struct device *dev)
>   static int i2c_device_pm_resume(struct device *dev)
>   {
>   	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
> +	struct i2c_adapter *adap = i2c_verify_adapter(dev);
> +
> +	if (adap) {
> +		i2c_lock_adapter(adap);
> +		adap->suspended = false;
> +		i2c_unlock_adapter(adap);
> +	}
>   
>   	if (pm)
>   		return pm_generic_resume(dev);
> @@ -1243,6 +1257,7 @@ static int i2c_register_adapter(struct i2c_adapter *adap)
>   	dev_set_name(&adap->dev, "i2c-%d", adap->nr);
>   	adap->dev.bus = &i2c_bus_type;
>   	adap->dev.type = &i2c_adapter_type;
> +	adap->suspended = false;
>   	res = device_register(&adap->dev);
>   	if (res)
>   		goto out_list;
> @@ -1819,7 +1834,10 @@ int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
>   			i2c_lock_adapter(adap);
>   		}
>   
> -		ret = __i2c_transfer(adap, msgs, num);
> +		if (!adap->suspended)
> +			ret = __i2c_transfer(adap, msgs, num);
> +		else
> +			ret = -EIO;
>   		i2c_unlock_adapter(adap);
>   
>   		return ret;
> @@ -2577,6 +2595,10 @@ s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
>   
>   	if (adapter->algo->smbus_xfer) {
>   		i2c_lock_adapter(adapter);
> +		if (adapter->suspended) {
> +			res = -EIO;
> +			goto unlock;
> +		}
>   
>   		/* Retry automatically on arbitration loss */
>   		orig_jiffies = jiffies;
> @@ -2590,6 +2612,7 @@ s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
>   				       orig_jiffies + adapter->timeout))
>   				break;
>   		}
> +unlock:
>   		i2c_unlock_adapter(adapter);
>   
>   		if (res != -EOPNOTSUPP || !adapter->algo->master_xfer)
> diff --git a/include/linux/i2c.h b/include/linux/i2c.h
> index b556e0a..af08c75 100644
> --- a/include/linux/i2c.h
> +++ b/include/linux/i2c.h
> @@ -434,6 +434,7 @@ struct i2c_adapter {
>   	int timeout;			/* in jiffies */
>   	int retries;
>   	struct device dev;		/* the adapter device */
> +	unsigned int suspended:1;
>   
>   	int nr;
>   	char name[48];
> 

Regards,
- grygroii
Russell King - ARM Linux July 22, 2014, 9:20 p.m. UTC | #4
On Tue, Jul 22, 2014 at 09:46:46PM +0300, Grygorii Strashko wrote:
>  I'm not sure, this optimization is safe  (
> Because, in many cases the access to PMIC IC needs to be allowed till late
> stages of suspending (at least till suspend_noirq stage or even later).
> For example, on some OMAP SoC Voltage management code need to use services
> provided by PMIC IC, which is connected to I2C.

This is definitely not safe.  I worked on a PXA platform a while back
where the only way to tell the thing to "sleep" was to send an I2C
message to a microcontroller asking it to remove power.

Plus, as you say, you may also have PMICs that you need to talk to
in order to shut power off to various peripherals (and maybe even
the CPU itself) during the suspend process.

I2C is one of those cases where devices attached to the I2C bus are
themselves responsible for doing their own suspend shutdown at the
appropriate time; it's not the responsibility of the I2C core to
know this kind of system/driver dependent detail.
Wolfram Sang Sept. 19, 2014, 5:18 p.m. UTC | #5
On Thu, Jul 17, 2014 at 04:48:36PM +0200, Bastian Hecht wrote:
> i2c transfer requests come in very uncontrolled, like from interrupt routines.
> We might be suspended when this happens. To avoid i2c timeouts caused by
> powered down busses we check for suspension.
> 
> Several bus drivers handle this problem on their own. We can clean things up
> by moving the protection mechanism into the core.
> 
> Signed-off-by: Bastian Hecht <hechtb@gmail.com>

Dropping this series due to the comments. I am not sure if it is worth
to add information about the clients being "normally" suspendable or
not. Thanks Bastian for the effort, though.
diff mbox

Patch

diff --git a/drivers/i2c/i2c-core.c b/drivers/i2c/i2c-core.c
index 7c7f4b8..b15dc20 100644
--- a/drivers/i2c/i2c-core.c
+++ b/drivers/i2c/i2c-core.c
@@ -343,6 +343,13 @@  static int i2c_legacy_resume(struct device *dev)
 static int i2c_device_pm_suspend(struct device *dev)
 {
 	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
+	struct i2c_adapter *adap = i2c_verify_adapter(dev);
+
+	if (adap) {
+		i2c_lock_adapter(adap);
+		adap->suspended = true;
+		i2c_unlock_adapter(adap);
+	}
 
 	if (pm)
 		return pm_generic_suspend(dev);
@@ -353,6 +360,13 @@  static int i2c_device_pm_suspend(struct device *dev)
 static int i2c_device_pm_resume(struct device *dev)
 {
 	const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
+	struct i2c_adapter *adap = i2c_verify_adapter(dev);
+
+	if (adap) {
+		i2c_lock_adapter(adap);
+		adap->suspended = false;
+		i2c_unlock_adapter(adap);
+	}
 
 	if (pm)
 		return pm_generic_resume(dev);
@@ -1243,6 +1257,7 @@  static int i2c_register_adapter(struct i2c_adapter *adap)
 	dev_set_name(&adap->dev, "i2c-%d", adap->nr);
 	adap->dev.bus = &i2c_bus_type;
 	adap->dev.type = &i2c_adapter_type;
+	adap->suspended = false;
 	res = device_register(&adap->dev);
 	if (res)
 		goto out_list;
@@ -1819,7 +1834,10 @@  int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
 			i2c_lock_adapter(adap);
 		}
 
-		ret = __i2c_transfer(adap, msgs, num);
+		if (!adap->suspended)
+			ret = __i2c_transfer(adap, msgs, num);
+		else
+			ret = -EIO;
 		i2c_unlock_adapter(adap);
 
 		return ret;
@@ -2577,6 +2595,10 @@  s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
 
 	if (adapter->algo->smbus_xfer) {
 		i2c_lock_adapter(adapter);
+		if (adapter->suspended) {
+			res = -EIO;
+			goto unlock;
+		}
 
 		/* Retry automatically on arbitration loss */
 		orig_jiffies = jiffies;
@@ -2590,6 +2612,7 @@  s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, unsigned short flags,
 				       orig_jiffies + adapter->timeout))
 				break;
 		}
+unlock:
 		i2c_unlock_adapter(adapter);
 
 		if (res != -EOPNOTSUPP || !adapter->algo->master_xfer)
diff --git a/include/linux/i2c.h b/include/linux/i2c.h
index b556e0a..af08c75 100644
--- a/include/linux/i2c.h
+++ b/include/linux/i2c.h
@@ -434,6 +434,7 @@  struct i2c_adapter {
 	int timeout;			/* in jiffies */
 	int retries;
 	struct device dev;		/* the adapter device */
+	unsigned int suspended:1;
 
 	int nr;
 	char name[48];