hwmon: (adt7475) Add VID support for the ADT7476
[linux-2.6.git] / drivers / hwmon / adm1029.c
1 /*
2  * adm1029.c - Part of lm_sensors, Linux kernel modules for hardware monitoring
3  *
4  * Copyright (C) 2006 Corentin LABBE <corentin.labbe@geomatys.fr>
5  *
6  * Based on LM83 Driver by Jean Delvare <khali@linux-fr.org>
7  *
8  * Give only processor, motherboard temperatures and fan tachs
9  * Very rare chip please let me know if you use it
10  *
11  * http://www.analog.com/UploadedFiles/Data_Sheets/ADM1029.pdf
12  *
13  *
14  * This program is free software; you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation version 2 of the License
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26  */
27
28 #include <linux/module.h>
29 #include <linux/init.h>
30 #include <linux/slab.h>
31 #include <linux/jiffies.h>
32 #include <linux/i2c.h>
33 #include <linux/hwmon-sysfs.h>
34 #include <linux/hwmon.h>
35 #include <linux/err.h>
36 #include <linux/mutex.h>
37
38 /*
39  * Addresses to scan
40  */
41
42 static const unsigned short normal_i2c[] = { 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d,
43                                                 0x2e, 0x2f, I2C_CLIENT_END
44 };
45
46 /*
47  * Insmod parameters
48  */
49
50 I2C_CLIENT_INSMOD_1(adm1029);
51
52 /*
53  * The ADM1029 registers
54  * Manufacturer ID is 0x41 for Analog Devices
55  */
56
57 #define ADM1029_REG_MAN_ID                      0x0D
58 #define ADM1029_REG_CHIP_ID                     0x0E
59 #define ADM1029_REG_CONFIG                      0x01
60 #define ADM1029_REG_NB_FAN_SUPPORT              0x02
61
62 #define ADM1029_REG_TEMP_DEVICES_INSTALLED      0x06
63
64 #define ADM1029_REG_LOCAL_TEMP                  0xA0
65 #define ADM1029_REG_REMOTE1_TEMP                0xA1
66 #define ADM1029_REG_REMOTE2_TEMP                0xA2
67
68 #define ADM1029_REG_LOCAL_TEMP_HIGH             0x90
69 #define ADM1029_REG_REMOTE1_TEMP_HIGH           0x91
70 #define ADM1029_REG_REMOTE2_TEMP_HIGH           0x92
71
72 #define ADM1029_REG_LOCAL_TEMP_LOW              0x98
73 #define ADM1029_REG_REMOTE1_TEMP_LOW            0x99
74 #define ADM1029_REG_REMOTE2_TEMP_LOW            0x9A
75
76 #define ADM1029_REG_FAN1                        0x70
77 #define ADM1029_REG_FAN2                        0x71
78
79 #define ADM1029_REG_FAN1_MIN                    0x78
80 #define ADM1029_REG_FAN2_MIN                    0x79
81
82 #define ADM1029_REG_FAN1_CONFIG                 0x68
83 #define ADM1029_REG_FAN2_CONFIG                 0x69
84
85 #define TEMP_FROM_REG(val)      ((val) * 1000)
86
87 #define DIV_FROM_REG(val)       ( 1 << (((val) >> 6) - 1))
88
89 /* Registers to be checked by adm1029_update_device() */
90 static const u8 ADM1029_REG_TEMP[] = {
91         ADM1029_REG_LOCAL_TEMP,
92         ADM1029_REG_REMOTE1_TEMP,
93         ADM1029_REG_REMOTE2_TEMP,
94         ADM1029_REG_LOCAL_TEMP_HIGH,
95         ADM1029_REG_REMOTE1_TEMP_HIGH,
96         ADM1029_REG_REMOTE2_TEMP_HIGH,
97         ADM1029_REG_LOCAL_TEMP_LOW,
98         ADM1029_REG_REMOTE1_TEMP_LOW,
99         ADM1029_REG_REMOTE2_TEMP_LOW,
100 };
101
102 static const u8 ADM1029_REG_FAN[] = {
103         ADM1029_REG_FAN1,
104         ADM1029_REG_FAN2,
105         ADM1029_REG_FAN1_MIN,
106         ADM1029_REG_FAN2_MIN,
107 };
108
109 static const u8 ADM1029_REG_FAN_DIV[] = {
110         ADM1029_REG_FAN1_CONFIG,
111         ADM1029_REG_FAN2_CONFIG,
112 };
113
114 /*
115  * Functions declaration
116  */
117
118 static int adm1029_probe(struct i2c_client *client,
119                          const struct i2c_device_id *id);
120 static int adm1029_detect(struct i2c_client *client, int kind,
121                           struct i2c_board_info *info);
122 static int adm1029_remove(struct i2c_client *client);
123 static struct adm1029_data *adm1029_update_device(struct device *dev);
124 static int adm1029_init_client(struct i2c_client *client);
125
126 /*
127  * Driver data (common to all clients)
128  */
129
130 static const struct i2c_device_id adm1029_id[] = {
131         { "adm1029", adm1029 },
132         { }
133 };
134 MODULE_DEVICE_TABLE(i2c, adm1029_id);
135
136 static struct i2c_driver adm1029_driver = {
137         .class          = I2C_CLASS_HWMON,
138         .driver = {
139                 .name = "adm1029",
140         },
141         .probe          = adm1029_probe,
142         .remove         = adm1029_remove,
143         .id_table       = adm1029_id,
144         .detect         = adm1029_detect,
145         .address_data   = &addr_data,
146 };
147
148 /*
149  * Client data (each client gets its own)
150  */
151
152 struct adm1029_data {
153         struct device *hwmon_dev;
154         struct mutex update_lock;
155         char valid;             /* zero until following fields are valid */
156         unsigned long last_updated;     /* in jiffies */
157
158         /* registers values, signed for temperature, unsigned for other stuff */
159         s8 temp[ARRAY_SIZE(ADM1029_REG_TEMP)];
160         u8 fan[ARRAY_SIZE(ADM1029_REG_FAN)];
161         u8 fan_div[ARRAY_SIZE(ADM1029_REG_FAN_DIV)];
162 };
163
164 /*
165  * Sysfs stuff
166  */
167
168 static ssize_t
169 show_temp(struct device *dev, struct device_attribute *devattr, char *buf)
170 {
171         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
172         struct adm1029_data *data = adm1029_update_device(dev);
173         return sprintf(buf, "%d\n", TEMP_FROM_REG(data->temp[attr->index]));
174 }
175
176 static ssize_t
177 show_fan(struct device *dev, struct device_attribute *devattr, char *buf)
178 {
179         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
180         struct adm1029_data *data = adm1029_update_device(dev);
181         u16 val;
182         if (data->fan[attr->index] == 0
183             || (data->fan_div[attr->index] & 0xC0) == 0
184             || data->fan[attr->index] == 255) {
185                 return sprintf(buf, "0\n");
186         }
187
188         val = 1880 * 120 / DIV_FROM_REG(data->fan_div[attr->index])
189             / data->fan[attr->index];
190         return sprintf(buf, "%d\n", val);
191 }
192
193 static ssize_t
194 show_fan_div(struct device *dev, struct device_attribute *devattr, char *buf)
195 {
196         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
197         struct adm1029_data *data = adm1029_update_device(dev);
198         if ((data->fan_div[attr->index] & 0xC0) == 0)
199                 return sprintf(buf, "0\n");
200         return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[attr->index]));
201 }
202
203 static ssize_t set_fan_div(struct device *dev,
204             struct device_attribute *devattr, const char *buf, size_t count)
205 {
206         struct i2c_client *client = to_i2c_client(dev);
207         struct adm1029_data *data = i2c_get_clientdata(client);
208         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
209         long val = simple_strtol(buf, NULL, 10);
210         u8 reg;
211
212         mutex_lock(&data->update_lock);
213
214         /*Read actual config */
215         reg = i2c_smbus_read_byte_data(client,
216                                        ADM1029_REG_FAN_DIV[attr->index]);
217
218         switch (val) {
219         case 1:
220                 val = 1;
221                 break;
222         case 2:
223                 val = 2;
224                 break;
225         case 4:
226                 val = 3;
227                 break;
228         default:
229                 mutex_unlock(&data->update_lock);
230                 dev_err(&client->dev, "fan_div value %ld not "
231                         "supported. Choose one of 1, 2 or 4!\n", val);
232                 return -EINVAL;
233         }
234         /* Update the value */
235         reg = (reg & 0x3F) | (val << 6);
236
237         /* Write value */
238         i2c_smbus_write_byte_data(client,
239                                   ADM1029_REG_FAN_DIV[attr->index], reg);
240         mutex_unlock(&data->update_lock);
241
242         return count;
243 }
244
245 /*
246 Access rights on sysfs, S_IRUGO stand for Is Readable by User, Group and Others
247                         S_IWUSR stand for Is Writable by User
248 */
249 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
250 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1);
251 static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp, NULL, 2);
252
253 static SENSOR_DEVICE_ATTR(temp1_max, S_IRUGO, show_temp, NULL, 3);
254 static SENSOR_DEVICE_ATTR(temp2_max, S_IRUGO, show_temp, NULL, 4);
255 static SENSOR_DEVICE_ATTR(temp3_max, S_IRUGO, show_temp, NULL, 5);
256
257 static SENSOR_DEVICE_ATTR(temp1_min, S_IRUGO, show_temp, NULL, 6);
258 static SENSOR_DEVICE_ATTR(temp2_min, S_IRUGO, show_temp, NULL, 7);
259 static SENSOR_DEVICE_ATTR(temp3_min, S_IRUGO, show_temp, NULL, 8);
260
261 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0);
262 static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, show_fan, NULL, 1);
263
264 static SENSOR_DEVICE_ATTR(fan1_min, S_IRUGO, show_fan, NULL, 2);
265 static SENSOR_DEVICE_ATTR(fan2_min, S_IRUGO, show_fan, NULL, 3);
266
267 static SENSOR_DEVICE_ATTR(fan1_div, S_IRUGO | S_IWUSR,
268                           show_fan_div, set_fan_div, 0);
269 static SENSOR_DEVICE_ATTR(fan2_div, S_IRUGO | S_IWUSR,
270                           show_fan_div, set_fan_div, 1);
271
272 static struct attribute *adm1029_attributes[] = {
273         &sensor_dev_attr_temp1_input.dev_attr.attr,
274         &sensor_dev_attr_temp1_min.dev_attr.attr,
275         &sensor_dev_attr_temp1_max.dev_attr.attr,
276         &sensor_dev_attr_temp2_input.dev_attr.attr,
277         &sensor_dev_attr_temp2_min.dev_attr.attr,
278         &sensor_dev_attr_temp2_max.dev_attr.attr,
279         &sensor_dev_attr_temp3_input.dev_attr.attr,
280         &sensor_dev_attr_temp3_min.dev_attr.attr,
281         &sensor_dev_attr_temp3_max.dev_attr.attr,
282         &sensor_dev_attr_fan1_input.dev_attr.attr,
283         &sensor_dev_attr_fan2_input.dev_attr.attr,
284         &sensor_dev_attr_fan1_min.dev_attr.attr,
285         &sensor_dev_attr_fan2_min.dev_attr.attr,
286         &sensor_dev_attr_fan1_div.dev_attr.attr,
287         &sensor_dev_attr_fan2_div.dev_attr.attr,
288         NULL
289 };
290
291 static const struct attribute_group adm1029_group = {
292         .attrs = adm1029_attributes,
293 };
294
295 /*
296  * Real code
297  */
298
299 /* Return 0 if detection is successful, -ENODEV otherwise */
300 static int adm1029_detect(struct i2c_client *client, int kind,
301                           struct i2c_board_info *info)
302 {
303         struct i2c_adapter *adapter = client->adapter;
304         u8 man_id, chip_id, temp_devices_installed, nb_fan_support;
305
306         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
307                 return -ENODEV;
308
309         /* ADM1029 doesn't have CHIP ID, check just MAN ID
310          * For better detection we check also ADM1029_TEMP_DEVICES_INSTALLED,
311          * ADM1029_REG_NB_FAN_SUPPORT and compare it with possible values
312          * documented
313          */
314
315         man_id = i2c_smbus_read_byte_data(client, ADM1029_REG_MAN_ID);
316         chip_id = i2c_smbus_read_byte_data(client, ADM1029_REG_CHIP_ID);
317         temp_devices_installed = i2c_smbus_read_byte_data(client,
318                                         ADM1029_REG_TEMP_DEVICES_INSTALLED);
319         nb_fan_support = i2c_smbus_read_byte_data(client,
320                                                 ADM1029_REG_NB_FAN_SUPPORT);
321         /* 0x41 is Analog Devices */
322         if (man_id != 0x41 || (temp_devices_installed & 0xf9) != 0x01
323             || nb_fan_support != 0x03)
324                 return -ENODEV;
325
326         if ((chip_id & 0xF0) != 0x00) {
327                 /* There are no "official" CHIP ID, so actually
328                  * we use Major/Minor revision for that */
329                 pr_info("adm1029: Unknown major revision %x, "
330                         "please let us know\n", chip_id);
331                 return -ENODEV;
332         }
333
334         strlcpy(info->type, "adm1029", I2C_NAME_SIZE);
335
336         return 0;
337 }
338
339 static int adm1029_probe(struct i2c_client *client,
340                          const struct i2c_device_id *id)
341 {
342         struct adm1029_data *data;
343         int err;
344
345         data = kzalloc(sizeof(struct adm1029_data), GFP_KERNEL);
346         if (!data) {
347                 err = -ENOMEM;
348                 goto exit;
349         }
350
351         i2c_set_clientdata(client, data);
352         mutex_init(&data->update_lock);
353
354         /*
355          * Initialize the ADM1029 chip
356          * Check config register
357          */
358         if (adm1029_init_client(client) == 0) {
359                 err = -ENODEV;
360                 goto exit_free;
361         }
362
363         /* Register sysfs hooks */
364         if ((err = sysfs_create_group(&client->dev.kobj, &adm1029_group)))
365                 goto exit_free;
366
367         data->hwmon_dev = hwmon_device_register(&client->dev);
368         if (IS_ERR(data->hwmon_dev)) {
369                 err = PTR_ERR(data->hwmon_dev);
370                 goto exit_remove_files;
371         }
372
373         return 0;
374
375  exit_remove_files:
376         sysfs_remove_group(&client->dev.kobj, &adm1029_group);
377  exit_free:
378         kfree(data);
379  exit:
380         return err;
381 }
382
383 static int adm1029_init_client(struct i2c_client *client)
384 {
385         u8 config;
386         config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG);
387         if ((config & 0x10) == 0) {
388                 i2c_smbus_write_byte_data(client, ADM1029_REG_CONFIG,
389                                           config | 0x10);
390         }
391         /* recheck config */
392         config = i2c_smbus_read_byte_data(client, ADM1029_REG_CONFIG);
393         if ((config & 0x10) == 0) {
394                 dev_err(&client->dev, "Initialization failed!\n");
395                 return 0;
396         }
397         return 1;
398 }
399
400 static int adm1029_remove(struct i2c_client *client)
401 {
402         struct adm1029_data *data = i2c_get_clientdata(client);
403
404         hwmon_device_unregister(data->hwmon_dev);
405         sysfs_remove_group(&client->dev.kobj, &adm1029_group);
406
407         kfree(data);
408         return 0;
409 }
410
411 /*
412 function that update the status of the chips (temperature for exemple)
413 */
414 static struct adm1029_data *adm1029_update_device(struct device *dev)
415 {
416         struct i2c_client *client = to_i2c_client(dev);
417         struct adm1029_data *data = i2c_get_clientdata(client);
418
419         mutex_lock(&data->update_lock);
420         /*
421          * Use the "cache" Luke, don't recheck values
422          * if there are already checked not a long time later
423          */
424         if (time_after(jiffies, data->last_updated + HZ * 2)
425          || !data->valid) {
426                 int nr;
427
428                 dev_dbg(&client->dev, "Updating adm1029 data\n");
429
430                 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_TEMP); nr++) {
431                         data->temp[nr] =
432                             i2c_smbus_read_byte_data(client,
433                                                      ADM1029_REG_TEMP[nr]);
434                 }
435                 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN); nr++) {
436                         data->fan[nr] =
437                             i2c_smbus_read_byte_data(client,
438                                                      ADM1029_REG_FAN[nr]);
439                 }
440                 for (nr = 0; nr < ARRAY_SIZE(ADM1029_REG_FAN_DIV); nr++) {
441                         data->fan_div[nr] =
442                             i2c_smbus_read_byte_data(client,
443                                                      ADM1029_REG_FAN_DIV[nr]);
444                 }
445
446                 data->last_updated = jiffies;
447                 data->valid = 1;
448         }
449
450         mutex_unlock(&data->update_lock);
451
452         return data;
453 }
454
455 /*
456         Common module stuff
457 */
458 static int __init sensors_adm1029_init(void)
459 {
460
461         return i2c_add_driver(&adm1029_driver);
462 }
463
464 static void __exit sensors_adm1029_exit(void)
465 {
466
467         i2c_del_driver(&adm1029_driver);
468 }
469
470 MODULE_AUTHOR("Corentin LABBE <corentin.labbe@geomatys.fr>");
471 MODULE_DESCRIPTION("adm1029 driver");
472 MODULE_LICENSE("GPL v2");
473
474 module_init(sensors_adm1029_init);
475 module_exit(sensors_adm1029_exit);