bf67860e6a206e7fbdd32f689fed3ef791baac23
[linux-2.6.git] / drivers / hwmon / adm1025.c
1 /*
2  * adm1025.c
3  *
4  * Copyright (C) 2000       Chen-Yuan Wu <gwu@esoft.com>
5  * Copyright (C) 2003-2004  Jean Delvare <khali@linux-fr.org>
6  *
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
16  *
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
20  * difference for us.
21  *
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
28  *
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.
32  *
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.
37  *
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.
42  *
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.
46  */
47
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>
56
57 /*
58  * Addresses to scan
59  * ADM1025 and ADM1025A have three possible addresses: 0x2c, 0x2d and 0x2e.
60  * NE1619 has two possible addresses: 0x2c and 0x2d.
61  */
62
63 static unsigned short normal_i2c[] = { 0x2c, 0x2d, 0x2e, I2C_CLIENT_END };
64
65 /*
66  * Insmod parameters
67  */
68
69 I2C_CLIENT_INSMOD_2(adm1025, ne1619);
70
71 /*
72  * The ADM1025 registers
73  */
74
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
88
89 /*
90  * Conversions and various macros
91  * The ADM1025 uses signed 8-bit values for temperatures.
92  */
93
94 static int in_scale[6] = { 2500, 2250, 3300, 5000, 12000, 3300 };
95
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))
100
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))
105
106 /*
107  * Functions declaration
108  */
109
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);
115
116 /*
117  * Driver data (common to all clients)
118  */
119
120 static struct i2c_driver adm1025_driver = {
121         .owner          = THIS_MODULE,
122         .name           = "adm1025",
123         .id             = I2C_DRIVERID_ADM1025,
124         .flags          = I2C_DF_NOTIFY,
125         .attach_adapter = adm1025_attach_adapter,
126         .detach_client  = adm1025_detach_client,
127 };
128
129 /*
130  * Client data (each client gets its own)
131  */
132
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 */
139
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 */
148         u8 vrm;
149 };
150
151 /*
152  * Sysfs stuff
153  */
154
155 #define show_in(offset) \
156 static ssize_t show_in##offset(struct device *dev, struct device_attribute *attr, char *buf) \
157 { \
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])); \
161 } \
162 static ssize_t show_in##offset##_min(struct device *dev, struct device_attribute *attr, char *buf) \
163 { \
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])); \
167 } \
168 static ssize_t show_in##offset##_max(struct device *dev, struct device_attribute *attr, char *buf) \
169 { \
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])); \
173 } \
174 static DEVICE_ATTR(in##offset##_input, S_IRUGO, show_in##offset, NULL);
175 show_in(0);
176 show_in(1);
177 show_in(2);
178 show_in(3);
179 show_in(4);
180 show_in(5);
181
182 #define show_temp(offset) \
183 static ssize_t show_temp##offset(struct device *dev, struct device_attribute *attr, char *buf) \
184 { \
185         struct adm1025_data *data = adm1025_update_device(dev); \
186         return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[offset-1])); \
187 } \
188 static ssize_t show_temp##offset##_min(struct device *dev, struct device_attribute *attr, char *buf) \
189 { \
190         struct adm1025_data *data = adm1025_update_device(dev); \
191         return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_min[offset-1])); \
192 } \
193 static ssize_t show_temp##offset##_max(struct device *dev, struct device_attribute *attr, char *buf) \
194 { \
195         struct adm1025_data *data = adm1025_update_device(dev); \
196         return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp_max[offset-1])); \
197 }\
198 static DEVICE_ATTR(temp##offset##_input, S_IRUGO, show_temp##offset, NULL);
199 show_temp(1);
200 show_temp(2);
201
202 #define set_in(offset) \
203 static ssize_t set_in##offset##_min(struct device *dev, struct device_attribute *attr, const char *buf, \
204         size_t count) \
205 { \
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); \
209  \
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); \
215         return count; \
216 } \
217 static ssize_t set_in##offset##_max(struct device *dev, struct device_attribute *attr, const char *buf, \
218         size_t count) \
219 { \
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); \
223  \
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); \
229         return count; \
230 } \
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);
235 set_in(0);
236 set_in(1);
237 set_in(2);
238 set_in(3);
239 set_in(4);
240 set_in(5);
241
242 #define set_temp(offset) \
243 static ssize_t set_temp##offset##_min(struct device *dev, struct device_attribute *attr, const char *buf, \
244         size_t count) \
245 { \
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); \
249  \
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); \
255         return count; \
256 } \
257 static ssize_t set_temp##offset##_max(struct device *dev, struct device_attribute *attr, const char *buf, \
258         size_t count) \
259 { \
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); \
263  \
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); \
269         return count; \
270 } \
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);
275 set_temp(1);
276 set_temp(2);
277
278 static ssize_t show_alarms(struct device *dev, struct device_attribute *attr, char *buf)
279 {
280         struct adm1025_data *data = adm1025_update_device(dev);
281         return sprintf(buf, "%u\n", data->alarms);
282 }
283 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
284
285 static ssize_t show_vid(struct device *dev, struct device_attribute *attr, char *buf)
286 {
287         struct adm1025_data *data = adm1025_update_device(dev);
288         return sprintf(buf, "%u\n", vid_from_reg(data->vid, data->vrm));
289 }
290 static DEVICE_ATTR(cpu0_vid, S_IRUGO, show_vid, NULL);
291
292 static ssize_t show_vrm(struct device *dev, struct device_attribute *attr, char *buf)
293 {
294         struct adm1025_data *data = adm1025_update_device(dev);
295         return sprintf(buf, "%u\n", data->vrm);
296 }
297 static ssize_t set_vrm(struct device *dev, struct device_attribute *attr, const char *buf, size_t count)
298 {
299         struct i2c_client *client = to_i2c_client(dev);
300         struct adm1025_data *data = i2c_get_clientdata(client);
301         data->vrm = simple_strtoul(buf, NULL, 10);
302         return count;
303 }
304 static DEVICE_ATTR(vrm, S_IRUGO | S_IWUSR, show_vrm, set_vrm);
305
306 /*
307  * Real code
308  */
309
310 static int adm1025_attach_adapter(struct i2c_adapter *adapter)
311 {
312         if (!(adapter->class & I2C_CLASS_HWMON))
313                 return 0;
314         return i2c_probe(adapter, &addr_data, adm1025_detect);
315 }
316
317 /*
318  * The following function does more than just detection. If detection
319  * succeeds, it also registers the new chip.
320  */
321 static int adm1025_detect(struct i2c_adapter *adapter, int address, int kind)
322 {
323         struct i2c_client *new_client;
324         struct adm1025_data *data;
325         int err = 0;
326         const char *name = "";
327         u8 config;
328
329         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
330                 goto exit;
331
332         if (!(data = kzalloc(sizeof(struct adm1025_data), GFP_KERNEL))) {
333                 err = -ENOMEM;
334                 goto exit;
335         }
336
337         /* The common I2C client data is placed right before the
338            ADM1025-specific data. */
339         new_client = &data->client;
340         i2c_set_clientdata(new_client, data);
341         new_client->addr = address;
342         new_client->adapter = adapter;
343         new_client->driver = &adm1025_driver;
344         new_client->flags = 0;
345
346         /*
347          * Now we do the remaining detection. A negative kind means that
348          * the driver was loaded with no force parameter (default), so we
349          * must both detect and identify the chip. A zero kind means that
350          * the driver was loaded with the force parameter, the detection
351          * step shall be skipped. A positive kind means that the driver
352          * was loaded with the force parameter and a given kind of chip is
353          * requested, so both the detection and the identification steps
354          * are skipped.
355          */
356         config = i2c_smbus_read_byte_data(new_client, ADM1025_REG_CONFIG);
357         if (kind < 0) { /* detection */
358                 if ((config & 0x80) != 0x00
359                  || (i2c_smbus_read_byte_data(new_client,
360                      ADM1025_REG_STATUS1) & 0xC0) != 0x00
361                  || (i2c_smbus_read_byte_data(new_client,
362                      ADM1025_REG_STATUS2) & 0xBC) != 0x00) {
363                         dev_dbg(&adapter->dev,
364                                 "ADM1025 detection failed at 0x%02x.\n",
365                                 address);
366                         goto exit_free;
367                 }
368         }
369
370         if (kind <= 0) { /* identification */
371                 u8 man_id, chip_id;
372
373                 man_id = i2c_smbus_read_byte_data(new_client,
374                          ADM1025_REG_MAN_ID);
375                 chip_id = i2c_smbus_read_byte_data(new_client,
376                           ADM1025_REG_CHIP_ID);
377                 
378                 if (man_id == 0x41) { /* Analog Devices */
379                         if ((chip_id & 0xF0) == 0x20) { /* ADM1025/ADM1025A */
380                                 kind = adm1025;
381                         }
382                 } else
383                 if (man_id == 0xA1) { /* Philips */
384                         if (address != 0x2E
385                          && (chip_id & 0xF0) == 0x20) { /* NE1619 */
386                                 kind = ne1619;
387                         }
388                 }
389
390                 if (kind <= 0) { /* identification failed */
391                         dev_info(&adapter->dev,
392                             "Unsupported chip (man_id=0x%02X, "
393                             "chip_id=0x%02X).\n", man_id, chip_id);
394                         goto exit_free;
395                 }
396         }
397
398         if (kind == adm1025) {
399                 name = "adm1025";
400         } else if (kind == ne1619) {
401                 name = "ne1619";
402         }
403
404         /* We can fill in the remaining client fields */
405         strlcpy(new_client->name, name, I2C_NAME_SIZE);
406         data->valid = 0;
407         init_MUTEX(&data->update_lock);
408
409         /* Tell the I2C layer a new client has arrived */
410         if ((err = i2c_attach_client(new_client)))
411                 goto exit_free;
412
413         /* Initialize the ADM1025 chip */
414         adm1025_init_client(new_client);
415
416         /* Register sysfs hooks */
417         data->class_dev = hwmon_device_register(&new_client->dev);
418         if (IS_ERR(data->class_dev)) {
419                 err = PTR_ERR(data->class_dev);
420                 goto exit_detach;
421         }
422
423         device_create_file(&new_client->dev, &dev_attr_in0_input);
424         device_create_file(&new_client->dev, &dev_attr_in1_input);
425         device_create_file(&new_client->dev, &dev_attr_in2_input);
426         device_create_file(&new_client->dev, &dev_attr_in3_input);
427         device_create_file(&new_client->dev, &dev_attr_in5_input);
428         device_create_file(&new_client->dev, &dev_attr_in0_min);
429         device_create_file(&new_client->dev, &dev_attr_in1_min);
430         device_create_file(&new_client->dev, &dev_attr_in2_min);
431         device_create_file(&new_client->dev, &dev_attr_in3_min);
432         device_create_file(&new_client->dev, &dev_attr_in5_min);
433         device_create_file(&new_client->dev, &dev_attr_in0_max);
434         device_create_file(&new_client->dev, &dev_attr_in1_max);
435         device_create_file(&new_client->dev, &dev_attr_in2_max);
436         device_create_file(&new_client->dev, &dev_attr_in3_max);
437         device_create_file(&new_client->dev, &dev_attr_in5_max);
438         device_create_file(&new_client->dev, &dev_attr_temp1_input);
439         device_create_file(&new_client->dev, &dev_attr_temp2_input);
440         device_create_file(&new_client->dev, &dev_attr_temp1_min);
441         device_create_file(&new_client->dev, &dev_attr_temp2_min);
442         device_create_file(&new_client->dev, &dev_attr_temp1_max);
443         device_create_file(&new_client->dev, &dev_attr_temp2_max);
444         device_create_file(&new_client->dev, &dev_attr_alarms);
445         device_create_file(&new_client->dev, &dev_attr_cpu0_vid);
446         device_create_file(&new_client->dev, &dev_attr_vrm);
447
448         /* Pin 11 is either in4 (+12V) or VID4 */
449         if (!(config & 0x20)) {
450                 device_create_file(&new_client->dev, &dev_attr_in4_input);
451                 device_create_file(&new_client->dev, &dev_attr_in4_min);
452                 device_create_file(&new_client->dev, &dev_attr_in4_max);
453         }
454
455         return 0;
456
457 exit_detach:
458         i2c_detach_client(new_client);
459 exit_free:
460         kfree(data);
461 exit:
462         return err;
463 }
464
465 static void adm1025_init_client(struct i2c_client *client)
466 {
467         u8 reg;
468         struct adm1025_data *data = i2c_get_clientdata(client);
469         int i;
470
471         data->vrm = vid_which_vrm();
472
473         /*
474          * Set high limits
475          * Usually we avoid setting limits on driver init, but it happens
476          * that the ADM1025 comes with stupid default limits (all registers
477          * set to 0). In case the chip has not gone through any limit
478          * setting yet, we better set the high limits to the max so that
479          * no alarm triggers.
480          */
481         for (i=0; i<6; i++) {
482                 reg = i2c_smbus_read_byte_data(client,
483                                                ADM1025_REG_IN_MAX(i));
484                 if (reg == 0)
485                         i2c_smbus_write_byte_data(client,
486                                                   ADM1025_REG_IN_MAX(i),
487                                                   0xFF);
488         }
489         for (i=0; i<2; i++) {
490                 reg = i2c_smbus_read_byte_data(client,
491                                                ADM1025_REG_TEMP_HIGH(i));
492                 if (reg == 0)
493                         i2c_smbus_write_byte_data(client,
494                                                   ADM1025_REG_TEMP_HIGH(i),
495                                                   0x7F);
496         }
497
498         /*
499          * Start the conversions
500          */
501         reg = i2c_smbus_read_byte_data(client, ADM1025_REG_CONFIG);
502         if (!(reg & 0x01))
503                 i2c_smbus_write_byte_data(client, ADM1025_REG_CONFIG,
504                                           (reg&0x7E)|0x01);
505 }
506
507 static int adm1025_detach_client(struct i2c_client *client)
508 {
509         struct adm1025_data *data = i2c_get_clientdata(client);
510         int err;
511
512         hwmon_device_unregister(data->class_dev);
513
514         if ((err = i2c_detach_client(client)))
515                 return err;
516
517         kfree(data);
518         return 0;
519 }
520
521 static struct adm1025_data *adm1025_update_device(struct device *dev)
522 {
523         struct i2c_client *client = to_i2c_client(dev);
524         struct adm1025_data *data = i2c_get_clientdata(client);
525
526         down(&data->update_lock);
527
528         if (time_after(jiffies, data->last_updated + HZ * 2) || !data->valid) {
529                 int i;
530
531                 dev_dbg(&client->dev, "Updating data.\n");
532                 for (i=0; i<6; i++) {
533                         data->in[i] = i2c_smbus_read_byte_data(client,
534                                       ADM1025_REG_IN(i));
535                         data->in_min[i] = i2c_smbus_read_byte_data(client,
536                                           ADM1025_REG_IN_MIN(i));
537                         data->in_max[i] = i2c_smbus_read_byte_data(client,
538                                           ADM1025_REG_IN_MAX(i));
539                 }
540                 for (i=0; i<2; i++) {
541                         data->temp[i] = i2c_smbus_read_byte_data(client,
542                                         ADM1025_REG_TEMP(i));
543                         data->temp_min[i] = i2c_smbus_read_byte_data(client,
544                                             ADM1025_REG_TEMP_LOW(i));
545                         data->temp_max[i] = i2c_smbus_read_byte_data(client,
546                                             ADM1025_REG_TEMP_HIGH(i));
547                 }
548                 data->alarms = i2c_smbus_read_byte_data(client,
549                                ADM1025_REG_STATUS1)
550                              | (i2c_smbus_read_byte_data(client,
551                                 ADM1025_REG_STATUS2) << 8);
552                 data->vid = (i2c_smbus_read_byte_data(client,
553                              ADM1025_REG_VID) & 0x0f)
554                           | ((i2c_smbus_read_byte_data(client,
555                               ADM1025_REG_VID4) & 0x01) << 4);
556
557                 data->last_updated = jiffies;
558                 data->valid = 1;
559         }
560
561         up(&data->update_lock);
562
563         return data;
564 }
565
566 static int __init sensors_adm1025_init(void)
567 {
568         return i2c_add_driver(&adm1025_driver);
569 }
570
571 static void __exit sensors_adm1025_exit(void)
572 {
573         i2c_del_driver(&adm1025_driver);
574 }
575
576 MODULE_AUTHOR("Jean Delvare <khali@linux-fr.org>");
577 MODULE_DESCRIPTION("ADM1025 driver");
578 MODULE_LICENSE("GPL");
579
580 module_init(sensors_adm1025_init);
581 module_exit(sensors_adm1025_exit);