Patchwork [RFC,4/6] power: supply: Ettus Research E31x charger driver

login
register
mail settings
Submitter Virendra Kakade
Date Feb. 12, 2019, 1:01 a.m.
Message ID <20190212010143.3729-5-virendra.kakade@ni.com>
Download mbox | patch
Permalink /patch/723455/
State New
Headers show

Comments

Virendra Kakade - Feb. 12, 2019, 1:01 a.m.
Add support for E31x devices charger which is a sub-device of E31X-PMU.
Enables query of charger properties from device tree.

Signed-off-by: Virendra Kakade <virendra.kakade@ni.com>
---
 drivers/power/supply/Kconfig        |   6 +
 drivers/power/supply/Makefile       |   1 +
 drivers/power/supply/e31x-charger.c | 190 ++++++++++++++++++++++++++++
 include/linux/mfd/e31x-pmu.h        |   4 +
 4 files changed, 201 insertions(+)
 create mode 100644 drivers/power/supply/e31x-charger.c
Sebastian Reichel - Feb. 12, 2019, 9:46 p.m.
Hi,

On Mon, Feb 11, 2019 at 07:01:41PM -0600, Virendra Kakade wrote:
> Add support for E31x devices charger which is a sub-device of E31X-PMU.
> Enables query of charger properties from device tree.
> 
> Signed-off-by: Virendra Kakade <virendra.kakade@ni.com>
> ---
>  drivers/power/supply/Kconfig        |   6 +
>  drivers/power/supply/Makefile       |   1 +
>  drivers/power/supply/e31x-charger.c | 190 ++++++++++++++++++++++++++++
>  include/linux/mfd/e31x-pmu.h        |   4 +
>  4 files changed, 201 insertions(+)
>  create mode 100644 drivers/power/supply/e31x-charger.c
> 
> diff --git a/drivers/power/supply/Kconfig b/drivers/power/supply/Kconfig
> index e901b9879e7e..3d043b8fd49c 100644
> --- a/drivers/power/supply/Kconfig
> +++ b/drivers/power/supply/Kconfig
> @@ -660,4 +660,10 @@ config FUEL_GAUGE_SC27XX
>  	 Say Y here to enable support for fuel gauge with SC27XX
>  	 PMIC chips.
>  
> +config E31X_CHARGER
> +	tristate "Ettus Research E31x charger support"
> +	depends on MFD_E31X_PMU
> +	help
> +	 This adds support for the battery charger in Ettus Research E31x PMU.
> +
>  endif # POWER_SUPPLY
> diff --git a/drivers/power/supply/Makefile b/drivers/power/supply/Makefile
> index b731c2a9b695..6f4f8ca5484e 100644
> --- a/drivers/power/supply/Makefile
> +++ b/drivers/power/supply/Makefile
> @@ -87,3 +87,4 @@ obj-$(CONFIG_AXP288_CHARGER)	+= axp288_charger.o
>  obj-$(CONFIG_CHARGER_CROS_USBPD)	+= cros_usbpd-charger.o
>  obj-$(CONFIG_CHARGER_SC2731)	+= sc2731_charger.o
>  obj-$(CONFIG_FUEL_GAUGE_SC27XX)	+= sc27xx_fuel_gauge.o
> +obj-$(CONFIG_E31X_CHARGER)	+= e31x-charger.o
> diff --git a/drivers/power/supply/e31x-charger.c b/drivers/power/supply/e31x-charger.c
> new file mode 100644
> index 000000000000..f154482bf95e
> --- /dev/null
> +++ b/drivers/power/supply/e31x-charger.c
> @@ -0,0 +1,190 @@
> +// SPDX-License-Identifier: GPL-2.0

This specifies GPLv2 only, but MODULE_LICENSE("GPL") specifies GPL2
or later. Please fix one of them.

> +/*
> + * Copyright (c) 2018 National Instruments Corp
> + * Author: Virendra Kakade <virendra.kakade@ni.com>
> + *
> + * Ettus Research E31x charger driver
> + */
> +
> +#include <linux/kernel.h>
> +#include <linux/module.h>
> +#include <linux/of_device.h>
> +#include <linux/platform_device.h>
> +#include <linux/mfd/syscon.h>
> +#include <linux/mutex.h>
> +#include <linux/regmap.h>
> +#include <linux/string.h>
> +#include <linux/slab.h>
> +#include <linux/power_supply.h>
> +#include <linux/delay.h>
> +#include <linux/mfd/e31x-pmu.h>

Please check the includes. Quite a few seem to be unused.

> +
> +#define E31X_PMU_CHARGER_HEALTH_MASK		GENMASK(1, 0)
> +#define E31X_PMU_CHARGER_HEALTH_SHIFT		0
> +#define E31X_PMU_CHARGER_CHARGE_TYPE_MASK	GENMASK(4, 3)
> +#define E31X_PMU_CHARGER_CHARGE_TYPE_SHIFT	3
> +
> +struct e31x_charger_dev {
> +	struct regmap *regmap;
> +	struct power_supply *supply;
> +};
> +
> +static int e31x_charger_get_health(struct e31x_charger_dev *charger,
> +				   union power_supply_propval *val)
> +{
> +	u32 value;
> +	int err;
> +
> +	err = regmap_read(charger->regmap, E31X_PMU_REG_CHARGER, &value);
> +	if (err)
> +		return err;
> +
> +	value = E31X_PMU_GET_FIELD(CHARGER_HEALTH, value);
> +	switch (value) {
> +	case 0x0:
> +		val->intval = POWER_SUPPLY_HEALTH_GOOD;
> +		break;
> +	case 0x1:
> +		val->intval = POWER_SUPPLY_HEALTH_UNSPEC_FAILURE;
> +		break;
> +	case 0x2:
> +		val->intval = POWER_SUPPLY_HEALTH_OVERVOLTAGE;
> +		break;
> +	case 0x3:
> +		val->intval = POWER_SUPPLY_HEALTH_OVERHEAT;
> +		break;
> +	default:
> +		val->intval = POWER_SUPPLY_HEALTH_UNKNOWN;
> +		break;
> +	};
> +
> +	return 0;
> +}
> +
> +static int e31x_charger_get_type(struct e31x_charger_dev *charger,
> +				 union power_supply_propval *val)
> +{
> +	u32 value;
> +	int err;
> +
> +	err = regmap_read(charger->regmap, E31X_PMU_REG_CHARGER, &value);
> +	if (err)
> +		return err;
> +
> +	value = E31X_PMU_GET_FIELD(CHARGER_CHARGE_TYPE, value);
> +	switch (value) {
> +	case 0x0:
> +		val->intval = POWER_SUPPLY_CHARGE_TYPE_NONE;
> +		break;
> +	case 0x1:
> +		val->intval = POWER_SUPPLY_CHARGE_TYPE_TRICKLE;
> +		break;
> +	case 0x2:
> +		val->intval = POWER_SUPPLY_CHARGE_TYPE_FAST;
> +		break;
> +	default:
> +		val->intval = POWER_SUPPLY_CHARGE_TYPE_NONE;
> +		break;
> +	};
> +	return 0;
> +}
> +
> +static int e31x_charger_get_online(struct e31x_charger_dev *charger,
> +				   union power_supply_propval *val)
> +{
> +	u32 value;
> +	int err;
> +
> +	err = regmap_read(charger->regmap, E31X_PMU_REG_CHARGER, &value);
> +	if (err)
> +		return err;
> +
> +	value = E31X_PMU_GET_FIELD(CHARGER_ONLINE, value);
> +	val->intval = !!value;
> +
> +	return 0;
> +}
> +
> +static int e31x_charger_get_property(struct power_supply *psy,
> +				     enum power_supply_property psp,
> +				     union power_supply_propval *val)
> +{
> +	struct e31x_charger_dev *charger = power_supply_get_drvdata(psy);
> +	int err = -EINVAL;
> +
> +	switch (psp) {
> +	case POWER_SUPPLY_PROP_HEALTH:
> +		return e31x_charger_get_health(charger, val);
> +	case POWER_SUPPLY_PROP_CHARGE_TYPE:
> +		return e31x_charger_get_type(charger, val);
> +	case POWER_SUPPLY_PROP_ONLINE:
> +		return e31x_charger_get_online(charger, val);
> +	case POWER_SUPPLY_PROP_SCOPE:
> +		val->intval = POWER_SUPPLY_SCOPE_SYSTEM;
> +		return 0;
> +	default:
> +		break;
> +	}
> +
> +	return err;
> +}
> +
> +static enum power_supply_property e31x_charger_properties[] = {
> +	POWER_SUPPLY_PROP_HEALTH,
> +	POWER_SUPPLY_PROP_CHARGE_TYPE,
> +	POWER_SUPPLY_PROP_ONLINE,
> +	POWER_SUPPLY_PROP_SCOPE,
> +};
> +
> +static const struct power_supply_desc e31x_charger_desc = {
> +	.name = "e31x-charger",
> +	.type = POWER_SUPPLY_TYPE_MAINS,
> +	.properties = e31x_charger_properties,
> +	.num_properties = ARRAY_SIZE(e31x_charger_properties),
> +	.get_property = e31x_charger_get_property,
> +};
> +
> +static const struct of_device_id e31x_charger_id[] = {
> +	{ .compatible = "ni,e31x-charger" },
> +	{ },
> +};
> +
> +static int e31x_charger_probe(struct platform_device *pdev)
> +{
> +	struct power_supply_config psy_cfg = {};
> +	struct e31x_charger_dev *charger;
> +
> +	if (!of_device_is_available(pdev->dev.of_node))
> +		return -ENODEV;
> +
> +	charger = devm_kzalloc(&pdev->dev, sizeof(*charger), GFP_KERNEL);
> +	if (!charger)
> +		return -ENOMEM;
> +
> +	charger->regmap = syscon_regmap_lookup_by_phandle(\

useless \

> +			pdev->dev.parent->of_node, "regmap");
> +
> +	psy_cfg.of_node = pdev->dev.of_node;
> +	psy_cfg.drv_data = charger;
> +
> +	charger->supply = devm_power_supply_register(&pdev->dev,
> +						     &e31x_charger_desc,
> +						     &psy_cfg);
> +
> +	if (IS_ERR(charger->supply))
> +		return PTR_ERR(charger->supply);
> +	return 0;
> +}
> +
> +static struct platform_driver e31x_charger_driver = {
> +	.driver = {
> +		.name = "e31x-charger",
> +		.of_match_table = e31x_charger_id,
> +	},
> +	.probe = e31x_charger_probe,
> +};
> +module_platform_driver(e31x_charger_driver);
> +
> +MODULE_AUTHOR("Virendra Kakade <virendra.kakade@ni.com>");
> +MODULE_DESCRIPTION("E31x charger driver");
> +MODULE_LICENSE("GPL");
> diff --git a/include/linux/mfd/e31x-pmu.h b/include/linux/mfd/e31x-pmu.h
> index c57d5a8c1aad..e0649845fe4d 100644
> --- a/include/linux/mfd/e31x-pmu.h
> +++ b/include/linux/mfd/e31x-pmu.h
> @@ -12,9 +12,13 @@
>  #include <linux/bitops.h>
>  
>  #define E31X_PMU_REG_MISC      0x04
> +#define E31X_PMU_REG_CHARGER   0x0c
>  
>  #define E31X_PMU_GET_FIELD(name, reg) \
>  	(((reg) & E31X_PMU_## name ##_MASK) >> \
>  	E31X_PMU_## name ##_SHIFT)
>  
> +#define E31X_PMU_CHARGER_ONLINE_MASK	BIT(2)
> +#define E31X_PMU_CHARGER_ONLINE_SHIFT	2
> +
>  #endif /* MFD_E31X_PMU_H */

Otherwise this looks good.

-- Sebastian

Patch

diff --git a/drivers/power/supply/Kconfig b/drivers/power/supply/Kconfig
index e901b9879e7e..3d043b8fd49c 100644
--- a/drivers/power/supply/Kconfig
+++ b/drivers/power/supply/Kconfig
@@ -660,4 +660,10 @@  config FUEL_GAUGE_SC27XX
 	 Say Y here to enable support for fuel gauge with SC27XX
 	 PMIC chips.
 
+config E31X_CHARGER
+	tristate "Ettus Research E31x charger support"
+	depends on MFD_E31X_PMU
+	help
+	 This adds support for the battery charger in Ettus Research E31x PMU.
+
 endif # POWER_SUPPLY
diff --git a/drivers/power/supply/Makefile b/drivers/power/supply/Makefile
index b731c2a9b695..6f4f8ca5484e 100644
--- a/drivers/power/supply/Makefile
+++ b/drivers/power/supply/Makefile
@@ -87,3 +87,4 @@  obj-$(CONFIG_AXP288_CHARGER)	+= axp288_charger.o
 obj-$(CONFIG_CHARGER_CROS_USBPD)	+= cros_usbpd-charger.o
 obj-$(CONFIG_CHARGER_SC2731)	+= sc2731_charger.o
 obj-$(CONFIG_FUEL_GAUGE_SC27XX)	+= sc27xx_fuel_gauge.o
+obj-$(CONFIG_E31X_CHARGER)	+= e31x-charger.o
diff --git a/drivers/power/supply/e31x-charger.c b/drivers/power/supply/e31x-charger.c
new file mode 100644
index 000000000000..f154482bf95e
--- /dev/null
+++ b/drivers/power/supply/e31x-charger.c
@@ -0,0 +1,190 @@ 
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Copyright (c) 2018 National Instruments Corp
+ * Author: Virendra Kakade <virendra.kakade@ni.com>
+ *
+ * Ettus Research E31x charger driver
+ */
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/of_device.h>
+#include <linux/platform_device.h>
+#include <linux/mfd/syscon.h>
+#include <linux/mutex.h>
+#include <linux/regmap.h>
+#include <linux/string.h>
+#include <linux/slab.h>
+#include <linux/power_supply.h>
+#include <linux/delay.h>
+#include <linux/mfd/e31x-pmu.h>
+
+#define E31X_PMU_CHARGER_HEALTH_MASK		GENMASK(1, 0)
+#define E31X_PMU_CHARGER_HEALTH_SHIFT		0
+#define E31X_PMU_CHARGER_CHARGE_TYPE_MASK	GENMASK(4, 3)
+#define E31X_PMU_CHARGER_CHARGE_TYPE_SHIFT	3
+
+struct e31x_charger_dev {
+	struct regmap *regmap;
+	struct power_supply *supply;
+};
+
+static int e31x_charger_get_health(struct e31x_charger_dev *charger,
+				   union power_supply_propval *val)
+{
+	u32 value;
+	int err;
+
+	err = regmap_read(charger->regmap, E31X_PMU_REG_CHARGER, &value);
+	if (err)
+		return err;
+
+	value = E31X_PMU_GET_FIELD(CHARGER_HEALTH, value);
+	switch (value) {
+	case 0x0:
+		val->intval = POWER_SUPPLY_HEALTH_GOOD;
+		break;
+	case 0x1:
+		val->intval = POWER_SUPPLY_HEALTH_UNSPEC_FAILURE;
+		break;
+	case 0x2:
+		val->intval = POWER_SUPPLY_HEALTH_OVERVOLTAGE;
+		break;
+	case 0x3:
+		val->intval = POWER_SUPPLY_HEALTH_OVERHEAT;
+		break;
+	default:
+		val->intval = POWER_SUPPLY_HEALTH_UNKNOWN;
+		break;
+	};
+
+	return 0;
+}
+
+static int e31x_charger_get_type(struct e31x_charger_dev *charger,
+				 union power_supply_propval *val)
+{
+	u32 value;
+	int err;
+
+	err = regmap_read(charger->regmap, E31X_PMU_REG_CHARGER, &value);
+	if (err)
+		return err;
+
+	value = E31X_PMU_GET_FIELD(CHARGER_CHARGE_TYPE, value);
+	switch (value) {
+	case 0x0:
+		val->intval = POWER_SUPPLY_CHARGE_TYPE_NONE;
+		break;
+	case 0x1:
+		val->intval = POWER_SUPPLY_CHARGE_TYPE_TRICKLE;
+		break;
+	case 0x2:
+		val->intval = POWER_SUPPLY_CHARGE_TYPE_FAST;
+		break;
+	default:
+		val->intval = POWER_SUPPLY_CHARGE_TYPE_NONE;
+		break;
+	};
+	return 0;
+}
+
+static int e31x_charger_get_online(struct e31x_charger_dev *charger,
+				   union power_supply_propval *val)
+{
+	u32 value;
+	int err;
+
+	err = regmap_read(charger->regmap, E31X_PMU_REG_CHARGER, &value);
+	if (err)
+		return err;
+
+	value = E31X_PMU_GET_FIELD(CHARGER_ONLINE, value);
+	val->intval = !!value;
+
+	return 0;
+}
+
+static int e31x_charger_get_property(struct power_supply *psy,
+				     enum power_supply_property psp,
+				     union power_supply_propval *val)
+{
+	struct e31x_charger_dev *charger = power_supply_get_drvdata(psy);
+	int err = -EINVAL;
+
+	switch (psp) {
+	case POWER_SUPPLY_PROP_HEALTH:
+		return e31x_charger_get_health(charger, val);
+	case POWER_SUPPLY_PROP_CHARGE_TYPE:
+		return e31x_charger_get_type(charger, val);
+	case POWER_SUPPLY_PROP_ONLINE:
+		return e31x_charger_get_online(charger, val);
+	case POWER_SUPPLY_PROP_SCOPE:
+		val->intval = POWER_SUPPLY_SCOPE_SYSTEM;
+		return 0;
+	default:
+		break;
+	}
+
+	return err;
+}
+
+static enum power_supply_property e31x_charger_properties[] = {
+	POWER_SUPPLY_PROP_HEALTH,
+	POWER_SUPPLY_PROP_CHARGE_TYPE,
+	POWER_SUPPLY_PROP_ONLINE,
+	POWER_SUPPLY_PROP_SCOPE,
+};
+
+static const struct power_supply_desc e31x_charger_desc = {
+	.name = "e31x-charger",
+	.type = POWER_SUPPLY_TYPE_MAINS,
+	.properties = e31x_charger_properties,
+	.num_properties = ARRAY_SIZE(e31x_charger_properties),
+	.get_property = e31x_charger_get_property,
+};
+
+static const struct of_device_id e31x_charger_id[] = {
+	{ .compatible = "ni,e31x-charger" },
+	{ },
+};
+
+static int e31x_charger_probe(struct platform_device *pdev)
+{
+	struct power_supply_config psy_cfg = {};
+	struct e31x_charger_dev *charger;
+
+	if (!of_device_is_available(pdev->dev.of_node))
+		return -ENODEV;
+
+	charger = devm_kzalloc(&pdev->dev, sizeof(*charger), GFP_KERNEL);
+	if (!charger)
+		return -ENOMEM;
+
+	charger->regmap = syscon_regmap_lookup_by_phandle(\
+			pdev->dev.parent->of_node, "regmap");
+
+	psy_cfg.of_node = pdev->dev.of_node;
+	psy_cfg.drv_data = charger;
+
+	charger->supply = devm_power_supply_register(&pdev->dev,
+						     &e31x_charger_desc,
+						     &psy_cfg);
+
+	if (IS_ERR(charger->supply))
+		return PTR_ERR(charger->supply);
+	return 0;
+}
+
+static struct platform_driver e31x_charger_driver = {
+	.driver = {
+		.name = "e31x-charger",
+		.of_match_table = e31x_charger_id,
+	},
+	.probe = e31x_charger_probe,
+};
+module_platform_driver(e31x_charger_driver);
+
+MODULE_AUTHOR("Virendra Kakade <virendra.kakade@ni.com>");
+MODULE_DESCRIPTION("E31x charger driver");
+MODULE_LICENSE("GPL");
diff --git a/include/linux/mfd/e31x-pmu.h b/include/linux/mfd/e31x-pmu.h
index c57d5a8c1aad..e0649845fe4d 100644
--- a/include/linux/mfd/e31x-pmu.h
+++ b/include/linux/mfd/e31x-pmu.h
@@ -12,9 +12,13 @@ 
 #include <linux/bitops.h>
 
 #define E31X_PMU_REG_MISC      0x04
+#define E31X_PMU_REG_CHARGER   0x0c
 
 #define E31X_PMU_GET_FIELD(name, reg) \
 	(((reg) & E31X_PMU_## name ##_MASK) >> \
 	E31X_PMU_## name ##_SHIFT)
 
+#define E31X_PMU_CHARGER_ONLINE_MASK	BIT(2)
+#define E31X_PMU_CHARGER_ONLINE_SHIFT	2
+
 #endif /* MFD_E31X_PMU_H */