diff mbox

Add regulator driver for the bq2407x family of charger ICs

Message ID 201108202224.52250.heiko@sntech.de (mailing list archive)
State Not Applicable, archived
Headers show

Commit Message

Heiko Stübner Aug. 20, 2011, 8:24 p.m. UTC
This driver controls a TI bq2407x charger attached via GPIOs.
The provided current regulator can enable/disable charging and
select between 100 mA, 500 mA and a machine specific current limit.

Signed-off-by: Heiko Stuebner <heiko@sntech.de>
---
 drivers/regulator/Kconfig         |    8 ++
 drivers/regulator/Makefile        |    1 +
 drivers/regulator/bq2407x.c       |  205 +++++++++++++++++++++++++++++++++++++
 include/linux/regulator/bq2407x.h |   36 +++++++
 4 files changed, 250 insertions(+), 0 deletions(-)
 create mode 100644 drivers/regulator/bq2407x.c
 create mode 100644 include/linux/regulator/bq2407x.h

Comments

Mark Brown Aug. 23, 2011, 11:50 a.m. UTC | #1
On Sat, Aug 20, 2011 at 10:24:51PM +0200, Heiko Stübner wrote:

Mostly looks good, just a few fairly small comments below.

> +	if (pdata->max_uA && pdata->max_uA > 500000
> +			      && max_uA >= pdata->max_uA) {
> +		dev_dbg(rdev_get_dev(rdev),
> +			"setting current limit to %d mA\n",
> +			pdata->max_uA / 1000);
> +		gpio_set_value(pdata->gpio_en2, 1);
> +		gpio_set_value(pdata->gpio_en1, 0);
> +	} else if (max_uA >= 500000) {
> +		dev_dbg(rdev_get_dev(rdev),
> +			"setting current limit to 500 mA\n");
> +		gpio_set_value(pdata->gpio_en2, 0);
> +		gpio_set_value(pdata->gpio_en1, 1);
> +	} else if (max_uA >= 100000) {
> +		dev_dbg(rdev_get_dev(rdev),
> +			"setting current limit to 100 mA\n");
> +		gpio_set_value(pdata->gpio_en2, 0);
> +		gpio_set_value(pdata->gpio_en1, 0);
> +	} else {
> +		dev_dbg(rdev_get_dev(rdev),
> +			"setting current limit to 0 mA\n");
> +		gpio_set_value(pdata->gpio_en2, 1);
> +		gpio_set_value(pdata->gpio_en1, 1);
> +	}

I'd rather expect this to return an error sometimes.

> +static int bq2407x_get_current_limit(struct regulator_dev *rdev)
> +{
> +	struct bq2407x_mach_info *pdata = rdev_get_drvdata(rdev);
> +
> +	int en2 = gpio_get_value(pdata->gpio_en2);
> +	int en1 = gpio_get_value(pdata->gpio_en1);

Calling gpio_get_value() on an output GPIO is undefined, you need to
remember what values you set.

> +static int bq2407x_enable(struct regulator_dev *rdev)
> +{
> +	struct bq2407x_mach_info *pdata = rdev_get_drvdata(rdev);
> +
> +	dev_dbg(rdev_get_dev(rdev), "enabling charger\n");
> +
> +	gpio_set_value(pdata->gpio_nce, 0);
> +	return 0;

Blank line here.
Heiko Stübner Aug. 23, 2011, 8:15 p.m. UTC | #2
Am Dienstag 23 August 2011, 13:50:24 schrieb Mark Brown:
> On Sat, Aug 20, 2011 at 10:24:51PM +0200, Heiko Stübner wrote:
> 
> Mostly looks good, just a few fairly small comments below.
> 
> > +	if (pdata->max_uA && pdata->max_uA > 500000
> > +			      && max_uA >= pdata->max_uA) {
> > +		dev_dbg(rdev_get_dev(rdev),
> > +			"setting current limit to %d mA\n",
> > +			pdata->max_uA / 1000);
> > +		gpio_set_value(pdata->gpio_en2, 1);
> > +		gpio_set_value(pdata->gpio_en1, 0);
> > +	} else if (max_uA >= 500000) {
> > +		dev_dbg(rdev_get_dev(rdev),
> > +			"setting current limit to 500 mA\n");
> > +		gpio_set_value(pdata->gpio_en2, 0);
> > +		gpio_set_value(pdata->gpio_en1, 1);
> > +	} else if (max_uA >= 100000) {
> > +		dev_dbg(rdev_get_dev(rdev),
> > +			"setting current limit to 100 mA\n");
> > +		gpio_set_value(pdata->gpio_en2, 0);
> > +		gpio_set_value(pdata->gpio_en1, 0);
> > +	} else {
> > +		dev_dbg(rdev_get_dev(rdev),
> > +			"setting current limit to 0 mA\n");
> > +		gpio_set_value(pdata->gpio_en2, 1);
> > +		gpio_set_value(pdata->gpio_en1, 1);
> > +	}
> 
> I'd rather expect this to return an error sometimes.
gpio_set_value is a void function, so I'm not sure what could cause an error 
here.

Heiko
Mark Brown Aug. 24, 2011, 9:07 a.m. UTC | #3
On Tue, Aug 23, 2011 at 10:15:07PM +0200, Heiko Stübner wrote:
> Am Dienstag 23 August 2011, 13:50:24 schrieb Mark Brown:
> > On Sat, Aug 20, 2011 at 10:24:51PM +0200, Heiko Stübner wrote:

> > > +	} else if (max_uA >= 100000) {
> > > +		dev_dbg(rdev_get_dev(rdev),
> > > +			"setting current limit to 100 mA\n");
> > > +		gpio_set_value(pdata->gpio_en2, 0);
> > > +		gpio_set_value(pdata->gpio_en1, 0);
> > > +	} else {
> > > +		dev_dbg(rdev_get_dev(rdev),
> > > +			"setting current limit to 0 mA\n");
> > > +		gpio_set_value(pdata->gpio_en2, 1);
> > > +		gpio_set_value(pdata->gpio_en1, 1);
> > > +	}

> > I'd rather expect this to return an error sometimes.

> gpio_set_value is a void function, so I'm not sure what could cause an error 
> here.

For example if you're asked for a limit below 100mA - disabling the
charger probably isn't a useful implementation.  The disable should be
done with enable/disable.
diff mbox

Patch

diff --git a/drivers/regulator/Kconfig b/drivers/regulator/Kconfig
index c7fd2c0..921e271 100644
--- a/drivers/regulator/Kconfig
+++ b/drivers/regulator/Kconfig
@@ -72,6 +72,14 @@  config REGULATOR_BQ24022
 	  charging select between 100 mA and 500 mA charging current
 	  limit.
 
+config REGULATOR_BQ2407x
+	tristate "TI bq2407x Li-Ion Charger IC"
+	help
+	  This driver controls a TI bq2407x Charger attached via
+	  GPIOs. The provided current regulator can enable/disable
+	  charging select between 100 mA, 500 mA and a machine specific
+	  charging current limit.
+
 config REGULATOR_MAX1586
 	tristate "Maxim 1586/1587 voltage regulator"
 	depends on I2C
diff --git a/drivers/regulator/Makefile b/drivers/regulator/Makefile
index 040d5aa..ce65493 100644
--- a/drivers/regulator/Makefile
+++ b/drivers/regulator/Makefile
@@ -10,6 +10,7 @@  obj-$(CONFIG_REGULATOR_USERSPACE_CONSUMER) += userspace-consumer.o
 
 obj-$(CONFIG_REGULATOR_AD5398) += ad5398.o
 obj-$(CONFIG_REGULATOR_BQ24022) += bq24022.o
+obj-$(CONFIG_REGULATOR_BQ2407x) += bq2407x.o
 obj-$(CONFIG_REGULATOR_LP3971) += lp3971.o
 obj-$(CONFIG_REGULATOR_LP3972) += lp3972.o
 obj-$(CONFIG_REGULATOR_MAX1586) += max1586.o
diff --git a/drivers/regulator/bq2407x.c b/drivers/regulator/bq2407x.c
new file mode 100644
index 0000000..2338540
--- /dev/null
+++ b/drivers/regulator/bq2407x.c
@@ -0,0 +1,205 @@ 
+/*
+ * Support for TI bq2407x USB-friendly
+ * Li-Ion Charger connected via GPIOs.
+ *
+ * Copyright (c) 2011 Heiko Stuebner
+ *
+ * based on the bq24022 driver
+ * Copyright (c) 2008 Philipp Zabel
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ */
+
+#include <linux/kernel.h>
+#include <linux/init.h>
+#include <linux/platform_device.h>
+#include <linux/err.h>
+#include <linux/module.h>
+#include <linux/gpio.h>
+#include <linux/regulator/bq2407x.h>
+#include <linux/regulator/driver.h>
+
+
+static int bq2407x_set_current_limit(struct regulator_dev *rdev,
+					int min_uA, int max_uA)
+{
+	struct bq2407x_mach_info *pdata = rdev_get_drvdata(rdev);
+
+	if (pdata->max_uA && pdata->max_uA > 500000
+			      && max_uA >= pdata->max_uA) {
+		dev_dbg(rdev_get_dev(rdev),
+			"setting current limit to %d mA\n",
+			pdata->max_uA / 1000);
+		gpio_set_value(pdata->gpio_en2, 1);
+		gpio_set_value(pdata->gpio_en1, 0);
+	} else if (max_uA >= 500000) {
+		dev_dbg(rdev_get_dev(rdev),
+			"setting current limit to 500 mA\n");
+		gpio_set_value(pdata->gpio_en2, 0);
+		gpio_set_value(pdata->gpio_en1, 1);
+	} else if (max_uA >= 100000) {
+		dev_dbg(rdev_get_dev(rdev),
+			"setting current limit to 100 mA\n");
+		gpio_set_value(pdata->gpio_en2, 0);
+		gpio_set_value(pdata->gpio_en1, 0);
+	} else {
+		dev_dbg(rdev_get_dev(rdev),
+			"setting current limit to 0 mA\n");
+		gpio_set_value(pdata->gpio_en2, 1);
+		gpio_set_value(pdata->gpio_en1, 1);
+	}
+
+	/* REVISIT: maybe return error if min_uA != 0 ? */
+	return 0;
+}
+
+static int bq2407x_get_current_limit(struct regulator_dev *rdev)
+{
+	struct bq2407x_mach_info *pdata = rdev_get_drvdata(rdev);
+
+	int en2 = gpio_get_value(pdata->gpio_en2);
+	int en1 = gpio_get_value(pdata->gpio_en1);
+
+	if (en2 && en1)
+		return 0;
+	else if (en2 && !en1)
+		return pdata->max_uA;
+	else if (!en2 && en1)
+		return 500000;
+	else
+		return 100000;
+}
+
+static int bq2407x_enable(struct regulator_dev *rdev)
+{
+	struct bq2407x_mach_info *pdata = rdev_get_drvdata(rdev);
+
+	dev_dbg(rdev_get_dev(rdev), "enabling charger\n");
+
+	gpio_set_value(pdata->gpio_nce, 0);
+	return 0;
+}
+
+static int bq2407x_disable(struct regulator_dev *rdev)
+{
+	struct bq2407x_mach_info *pdata = rdev_get_drvdata(rdev);
+
+	dev_dbg(rdev_get_dev(rdev), "disabling charger\n");
+
+	gpio_set_value(pdata->gpio_nce, 1);
+	return 0;
+}
+
+static int bq2407x_is_enabled(struct regulator_dev *rdev)
+{
+	struct bq2407x_mach_info *pdata = rdev_get_drvdata(rdev);
+
+	return !gpio_get_value(pdata->gpio_nce);
+}
+
+static struct regulator_ops bq2407x_ops = {
+	.set_current_limit = bq2407x_set_current_limit,
+	.get_current_limit = bq2407x_get_current_limit,
+	.enable            = bq2407x_enable,
+	.disable           = bq2407x_disable,
+	.is_enabled        = bq2407x_is_enabled,
+};
+
+static struct regulator_desc bq2407x_desc = {
+	.name  = "bq2407x",
+	.ops   = &bq2407x_ops,
+	.type  = REGULATOR_CURRENT,
+	.owner = THIS_MODULE,
+};
+
+static int __init bq2407x_probe(struct platform_device *pdev)
+{
+	struct bq2407x_mach_info *pdata = pdev->dev.platform_data;
+	struct regulator_dev *bq2407x;
+	int ret;
+
+	if (!pdata || !pdata->gpio_nce || !pdata->gpio_en1 || !pdata->gpio_en2)
+		return -EINVAL;
+
+	ret = gpio_request(pdata->gpio_nce, "ncharge_en");
+	if (ret) {
+		dev_dbg(&pdev->dev, "couldn't request nCE GPIO: %d\n",
+			pdata->gpio_nce);
+		goto err_ce;
+	}
+	ret = gpio_request(pdata->gpio_en2, "charge_mode_en2");
+	if (ret) {
+		dev_dbg(&pdev->dev, "couldn't request EN2 GPIO: %d\n",
+			pdata->gpio_en2);
+		goto err_en2;
+	}
+	ret = gpio_request(pdata->gpio_en1, "charge_mode_en1");
+	if (ret) {
+		dev_dbg(&pdev->dev, "couldn't request EN1 GPIO: %d\n",
+			pdata->gpio_en1);
+		goto err_en1;
+	}
+	ret = gpio_direction_output(pdata->gpio_en2, 0);
+	ret = gpio_direction_output(pdata->gpio_en1, 0);
+	ret = gpio_direction_output(pdata->gpio_nce, 1);
+
+	bq2407x = regulator_register(&bq2407x_desc, &pdev->dev,
+				     pdata->init_data, pdata);
+	if (IS_ERR(bq2407x)) {
+		dev_dbg(&pdev->dev, "couldn't register regulator\n");
+		ret = PTR_ERR(bq2407x);
+		goto err_reg;
+	}
+	platform_set_drvdata(pdev, bq2407x);
+	dev_dbg(&pdev->dev, "registered regulator\n");
+
+	return 0;
+err_reg:
+	gpio_free(pdata->gpio_en1);
+err_en1:
+	gpio_free(pdata->gpio_en2);
+err_en2:
+	gpio_free(pdata->gpio_nce);
+err_ce:
+	return ret;
+}
+
+static int __devexit bq2407x_remove(struct platform_device *pdev)
+{
+	struct bq2407x_mach_info *pdata = pdev->dev.platform_data;
+	struct regulator_dev *bq2407x = platform_get_drvdata(pdev);
+
+	regulator_unregister(bq2407x);
+	gpio_free(pdata->gpio_en1);
+	gpio_free(pdata->gpio_en2);
+	gpio_free(pdata->gpio_nce);
+
+	return 0;
+}
+
+static struct platform_driver bq2407x_driver = {
+	.driver = {
+		.name = "bq2407x",
+	},
+	.remove = __devexit_p(bq2407x_remove),
+};
+
+static int __init bq2407x_init(void)
+{
+	return platform_driver_probe(&bq2407x_driver, bq2407x_probe);
+}
+
+static void __exit bq2407x_exit(void)
+{
+	platform_driver_unregister(&bq2407x_driver);
+}
+
+module_init(bq2407x_init);
+module_exit(bq2407x_exit);
+
+MODULE_AUTHOR("Heiko Stuebner");
+MODULE_DESCRIPTION("TI bq2407x Li-Ion Charger driver");
+MODULE_LICENSE("GPL");
diff --git a/include/linux/regulator/bq2407x.h b/include/linux/regulator/bq2407x.h
new file mode 100644
index 0000000..8145150
--- /dev/null
+++ b/include/linux/regulator/bq2407x.h
@@ -0,0 +1,36 @@ 
+/*
+ * Support for TI bq2407x 1.5A USB-friendly
+ * Li-Ion Charger connected via GPIOs.
+ *
+ * Copyright (c) 2011 Heiko Stuebner
+ *
+ * based on the bq24022 driver
+ * Copyright (c) 2008 Philipp Zabel
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ */
+
+struct regulator_init_data;
+
+/**
+ * bq2407x_mach_info - platform data for bq2407x
+ * @gpio_nce: GPIO line connected to the nCE pin, used to control charging
+ * @gpio_en2: GPIO line connected to the EN2 pin, used to limit charging
+ * @gpio_en1: GPIO line connected to the EN1 pin, used to limit charging
+ * @max_uA: maximum current defined by resistor on ILIM connector
+ * Modes of operation:
+ * EN2 = 0, EN1 = 0: 100mA
+ * EN2 = 0, EN1 = 1: 500mA
+ * EN2 = 1, EN1 = 0: max_current
+ * EN2 = 1, EN1 = 1: Standby (usb suspend)
+ */
+struct bq2407x_mach_info {
+	int gpio_nce;
+	int gpio_en2;
+	int gpio_en1;
+	int max_uA;
+	struct regulator_init_data *init_data;
+};