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-vid.h>
55 #include <linux/err.h>
59 * ADM1025 and ADM1025A have three possible addresses: 0x2c, 0x2d and 0x2e.
60 * NE1619 has two possible addresses: 0x2c and 0x2d.
63 static unsigned short normal_i2c
[] = { 0x2c, 0x2d, 0x2e, I2C_CLIENT_END
};
69 I2C_CLIENT_INSMOD_2(adm1025
, ne1619
);
72 * The ADM1025 registers
75 #define ADM1025_REG_MAN_ID 0x3E
76 #define ADM1025_REG_CHIP_ID 0x3F
77 #define ADM1025_REG_CONFIG 0x40
78 #define ADM1025_REG_STATUS1 0x41
79 #define ADM1025_REG_STATUS2 0x42
80 #define ADM1025_REG_IN(nr) (0x20 + (nr))
81 #define ADM1025_REG_IN_MAX(nr) (0x2B + (nr) * 2)
82 #define ADM1025_REG_IN_MIN(nr) (0x2C + (nr) * 2)
83 #define ADM1025_REG_TEMP(nr) (0x26 + (nr))
84 #define ADM1025_REG_TEMP_HIGH(nr) (0x37 + (nr) * 2)
85 #define ADM1025_REG_TEMP_LOW(nr) (0x38 + (nr) * 2)
86 #define ADM1025_REG_VID 0x47
87 #define ADM1025_REG_VID4 0x49
90 * Conversions and various macros
91 * The ADM1025 uses signed 8-bit values for temperatures.
94 static int in_scale
[6] = { 2500, 2250, 3300, 5000, 12000, 3300 };
96 #define IN_FROM_REG(reg,scale) (((reg) * (scale) + 96) / 192)
97 #define IN_TO_REG(val,scale) ((val) <= 0 ? 0 : \
98 (val) * 192 >= (scale) * 255 ? 255 : \
99 ((val) * 192 + (scale)/2) / (scale))
101 #define TEMP_FROM_REG(reg) ((reg) * 1000)
102 #define TEMP_TO_REG(val) ((val) <= -127500 ? -128 : \
103 (val) >= 126500 ? 127 : \
104 (((val) < 0 ? (val)-500 : (val)+500) / 1000))
107 * Functions declaration
110 static int adm1025_attach_adapter(struct i2c_adapter
*adapter
);
111 static int adm1025_detect(struct i2c_adapter
*adapter
, int address
, int kind
);
112 static void adm1025_init_client(struct i2c_client
*client
);
113 static int adm1025_detach_client(struct i2c_client
*client
);
114 static struct adm1025_data
*adm1025_update_device(struct device
*dev
);
117 * Driver data (common to all clients)
120 static struct i2c_driver adm1025_driver
= {
121 .owner
= THIS_MODULE
,
123 .id
= I2C_DRIVERID_ADM1025
,
124 .flags
= I2C_DF_NOTIFY
,
125 .attach_adapter
= adm1025_attach_adapter
,
126 .detach_client
= adm1025_detach_client
,
130 * Client data (each client gets its own)
133 struct adm1025_data
{
134 struct i2c_client client
;
135 struct class_device
*class_dev
;
136 struct semaphore update_lock
;
137 char valid
; /* zero until following fields are valid */
138 unsigned long last_updated
; /* in jiffies */
140 u8 in
[6]; /* register value */
141 u8 in_max
[6]; /* register value */
142 u8 in_min
[6]; /* register value */
143 s8 temp
[2]; /* register value */
144 s8 temp_min
[2]; /* register value */
145 s8 temp_max
[2]; /* register value */
146 u16 alarms
; /* register values, combined */
147 u8 vid
; /* register values, combined */
155 #define show_in(offset) \
156 static ssize_t show_in##offset(struct device *dev, struct device_attribute *attr, char *buf) \
158 struct adm1025_data *data = adm1025_update_device(dev); \
159 return sprintf(buf, "%u\n", IN_FROM_REG(data->in[offset], \
160 in_scale[offset])); \
162 static ssize_t show_in##offset##_min(struct device *dev, struct device_attribute *attr, char *buf) \
164 struct adm1025_data *data = adm1025_update_device(dev); \
165 return sprintf(buf, "%u\n", IN_FROM_REG(data->in_min[offset], \
166 in_scale[offset])); \
168 static ssize_t show_in##offset##_max(struct device *dev, struct device_attribute *attr, char *buf) \
170 struct adm1025_data *data = adm1025_update_device(dev); \
171 return sprintf(buf, "%u\n", IN_FROM_REG(data->in_max[offset], \
172 in_scale[offset])); \
174 static DEVICE_ATTR(in##offset##_input, S_IRUGO, show_in##offset, NULL);
182 #define show_temp(offset) \
183 static ssize_t show_temp##offset(struct device *dev, struct device_attribute *attr, char *buf) \
185 struct adm1025_data *data = adm1025_update_device(dev); \
186 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[offset-1])); \
188 static ssize_t show_temp##offset##_min(struct device *dev, struct device_attribute *attr, char *buf) \
190 struct adm1025_data *data = adm1025_update_device(dev); \
191 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_min[offset-1])); \
193 static ssize_t show_temp##offset##_max(struct device *dev, struct device_attribute *attr, char *buf) \
195 struct adm1025_data *data = adm1025_update_device(dev); \
196 return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_max[offset-1])); \
198 static DEVICE_ATTR(temp##offset##_input, S_IRUGO, show_temp##offset, NULL);
202 #define set_in(offset) \
203 static ssize_t set_in##offset##_min(struct device *dev, struct device_attribute *attr, const char *buf, \
206 struct i2c_client *client = to_i2c_client(dev); \
207 struct adm1025_data *data = i2c_get_clientdata(client); \
208 long val = simple_strtol(buf, NULL, 10); \
210 down(&data->update_lock); \
211 data->in_min[offset] = IN_TO_REG(val, in_scale[offset]); \
212 i2c_smbus_write_byte_data(client, ADM1025_REG_IN_MIN(offset), \
213 data->in_min[offset]); \
214 up(&data->update_lock); \
217 static ssize_t set_in##offset##_max(struct device *dev, struct device_attribute *attr, const char *buf, \
220 struct i2c_client *client = to_i2c_client(dev); \
221 struct adm1025_data *data = i2c_get_clientdata(client); \
222 long val = simple_strtol(buf, NULL, 10); \
224 down(&data->update_lock); \
225 data->in_max[offset] = IN_TO_REG(val, in_scale[offset]); \
226 i2c_smbus_write_byte_data(client, ADM1025_REG_IN_MAX(offset), \
227 data->in_max[offset]); \
228 up(&data->update_lock); \
231 static DEVICE_ATTR(in##offset##_min, S_IWUSR | S_IRUGO, \
232 show_in##offset##_min, set_in##offset##_min); \
233 static DEVICE_ATTR(in##offset##_max, S_IWUSR | S_IRUGO, \
234 show_in##offset##_max, set_in##offset##_max);
242 #define set_temp(offset) \
243 static ssize_t set_temp##offset##_min(struct device *dev, struct device_attribute *attr, const char *buf, \
246 struct i2c_client *client = to_i2c_client(dev); \
247 struct adm1025_data *data = i2c_get_clientdata(client); \
248 long val = simple_strtol(buf, NULL, 10); \
250 down(&data->update_lock); \
251 data->temp_min[offset-1] = TEMP_TO_REG(val); \
252 i2c_smbus_write_byte_data(client, ADM1025_REG_TEMP_LOW(offset-1), \
253 data->temp_min[offset-1]); \
254 up(&data->update_lock); \
257 static ssize_t set_temp##offset##_max(struct device *dev, struct device_attribute *attr, const char *buf, \
260 struct i2c_client *client = to_i2c_client(dev); \
261 struct adm1025_data *data = i2c_get_clientdata(client); \
262 long val = simple_strtol(buf, NULL, 10); \
264 down(&data->update_lock); \
265 data->temp_max[offset-1] = TEMP_TO_REG(val); \
266 i2c_smbus_write_byte_data(client, ADM1025_REG_TEMP_HIGH(offset-1), \
267 data->temp_max[offset-1]); \
268 up(&data->update_lock); \
271 static DEVICE_ATTR(temp##offset##_min, S_IWUSR | S_IRUGO, \
272 show_temp##offset##_min, set_temp##offset##_min); \
273 static DEVICE_ATTR(temp##offset##_max, S_IWUSR | S_IRUGO, \
274 show_temp##offset##_max, set_temp##offset##_max);
278 static ssize_t
show_alarms(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
280 struct adm1025_data
*data
= adm1025_update_device(dev
);
281 return sprintf(buf
, "%u\n", data
->alarms
);
283 static DEVICE_ATTR(alarms
, S_IRUGO
, show_alarms
, NULL
);
285 static ssize_t
show_vid(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
287 struct adm1025_data
*data
= adm1025_update_device(dev
);
288 return sprintf(buf
, "%u\n", vid_from_reg(data
->vid
, data
->vrm
));
290 /* in1_ref is deprecated in favour of cpu0_vid, remove after 2005-11-11 */
291 static DEVICE_ATTR(in1_ref
, S_IRUGO
, show_vid
, NULL
);
292 static DEVICE_ATTR(cpu0_vid
, S_IRUGO
, show_vid
, NULL
);
294 static ssize_t
show_vrm(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
296 struct adm1025_data
*data
= adm1025_update_device(dev
);
297 return sprintf(buf
, "%u\n", data
->vrm
);
299 static ssize_t
set_vrm(struct device
*dev
, struct device_attribute
*attr
, const char *buf
, size_t count
)
301 struct i2c_client
*client
= to_i2c_client(dev
);
302 struct adm1025_data
*data
= i2c_get_clientdata(client
);
303 data
->vrm
= simple_strtoul(buf
, NULL
, 10);
306 static DEVICE_ATTR(vrm
, S_IRUGO
| S_IWUSR
, show_vrm
, set_vrm
);
312 static int adm1025_attach_adapter(struct i2c_adapter
*adapter
)
314 if (!(adapter
->class & I2C_CLASS_HWMON
))
316 return i2c_probe(adapter
, &addr_data
, adm1025_detect
);
320 * The following function does more than just detection. If detection
321 * succeeds, it also registers the new chip.
323 static int adm1025_detect(struct i2c_adapter
*adapter
, int address
, int kind
)
325 struct i2c_client
*new_client
;
326 struct adm1025_data
*data
;
328 const char *name
= "";
331 if (!i2c_check_functionality(adapter
, I2C_FUNC_SMBUS_BYTE_DATA
))
334 if (!(data
= kmalloc(sizeof(struct adm1025_data
), GFP_KERNEL
))) {
338 memset(data
, 0, sizeof(struct adm1025_data
));
340 /* The common I2C client data is placed right before the
341 ADM1025-specific data. */
342 new_client
= &data
->client
;
343 i2c_set_clientdata(new_client
, data
);
344 new_client
->addr
= address
;
345 new_client
->adapter
= adapter
;
346 new_client
->driver
= &adm1025_driver
;
347 new_client
->flags
= 0;
350 * Now we do the remaining detection. A negative kind means that
351 * the driver was loaded with no force parameter (default), so we
352 * must both detect and identify the chip. A zero kind means that
353 * the driver was loaded with the force parameter, the detection
354 * step shall be skipped. A positive kind means that the driver
355 * was loaded with the force parameter and a given kind of chip is
356 * requested, so both the detection and the identification steps
359 config
= i2c_smbus_read_byte_data(new_client
, ADM1025_REG_CONFIG
);
360 if (kind
< 0) { /* detection */
361 if ((config
& 0x80) != 0x00
362 || (i2c_smbus_read_byte_data(new_client
,
363 ADM1025_REG_STATUS1
) & 0xC0) != 0x00
364 || (i2c_smbus_read_byte_data(new_client
,
365 ADM1025_REG_STATUS2
) & 0xBC) != 0x00) {
366 dev_dbg(&adapter
->dev
,
367 "ADM1025 detection failed at 0x%02x.\n",
373 if (kind
<= 0) { /* identification */
376 man_id
= i2c_smbus_read_byte_data(new_client
,
378 chip_id
= i2c_smbus_read_byte_data(new_client
,
379 ADM1025_REG_CHIP_ID
);
381 if (man_id
== 0x41) { /* Analog Devices */
382 if ((chip_id
& 0xF0) == 0x20) { /* ADM1025/ADM1025A */
386 if (man_id
== 0xA1) { /* Philips */
388 && (chip_id
& 0xF0) == 0x20) { /* NE1619 */
393 if (kind
<= 0) { /* identification failed */
394 dev_info(&adapter
->dev
,
395 "Unsupported chip (man_id=0x%02X, "
396 "chip_id=0x%02X).\n", man_id
, chip_id
);
401 if (kind
== adm1025
) {
403 } else if (kind
== ne1619
) {
407 /* We can fill in the remaining client fields */
408 strlcpy(new_client
->name
, name
, I2C_NAME_SIZE
);
410 init_MUTEX(&data
->update_lock
);
412 /* Tell the I2C layer a new client has arrived */
413 if ((err
= i2c_attach_client(new_client
)))
416 /* Initialize the ADM1025 chip */
417 adm1025_init_client(new_client
);
419 /* Register sysfs hooks */
420 data
->class_dev
= hwmon_device_register(&new_client
->dev
);
421 if (IS_ERR(data
->class_dev
)) {
422 err
= PTR_ERR(data
->class_dev
);
426 device_create_file(&new_client
->dev
, &dev_attr_in0_input
);
427 device_create_file(&new_client
->dev
, &dev_attr_in1_input
);
428 device_create_file(&new_client
->dev
, &dev_attr_in2_input
);
429 device_create_file(&new_client
->dev
, &dev_attr_in3_input
);
430 device_create_file(&new_client
->dev
, &dev_attr_in5_input
);
431 device_create_file(&new_client
->dev
, &dev_attr_in0_min
);
432 device_create_file(&new_client
->dev
, &dev_attr_in1_min
);
433 device_create_file(&new_client
->dev
, &dev_attr_in2_min
);
434 device_create_file(&new_client
->dev
, &dev_attr_in3_min
);
435 device_create_file(&new_client
->dev
, &dev_attr_in5_min
);
436 device_create_file(&new_client
->dev
, &dev_attr_in0_max
);
437 device_create_file(&new_client
->dev
, &dev_attr_in1_max
);
438 device_create_file(&new_client
->dev
, &dev_attr_in2_max
);
439 device_create_file(&new_client
->dev
, &dev_attr_in3_max
);
440 device_create_file(&new_client
->dev
, &dev_attr_in5_max
);
441 device_create_file(&new_client
->dev
, &dev_attr_temp1_input
);
442 device_create_file(&new_client
->dev
, &dev_attr_temp2_input
);
443 device_create_file(&new_client
->dev
, &dev_attr_temp1_min
);
444 device_create_file(&new_client
->dev
, &dev_attr_temp2_min
);
445 device_create_file(&new_client
->dev
, &dev_attr_temp1_max
);
446 device_create_file(&new_client
->dev
, &dev_attr_temp2_max
);
447 device_create_file(&new_client
->dev
, &dev_attr_alarms
);
448 /* in1_ref is deprecated, remove after 2005-11-11 */
449 device_create_file(&new_client
->dev
, &dev_attr_in1_ref
);
450 device_create_file(&new_client
->dev
, &dev_attr_cpu0_vid
);
451 device_create_file(&new_client
->dev
, &dev_attr_vrm
);
453 /* Pin 11 is either in4 (+12V) or VID4 */
454 if (!(config
& 0x20)) {
455 device_create_file(&new_client
->dev
, &dev_attr_in4_input
);
456 device_create_file(&new_client
->dev
, &dev_attr_in4_min
);
457 device_create_file(&new_client
->dev
, &dev_attr_in4_max
);
463 i2c_detach_client(new_client
);
470 static void adm1025_init_client(struct i2c_client
*client
)
473 struct adm1025_data
*data
= i2c_get_clientdata(client
);
476 data
->vrm
= vid_which_vrm();
480 * Usually we avoid setting limits on driver init, but it happens
481 * that the ADM1025 comes with stupid default limits (all registers
482 * set to 0). In case the chip has not gone through any limit
483 * setting yet, we better set the high limits to the max so that
486 for (i
=0; i
<6; i
++) {
487 reg
= i2c_smbus_read_byte_data(client
,
488 ADM1025_REG_IN_MAX(i
));
490 i2c_smbus_write_byte_data(client
,
491 ADM1025_REG_IN_MAX(i
),
494 for (i
=0; i
<2; i
++) {
495 reg
= i2c_smbus_read_byte_data(client
,
496 ADM1025_REG_TEMP_HIGH(i
));
498 i2c_smbus_write_byte_data(client
,
499 ADM1025_REG_TEMP_HIGH(i
),
504 * Start the conversions
506 reg
= i2c_smbus_read_byte_data(client
, ADM1025_REG_CONFIG
);
508 i2c_smbus_write_byte_data(client
, ADM1025_REG_CONFIG
,
512 static int adm1025_detach_client(struct i2c_client
*client
)
514 struct adm1025_data
*data
= i2c_get_clientdata(client
);
517 hwmon_device_unregister(data
->class_dev
);
519 if ((err
= i2c_detach_client(client
)))
526 static struct adm1025_data
*adm1025_update_device(struct device
*dev
)
528 struct i2c_client
*client
= to_i2c_client(dev
);
529 struct adm1025_data
*data
= i2c_get_clientdata(client
);
531 down(&data
->update_lock
);
533 if (time_after(jiffies
, data
->last_updated
+ HZ
* 2) || !data
->valid
) {
536 dev_dbg(&client
->dev
, "Updating data.\n");
537 for (i
=0; i
<6; i
++) {
538 data
->in
[i
] = i2c_smbus_read_byte_data(client
,
540 data
->in_min
[i
] = i2c_smbus_read_byte_data(client
,
541 ADM1025_REG_IN_MIN(i
));
542 data
->in_max
[i
] = i2c_smbus_read_byte_data(client
,
543 ADM1025_REG_IN_MAX(i
));
545 for (i
=0; i
<2; i
++) {
546 data
->temp
[i
] = i2c_smbus_read_byte_data(client
,
547 ADM1025_REG_TEMP(i
));
548 data
->temp_min
[i
] = i2c_smbus_read_byte_data(client
,
549 ADM1025_REG_TEMP_LOW(i
));
550 data
->temp_max
[i
] = i2c_smbus_read_byte_data(client
,
551 ADM1025_REG_TEMP_HIGH(i
));
553 data
->alarms
= i2c_smbus_read_byte_data(client
,
555 | (i2c_smbus_read_byte_data(client
,
556 ADM1025_REG_STATUS2
) << 8);
557 data
->vid
= (i2c_smbus_read_byte_data(client
,
558 ADM1025_REG_VID
) & 0x0f)
559 | ((i2c_smbus_read_byte_data(client
,
560 ADM1025_REG_VID4
) & 0x01) << 4);
562 data
->last_updated
= jiffies
;
566 up(&data
->update_lock
);
571 static int __init
sensors_adm1025_init(void)
573 return i2c_add_driver(&adm1025_driver
);
576 static void __exit
sensors_adm1025_exit(void)
578 i2c_del_driver(&adm1025_driver
);
581 MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>");
582 MODULE_DESCRIPTION("ADM1025 driver");
583 MODULE_LICENSE("GPL");
585 module_init(sensors_adm1025_init
);
586 module_exit(sensors_adm1025_exit
);