[PATCH 0/1] TWL: USB: disable VUSB regulators

[PATCH 0/1] TWL: USB: disable VUSB regulators

[Kalle Jokiniemi]

The TWL5030/4030 internal VUSB regulators are eating current
like small piggies. The following patch makes an aptempt at
making the twl4030-usb consumer driver dynamically disable
and enable the regulators it needs.

This regulator fw stuff is fairly new so any comments are
appreciated.

Tested on custom omap3430 hw. Build tested on beagle and
SDP defconfigs. If anyone could test this on public hw, that
would be great. There should be a noticeable drop in power
consumption when usb cable is unplugged with this patch. 


Kalle Jokiniemi (1):
      TWL: USB: disable VUSB regulators when cable unplugged

[PATCH 1/1] TWL: USB: disable VUSB regulators when cable unplugged

[Kalle Jokiniemi]

This patch disables USB regulators VUSB1V5, VUSB1V8, and VUSB3V1
when the USB cable is unplugged to reduce power consumption.

Signed-off-by: Kalle Jokiniemi <kalle.jokiniemi@digia.com>
---
 drivers/usb/otg/twl4030-usb.c |   30 ++++++++++++++++++++++++------
 1 files changed, 24 insertions(+), 6 deletions(-)

diff --git a/drivers/usb/otg/twl4030-usb.c b/drivers/usb/otg/twl4030-usb.c
index 416e441..105ab55 100644
--- a/drivers/usb/otg/twl4030-usb.c
+++ b/drivers/usb/otg/twl4030-usb.c
@@ -34,6 +34,7 @@
 #include <linux/delay.h>
 #include <linux/usb/otg.h>
 #include <linux/i2c/twl4030.h>
+#include <linux/regulator/consumer.h>
 
 
 /* Register defines */
@@ -246,6 +247,11 @@ struct twl4030_usb {
 	struct otg_transceiver	otg;
 	struct device		*dev;
 
+	/* TWL4030 internal USB regulator supplies */
+	struct regulator	*usb1v5;
+	struct regulator	*usb1v8;
+	struct regulator	*usb3v1;
+
 	/* for vbus reporting with irqs disabled */
 	spinlock_t		lock;
 
@@ -434,6 +440,9 @@ static void twl4030_phy_power(struct twl4030_usb *twl, int on)
 
 	pwr = twl4030_usb_read(twl, PHY_PWR_CTRL);
 	if (on) {
+		regulator_enable(twl->usb1v5);
+		regulator_enable(twl->usb1v8);
+		regulator_enable(twl->usb3v1);
 		pwr &= ~PHY_PWR_PHYPWD;
 		WARN_ON(twl4030_usb_write_verify(twl, PHY_PWR_CTRL, pwr) < 0);
 		twl4030_usb_write(twl, PHY_CLK_CTRL,
@@ -443,6 +452,9 @@ static void twl4030_phy_power(struct twl4030_usb *twl, int on)
 	} else  {
 		pwr |= PHY_PWR_PHYPWD;
 		WARN_ON(twl4030_usb_write_verify(twl, PHY_PWR_CTRL, pwr) < 0);
+		regulator_disable(twl->usb1v5);
+		regulator_disable(twl->usb1v8);
+		regulator_disable(twl->usb3v1);
 	}
 }
 
@@ -480,16 +492,19 @@ static void twl4030_usb_ldo_init(struct twl4030_usb *twl)
 	/* input to VUSB3V1 LDO is from VBAT, not VBUS */
 	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0x14, VUSB_DEDICATED1);
 
-	/* turn on 3.1V regulator */
-	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0x20, VUSB3V1_DEV_GRP);
+	/* Initialize 3.1V regulator */
+	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB3V1_DEV_GRP);
+	twl->usb3v1 = regulator_get(twl->dev, "usb3v1");
 	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB3V1_TYPE);
 
-	/* turn on 1.5V regulator */
-	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0x20, VUSB1V5_DEV_GRP);
+	/* Initialize 1.5V regulator */
+	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB1V5_DEV_GRP);
+	twl->usb1v5 = regulator_get(twl->dev, "usb1v5");
 	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB1V5_TYPE);
 
-	/* turn on 1.8V regulator */
-	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0x20, VUSB1V8_DEV_GRP);
+	/* Initialize 1.8V regulator */
+	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB1V8_DEV_GRP);
+	twl->usb1v8 = regulator_get(twl->dev, "usb1v8");
 	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB1V8_TYPE);
 
 	/* disable access to power configuration registers */
@@ -688,6 +703,9 @@ static int __exit twl4030_usb_remove(struct platform_device *pdev)
 	twl4030_usb_clear_bits(twl, POWER_CTRL, POWER_CTRL_OTG_ENAB);
 
 	twl4030_phy_power(twl, 0);
+	regulator_put(twl->usb1v5);
+	regulator_put(twl->usb1v8);
+	regulator_put(twl->usb3v1);
 
 	kfree(twl);
 
-- 
1.5.6.5

Re: [PATCH 1/1] TWL: USB: disable VUSB regulators when cable unplugged

[David Brownell]

On Wednesday 21 January 2009, Kalle Jokiniemi wrote:
> This patch disables USB regulators VUSB1V5, VUSB1V8, and VUSB3V1
> when the USB cable is unplugged to reduce power consumption.

Worked fine on a Beagle, now I'm trying to find out
what's borked on an Overo ...

- Dave

Re: [PATCH 1/1] TWL: USB: disable VUSB regulators when cable unplugged

[Kalle Jokiniemi]

On Thu, 2009-01-22 at 09:55 -0800, David Brownell wrote:
> On Wednesday 21 January 2009, Kalle Jokiniemi wrote:
> > This patch disables USB regulators VUSB1V5, VUSB1V8, and VUSB3V1
> > when the USB cable is unplugged to reduce power consumption.
> 
> Worked fine on a Beagle, now I'm trying to find out
> what's borked on an Overo ...

Did you manage to get it working on Overo? 

BTW. Should I post this patch to linux-usb as well?

- Kalle

> 
> - Dave
> 

Re: [PATCH 1/1] TWL: USB: disable VUSB regulators when cable unplugged

[David Brownell]

On Tuesday 27 January 2009, Kalle Jokiniemi wrote:
> On Thu, 2009-01-22 at 09:55 -0800, David Brownell wrote:
> > On Wednesday 21 January 2009, Kalle Jokiniemi wrote:
> > > This patch disables USB regulators VUSB1V5, VUSB1V8, and VUSB3V1
> > > when the USB cable is unplugged to reduce power consumption.
> > 
> > Worked fine on a Beagle, now I'm trying to find out
> > what's borked on an Overo ...
> 
> Did you manage to get it working on Overo? 

Yes.  It must have either been a bad build, or an issue
with one of the other patches, or something.


> BTW. Should I post this patch to linux-usb as well?

If you like, but it can't merge yet ... the twl4030
regulator code isn't in mainline yet.  I think it's
ready given the patches I posted earlier.

- Dave
 

Re: [PATCH 1/1] TWL: USB: disable VUSB regulators when cable unplugged

[Kalle Jokiniemi]

On Tue, 2009-01-27 at 18:02 -0800, David Brownell wrote:
> On Tuesday 27 January 2009, Kalle Jokiniemi wrote:
> > On Thu, 2009-01-22 at 09:55 -0800, David Brownell wrote:
> > > On Wednesday 21 January 2009, Kalle Jokiniemi wrote:
> > > > This patch disables USB regulators VUSB1V5, VUSB1V8, and VUSB3V1
> > > > when the USB cable is unplugged to reduce power consumption.
> > > 
> > > Worked fine on a Beagle, now I'm trying to find out
> > > what's borked on an Overo ...
> > 
> > Did you manage to get it working on Overo? 
> 
> Yes.  It must have either been a bad build, or an issue
> with one of the other patches, or something.

OK, great :)

> 
> 
> > BTW. Should I post this patch to linux-usb as well?
> 
> If you like, but it can't merge yet ... the twl4030
> regulator code isn't in mainline yet.  I think it's
> ready given the patches I posted earlier.

Oh, so it seems. I guess I'll have to wait for the regulator code to hit
mainline.

- Kalle

> 
> - Dave
>  
> 
> 

Re: [PATCH 0/1] TWL: USB: disable VUSB regulators

[David Brownell]

On Wednesday 21 January 2009, Kalle Jokiniemi wrote:
> The TWL5030/4030 internal VUSB regulators are eating current
> like small piggies.

Feral pigs are a big problem in many places ...
no surprise that feral code is too!


> The following patch makes an aptempt at 
> making the twl4030-usb consumer driver dynamically disable
> and enable the regulators it needs.

Thanks, I'll have a look.  It's a bit different
from some old hacks I didn't finish debugging.

Shouldn't the power down sequence mirror the
power up sequence?  Up 1.5, 1.8, 3.1 ... then
down 3.1, 1.8, 1.5?  Or does that matter?

Also, I'm thinking that the DEV_GRP and TYPE
register updates belong in regulator code, not
transceiver code.  That's something to take care
of with a separate patch though.

- Dave

RE: [PATCH 0/1] TWL: USB: disable VUSB regulators

[Woodruff, Richard]

On Wednesday 21 January 2009, Kalle Jokiniemi wrote:
> > The TWL5030/4030 internal VUSB regulators are eating current
> > like small piggies.
>
> Feral pigs are a big problem in many places ...
> no surprise that feral code is too!

A simple but impacting point is a LDO when left on, wastes a lot of system power.

If you have say 4.4v battery and it goes to a LDO which supports a 1.8v IO.  The LDO will drop a lot of power on the floor.  A design with a 3.6v batter to the same LDO drops less power.  Twl5030 can consume a lot of power if your not watching at the system level.

For processor rails VCORE (omap2), VDD1/VDD2 (omap3) at least there is a DCDC switcher which is somewhat efficient. This gives you your 1.2v with out dumping everything.

Didn't know Dave was such a poet :)

Regards,
Richard W.

Re: [PATCH 0/1] TWL: USB: disable VUSB regulators

[David Brownell]

On Wednesday 21 January 2009, Woodruff, Richard wrote:
> A simple but impacting point is a LDO when left on, wastes a lot of system power.

So I guess I'll poke a bit harder at finding ways to
make sure the LDOs on the twl4030 get turned off..
this patch looks like a good start (since the VUSB
regulators are completely set up).

VAUX3 seems to be inappropriately enabled on a lot
of OMAP3 boards; short of fixing u-boot, that'd be
another bit of low-hanging fruit.


> Didn't know Dave was such a poet :)

Well, I dunno about the rhyme or scansion, but I
do sort of like the "feral code" imagery.  It seems
to highlight some key behaviors better than many
more familiar terms!

- Dave

Re: [PATCH 0/1] TWL: USB: disable VUSB regulators

[Kalle Jokiniemi]

Hi Dave,

Sorry for the late response, I was out of office yesterday.

On Wed, 2009-01-21 at 12:38 -0800, David Brownell wrote:
> On Wednesday 21 January 2009, Kalle Jokiniemi wrote:
> > The TWL5030/4030 internal VUSB regulators are eating current
> > like small piggies.
> 
> Feral pigs are a big problem in many places ...
> no surprise that feral code is too!
> 
> 
> > The following patch makes an aptempt at 
> > making the twl4030-usb consumer driver dynamically disable
> > and enable the regulators it needs.
> 
> Thanks, I'll have a look.  It's a bit different
> from some old hacks I didn't finish debugging.
> 
> Shouldn't the power down sequence mirror the
> power up sequence?  Up 1.5, 1.8, 3.1 ... then
> down 3.1, 1.8, 1.5?  Or does that matter?

Good question. The TRM tells quite little on these VUSB regulators,
other than they supply the USB sub-chip in TWL. For VUSB3V1 there is a
bit more information, telling that it supplies USB PHY, CEA Carkit
modules and MCPC (seems to be some special usb UART specification). 

I would think they all can be shut down in whatever order, if there is
nothing connected to the usb connector.

> 
> Also, I'm thinking that the DEV_GRP and TYPE
> register updates belong in regulator code, not
> transceiver code.  That's something to take care
> of with a separate patch though.

I agree.

- Kalle 

> 
> - Dave

[PATCH 0/1] USB: disable twl4030 usb regulators

[Kalle Jokiniemi]

This patch combines the two patches "TWL: USB: disable VUSB
regulators when cable unplugged" and "USB: OTG: Twl4030 depends
on REGULATOR_TWL4030" sent earlier by me.

New thing is that the patch now handles situations where
disabling of VUSB3V1 regulator resets the ACTIVE state
remapping to SLEEP to be enabled.

Thanks to Jouni Hogander and David Brownell for helping
out with the patch. 

 drivers/usb/otg/Kconfig       |    2 +-
 drivers/usb/otg/twl4030-usb.c |   73 ++++++++++++++++++++++++++++++++++++-----
 2 files changed, 65 insertions(+), 10 deletions(-)


--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[PATCH 1/1] TWL: USB: disable VUSB regulators when cable unplugged

[Kalle Jokiniemi]

From: Jouni Hogander <jouni.hogander-xNZwKgViW5gAvxtiuMwx3w@public.gmane.org>

This patch disables USB regulators VUSB1V5, VUSB1V8, and VUSB3V1
when the USB cable is unplugged to reduce power consumption.
Added a depencency from twl4030 usb driver to TWL_REGULATOR.

Signed-off-by: Jouni Hogander <jouni.hogander-xNZwKgViW5gAvxtiuMwx3w@public.gmane.org>
Signed-off-by: Kalle Jokiniemi <kalle.jokiniemi-sMOQStClEysAvxtiuMwx3w@public.gmane.org>
---
 drivers/usb/otg/Kconfig       |    2 +-
 drivers/usb/otg/twl4030-usb.c |   73 ++++++++++++++++++++++++++++++++++++-----
 2 files changed, 65 insertions(+), 10 deletions(-)

diff --git a/drivers/usb/otg/Kconfig b/drivers/usb/otg/Kconfig
index ee55b44..5790a5b 100644
--- a/drivers/usb/otg/Kconfig
+++ b/drivers/usb/otg/Kconfig
@@ -43,7 +43,7 @@ config ISP1301_OMAP
 
 config TWL4030_USB
 	tristate "TWL4030 USB Transceiver Driver"
-	depends on TWL4030_CORE
+	depends on TWL4030_CORE && REGULATOR_TWL4030
 	select USB_OTG_UTILS
 	help
 	  Enable this to support the USB OTG transceiver on TWL4030
diff --git a/drivers/usb/otg/twl4030-usb.c b/drivers/usb/otg/twl4030-usb.c
index 416e441..d9478d0 100644
--- a/drivers/usb/otg/twl4030-usb.c
+++ b/drivers/usb/otg/twl4030-usb.c
@@ -34,6 +34,8 @@
 #include <linux/delay.h>
 #include <linux/usb/otg.h>
 #include <linux/i2c/twl4030.h>
+#include <linux/regulator/consumer.h>
+#include <linux/err.h>
 
 
 /* Register defines */
@@ -246,6 +248,11 @@ struct twl4030_usb {
 	struct otg_transceiver	otg;
 	struct device		*dev;
 
+	/* TWL4030 internal USB regulator supplies */
+	struct regulator	*usb1v5;
+	struct regulator	*usb1v8;
+	struct regulator	*usb3v1;
+
 	/* for vbus reporting with irqs disabled */
 	spinlock_t		lock;
 
@@ -434,6 +441,18 @@ static void twl4030_phy_power(struct twl4030_usb *twl, int on)
 
 	pwr = twl4030_usb_read(twl, PHY_PWR_CTRL);
 	if (on) {
+		regulator_enable(twl->usb3v1);
+		regulator_enable(twl->usb1v8);
+		/*
+		 * Disabling usb3v1 regulator (= writing 0 to VUSB3V1_DEV_GRP
+		 * in twl4030) resets the VUSB_DEDICATED2 register. This reset
+		 * enables VUSB3V1_SLEEP bit that remaps usb3v1 ACTIVE state to
+		 * SLEEP. We work around this by clearing the bit after usv3v1
+		 * is re-activated. This ensures that VUSB3V1 is really active.
+		 */
+		twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0,
+							VUSB_DEDICATED2);
+		regulator_enable(twl->usb1v5);
 		pwr &= ~PHY_PWR_PHYPWD;
 		WARN_ON(twl4030_usb_write_verify(twl, PHY_PWR_CTRL, pwr) < 0);
 		twl4030_usb_write(twl, PHY_CLK_CTRL,
@@ -443,6 +462,9 @@ static void twl4030_phy_power(struct twl4030_usb *twl, int on)
 	} else  {
 		pwr |= PHY_PWR_PHYPWD;
 		WARN_ON(twl4030_usb_write_verify(twl, PHY_PWR_CTRL, pwr) < 0);
+		regulator_disable(twl->usb1v5);
+		regulator_disable(twl->usb1v8);
+		regulator_disable(twl->usb3v1);
 	}
 }
 
@@ -468,7 +490,7 @@ static void twl4030_phy_resume(struct twl4030_usb *twl)
 	twl->asleep = 0;
 }
 
-static void twl4030_usb_ldo_init(struct twl4030_usb *twl)
+static int twl4030_usb_ldo_init(struct twl4030_usb *twl)
 {
 	/* Enable writing to power configuration registers */
 	twl4030_i2c_write_u8(TWL4030_MODULE_PM_MASTER, 0xC0, PROTECT_KEY);
@@ -480,20 +502,45 @@ static void twl4030_usb_ldo_init(struct twl4030_usb *twl)
 	/* input to VUSB3V1 LDO is from VBAT, not VBUS */
 	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0x14, VUSB_DEDICATED1);
 
-	/* turn on 3.1V regulator */
-	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0x20, VUSB3V1_DEV_GRP);
+	/* Initialize 3.1V regulator */
+	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB3V1_DEV_GRP);
+
+	twl->usb3v1 = regulator_get(twl->dev, "usb3v1");
+	if (IS_ERR(twl->usb3v1))
+		return -ENODEV;
+
 	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB3V1_TYPE);
 
-	/* turn on 1.5V regulator */
-	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0x20, VUSB1V5_DEV_GRP);
+	/* Initialize 1.5V regulator */
+	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB1V5_DEV_GRP);
+
+	twl->usb1v5 = regulator_get(twl->dev, "usb1v5");
+	if (IS_ERR(twl->usb1v5))
+		goto fail1;
+
 	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB1V5_TYPE);
 
-	/* turn on 1.8V regulator */
-	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0x20, VUSB1V8_DEV_GRP);
+	/* Initialize 1.8V regulator */
+	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB1V8_DEV_GRP);
+
+	twl->usb1v8 = regulator_get(twl->dev, "usb1v8");
+	if (IS_ERR(twl->usb1v8))
+		goto fail2;
+
 	twl4030_i2c_write_u8(TWL4030_MODULE_PM_RECEIVER, 0, VUSB1V8_TYPE);
 
 	/* disable access to power configuration registers */
 	twl4030_i2c_write_u8(TWL4030_MODULE_PM_MASTER, 0, PROTECT_KEY);
+
+	return 0;
+
+fail2:
+	regulator_put(twl->usb1v5);
+	twl->usb1v5 = NULL;
+fail1:
+	regulator_put(twl->usb3v1);
+	twl->usb3v1 = NULL;
+	return -ENODEV;
 }
 
 static ssize_t twl4030_usb_vbus_show(struct device *dev,
@@ -598,7 +645,7 @@ static int __init twl4030_usb_probe(struct platform_device *pdev)
 {
 	struct twl4030_usb_data *pdata = pdev->dev.platform_data;
 	struct twl4030_usb	*twl;
-	int			status;
+	int			status, err;
 
 	if (!pdata) {
 		dev_dbg(&pdev->dev, "platform_data not available\n");
@@ -622,7 +669,12 @@ static int __init twl4030_usb_probe(struct platform_device *pdev)
 	/* init spinlock for workqueue */
 	spin_lock_init(&twl->lock);
 
-	twl4030_usb_ldo_init(twl);
+	err = twl4030_usb_ldo_init(twl);
+	if (err) {
+		dev_err(&pdev->dev, "ldo init failed\n");
+		kfree(twl);
+		return err;
+	}
 	otg_set_transceiver(&twl->otg);
 
 	platform_set_drvdata(pdev, twl);
@@ -688,6 +740,9 @@ static int __exit twl4030_usb_remove(struct platform_device *pdev)
 	twl4030_usb_clear_bits(twl, POWER_CTRL, POWER_CTRL_OTG_ENAB);
 
 	twl4030_phy_power(twl, 0);
+	regulator_put(twl->usb1v5);
+	regulator_put(twl->usb1v8);
+	regulator_put(twl->usb3v1);
 
 	kfree(twl);
 
-- 
1.5.4.3

--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html