[mirror_ubuntu-zesty-kernel.git] / drivers / power / max17040_battery.c

/*
 *  max17040_battery.c
 *  fuel-gauge systems for lithium-ion (Li+) batteries
 *
 *  Copyright (C) 2009 Samsung Electronics
 *  Minkyu Kang <mk7.kang@samsung.com>
 *
 * 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/module.h>
#include <linux/init.h>
#include <linux/platform_device.h>
#include <linux/mutex.h>
#include <linux/err.h>
#include <linux/i2c.h>
#include <linux/delay.h>
#include <linux/power_supply.h>
#include <linux/max17040_battery.h>
#include <linux/slab.h>

#define MAX17040_VCELL_MSB	0x02
#define MAX17040_VCELL_LSB	0x03
#define MAX17040_SOC_MSB	0x04
#define MAX17040_SOC_LSB	0x05
#define MAX17040_MODE_MSB	0x06
#define MAX17040_MODE_LSB	0x07
#define MAX17040_VER_MSB	0x08
#define MAX17040_VER_LSB	0x09
#define MAX17040_RCOMP_MSB	0x0C
#define MAX17040_RCOMP_LSB	0x0D
#define MAX17040_CMD_MSB	0xFE
#define MAX17040_CMD_LSB	0xFF

#define MAX17040_DELAY		1000
#define MAX17040_BATTERY_FULL	95

struct max17040_chip {
	struct i2c_client		*client;
	struct delayed_work		work;
	struct power_supply		battery;
	struct max17040_platform_data	*pdata;

	/* State Of Connect */
	int online;
	/* battery voltage */
	int vcell;
	/* battery capacity */
	int soc;
	/* State Of Charge */
	int status;
};

static int max17040_get_property(struct power_supply *psy,
			    enum power_supply_property psp,
			    union power_supply_propval *val)
{
	struct max17040_chip *chip = container_of(psy,
				struct max17040_chip, battery);

	switch (psp) {
	case POWER_SUPPLY_PROP_STATUS:
		val->intval = chip->status;
		break;
	case POWER_SUPPLY_PROP_ONLINE:
		val->intval = chip->online;
		break;
	case POWER_SUPPLY_PROP_VOLTAGE_NOW:
		val->intval = chip->vcell;
		break;
	case POWER_SUPPLY_PROP_CAPACITY:
		val->intval = chip->soc;
		break;
	default:
		return -EINVAL;
	}
	return 0;
}

static int max17040_write_reg(struct i2c_client *client, int reg, u8 value)
{
	int ret;

	ret = i2c_smbus_write_byte_data(client, reg, value);

	if (ret < 0)
		dev_err(&client->dev, "%s: err %d\n", __func__, ret);

	return ret;
}

static int max17040_read_reg(struct i2c_client *client, int reg)
{
	int ret;

	ret = i2c_smbus_read_byte_data(client, reg);

	if (ret < 0)
		dev_err(&client->dev, "%s: err %d\n", __func__, ret);

	return ret;
}

static void max17040_reset(struct i2c_client *client)
{
	max17040_write_reg(client, MAX17040_CMD_MSB, 0x54);
	max17040_write_reg(client, MAX17040_CMD_LSB, 0x00);
}

static void max17040_get_vcell(struct i2c_client *client)
{
	struct max17040_chip *chip = i2c_get_clientdata(client);
	u8 msb;
	u8 lsb;

	msb = max17040_read_reg(client, MAX17040_VCELL_MSB);
	lsb = max17040_read_reg(client, MAX17040_VCELL_LSB);

	chip->vcell = (msb << 4) + (lsb >> 4);
}

static void max17040_get_soc(struct i2c_client *client)
{
	struct max17040_chip *chip = i2c_get_clientdata(client);
	u8 msb;
	u8 lsb;

	msb = max17040_read_reg(client, MAX17040_SOC_MSB);
	lsb = max17040_read_reg(client, MAX17040_SOC_LSB);

	chip->soc = msb;
}

static void max17040_get_version(struct i2c_client *client)
{
	u8 msb;
	u8 lsb;

	msb = max17040_read_reg(client, MAX17040_VER_MSB);
	lsb = max17040_read_reg(client, MAX17040_VER_LSB);

	dev_info(&client->dev, "MAX17040 Fuel-Gauge Ver %d%d\n", msb, lsb);
}

static void max17040_get_online(struct i2c_client *client)
{
	struct max17040_chip *chip = i2c_get_clientdata(client);

	if (chip->pdata && chip->pdata->battery_online)
		chip->online = chip->pdata->battery_online();
	else
		chip->online = 1;
}

static void max17040_get_status(struct i2c_client *client)
{
	struct max17040_chip *chip = i2c_get_clientdata(client);

	if (!chip->pdata || !chip->pdata->charger_online
			|| !chip->pdata->charger_enable) {
		chip->status = POWER_SUPPLY_STATUS_UNKNOWN;
		return;
	}

	if (chip->pdata->charger_online()) {
		if (chip->pdata->charger_enable())
			chip->status = POWER_SUPPLY_STATUS_CHARGING;
		else
			chip->status = POWER_SUPPLY_STATUS_NOT_CHARGING;
	} else {
		chip->status = POWER_SUPPLY_STATUS_DISCHARGING;
	}

	if (chip->soc > MAX17040_BATTERY_FULL)
		chip->status = POWER_SUPPLY_STATUS_FULL;
}

static void max17040_work(struct work_struct *work)
{
	struct max17040_chip *chip;

	chip = container_of(work, struct max17040_chip, work.work);

	max17040_get_vcell(chip->client);
	max17040_get_soc(chip->client);
	max17040_get_online(chip->client);
	max17040_get_status(chip->client);

	queue_delayed_work(system_power_efficient_wq, &chip->work,
			   MAX17040_DELAY);
}

static enum power_supply_property max17040_battery_props[] = {
	POWER_SUPPLY_PROP_STATUS,
	POWER_SUPPLY_PROP_ONLINE,
	POWER_SUPPLY_PROP_VOLTAGE_NOW,
	POWER_SUPPLY_PROP_CAPACITY,
};

static int max17040_probe(struct i2c_client *client,
			const struct i2c_device_id *id)
{
	struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
	struct max17040_chip *chip;
	int ret;

	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE))
		return -EIO;

	chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
	if (!chip)
		return -ENOMEM;

	chip->client = client;
	chip->pdata = client->dev.platform_data;

	i2c_set_clientdata(client, chip);

	chip->battery.name		= "battery";
	chip->battery.type		= POWER_SUPPLY_TYPE_BATTERY;
	chip->battery.get_property	= max17040_get_property;
	chip->battery.properties	= max17040_battery_props;
	chip->battery.num_properties	= ARRAY_SIZE(max17040_battery_props);

	ret = power_supply_register(&client->dev, &chip->battery, NULL);
	if (ret) {
		dev_err(&client->dev, "failed: power supply register\n");
		return ret;
	}

	max17040_reset(client);
	max17040_get_version(client);

	INIT_DEFERRABLE_WORK(&chip->work, max17040_work);
	queue_delayed_work(system_power_efficient_wq, &chip->work,
			   MAX17040_DELAY);

	return 0;
}

static int max17040_remove(struct i2c_client *client)
{
	struct max17040_chip *chip = i2c_get_clientdata(client);

	power_supply_unregister(&chip->battery);
	cancel_delayed_work(&chip->work);
	return 0;
}

#ifdef CONFIG_PM_SLEEP

static int max17040_suspend(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct max17040_chip *chip = i2c_get_clientdata(client);

	cancel_delayed_work(&chip->work);
	return 0;
}

static int max17040_resume(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct max17040_chip *chip = i2c_get_clientdata(client);

	queue_delayed_work(system_power_efficient_wq, &chip->work,
			   MAX17040_DELAY);
	return 0;
}

static SIMPLE_DEV_PM_OPS(max17040_pm_ops, max17040_suspend, max17040_resume);
#define MAX17040_PM_OPS (&max17040_pm_ops)

#else

#define MAX17040_PM_OPS NULL

#endif /* CONFIG_PM_SLEEP */

static const struct i2c_device_id max17040_id[] = {
	{ "max17040" },
	{ "max77836-battery" },
	{ }
};
MODULE_DEVICE_TABLE(i2c, max17040_id);

static struct i2c_driver max17040_i2c_driver = {
	.driver	= {
		.name	= "max17040",
		.pm	= MAX17040_PM_OPS,
	},
	.probe		= max17040_probe,
	.remove		= max17040_remove,
	.id_table	= max17040_id,
};
module_i2c_driver(max17040_i2c_driver);

MODULE_AUTHOR("Minkyu Kang <mk7.kang@samsung.com>");
MODULE_DESCRIPTION("MAX17040 Fuel Gauge");
MODULE_LICENSE("GPL");
Commit	Line	Data
c6f4a42d MK	1	/*
	2	* max17040_battery.c
	3	* fuel-gauge systems for lithium-ion (Li+) batteries
	4	*
	5	* Copyright (C) 2009 Samsung Electronics
	6	* Minkyu Kang <mk7.kang@samsung.com>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License version 2 as
	10	* published by the Free Software Foundation.
	11	*/
	12
	13	#include <linux/module.h>
	14	#include <linux/init.h>
	15	#include <linux/platform_device.h>
	16	#include <linux/mutex.h>
	17	#include <linux/err.h>
	18	#include <linux/i2c.h>
	19	#include <linux/delay.h>
	20	#include <linux/power_supply.h>
	21	#include <linux/max17040_battery.h>
5a0e3ad6	22	#include <linux/slab.h>
c6f4a42d MK	23
	24	#define MAX17040_VCELL_MSB 0x02
	25	#define MAX17040_VCELL_LSB 0x03
	26	#define MAX17040_SOC_MSB 0x04
	27	#define MAX17040_SOC_LSB 0x05
	28	#define MAX17040_MODE_MSB 0x06
	29	#define MAX17040_MODE_LSB 0x07
	30	#define MAX17040_VER_MSB 0x08
	31	#define MAX17040_VER_LSB 0x09
	32	#define MAX17040_RCOMP_MSB 0x0C
	33	#define MAX17040_RCOMP_LSB 0x0D
	34	#define MAX17040_CMD_MSB 0xFE
	35	#define MAX17040_CMD_LSB 0xFF
	36
	37	#define MAX17040_DELAY 1000
	38	#define MAX17040_BATTERY_FULL 95
	39
	40	struct max17040_chip {
	41	struct i2c_client *client;
	42	struct delayed_work work;
	43	struct power_supply battery;
	44	struct max17040_platform_data *pdata;
	45
	46	/* State Of Connect */
	47	int online;
	48	/* battery voltage */
	49	int vcell;
	50	/* battery capacity */
	51	int soc;
	52	/* State Of Charge */
	53	int status;
	54	};
	55
	56	static int max17040_get_property(struct power_supply *psy,
	57	enum power_supply_property psp,
	58	union power_supply_propval *val)
	59	{
	60	struct max17040_chip *chip = container_of(psy,
	61	struct max17040_chip, battery);
	62
	63	switch (psp) {
	64	case POWER_SUPPLY_PROP_STATUS:
	65	val->intval = chip->status;
	66	break;
	67	case POWER_SUPPLY_PROP_ONLINE:
	68	val->intval = chip->online;
	69	break;
	70	case POWER_SUPPLY_PROP_VOLTAGE_NOW:
	71	val->intval = chip->vcell;
	72	break;
	73	case POWER_SUPPLY_PROP_CAPACITY:
	74	val->intval = chip->soc;
	75	break;
	76	default:
	77	return -EINVAL;
	78	}
	79	return 0;
	80	}
	81
	82	static int max17040_write_reg(struct i2c_client *client, int reg, u8 value)
	83	{
	84	int ret;
	85
	86	ret = i2c_smbus_write_byte_data(client, reg, value);
87
88	if (ret < 0)
89	dev_err(&client->dev, "%s: err %d\n", __func__, ret);
90
91	return ret;
92	}
93
94	static int max17040_read_reg(struct i2c_client *client, int reg)
95	{
96	int ret;
97
98	ret = i2c_smbus_read_byte_data(client, reg);
99
100	if (ret < 0)
101	dev_err(&client->dev, "%s: err %d\n", __func__, ret);
102
103	return ret;
104	}
105
106	static void max17040_reset(struct i2c_client *client)
107	{
108	max17040_write_reg(client, MAX17040_CMD_MSB, 0x54);
109	max17040_write_reg(client, MAX17040_CMD_LSB, 0x00);
110	}
111
112	static void max17040_get_vcell(struct i2c_client *client)
113	{
114	struct max17040_chip *chip = i2c_get_clientdata(client);
115	u8 msb;
116	u8 lsb;
117
118	msb = max17040_read_reg(client, MAX17040_VCELL_MSB);
119	lsb = max17040_read_reg(client, MAX17040_VCELL_LSB);
120
121	chip->vcell = (msb << 4) + (lsb >> 4);
122	}
123
124	static void max17040_get_soc(struct i2c_client *client)
125	{
126	struct max17040_chip *chip = i2c_get_clientdata(client);
127	u8 msb;
128	u8 lsb;
129
130	msb = max17040_read_reg(client, MAX17040_SOC_MSB);
131	lsb = max17040_read_reg(client, MAX17040_SOC_LSB);
132
133	chip->soc = msb;
134	}
135
136	static void max17040_get_version(struct i2c_client *client)
137	{
138	u8 msb;
139	u8 lsb;
140
141	msb = max17040_read_reg(client, MAX17040_VER_MSB);
142	lsb = max17040_read_reg(client, MAX17040_VER_LSB);
143
144	dev_info(&client->dev, "MAX17040 Fuel-Gauge Ver %d%d\n", msb, lsb);
145	}
146
147	static void max17040_get_online(struct i2c_client *client)
148	{
149	struct max17040_chip *chip = i2c_get_clientdata(client);
150
ac323d8d	151	if (chip->pdata && chip->pdata->battery_online)
c6f4a42d MK	152	chip->online = chip->pdata->battery_online();
	153	else
	154	chip->online = 1;
	155	}
	156
	157	static void max17040_get_status(struct i2c_client *client)
	158	{
	159	struct max17040_chip *chip = i2c_get_clientdata(client);
	160
ac323d8d KK	161	if (!chip->pdata \|\| !chip->pdata->charger_online
ac323d8d KK	162	\|\| !chip->pdata->charger_enable) {
c6f4a42d MK	163	chip->status = POWER_SUPPLY_STATUS_UNKNOWN;
	164	return;
	165	}
	166
	167	if (chip->pdata->charger_online()) {
	168	if (chip->pdata->charger_enable())
	169	chip->status = POWER_SUPPLY_STATUS_CHARGING;
	170	else
	171	chip->status = POWER_SUPPLY_STATUS_NOT_CHARGING;
	172	} else {
	173	chip->status = POWER_SUPPLY_STATUS_DISCHARGING;
	174	}
	175
	176	if (chip->soc > MAX17040_BATTERY_FULL)
	177	chip->status = POWER_SUPPLY_STATUS_FULL;
	178	}
	179
	180	static void max17040_work(struct work_struct *work)
	181	{
	182	struct max17040_chip *chip;
	183
	184	chip = container_of(work, struct max17040_chip, work.work);
	185
	186	max17040_get_vcell(chip->client);
	187	max17040_get_soc(chip->client);
	188	max17040_get_online(chip->client);
	189	max17040_get_status(chip->client);
	190
52fa74ee KK	191	queue_delayed_work(system_power_efficient_wq, &chip->work,
52fa74ee KK	192	MAX17040_DELAY);
c6f4a42d MK	193	}
	194
	195	static enum power_supply_property max17040_battery_props[] = {
	196	POWER_SUPPLY_PROP_STATUS,
	197	POWER_SUPPLY_PROP_ONLINE,
	198	POWER_SUPPLY_PROP_VOLTAGE_NOW,
	199	POWER_SUPPLY_PROP_CAPACITY,
	200	};
	201
c8afa640	202	static int max17040_probe(struct i2c_client *client,
c6f4a42d MK	203	const struct i2c_device_id *id)
	204	{
	205	struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
	206	struct max17040_chip *chip;
	207	int ret;
	208
	209	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE))
	210	return -EIO;
	211
00edfc65	212	chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
c6f4a42d MK	213	if (!chip)
	214	return -ENOMEM;
	215
	216	chip->client = client;
	217	chip->pdata = client->dev.platform_data;
	218
	219	i2c_set_clientdata(client, chip);
	220
	221	chip->battery.name = "battery";
	222	chip->battery.type = POWER_SUPPLY_TYPE_BATTERY;
	223	chip->battery.get_property = max17040_get_property;
	224	chip->battery.properties = max17040_battery_props;
	225	chip->battery.num_properties = ARRAY_SIZE(max17040_battery_props);
	226
2dc9215d	227	ret = power_supply_register(&client->dev, &chip->battery, NULL);
c6f4a42d MK	228	if (ret) {
c6f4a42d MK	229	dev_err(&client->dev, "failed: power supply register\n");
c6f4a42d MK	230	return ret;
	231	}
	232
	233	max17040_reset(client);
	234	max17040_get_version(client);
	235
203b42f7	236	INIT_DEFERRABLE_WORK(&chip->work, max17040_work);
52fa74ee KK	237	queue_delayed_work(system_power_efficient_wq, &chip->work,
52fa74ee KK	238	MAX17040_DELAY);
c6f4a42d MK	239
	240	return 0;
	241	}
	242
415ec69f	243	static int max17040_remove(struct i2c_client *client)
c6f4a42d MK	244	{
	245	struct max17040_chip *chip = i2c_get_clientdata(client);
	246
	247	power_supply_unregister(&chip->battery);
	248	cancel_delayed_work(&chip->work);
c6f4a42d MK	249	return 0;
	250	}
	251
43cf454a	252	#ifdef CONFIG_PM_SLEEP
c6f4a42d	253
43cf454a	254	static int max17040_suspend(struct device *dev)
c6f4a42d	255	{
43cf454a	256	struct i2c_client *client = to_i2c_client(dev);
c6f4a42d MK	257	struct max17040_chip *chip = i2c_get_clientdata(client);
	258
	259	cancel_delayed_work(&chip->work);
	260	return 0;
	261	}
	262
43cf454a	263	static int max17040_resume(struct device *dev)
c6f4a42d	264	{
43cf454a	265	struct i2c_client *client = to_i2c_client(dev);
c6f4a42d MK	266	struct max17040_chip *chip = i2c_get_clientdata(client);
c6f4a42d MK	267
52fa74ee KK	268	queue_delayed_work(system_power_efficient_wq, &chip->work,
52fa74ee KK	269	MAX17040_DELAY);
c6f4a42d MK	270	return 0;
	271	}
	272
43cf454a LPC	273	static SIMPLE_DEV_PM_OPS(max17040_pm_ops, max17040_suspend, max17040_resume);
	274	#define MAX17040_PM_OPS (&max17040_pm_ops)
	275
c6f4a42d MK	276	#else
c6f4a42d MK	277
43cf454a	278	#define MAX17040_PM_OPS NULL
c6f4a42d	279
43cf454a	280	#endif /* CONFIG_PM_SLEEP */
c6f4a42d MK	281
c6f4a42d MK	282	static const struct i2c_device_id max17040_id[] = {
2c33e929 KK	283	{ "max17040" },
2c33e929 KK	284	{ "max77836-battery" },
c6f4a42d MK	285	{ }
	286	};
	287	MODULE_DEVICE_TABLE(i2c, max17040_id);
	288
	289	static struct i2c_driver max17040_i2c_driver = {
	290	.driver = {
	291	.name = "max17040",
43cf454a	292	.pm = MAX17040_PM_OPS,
c6f4a42d MK	293	},
c6f4a42d MK	294	.probe = max17040_probe,
28ea73f4	295	.remove = max17040_remove,
c6f4a42d MK	296	.id_table = max17040_id,
c6f4a42d MK	297	};
5ff92e7a	298	module_i2c_driver(max17040_i2c_driver);
c6f4a42d MK	299
	300	MODULE_AUTHOR("Minkyu Kang <mk7.kang@samsung.com>");
	301	MODULE_DESCRIPTION("MAX17040 Fuel Gauge");
	302	MODULE_LICENSE("GPL");