blob: 5f300ffed6577e8ea95108a60204516c3fb076e6 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 ds1621.c - Part of lm_sensors, Linux kernel modules for hardware
3 monitoring
4 Christian W. Zuckschwerdt <zany@triq.net> 2000-11-23
5 based on lm75.c by Frodo Looijaard <frodol@dds.nl>
6 Ported to Linux 2.6 by Aurelien Jarno <aurelien@aurel32.net> with
7 the help of Jean Delvare <khali@linux-fr.org>
8
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
13
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22*/
23
24#include <linux/module.h>
25#include <linux/init.h>
26#include <linux/slab.h>
27#include <linux/jiffies.h>
28#include <linux/i2c.h>
Mark M. Hoffman943b0832005-07-15 21:39:18 -040029#include <linux/hwmon.h>
Jean Delvare46a2e712007-06-09 10:11:15 -040030#include <linux/hwmon-sysfs.h>
Mark M. Hoffman943b0832005-07-15 21:39:18 -040031#include <linux/err.h>
Ingo Molnar9a61bf62006-01-18 23:19:26 +010032#include <linux/mutex.h>
Jean Delvarea5ebe662006-09-24 21:24:46 +020033#include <linux/sysfs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include "lm75.h"
35
36/* Addresses to scan */
Mark M. Hoffman25e9c862008-02-17 22:28:03 -050037static const unsigned short normal_i2c[] = { 0x48, 0x49, 0x4a, 0x4b, 0x4c,
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 0x4d, 0x4e, 0x4f, I2C_CLIENT_END };
Linus Torvalds1da177e2005-04-16 15:20:36 -070039
40/* Insmod parameters */
Jean Delvaref4b50262005-07-31 21:49:03 +020041I2C_CLIENT_INSMOD_1(ds1621);
Linus Torvalds1da177e2005-04-16 15:20:36 -070042static int polarity = -1;
43module_param(polarity, int, 0);
44MODULE_PARM_DESC(polarity, "Output's polarity: 0 = active high, 1 = active low");
45
46/* Many DS1621 constants specified below */
47/* Config register used for detection */
48/* 7 6 5 4 3 2 1 0 */
49/* |Done|THF |TLF |NVB | X | X |POL |1SHOT| */
50#define DS1621_REG_CONFIG_NVB 0x10
51#define DS1621_REG_CONFIG_POLARITY 0x02
52#define DS1621_REG_CONFIG_1SHOT 0x01
53#define DS1621_REG_CONFIG_DONE 0x80
54
55/* The DS1621 registers */
Jean Delvare46a2e712007-06-09 10:11:15 -040056static const u8 DS1621_REG_TEMP[3] = {
57 0xAA, /* input, word, RO */
58 0xA2, /* min, word, RW */
59 0xA1, /* max, word, RW */
60};
Linus Torvalds1da177e2005-04-16 15:20:36 -070061#define DS1621_REG_CONF 0xAC /* byte, RW */
62#define DS1621_COM_START 0xEE /* no data */
63#define DS1621_COM_STOP 0x22 /* no data */
64
65/* The DS1621 configuration register */
66#define DS1621_ALARM_TEMP_HIGH 0x40
67#define DS1621_ALARM_TEMP_LOW 0x20
68
Jean Delvare75819f02007-06-09 10:11:15 -040069/* Conversions */
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#define ALARMS_FROM_REG(val) ((val) & \
71 (DS1621_ALARM_TEMP_HIGH | DS1621_ALARM_TEMP_LOW))
72
73/* Each client has this additional data */
74struct ds1621_data {
75 struct i2c_client client;
Tony Jones1beeffe2007-08-20 13:46:20 -070076 struct device *hwmon_dev;
Ingo Molnar9a61bf62006-01-18 23:19:26 +010077 struct mutex update_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 char valid; /* !=0 if following fields are valid */
79 unsigned long last_updated; /* In jiffies */
80
Jean Delvare46a2e712007-06-09 10:11:15 -040081 u16 temp[3]; /* Register values, word */
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 u8 conf; /* Register encoding, combined */
83};
84
85static int ds1621_attach_adapter(struct i2c_adapter *adapter);
86static int ds1621_detect(struct i2c_adapter *adapter, int address,
87 int kind);
88static void ds1621_init_client(struct i2c_client *client);
89static int ds1621_detach_client(struct i2c_client *client);
90static struct ds1621_data *ds1621_update_client(struct device *dev);
91
92/* This is the driver that will be inserted */
93static struct i2c_driver ds1621_driver = {
Laurent Riffardcdaf7932005-11-26 20:37:41 +010094 .driver = {
Laurent Riffardcdaf7932005-11-26 20:37:41 +010095 .name = "ds1621",
96 },
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 .attach_adapter = ds1621_attach_adapter,
98 .detach_client = ds1621_detach_client,
99};
100
101/* All registers are word-sized, except for the configuration register.
102 DS1621 uses a high-byte first convention, which is exactly opposite to
Jean Delvare75819f02007-06-09 10:11:15 -0400103 the SMBus standard. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104static int ds1621_read_value(struct i2c_client *client, u8 reg)
105{
106 if (reg == DS1621_REG_CONF)
107 return i2c_smbus_read_byte_data(client, reg);
108 else
109 return swab16(i2c_smbus_read_word_data(client, reg));
110}
111
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112static int ds1621_write_value(struct i2c_client *client, u8 reg, u16 value)
113{
114 if (reg == DS1621_REG_CONF)
115 return i2c_smbus_write_byte_data(client, reg, value);
116 else
117 return i2c_smbus_write_word_data(client, reg, swab16(value));
118}
119
120static void ds1621_init_client(struct i2c_client *client)
121{
122 int reg = ds1621_read_value(client, DS1621_REG_CONF);
Steven Cole44bbe872005-05-03 18:21:25 -0600123 /* switch to continuous conversion mode */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 reg &= ~ DS1621_REG_CONFIG_1SHOT;
125
126 /* setup output polarity */
127 if (polarity == 0)
128 reg &= ~DS1621_REG_CONFIG_POLARITY;
129 else if (polarity == 1)
130 reg |= DS1621_REG_CONFIG_POLARITY;
131
132 ds1621_write_value(client, DS1621_REG_CONF, reg);
133
134 /* start conversion */
135 i2c_smbus_write_byte(client, DS1621_COM_START);
136}
137
Jean Delvare46a2e712007-06-09 10:11:15 -0400138static ssize_t show_temp(struct device *dev, struct device_attribute *da,
139 char *buf)
140{
141 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
142 struct ds1621_data *data = ds1621_update_client(dev);
143 return sprintf(buf, "%d\n",
144 LM75_TEMP_FROM_REG(data->temp[attr->index]));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145}
146
Jean Delvare46a2e712007-06-09 10:11:15 -0400147static ssize_t set_temp(struct device *dev, struct device_attribute *da,
148 const char *buf, size_t count)
149{
150 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
151 struct i2c_client *client = to_i2c_client(dev);
152 struct ds1621_data *data = ds1621_update_client(dev);
Christian Hohnstaedt5bfedac2007-08-16 11:40:10 +0200153 u16 val = LM75_TEMP_TO_REG(simple_strtol(buf, NULL, 10));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Jean Delvare46a2e712007-06-09 10:11:15 -0400155 mutex_lock(&data->update_lock);
156 data->temp[attr->index] = val;
157 ds1621_write_value(client, DS1621_REG_TEMP[attr->index],
158 data->temp[attr->index]);
159 mutex_unlock(&data->update_lock);
160 return count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
Jean Delvare46a2e712007-06-09 10:11:15 -0400163static ssize_t show_alarms(struct device *dev, struct device_attribute *da,
164 char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
166 struct ds1621_data *data = ds1621_update_client(dev);
167 return sprintf(buf, "%d\n", ALARMS_FROM_REG(data->conf));
168}
169
Jean Delvare87f0f312007-06-09 10:11:15 -0400170static ssize_t show_alarm(struct device *dev, struct device_attribute *da,
171 char *buf)
172{
173 struct sensor_device_attribute *attr = to_sensor_dev_attr(da);
174 struct ds1621_data *data = ds1621_update_client(dev);
175 return sprintf(buf, "%d\n", !!(data->conf & attr->index));
176}
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
Jean Delvare46a2e712007-06-09 10:11:15 -0400179static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
180static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp, set_temp, 1);
181static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp, set_temp, 2);
Jean Delvare87f0f312007-06-09 10:11:15 -0400182static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL,
183 DS1621_ALARM_TEMP_LOW);
184static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL,
185 DS1621_ALARM_TEMP_HIGH);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Jean Delvarea5ebe662006-09-24 21:24:46 +0200187static struct attribute *ds1621_attributes[] = {
Jean Delvare46a2e712007-06-09 10:11:15 -0400188 &sensor_dev_attr_temp1_input.dev_attr.attr,
189 &sensor_dev_attr_temp1_min.dev_attr.attr,
190 &sensor_dev_attr_temp1_max.dev_attr.attr,
Jean Delvare87f0f312007-06-09 10:11:15 -0400191 &sensor_dev_attr_temp1_min_alarm.dev_attr.attr,
192 &sensor_dev_attr_temp1_max_alarm.dev_attr.attr,
Jean Delvarea5ebe662006-09-24 21:24:46 +0200193 &dev_attr_alarms.attr,
194 NULL
195};
196
197static const struct attribute_group ds1621_group = {
198 .attrs = ds1621_attributes,
199};
200
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
202static int ds1621_attach_adapter(struct i2c_adapter *adapter)
203{
Jean Delvareddec7482005-10-17 23:02:42 +0200204 if (!(adapter->class & I2C_CLASS_HWMON))
205 return 0;
Jean Delvare2ed2dc32005-07-31 21:42:02 +0200206 return i2c_probe(adapter, &addr_data, ds1621_detect);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207}
208
Jean Delvare2ed2dc32005-07-31 21:42:02 +0200209/* This function is called by i2c_probe */
Ben Dooksc49efce2005-10-26 21:07:25 +0200210static int ds1621_detect(struct i2c_adapter *adapter, int address,
211 int kind)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212{
213 int conf, temp;
Jean Delvare75819f02007-06-09 10:11:15 -0400214 struct i2c_client *client;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 struct ds1621_data *data;
Jean Delvare46a2e712007-06-09 10:11:15 -0400216 int i, err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217
218 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA
219 | I2C_FUNC_SMBUS_WORD_DATA
220 | I2C_FUNC_SMBUS_WRITE_BYTE))
221 goto exit;
222
223 /* OK. For now, we presume we have a valid client. We now create the
224 client structure, even though we cannot fill it completely yet.
225 But it allows us to access ds1621_{read,write}_value. */
Deepak Saxenaba9c2e82005-10-17 23:08:32 +0200226 if (!(data = kzalloc(sizeof(struct ds1621_data), GFP_KERNEL))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 err = -ENOMEM;
228 goto exit;
229 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Jean Delvare75819f02007-06-09 10:11:15 -0400231 client = &data->client;
232 i2c_set_clientdata(client, data);
233 client->addr = address;
234 client->adapter = adapter;
235 client->driver = &ds1621_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
237 /* Now, we do the remaining detection. It is lousy. */
238 if (kind < 0) {
239 /* The NVB bit should be low if no EEPROM write has been
240 requested during the latest 10ms, which is highly
241 improbable in our case. */
Jean Delvare75819f02007-06-09 10:11:15 -0400242 conf = ds1621_read_value(client, DS1621_REG_CONF);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 if (conf & DS1621_REG_CONFIG_NVB)
244 goto exit_free;
245 /* The 7 lowest bits of a temperature should always be 0. */
Jean Delvare46a2e712007-06-09 10:11:15 -0400246 for (i = 0; i < ARRAY_SIZE(data->temp); i++) {
247 temp = ds1621_read_value(client, DS1621_REG_TEMP[i]);
248 if (temp & 0x007f)
249 goto exit_free;
250 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 }
252
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 /* Fill in remaining client fields and put it into the global list */
Jean Delvare75819f02007-06-09 10:11:15 -0400254 strlcpy(client->name, "ds1621", I2C_NAME_SIZE);
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100255 mutex_init(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
257 /* Tell the I2C layer a new client has arrived */
Jean Delvare75819f02007-06-09 10:11:15 -0400258 if ((err = i2c_attach_client(client)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 goto exit_free;
260
261 /* Initialize the DS1621 chip */
Jean Delvare75819f02007-06-09 10:11:15 -0400262 ds1621_init_client(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
264 /* Register sysfs hooks */
Jean Delvare75819f02007-06-09 10:11:15 -0400265 if ((err = sysfs_create_group(&client->dev.kobj, &ds1621_group)))
Jean Delvarea5ebe662006-09-24 21:24:46 +0200266 goto exit_detach;
267
Tony Jones1beeffe2007-08-20 13:46:20 -0700268 data->hwmon_dev = hwmon_device_register(&client->dev);
269 if (IS_ERR(data->hwmon_dev)) {
270 err = PTR_ERR(data->hwmon_dev);
Jean Delvarea5ebe662006-09-24 21:24:46 +0200271 goto exit_remove_files;
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400272 }
273
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 return 0;
275
Jean Delvarea5ebe662006-09-24 21:24:46 +0200276 exit_remove_files:
Jean Delvare75819f02007-06-09 10:11:15 -0400277 sysfs_remove_group(&client->dev.kobj, &ds1621_group);
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400278 exit_detach:
Jean Delvare75819f02007-06-09 10:11:15 -0400279 i2c_detach_client(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 exit_free:
281 kfree(data);
282 exit:
283 return err;
284}
285
286static int ds1621_detach_client(struct i2c_client *client)
287{
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400288 struct ds1621_data *data = i2c_get_clientdata(client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 int err;
290
Tony Jones1beeffe2007-08-20 13:46:20 -0700291 hwmon_device_unregister(data->hwmon_dev);
Jean Delvarea5ebe662006-09-24 21:24:46 +0200292 sysfs_remove_group(&client->dev.kobj, &ds1621_group);
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400293
Jean Delvare7bef5592005-07-27 22:14:49 +0200294 if ((err = i2c_detach_client(client)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Mark M. Hoffman943b0832005-07-15 21:39:18 -0400297 kfree(data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
299 return 0;
300}
301
302
303static struct ds1621_data *ds1621_update_client(struct device *dev)
304{
305 struct i2c_client *client = to_i2c_client(dev);
306 struct ds1621_data *data = i2c_get_clientdata(client);
307 u8 new_conf;
308
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100309 mutex_lock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
311 if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
312 || !data->valid) {
Jean Delvare46a2e712007-06-09 10:11:15 -0400313 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
315 dev_dbg(&client->dev, "Starting ds1621 update\n");
316
317 data->conf = ds1621_read_value(client, DS1621_REG_CONF);
318
Jean Delvare46a2e712007-06-09 10:11:15 -0400319 for (i = 0; i < ARRAY_SIZE(data->temp); i++)
320 data->temp[i] = ds1621_read_value(client,
321 DS1621_REG_TEMP[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
Steven Cole44bbe872005-05-03 18:21:25 -0600323 /* reset alarms if necessary */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 new_conf = data->conf;
Jean Delvare46a2e712007-06-09 10:11:15 -0400325 if (data->temp[0] > data->temp[1]) /* input > min */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 new_conf &= ~DS1621_ALARM_TEMP_LOW;
Jean Delvare46a2e712007-06-09 10:11:15 -0400327 if (data->temp[0] < data->temp[2]) /* input < max */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328 new_conf &= ~DS1621_ALARM_TEMP_HIGH;
329 if (data->conf != new_conf)
330 ds1621_write_value(client, DS1621_REG_CONF,
331 new_conf);
332
333 data->last_updated = jiffies;
334 data->valid = 1;
335 }
336
Ingo Molnar9a61bf62006-01-18 23:19:26 +0100337 mutex_unlock(&data->update_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338
339 return data;
340}
341
342static int __init ds1621_init(void)
343{
344 return i2c_add_driver(&ds1621_driver);
345}
346
347static void __exit ds1621_exit(void)
348{
349 i2c_del_driver(&ds1621_driver);
350}
351
352
353MODULE_AUTHOR("Christian W. Zuckschwerdt <zany@triq.net>");
354MODULE_DESCRIPTION("DS1621 driver");
355MODULE_LICENSE("GPL");
356
357module_init(ds1621_init);
358module_exit(ds1621_exit);