4 * Copyright (C) 2000 Chen-Yuan Wu <gwu@esoft.com>
5 * Copyright (C) 2003-2004 Jean Delvare <khali@linux-fr.org>
7 * The ADM1025 is a sensor chip made by Analog Devices. It reports up to 6
8 * voltages (including its own power source) and up to two temperatures
9 * (its own plus up to one external one). Voltages are scaled internally
10 * (which is not the common way) with ratios such that the nominal value
11 * of each voltage correspond to a register value of 192 (which means a
12 * resolution of about 0.5% of the nominal value). Temperature values are
13 * reported with a 1 deg resolution and a 3 deg accuracy. Complete
14 * datasheet can be obtained from Analog's website at:
15 * http://www.analog.com/Analog_Root/productPage/productHome/0,2121,ADM1025,00.html
17 * This driver also supports the ADM1025A, which differs from the ADM1025
18 * only in that it has "open-drain VID inputs while the ADM1025 has
19 * on-chip 100k pull-ups on the VID inputs". It doesn't make any
22 * This driver also supports the NE1619, a sensor chip made by Philips.
23 * That chip is similar to the ADM1025A, with a few differences. The only
24 * difference that matters to us is that the NE1619 has only two possible
25 * addresses while the ADM1025A has a third one. Complete datasheet can be
26 * obtained from Philips's website at:
27 * http://www.semiconductors.philips.com/pip/NE1619DS.html
29 * Since the ADM1025 was the first chipset supported by this driver, most
30 * comments will refer to this chipset, but are actually general and
31 * concern all supported chipsets, unless mentioned otherwise.
33 * This program is free software; you can redistribute it and/or modify
34 * it under the terms of the GNU General Public License as published by
35 * the Free Software Foundation; either version 2 of the License, or
36 * (at your option) any later version.
38 * This program is distributed in the hope that it will be useful,
39 * but WITHOUT ANY WARRANTY; without even the implied warranty of
40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41 * GNU General Public License for more details.
43 * You should have received a copy of the GNU General Public License
44 * along with this program; if not, write to the Free Software
45 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
48 #include <linux/module.h>
49 #include <linux/init.h>
50 #include <linux/slab.h>
51 #include <linux/jiffies.h>
52 #include <linux/i2c.h>
53 #include <linux/hwmon.h>
54 #include <linux/hwmon-sysfs.h>
55 #include <linux/hwmon-vid.h>
56 #include <linux/err.h>
57 #include <linux/mutex.h>
61 * ADM1025 and ADM1025A have three possible addresses: 0x2c, 0x2d and 0x2e.
62 * NE1619 has two possible addresses: 0x2c and 0x2d.
65 static unsigned short normal_i2c[] = { 0x2c, 0x2d, 0x2e, I2C_CLIENT_END };
71 I2C_CLIENT_INSMOD_2(adm1025, ne1619);
74 * The ADM1025 registers
77 #define ADM1025_REG_MAN_ID 0x3E
78 #define ADM1025_REG_CHIP_ID 0x3F
79 #define ADM1025_REG_CONFIG 0x40
80 #define ADM1025_REG_STATUS1 0x41
81 #define ADM1025_REG_STATUS2 0x42
82 #define ADM1025_REG_IN(nr) (0x20 + (nr))
83 #define ADM1025_REG_IN_MAX(nr) (0x2B + (nr) * 2)
84 #define ADM1025_REG_IN_MIN(nr) (0x2C + (nr) * 2)
85 #define ADM1025_REG_TEMP(nr) (0x26 + (nr))
86 #define ADM1025_REG_TEMP_HIGH(nr) (0x37 + (nr) * 2)
87 #define ADM1025_REG_TEMP_LOW(nr) (0x38 + (nr) * 2)
88 #define ADM1025_REG_VID 0x47
89 #define ADM1025_REG_VID4 0x49
92 * Conversions and various macros
93 * The ADM1025 uses signed 8-bit values for temperatures.
96 static int in_scale[6] = { 2500, 2250, 3300, 5000, 12000, 3300 };
98 #define IN_FROM_REG(reg,scale) (((reg) * (scale) + 96) / 192)
99 #define IN_TO_REG(val,scale) ((val) <= 0 ? 0 : \
100 (val) * 192 >= (scale) * 255 ? 255 : \
101 ((val) * 192 + (scale)/2) / (scale))
103 #define TEMP_FROM_REG(reg) ((reg) * 1000)
104 #define TEMP_TO_REG(val) ((val) <= -127500 ? -128 : \
105 (val) >= 126500 ? 127 : \
106 (((val) < 0 ? (val)-500 : (val)+500) / 1000))
109 * Functions declaration
112 static int adm1025_attach_adapter(struct i2c_adapter *adapter);
113 static int adm1025_detect(struct i2c_adapter *adapter, int address, int kind);
114 static void adm1025_init_client(struct i2c_client *client);
115 static int adm1025_detach_client(struct i2c_client *client);
116 static struct adm1025_data *adm1025_update_device(struct device *dev);
119 * Driver data (common to all clients)
122 static struct i2c_driver adm1025_driver = {
126 .id = I2C_DRIVERID_ADM1025,
127 .attach_adapter = adm1025_attach_adapter,
128 .detach_client = adm1025_detach_client,
132 * Client data (each client gets its own)
135 struct adm1025_data {
136 struct i2c_client client;
137 struct device *hwmon_dev;
138 struct mutex update_lock;
139 char valid; /* zero until following fields are valid */
140 unsigned long last_updated; /* in jiffies */
142 u8 in[6]; /* register value */
143 u8 in_max[6]; /* register value */
144 u8 in_min[6]; /* register value */
145 s8 temp[2]; /* register value */
146 s8 temp_min[2]; /* register value */
147 s8 temp_max[2]; /* register value */
148 u16 alarms; /* register values, combined */
149 u8 vid; /* register values, combined */
158 show_in(struct device *dev, struct device_attribute *attr, char *buf)
160 int index = to_sensor_dev_attr(attr)->index;
161 struct adm1025_data *data = adm1025_update_device(dev);
162 return sprintf(buf, "%u\n", IN_FROM_REG(data->in[index],
167 show_in_min(struct device *dev, struct device_attribute *attr, char *buf)
169 int index = to_sensor_dev_attr(attr)->index;
170 struct adm1025_data *data = adm1025_update_device(dev);
171 return sprintf(buf, "%u\n", IN_FROM_REG(data->in_min[index],
176 show_in_max(struct device *dev, struct device_attribute *attr, char *buf)
178 int index = to_sensor_dev_attr(attr)->index;
179 struct adm1025_data *data = adm1025_update_device(dev);
180 return sprintf(buf, "%u\n", IN_FROM_REG(data->in_max[index],
185 show_temp(struct device *dev, struct device_attribute *attr, char *buf)
187 int index = to_sensor_dev_attr(attr)->index;
188 struct adm1025_data *data = adm1025_update_device(dev);
189 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[index]));
193 show_temp_min(struct device *dev, struct device_attribute *attr, char *buf)
195 int index = to_sensor_dev_attr(attr)->index;
196 struct adm1025_data *data = adm1025_update_device(dev);
197 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_min[index]));
201 show_temp_max(struct device *dev, struct device_attribute *attr, char *buf)
203 int index = to_sensor_dev_attr(attr)->index;
204 struct adm1025_data *data = adm1025_update_device(dev);
205 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_max[index]));
208 static ssize_t set_in_min(struct device *dev, struct device_attribute *attr,
209 const char *buf, size_t count)
211 int index = to_sensor_dev_attr(attr)->index;
212 struct i2c_client *client = to_i2c_client(dev);
213 struct adm1025_data *data = i2c_get_clientdata(client);
214 long val = simple_strtol(buf, NULL, 10);
216 mutex_lock(&data->update_lock);
217 data->in_min[index] = IN_TO_REG(val, in_scale[index]);
218 i2c_smbus_write_byte_data(client, ADM1025_REG_IN_MIN(index),
219 data->in_min[index]);
220 mutex_unlock(&data->update_lock);
224 static ssize_t set_in_max(struct device *dev, struct device_attribute *attr,
225 const char *buf, size_t count)
227 int index = to_sensor_dev_attr(attr)->index;
228 struct i2c_client *client = to_i2c_client(dev);
229 struct adm1025_data *data = i2c_get_clientdata(client);
230 long val = simple_strtol(buf, NULL, 10);
232 mutex_lock(&data->update_lock);
233 data->in_max[index] = IN_TO_REG(val, in_scale[index]);
234 i2c_smbus_write_byte_data(client, ADM1025_REG_IN_MAX(index),
235 data->in_max[index]);
236 mutex_unlock(&data->update_lock);
240 #define set_in(offset) \
241 static SENSOR_DEVICE_ATTR(in##offset##_input, S_IRUGO, \
242 show_in, NULL, offset); \
243 static SENSOR_DEVICE_ATTR(in##offset##_min, S_IWUSR | S_IRUGO, \
244 show_in_min, set_in_min, offset); \
245 static SENSOR_DEVICE_ATTR(in##offset##_max, S_IWUSR | S_IRUGO, \
246 show_in_max, set_in_max, offset)
254 static ssize_t set_temp_min(struct device *dev, struct device_attribute *attr,
255 const char *buf, size_t count)
257 int index = to_sensor_dev_attr(attr)->index;
258 struct i2c_client *client = to_i2c_client(dev);
259 struct adm1025_data *data = i2c_get_clientdata(client);
260 long val = simple_strtol(buf, NULL, 10);
262 mutex_lock(&data->update_lock);
263 data->temp_min[index] = TEMP_TO_REG(val);
264 i2c_smbus_write_byte_data(client, ADM1025_REG_TEMP_LOW(index),
265 data->temp_min[index]);
266 mutex_unlock(&data->update_lock);
270 static ssize_t set_temp_max(struct device *dev, struct device_attribute *attr,
271 const char *buf, size_t count)
273 int index = to_sensor_dev_attr(attr)->index;
274 struct i2c_client *client = to_i2c_client(dev);
275 struct adm1025_data *data = i2c_get_clientdata(client);
276 long val = simple_strtol(buf, NULL, 10);
278 mutex_lock(&data->update_lock);
279 data->temp_max[index] = TEMP_TO_REG(val);
280 i2c_smbus_write_byte_data(client, ADM1025_REG_TEMP_HIGH(index),
281 data->temp_max[index]);
282 mutex_unlock(&data->update_lock);
286 #define set_temp(offset) \
287 static SENSOR_DEVICE_ATTR(temp##offset##_input, S_IRUGO, \
288 show_temp, NULL, offset - 1); \
289 static SENSOR_DEVICE_ATTR(temp##offset##_min, S_IWUSR | S_IRUGO, \
290 show_temp_min, set_temp_min, offset - 1); \
291 static SENSOR_DEVICE_ATTR(temp##offset##_max, S_IWUSR | S_IRUGO, \
292 show_temp_max, set_temp_max, offset - 1)
296 static ssize_t show_alarms(struct device *dev, struct device_attribute *attr, char *buf)
298 struct adm1025_data *data = adm1025_update_device(dev);
299 return sprintf(buf, "%u\n", data->alarms);
301 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
304 show_alarm(struct device *dev, struct device_attribute *attr, char *buf)
306 int bitnr = to_sensor_dev_attr(attr)->index;
307 struct adm1025_data *data = adm1025_update_device(dev);
308 return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
310 static SENSOR_DEVICE_ATTR(in0_alarm, S_IRUGO, show_alarm, NULL, 0);
311 static SENSOR_DEVICE_ATTR(in1_alarm, S_IRUGO, show_alarm, NULL, 1);
312 static SENSOR_DEVICE_ATTR(in2_alarm, S_IRUGO, show_alarm, NULL, 2);
313 static SENSOR_DEVICE_ATTR(in3_alarm, S_IRUGO, show_alarm, NULL, 3);
314 static SENSOR_DEVICE_ATTR(in4_alarm, S_IRUGO, show_alarm, NULL, 8);
315 static SENSOR_DEVICE_ATTR(in5_alarm, S_IRUGO, show_alarm, NULL, 9);
316 static SENSOR_DEVICE_ATTR(temp1_alarm, S_IRUGO, show_alarm, NULL, 5);
317 static SENSOR_DEVICE_ATTR(temp2_alarm, S_IRUGO, show_alarm, NULL, 4);
318 static SENSOR_DEVICE_ATTR(temp1_fault, S_IRUGO, show_alarm, NULL, 14);
320 static ssize_t show_vid(struct device *dev, struct device_attribute *attr, char *buf)
322 struct adm1025_data *data = adm1025_update_device(dev);
323 return sprintf(buf, "%u\n", vid_from_reg(data->vid, data->vrm));
325 static DEVICE_ATTR(cpu0_vid, S_IRUGO, show_vid, NULL);
327 static ssize_t show_vrm(struct device *dev, struct device_attribute *attr, char *buf)
329 struct adm1025_data *data = dev_get_drvdata(dev);
330 return sprintf(buf, "%u\n", data->vrm);
332 static ssize_t set_vrm(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
334 struct i2c_client *client = to_i2c_client(dev);
335 struct adm1025_data *data = i2c_get_clientdata(client);
336 data->vrm = simple_strtoul(buf, NULL, 10);
339 static DEVICE_ATTR(vrm, S_IRUGO | S_IWUSR, show_vrm, set_vrm);
345 static int adm1025_attach_adapter(struct i2c_adapter *adapter)
347 if (!(adapter->class & I2C_CLASS_HWMON))
349 return i2c_probe(adapter, &addr_data, adm1025_detect);
352 static struct attribute *adm1025_attributes[] = {
353 &sensor_dev_attr_in0_input.dev_attr.attr,
354 &sensor_dev_attr_in1_input.dev_attr.attr,
355 &sensor_dev_attr_in2_input.dev_attr.attr,
356 &sensor_dev_attr_in3_input.dev_attr.attr,
357 &sensor_dev_attr_in5_input.dev_attr.attr,
358 &sensor_dev_attr_in0_min.dev_attr.attr,
359 &sensor_dev_attr_in1_min.dev_attr.attr,
360 &sensor_dev_attr_in2_min.dev_attr.attr,
361 &sensor_dev_attr_in3_min.dev_attr.attr,
362 &sensor_dev_attr_in5_min.dev_attr.attr,
363 &sensor_dev_attr_in0_max.dev_attr.attr,
364 &sensor_dev_attr_in1_max.dev_attr.attr,
365 &sensor_dev_attr_in2_max.dev_attr.attr,
366 &sensor_dev_attr_in3_max.dev_attr.attr,
367 &sensor_dev_attr_in5_max.dev_attr.attr,
368 &sensor_dev_attr_in0_alarm.dev_attr.attr,
369 &sensor_dev_attr_in1_alarm.dev_attr.attr,
370 &sensor_dev_attr_in2_alarm.dev_attr.attr,
371 &sensor_dev_attr_in3_alarm.dev_attr.attr,
372 &sensor_dev_attr_in5_alarm.dev_attr.attr,
373 &sensor_dev_attr_temp1_input.dev_attr.attr,
374 &sensor_dev_attr_temp2_input.dev_attr.attr,
375 &sensor_dev_attr_temp1_min.dev_attr.attr,
376 &sensor_dev_attr_temp2_min.dev_attr.attr,
377 &sensor_dev_attr_temp1_max.dev_attr.attr,
378 &sensor_dev_attr_temp2_max.dev_attr.attr,
379 &sensor_dev_attr_temp1_alarm.dev_attr.attr,
380 &sensor_dev_attr_temp2_alarm.dev_attr.attr,
381 &sensor_dev_attr_temp1_fault.dev_attr.attr,
382 &dev_attr_alarms.attr,
383 &dev_attr_cpu0_vid.attr,
388 static const struct attribute_group adm1025_group = {
389 .attrs = adm1025_attributes,
392 static struct attribute *adm1025_attributes_opt[] = {
393 &sensor_dev_attr_in4_input.dev_attr.attr,
394 &sensor_dev_attr_in4_min.dev_attr.attr,
395 &sensor_dev_attr_in4_max.dev_attr.attr,
396 &sensor_dev_attr_in4_alarm.dev_attr.attr,
400 static const struct attribute_group adm1025_group_opt = {
401 .attrs = adm1025_attributes_opt,
405 * The following function does more than just detection. If detection
406 * succeeds, it also registers the new chip.
408 static int adm1025_detect(struct i2c_adapter *adapter, int address, int kind)
410 struct i2c_client *new_client;
411 struct adm1025_data *data;
413 const char *name = "";
416 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
419 if (!(data = kzalloc(sizeof(struct adm1025_data), GFP_KERNEL))) {
424 /* The common I2C client data is placed right before the
425 ADM1025-specific data. */
426 new_client = &data->client;
427 i2c_set_clientdata(new_client, data);
428 new_client->addr = address;
429 new_client->adapter = adapter;
430 new_client->driver = &adm1025_driver;
431 new_client->flags = 0;
434 * Now we do the remaining detection. A negative kind means that
435 * the driver was loaded with no force parameter (default), so we
436 * must both detect and identify the chip. A zero kind means that
437 * the driver was loaded with the force parameter, the detection
438 * step shall be skipped. A positive kind means that the driver
439 * was loaded with the force parameter and a given kind of chip is
440 * requested, so both the detection and the identification steps
443 config = i2c_smbus_read_byte_data(new_client, ADM1025_REG_CONFIG);
444 if (kind < 0) { /* detection */
445 if ((config & 0x80) != 0x00
446 || (i2c_smbus_read_byte_data(new_client,
447 ADM1025_REG_STATUS1) & 0xC0) != 0x00
448 || (i2c_smbus_read_byte_data(new_client,
449 ADM1025_REG_STATUS2) & 0xBC) != 0x00) {
450 dev_dbg(&adapter->dev,
451 "ADM1025 detection failed at 0x%02x.\n",
457 if (kind <= 0) { /* identification */
460 man_id = i2c_smbus_read_byte_data(new_client,
462 chip_id = i2c_smbus_read_byte_data(new_client,
463 ADM1025_REG_CHIP_ID);
465 if (man_id == 0x41) { /* Analog Devices */
466 if ((chip_id & 0xF0) == 0x20) { /* ADM1025/ADM1025A */
470 if (man_id == 0xA1) { /* Philips */
472 && (chip_id & 0xF0) == 0x20) { /* NE1619 */
477 if (kind <= 0) { /* identification failed */
478 dev_info(&adapter->dev,
479 "Unsupported chip (man_id=0x%02X, "
480 "chip_id=0x%02X).\n", man_id, chip_id);
485 if (kind == adm1025) {
487 } else if (kind == ne1619) {
491 /* We can fill in the remaining client fields */
492 strlcpy(new_client->name, name, I2C_NAME_SIZE);
494 mutex_init(&data->update_lock);
496 /* Tell the I2C layer a new client has arrived */
497 if ((err = i2c_attach_client(new_client)))
500 /* Initialize the ADM1025 chip */
501 adm1025_init_client(new_client);
503 /* Register sysfs hooks */
504 if ((err = sysfs_create_group(&new_client->dev.kobj, &adm1025_group)))
507 /* Pin 11 is either in4 (+12V) or VID4 */
508 if (!(config & 0x20)) {
509 if ((err = device_create_file(&new_client->dev,
510 &sensor_dev_attr_in4_input.dev_attr))
511 || (err = device_create_file(&new_client->dev,
512 &sensor_dev_attr_in4_min.dev_attr))
513 || (err = device_create_file(&new_client->dev,
514 &sensor_dev_attr_in4_max.dev_attr))
515 || (err = device_create_file(&new_client->dev,
516 &sensor_dev_attr_in4_alarm.dev_attr)))
520 data->hwmon_dev = hwmon_device_register(&new_client->dev);
521 if (IS_ERR(data->hwmon_dev)) {
522 err = PTR_ERR(data->hwmon_dev);
529 sysfs_remove_group(&new_client->dev.kobj, &adm1025_group);
530 sysfs_remove_group(&new_client->dev.kobj, &adm1025_group_opt);
532 i2c_detach_client(new_client);
539 static void adm1025_init_client(struct i2c_client *client)
542 struct adm1025_data *data = i2c_get_clientdata(client);
545 data->vrm = vid_which_vrm();
549 * Usually we avoid setting limits on driver init, but it happens
550 * that the ADM1025 comes with stupid default limits (all registers
551 * set to 0). In case the chip has not gone through any limit
552 * setting yet, we better set the high limits to the max so that
555 for (i=0; i<6; i++) {
556 reg = i2c_smbus_read_byte_data(client,
557 ADM1025_REG_IN_MAX(i));
559 i2c_smbus_write_byte_data(client,
560 ADM1025_REG_IN_MAX(i),
563 for (i=0; i<2; i++) {
564 reg = i2c_smbus_read_byte_data(client,
565 ADM1025_REG_TEMP_HIGH(i));
567 i2c_smbus_write_byte_data(client,
568 ADM1025_REG_TEMP_HIGH(i),
573 * Start the conversions
575 reg = i2c_smbus_read_byte_data(client, ADM1025_REG_CONFIG);
577 i2c_smbus_write_byte_data(client, ADM1025_REG_CONFIG,
581 static int adm1025_detach_client(struct i2c_client *client)
583 struct adm1025_data *data = i2c_get_clientdata(client);
586 hwmon_device_unregister(data->hwmon_dev);
587 sysfs_remove_group(&client->dev.kobj, &adm1025_group);
588 sysfs_remove_group(&client->dev.kobj, &adm1025_group_opt);
590 if ((err = i2c_detach_client(client)))
597 static struct adm1025_data *adm1025_update_device(struct device *dev)
599 struct i2c_client *client = to_i2c_client(dev);
600 struct adm1025_data *data = i2c_get_clientdata(client);
602 mutex_lock(&data->update_lock);
604 if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) {
607 dev_dbg(&client->dev, "Updating data.\n");
608 for (i=0; i<6; i++) {
609 data->in[i] = i2c_smbus_read_byte_data(client,
611 data->in_min[i] = i2c_smbus_read_byte_data(client,
612 ADM1025_REG_IN_MIN(i));
613 data->in_max[i] = i2c_smbus_read_byte_data(client,
614 ADM1025_REG_IN_MAX(i));
616 for (i=0; i<2; i++) {
617 data->temp[i] = i2c_smbus_read_byte_data(client,
618 ADM1025_REG_TEMP(i));
619 data->temp_min[i] = i2c_smbus_read_byte_data(client,
620 ADM1025_REG_TEMP_LOW(i));
621 data->temp_max[i] = i2c_smbus_read_byte_data(client,
622 ADM1025_REG_TEMP_HIGH(i));
624 data->alarms = i2c_smbus_read_byte_data(client,
626 | (i2c_smbus_read_byte_data(client,
627 ADM1025_REG_STATUS2) << 8);
628 data->vid = (i2c_smbus_read_byte_data(client,
629 ADM1025_REG_VID) & 0x0f)
630 | ((i2c_smbus_read_byte_data(client,
631 ADM1025_REG_VID4) & 0x01) << 4);
633 data->last_updated = jiffies;
637 mutex_unlock(&data->update_lock);
642 static int __init sensors_adm1025_init(void)
644 return i2c_add_driver(&adm1025_driver);
647 static void __exit sensors_adm1025_exit(void)
649 i2c_del_driver(&adm1025_driver);
652 MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>");
653 MODULE_DESCRIPTION("ADM1025 driver");
654 MODULE_LICENSE("GPL");
656 module_init(sensors_adm1025_init);
657 module_exit(sensors_adm1025_exit);