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