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/i2c-sensor.h>
54 #include <linux/i2c-vid.h>
55 #include <linux/hwmon.h>
56 #include <linux/err.h>
60 * ADM1025 and ADM1025A have three possible addresses: 0x2c, 0x2d and 0x2e.
61 * NE1619 has two possible addresses: 0x2c and 0x2d.
64 static unsigned short normal_i2c
[] = { 0x2c, 0x2d, 0x2e, I2C_CLIENT_END
};
65 static unsigned int normal_isa
[] = { I2C_CLIENT_ISA_END
};
71 SENSORS_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
= {
123 .owner
= THIS_MODULE
,
125 .id
= I2C_DRIVERID_ADM1025
,
126 .flags
= I2C_DF_NOTIFY
,
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 class_device
*class_dev
;
138 struct semaphore 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 */
157 #define show_in(offset) \
158 static ssize_t show_in##offset(struct device *dev, struct device_attribute *attr, char *buf) \
160 struct adm1025_data *data = adm1025_update_device(dev); \
161 return sprintf(buf, "%u\n", IN_FROM_REG(data->in[offset], \
162 in_scale[offset])); \
164 static ssize_t show_in##offset##_min(struct device *dev, struct device_attribute *attr, char *buf) \
166 struct adm1025_data *data = adm1025_update_device(dev); \
167 return sprintf(buf, "%u\n", IN_FROM_REG(data->in_min[offset], \
168 in_scale[offset])); \
170 static ssize_t show_in##offset##_max(struct device *dev, struct device_attribute *attr, char *buf) \
172 struct adm1025_data *data = adm1025_update_device(dev); \
173 return sprintf(buf, "%u\n", IN_FROM_REG(data->in_max[offset], \
174 in_scale[offset])); \
176 static DEVICE_ATTR(in##offset##_input, S_IRUGO, show_in##offset, NULL);
184 #define show_temp(offset) \
185 static ssize_t show_temp##offset(struct device *dev, struct device_attribute *attr, char *buf) \
187 struct adm1025_data *data = adm1025_update_device(dev); \
188 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[offset-1])); \
190 static ssize_t show_temp##offset##_min(struct device *dev, struct device_attribute *attr, char *buf) \
192 struct adm1025_data *data = adm1025_update_device(dev); \
193 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_min[offset-1])); \
195 static ssize_t show_temp##offset##_max(struct device *dev, struct device_attribute *attr, char *buf) \
197 struct adm1025_data *data = adm1025_update_device(dev); \
198 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_max[offset-1])); \
200 static DEVICE_ATTR(temp##offset##_input, S_IRUGO, show_temp##offset, NULL);
204 #define set_in(offset) \
205 static ssize_t set_in##offset##_min(struct device *dev, struct device_attribute *attr, const char *buf, \
208 struct i2c_client *client = to_i2c_client(dev); \
209 struct adm1025_data *data = i2c_get_clientdata(client); \
210 long val = simple_strtol(buf, NULL, 10); \
212 down(&data->update_lock); \
213 data->in_min[offset] = IN_TO_REG(val, in_scale[offset]); \
214 i2c_smbus_write_byte_data(client, ADM1025_REG_IN_MIN(offset), \
215 data->in_min[offset]); \
216 up(&data->update_lock); \
219 static ssize_t set_in##offset##_max(struct device *dev, struct device_attribute *attr, const char *buf, \
222 struct i2c_client *client = to_i2c_client(dev); \
223 struct adm1025_data *data = i2c_get_clientdata(client); \
224 long val = simple_strtol(buf, NULL, 10); \
226 down(&data->update_lock); \
227 data->in_max[offset] = IN_TO_REG(val, in_scale[offset]); \
228 i2c_smbus_write_byte_data(client, ADM1025_REG_IN_MAX(offset), \
229 data->in_max[offset]); \
230 up(&data->update_lock); \
233 static DEVICE_ATTR(in##offset##_min, S_IWUSR | S_IRUGO, \
234 show_in##offset##_min, set_in##offset##_min); \
235 static DEVICE_ATTR(in##offset##_max, S_IWUSR | S_IRUGO, \
236 show_in##offset##_max, set_in##offset##_max);
244 #define set_temp(offset) \
245 static ssize_t set_temp##offset##_min(struct device *dev, struct device_attribute *attr, const char *buf, \
248 struct i2c_client *client = to_i2c_client(dev); \
249 struct adm1025_data *data = i2c_get_clientdata(client); \
250 long val = simple_strtol(buf, NULL, 10); \
252 down(&data->update_lock); \
253 data->temp_min[offset-1] = TEMP_TO_REG(val); \
254 i2c_smbus_write_byte_data(client, ADM1025_REG_TEMP_LOW(offset-1), \
255 data->temp_min[offset-1]); \
256 up(&data->update_lock); \
259 static ssize_t set_temp##offset##_max(struct device *dev, struct device_attribute *attr, const char *buf, \
262 struct i2c_client *client = to_i2c_client(dev); \
263 struct adm1025_data *data = i2c_get_clientdata(client); \
264 long val = simple_strtol(buf, NULL, 10); \
266 down(&data->update_lock); \
267 data->temp_max[offset-1] = TEMP_TO_REG(val); \
268 i2c_smbus_write_byte_data(client, ADM1025_REG_TEMP_HIGH(offset-1), \
269 data->temp_max[offset-1]); \
270 up(&data->update_lock); \
273 static DEVICE_ATTR(temp##offset##_min, S_IWUSR | S_IRUGO, \
274 show_temp##offset##_min, set_temp##offset##_min); \
275 static DEVICE_ATTR(temp##offset##_max, S_IWUSR | S_IRUGO, \
276 show_temp##offset##_max, set_temp##offset##_max);
280 static ssize_t
show_alarms(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
282 struct adm1025_data
*data
= adm1025_update_device(dev
);
283 return sprintf(buf
, "%u\n", data
->alarms
);
285 static DEVICE_ATTR(alarms
, S_IRUGO
, show_alarms
, NULL
);
287 static ssize_t
show_vid(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
289 struct adm1025_data
*data
= adm1025_update_device(dev
);
290 return sprintf(buf
, "%u\n", vid_from_reg(data
->vid
, data
->vrm
));
292 /* in1_ref is deprecated in favour of cpu0_vid, remove after 2005-11-11 */
293 static DEVICE_ATTR(in1_ref
, S_IRUGO
, show_vid
, NULL
);
294 static DEVICE_ATTR(cpu0_vid
, S_IRUGO
, show_vid
, NULL
);
296 static ssize_t
show_vrm(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
->vrm
);
301 static ssize_t
set_vrm(struct device
*dev
, struct device_attribute
*attr
, const char *buf
, size_t count
)
303 struct i2c_client
*client
= to_i2c_client(dev
);
304 struct adm1025_data
*data
= i2c_get_clientdata(client
);
305 data
->vrm
= simple_strtoul(buf
, NULL
, 10);
308 static DEVICE_ATTR(vrm
, S_IRUGO
| S_IWUSR
, show_vrm
, set_vrm
);
314 static int adm1025_attach_adapter(struct i2c_adapter
*adapter
)
316 if (!(adapter
->class & I2C_CLASS_HWMON
))
318 return i2c_detect(adapter
, &addr_data
, adm1025_detect
);
322 * The following function does more than just detection. If detection
323 * succeeds, it also registers the new chip.
325 static int adm1025_detect(struct i2c_adapter
*adapter
, int address
, int kind
)
327 struct i2c_client
*new_client
;
328 struct adm1025_data
*data
;
330 const char *name
= "";
333 if (!i2c_check_functionality(adapter
, I2C_FUNC_SMBUS_BYTE_DATA
))
336 if (!(data
= kmalloc(sizeof(struct adm1025_data
), GFP_KERNEL
))) {
340 memset(data
, 0, sizeof(struct adm1025_data
));
342 /* The common I2C client data is placed right before the
343 ADM1025-specific data. */
344 new_client
= &data
->client
;
345 i2c_set_clientdata(new_client
, data
);
346 new_client
->addr
= address
;
347 new_client
->adapter
= adapter
;
348 new_client
->driver
= &adm1025_driver
;
349 new_client
->flags
= 0;
352 * Now we do the remaining detection. A negative kind means that
353 * the driver was loaded with no force parameter (default), so we
354 * must both detect and identify the chip. A zero kind means that
355 * the driver was loaded with the force parameter, the detection
356 * step shall be skipped. A positive kind means that the driver
357 * was loaded with the force parameter and a given kind of chip is
358 * requested, so both the detection and the identification steps
361 config
= i2c_smbus_read_byte_data(new_client
, ADM1025_REG_CONFIG
);
362 if (kind
< 0) { /* detection */
363 if ((config
& 0x80) != 0x00
364 || (i2c_smbus_read_byte_data(new_client
,
365 ADM1025_REG_STATUS1
) & 0xC0) != 0x00
366 || (i2c_smbus_read_byte_data(new_client
,
367 ADM1025_REG_STATUS2
) & 0xBC) != 0x00) {
368 dev_dbg(&adapter
->dev
,
369 "ADM1025 detection failed at 0x%02x.\n",
375 if (kind
<= 0) { /* identification */
378 man_id
= i2c_smbus_read_byte_data(new_client
,
380 chip_id
= i2c_smbus_read_byte_data(new_client
,
381 ADM1025_REG_CHIP_ID
);
383 if (man_id
== 0x41) { /* Analog Devices */
384 if ((chip_id
& 0xF0) == 0x20) { /* ADM1025/ADM1025A */
388 if (man_id
== 0xA1) { /* Philips */
390 && (chip_id
& 0xF0) == 0x20) { /* NE1619 */
395 if (kind
<= 0) { /* identification failed */
396 dev_info(&adapter
->dev
,
397 "Unsupported chip (man_id=0x%02X, "
398 "chip_id=0x%02X).\n", man_id
, chip_id
);
403 if (kind
== adm1025
) {
405 } else if (kind
== ne1619
) {
409 /* We can fill in the remaining client fields */
410 strlcpy(new_client
->name
, name
, I2C_NAME_SIZE
);
412 init_MUTEX(&data
->update_lock
);
414 /* Tell the I2C layer a new client has arrived */
415 if ((err
= i2c_attach_client(new_client
)))
418 /* Initialize the ADM1025 chip */
419 adm1025_init_client(new_client
);
421 /* Register sysfs hooks */
422 data
->class_dev
= hwmon_device_register(&new_client
->dev
);
423 if (IS_ERR(data
->class_dev
)) {
424 err
= PTR_ERR(data
->class_dev
);
428 device_create_file(&new_client
->dev
, &dev_attr_in0_input
);
429 device_create_file(&new_client
->dev
, &dev_attr_in1_input
);
430 device_create_file(&new_client
->dev
, &dev_attr_in2_input
);
431 device_create_file(&new_client
->dev
, &dev_attr_in3_input
);
432 device_create_file(&new_client
->dev
, &dev_attr_in5_input
);
433 device_create_file(&new_client
->dev
, &dev_attr_in0_min
);
434 device_create_file(&new_client
->dev
, &dev_attr_in1_min
);
435 device_create_file(&new_client
->dev
, &dev_attr_in2_min
);
436 device_create_file(&new_client
->dev
, &dev_attr_in3_min
);
437 device_create_file(&new_client
->dev
, &dev_attr_in5_min
);
438 device_create_file(&new_client
->dev
, &dev_attr_in0_max
);
439 device_create_file(&new_client
->dev
, &dev_attr_in1_max
);
440 device_create_file(&new_client
->dev
, &dev_attr_in2_max
);
441 device_create_file(&new_client
->dev
, &dev_attr_in3_max
);
442 device_create_file(&new_client
->dev
, &dev_attr_in5_max
);
443 device_create_file(&new_client
->dev
, &dev_attr_temp1_input
);
444 device_create_file(&new_client
->dev
, &dev_attr_temp2_input
);
445 device_create_file(&new_client
->dev
, &dev_attr_temp1_min
);
446 device_create_file(&new_client
->dev
, &dev_attr_temp2_min
);
447 device_create_file(&new_client
->dev
, &dev_attr_temp1_max
);
448 device_create_file(&new_client
->dev
, &dev_attr_temp2_max
);
449 device_create_file(&new_client
->dev
, &dev_attr_alarms
);
450 /* in1_ref is deprecated, remove after 2005-11-11 */
451 device_create_file(&new_client
->dev
, &dev_attr_in1_ref
);
452 device_create_file(&new_client
->dev
, &dev_attr_cpu0_vid
);
453 device_create_file(&new_client
->dev
, &dev_attr_vrm
);
455 /* Pin 11 is either in4 (+12V) or VID4 */
456 if (!(config
& 0x20)) {
457 device_create_file(&new_client
->dev
, &dev_attr_in4_input
);
458 device_create_file(&new_client
->dev
, &dev_attr_in4_min
);
459 device_create_file(&new_client
->dev
, &dev_attr_in4_max
);
465 i2c_detach_client(new_client
);
472 static void adm1025_init_client(struct i2c_client
*client
)
475 struct adm1025_data
*data
= i2c_get_clientdata(client
);
478 data
->vrm
= i2c_which_vrm();
482 * Usually we avoid setting limits on driver init, but it happens
483 * that the ADM1025 comes with stupid default limits (all registers
484 * set to 0). In case the chip has not gone through any limit
485 * setting yet, we better set the high limits to the max so that
488 for (i
=0; i
<6; i
++) {
489 reg
= i2c_smbus_read_byte_data(client
,
490 ADM1025_REG_IN_MAX(i
));
492 i2c_smbus_write_byte_data(client
,
493 ADM1025_REG_IN_MAX(i
),
496 for (i
=0; i
<2; i
++) {
497 reg
= i2c_smbus_read_byte_data(client
,
498 ADM1025_REG_TEMP_HIGH(i
));
500 i2c_smbus_write_byte_data(client
,
501 ADM1025_REG_TEMP_HIGH(i
),
506 * Start the conversions
508 reg
= i2c_smbus_read_byte_data(client
, ADM1025_REG_CONFIG
);
510 i2c_smbus_write_byte_data(client
, ADM1025_REG_CONFIG
,
514 static int adm1025_detach_client(struct i2c_client
*client
)
516 struct adm1025_data
*data
= i2c_get_clientdata(client
);
519 hwmon_device_unregister(data
->class_dev
);
521 if ((err
= i2c_detach_client(client
))) {
522 dev_err(&client
->dev
, "Client deregistration failed, "
523 "client not detached.\n");
531 static struct adm1025_data
*adm1025_update_device(struct device
*dev
)
533 struct i2c_client
*client
= to_i2c_client(dev
);
534 struct adm1025_data
*data
= i2c_get_clientdata(client
);
536 down(&data
->update_lock
);
538 if (time_after(jiffies
, data
->last_updated
+ HZ
* 2) || !data
->valid
) {
541 dev_dbg(&client
->dev
, "Updating data.\n");
542 for (i
=0; i
<6; i
++) {
543 data
->in
[i
] = i2c_smbus_read_byte_data(client
,
545 data
->in_min
[i
] = i2c_smbus_read_byte_data(client
,
546 ADM1025_REG_IN_MIN(i
));
547 data
->in_max
[i
] = i2c_smbus_read_byte_data(client
,
548 ADM1025_REG_IN_MAX(i
));
550 for (i
=0; i
<2; i
++) {
551 data
->temp
[i
] = i2c_smbus_read_byte_data(client
,
552 ADM1025_REG_TEMP(i
));
553 data
->temp_min
[i
] = i2c_smbus_read_byte_data(client
,
554 ADM1025_REG_TEMP_LOW(i
));
555 data
->temp_max
[i
] = i2c_smbus_read_byte_data(client
,
556 ADM1025_REG_TEMP_HIGH(i
));
558 data
->alarms
= i2c_smbus_read_byte_data(client
,
560 | (i2c_smbus_read_byte_data(client
,
561 ADM1025_REG_STATUS2
) << 8);
562 data
->vid
= (i2c_smbus_read_byte_data(client
,
563 ADM1025_REG_VID
) & 0x0f)
564 | ((i2c_smbus_read_byte_data(client
,
565 ADM1025_REG_VID4
) & 0x01) << 4);
567 data
->last_updated
= jiffies
;
571 up(&data
->update_lock
);
576 static int __init
sensors_adm1025_init(void)
578 return i2c_add_driver(&adm1025_driver
);
581 static void __exit
sensors_adm1025_exit(void)
583 i2c_del_driver(&adm1025_driver
);
586 MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>");
587 MODULE_DESCRIPTION("ADM1025 driver");
588 MODULE_LICENSE("GPL");
590 module_init(sensors_adm1025_init
);
591 module_exit(sensors_adm1025_exit
);