[linux.git] / drivers / hwmon / tmp421.c

/* tmp421.c
 *
 * Copyright (C) 2009 Andre Prendel <[email protected]>
 * Preliminary support by:
 * Melvin Rook, Raymond Ng
 *
 * 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.
 */

/*
 * Driver for the Texas Instruments TMP421 SMBus temperature sensor IC.
 * Supported models: TMP421, TMP422, TMP423
 */

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

/* Addresses to scan */
static unsigned short normal_i2c[] = { 0x2a, 0x4c, 0x4d, 0x4e, 0x4f,
				       I2C_CLIENT_END };

/* Insmod parameters */
I2C_CLIENT_INSMOD_3(tmp421, tmp422, tmp423);

/* The TMP421 registers */
#define TMP421_CONFIG_REG_1			0x09
#define TMP421_CONVERSION_RATE_REG		0x0B
#define TMP421_MANUFACTURER_ID_REG		0xFE
#define TMP421_DEVICE_ID_REG			0xFF

static const u8 TMP421_TEMP_MSB[4]		= { 0x00, 0x01, 0x02, 0x03 };
static const u8 TMP421_TEMP_LSB[4]		= { 0x10, 0x11, 0x12, 0x13 };

/* Flags */
#define TMP421_CONFIG_SHUTDOWN			0x40
#define TMP421_CONFIG_RANGE			0x04

/* Manufacturer / Device ID's */
#define TMP421_MANUFACTURER_ID			0x55
#define TMP421_DEVICE_ID			0x21
#define TMP422_DEVICE_ID			0x22
#define TMP423_DEVICE_ID			0x23

static const struct i2c_device_id tmp421_id[] = {
	{ "tmp421", tmp421 },
	{ "tmp422", tmp422 },
	{ "tmp423", tmp423 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, tmp421_id);

struct tmp421_data {
	struct device *hwmon_dev;
	struct mutex update_lock;
	char valid;
	unsigned long last_updated;
	int kind;
	u8 config;
	s16 temp[4];
};

static int temp_from_s16(s16 reg)
{
	int temp = reg;

	return (temp * 1000 + 128) / 256;
}

static int temp_from_u16(u16 reg)
{
	int temp = reg;

	/* Add offset for extended temperature range. */
	temp -= 64 * 256;

	return (temp * 1000 + 128) / 256;
}

static struct tmp421_data *tmp421_update_device(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct tmp421_data *data = i2c_get_clientdata(client);
	int i;

	mutex_lock(&data->update_lock);

	if (time_after(jiffies, data->last_updated + 2 * HZ) || !data->valid) {
		data->config = i2c_smbus_read_byte_data(client,
			TMP421_CONFIG_REG_1);

		for (i = 0; i <= data->kind; i++) {
			data->temp[i] = i2c_smbus_read_byte_data(client,
				TMP421_TEMP_MSB[i]) << 8;
			data->temp[i] |= i2c_smbus_read_byte_data(client,
				TMP421_TEMP_LSB[i]);
		}
		data->last_updated = jiffies;
		data->valid = 1;
	}

	mutex_unlock(&data->update_lock);

	return data;
}

static ssize_t show_temp_value(struct device *dev,
			       struct device_attribute *devattr, char *buf)
{
	int index = to_sensor_dev_attr(devattr)->index;
	struct tmp421_data *data = tmp421_update_device(dev);
	int temp;

	mutex_lock(&data->update_lock);
	if (data->config & TMP421_CONFIG_RANGE)
		temp = temp_from_u16(data->temp[index]);
	else
		temp = temp_from_s16(data->temp[index]);
	mutex_unlock(&data->update_lock);

	return sprintf(buf, "%d\n", temp);
}

static ssize_t show_fault(struct device *dev,
			  struct device_attribute *devattr, char *buf)
{
	int index = to_sensor_dev_attr(devattr)->index;
	struct tmp421_data *data = tmp421_update_device(dev);

	/*
	 * The OPEN bit signals a fault. This is bit 0 of the temperature
	 * register (low byte).
	 */
	if (data->temp[index] & 0x01)
		return sprintf(buf, "1\n");
	else
		return sprintf(buf, "0\n");
}

static mode_t tmp421_is_visible(struct kobject *kobj, struct attribute *a,
				int n)
{
	struct device *dev = container_of(kobj, struct device, kobj);
	struct tmp421_data *data = dev_get_drvdata(dev);
	struct device_attribute *devattr;
	unsigned int index;

	devattr = container_of(a, struct device_attribute, attr);
	index = to_sensor_dev_attr(devattr)->index;

	if (data->kind > index)
		return a->mode;

	return 0;
}

static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp_value, NULL, 0);
static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp_value, NULL, 1);
static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_fault, NULL, 1);
static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp_value, NULL, 2);
static SENSOR_DEVICE_ATTR(temp3_fault, S_IRUGO, show_fault, NULL, 2);
static SENSOR_DEVICE_ATTR(temp4_input, S_IRUGO, show_temp_value, NULL, 3);
static SENSOR_DEVICE_ATTR(temp4_fault, S_IRUGO, show_fault, NULL, 3);

static struct attribute *tmp421_attr[] = {
	&sensor_dev_attr_temp1_input.dev_attr.attr,
	&sensor_dev_attr_temp2_input.dev_attr.attr,
	&sensor_dev_attr_temp2_fault.dev_attr.attr,
	&sensor_dev_attr_temp3_input.dev_attr.attr,
	&sensor_dev_attr_temp3_fault.dev_attr.attr,
	&sensor_dev_attr_temp4_input.dev_attr.attr,
	&sensor_dev_attr_temp4_fault.dev_attr.attr,
	NULL
};

static const struct attribute_group tmp421_group = {
	.attrs = tmp421_attr,
	.is_visible = tmp421_is_visible,
};

static int tmp421_init_client(struct i2c_client *client)
{
	int config, config_orig;

	/* Set the conversion rate to 2 Hz */
	i2c_smbus_write_byte_data(client, TMP421_CONVERSION_RATE_REG, 0x05);

	/* Start conversions (disable shutdown if necessary) */
	config = i2c_smbus_read_byte_data(client, TMP421_CONFIG_REG_1);
	if (config < 0) {
		dev_err(&client->dev, "Could not read configuration"
			 " register (%d)\n", config);
		return -ENODEV;
	}

	config_orig = config;
	config &= ~TMP421_CONFIG_SHUTDOWN;

	if (config != config_orig) {
		dev_info(&client->dev, "Enable monitoring chip\n");
		i2c_smbus_write_byte_data(client, TMP421_CONFIG_REG_1, config);
	}

	return 0;
}

static int tmp421_detect(struct i2c_client *client, int _kind,
			 struct i2c_board_info *info)
{
	enum chips kind;
	struct i2c_adapter *adapter = client->adapter;
	const char *names[] = { "TMP421", "TMP422", "TMP423" };
	u8 reg;

	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
		return -ENODEV;

	reg = i2c_smbus_read_byte_data(client, TMP421_MANUFACTURER_ID_REG);
	if (reg != TMP421_MANUFACTURER_ID)
		return -ENODEV;

	reg = i2c_smbus_read_byte_data(client, TMP421_DEVICE_ID_REG);
	switch (reg) {
	case TMP421_DEVICE_ID:
		kind = tmp421;
		break;
	case TMP422_DEVICE_ID:
		kind = tmp422;
		break;
	case TMP423_DEVICE_ID:
		kind = tmp423;
		break;
	default:
		return -ENODEV;
	}

	strlcpy(info->type, tmp421_id[kind - 1].name, I2C_NAME_SIZE);
	dev_info(&adapter->dev, "Detected TI %s chip at 0x%02x\n",
		 names[kind - 1], client->addr);

	return 0;
}

static int tmp421_probe(struct i2c_client *client,
			const struct i2c_device_id *id)
{
	struct tmp421_data *data;
	int err;

	data = kzalloc(sizeof(struct tmp421_data), GFP_KERNEL);
	if (!data)
		return -ENOMEM;

	i2c_set_clientdata(client, data);
	mutex_init(&data->update_lock);
	data->kind = id->driver_data;

	err = tmp421_init_client(client);
	if (err)
		goto exit_free;

	err = sysfs_create_group(&client->dev.kobj, &tmp421_group);
	if (err)
		goto exit_free;

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

exit_remove:
	sysfs_remove_group(&client->dev.kobj, &tmp421_group);

exit_free:
	i2c_set_clientdata(client, NULL);
	kfree(data);

	return err;
}

static int tmp421_remove(struct i2c_client *client)
{
	struct tmp421_data *data = i2c_get_clientdata(client);

	hwmon_device_unregister(data->hwmon_dev);
	sysfs_remove_group(&client->dev.kobj, &tmp421_group);

	i2c_set_clientdata(client, NULL);
	kfree(data);

	return 0;
}

static struct i2c_driver tmp421_driver = {
	.class = I2C_CLASS_HWMON,
	.driver = {
		.name	= "tmp421",
	},
	.probe = tmp421_probe,
	.remove = tmp421_remove,
	.id_table = tmp421_id,
	.detect = tmp421_detect,
	.address_data = &addr_data,
};

static int __init tmp421_init(void)
{
	return i2c_add_driver(&tmp421_driver);
}

static void __exit tmp421_exit(void)
{
	i2c_del_driver(&tmp421_driver);
}

MODULE_AUTHOR("Andre Prendel <[email protected]>");
MODULE_DESCRIPTION("Texas Instruments TMP421/422/423 temperature sensor"
		   " driver");
MODULE_LICENSE("GPL");

module_init(tmp421_init);
module_exit(tmp421_exit);
Commit	Line	Data
9410700b AP	1	/* tmp421.c
	2	*
	3	* Copyright (C) 2009 Andre Prendel <[email protected]>
	4	* Preliminary support by:
	5	* Melvin Rook, Raymond Ng
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License as published by
	9	* the Free Software Foundation; either version 2 of the License, or
	10	* (at your option) any later version.
	11	*
	12	* This program is distributed in the hope that it will be useful,
	13	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	* GNU General Public License for more details.
	16	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with this program; if not, write to the Free Software
	19	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	20	*/
	21
	22	/*
	23	* Driver for the Texas Instruments TMP421 SMBus temperature sensor IC.
	24	* Supported models: TMP421, TMP422, TMP423
	25	*/
	26
	27	#include <linux/module.h>
	28	#include <linux/init.h>
	29	#include <linux/slab.h>
	30	#include <linux/jiffies.h>
	31	#include <linux/i2c.h>
	32	#include <linux/hwmon.h>
	33	#include <linux/hwmon-sysfs.h>
	34	#include <linux/err.h>
	35	#include <linux/mutex.h>
	36	#include <linux/sysfs.h>
	37
	38	/* Addresses to scan */
	39	static unsigned short normal_i2c[] = { 0x2a, 0x4c, 0x4d, 0x4e, 0x4f,
	40	I2C_CLIENT_END };
	41
	42	/* Insmod parameters */
	43	I2C_CLIENT_INSMOD_3(tmp421, tmp422, tmp423);
	44
	45	/* The TMP421 registers */
	46	#define TMP421_CONFIG_REG_1 0x09
	47	#define TMP421_CONVERSION_RATE_REG 0x0B
	48	#define TMP421_MANUFACTURER_ID_REG 0xFE
	49	#define TMP421_DEVICE_ID_REG 0xFF
	50
	51	static const u8 TMP421_TEMP_MSB[4] = { 0x00, 0x01, 0x02, 0x03 };
	52	static const u8 TMP421_TEMP_LSB[4] = { 0x10, 0x11, 0x12, 0x13 };
	53
	54	/* Flags */
	55	#define TMP421_CONFIG_SHUTDOWN 0x40
	56	#define TMP421_CONFIG_RANGE 0x04
	57
	58	/* Manufacturer / Device ID's */
	59	#define TMP421_MANUFACTURER_ID 0x55
	60	#define TMP421_DEVICE_ID 0x21
	61	#define TMP422_DEVICE_ID 0x22
	62	#define TMP423_DEVICE_ID 0x23
	63
	64	static const struct i2c_device_id tmp421_id[] = {
65	{ "tmp421", tmp421 },
66	{ "tmp422", tmp422 },
67	{ "tmp423", tmp423 },
68	{ }
69	};
70	MODULE_DEVICE_TABLE(i2c, tmp421_id);
71
72	struct tmp421_data {
73	struct device *hwmon_dev;
74	struct mutex update_lock;
75	char valid;
76	unsigned long last_updated;
77	int kind;
78	u8 config;
79	s16 temp[4];
80	};
81
82	static int temp_from_s16(s16 reg)
83	{
84	int temp = reg;
85
86	return (temp * 1000 + 128) / 256;
87	}
88
89	static int temp_from_u16(u16 reg)
90	{
91	int temp = reg;
92
93	/* Add offset for extended temperature range. */
94	temp -= 64 * 256;
95
96	return (temp * 1000 + 128) / 256;
97	}
98
99	static struct tmp421_data tmp421_update_device(struct device dev)
100	{
101	struct i2c_client *client = to_i2c_client(dev);
102	struct tmp421_data *data = i2c_get_clientdata(client);
103	int i;
104
105	mutex_lock(&data->update_lock);
106
107	if (time_after(jiffies, data->last_updated + 2 * HZ) \|\| !data->valid) {
108	data->config = i2c_smbus_read_byte_data(client,
109	TMP421_CONFIG_REG_1);
110
111	for (i = 0; i <= data->kind; i++) {
112	data->temp[i] = i2c_smbus_read_byte_data(client,
113	TMP421_TEMP_MSB[i]) << 8;
114	data->temp[i] \|= i2c_smbus_read_byte_data(client,
115	TMP421_TEMP_LSB[i]);
116	}
117	data->last_updated = jiffies;
118	data->valid = 1;
119	}
120
121	mutex_unlock(&data->update_lock);
122
123	return data;
124	}
125
126	static ssize_t show_temp_value(struct device *dev,
127	struct device_attribute devattr, char buf)
128	{
129	int index = to_sensor_dev_attr(devattr)->index;
130	struct tmp421_data *data = tmp421_update_device(dev);
131	int temp;
132
133	mutex_lock(&data->update_lock);
134	if (data->config & TMP421_CONFIG_RANGE)
135	temp = temp_from_u16(data->temp[index]);
136	else
137	temp = temp_from_s16(data->temp[index]);
138	mutex_unlock(&data->update_lock);
139
140	return sprintf(buf, "%d\n", temp);
141	}
142
143	static ssize_t show_fault(struct device *dev,
144	struct device_attribute devattr, char buf)
145	{
146	int index = to_sensor_dev_attr(devattr)->index;
147	struct tmp421_data *data = tmp421_update_device(dev);
148
149	/*
150	* The OPEN bit signals a fault. This is bit 0 of the temperature
151	* register (low byte).
152	*/
153	if (data->temp[index] & 0x01)
154	return sprintf(buf, "1\n");
155	else
156	return sprintf(buf, "0\n");
157	}
158
159	static mode_t tmp421_is_visible(struct kobject kobj, struct attribute a,
160	int n)
161	{
162	struct device *dev = container_of(kobj, struct device, kobj);
163	struct tmp421_data *data = dev_get_drvdata(dev);
164	struct device_attribute *devattr;
165	unsigned int index;
166
167	devattr = container_of(a, struct device_attribute, attr);
168	index = to_sensor_dev_attr(devattr)->index;
169
170	if (data->kind > index)
171	return a->mode;
172
173	return 0;
174	}
175
176	static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp_value, NULL, 0);
177	static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp_value, NULL, 1);
178	static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_fault, NULL, 1);
179	static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp_value, NULL, 2);
180	static SENSOR_DEVICE_ATTR(temp3_fault, S_IRUGO, show_fault, NULL, 2);
181	static SENSOR_DEVICE_ATTR(temp4_input, S_IRUGO, show_temp_value, NULL, 3);
182	static SENSOR_DEVICE_ATTR(temp4_fault, S_IRUGO, show_fault, NULL, 3);
183
184	static struct attribute *tmp421_attr[] = {
185	&sensor_dev_attr_temp1_input.dev_attr.attr,
186	&sensor_dev_attr_temp2_input.dev_attr.attr,
187	&sensor_dev_attr_temp2_fault.dev_attr.attr,
188	&sensor_dev_attr_temp3_input.dev_attr.attr,
189	&sensor_dev_attr_temp3_fault.dev_attr.attr,
190	&sensor_dev_attr_temp4_input.dev_attr.attr,
191	&sensor_dev_attr_temp4_fault.dev_attr.attr,
192	NULL
193	};
194
195	static const struct attribute_group tmp421_group = {
196	.attrs = tmp421_attr,
197	.is_visible = tmp421_is_visible,
198	};
199
200	static int tmp421_init_client(struct i2c_client *client)
201	{
202	int config, config_orig;
203
204	/* Set the conversion rate to 2 Hz */
205	i2c_smbus_write_byte_data(client, TMP421_CONVERSION_RATE_REG, 0x05);
206
207	/* Start conversions (disable shutdown if necessary) */
208	config = i2c_smbus_read_byte_data(client, TMP421_CONFIG_REG_1);
209	if (config < 0) {
210	dev_err(&client->dev, "Could not read configuration"
211	" register (%d)\n", config);
212	return -ENODEV;
213	}
214
215	config_orig = config;
216	config &= ~TMP421_CONFIG_SHUTDOWN;
217
218	if (config != config_orig) {
219	dev_info(&client->dev, "Enable monitoring chip\n");
220	i2c_smbus_write_byte_data(client, TMP421_CONFIG_REG_1, config);
221	}
222
223	return 0;
224	}
225
dbe73c8f	226	static int tmp421_detect(struct i2c_client *client, int _kind,
9410700b AP	227	struct i2c_board_info *info)
9410700b AP	228	{
dbe73c8f	229	enum chips kind;
9410700b AP	230	struct i2c_adapter *adapter = client->adapter;
9410700b AP	231	const char *names[] = { "TMP421", "TMP422", "TMP423" };
dbe73c8f	232	u8 reg;
9410700b AP	233
	234	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
	235	return -ENODEV;
	236
dbe73c8f JD	237	reg = i2c_smbus_read_byte_data(client, TMP421_MANUFACTURER_ID_REG);
	238	if (reg != TMP421_MANUFACTURER_ID)
	239	return -ENODEV;
	240
	241	reg = i2c_smbus_read_byte_data(client, TMP421_DEVICE_ID_REG);
	242	switch (reg) {
	243	case TMP421_DEVICE_ID:
	244	kind = tmp421;
	245	break;
	246	case TMP422_DEVICE_ID:
	247	kind = tmp422;
	248	break;
	249	case TMP423_DEVICE_ID:
	250	kind = tmp423;
	251	break;
	252	default:
	253	return -ENODEV;
9410700b	254	}
dbe73c8f	255
9410700b AP	256	strlcpy(info->type, tmp421_id[kind - 1].name, I2C_NAME_SIZE);
	257	dev_info(&adapter->dev, "Detected TI %s chip at 0x%02x\n",
	258	names[kind - 1], client->addr);
	259
	260	return 0;
	261	}
	262
	263	static int tmp421_probe(struct i2c_client *client,
	264	const struct i2c_device_id *id)
	265	{
	266	struct tmp421_data *data;
	267	int err;
	268
	269	data = kzalloc(sizeof(struct tmp421_data), GFP_KERNEL);
	270	if (!data)
	271	return -ENOMEM;
	272
	273	i2c_set_clientdata(client, data);
	274	mutex_init(&data->update_lock);
	275	data->kind = id->driver_data;
	276
	277	err = tmp421_init_client(client);
	278	if (err)
	279	goto exit_free;
	280
	281	err = sysfs_create_group(&client->dev.kobj, &tmp421_group);
	282	if (err)
	283	goto exit_free;
	284
	285	data->hwmon_dev = hwmon_device_register(&client->dev);
	286	if (IS_ERR(data->hwmon_dev)) {
	287	err = PTR_ERR(data->hwmon_dev);
	288	data->hwmon_dev = NULL;
	289	goto exit_remove;
	290	}
	291	return 0;
	292
	293	exit_remove:
	294	sysfs_remove_group(&client->dev.kobj, &tmp421_group);
	295
	296	exit_free:
	297	i2c_set_clientdata(client, NULL);
	298	kfree(data);
	299
	300	return err;
	301	}
	302
	303	static int tmp421_remove(struct i2c_client *client)
	304	{
	305	struct tmp421_data *data = i2c_get_clientdata(client);
	306
	307	hwmon_device_unregister(data->hwmon_dev);
	308	sysfs_remove_group(&client->dev.kobj, &tmp421_group);
	309
	310	i2c_set_clientdata(client, NULL);
	311	kfree(data);
	312
	313	return 0;
	314	}
	315
	316	static struct i2c_driver tmp421_driver = {
	317	.class = I2C_CLASS_HWMON,
	318	.driver = {
	319	.name = "tmp421",
320	},
321	.probe = tmp421_probe,
322	.remove = tmp421_remove,
323	.id_table = tmp421_id,
324	.detect = tmp421_detect,
325	.address_data = &addr_data,
326	};
327
328	static int __init tmp421_init(void)
329	{
330	return i2c_add_driver(&tmp421_driver);
331	}
332
333	static void __exit tmp421_exit(void)
334	{
335	i2c_del_driver(&tmp421_driver);
336	}
337
338	MODULE_AUTHOR("Andre Prendel <[email protected]>");
339	MODULE_DESCRIPTION("Texas Instruments TMP421/422/423 temperature sensor"
340	" driver");
341	MODULE_LICENSE("GPL");
342
343	module_init(tmp421_init);
344	module_exit(tmp421_exit);