[deliverable/linux.git] / drivers / misc / lis3lv02d / lis3lv02d_i2c.c

/*
 * drivers/hwmon/lis3lv02d_i2c.c
 *
 * Implements I2C interface for lis3lv02d (STMicroelectronics) accelerometer.
 * Driver is based on corresponding SPI driver written by Daniel Mack
 * (lis3lv02d_spi.c (C) 2009 Daniel Mack <daniel@caiaq.de> ).
 *
 * Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
 *
 * Contact: Samu Onkalo <samu.p.onkalo@nokia.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.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/err.h>
#include <linux/i2c.h>
#include <linux/pm_runtime.h>
#include <linux/delay.h>
#include "lis3lv02d.h"

#define DRV_NAME	"lis3lv02d_i2c"

static const char reg_vdd[]    = "Vdd";
static const char reg_vdd_io[] = "Vdd_IO";

static int lis3_reg_ctrl(struct lis3lv02d *lis3, bool state)
{
	int ret;
	if (state == LIS3_REG_OFF) {
		ret = regulator_bulk_disable(ARRAY_SIZE(lis3->regulators),
					lis3->regulators);
	} else {
		ret = regulator_bulk_enable(ARRAY_SIZE(lis3->regulators),
					lis3->regulators);
		/* Chip needs time to wakeup. Not mentioned in datasheet */
		usleep_range(10000, 20000);
	}
	return ret;
}

static inline s32 lis3_i2c_write(struct lis3lv02d *lis3, int reg, u8 value)
{
	struct i2c_client *c = lis3->bus_priv;
	return i2c_smbus_write_byte_data(c, reg, value);
}

static inline s32 lis3_i2c_read(struct lis3lv02d *lis3, int reg, u8 *v)
{
	struct i2c_client *c = lis3->bus_priv;
	*v = i2c_smbus_read_byte_data(c, reg);
	return 0;
}

static inline s32 lis3_i2c_blockread(struct lis3lv02d *lis3, int reg, int len,
				u8 *v)
{
	struct i2c_client *c = lis3->bus_priv;
	reg |= (1 << 7); /* 7th bit enables address auto incrementation */
	return i2c_smbus_read_i2c_block_data(c, reg, len, v);
}

static int lis3_i2c_init(struct lis3lv02d *lis3)
{
	u8 reg;
	int ret;

	lis3_reg_ctrl(lis3, LIS3_REG_ON);

	lis3->read(lis3, WHO_AM_I, &reg);
	if (reg != lis3->whoami)
		printk(KERN_ERR "lis3: power on failure\n");

	/* power up the device */
	ret = lis3->read(lis3, CTRL_REG1, &reg);
	if (ret < 0)
		return ret;

	if (lis3->whoami == WAI_3DLH)
		reg |= CTRL1_PM0 | CTRL1_Xen | CTRL1_Yen | CTRL1_Zen;
	else
		reg |= CTRL1_PD0 | CTRL1_Xen | CTRL1_Yen | CTRL1_Zen;

	return lis3->write(lis3, CTRL_REG1, reg);
}

/* Default axis mapping but it can be overwritten by platform data */
static union axis_conversion lis3lv02d_axis_map =
	{ .as_array = { LIS3_DEV_X, LIS3_DEV_Y, LIS3_DEV_Z } };

static int __devinit lis3lv02d_i2c_probe(struct i2c_client *client,
					const struct i2c_device_id *id)
{
	int ret = 0;
	struct lis3lv02d_platform_data *pdata = client->dev.platform_data;

	if (pdata) {
		if ((pdata->driver_features & LIS3_USE_BLOCK_READ) &&
			(i2c_check_functionality(client->adapter,
						I2C_FUNC_SMBUS_I2C_BLOCK)))
			lis3_dev.blkread  = lis3_i2c_blockread;

		if (pdata->axis_x)
			lis3lv02d_axis_map.x = pdata->axis_x;

		if (pdata->axis_y)
			lis3lv02d_axis_map.y = pdata->axis_y;

		if (pdata->axis_z)
			lis3lv02d_axis_map.z = pdata->axis_z;

		if (pdata->setup_resources)
			ret = pdata->setup_resources();

		if (ret)
			goto fail;
	}

	lis3_dev.regulators[0].supply = reg_vdd;
	lis3_dev.regulators[1].supply = reg_vdd_io;
	ret = regulator_bulk_get(&client->dev,
				 ARRAY_SIZE(lis3_dev.regulators),
				 lis3_dev.regulators);
	if (ret < 0)
		goto fail;

	lis3_dev.pdata	  = pdata;
	lis3_dev.bus_priv = client;
	lis3_dev.init	  = lis3_i2c_init;
	lis3_dev.read	  = lis3_i2c_read;
	lis3_dev.write	  = lis3_i2c_write;
	lis3_dev.irq	  = client->irq;
	lis3_dev.ac	  = lis3lv02d_axis_map;
	lis3_dev.pm_dev	  = &client->dev;

	i2c_set_clientdata(client, &lis3_dev);

	/* Provide power over the init call */
	lis3_reg_ctrl(&lis3_dev, LIS3_REG_ON);

	ret = lis3lv02d_init_device(&lis3_dev);

	lis3_reg_ctrl(&lis3_dev, LIS3_REG_OFF);

	if (ret)
		goto fail2;
	return 0;

fail2:
	regulator_bulk_free(ARRAY_SIZE(lis3_dev.regulators),
				lis3_dev.regulators);
fail:
	if (pdata && pdata->release_resources)
		pdata->release_resources();
	return ret;
}

static int __devexit lis3lv02d_i2c_remove(struct i2c_client *client)
{
	struct lis3lv02d *lis3 = i2c_get_clientdata(client);
	struct lis3lv02d_platform_data *pdata = client->dev.platform_data;

	if (pdata && pdata->release_resources)
		pdata->release_resources();

	lis3lv02d_joystick_disable(lis3);
	lis3lv02d_remove_fs(&lis3_dev);

	regulator_bulk_free(ARRAY_SIZE(lis3->regulators),
			    lis3_dev.regulators);
	return 0;
}

#ifdef CONFIG_PM_SLEEP
static int lis3lv02d_i2c_suspend(struct device *dev)
{
	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
	struct lis3lv02d *lis3 = i2c_get_clientdata(client);

	if (!lis3->pdata || !lis3->pdata->wakeup_flags)
		lis3lv02d_poweroff(lis3);
	return 0;
}

static int lis3lv02d_i2c_resume(struct device *dev)
{
	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
	struct lis3lv02d *lis3 = i2c_get_clientdata(client);

	/*
	 * pm_runtime documentation says that devices should always
	 * be powered on at resume. Pm_runtime turns them off after system
	 * wide resume is complete.
	 */
	if (!lis3->pdata || !lis3->pdata->wakeup_flags ||
		pm_runtime_suspended(dev))
		lis3lv02d_poweron(lis3);

	return 0;
}
#endif /* CONFIG_PM_SLEEP */

#ifdef CONFIG_PM_RUNTIME
static int lis3_i2c_runtime_suspend(struct device *dev)
{
	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
	struct lis3lv02d *lis3 = i2c_get_clientdata(client);

	lis3lv02d_poweroff(lis3);
	return 0;
}

static int lis3_i2c_runtime_resume(struct device *dev)
{
	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
	struct lis3lv02d *lis3 = i2c_get_clientdata(client);

	lis3lv02d_poweron(lis3);
	return 0;
}
#endif /* CONFIG_PM_RUNTIME */

static const struct i2c_device_id lis3lv02d_id[] = {
	{"lis3lv02d", 0 },
	{"lis331dlh", LIS331DLH},
	{}
};

MODULE_DEVICE_TABLE(i2c, lis3lv02d_id);

static const struct dev_pm_ops lis3_pm_ops = {
	SET_SYSTEM_SLEEP_PM_OPS(lis3lv02d_i2c_suspend,
				lis3lv02d_i2c_resume)
	SET_RUNTIME_PM_OPS(lis3_i2c_runtime_suspend,
			   lis3_i2c_runtime_resume,
			   NULL)
};

static struct i2c_driver lis3lv02d_i2c_driver = {
	.driver	 = {
		.name   = DRV_NAME,
		.owner  = THIS_MODULE,
		.pm     = &lis3_pm_ops,
	},
	.probe	= lis3lv02d_i2c_probe,
	.remove	= __devexit_p(lis3lv02d_i2c_remove),
	.id_table = lis3lv02d_id,
};

module_i2c_driver(lis3lv02d_i2c_driver);

MODULE_AUTHOR("Nokia Corporation");
MODULE_DESCRIPTION("lis3lv02d I2C interface");
MODULE_LICENSE("GPL");
Commit	Line	Data
312ea07b SO	1	/*
	2	* drivers/hwmon/lis3lv02d_i2c.c
	3	*
	4	* Implements I2C interface for lis3lv02d (STMicroelectronics) accelerometer.
	5	* Driver is based on corresponding SPI driver written by Daniel Mack
	6	* (lis3lv02d_spi.c (C) 2009 Daniel Mack <daniel@caiaq.de> ).
	7	*
	8	* Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
	9	*
	10	* Contact: Samu Onkalo <samu.p.onkalo@nokia.com>
	11	*
	12	* This program is free software; you can redistribute it and/or
	13	* modify it under the terms of the GNU General Public License
	14	* version 2 as published by the Free Software Foundation.
	15	*
	16	* This program is distributed in the hope that it will be useful, but
	17	* WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	19	* General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU General Public License
	22	* along with this program; if not, write to the Free Software
	23	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
	24	* 02110-1301 USA
	25	*/
	26
	27	#include <linux/module.h>
	28	#include <linux/kernel.h>
	29	#include <linux/init.h>
	30	#include <linux/err.h>
	31	#include <linux/i2c.h>
2a346996	32	#include <linux/pm_runtime.h>
f9deb41f	33	#include <linux/delay.h>
312ea07b SO	34	#include "lis3lv02d.h"
312ea07b SO	35
ff606677	36	#define DRV_NAME "lis3lv02d_i2c"
312ea07b	37
f9deb41f SO	38	static const char reg_vdd[] = "Vdd";
	39	static const char reg_vdd_io[] = "Vdd_IO";
	40
	41	static int lis3_reg_ctrl(struct lis3lv02d *lis3, bool state)
	42	{
	43	int ret;
	44	if (state == LIS3_REG_OFF) {
	45	ret = regulator_bulk_disable(ARRAY_SIZE(lis3->regulators),
	46	lis3->regulators);
	47	} else {
	48	ret = regulator_bulk_enable(ARRAY_SIZE(lis3->regulators),
	49	lis3->regulators);
	50	/* Chip needs time to wakeup. Not mentioned in datasheet */
	51	usleep_range(10000, 20000);
	52	}
	53	return ret;
	54	}
	55
312ea07b SO	56	static inline s32 lis3_i2c_write(struct lis3lv02d *lis3, int reg, u8 value)
	57	{
	58	struct i2c_client *c = lis3->bus_priv;
	59	return i2c_smbus_write_byte_data(c, reg, value);
	60	}
	61
	62	static inline s32 lis3_i2c_read(struct lis3lv02d lis3, int reg, u8 v)
	63	{
	64	struct i2c_client *c = lis3->bus_priv;
	65	*v = i2c_smbus_read_byte_data(c, reg);
	66	return 0;
	67	}
	68
f10a5407 SO	69	static inline s32 lis3_i2c_blockread(struct lis3lv02d *lis3, int reg, int len,
	70	u8 *v)
	71	{
	72	struct i2c_client *c = lis3->bus_priv;
	73	reg \|= (1 << 7); /* 7th bit enables address auto incrementation */
	74	return i2c_smbus_read_i2c_block_data(c, reg, len, v);
	75	}
	76
312ea07b SO	77	static int lis3_i2c_init(struct lis3lv02d *lis3)
	78	{
	79	u8 reg;
	80	int ret;
	81
ec400c9f	82	lis3_reg_ctrl(lis3, LIS3_REG_ON);
f9deb41f SO	83
	84	lis3->read(lis3, WHO_AM_I, &reg);
	85	if (reg != lis3->whoami)
	86	printk(KERN_ERR "lis3: power on failure\n");
	87
312ea07b SO	88	/* power up the device */
	89	ret = lis3->read(lis3, CTRL_REG1, &reg);
	90	if (ret < 0)
	91	return ret;
	92
0bf5a8be AC	93	if (lis3->whoami == WAI_3DLH)
	94	reg \|= CTRL1_PM0 \| CTRL1_Xen \| CTRL1_Yen \| CTRL1_Zen;
	95	else
	96	reg \|= CTRL1_PD0 \| CTRL1_Xen \| CTRL1_Yen \| CTRL1_Zen;
	97
312ea07b SO	98	return lis3->write(lis3, CTRL_REG1, reg);
	99	}
	100
	101	/* Default axis mapping but it can be overwritten by platform data */
2ee32144 TI	102	static union axis_conversion lis3lv02d_axis_map =
2ee32144 TI	103	{ .as_array = { LIS3_DEV_X, LIS3_DEV_Y, LIS3_DEV_Z } };
312ea07b SO	104
	105	static int __devinit lis3lv02d_i2c_probe(struct i2c_client *client,
	106	const struct i2c_device_id *id)
	107	{
	108	int ret = 0;
	109	struct lis3lv02d_platform_data *pdata = client->dev.platform_data;
	110
	111	if (pdata) {
f10a5407 SO	112	if ((pdata->driver_features & LIS3_USE_BLOCK_READ) &&
	113	(i2c_check_functionality(client->adapter,
	114	I2C_FUNC_SMBUS_I2C_BLOCK)))
	115	lis3_dev.blkread = lis3_i2c_blockread;
	116
312ea07b SO	117	if (pdata->axis_x)
	118	lis3lv02d_axis_map.x = pdata->axis_x;
	119
	120	if (pdata->axis_y)
	121	lis3lv02d_axis_map.y = pdata->axis_y;
	122
	123	if (pdata->axis_z)
	124	lis3lv02d_axis_map.z = pdata->axis_z;
	125
	126	if (pdata->setup_resources)
	127	ret = pdata->setup_resources();
	128
	129	if (ret)
	130	goto fail;
	131	}
	132
ec400c9f MB	133	lis3_dev.regulators[0].supply = reg_vdd;
	134	lis3_dev.regulators[1].supply = reg_vdd_io;
	135	ret = regulator_bulk_get(&client->dev,
	136	ARRAY_SIZE(lis3_dev.regulators),
	137	lis3_dev.regulators);
	138	if (ret < 0)
	139	goto fail;
f9deb41f	140
312ea07b SO	141	lis3_dev.pdata = pdata;
	142	lis3_dev.bus_priv = client;
	143	lis3_dev.init = lis3_i2c_init;
	144	lis3_dev.read = lis3_i2c_read;
	145	lis3_dev.write = lis3_i2c_write;
	146	lis3_dev.irq = client->irq;
	147	lis3_dev.ac = lis3lv02d_axis_map;
2a346996	148	lis3_dev.pm_dev = &client->dev;
312ea07b SO	149
312ea07b SO	150	i2c_set_clientdata(client, &lis3_dev);
f9deb41f SO	151
f9deb41f SO	152	/* Provide power over the init call */
ec400c9f	153	lis3_reg_ctrl(&lis3_dev, LIS3_REG_ON);
f9deb41f	154
312ea07b	155	ret = lis3lv02d_init_device(&lis3_dev);
f9deb41f	156
ec400c9f	157	lis3_reg_ctrl(&lis3_dev, LIS3_REG_OFF);
b11e7b3f	158
0021586b ÉP	159	if (ret)
	160	goto fail2;
	161	return 0;
	162
	163	fail2:
	164	regulator_bulk_free(ARRAY_SIZE(lis3_dev.regulators),
	165	lis3_dev.regulators);
312ea07b	166	fail:
b11e7b3f SO	167	if (pdata && pdata->release_resources)
b11e7b3f SO	168	pdata->release_resources();
312ea07b SO	169	return ret;
	170	}
	171
	172	static int __devexit lis3lv02d_i2c_remove(struct i2c_client *client)
	173	{
f9deb41f	174	struct lis3lv02d *lis3 = i2c_get_clientdata(client);
312ea07b SO	175	struct lis3lv02d_platform_data *pdata = client->dev.platform_data;
	176
	177	if (pdata && pdata->release_resources)
	178	pdata->release_resources();
	179
e1e5687d	180	lis3lv02d_joystick_disable(lis3);
f9deb41f	181	lis3lv02d_remove_fs(&lis3_dev);
312ea07b	182
ec400c9f MB	183	regulator_bulk_free(ARRAY_SIZE(lis3->regulators),
ec400c9f MB	184	lis3_dev.regulators);
f9deb41f	185	return 0;
312ea07b SO	186	}
312ea07b SO	187
32292f49	188	#ifdef CONFIG_PM_SLEEP
2a346996	189	static int lis3lv02d_i2c_suspend(struct device *dev)
312ea07b	190	{
2a346996	191	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
312ea07b SO	192	struct lis3lv02d *lis3 = i2c_get_clientdata(client);
312ea07b SO	193
5facb097	194	if (!lis3->pdata \|\| !lis3->pdata->wakeup_flags)
312ea07b SO	195	lis3lv02d_poweroff(lis3);
	196	return 0;
	197	}
	198
2a346996	199	static int lis3lv02d_i2c_resume(struct device *dev)
312ea07b	200	{
2a346996	201	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
312ea07b SO	202	struct lis3lv02d *lis3 = i2c_get_clientdata(client);
312ea07b SO	203
2a346996 SO	204	/*
	205	* pm_runtime documentation says that devices should always
	206	* be powered on at resume. Pm_runtime turns them off after system
	207	* wide resume is complete.
	208	*/
	209	if (!lis3->pdata \|\| !lis3->pdata->wakeup_flags \|\|
	210	pm_runtime_suspended(dev))
312ea07b	211	lis3lv02d_poweron(lis3);
312ea07b	212
2a346996	213	return 0;
312ea07b	214	}
32292f49	215	#endif /* CONFIG_PM_SLEEP */
312ea07b	216
32292f49	217	#ifdef CONFIG_PM_RUNTIME
2a346996 SO	218	static int lis3_i2c_runtime_suspend(struct device *dev)
	219	{
	220	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
	221	struct lis3lv02d *lis3 = i2c_get_clientdata(client);
	222
	223	lis3lv02d_poweroff(lis3);
	224	return 0;
	225	}
	226
	227	static int lis3_i2c_runtime_resume(struct device *dev)
	228	{
	229	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
	230	struct lis3lv02d *lis3 = i2c_get_clientdata(client);
	231
	232	lis3lv02d_poweron(lis3);
	233	return 0;
	234	}
32292f49	235	#endif /* CONFIG_PM_RUNTIME */
2a346996	236
312ea07b SO	237	static const struct i2c_device_id lis3lv02d_id[] = {
312ea07b SO	238	{"lis3lv02d", 0 },
0bf5a8be	239	{"lis331dlh", LIS331DLH},
312ea07b SO	240	{}
	241	};
	242
	243	MODULE_DEVICE_TABLE(i2c, lis3lv02d_id);
	244
2a346996 SO	245	static const struct dev_pm_ops lis3_pm_ops = {
	246	SET_SYSTEM_SLEEP_PM_OPS(lis3lv02d_i2c_suspend,
	247	lis3lv02d_i2c_resume)
	248	SET_RUNTIME_PM_OPS(lis3_i2c_runtime_suspend,
	249	lis3_i2c_runtime_resume,
	250	NULL)
	251	};
	252
312ea07b SO	253	static struct i2c_driver lis3lv02d_i2c_driver = {
	254	.driver = {
	255	.name = DRV_NAME,
	256	.owner = THIS_MODULE,
2a346996	257	.pm = &lis3_pm_ops,
312ea07b	258	},
312ea07b SO	259	.probe = lis3lv02d_i2c_probe,
	260	.remove = __devexit_p(lis3lv02d_i2c_remove),
	261	.id_table = lis3lv02d_id,
	262	};
	263
a64fe2ed	264	module_i2c_driver(lis3lv02d_i2c_driver);
312ea07b SO	265
	266	MODULE_AUTHOR("Nokia Corporation");
	267	MODULE_DESCRIPTION("lis3lv02d I2C interface");
	268	MODULE_LICENSE("GPL");