4 * Copyright (C) 2000 Chen-Yuan Wu <gwu@esoft.com>
5 * Copyright (C) 2003-2009 Jean Delvare <jdelvare@suse.de>
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.onsemi.com/PowerSolutions/product.do?id=ADM1025
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 const unsigned short normal_i2c[] = { 0x2c, 0x2d, 0x2e, I2C_CLIENT_END };
67 enum chips { adm1025, ne1619 };
70 * The ADM1025 registers
73 #define ADM1025_REG_MAN_ID 0x3E
74 #define ADM1025_REG_CHIP_ID 0x3F
75 #define ADM1025_REG_CONFIG 0x40
76 #define ADM1025_REG_STATUS1 0x41
77 #define ADM1025_REG_STATUS2 0x42
78 #define ADM1025_REG_IN(nr) (0x20 + (nr))
79 #define ADM1025_REG_IN_MAX(nr) (0x2B + (nr) * 2)
80 #define ADM1025_REG_IN_MIN(nr) (0x2C + (nr) * 2)
81 #define ADM1025_REG_TEMP(nr) (0x26 + (nr))
82 #define ADM1025_REG_TEMP_HIGH(nr) (0x37 + (nr) * 2)
83 #define ADM1025_REG_TEMP_LOW(nr) (0x38 + (nr) * 2)
84 #define ADM1025_REG_VID 0x47
85 #define ADM1025_REG_VID4 0x49
88 * Conversions and various macros
89 * The ADM1025 uses signed 8-bit values for temperatures.
92 static const int in_scale[6] = { 2500, 2250, 3300, 5000, 12000, 3300 };
94 #define IN_FROM_REG(reg, scale) (((reg) * (scale) + 96) / 192)
95 #define IN_TO_REG(val, scale) ((val) <= 0 ? 0 : \
96 (val) * 192 >= (scale) * 255 ? 255 : \
97 ((val) * 192 + (scale) / 2) / (scale))
99 #define TEMP_FROM_REG(reg) ((reg) * 1000)
100 #define TEMP_TO_REG(val) ((val) <= -127500 ? -128 : \
101 (val) >= 126500 ? 127 : \
102 (((val) < 0 ? (val) - 500 : \
103 (val) + 500) / 1000))
106 * Client data (each client gets its own)
109 struct adm1025_data {
110 struct i2c_client *client;
111 const struct attribute_group *groups[3];
112 struct mutex update_lock;
113 char valid; /* zero until following fields are valid */
114 unsigned long last_updated; /* in jiffies */
116 u8 in[6]; /* register value */
117 u8 in_max[6]; /* register value */
118 u8 in_min[6]; /* register value */
119 s8 temp[2]; /* register value */
120 s8 temp_min[2]; /* register value */
121 s8 temp_max[2]; /* register value */
122 u16 alarms; /* register values, combined */
123 u8 vid; /* register values, combined */
127 static struct adm1025_data *adm1025_update_device(struct device *dev)
129 struct adm1025_data *data = dev_get_drvdata(dev);
130 struct i2c_client *client = data->client;
132 mutex_lock(&data->update_lock);
134 if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) {
137 dev_dbg(&client->dev, "Updating data.\n");
138 for (i = 0; i < 6; i++) {
139 data->in[i] = i2c_smbus_read_byte_data(client,
141 data->in_min[i] = i2c_smbus_read_byte_data(client,
142 ADM1025_REG_IN_MIN(i));
143 data->in_max[i] = i2c_smbus_read_byte_data(client,
144 ADM1025_REG_IN_MAX(i));
146 for (i = 0; i < 2; i++) {
147 data->temp[i] = i2c_smbus_read_byte_data(client,
148 ADM1025_REG_TEMP(i));
149 data->temp_min[i] = i2c_smbus_read_byte_data(client,
150 ADM1025_REG_TEMP_LOW(i));
151 data->temp_max[i] = i2c_smbus_read_byte_data(client,
152 ADM1025_REG_TEMP_HIGH(i));
154 data->alarms = i2c_smbus_read_byte_data(client,
156 | (i2c_smbus_read_byte_data(client,
157 ADM1025_REG_STATUS2) << 8);
158 data->vid = (i2c_smbus_read_byte_data(client,
159 ADM1025_REG_VID) & 0x0f)
160 | ((i2c_smbus_read_byte_data(client,
161 ADM1025_REG_VID4) & 0x01) << 4);
163 data->last_updated = jiffies;
167 mutex_unlock(&data->update_lock);
177 show_in(struct device *dev, struct device_attribute *attr, char *buf)
179 int index = to_sensor_dev_attr(attr)->index;
180 struct adm1025_data *data = adm1025_update_device(dev);
181 return sprintf(buf, "%u\n", IN_FROM_REG(data->in[index],
186 show_in_min(struct device *dev, struct device_attribute *attr, char *buf)
188 int index = to_sensor_dev_attr(attr)->index;
189 struct adm1025_data *data = adm1025_update_device(dev);
190 return sprintf(buf, "%u\n", IN_FROM_REG(data->in_min[index],
195 show_in_max(struct device *dev, struct device_attribute *attr, char *buf)
197 int index = to_sensor_dev_attr(attr)->index;
198 struct adm1025_data *data = adm1025_update_device(dev);
199 return sprintf(buf, "%u\n", IN_FROM_REG(data->in_max[index],
204 show_temp(struct device *dev, struct device_attribute *attr, char *buf)
206 int index = to_sensor_dev_attr(attr)->index;
207 struct adm1025_data *data = adm1025_update_device(dev);
208 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[index]));
212 show_temp_min(struct device *dev, struct device_attribute *attr, char *buf)
214 int index = to_sensor_dev_attr(attr)->index;
215 struct adm1025_data *data = adm1025_update_device(dev);
216 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_min[index]));
220 show_temp_max(struct device *dev, struct device_attribute *attr, char *buf)
222 int index = to_sensor_dev_attr(attr)->index;
223 struct adm1025_data *data = adm1025_update_device(dev);
224 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_max[index]));
227 static ssize_t set_in_min(struct device *dev, struct device_attribute *attr,
228 const char *buf, size_t count)
230 int index = to_sensor_dev_attr(attr)->index;
231 struct adm1025_data *data = dev_get_drvdata(dev);
232 struct i2c_client *client = data->client;
236 err = kstrtol(buf, 10, &val);
240 mutex_lock(&data->update_lock);
241 data->in_min[index] = IN_TO_REG(val, in_scale[index]);
242 i2c_smbus_write_byte_data(client, ADM1025_REG_IN_MIN(index),
243 data->in_min[index]);
244 mutex_unlock(&data->update_lock);
248 static ssize_t set_in_max(struct device *dev, struct device_attribute *attr,
249 const char *buf, size_t count)
251 int index = to_sensor_dev_attr(attr)->index;
252 struct adm1025_data *data = dev_get_drvdata(dev);
253 struct i2c_client *client = data->client;
257 err = kstrtol(buf, 10, &val);
261 mutex_lock(&data->update_lock);
262 data->in_max[index] = IN_TO_REG(val, in_scale[index]);
263 i2c_smbus_write_byte_data(client, ADM1025_REG_IN_MAX(index),
264 data->in_max[index]);
265 mutex_unlock(&data->update_lock);
269 #define set_in(offset) \
270 static SENSOR_DEVICE_ATTR(in##offset##_input, S_IRUGO, \
271 show_in, NULL, offset); \
272 static SENSOR_DEVICE_ATTR(in##offset##_min, S_IWUSR | S_IRUGO, \
273 show_in_min, set_in_min, offset); \
274 static SENSOR_DEVICE_ATTR(in##offset##_max, S_IWUSR | S_IRUGO, \
275 show_in_max, set_in_max, offset)
283 static ssize_t set_temp_min(struct device *dev, struct device_attribute *attr,
284 const char *buf, size_t count)
286 int index = to_sensor_dev_attr(attr)->index;
287 struct adm1025_data *data = dev_get_drvdata(dev);
288 struct i2c_client *client = data->client;
292 err = kstrtol(buf, 10, &val);
296 mutex_lock(&data->update_lock);
297 data->temp_min[index] = TEMP_TO_REG(val);
298 i2c_smbus_write_byte_data(client, ADM1025_REG_TEMP_LOW(index),
299 data->temp_min[index]);
300 mutex_unlock(&data->update_lock);
304 static ssize_t set_temp_max(struct device *dev, struct device_attribute *attr,
305 const char *buf, size_t count)
307 int index = to_sensor_dev_attr(attr)->index;
308 struct adm1025_data *data = dev_get_drvdata(dev);
309 struct i2c_client *client = data->client;
313 err = kstrtol(buf, 10, &val);
317 mutex_lock(&data->update_lock);
318 data->temp_max[index] = TEMP_TO_REG(val);
319 i2c_smbus_write_byte_data(client, ADM1025_REG_TEMP_HIGH(index),
320 data->temp_max[index]);
321 mutex_unlock(&data->update_lock);
325 #define set_temp(offset) \
326 static SENSOR_DEVICE_ATTR(temp##offset##_input, S_IRUGO, \
327 show_temp, NULL, offset - 1); \
328 static SENSOR_DEVICE_ATTR(temp##offset##_min, S_IWUSR | S_IRUGO, \
329 show_temp_min, set_temp_min, offset - 1); \
330 static SENSOR_DEVICE_ATTR(temp##offset##_max, S_IWUSR | S_IRUGO, \
331 show_temp_max, set_temp_max, offset - 1)
336 show_alarms(struct device *dev, struct device_attribute *attr, char *buf)
338 struct adm1025_data *data = adm1025_update_device(dev);
339 return sprintf(buf, "%u\n", data->alarms);
341 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
344 show_alarm(struct device *dev, struct device_attribute *attr, char *buf)
346 int bitnr = to_sensor_dev_attr(attr)->index;
347 struct adm1025_data *data = adm1025_update_device(dev);
348 return sprintf(buf, "%u\n", (data->alarms >> bitnr) & 1);
350 static SENSOR_DEVICE_ATTR(in0_alarm, S_IRUGO, show_alarm, NULL, 0);
351 static SENSOR_DEVICE_ATTR(in1_alarm, S_IRUGO, show_alarm, NULL, 1);
352 static SENSOR_DEVICE_ATTR(in2_alarm, S_IRUGO, show_alarm, NULL, 2);
353 static SENSOR_DEVICE_ATTR(in3_alarm, S_IRUGO, show_alarm, NULL, 3);
354 static SENSOR_DEVICE_ATTR(in4_alarm, S_IRUGO, show_alarm, NULL, 8);
355 static SENSOR_DEVICE_ATTR(in5_alarm, S_IRUGO, show_alarm, NULL, 9);
356 static SENSOR_DEVICE_ATTR(temp1_alarm, S_IRUGO, show_alarm, NULL, 5);
357 static SENSOR_DEVICE_ATTR(temp2_alarm, S_IRUGO, show_alarm, NULL, 4);
358 static SENSOR_DEVICE_ATTR(temp1_fault, S_IRUGO, show_alarm, NULL, 14);
361 show_vid(struct device *dev, struct device_attribute *attr, char *buf)
363 struct adm1025_data *data = adm1025_update_device(dev);
364 return sprintf(buf, "%u\n", vid_from_reg(data->vid, data->vrm));
366 static DEVICE_ATTR(cpu0_vid, S_IRUGO, show_vid, NULL);
369 show_vrm(struct device *dev, struct device_attribute *attr, char *buf)
371 struct adm1025_data *data = dev_get_drvdata(dev);
372 return sprintf(buf, "%u\n", data->vrm);
374 static ssize_t set_vrm(struct device *dev, struct device_attribute *attr,
375 const char *buf, size_t count)
377 struct adm1025_data *data = dev_get_drvdata(dev);
381 err = kstrtoul(buf, 10, &val);
388 static DEVICE_ATTR(vrm, S_IRUGO | S_IWUSR, show_vrm, set_vrm);
394 static struct attribute *adm1025_attributes[] = {
395 &sensor_dev_attr_in0_input.dev_attr.attr,
396 &sensor_dev_attr_in1_input.dev_attr.attr,
397 &sensor_dev_attr_in2_input.dev_attr.attr,
398 &sensor_dev_attr_in3_input.dev_attr.attr,
399 &sensor_dev_attr_in5_input.dev_attr.attr,
400 &sensor_dev_attr_in0_min.dev_attr.attr,
401 &sensor_dev_attr_in1_min.dev_attr.attr,
402 &sensor_dev_attr_in2_min.dev_attr.attr,
403 &sensor_dev_attr_in3_min.dev_attr.attr,
404 &sensor_dev_attr_in5_min.dev_attr.attr,
405 &sensor_dev_attr_in0_max.dev_attr.attr,
406 &sensor_dev_attr_in1_max.dev_attr.attr,
407 &sensor_dev_attr_in2_max.dev_attr.attr,
408 &sensor_dev_attr_in3_max.dev_attr.attr,
409 &sensor_dev_attr_in5_max.dev_attr.attr,
410 &sensor_dev_attr_in0_alarm.dev_attr.attr,
411 &sensor_dev_attr_in1_alarm.dev_attr.attr,
412 &sensor_dev_attr_in2_alarm.dev_attr.attr,
413 &sensor_dev_attr_in3_alarm.dev_attr.attr,
414 &sensor_dev_attr_in5_alarm.dev_attr.attr,
415 &sensor_dev_attr_temp1_input.dev_attr.attr,
416 &sensor_dev_attr_temp2_input.dev_attr.attr,
417 &sensor_dev_attr_temp1_min.dev_attr.attr,
418 &sensor_dev_attr_temp2_min.dev_attr.attr,
419 &sensor_dev_attr_temp1_max.dev_attr.attr,
420 &sensor_dev_attr_temp2_max.dev_attr.attr,
421 &sensor_dev_attr_temp1_alarm.dev_attr.attr,
422 &sensor_dev_attr_temp2_alarm.dev_attr.attr,
423 &sensor_dev_attr_temp1_fault.dev_attr.attr,
424 &dev_attr_alarms.attr,
425 &dev_attr_cpu0_vid.attr,
430 static const struct attribute_group adm1025_group = {
431 .attrs = adm1025_attributes,
434 static struct attribute *adm1025_attributes_in4[] = {
435 &sensor_dev_attr_in4_input.dev_attr.attr,
436 &sensor_dev_attr_in4_min.dev_attr.attr,
437 &sensor_dev_attr_in4_max.dev_attr.attr,
438 &sensor_dev_attr_in4_alarm.dev_attr.attr,
442 static const struct attribute_group adm1025_group_in4 = {
443 .attrs = adm1025_attributes_in4,
446 /* Return 0 if detection is successful, -ENODEV otherwise */
447 static int adm1025_detect(struct i2c_client *client,
448 struct i2c_board_info *info)
450 struct i2c_adapter *adapter = client->adapter;
454 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
457 /* Check for unused bits */
458 if ((i2c_smbus_read_byte_data(client, ADM1025_REG_CONFIG) & 0x80)
459 || (i2c_smbus_read_byte_data(client, ADM1025_REG_STATUS1) & 0xC0)
460 || (i2c_smbus_read_byte_data(client, ADM1025_REG_STATUS2) & 0xBC)) {
461 dev_dbg(&adapter->dev, "ADM1025 detection failed at 0x%02x\n",
467 chip_id = i2c_smbus_read_byte_data(client, ADM1025_REG_CHIP_ID);
468 if ((chip_id & 0xF0) != 0x20)
471 man_id = i2c_smbus_read_byte_data(client, ADM1025_REG_MAN_ID);
474 else if (man_id == 0xA1 && client->addr != 0x2E)
479 strlcpy(info->type, name, I2C_NAME_SIZE);
484 static void adm1025_init_client(struct i2c_client *client)
487 struct adm1025_data *data = i2c_get_clientdata(client);
490 data->vrm = vid_which_vrm();
494 * Usually we avoid setting limits on driver init, but it happens
495 * that the ADM1025 comes with stupid default limits (all registers
496 * set to 0). In case the chip has not gone through any limit
497 * setting yet, we better set the high limits to the max so that
500 for (i = 0; i < 6; i++) {
501 reg = i2c_smbus_read_byte_data(client,
502 ADM1025_REG_IN_MAX(i));
504 i2c_smbus_write_byte_data(client,
505 ADM1025_REG_IN_MAX(i),
508 for (i = 0; i < 2; i++) {
509 reg = i2c_smbus_read_byte_data(client,
510 ADM1025_REG_TEMP_HIGH(i));
512 i2c_smbus_write_byte_data(client,
513 ADM1025_REG_TEMP_HIGH(i),
518 * Start the conversions
520 reg = i2c_smbus_read_byte_data(client, ADM1025_REG_CONFIG);
522 i2c_smbus_write_byte_data(client, ADM1025_REG_CONFIG,
526 static int adm1025_probe(struct i2c_client *client,
527 const struct i2c_device_id *id)
529 struct device *dev = &client->dev;
530 struct device *hwmon_dev;
531 struct adm1025_data *data;
534 data = devm_kzalloc(dev, sizeof(struct adm1025_data), GFP_KERNEL);
538 i2c_set_clientdata(client, data);
539 data->client = client;
540 mutex_init(&data->update_lock);
542 /* Initialize the ADM1025 chip */
543 adm1025_init_client(client);
546 data->groups[0] = &adm1025_group;
547 /* Pin 11 is either in4 (+12V) or VID4 */
548 config = i2c_smbus_read_byte_data(client, ADM1025_REG_CONFIG);
549 if (!(config & 0x20))
550 data->groups[1] = &adm1025_group_in4;
552 hwmon_dev = devm_hwmon_device_register_with_groups(dev, client->name,
554 return PTR_ERR_OR_ZERO(hwmon_dev);
557 static const struct i2c_device_id adm1025_id[] = {
558 { "adm1025", adm1025 },
559 { "ne1619", ne1619 },
562 MODULE_DEVICE_TABLE(i2c, adm1025_id);
564 static struct i2c_driver adm1025_driver = {
565 .class = I2C_CLASS_HWMON,
569 .probe = adm1025_probe,
570 .id_table = adm1025_id,
571 .detect = adm1025_detect,
572 .address_list = normal_i2c,
575 module_i2c_driver(adm1025_driver);
577 MODULE_AUTHOR("Jean Delvare <jdelvare@suse.de>");
578 MODULE_DESCRIPTION("ADM1025 driver");
579 MODULE_LICENSE("GPL");