[deliverable/linux.git] / drivers / hwmon / ads1015.c

/*
 * ads1015.c - lm_sensors driver for ads1015 12-bit 4-input ADC
 * (C) Copyright 2010
 * Dirk Eibach, Guntermann & Drunck GmbH <eibach@gdsys.de>
 *
 * Based on the ads7828 driver by Steve Hardy.
 *
 * Datasheet available at: http://focus.ti.com/lit/ds/symlink/ads1015.pdf
 *
 * 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; either version 2 of the License, or
 * (at your option) any later version.
 *
 * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

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

#include <linux/i2c/ads1015.h>

/* ADS1015 registers */
enum {
	ADS1015_CONVERSION = 0,
	ADS1015_CONFIG = 1,
};

/* PGA fullscale voltages in mV */
static const unsigned int fullscale_table[8] = {
	6144, 4096, 2048, 1024, 512, 256, 256, 256 };

/* Data rates in samples per second */
static const unsigned int data_rate_table[8] = {
	128, 250, 490, 920, 1600, 2400, 3300, 3300 };

#define ADS1015_DEFAULT_CHANNELS 0xff
#define ADS1015_DEFAULT_PGA 2
#define ADS1015_DEFAULT_DATA_RATE 4

struct ads1015_data {
	struct device *hwmon_dev;
	struct mutex update_lock; /* mutex protect updates */
	struct ads1015_channel_data channel_data[ADS1015_CHANNELS];
};

static int ads1015_read_adc(struct i2c_client *client, unsigned int channel)
{
	u16 config;
	struct ads1015_data *data = i2c_get_clientdata(client);
	unsigned int pga = data->channel_data[channel].pga;
	unsigned int data_rate = data->channel_data[channel].data_rate;
	unsigned int conversion_time_ms;
	int res;

	mutex_lock(&data->update_lock);

	/* get channel parameters */
	res = i2c_smbus_read_word_swapped(client, ADS1015_CONFIG);
	if (res < 0)
		goto err_unlock;
	config = res;
	conversion_time_ms = DIV_ROUND_UP(1000, data_rate_table[data_rate]);

	/* setup and start single conversion */
	config &= 0x001f;
	config |= (1 << 15) | (1 << 8);
	config |= (channel & 0x0007) << 12;
	config |= (pga & 0x0007) << 9;
	config |= (data_rate & 0x0007) << 5;

	res = i2c_smbus_write_word_swapped(client, ADS1015_CONFIG, config);
	if (res < 0)
		goto err_unlock;

	/* wait until conversion finished */
	msleep(conversion_time_ms);
	res = i2c_smbus_read_word_swapped(client, ADS1015_CONFIG);
	if (res < 0)
		goto err_unlock;
	config = res;
	if (!(config & (1 << 15))) {
		/* conversion not finished in time */
		res = -EIO;
		goto err_unlock;
	}

	res = i2c_smbus_read_word_swapped(client, ADS1015_CONVERSION);

err_unlock:
	mutex_unlock(&data->update_lock);
	return res;
}

static int ads1015_reg_to_mv(struct i2c_client *client, unsigned int channel,
			     s16 reg)
{
	struct ads1015_data *data = i2c_get_clientdata(client);
	unsigned int pga = data->channel_data[channel].pga;
	int fullscale = fullscale_table[pga];

	return DIV_ROUND_CLOSEST(reg * fullscale, 0x7ff0);
}

/* sysfs callback function */
static ssize_t show_in(struct device *dev, struct device_attribute *da,
	char *buf)
{
	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
	struct i2c_client *client = to_i2c_client(dev);
	int res;
	int index = attr->index;

	res = ads1015_read_adc(client, index);
	if (res < 0)
		return res;

	return sprintf(buf, "%d\n", ads1015_reg_to_mv(client, index, res));
}

static const struct sensor_device_attribute ads1015_in[] = {
	SENSOR_ATTR(in0_input, S_IRUGO, show_in, NULL, 0),
	SENSOR_ATTR(in1_input, S_IRUGO, show_in, NULL, 1),
	SENSOR_ATTR(in2_input, S_IRUGO, show_in, NULL, 2),
	SENSOR_ATTR(in3_input, S_IRUGO, show_in, NULL, 3),
	SENSOR_ATTR(in4_input, S_IRUGO, show_in, NULL, 4),
	SENSOR_ATTR(in5_input, S_IRUGO, show_in, NULL, 5),
	SENSOR_ATTR(in6_input, S_IRUGO, show_in, NULL, 6),
	SENSOR_ATTR(in7_input, S_IRUGO, show_in, NULL, 7),
};

/*
 * Driver interface
 */

static int ads1015_remove(struct i2c_client *client)
{
	struct ads1015_data *data = i2c_get_clientdata(client);
	int k;

	hwmon_device_unregister(data->hwmon_dev);
	for (k = 0; k < ADS1015_CHANNELS; ++k)
		device_remove_file(&client->dev, &ads1015_in[k].dev_attr);
	kfree(data);
	return 0;
}

#ifdef CONFIG_OF
static int ads1015_get_channels_config_of(struct i2c_client *client)
{
	struct ads1015_data *data = i2c_get_clientdata(client);
	struct device_node *node;

	if (!client->dev.of_node
	    || !of_get_next_child(client->dev.of_node, NULL))
		return -EINVAL;

	for_each_child_of_node(client->dev.of_node, node) {
		const __be32 *property;
		int len;
		unsigned int channel;
		unsigned int pga = ADS1015_DEFAULT_PGA;
		unsigned int data_rate = ADS1015_DEFAULT_DATA_RATE;

		property = of_get_property(node, "reg", &len);
		if (!property || len != sizeof(int)) {
			dev_err(&client->dev, "invalid reg on %s\n",
				node->full_name);
			continue;
		}

		channel = be32_to_cpup(property);
		if (channel > ADS1015_CHANNELS) {
			dev_err(&client->dev,
				"invalid channel index %d on %s\n",
				channel, node->full_name);
			continue;
		}

		property = of_get_property(node, "ti,gain", &len);
		if (property && len == sizeof(int)) {
			pga = be32_to_cpup(property);
			if (pga > 6) {
				dev_err(&client->dev,
					"invalid gain on %s\n",
					node->full_name);
			}
		}

		property = of_get_property(node, "ti,datarate", &len);
		if (property && len == sizeof(int)) {
			data_rate = be32_to_cpup(property);
			if (data_rate > 7) {
				dev_err(&client->dev,
					"invalid data_rate on %s\n",
					node->full_name);
			}
		}

		data->channel_data[channel].enabled = true;
		data->channel_data[channel].pga = pga;
		data->channel_data[channel].data_rate = data_rate;
	}

	return 0;
}
#endif

static void ads1015_get_channels_config(struct i2c_client *client)
{
	unsigned int k;
	struct ads1015_data *data = i2c_get_clientdata(client);
	struct ads1015_platform_data *pdata = dev_get_platdata(&client->dev);

	/* prefer platform data */
	if (pdata) {
		memcpy(data->channel_data, pdata->channel_data,
		       sizeof(data->channel_data));
		return;
	}

#ifdef CONFIG_OF
	if (!ads1015_get_channels_config_of(client))
		return;
#endif

	/* fallback on default configuration */
	for (k = 0; k < ADS1015_CHANNELS; ++k) {
		data->channel_data[k].enabled = true;
		data->channel_data[k].pga = ADS1015_DEFAULT_PGA;
		data->channel_data[k].data_rate = ADS1015_DEFAULT_DATA_RATE;
	}
}

static int ads1015_probe(struct i2c_client *client,
			 const struct i2c_device_id *id)
{
	struct ads1015_data *data;
	int err;
	unsigned int k;

	data = kzalloc(sizeof(struct ads1015_data), GFP_KERNEL);
	if (!data) {
		err = -ENOMEM;
		goto exit;
	}

	i2c_set_clientdata(client, data);
	mutex_init(&data->update_lock);

	/* build sysfs attribute group */
	ads1015_get_channels_config(client);
	for (k = 0; k < ADS1015_CHANNELS; ++k) {
		if (!data->channel_data[k].enabled)
			continue;
		err = device_create_file(&client->dev, &ads1015_in[k].dev_attr);
		if (err)
			goto exit_remove;
	}

	data->hwmon_dev = hwmon_device_register(&client->dev);
	if (IS_ERR(data->hwmon_dev)) {
		err = PTR_ERR(data->hwmon_dev);
		goto exit_remove;
	}

	return 0;

exit_remove:
	for (k = 0; k < ADS1015_CHANNELS; ++k)
		device_remove_file(&client->dev, &ads1015_in[k].dev_attr);
	kfree(data);
exit:
	return err;
}

static const struct i2c_device_id ads1015_id[] = {
	{ "ads1015", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, ads1015_id);

static struct i2c_driver ads1015_driver = {
	.driver = {
		.name = "ads1015",
	},
	.probe = ads1015_probe,
	.remove = ads1015_remove,
	.id_table = ads1015_id,
};

module_i2c_driver(ads1015_driver);

MODULE_AUTHOR("Dirk Eibach <eibach@gdsys.de>");
MODULE_DESCRIPTION("ADS1015 driver");
MODULE_LICENSE("GPL");
Commit	Line	Data
8c22a8f5 DE	1	/*
	2	* ads1015.c - lm_sensors driver for ads1015 12-bit 4-input ADC
	3	* (C) Copyright 2010
	4	* Dirk Eibach, Guntermann & Drunck GmbH <eibach@gdsys.de>
	5	*
	6	* Based on the ads7828 driver by Steve Hardy.
	7	*
	8	* Datasheet available at: http://focus.ti.com/lit/ds/symlink/ads1015.pdf
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of the GNU General Public License as published by
	12	* the Free Software Foundation; either version 2 of the License, or
	13	* (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	18	* GNU General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public License
	21	* along with this program; if not, write to the Free Software
	22	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	23	*/
	24
	25	#include <linux/module.h>
	26	#include <linux/init.h>
	27	#include <linux/slab.h>
	28	#include <linux/delay.h>
	29	#include <linux/i2c.h>
	30	#include <linux/hwmon.h>
	31	#include <linux/hwmon-sysfs.h>
	32	#include <linux/err.h>
	33	#include <linux/mutex.h>
	34	#include <linux/of.h>
	35
	36	#include <linux/i2c/ads1015.h>
	37
	38	/* ADS1015 registers */
	39	enum {
	40	ADS1015_CONVERSION = 0,
	41	ADS1015_CONFIG = 1,
	42	};
	43
	44	/* PGA fullscale voltages in mV */
	45	static const unsigned int fullscale_table[8] = {
	46	6144, 4096, 2048, 1024, 512, 256, 256, 256 };
	47
c0046867 DE	48	/* Data rates in samples per second */
	49	static const unsigned int data_rate_table[8] = {
	50	128, 250, 490, 920, 1600, 2400, 3300, 3300 };
	51
8c22a8f5	52	#define ADS1015_DEFAULT_CHANNELS 0xff
c0046867 DE	53	#define ADS1015_DEFAULT_PGA 2
c0046867 DE	54	#define ADS1015_DEFAULT_DATA_RATE 4
8c22a8f5 DE	55
	56	struct ads1015_data {
	57	struct device *hwmon_dev;
	58	struct mutex update_lock; /* mutex protect updates */
c0046867	59	struct ads1015_channel_data channel_data[ADS1015_CHANNELS];
8c22a8f5 DE	60	};
8c22a8f5 DE	61
1196573f	62	static int ads1015_read_adc(struct i2c_client *client, unsigned int channel)
8c22a8f5 DE	63	{
8c22a8f5 DE	64	u16 config;
8c22a8f5	65	struct ads1015_data *data = i2c_get_clientdata(client);
c0046867	66	unsigned int pga = data->channel_data[channel].pga;
c0046867 DE	67	unsigned int data_rate = data->channel_data[channel].data_rate;
c0046867 DE	68	unsigned int conversion_time_ms;
8c22a8f5 DE	69	int res;
	70
	71	mutex_lock(&data->update_lock);
	72
c0046867	73	/* get channel parameters */
90f4102c	74	res = i2c_smbus_read_word_swapped(client, ADS1015_CONFIG);
8c22a8f5 DE	75	if (res < 0)
	76	goto err_unlock;
	77	config = res;
c0046867	78	conversion_time_ms = DIV_ROUND_UP(1000, data_rate_table[data_rate]);
8c22a8f5	79
c0046867 DE	80	/* setup and start single conversion */
	81	config &= 0x001f;
	82	config \|= (1 << 15) \| (1 << 8);
	83	config \|= (channel & 0x0007) << 12;
	84	config \|= (pga & 0x0007) << 9;
	85	config \|= (data_rate & 0x0007) << 5;
8c22a8f5	86
90f4102c	87	res = i2c_smbus_write_word_swapped(client, ADS1015_CONFIG, config);
8c22a8f5 DE	88	if (res < 0)
8c22a8f5 DE	89	goto err_unlock;
c0046867 DE	90
	91	/* wait until conversion finished */
	92	msleep(conversion_time_ms);
90f4102c	93	res = i2c_smbus_read_word_swapped(client, ADS1015_CONFIG);
c0046867 DE	94	if (res < 0)
	95	goto err_unlock;
	96	config = res;
	97	if (!(config & (1 << 15))) {
	98	/* conversion not finished in time */
8c22a8f5 DE	99	res = -EIO;
	100	goto err_unlock;
	101	}
	102
90f4102c	103	res = i2c_smbus_read_word_swapped(client, ADS1015_CONVERSION);
8c22a8f5 DE	104
	105	err_unlock:
	106	mutex_unlock(&data->update_lock);
	107	return res;
	108	}
	109
1196573f GR	110	static int ads1015_reg_to_mv(struct i2c_client *client, unsigned int channel,
	111	s16 reg)
	112	{
	113	struct ads1015_data *data = i2c_get_clientdata(client);
	114	unsigned int pga = data->channel_data[channel].pga;
	115	int fullscale = fullscale_table[pga];
	116
	117	return DIV_ROUND_CLOSEST(reg * fullscale, 0x7ff0);
	118	}
	119
8c22a8f5 DE	120	/* sysfs callback function */
	121	static ssize_t show_in(struct device dev, struct device_attribute da,
	122	char *buf)
	123	{
	124	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
	125	struct i2c_client *client = to_i2c_client(dev);
8c22a8f5	126	int res;
1196573f	127	int index = attr->index;
8c22a8f5	128
1196573f GR	129	res = ads1015_read_adc(client, index);
	130	if (res < 0)
	131	return res;
8c22a8f5	132
1196573f	133	return sprintf(buf, "%d\n", ads1015_reg_to_mv(client, index, res));
8c22a8f5 DE	134	}
8c22a8f5 DE	135
fdf241a8 JD	136	static const struct sensor_device_attribute ads1015_in[] = {
	137	SENSOR_ATTR(in0_input, S_IRUGO, show_in, NULL, 0),
	138	SENSOR_ATTR(in1_input, S_IRUGO, show_in, NULL, 1),
	139	SENSOR_ATTR(in2_input, S_IRUGO, show_in, NULL, 2),
	140	SENSOR_ATTR(in3_input, S_IRUGO, show_in, NULL, 3),
	141	SENSOR_ATTR(in4_input, S_IRUGO, show_in, NULL, 4),
	142	SENSOR_ATTR(in5_input, S_IRUGO, show_in, NULL, 5),
	143	SENSOR_ATTR(in6_input, S_IRUGO, show_in, NULL, 6),
	144	SENSOR_ATTR(in7_input, S_IRUGO, show_in, NULL, 7),
8c22a8f5 DE	145	};
	146
	147	/*
	148	* Driver interface
	149	*/
	150
	151	static int ads1015_remove(struct i2c_client *client)
	152	{
	153	struct ads1015_data *data = i2c_get_clientdata(client);
fdf241a8 JD	154	int k;
fdf241a8 JD	155
8c22a8f5	156	hwmon_device_unregister(data->hwmon_dev);
c0046867	157	for (k = 0; k < ADS1015_CHANNELS; ++k)
fdf241a8	158	device_remove_file(&client->dev, &ads1015_in[k].dev_attr);
8c22a8f5 DE	159	kfree(data);
	160	return 0;
	161	}
	162
8c22a8f5	163	#ifdef CONFIG_OF
c0046867 DE	164	static int ads1015_get_channels_config_of(struct i2c_client *client)
	165	{
	166	struct ads1015_data *data = i2c_get_clientdata(client);
	167	struct device_node *node;
	168
	169	if (!client->dev.of_node
	170	\|\| !of_get_next_child(client->dev.of_node, NULL))
	171	return -EINVAL;
	172
	173	for_each_child_of_node(client->dev.of_node, node) {
	174	const __be32 *property;
	175	int len;
	176	unsigned int channel;
	177	unsigned int pga = ADS1015_DEFAULT_PGA;
	178	unsigned int data_rate = ADS1015_DEFAULT_DATA_RATE;
	179
	180	property = of_get_property(node, "reg", &len);
	181	if (!property \|\| len != sizeof(int)) {
	182	dev_err(&client->dev, "invalid reg on %s\n",
	183	node->full_name);
	184	continue;
	185	}
	186
	187	channel = be32_to_cpup(property);
	188	if (channel > ADS1015_CHANNELS) {
	189	dev_err(&client->dev,
	190	"invalid channel index %d on %s\n",
	191	channel, node->full_name);
	192	continue;
	193	}
	194
	195	property = of_get_property(node, "ti,gain", &len);
	196	if (property && len == sizeof(int)) {
	197	pga = be32_to_cpup(property);
	198	if (pga > 6) {
	199	dev_err(&client->dev,
	200	"invalid gain on %s\n",
	201	node->full_name);
	202	}
	203	}
	204
	205	property = of_get_property(node, "ti,datarate", &len);
	206	if (property && len == sizeof(int)) {
	207	data_rate = be32_to_cpup(property);
	208	if (data_rate > 7) {
	209	dev_err(&client->dev,
	210	"invalid data_rate on %s\n",
	211	node->full_name);
	212	}
	213	}
	214
	215	data->channel_data[channel].enabled = true;
	216	data->channel_data[channel].pga = pga;
	217	data->channel_data[channel].data_rate = data_rate;
	218	}
	219
	220	return 0;
	221	}
8c22a8f5 DE	222	#endif
8c22a8f5 DE	223
c0046867 DE	224	static void ads1015_get_channels_config(struct i2c_client *client)
	225	{
	226	unsigned int k;
	227	struct ads1015_data *data = i2c_get_clientdata(client);
	228	struct ads1015_platform_data *pdata = dev_get_platdata(&client->dev);
	229
8c22a8f5	230	/* prefer platform data */
c0046867 DE	231	if (pdata) {
	232	memcpy(data->channel_data, pdata->channel_data,
	233	sizeof(data->channel_data));
	234	return;
	235	}
8c22a8f5 DE	236
8c22a8f5 DE	237	#ifdef CONFIG_OF
c0046867 DE	238	if (!ads1015_get_channels_config_of(client))
c0046867 DE	239	return;
8c22a8f5 DE	240	#endif
	241
	242	/* fallback on default configuration */
c0046867 DE	243	for (k = 0; k < ADS1015_CHANNELS; ++k) {
	244	data->channel_data[k].enabled = true;
	245	data->channel_data[k].pga = ADS1015_DEFAULT_PGA;
	246	data->channel_data[k].data_rate = ADS1015_DEFAULT_DATA_RATE;
	247	}
8c22a8f5 DE	248	}
	249
	250	static int ads1015_probe(struct i2c_client *client,
	251	const struct i2c_device_id *id)
	252	{
	253	struct ads1015_data *data;
	254	int err;
8c22a8f5	255	unsigned int k;
8c22a8f5 DE	256
	257	data = kzalloc(sizeof(struct ads1015_data), GFP_KERNEL);
	258	if (!data) {
	259	err = -ENOMEM;
	260	goto exit;
	261	}
	262
	263	i2c_set_clientdata(client, data);
	264	mutex_init(&data->update_lock);
	265
	266	/* build sysfs attribute group */
c0046867 DE	267	ads1015_get_channels_config(client);
	268	for (k = 0; k < ADS1015_CHANNELS; ++k) {
	269	if (!data->channel_data[k].enabled)
8c22a8f5	270	continue;
fdf241a8 JD	271	err = device_create_file(&client->dev, &ads1015_in[k].dev_attr);
fdf241a8 JD	272	if (err)
363434b5	273	goto exit_remove;
8c22a8f5	274	}
8c22a8f5 DE	275
	276	data->hwmon_dev = hwmon_device_register(&client->dev);
	277	if (IS_ERR(data->hwmon_dev)) {
	278	err = PTR_ERR(data->hwmon_dev);
	279	goto exit_remove;
	280	}
	281
	282	return 0;
	283
	284	exit_remove:
c0046867	285	for (k = 0; k < ADS1015_CHANNELS; ++k)
fdf241a8	286	device_remove_file(&client->dev, &ads1015_in[k].dev_attr);
8c22a8f5 DE	287	kfree(data);
	288	exit:
	289	return err;
	290	}
	291
	292	static const struct i2c_device_id ads1015_id[] = {
	293	{ "ads1015", 0 },
	294	{ }
	295	};
	296	MODULE_DEVICE_TABLE(i2c, ads1015_id);
	297
	298	static struct i2c_driver ads1015_driver = {
	299	.driver = {
	300	.name = "ads1015",
	301	},
	302	.probe = ads1015_probe,
	303	.remove = ads1015_remove,
	304	.id_table = ads1015_id,
	305	};
	306
f0967eea	307	module_i2c_driver(ads1015_driver);
8c22a8f5 DE	308
	309	MODULE_AUTHOR("Dirk Eibach <eibach@gdsys.de>");
	310	MODULE_DESCRIPTION("ADS1015 driver");
	311	MODULE_LICENSE("GPL");