[mirror_ubuntu-kernels.git] / drivers / hwmon / 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 int lis3_i2c_init(struct lis3lv02d *lis3)
{
	u8 reg;
	int ret;

	if (lis3->reg_ctrl)
		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;

	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) {
		/* Regulator control is optional */
		if (pdata->driver_features & LIS3_USE_REGULATOR_CTRL)
			lis3_dev.reg_ctrl = lis3_reg_ctrl;

		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;
	}

	if (lis3_dev.reg_ctrl) {
		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 */
	if (lis3_dev.reg_ctrl)
		lis3_reg_ctrl(&lis3_dev, LIS3_REG_ON);

	ret = lis3lv02d_init_device(&lis3_dev);

	if (lis3_dev.reg_ctrl)
		lis3_reg_ctrl(&lis3_dev, LIS3_REG_OFF);
fail:
	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();
	lis3lv02d_remove_fs(&lis3_dev);

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

#ifdef CONFIG_PM
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;
}
#else
#define lis3lv02d_i2c_suspend	NULL
#define lis3lv02d_i2c_resume	NULL
#define lis3lv02d_i2c_shutdown	NULL
#endif

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;
}

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

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,
};

static int __init lis3lv02d_init(void)
{
	return i2c_add_driver(&lis3lv02d_i2c_driver);
}

static void __exit lis3lv02d_exit(void)
{
	i2c_del_driver(&lis3lv02d_i2c_driver);
}

MODULE_AUTHOR("Nokia Corporation");
MODULE_DESCRIPTION("lis3lv02d I2C interface");
MODULE_LICENSE("GPL");

module_init(lis3lv02d_init);
module_exit(lis3lv02d_exit);
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"
	35
	36	#define DRV_NAME "lis3lv02d_i2c"
	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
	69	static int lis3_i2c_init(struct lis3lv02d *lis3)
	70	{
	71	u8 reg;
	72	int ret;
	73
f9deb41f SO	74	if (lis3->reg_ctrl)
	75	lis3_reg_ctrl(lis3, LIS3_REG_ON);
	76
	77	lis3->read(lis3, WHO_AM_I, &reg);
	78	if (reg != lis3->whoami)
	79	printk(KERN_ERR "lis3: power on failure\n");
	80
312ea07b SO	81	/* power up the device */
	82	ret = lis3->read(lis3, CTRL_REG1, &reg);
	83	if (ret < 0)
	84	return ret;
	85
ed37d7f6	86	reg \|= CTRL1_PD0 \| CTRL1_Xen \| CTRL1_Yen \| CTRL1_Zen;
312ea07b SO	87	return lis3->write(lis3, CTRL_REG1, reg);
	88	}
	89
	90	/* Default axis mapping but it can be overwritten by platform data */
2ee32144 TI	91	static union axis_conversion lis3lv02d_axis_map =
2ee32144 TI	92	{ .as_array = { LIS3_DEV_X, LIS3_DEV_Y, LIS3_DEV_Z } };
312ea07b SO	93
	94	static int __devinit lis3lv02d_i2c_probe(struct i2c_client *client,
	95	const struct i2c_device_id *id)
	96	{
	97	int ret = 0;
	98	struct lis3lv02d_platform_data *pdata = client->dev.platform_data;
	99
	100	if (pdata) {
f9deb41f SO	101	/* Regulator control is optional */
	102	if (pdata->driver_features & LIS3_USE_REGULATOR_CTRL)
	103	lis3_dev.reg_ctrl = lis3_reg_ctrl;
	104
312ea07b SO	105	if (pdata->axis_x)
	106	lis3lv02d_axis_map.x = pdata->axis_x;
	107
	108	if (pdata->axis_y)
	109	lis3lv02d_axis_map.y = pdata->axis_y;
	110
	111	if (pdata->axis_z)
	112	lis3lv02d_axis_map.z = pdata->axis_z;
	113
	114	if (pdata->setup_resources)
	115	ret = pdata->setup_resources();
	116
	117	if (ret)
	118	goto fail;
	119	}
	120
f9deb41f SO	121	if (lis3_dev.reg_ctrl) {
	122	lis3_dev.regulators[0].supply = reg_vdd;
	123	lis3_dev.regulators[1].supply = reg_vdd_io;
	124	ret = regulator_bulk_get(&client->dev,
	125	ARRAY_SIZE(lis3_dev.regulators),
	126	lis3_dev.regulators);
	127	if (ret < 0)
	128	goto fail;
	129	}
	130
312ea07b SO	131	lis3_dev.pdata = pdata;
	132	lis3_dev.bus_priv = client;
	133	lis3_dev.init = lis3_i2c_init;
	134	lis3_dev.read = lis3_i2c_read;
	135	lis3_dev.write = lis3_i2c_write;
	136	lis3_dev.irq = client->irq;
	137	lis3_dev.ac = lis3lv02d_axis_map;
2a346996	138	lis3_dev.pm_dev = &client->dev;
312ea07b SO	139
312ea07b SO	140	i2c_set_clientdata(client, &lis3_dev);
f9deb41f SO	141
	142	/* Provide power over the init call */
	143	if (lis3_dev.reg_ctrl)
	144	lis3_reg_ctrl(&lis3_dev, LIS3_REG_ON);
	145
312ea07b	146	ret = lis3lv02d_init_device(&lis3_dev);
f9deb41f SO	147
	148	if (lis3_dev.reg_ctrl)
	149	lis3_reg_ctrl(&lis3_dev, LIS3_REG_OFF);
312ea07b SO	150	fail:
	151	return ret;
	152	}
	153
	154	static int __devexit lis3lv02d_i2c_remove(struct i2c_client *client)
	155	{
f9deb41f	156	struct lis3lv02d *lis3 = i2c_get_clientdata(client);
312ea07b SO	157	struct lis3lv02d_platform_data *pdata = client->dev.platform_data;
	158
	159	if (pdata && pdata->release_resources)
	160	pdata->release_resources();
	161
	162	lis3lv02d_joystick_disable();
f9deb41f	163	lis3lv02d_remove_fs(&lis3_dev);
312ea07b	164
f9deb41f SO	165	if (lis3_dev.reg_ctrl)
	166	regulator_bulk_free(ARRAY_SIZE(lis3->regulators),
	167	lis3_dev.regulators);
	168	return 0;
312ea07b SO	169	}
	170
	171	#ifdef CONFIG_PM
2a346996	172	static int lis3lv02d_i2c_suspend(struct device *dev)
312ea07b	173	{
2a346996	174	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
312ea07b SO	175	struct lis3lv02d *lis3 = i2c_get_clientdata(client);
312ea07b SO	176
5facb097	177	if (!lis3->pdata \|\| !lis3->pdata->wakeup_flags)
312ea07b SO	178	lis3lv02d_poweroff(lis3);
	179	return 0;
	180	}
	181
2a346996	182	static int lis3lv02d_i2c_resume(struct device *dev)
312ea07b	183	{
2a346996	184	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
312ea07b SO	185	struct lis3lv02d *lis3 = i2c_get_clientdata(client);
312ea07b SO	186
2a346996 SO	187	/*
	188	* pm_runtime documentation says that devices should always
	189	* be powered on at resume. Pm_runtime turns them off after system
	190	* wide resume is complete.
	191	*/
	192	if (!lis3->pdata \|\| !lis3->pdata->wakeup_flags \|\|
	193	pm_runtime_suspended(dev))
312ea07b	194	lis3lv02d_poweron(lis3);
312ea07b	195
2a346996	196	return 0;
312ea07b SO	197	}
	198	#else
	199	#define lis3lv02d_i2c_suspend NULL
	200	#define lis3lv02d_i2c_resume NULL
	201	#define lis3lv02d_i2c_shutdown NULL
	202	#endif
	203
2a346996 SO	204	static int lis3_i2c_runtime_suspend(struct device *dev)
	205	{
	206	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
	207	struct lis3lv02d *lis3 = i2c_get_clientdata(client);
	208
	209	lis3lv02d_poweroff(lis3);
	210	return 0;
	211	}
	212
	213	static int lis3_i2c_runtime_resume(struct device *dev)
	214	{
	215	struct i2c_client *client = container_of(dev, struct i2c_client, dev);
	216	struct lis3lv02d *lis3 = i2c_get_clientdata(client);
	217
	218	lis3lv02d_poweron(lis3);
	219	return 0;
	220	}
	221
312ea07b SO	222	static const struct i2c_device_id lis3lv02d_id[] = {
	223	{"lis3lv02d", 0 },
	224	{}
	225	};
	226
	227	MODULE_DEVICE_TABLE(i2c, lis3lv02d_id);
	228
2a346996 SO	229	static const struct dev_pm_ops lis3_pm_ops = {
	230	SET_SYSTEM_SLEEP_PM_OPS(lis3lv02d_i2c_suspend,
	231	lis3lv02d_i2c_resume)
	232	SET_RUNTIME_PM_OPS(lis3_i2c_runtime_suspend,
	233	lis3_i2c_runtime_resume,
	234	NULL)
	235	};
	236
312ea07b SO	237	static struct i2c_driver lis3lv02d_i2c_driver = {
	238	.driver = {
	239	.name = DRV_NAME,
	240	.owner = THIS_MODULE,
2a346996	241	.pm = &lis3_pm_ops,
312ea07b	242	},
312ea07b SO	243	.probe = lis3lv02d_i2c_probe,
	244	.remove = __devexit_p(lis3lv02d_i2c_remove),
	245	.id_table = lis3lv02d_id,
	246	};
	247
	248	static int __init lis3lv02d_init(void)
	249	{
	250	return i2c_add_driver(&lis3lv02d_i2c_driver);
	251	}
	252
	253	static void __exit lis3lv02d_exit(void)
	254	{
	255	i2c_del_driver(&lis3lv02d_i2c_driver);
	256	}
	257
	258	MODULE_AUTHOR("Nokia Corporation");
	259	MODULE_DESCRIPTION("lis3lv02d I2C interface");
	260	MODULE_LICENSE("GPL");
	261
	262	module_init(lis3lv02d_init);
	263	module_exit(lis3lv02d_exit);