]>
Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
19f2c059 GR |
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 | * | |
cd6c8a42 RC |
9 | * The DS1621 device is a digital temperature/thermometer with 9-bit |
10 | * resolution, a thermal alarm output (Tout), and user-defined minimum | |
11 | * and maximum temperature thresholds (TH and TL). | |
12 | * | |
260f81ff RC |
13 | * The DS1625, DS1631, DS1721, and DS1731 are pin compatible with the DS1621 |
14 | * and similar in operation, with slight variations as noted in the device | |
cd6c8a42 RC |
15 | * datasheets (please refer to www.maximintegrated.com for specific |
16 | * device information). | |
17 | * | |
18 | * Since the DS1621 was the first chipset supported by this driver, | |
19 | * most comments will refer to this chipset, but are actually general | |
20 | * and concern all supported chipsets, unless mentioned otherwise. | |
21 | * | |
19f2c059 GR |
22 | * This program is free software; you can redistribute it and/or modify |
23 | * it under the terms of the GNU General Public License as published by | |
24 | * the Free Software Foundation; either version 2 of the License, or | |
25 | * (at your option) any later version. | |
26 | * | |
27 | * This program is distributed in the hope that it will be useful, | |
28 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
29 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
30 | * GNU General Public License for more details. | |
31 | * | |
32 | * You should have received a copy of the GNU General Public License | |
33 | * along with this program; if not, write to the Free Software | |
34 | * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. | |
35 | */ | |
1da177e4 LT |
36 | |
37 | #include <linux/module.h> | |
38 | #include <linux/init.h> | |
39 | #include <linux/slab.h> | |
40 | #include <linux/jiffies.h> | |
41 | #include <linux/i2c.h> | |
943b0830 | 42 | #include <linux/hwmon.h> |
46a2e71c | 43 | #include <linux/hwmon-sysfs.h> |
943b0830 | 44 | #include <linux/err.h> |
9a61bf63 | 45 | #include <linux/mutex.h> |
a5ebe668 | 46 | #include <linux/sysfs.h> |
cd6c8a42 | 47 | #include <linux/kernel.h> |
1da177e4 | 48 | |
cd6c8a42 | 49 | /* Supported devices */ |
260f81ff | 50 | enum chips { ds1621, ds1625, ds1631, ds1721, ds1731 }; |
cd6c8a42 | 51 | |
1da177e4 | 52 | /* Insmod parameters */ |
1da177e4 LT |
53 | static int polarity = -1; |
54 | module_param(polarity, int, 0); | |
55 | MODULE_PARM_DESC(polarity, "Output's polarity: 0 = active high, 1 = active low"); | |
56 | ||
cd6c8a42 RC |
57 | /* |
58 | * The Configuration/Status register | |
59 | * | |
60 | * - DS1621: | |
61 | * 7 6 5 4 3 2 1 0 | |
62 | * |Done|THF |TLF |NVB | X | X |POL |1SHOT| | |
63 | * | |
64 | * - DS1625: | |
65 | * 7 6 5 4 3 2 1 0 | |
66 | * |Done|THF |TLF |NVB | 1 | 0 |POL |1SHOT| | |
67 | * | |
260f81ff | 68 | * - DS1631, DS1731: |
79c1cc1c RC |
69 | * 7 6 5 4 3 2 1 0 |
70 | * |Done|THF |TLF |NVB | R1 | R0 |POL |1SHOT| | |
71 | * | |
cd6c8a42 RC |
72 | * - DS1721: |
73 | * 7 6 5 4 3 2 1 0 | |
74 | * |Done| X | X | U | R1 | R0 |POL |1SHOT| | |
75 | * | |
76 | * Where: | |
77 | * - 'X' is Reserved | |
78 | * - 'U' is Undefined | |
79 | */ | |
1da177e4 | 80 | #define DS1621_REG_CONFIG_NVB 0x10 |
cd6c8a42 | 81 | #define DS1621_REG_CONFIG_RESOL 0x0C |
1da177e4 LT |
82 | #define DS1621_REG_CONFIG_POLARITY 0x02 |
83 | #define DS1621_REG_CONFIG_1SHOT 0x01 | |
84 | #define DS1621_REG_CONFIG_DONE 0x80 | |
85 | ||
cd6c8a42 RC |
86 | #define DS1621_REG_CONFIG_RESOL_SHIFT 2 |
87 | ||
88 | /* ds1721 conversion rates: {C/LSB, time(ms), resolution bit setting} */ | |
89 | static const unsigned short ds1721_convrates[] = { | |
90 | 94, /* 9-bits (0.5, 93.75, RES[0..1] = 0 */ | |
91 | 188, /* 10-bits (0.25, 187.5, RES[0..1] = 1 */ | |
92 | 375, /* 11-bits (0.125, 375, RES[0..1] = 2 */ | |
93 | 750, /* 12-bits (0.0625, 750, RES[0..1] = 3 */ | |
94 | }; | |
95 | ||
96 | #define DS1621_CONVERSION_MAX 750 | |
97 | #define DS1625_CONVERSION_MAX 500 | |
98 | ||
99 | #define DS1621_TEMP_MAX 125000 | |
100 | #define DS1621_TEMP_MIN (-55000) | |
101 | ||
102 | /* The DS1621 temperature registers */ | |
46a2e71c JD |
103 | static const u8 DS1621_REG_TEMP[3] = { |
104 | 0xAA, /* input, word, RO */ | |
105 | 0xA2, /* min, word, RW */ | |
106 | 0xA1, /* max, word, RW */ | |
107 | }; | |
1da177e4 LT |
108 | #define DS1621_REG_CONF 0xAC /* byte, RW */ |
109 | #define DS1621_COM_START 0xEE /* no data */ | |
cd6c8a42 | 110 | #define DS1721_COM_START 0x51 /* no data */ |
1da177e4 LT |
111 | #define DS1621_COM_STOP 0x22 /* no data */ |
112 | ||
113 | /* The DS1621 configuration register */ | |
114 | #define DS1621_ALARM_TEMP_HIGH 0x40 | |
115 | #define DS1621_ALARM_TEMP_LOW 0x20 | |
116 | ||
75819f01 | 117 | /* Conversions */ |
1da177e4 | 118 | #define ALARMS_FROM_REG(val) ((val) & \ |
19f2c059 | 119 | (DS1621_ALARM_TEMP_HIGH | DS1621_ALARM_TEMP_LOW)) |
1da177e4 LT |
120 | |
121 | /* Each client has this additional data */ | |
122 | struct ds1621_data { | |
1beeffe4 | 123 | struct device *hwmon_dev; |
9a61bf63 | 124 | struct mutex update_lock; |
1da177e4 LT |
125 | char valid; /* !=0 if following fields are valid */ |
126 | unsigned long last_updated; /* In jiffies */ | |
cd6c8a42 | 127 | enum chips kind; /* device type */ |
1da177e4 | 128 | |
46a2e71c | 129 | u16 temp[3]; /* Register values, word */ |
1da177e4 | 130 | u8 conf; /* Register encoding, combined */ |
cd6c8a42 | 131 | u16 update_interval; /* Conversion rate in milliseconds */ |
1da177e4 LT |
132 | }; |
133 | ||
cd6c8a42 RC |
134 | static inline int DS1621_TEMP_FROM_REG(u16 reg) |
135 | { | |
136 | return DIV_ROUND_CLOSEST(((s16)reg / 16) * 625, 10); | |
137 | } | |
138 | ||
139 | /* | |
140 | * TEMP: 0.001C/bit (-55C to +125C) | |
141 | * REG: | |
79c1cc1c | 142 | * - 1621, 1625: 0.5C/bit |
260f81ff | 143 | * - 1631, 1721, 1731: 0.0625C/bit |
cd6c8a42 RC |
144 | * Assume highest resolution and let the bits fall where they may.. |
145 | */ | |
146 | static inline u16 DS1621_TEMP_TO_REG(long temp) | |
147 | { | |
148 | int ntemp = clamp_val(temp, DS1621_TEMP_MIN, DS1621_TEMP_MAX); | |
149 | ntemp += (ntemp < 0 ? -31 : 31); | |
150 | ntemp = DIV_ROUND_CLOSEST(ntemp * 10, 625) << 4; | |
151 | return (u16)ntemp; | |
152 | } | |
153 | ||
1da177e4 LT |
154 | static void ds1621_init_client(struct i2c_client *client) |
155 | { | |
cd6c8a42 RC |
156 | u8 conf, new_conf, sreg, resol; |
157 | struct ds1621_data *data = i2c_get_clientdata(client); | |
e4879e28 JD |
158 | |
159 | new_conf = conf = i2c_smbus_read_byte_data(client, DS1621_REG_CONF); | |
44bbe87e | 160 | /* switch to continuous conversion mode */ |
e4879e28 | 161 | new_conf &= ~DS1621_REG_CONFIG_1SHOT; |
1da177e4 LT |
162 | |
163 | /* setup output polarity */ | |
164 | if (polarity == 0) | |
e4879e28 | 165 | new_conf &= ~DS1621_REG_CONFIG_POLARITY; |
1da177e4 | 166 | else if (polarity == 1) |
e4879e28 | 167 | new_conf |= DS1621_REG_CONFIG_POLARITY; |
19f2c059 | 168 | |
e4879e28 JD |
169 | if (conf != new_conf) |
170 | i2c_smbus_write_byte_data(client, DS1621_REG_CONF, new_conf); | |
19f2c059 | 171 | |
cd6c8a42 RC |
172 | switch (data->kind) { |
173 | case ds1625: | |
174 | data->update_interval = DS1625_CONVERSION_MAX; | |
175 | sreg = DS1621_COM_START; | |
176 | break; | |
79c1cc1c | 177 | case ds1631: |
cd6c8a42 | 178 | case ds1721: |
260f81ff | 179 | case ds1731: |
cd6c8a42 RC |
180 | resol = (new_conf & DS1621_REG_CONFIG_RESOL) >> |
181 | DS1621_REG_CONFIG_RESOL_SHIFT; | |
182 | data->update_interval = ds1721_convrates[resol]; | |
183 | sreg = DS1721_COM_START; | |
184 | break; | |
185 | default: | |
186 | data->update_interval = DS1621_CONVERSION_MAX; | |
187 | sreg = DS1621_COM_START; | |
188 | break; | |
189 | } | |
190 | ||
1da177e4 | 191 | /* start conversion */ |
cd6c8a42 | 192 | i2c_smbus_write_byte(client, sreg); |
1da177e4 LT |
193 | } |
194 | ||
9202add6 JD |
195 | static struct ds1621_data *ds1621_update_client(struct device *dev) |
196 | { | |
197 | struct i2c_client *client = to_i2c_client(dev); | |
198 | struct ds1621_data *data = i2c_get_clientdata(client); | |
199 | u8 new_conf; | |
200 | ||
201 | mutex_lock(&data->update_lock); | |
202 | ||
cd6c8a42 RC |
203 | if (time_after(jiffies, data->last_updated + data->update_interval) || |
204 | !data->valid) { | |
9202add6 JD |
205 | int i; |
206 | ||
207 | dev_dbg(&client->dev, "Starting ds1621 update\n"); | |
208 | ||
594592dc | 209 | data->conf = i2c_smbus_read_byte_data(client, DS1621_REG_CONF); |
9202add6 JD |
210 | |
211 | for (i = 0; i < ARRAY_SIZE(data->temp); i++) | |
90f4102c | 212 | data->temp[i] = i2c_smbus_read_word_swapped(client, |
594592dc | 213 | DS1621_REG_TEMP[i]); |
9202add6 JD |
214 | |
215 | /* reset alarms if necessary */ | |
216 | new_conf = data->conf; | |
217 | if (data->temp[0] > data->temp[1]) /* input > min */ | |
218 | new_conf &= ~DS1621_ALARM_TEMP_LOW; | |
219 | if (data->temp[0] < data->temp[2]) /* input < max */ | |
220 | new_conf &= ~DS1621_ALARM_TEMP_HIGH; | |
221 | if (data->conf != new_conf) | |
594592dc JD |
222 | i2c_smbus_write_byte_data(client, DS1621_REG_CONF, |
223 | new_conf); | |
9202add6 JD |
224 | |
225 | data->last_updated = jiffies; | |
226 | data->valid = 1; | |
227 | } | |
228 | ||
229 | mutex_unlock(&data->update_lock); | |
230 | ||
231 | return data; | |
232 | } | |
233 | ||
46a2e71c JD |
234 | static ssize_t show_temp(struct device *dev, struct device_attribute *da, |
235 | char *buf) | |
236 | { | |
237 | struct sensor_device_attribute *attr = to_sensor_dev_attr(da); | |
238 | struct ds1621_data *data = ds1621_update_client(dev); | |
239 | return sprintf(buf, "%d\n", | |
cd6c8a42 | 240 | DS1621_TEMP_FROM_REG(data->temp[attr->index])); |
1da177e4 LT |
241 | } |
242 | ||
46a2e71c JD |
243 | static ssize_t set_temp(struct device *dev, struct device_attribute *da, |
244 | const char *buf, size_t count) | |
245 | { | |
246 | struct sensor_device_attribute *attr = to_sensor_dev_attr(da); | |
247 | struct i2c_client *client = to_i2c_client(dev); | |
e4879e28 | 248 | struct ds1621_data *data = i2c_get_clientdata(client); |
19f2c059 GR |
249 | long val; |
250 | int err; | |
251 | ||
252 | err = kstrtol(buf, 10, &val); | |
253 | if (err) | |
254 | return err; | |
1da177e4 | 255 | |
46a2e71c | 256 | mutex_lock(&data->update_lock); |
cd6c8a42 | 257 | data->temp[attr->index] = DS1621_TEMP_TO_REG(val); |
90f4102c JD |
258 | i2c_smbus_write_word_swapped(client, DS1621_REG_TEMP[attr->index], |
259 | data->temp[attr->index]); | |
46a2e71c JD |
260 | mutex_unlock(&data->update_lock); |
261 | return count; | |
262 | } | |
1da177e4 | 263 | |
46a2e71c JD |
264 | static ssize_t show_alarms(struct device *dev, struct device_attribute *da, |
265 | char *buf) | |
1da177e4 LT |
266 | { |
267 | struct ds1621_data *data = ds1621_update_client(dev); | |
268 | return sprintf(buf, "%d\n", ALARMS_FROM_REG(data->conf)); | |
269 | } | |
270 | ||
87f0f31b JD |
271 | static ssize_t show_alarm(struct device *dev, struct device_attribute *da, |
272 | char *buf) | |
273 | { | |
274 | struct sensor_device_attribute *attr = to_sensor_dev_attr(da); | |
275 | struct ds1621_data *data = ds1621_update_client(dev); | |
276 | return sprintf(buf, "%d\n", !!(data->conf & attr->index)); | |
277 | } | |
278 | ||
3a8fe331 RC |
279 | static ssize_t show_convrate(struct device *dev, struct device_attribute *da, |
280 | char *buf) | |
281 | { | |
282 | struct i2c_client *client = to_i2c_client(dev); | |
283 | struct ds1621_data *data = i2c_get_clientdata(client); | |
284 | return scnprintf(buf, PAGE_SIZE, "%hu\n", data->update_interval); | |
285 | } | |
286 | ||
287 | static ssize_t set_convrate(struct device *dev, struct device_attribute *da, | |
288 | const char *buf, size_t count) | |
289 | { | |
290 | struct i2c_client *client = to_i2c_client(dev); | |
291 | struct ds1621_data *data = i2c_get_clientdata(client); | |
292 | unsigned long convrate; | |
293 | s32 err; | |
294 | int resol = 0; | |
295 | ||
296 | err = kstrtoul(buf, 10, &convrate); | |
297 | if (err) | |
298 | return err; | |
299 | ||
300 | /* Convert rate into resolution bits */ | |
301 | while (resol < (ARRAY_SIZE(ds1721_convrates) - 1) && | |
302 | convrate > ds1721_convrates[resol]) | |
303 | resol++; | |
304 | ||
305 | mutex_lock(&data->update_lock); | |
306 | data->conf = i2c_smbus_read_byte_data(client, DS1621_REG_CONF); | |
307 | data->conf &= ~DS1621_REG_CONFIG_RESOL; | |
308 | data->conf |= (resol << DS1621_REG_CONFIG_RESOL_SHIFT); | |
309 | i2c_smbus_write_byte_data(client, DS1621_REG_CONF, data->conf); | |
310 | data->update_interval = ds1721_convrates[resol]; | |
311 | mutex_unlock(&data->update_lock); | |
312 | ||
313 | return count; | |
314 | } | |
315 | ||
1da177e4 | 316 | static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL); |
3a8fe331 RC |
317 | static DEVICE_ATTR(update_interval, S_IWUSR | S_IRUGO, show_convrate, |
318 | set_convrate); | |
319 | ||
46a2e71c JD |
320 | static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0); |
321 | static SENSOR_DEVICE_ATTR(temp1_min, S_IWUSR | S_IRUGO, show_temp, set_temp, 1); | |
322 | static SENSOR_DEVICE_ATTR(temp1_max, S_IWUSR | S_IRUGO, show_temp, set_temp, 2); | |
87f0f31b JD |
323 | static SENSOR_DEVICE_ATTR(temp1_min_alarm, S_IRUGO, show_alarm, NULL, |
324 | DS1621_ALARM_TEMP_LOW); | |
325 | static SENSOR_DEVICE_ATTR(temp1_max_alarm, S_IRUGO, show_alarm, NULL, | |
326 | DS1621_ALARM_TEMP_HIGH); | |
1da177e4 | 327 | |
a5ebe668 | 328 | static struct attribute *ds1621_attributes[] = { |
46a2e71c JD |
329 | &sensor_dev_attr_temp1_input.dev_attr.attr, |
330 | &sensor_dev_attr_temp1_min.dev_attr.attr, | |
331 | &sensor_dev_attr_temp1_max.dev_attr.attr, | |
87f0f31b JD |
332 | &sensor_dev_attr_temp1_min_alarm.dev_attr.attr, |
333 | &sensor_dev_attr_temp1_max_alarm.dev_attr.attr, | |
a5ebe668 | 334 | &dev_attr_alarms.attr, |
3a8fe331 | 335 | &dev_attr_update_interval.attr, |
a5ebe668 JD |
336 | NULL |
337 | }; | |
338 | ||
3a8fe331 RC |
339 | static umode_t ds1621_attribute_visible(struct kobject *kobj, |
340 | struct attribute *attr, int index) | |
341 | { | |
342 | struct device *dev = container_of(kobj, struct device, kobj); | |
343 | struct i2c_client *client = to_i2c_client(dev); | |
344 | struct ds1621_data *data = i2c_get_clientdata(client); | |
345 | ||
346 | if (attr == &dev_attr_update_interval.attr) | |
79c1cc1c | 347 | if (data->kind == ds1621 || data->kind == ds1625) |
3a8fe331 RC |
348 | /* shhh, we're hiding update_interval */ |
349 | return 0; | |
350 | return attr->mode; | |
351 | } | |
352 | ||
a5ebe668 JD |
353 | static const struct attribute_group ds1621_group = { |
354 | .attrs = ds1621_attributes, | |
3a8fe331 | 355 | .is_visible = ds1621_attribute_visible |
a5ebe668 JD |
356 | }; |
357 | ||
70313eab JD |
358 | static int ds1621_probe(struct i2c_client *client, |
359 | const struct i2c_device_id *id) | |
360 | { | |
361 | struct ds1621_data *data; | |
362 | int err; | |
363 | ||
e20b4b38 GR |
364 | data = devm_kzalloc(&client->dev, sizeof(struct ds1621_data), |
365 | GFP_KERNEL); | |
366 | if (!data) | |
367 | return -ENOMEM; | |
70313eab JD |
368 | |
369 | i2c_set_clientdata(client, data); | |
370 | mutex_init(&data->update_lock); | |
1da177e4 | 371 | |
cd6c8a42 RC |
372 | data->kind = id->driver_data; |
373 | ||
1da177e4 | 374 | /* Initialize the DS1621 chip */ |
75819f01 | 375 | ds1621_init_client(client); |
1da177e4 LT |
376 | |
377 | /* Register sysfs hooks */ | |
19f2c059 GR |
378 | err = sysfs_create_group(&client->dev.kobj, &ds1621_group); |
379 | if (err) | |
e20b4b38 | 380 | return err; |
a5ebe668 | 381 | |
1beeffe4 TJ |
382 | data->hwmon_dev = hwmon_device_register(&client->dev); |
383 | if (IS_ERR(data->hwmon_dev)) { | |
384 | err = PTR_ERR(data->hwmon_dev); | |
a5ebe668 | 385 | goto exit_remove_files; |
943b0830 MH |
386 | } |
387 | ||
1da177e4 LT |
388 | return 0; |
389 | ||
19f2c059 | 390 | exit_remove_files: |
75819f01 | 391 | sysfs_remove_group(&client->dev.kobj, &ds1621_group); |
1da177e4 LT |
392 | return err; |
393 | } | |
394 | ||
70313eab | 395 | static int ds1621_remove(struct i2c_client *client) |
1da177e4 | 396 | { |
943b0830 | 397 | struct ds1621_data *data = i2c_get_clientdata(client); |
1da177e4 | 398 | |
1beeffe4 | 399 | hwmon_device_unregister(data->hwmon_dev); |
a5ebe668 | 400 | sysfs_remove_group(&client->dev.kobj, &ds1621_group); |
943b0830 | 401 | |
1da177e4 LT |
402 | return 0; |
403 | } | |
404 | ||
9202add6 | 405 | static const struct i2c_device_id ds1621_id[] = { |
cd6c8a42 RC |
406 | { "ds1621", ds1621 }, |
407 | { "ds1625", ds1625 }, | |
79c1cc1c | 408 | { "ds1631", ds1631 }, |
cd6c8a42 | 409 | { "ds1721", ds1721 }, |
260f81ff | 410 | { "ds1731", ds1731 }, |
9202add6 JD |
411 | { } |
412 | }; | |
413 | MODULE_DEVICE_TABLE(i2c, ds1621_id); | |
1da177e4 | 414 | |
9202add6 JD |
415 | /* This is the driver that will be inserted */ |
416 | static struct i2c_driver ds1621_driver = { | |
417 | .class = I2C_CLASS_HWMON, | |
418 | .driver = { | |
419 | .name = "ds1621", | |
420 | }, | |
421 | .probe = ds1621_probe, | |
422 | .remove = ds1621_remove, | |
423 | .id_table = ds1621_id, | |
9202add6 | 424 | }; |
1da177e4 | 425 | |
f0967eea | 426 | module_i2c_driver(ds1621_driver); |
1da177e4 LT |
427 | |
428 | MODULE_AUTHOR("Christian W. Zuckschwerdt <zany@triq.net>"); | |
429 | MODULE_DESCRIPTION("DS1621 driver"); | |
430 | MODULE_LICENSE("GPL"); |