Add support for DA9150 Fuel-Gauge

Signed-off-by Adam Thomson <[email protected]>

[...]

+config FG_DA9150

[...]

drivers/power/da9150-fg.c new file +3 -0

+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>

drivers/power/da9150-fg.c new file +26 -0

+		da9150_fg_soc_event_config(fg);
+
+	/* Clear any FG IRQs */
+	da9150_fg_write_attr(fg, DA9150_QIF_E_FG_STATUS,
+			     DA9150_QIF_E_FG_STATUS_SIZE, e_fg_status);
+
+	return IRQ_HANDLED;
+}
+
 
[...]
 
+static int da9150_fg_probe(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	struct da9150 *da9150 = dev_get_drvdata(dev->parent);
+	struct da9150_fg_pdata *fg_pdata = dev_get_platdata(dev);
+	struct da9150_fg *fg;
+	int ver, irq, ret;
+
+	fg = devm_kzalloc(dev, sizeof(*fg), GFP_KERNEL);
+	if (fg == NULL)
+		return -ENOMEM;
+
+	platform_set_drvdata(pdev, fg);
+	fg->da9150 = da9150;
+	fg->dev = dev;
+
+	mutex_init(&fg->io_lock);

drivers/power/da9150-fg.c new file +57 -0

+	ver = da9150_fg_read_attr(fg, DA9150_QIF_FW_MAIN_VER,
+				  DA9150_QIF_FW_MAIN_VER_SIZE);
+	dev_info(dev, "Version: 0x%x\n", ver);
+
+	/* Handle DT data if provided */
+	if (dev->of_node) {
+		fg_pdata = da9150_fg_dt_pdata(dev);
+		dev->platform_data = fg_pdata;
+	}
+
+	/* Handle any pdata provided */
+	if (fg_pdata) {
+		fg->interval = fg_pdata->update_interval;
+
+		if (fg_pdata->warn_soc_lvl > 100)
+			dev_warn(dev, "Invalid SOC warning level provided, Ignoring");
+		else
+			fg->warn_soc = fg_pdata->warn_soc_lvl;
+
+		if ((fg_pdata->crit_soc_lvl > 100) ||
+		    (fg_pdata->crit_soc_lvl >= fg_pdata->warn_soc_lvl))
+			dev_warn(dev, "Invalid SOC critical level provided, Ignoring");
+		else
+			fg->crit_soc = fg_pdata->crit_soc_lvl;
+
+
+	}
+
+	/* Configure initial SOC level events */
+	da9150_fg_soc_event_config(fg);
+
+	/*
+	 * If an interval period has been provided then setup repeating
+	 * work for reporting data updates.
+	 */
+	if (fg->interval) {
+		INIT_DELAYED_WORK(&fg->work, da9150_fg_work);
+		schedule_delayed_work(&fg->work,
+				      msecs_to_jiffies(fg->interval));
+	}
+
+	/* Register IRQ */
+	irq = platform_get_irq_byname(pdev, "FG");
+	ret = request_threaded_irq(irq, NULL, da9150_fg_irq, IRQF_ONESHOT, "FG",
+				   fg);
+	if (ret)
+		goto irq_fail;
+
+	return ret;
+
+irq_fail:
+	cancel_delayed_work(&fg->work);
+	power_supply_unregister(fg->battery);
+
+	return ret;
+}
+

Hi Adam,

The driver looks mostly fine. I have a few comments, though:

Quoted 1 line · Adam Thomson

Signed-off-by Adam Thomson <[email protected]>

Please add a short description to the commit message.

Quoted 3 lines

[...]

+config FG_DA9150

Please name the config entry BATTERY_DA9150 to be consistent with the other fuel gauges.

Quoted 5 lines

[...]

drivers/power/da9150-fg.c new file +3 -0

+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>

drivers/power/da9150-fg.c line 26

Quoted 10 lines

drivers/power/da9150-fg.c new file +10 -0

+#include <linux/of.h>
+#include <linux/of_platform.h>
+#include <linux/slab.h>
+#include <linux/interrupt.h>
+#include <linux/delay.h>
+#include <linux/power_supply.h>
+#include <linux/list.h>
+#include <asm/div64.h>
+#include <linux/mfd/da9150/core.h>
+#include <linux/mfd/da9150/registers.h>

I wonder if the "depends CHARGER_DA9150" in Kconfig should be "depends MFD_DA9150" instead.

drivers/power/da9150-fg.c line 219

Quoted 10 lines

[...]

drivers/power/da9150-fg.c new file +9 -0

+
+/* Power Supply attributes */
+static int da9150_fg_capacity(struct da9150_fg *fg,
+			      union power_supply_propval *val)
+{
+	da9150_fg_read_sync_start(fg);
+	val->intval = da9150_fg_read_attr(fg, DA9150_QIF_SOC_PCT,
+					  DA9150_QIF_SOC_PCT_SIZE);
+	da9150_fg_read_sync_end(fg);

Create a wrapper function for this. Reading a single value with sync guards is done multiple times.

da9150_fg_read_attr_sync(fg, ...) {
    da9150_fg_read_sync_start(fg);
    da9150_fg_read_attr(fg, ...);
    da9150_fg_read_sync_end(fg);
}

drivers/power/da9150-fg.c

Quoted 12 lines

drivers/power/da9150-fg.c new file +10 -0

+	if (val->intval > 100)
+		val->intval = 100;
+
+	return 0;
+}
+
 
[...]
+					  DA9150_QIF_E_FG_STATUS_SIZE);
+
+	/* Handle warning/critical threhold events */
+	if ((DA9150_FG_IRQ_LOW_SOC_MASK | DA9150_FG_IRQ_HIGH_SOC_MASK)

&

drivers/power/da9150-fg.c line 409

Quoted 1 line

drivers/power/da9150-fg.c new file +1 -0

+	    e_fg_status)

Please make this (e_fg_status & CONSTANT_MASK).

Quoted 22 lines

drivers/power/da9150-fg.c new file +19 -0

+		da9150_fg_soc_event_config(fg);
+
+	/* Clear any FG IRQs */
+	da9150_fg_write_attr(fg, DA9150_QIF_E_FG_STATUS,
+			     DA9150_QIF_E_FG_STATUS_SIZE, e_fg_status);
+
+	return IRQ_HANDLED;
+}
+
 
[...]
 
+static int da9150_fg_probe(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	struct da9150 *da9150 = dev_get_drvdata(dev->parent);
+	struct da9150_fg_pdata *fg_pdata = dev_get_platdata(dev);
+	struct da9150_fg *fg;
+	int ver, irq, ret;
+
+	fg = devm_kzalloc(dev, sizeof(*fg), GFP_KERNEL);
+	if (fg == NULL)

drivers/power/da9150-fg.c

Quoted 10 lines

drivers/power/da9150-fg.c new file +10 -0

+		return -ENOMEM;
+
+	platform_set_drvdata(pdev, fg);
+	fg->da9150 = da9150;
+	fg->dev = dev;
+
+	mutex_init(&fg->io_lock);
+
+	/* Enable QIF */
+	da9150_set_bits(da9150, DA9150_CORE2WIRE_CTRL_A,

DA9150_FG_QIF_EN_MASK,

drivers/power/da9150-fg.c line 472

Quoted 7 lines

drivers/power/da9150-fg.c new file +7 -0

+			DA9150_FG_QIF_EN_MASK);
+
+	fg->battery = power_supply_register(dev, &fg_desc, NULL);
+	if (IS_ERR(fg->battery)) {
+		ret = PTR_ERR(fg->battery);
+		return ret;
+	}

Please use devm_power_supply_register(...) to simplify the driver.

Quoted 6 lines

drivers/power/da9150-fg.c new file +6 -0

+	ver = da9150_fg_read_attr(fg, DA9150_QIF_FW_MAIN_VER,
+				  DA9150_QIF_FW_MAIN_VER_SIZE);
+	dev_info(dev, "Version: 0x%x\n", ver);
+
+	/* Handle DT data if provided */
+	if (dev->of_node) {

drivers/power/da9150-fg.c

Quoted 10 lines

drivers/power/da9150-fg.c new file +10 -0

+		fg_pdata = da9150_fg_dt_pdata(dev);
+		dev->platform_data = fg_pdata;
+	}
+
+	/* Handle any pdata provided */
+	if (fg_pdata) {
+		fg->interval = fg_pdata->update_interval;
+
+		if (fg_pdata->warn_soc_lvl > 100)
+			dev_warn(dev, "Invalid SOC warning level provided,

Ignoring");

drivers/power/da9150-fg.c

Quoted 6 lines

drivers/power/da9150-fg.c new file +6 -0

+		else
+			fg->warn_soc = fg_pdata->warn_soc_lvl;
+
+		if ((fg_pdata->crit_soc_lvl > 100) ||
+		    (fg_pdata->crit_soc_lvl >= fg_pdata->warn_soc_lvl))
+			dev_warn(dev, "Invalid SOC critical level provided,

Ignoring");

Quoted 41 lines

drivers/power/da9150-fg.c new file +41 -0

+		else
+			fg->crit_soc = fg_pdata->crit_soc_lvl;
+
+
+	}
+
+	/* Configure initial SOC level events */
+	da9150_fg_soc_event_config(fg);
+
+	/*
+	 * If an interval period has been provided then setup repeating
+	 * work for reporting data updates.
+	 */
+	if (fg->interval) {
+		INIT_DELAYED_WORK(&fg->work, da9150_fg_work);
+		schedule_delayed_work(&fg->work,
+				      msecs_to_jiffies(fg->interval));
+	}
+
+	/* Register IRQ */
+	irq = platform_get_irq_byname(pdev, "FG");
+	ret = request_threaded_irq(irq, NULL, da9150_fg_irq, IRQF_ONESHOT, "FG",
+				   fg);
+	if (ret)
+		goto irq_fail;
+
+	return ret;
+
+irq_fail:
+	cancel_delayed_work(&fg->work);
+	power_supply_unregister(fg->battery);
+
+	return ret;
+}
+
+static int da9150_fg_remove(struct platform_device *pdev)
+{
+	struct da9150_fg *fg = platform_get_drvdata(pdev);
+	int irq;
+
+	irq = platform_get_irq_byname(pdev, "FG");

drivers/power/da9150-fg.c line 540

Quoted 4 lines

drivers/power/da9150-fg.c new file +4 -0

+	free_irq(irq, fg);
+
+	if (fg->interval)
+		cancel_delayed_work(&fg->work);

It looks like the order of irq freeing and canceling of the delayed work is not important. In that case I suggest switching to devm_request_threaded_irq(...).

Quoted 7 lines

drivers/power/da9150-fg.c new file +4 -0

+	power_supply_unregister(fg->battery);
+
+	return 0;
+}
 
[...]

drivers/power/da9150-fg.c

Quoted 3 lines

drivers/power/da9150-fg.c new file +3 -0

+
+MODULE_DESCRIPTION("Fuel-Gauge Driver for DA9150");
+MODULE_AUTHOR("Adam Thomson

<[email protected]>");

Quoted 1 line

+MODULE_LICENSE("GPL");

MODULE_LICENSE("GPL v2");

Quoted 3 lines

Quoted 1 line

+MODULE_LICENSE("GPL");

MODULE_LICENSE("GPL v2");

If I do this then I need to update the file license disclaimer at the top, as right now they match and are correct as far as I can tell. Is this change needed and if so is this the intention for other drivers as well, just so I'm clear?

Quoted 7 lines

Quoted 3 lines

Quoted 1 line

+MODULE_LICENSE("GPL");

MODULE_LICENSE("GPL v2");

If I do this then I need to update the file license disclaimer at the top, as right now they match and are correct as far as I can tell. Is this change needed and if so is this the intention for other drivers as well, just so I'm clear?

The header states GPL v2+.

-- Sebastian

Quoted 1 line

The header states GPL v2+.

Yes, and this matches the "GPL" string as I understand it. The following is taken from "include/linux/module.h":

---
/*
* The following license idents are currently accepted as indicating free
* software modules
*
* "GPL" [GNU Public License v2 or later]
* "GPL v2" [GNU Public License v2]

Hi,

Review

Quoted 1 line · Adam Thomson

(quoted diff) +0 -0

b/Documentation/devicetree/bindings/power/da9150-fg.txt

Documentation/devicetree/bindings/power/da9150-fg.txt line 4

Quoted 9 lines

new file mode 100644
index 0000000..c3c76eb

Documentation/devicetree/bindings/power/da9150-fg.txt new file +4 -0

@@ -0,0 +1,23 @@
+Dialog Semiconductor DA9150 Fuel-Gauge Power Supply bindings
+
+Required properties:
+- compatible: "dlg,da9150-fg" for DA9150 Fuel-Gauge Power Supply

                  ^^^^^^^^^^^^^

s/dlg,da9150-fg/dlg,da9150-fuel-gauge/g

Quoted 6 lines

Documentation/devicetree/bindings/power/da9150-fg.txt new file +6 -0

+Optional properties:
+- dlg,update-interval: Interval time (milliseconds) between battery level checks.
+- dlg,warn-soc-level: Battery discharge level (%) where warning event raised.
+      [1 - 100]
+- dlg,crit-soc-level: Battery discharge level (%) where critical event raised.
+  This value should be lower than the warning level.

Documentation/devicetree/bindings/power/da9150-fg.txt line 17

Quoted 6 lines

Documentation/devicetree/bindings/power/da9150-fg.txt new file +6 -0

+      [1 - 100]
+
+
+Example:
+
+	da9150-fg {

Make this just "fuel-gauge".

Documentation/devicetree/bindings/power/da9150-fg.txt line 18

Quoted 2 lines

Documentation/devicetree/bindings/power/da9150-fg.txt new file +1 -0

+		compatible = "dlg,da9150-fg";

                      ^^^^^^^^^^^^^

here too ;)

Documentation/devicetree/bindings/power/da9150-fg.txt line 23

Quoted 6 lines

Documentation/devicetree/bindings/power/da9150-fg.txt new file +5 -0

+
+		dlg,update-interval = <10000>;
+		dlg,warn-soc-level = /bits/ 8 <15>;
+		dlg,crit-soc-level = /bits/ 8 <5>;
+	};

-- Sebastian