[mirror_ubuntu-bionic-kernel.git] / drivers / misc / apds9802als.c

/*
 * apds9802als.c - apds9802  ALS Driver
 *
 * Copyright (C) 2009 Intel Corp
 *
 *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 *
 * 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.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/i2c.h>
#include <linux/err.h>
#include <linux/delay.h>
#include <linux/mutex.h>
#include <linux/sysfs.h>
#include <linux/pm_runtime.h>

#define ALS_MIN_RANGE_VAL 1
#define ALS_MAX_RANGE_VAL 2
#define POWER_STA_ENABLE 1
#define POWER_STA_DISABLE 0

#define DRIVER_NAME "apds9802als"

struct als_data {
	struct mutex mutex;
};

static ssize_t als_sensing_range_show(struct device *dev,
			struct device_attribute *attr,  char *buf)
{
	struct i2c_client *client = to_i2c_client(dev);
	int  val;

	val = i2c_smbus_read_byte_data(client, 0x81);
	if (val < 0)
		return val;
	if (val & 1)
		return sprintf(buf, "4095\n");
	else
		return sprintf(buf, "65535\n");
}

static int als_wait_for_data_ready(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	int ret;
	int retry = 10;

	do {
		msleep(30);
		ret = i2c_smbus_read_byte_data(client, 0x86);
	} while (!(ret & 0x80) && retry--);

	if (retry < 0) {
		dev_warn(dev, "timeout waiting for data ready\n");
		return -ETIMEDOUT;
	}

	return 0;
}

static ssize_t als_lux0_input_data_show(struct device *dev,
			struct device_attribute *attr, char *buf)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct als_data *data = i2c_get_clientdata(client);
	int ret_val;
	int temp;

	/* Protect against parallel reads */
	pm_runtime_get_sync(dev);
	mutex_lock(&data->mutex);

	/* clear EOC interrupt status */
	i2c_smbus_write_byte(client, 0x40);
	/* start measurement */
	temp = i2c_smbus_read_byte_data(client, 0x81);
	i2c_smbus_write_byte_data(client, 0x81, temp | 0x08);

	ret_val = als_wait_for_data_ready(dev);
	if (ret_val < 0)
		goto failed;

	temp = i2c_smbus_read_byte_data(client, 0x8C); /* LSB data */
	if (temp < 0) {
		ret_val = temp;
		goto failed;
	}
	ret_val = i2c_smbus_read_byte_data(client, 0x8D); /* MSB data */
	if (ret_val < 0)
		goto failed;

	mutex_unlock(&data->mutex);
	pm_runtime_put_sync(dev);

	temp = (ret_val << 8) | temp;
	return sprintf(buf, "%d\n", temp);
failed:
	mutex_unlock(&data->mutex);
	pm_runtime_put_sync(dev);
	return ret_val;
}

static ssize_t als_sensing_range_store(struct device *dev,
		struct device_attribute *attr, const  char *buf, size_t count)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct als_data *data = i2c_get_clientdata(client);
	int ret_val;
	unsigned long val;

	ret_val = kstrtoul(buf, 10, &val);
	if (ret_val)
		return ret_val;

	if (val < 4096)
		val = 1;
	else if (val < 65536)
		val = 2;
	else
		return -ERANGE;

	pm_runtime_get_sync(dev);

	/* Make sure nobody else reads/modifies/writes 0x81 while we
	   are active */
	mutex_lock(&data->mutex);

	ret_val = i2c_smbus_read_byte_data(client, 0x81);
	if (ret_val < 0)
		goto fail;

	/* Reset the bits before setting them */
	ret_val = ret_val & 0xFA;

	if (val == 1) /* Setting detection range up to 4k LUX */
		ret_val = (ret_val | 0x01);
	else /* Setting detection range up to 64k LUX*/
		ret_val = (ret_val | 0x00);

	ret_val = i2c_smbus_write_byte_data(client, 0x81, ret_val);

	if (ret_val >= 0) {
		/* All OK */
		mutex_unlock(&data->mutex);
		pm_runtime_put_sync(dev);
		return count;
	}
fail:
	mutex_unlock(&data->mutex);
	pm_runtime_put_sync(dev);
	return ret_val;
}

static int als_set_power_state(struct i2c_client *client, bool on_off)
{
	int ret_val;
	struct als_data *data = i2c_get_clientdata(client);

	mutex_lock(&data->mutex);
	ret_val = i2c_smbus_read_byte_data(client, 0x80);
	if (ret_val < 0)
		goto fail;
	if (on_off)
		ret_val = ret_val | 0x01;
	else
		ret_val = ret_val & 0xFE;
	ret_val = i2c_smbus_write_byte_data(client, 0x80, ret_val);
fail:
	mutex_unlock(&data->mutex);
	return ret_val;
}

static DEVICE_ATTR(lux0_sensor_range, S_IRUGO | S_IWUSR,
	als_sensing_range_show, als_sensing_range_store);
static DEVICE_ATTR(lux0_input, S_IRUGO, als_lux0_input_data_show, NULL);

static struct attribute *mid_att_als[] = {
	&dev_attr_lux0_sensor_range.attr,
	&dev_attr_lux0_input.attr,
	NULL
};

static struct attribute_group m_als_gr = {
	.name = "apds9802als",
	.attrs = mid_att_als
};

static int als_set_default_config(struct i2c_client *client)
{
	int ret_val;
	/* Write the command and then switch on */
	ret_val = i2c_smbus_write_byte_data(client, 0x80, 0x01);
	if (ret_val < 0) {
		dev_err(&client->dev, "failed default switch on write\n");
		return ret_val;
	}
	/* detection range: 1~64K Lux, maunal measurement */
	ret_val = i2c_smbus_write_byte_data(client, 0x81, 0x08);
	if (ret_val < 0)
		dev_err(&client->dev, "failed default LUX on write\n");

	/*  We always get 0 for the 1st measurement after system power on,
	 *  so make sure it is finished before user asks for data.
	 */
	als_wait_for_data_ready(&client->dev);

	return ret_val;
}

static int apds9802als_probe(struct i2c_client *client,
			     const struct i2c_device_id *id)
{
	int res;
	struct als_data *data;

	data = kzalloc(sizeof(struct als_data), GFP_KERNEL);
	if (data == NULL) {
		dev_err(&client->dev, "Memory allocation failed\n");
		return -ENOMEM;
	}
	i2c_set_clientdata(client, data);
	res = sysfs_create_group(&client->dev.kobj, &m_als_gr);
	if (res) {
		dev_err(&client->dev, "device create file failed\n");
		goto als_error1;
	}
	dev_info(&client->dev, "ALS chip found\n");
	als_set_default_config(client);
	mutex_init(&data->mutex);

	pm_runtime_set_active(&client->dev);
	pm_runtime_enable(&client->dev);

	return res;
als_error1:
	kfree(data);
	return res;
}

static int apds9802als_remove(struct i2c_client *client)
{
	struct als_data *data = i2c_get_clientdata(client);

	pm_runtime_get_sync(&client->dev);

	als_set_power_state(client, false);
	sysfs_remove_group(&client->dev.kobj, &m_als_gr);

	pm_runtime_disable(&client->dev);
	pm_runtime_set_suspended(&client->dev);
	pm_runtime_put_noidle(&client->dev);

	kfree(data);
	return 0;
}

#ifdef CONFIG_PM

static int apds9802als_suspend(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);

	als_set_power_state(client, false);
	return 0;
}

static int apds9802als_resume(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);

	als_set_power_state(client, true);
	return 0;
}

static UNIVERSAL_DEV_PM_OPS(apds9802als_pm_ops, apds9802als_suspend,
	apds9802als_resume, NULL);

#define APDS9802ALS_PM_OPS (&apds9802als_pm_ops)

#else	/* CONFIG_PM */
#define APDS9802ALS_PM_OPS NULL
#endif	/* CONFIG_PM */

static struct i2c_device_id apds9802als_id[] = {
	{ DRIVER_NAME, 0 },
	{ }
};

MODULE_DEVICE_TABLE(i2c, apds9802als_id);

static struct i2c_driver apds9802als_driver = {
	.driver = {
		.name = DRIVER_NAME,
		.pm = APDS9802ALS_PM_OPS,
	},
	.probe = apds9802als_probe,
	.remove = apds9802als_remove,
	.id_table = apds9802als_id,
};

module_i2c_driver(apds9802als_driver);

MODULE_AUTHOR("Anantha Narayanan <Anantha.Narayanan@intel.com");
MODULE_DESCRIPTION("Avago apds9802als ALS Driver");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
22d96aa5	1	/*
	2	* apds9802als.c - apds9802 ALS Driver
	3	*
	4	* Copyright (C) 2009 Intel Corp
	5	*
	6	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	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 as published by
	10	* the Free Software Foundation; version 2 of the License.
	11	*
	12	* This program is distributed in the hope that it will be useful, but
	13	* WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License along
	18	* with this program; if not, write to the Free Software Foundation, Inc.,
	19	* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
	20	* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	21	*
	22	*/
	23
	24	#include <linux/module.h>
	25	#include <linux/init.h>
	26	#include <linux/slab.h>
	27	#include <linux/i2c.h>
	28	#include <linux/err.h>
	29	#include <linux/delay.h>
	30	#include <linux/mutex.h>
	31	#include <linux/sysfs.h>
f0cfec11	32	#include <linux/pm_runtime.h>
22d96aa5	33
	34	#define ALS_MIN_RANGE_VAL 1
	35	#define ALS_MAX_RANGE_VAL 2
	36	#define POWER_STA_ENABLE 1
	37	#define POWER_STA_DISABLE 0
22d96aa5	38
	39	#define DRIVER_NAME "apds9802als"
	40
	41	struct als_data {
22d96aa5	42	struct mutex mutex;
	43	};
	44
	45	static ssize_t als_sensing_range_show(struct device *dev,
	46	struct device_attribute attr, char buf)
	47	{
	48	struct i2c_client *client = to_i2c_client(dev);
	49	int val;
	50
	51	val = i2c_smbus_read_byte_data(client, 0x81);
	52	if (val < 0)
	53	return val;
	54	if (val & 1)
	55	return sprintf(buf, "4095\n");
	56	else
	57	return sprintf(buf, "65535\n");
	58	}
	59
f0cfec11 HL	60	static int als_wait_for_data_ready(struct device *dev)
	61	{
	62	struct i2c_client *client = to_i2c_client(dev);
	63	int ret;
	64	int retry = 10;
	65
	66	do {
	67	msleep(30);
	68	ret = i2c_smbus_read_byte_data(client, 0x86);
	69	} while (!(ret & 0x80) && retry--);
	70
644a9d3b	71	if (retry < 0) {
f0cfec11 HL	72	dev_warn(dev, "timeout waiting for data ready\n");
	73	return -ETIMEDOUT;
	74	}
	75
	76	return 0;
	77	}
	78
22d96aa5	79	static ssize_t als_lux0_input_data_show(struct device *dev,
	80	struct device_attribute attr, char buf)
	81	{
	82	struct i2c_client *client = to_i2c_client(dev);
	83	struct als_data *data = i2c_get_clientdata(client);
f0cfec11	84	int ret_val;
22d96aa5	85	int temp;
	86
	87	/* Protect against parallel reads */
f0cfec11	88	pm_runtime_get_sync(dev);
22d96aa5	89	mutex_lock(&data->mutex);
f0cfec11 HL	90
	91	/* clear EOC interrupt status */
	92	i2c_smbus_write_byte(client, 0x40);
	93	/* start measurement */
	94	temp = i2c_smbus_read_byte_data(client, 0x81);
	95	i2c_smbus_write_byte_data(client, 0x81, temp \| 0x08);
	96
	97	ret_val = als_wait_for_data_ready(dev);
	98	if (ret_val < 0)
	99	goto failed;
	100
	101	temp = i2c_smbus_read_byte_data(client, 0x8C); /* LSB data */
22d96aa5	102	if (temp < 0) {
	103	ret_val = temp;
	104	goto failed;
	105	}
f0cfec11	106	ret_val = i2c_smbus_read_byte_data(client, 0x8D); /* MSB data */
22d96aa5	107	if (ret_val < 0)
22d96aa5	108	goto failed;
f0cfec11	109
22d96aa5	110	mutex_unlock(&data->mutex);
f0cfec11 HL	111	pm_runtime_put_sync(dev);
	112
	113	temp = (ret_val << 8) \| temp;
	114	return sprintf(buf, "%d\n", temp);
22d96aa5	115	failed:
22d96aa5	116	mutex_unlock(&data->mutex);
f0cfec11	117	pm_runtime_put_sync(dev);
22d96aa5	118	return ret_val;
	119	}
	120
	121	static ssize_t als_sensing_range_store(struct device *dev,
	122	struct device_attribute attr, const char buf, size_t count)
	123	{
	124	struct i2c_client *client = to_i2c_client(dev);
	125	struct als_data *data = i2c_get_clientdata(client);
1093736b	126	int ret_val;
22d96aa5	127	unsigned long val;
22d96aa5	128
f7b41276 JH	129	ret_val = kstrtoul(buf, 10, &val);
	130	if (ret_val)
	131	return ret_val;
22d96aa5	132
	133	if (val < 4096)
	134	val = 1;
	135	else if (val < 65536)
	136	val = 2;
	137	else
	138	return -ERANGE;
	139
f0cfec11 HL	140	pm_runtime_get_sync(dev);
f0cfec11 HL	141
22d96aa5	142	/* Make sure nobody else reads/modifies/writes 0x81 while we
22d96aa5	143	are active */
22d96aa5	144	mutex_lock(&data->mutex);
	145
	146	ret_val = i2c_smbus_read_byte_data(client, 0x81);
	147	if (ret_val < 0)
	148	goto fail;
	149
	150	/* Reset the bits before setting them */
	151	ret_val = ret_val & 0xFA;
	152
f0cfec11 HL	153	if (val == 1) /* Setting detection range up to 4k LUX */
	154	ret_val = (ret_val \| 0x01);
	155	else /* Setting detection range up to 64k LUX*/
	156	ret_val = (ret_val \| 0x00);
22d96aa5	157
22d96aa5	158	ret_val = i2c_smbus_write_byte_data(client, 0x81, ret_val);
f0cfec11	159
22d96aa5	160	if (ret_val >= 0) {
	161	/* All OK */
	162	mutex_unlock(&data->mutex);
f0cfec11	163	pm_runtime_put_sync(dev);
22d96aa5	164	return count;
	165	}
	166	fail:
	167	mutex_unlock(&data->mutex);
f0cfec11	168	pm_runtime_put_sync(dev);
22d96aa5	169	return ret_val;
	170	}
	171
22d96aa5	172	static int als_set_power_state(struct i2c_client *client, bool on_off)
	173	{
	174	int ret_val;
	175	struct als_data *data = i2c_get_clientdata(client);
	176
	177	mutex_lock(&data->mutex);
	178	ret_val = i2c_smbus_read_byte_data(client, 0x80);
	179	if (ret_val < 0)
	180	goto fail;
	181	if (on_off)
	182	ret_val = ret_val \| 0x01;
	183	else
	184	ret_val = ret_val & 0xFE;
	185	ret_val = i2c_smbus_write_byte_data(client, 0x80, ret_val);
	186	fail:
	187	mutex_unlock(&data->mutex);
	188	return ret_val;
	189	}
	190
22d96aa5	191	static DEVICE_ATTR(lux0_sensor_range, S_IRUGO \| S_IWUSR,
	192	als_sensing_range_show, als_sensing_range_store);
	193	static DEVICE_ATTR(lux0_input, S_IRUGO, als_lux0_input_data_show, NULL);
22d96aa5	194
	195	static struct attribute *mid_att_als[] = {
	196	&dev_attr_lux0_sensor_range.attr,
	197	&dev_attr_lux0_input.attr,
22d96aa5	198	NULL
	199	};
	200
	201	static struct attribute_group m_als_gr = {
	202	.name = "apds9802als",
	203	.attrs = mid_att_als
	204	};
	205
	206	static int als_set_default_config(struct i2c_client *client)
	207	{
	208	int ret_val;
	209	/* Write the command and then switch on */
	210	ret_val = i2c_smbus_write_byte_data(client, 0x80, 0x01);
	211	if (ret_val < 0) {
	212	dev_err(&client->dev, "failed default switch on write\n");
	213	return ret_val;
	214	}
f0cfec11 HL	215	/* detection range: 1~64K Lux, maunal measurement */
f0cfec11 HL	216	ret_val = i2c_smbus_write_byte_data(client, 0x81, 0x08);
22d96aa5	217	if (ret_val < 0)
22d96aa5	218	dev_err(&client->dev, "failed default LUX on write\n");
f0cfec11 HL	219
	220	/* We always get 0 for the 1st measurement after system power on,
	221	* so make sure it is finished before user asks for data.
	222	*/
	223	als_wait_for_data_ready(&client->dev);
	224
22d96aa5	225	return ret_val;
	226	}
	227
f0cfec11 HL	228	static int apds9802als_probe(struct i2c_client *client,
f0cfec11 HL	229	const struct i2c_device_id *id)
22d96aa5	230	{
	231	int res;
	232	struct als_data *data;
	233
	234	data = kzalloc(sizeof(struct als_data), GFP_KERNEL);
	235	if (data == NULL) {
	236	dev_err(&client->dev, "Memory allocation failed\n");
	237	return -ENOMEM;
	238	}
	239	i2c_set_clientdata(client, data);
	240	res = sysfs_create_group(&client->dev.kobj, &m_als_gr);
	241	if (res) {
	242	dev_err(&client->dev, "device create file failed\n");
	243	goto als_error1;
	244	}
f0cfec11	245	dev_info(&client->dev, "ALS chip found\n");
22d96aa5	246	als_set_default_config(client);
22d96aa5	247	mutex_init(&data->mutex);
f0cfec11	248
4e673599	249	pm_runtime_set_active(&client->dev);
f0cfec11	250	pm_runtime_enable(&client->dev);
f0cfec11	251
22d96aa5	252	return res;
22d96aa5	253	als_error1:
22d96aa5	254	kfree(data);
	255	return res;
	256	}
	257
486a5c28	258	static int apds9802als_remove(struct i2c_client *client)
22d96aa5	259	{
22d96aa5	260	struct als_data *data = i2c_get_clientdata(client);
f0cfec11	261
4e673599 HL	262	pm_runtime_get_sync(&client->dev);
4e673599 HL	263
f0cfec11	264	als_set_power_state(client, false);
22d96aa5	265	sysfs_remove_group(&client->dev.kobj, &m_als_gr);
4e673599 HL	266
	267	pm_runtime_disable(&client->dev);
	268	pm_runtime_set_suspended(&client->dev);
	269	pm_runtime_put_noidle(&client->dev);
	270
22d96aa5	271	kfree(data);
	272	return 0;
	273	}
	274
f0cfec11	275	#ifdef CONFIG_PM
22d96aa5	276
1c9354b0	277	static int apds9802als_suspend(struct device *dev)
f0cfec11 HL	278	{
	279	struct i2c_client *client = to_i2c_client(dev);
	280
	281	als_set_power_state(client, false);
	282	return 0;
	283	}
	284
1c9354b0	285	static int apds9802als_resume(struct device *dev)
f0cfec11 HL	286	{
	287	struct i2c_client *client = to_i2c_client(dev);
	288
	289	als_set_power_state(client, true);
	290	return 0;
	291	}
	292
1c9354b0 LPC	293	static UNIVERSAL_DEV_PM_OPS(apds9802als_pm_ops, apds9802als_suspend,
1c9354b0 LPC	294	apds9802als_resume, NULL);
f0cfec11 HL	295
	296	#define APDS9802ALS_PM_OPS (&apds9802als_pm_ops)
	297
	298	#else /* CONFIG_PM */
f0cfec11 HL	299	#define APDS9802ALS_PM_OPS NULL
	300	#endif /* CONFIG_PM */
	301
22d96aa5	302	static struct i2c_device_id apds9802als_id[] = {
	303	{ DRIVER_NAME, 0 },
	304	{ }
	305	};
	306
	307	MODULE_DEVICE_TABLE(i2c, apds9802als_id);
	308
	309	static struct i2c_driver apds9802als_driver = {
	310	.driver = {
f0cfec11 HL	311	.name = DRIVER_NAME,
f0cfec11 HL	312	.pm = APDS9802ALS_PM_OPS,
22d96aa5	313	},
22d96aa5	314	.probe = apds9802als_probe,
2d6bed9c	315	.remove = apds9802als_remove,
22d96aa5	316	.id_table = apds9802als_id,
	317	};
	318
a64fe2ed	319	module_i2c_driver(apds9802als_driver);
22d96aa5	320
	321	MODULE_AUTHOR("Anantha Narayanan <Anantha.Narayanan@intel.com");
	322	MODULE_DESCRIPTION("Avago apds9802als ALS Driver");
	323	MODULE_LICENSE("GPL v2");