ds1621.c 10.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
/*
    ds1621.c - Part of lm_sensors, Linux kernel modules for hardware
             monitoring
    Christian W. Zuckschwerdt  <zany@triq.net>  2000-11-23
    based on lm75.c by Frodo Looijaard <frodol@dds.nl>
    Ported to Linux 2.6 by Aurelien Jarno <aurelien@aurel32.net> with 
    the help of Jean Delvare <khali@linux-fr.org>

    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/jiffies.h>
#include <linux/i2c.h>
29
#include <linux/hwmon.h>
30
#include <linux/hwmon-sysfs.h>
31
#include <linux/err.h>
32
#include <linux/mutex.h>
33
#include <linux/sysfs.h>
L
Linus Torvalds 已提交
34 35 36 37 38 39 40
#include "lm75.h"

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

/* Insmod parameters */
41
I2C_CLIENT_INSMOD_1(ds1621);
L
Linus Torvalds 已提交
42 43 44 45 46 47 48 49 50 51 52 53 54 55
static int polarity = -1;
module_param(polarity, int, 0);
MODULE_PARM_DESC(polarity, "Output's polarity: 0 = active high, 1 = active low");

/* Many DS1621 constants specified below */
/* Config register used for detection         */
/*  7    6    5    4    3    2    1    0      */
/* |Done|THF |TLF |NVB | X  | X  |POL |1SHOT| */
#define DS1621_REG_CONFIG_NVB		0x10
#define DS1621_REG_CONFIG_POLARITY	0x02
#define DS1621_REG_CONFIG_1SHOT		0x01
#define DS1621_REG_CONFIG_DONE		0x80

/* The DS1621 registers */
56 57 58 59 60
static const u8 DS1621_REG_TEMP[3] = {
	0xAA,		/* input, word, RO */
	0xA2,		/* min, word, RW */
	0xA1,		/* max, word, RW */
};
L
Linus Torvalds 已提交
61 62 63 64 65 66 67 68
#define DS1621_REG_CONF			0xAC /* byte, RW */
#define DS1621_COM_START		0xEE /* no data */
#define DS1621_COM_STOP			0x22 /* no data */

/* The DS1621 configuration register */
#define DS1621_ALARM_TEMP_HIGH		0x40
#define DS1621_ALARM_TEMP_LOW		0x20

J
Jean Delvare 已提交
69
/* Conversions */
L
Linus Torvalds 已提交
70 71 72 73 74 75
#define ALARMS_FROM_REG(val) ((val) & \
                              (DS1621_ALARM_TEMP_HIGH | DS1621_ALARM_TEMP_LOW))

/* Each client has this additional data */
struct ds1621_data {
	struct i2c_client client;
76
	struct class_device *class_dev;
77
	struct mutex update_lock;
L
Linus Torvalds 已提交
78 79 80
	char valid;			/* !=0 if following fields are valid */
	unsigned long last_updated;	/* In jiffies */

81
	u16 temp[3];			/* Register values, word */
L
Linus Torvalds 已提交
82 83 84 85 86 87 88 89 90 91 92 93
	u8 conf;			/* Register encoding, combined */
};

static int ds1621_attach_adapter(struct i2c_adapter *adapter);
static int ds1621_detect(struct i2c_adapter *adapter, int address,
			 int kind);
static void ds1621_init_client(struct i2c_client *client);
static int ds1621_detach_client(struct i2c_client *client);
static struct ds1621_data *ds1621_update_client(struct device *dev);

/* This is the driver that will be inserted */
static struct i2c_driver ds1621_driver = {
94 95 96
	.driver = {
		.name	= "ds1621",
	},
L
Linus Torvalds 已提交
97 98 99 100 101 102 103
	.id		= I2C_DRIVERID_DS1621,
	.attach_adapter	= ds1621_attach_adapter,
	.detach_client	= ds1621_detach_client,
};

/* All registers are word-sized, except for the configuration register.
   DS1621 uses a high-byte first convention, which is exactly opposite to
J
Jean Delvare 已提交
104
   the SMBus standard. */
L
Linus Torvalds 已提交
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
static int ds1621_read_value(struct i2c_client *client, u8 reg)
{
	if (reg == DS1621_REG_CONF)
		return i2c_smbus_read_byte_data(client, reg);
	else
		return swab16(i2c_smbus_read_word_data(client, reg));
}

static int ds1621_write_value(struct i2c_client *client, u8 reg, u16 value)
{
	if (reg == DS1621_REG_CONF)
		return i2c_smbus_write_byte_data(client, reg, value);
	else
		return i2c_smbus_write_word_data(client, reg, swab16(value));
}

static void ds1621_init_client(struct i2c_client *client)
{
	int reg = ds1621_read_value(client, DS1621_REG_CONF);
124
	/* switch to continuous conversion mode */
L
Linus Torvalds 已提交
125 126 127 128 129 130 131 132 133 134 135 136 137 138
	reg &= ~ DS1621_REG_CONFIG_1SHOT;

	/* setup output polarity */
	if (polarity == 0)
		reg &= ~DS1621_REG_CONFIG_POLARITY;
	else if (polarity == 1)
		reg |= DS1621_REG_CONFIG_POLARITY;
	
	ds1621_write_value(client, DS1621_REG_CONF, reg);
	
	/* start conversion */
	i2c_smbus_write_byte(client, DS1621_COM_START);
}

139 140 141 142 143 144 145
static ssize_t show_temp(struct device *dev, struct device_attribute *da,
			 char *buf)
{
	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
	struct ds1621_data *data = ds1621_update_client(dev);
	return sprintf(buf, "%d\n",
		       LM75_TEMP_FROM_REG(data->temp[attr->index]));
L
Linus Torvalds 已提交
146 147
}

148 149 150 151 152 153 154
static ssize_t set_temp(struct device *dev, struct device_attribute *da,
			const char *buf, size_t count)
{
	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
	struct i2c_client *client = to_i2c_client(dev);
	struct ds1621_data *data = ds1621_update_client(dev);
	u16 val = LM75_TEMP_TO_REG(simple_strtoul(buf, NULL, 10));
L
Linus Torvalds 已提交
155

156 157 158 159 160 161 162
	mutex_lock(&data->update_lock);
	data->temp[attr->index] = val;
	ds1621_write_value(client, DS1621_REG_TEMP[attr->index],
			   data->temp[attr->index]);
	mutex_unlock(&data->update_lock);
	return count;
}
L
Linus Torvalds 已提交
163

164 165
static ssize_t show_alarms(struct device *dev, struct device_attribute *da,
			   char *buf)
L
Linus Torvalds 已提交
166 167 168 169 170
{
	struct ds1621_data *data = ds1621_update_client(dev);
	return sprintf(buf, "%d\n", ALARMS_FROM_REG(data->conf));
}

171 172 173 174 175 176 177 178
static ssize_t show_alarm(struct device *dev, struct device_attribute *da,
			  char *buf)
{
	struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
	struct ds1621_data *data = ds1621_update_client(dev);
	return sprintf(buf, "%d\n", !!(data->conf & attr->index));
}

L
Linus Torvalds 已提交
179
static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
180 181 182
static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp, set_temp, 1);
static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp, set_temp, 2);
183 184 185 186
static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL,
		DS1621_ALARM_TEMP_LOW);
static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL,
		DS1621_ALARM_TEMP_HIGH);
L
Linus Torvalds 已提交
187

188
static struct attribute *ds1621_attributes[] = {
189 190 191
	&sensor_dev_attr_temp1_input.dev_attr.attr,
	&sensor_dev_attr_temp1_min.dev_attr.attr,
	&sensor_dev_attr_temp1_max.dev_attr.attr,
192 193
	&sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
	&sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
194 195 196 197 198 199 200 201
	&dev_attr_alarms.attr,
	NULL
};

static const struct attribute_group ds1621_group = {
	.attrs = ds1621_attributes,
};

L
Linus Torvalds 已提交
202 203 204

static int ds1621_attach_adapter(struct i2c_adapter *adapter)
{
205 206
	if (!(adapter->class & I2C_CLASS_HWMON))
		return 0;
207
	return i2c_probe(adapter, &addr_data, ds1621_detect);
L
Linus Torvalds 已提交
208 209
}

210
/* This function is called by i2c_probe */
211 212
static int ds1621_detect(struct i2c_adapter *adapter, int address,
			 int kind)
L
Linus Torvalds 已提交
213 214
{
	int conf, temp;
J
Jean Delvare 已提交
215
	struct i2c_client *client;
L
Linus Torvalds 已提交
216
	struct ds1621_data *data;
217
	int i, err = 0;
L
Linus Torvalds 已提交
218 219 220 221 222 223 224 225 226

	if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA 
				     | I2C_FUNC_SMBUS_WORD_DATA 
				     | I2C_FUNC_SMBUS_WRITE_BYTE))
		goto exit;

	/* OK. For now, we presume we have a valid client. We now create the
	   client structure, even though we cannot fill it completely yet.
	   But it allows us to access ds1621_{read,write}_value. */
D
Deepak Saxena 已提交
227
	if (!(data = kzalloc(sizeof(struct ds1621_data), GFP_KERNEL))) {
L
Linus Torvalds 已提交
228 229 230 231
		err = -ENOMEM;
		goto exit;
	}
	
J
Jean Delvare 已提交
232 233 234 235 236
	client = &data->client;
	i2c_set_clientdata(client, data);
	client->addr = address;
	client->adapter = adapter;
	client->driver = &ds1621_driver;
L
Linus Torvalds 已提交
237 238 239 240 241 242

	/* Now, we do the remaining detection. It is lousy. */
	if (kind < 0) {
		/* The NVB bit should be low if no EEPROM write has been 
		   requested during the latest 10ms, which is highly 
		   improbable in our case. */
J
Jean Delvare 已提交
243
		conf = ds1621_read_value(client, DS1621_REG_CONF);
L
Linus Torvalds 已提交
244 245 246
		if (conf & DS1621_REG_CONFIG_NVB)
			goto exit_free;
		/* The 7 lowest bits of a temperature should always be 0. */
247 248 249 250 251
		for (i = 0; i < ARRAY_SIZE(data->temp); i++) {
			temp = ds1621_read_value(client, DS1621_REG_TEMP[i]);
			if (temp & 0x007f)
				goto exit_free;
		}
L
Linus Torvalds 已提交
252 253 254
	}

	/* Fill in remaining client fields and put it into the global list */
J
Jean Delvare 已提交
255
	strlcpy(client->name, "ds1621", I2C_NAME_SIZE);
256
	mutex_init(&data->update_lock);
L
Linus Torvalds 已提交
257 258

	/* Tell the I2C layer a new client has arrived */
J
Jean Delvare 已提交
259
	if ((err = i2c_attach_client(client)))
L
Linus Torvalds 已提交
260 261 262
		goto exit_free;

	/* Initialize the DS1621 chip */
J
Jean Delvare 已提交
263
	ds1621_init_client(client);
L
Linus Torvalds 已提交
264 265

	/* Register sysfs hooks */
J
Jean Delvare 已提交
266
	if ((err = sysfs_create_group(&client->dev.kobj, &ds1621_group)))
267 268
		goto exit_detach;

J
Jean Delvare 已提交
269
	data->class_dev = hwmon_device_register(&client->dev);
270 271
	if (IS_ERR(data->class_dev)) {
		err = PTR_ERR(data->class_dev);
272
		goto exit_remove_files;
273 274
	}

L
Linus Torvalds 已提交
275 276
	return 0;

277
      exit_remove_files:
J
Jean Delvare 已提交
278
	sysfs_remove_group(&client->dev.kobj, &ds1621_group);
279
      exit_detach:
J
Jean Delvare 已提交
280
	i2c_detach_client(client);
L
Linus Torvalds 已提交
281 282 283 284 285 286 287 288
      exit_free:
	kfree(data);
      exit:
	return err;
}

static int ds1621_detach_client(struct i2c_client *client)
{
289
	struct ds1621_data *data = i2c_get_clientdata(client);
L
Linus Torvalds 已提交
290 291
	int err;

292
	hwmon_device_unregister(data->class_dev);
293
	sysfs_remove_group(&client->dev.kobj, &ds1621_group);
294

295
	if ((err = i2c_detach_client(client)))
L
Linus Torvalds 已提交
296 297
		return err;

298
	kfree(data);
L
Linus Torvalds 已提交
299 300 301 302 303 304 305 306 307 308 309

	return 0;
}


static struct ds1621_data *ds1621_update_client(struct device *dev)
{
	struct i2c_client *client = to_i2c_client(dev);
	struct ds1621_data *data = i2c_get_clientdata(client);
	u8 new_conf;

310
	mutex_lock(&data->update_lock);
L
Linus Torvalds 已提交
311 312 313

	if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
	    || !data->valid) {
314
		int i;
L
Linus Torvalds 已提交
315 316 317 318 319

		dev_dbg(&client->dev, "Starting ds1621 update\n");

		data->conf = ds1621_read_value(client, DS1621_REG_CONF);

320 321 322
		for (i = 0; i < ARRAY_SIZE(data->temp); i++)
			data->temp[i] = ds1621_read_value(client,
							  DS1621_REG_TEMP[i]);
L
Linus Torvalds 已提交
323

324
		/* reset alarms if necessary */
L
Linus Torvalds 已提交
325
		new_conf = data->conf;
326
		if (data->temp[0] > data->temp[1])	/* input > min */
L
Linus Torvalds 已提交
327
			new_conf &= ~DS1621_ALARM_TEMP_LOW;
328
		if (data->temp[0] < data->temp[2])	/* input < max */
L
Linus Torvalds 已提交
329 330 331 332 333 334 335 336 337
			new_conf &= ~DS1621_ALARM_TEMP_HIGH;
		if (data->conf != new_conf)
			ds1621_write_value(client, DS1621_REG_CONF,
					   new_conf);

		data->last_updated = jiffies;
		data->valid = 1;
	}

338
	mutex_unlock(&data->update_lock);
L
Linus Torvalds 已提交
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359

	return data;
}

static int __init ds1621_init(void)
{
	return i2c_add_driver(&ds1621_driver);
}

static void __exit ds1621_exit(void)
{
	i2c_del_driver(&ds1621_driver);
}


MODULE_AUTHOR("Christian W. Zuckschwerdt <zany@triq.net>");
MODULE_DESCRIPTION("DS1621 driver");
MODULE_LICENSE("GPL");

module_init(ds1621_init);
module_exit(ds1621_exit);