866d66507596578407d009f4bd1414ab74160f7f
[linux-2.6.git] / drivers / hwmon / thmc50.c
1 /*
2     thmc50.c - Part of lm_sensors, Linux kernel modules for hardware
3              monitoring
4     Copyright (C) 2007 Krzysztof Helt <krzysztof.h1@wp.pl>
5     Based on 2.4 driver by Frodo Looijaard <frodol@dds.nl> and
6     Philip Edelbrock <phil@netroedge.com>
7
8     This program is free software; you can redistribute it and/or modify
9     it under the terms of the GNU General Public License as published by
10     the Free Software Foundation; either version 2 of the License, or
11     (at your option) any later version.
12
13     This program is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16     GNU General Public License for more details.
17
18     You should have received a copy of the GNU General Public License
19     along with this program; if not, write to the Free Software
20     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 #include <linux/module.h>
24 #include <linux/init.h>
25 #include <linux/slab.h>
26 #include <linux/i2c.h>
27 #include <linux/hwmon.h>
28 #include <linux/hwmon-sysfs.h>
29 #include <linux/err.h>
30 #include <linux/mutex.h>
31
32 MODULE_LICENSE("GPL");
33
34 /* Addresses to scan */
35 static const unsigned short normal_i2c[] = { 0x2c, 0x2d, 0x2e, I2C_CLIENT_END };
36
37 /* Insmod parameters */
38 I2C_CLIENT_INSMOD_2(thmc50, adm1022);
39
40 static unsigned short adm1022_temp3[16];
41 static unsigned int adm1022_temp3_num;
42 module_param_array(adm1022_temp3, ushort, &adm1022_temp3_num, 0);
43 MODULE_PARM_DESC(adm1022_temp3, "List of adapter,address pairs "
44                         "to enable 3rd temperature (ADM1022 only)");
45
46 /* Many THMC50 constants specified below */
47
48 /* The THMC50 registers */
49 #define THMC50_REG_CONF                         0x40
50 #define THMC50_REG_COMPANY_ID                   0x3E
51 #define THMC50_REG_DIE_CODE                     0x3F
52 #define THMC50_REG_ANALOG_OUT                   0x19
53 /*
54  * The mirror status register cannot be used as
55  * reading it does not clear alarms.
56  */
57 #define THMC50_REG_INTR                         0x41
58
59 static const u8 THMC50_REG_TEMP[] = { 0x27, 0x26, 0x20 };
60 static const u8 THMC50_REG_TEMP_MIN[] = { 0x3A, 0x38, 0x2C };
61 static const u8 THMC50_REG_TEMP_MAX[] = { 0x39, 0x37, 0x2B };
62 static const u8 THMC50_REG_TEMP_CRITICAL[] = { 0x13, 0x14, 0x14 };
63 static const u8 THMC50_REG_TEMP_DEFAULT[] = { 0x17, 0x18, 0x18 };
64
65 #define THMC50_REG_CONF_nFANOFF                 0x20
66 #define THMC50_REG_CONF_PROGRAMMED              0x08
67
68 /* Each client has this additional data */
69 struct thmc50_data {
70         struct device *hwmon_dev;
71
72         struct mutex update_lock;
73         enum chips type;
74         unsigned long last_updated;     /* In jiffies */
75         char has_temp3;         /* !=0 if it is ADM1022 in temp3 mode */
76         char valid;             /* !=0 if following fields are valid */
77
78         /* Register values */
79         s8 temp_input[3];
80         s8 temp_max[3];
81         s8 temp_min[3];
82         s8 temp_critical[3];
83         u8 analog_out;
84         u8 alarms;
85 };
86
87 static int thmc50_detect(struct i2c_client *client,
88                          struct i2c_board_info *info);
89 static int thmc50_probe(struct i2c_client *client,
90                         const struct i2c_device_id *id);
91 static int thmc50_remove(struct i2c_client *client);
92 static void thmc50_init_client(struct i2c_client *client);
93 static struct thmc50_data *thmc50_update_device(struct device *dev);
94
95 static const struct i2c_device_id thmc50_id[] = {
96         { "adm1022", adm1022 },
97         { "thmc50", thmc50 },
98         { }
99 };
100 MODULE_DEVICE_TABLE(i2c, thmc50_id);
101
102 static struct i2c_driver thmc50_driver = {
103         .class = I2C_CLASS_HWMON,
104         .driver = {
105                 .name = "thmc50",
106         },
107         .probe = thmc50_probe,
108         .remove = thmc50_remove,
109         .id_table = thmc50_id,
110         .detect = thmc50_detect,
111         .address_list = normal_i2c,
112 };
113
114 static ssize_t show_analog_out(struct device *dev,
115                                struct device_attribute *attr, char *buf)
116 {
117         struct thmc50_data *data = thmc50_update_device(dev);
118         return sprintf(buf, "%d\n", data->analog_out);
119 }
120
121 static ssize_t set_analog_out(struct device *dev,
122                               struct device_attribute *attr,
123                               const char *buf, size_t count)
124 {
125         struct i2c_client *client = to_i2c_client(dev);
126         struct thmc50_data *data = i2c_get_clientdata(client);
127         int tmp = simple_strtoul(buf, NULL, 10);
128         int config;
129
130         mutex_lock(&data->update_lock);
131         data->analog_out = SENSORS_LIMIT(tmp, 0, 255);
132         i2c_smbus_write_byte_data(client, THMC50_REG_ANALOG_OUT,
133                                   data->analog_out);
134
135         config = i2c_smbus_read_byte_data(client, THMC50_REG_CONF);
136         if (data->analog_out == 0)
137                 config &= ~THMC50_REG_CONF_nFANOFF;
138         else
139                 config |= THMC50_REG_CONF_nFANOFF;
140         i2c_smbus_write_byte_data(client, THMC50_REG_CONF, config);
141
142         mutex_unlock(&data->update_lock);
143         return count;
144 }
145
146 /* There is only one PWM mode = DC */
147 static ssize_t show_pwm_mode(struct device *dev, struct device_attribute *attr,
148                              char *buf)
149 {
150         return sprintf(buf, "0\n");
151 }
152
153 /* Temperatures */
154 static ssize_t show_temp(struct device *dev, struct device_attribute *attr,
155                          char *buf)
156 {
157         int nr = to_sensor_dev_attr(attr)->index;
158         struct thmc50_data *data = thmc50_update_device(dev);
159         return sprintf(buf, "%d\n", data->temp_input[nr] * 1000);
160 }
161
162 static ssize_t show_temp_min(struct device *dev, struct device_attribute *attr,
163                              char *buf)
164 {
165         int nr = to_sensor_dev_attr(attr)->index;
166         struct thmc50_data *data = thmc50_update_device(dev);
167         return sprintf(buf, "%d\n", data->temp_min[nr] * 1000);
168 }
169
170 static ssize_t set_temp_min(struct device *dev, struct device_attribute *attr,
171                             const char *buf, size_t count)
172 {
173         int nr = to_sensor_dev_attr(attr)->index;
174         struct i2c_client *client = to_i2c_client(dev);
175         struct thmc50_data *data = i2c_get_clientdata(client);
176         int val = simple_strtol(buf, NULL, 10);
177
178         mutex_lock(&data->update_lock);
179         data->temp_min[nr] = SENSORS_LIMIT(val / 1000, -128, 127);
180         i2c_smbus_write_byte_data(client, THMC50_REG_TEMP_MIN[nr],
181                                   data->temp_min[nr]);
182         mutex_unlock(&data->update_lock);
183         return count;
184 }
185
186 static ssize_t show_temp_max(struct device *dev, struct device_attribute *attr,
187                              char *buf)
188 {
189         int nr = to_sensor_dev_attr(attr)->index;
190         struct thmc50_data *data = thmc50_update_device(dev);
191         return sprintf(buf, "%d\n", data->temp_max[nr] * 1000);
192 }
193
194 static ssize_t set_temp_max(struct device *dev, struct device_attribute *attr,
195                             const char *buf, size_t count)
196 {
197         int nr = to_sensor_dev_attr(attr)->index;
198         struct i2c_client *client = to_i2c_client(dev);
199         struct thmc50_data *data = i2c_get_clientdata(client);
200         int val = simple_strtol(buf, NULL, 10);
201
202         mutex_lock(&data->update_lock);
203         data->temp_max[nr] = SENSORS_LIMIT(val / 1000, -128, 127);
204         i2c_smbus_write_byte_data(client, THMC50_REG_TEMP_MAX[nr],
205                                   data->temp_max[nr]);
206         mutex_unlock(&data->update_lock);
207         return count;
208 }
209
210 static ssize_t show_temp_critical(struct device *dev,
211                                   struct device_attribute *attr,
212                                   char *buf)
213 {
214         int nr = to_sensor_dev_attr(attr)->index;
215         struct thmc50_data *data = thmc50_update_device(dev);
216         return sprintf(buf, "%d\n", data->temp_critical[nr] * 1000);
217 }
218
219 static ssize_t show_alarm(struct device *dev, struct device_attribute *attr,
220                           char *buf)
221 {
222         int index = to_sensor_dev_attr(attr)->index;
223         struct thmc50_data *data = thmc50_update_device(dev);
224
225         return sprintf(buf, "%u\n", (data->alarms >> index) & 1);
226 }
227
228 #define temp_reg(offset)                                                \
229 static SENSOR_DEVICE_ATTR(temp##offset##_input, S_IRUGO, show_temp,     \
230                         NULL, offset - 1);                              \
231 static SENSOR_DEVICE_ATTR(temp##offset##_min, S_IRUGO | S_IWUSR,        \
232                         show_temp_min, set_temp_min, offset - 1);       \
233 static SENSOR_DEVICE_ATTR(temp##offset##_max, S_IRUGO | S_IWUSR,        \
234                         show_temp_max, set_temp_max, offset - 1);       \
235 static SENSOR_DEVICE_ATTR(temp##offset##_crit, S_IRUGO,                 \
236                         show_temp_critical, NULL, offset - 1);
237
238 temp_reg(1);
239 temp_reg(2);
240 temp_reg(3);
241
242 static SENSOR_DEVICE_ATTR(temp1_alarm, S_IRUGO, show_alarm, NULL, 0);
243 static SENSOR_DEVICE_ATTR(temp2_alarm, S_IRUGO, show_alarm, NULL, 5);
244 static SENSOR_DEVICE_ATTR(temp3_alarm, S_IRUGO, show_alarm, NULL, 1);
245 static SENSOR_DEVICE_ATTR(temp2_fault, S_IRUGO, show_alarm, NULL, 7);
246 static SENSOR_DEVICE_ATTR(temp3_fault, S_IRUGO, show_alarm, NULL, 2);
247
248 static SENSOR_DEVICE_ATTR(pwm1, S_IRUGO | S_IWUSR, show_analog_out,
249                           set_analog_out, 0);
250 static SENSOR_DEVICE_ATTR(pwm1_mode, S_IRUGO, show_pwm_mode, NULL, 0);
251
252 static struct attribute *thmc50_attributes[] = {
253         &sensor_dev_attr_temp1_max.dev_attr.attr,
254         &sensor_dev_attr_temp1_min.dev_attr.attr,
255         &sensor_dev_attr_temp1_input.dev_attr.attr,
256         &sensor_dev_attr_temp1_crit.dev_attr.attr,
257         &sensor_dev_attr_temp1_alarm.dev_attr.attr,
258         &sensor_dev_attr_temp2_max.dev_attr.attr,
259         &sensor_dev_attr_temp2_min.dev_attr.attr,
260         &sensor_dev_attr_temp2_input.dev_attr.attr,
261         &sensor_dev_attr_temp2_crit.dev_attr.attr,
262         &sensor_dev_attr_temp2_alarm.dev_attr.attr,
263         &sensor_dev_attr_temp2_fault.dev_attr.attr,
264         &sensor_dev_attr_pwm1.dev_attr.attr,
265         &sensor_dev_attr_pwm1_mode.dev_attr.attr,
266         NULL
267 };
268
269 static const struct attribute_group thmc50_group = {
270         .attrs = thmc50_attributes,
271 };
272
273 /* for ADM1022 3rd temperature mode */
274 static struct attribute *temp3_attributes[] = {
275         &sensor_dev_attr_temp3_max.dev_attr.attr,
276         &sensor_dev_attr_temp3_min.dev_attr.attr,
277         &sensor_dev_attr_temp3_input.dev_attr.attr,
278         &sensor_dev_attr_temp3_crit.dev_attr.attr,
279         &sensor_dev_attr_temp3_alarm.dev_attr.attr,
280         &sensor_dev_attr_temp3_fault.dev_attr.attr,
281         NULL
282 };
283
284 static const struct attribute_group temp3_group = {
285         .attrs = temp3_attributes,
286 };
287
288 /* Return 0 if detection is successful, -ENODEV otherwise */
289 static int thmc50_detect(struct i2c_client *client,
290                          struct i2c_board_info *info)
291 {
292         unsigned company;
293         unsigned revision;
294         unsigned config;
295         struct i2c_adapter *adapter = client->adapter;
296         const char *type_name;
297
298         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA)) {
299                 pr_debug("thmc50: detect failed, "
300                          "smbus byte data not supported!\n");
301                 return -ENODEV;
302         }
303
304         pr_debug("thmc50: Probing for THMC50 at 0x%2X on bus %d\n",
305                  client->addr, i2c_adapter_id(client->adapter));
306
307         company = i2c_smbus_read_byte_data(client, THMC50_REG_COMPANY_ID);
308         revision = i2c_smbus_read_byte_data(client, THMC50_REG_DIE_CODE);
309         config = i2c_smbus_read_byte_data(client, THMC50_REG_CONF);
310         if (revision < 0xc0 || (config & 0x10))
311                 return -ENODEV;
312
313         if (company == 0x41) {
314                 int id = i2c_adapter_id(client->adapter);
315                 int i;
316
317                 type_name = "adm1022";
318                 for (i = 0; i + 1 < adm1022_temp3_num; i += 2)
319                         if (adm1022_temp3[i] == id &&
320                             adm1022_temp3[i + 1] == client->addr) {
321                                 /* enable 2nd remote temp */
322                                 config |= (1 << 7);
323                                 i2c_smbus_write_byte_data(client,
324                                                           THMC50_REG_CONF,
325                                                           config);
326                                 break;
327                         }
328         } else if (company == 0x49) {
329                 type_name = "thmc50";
330         } else {
331                 pr_debug("thmc50: Detection of THMC50/ADM1022 failed\n");
332                 return -ENODEV;
333         }
334
335         pr_debug("thmc50: Detected %s (version %x, revision %x)\n",
336                  type_name, (revision >> 4) - 0xc, revision & 0xf);
337
338         strlcpy(info->type, type_name, I2C_NAME_SIZE);
339
340         return 0;
341 }
342
343 static int thmc50_probe(struct i2c_client *client,
344                         const struct i2c_device_id *id)
345 {
346         struct thmc50_data *data;
347         int err;
348
349         data = kzalloc(sizeof(struct thmc50_data), GFP_KERNEL);
350         if (!data) {
351                 pr_debug("thmc50: detect failed, kzalloc failed!\n");
352                 err = -ENOMEM;
353                 goto exit;
354         }
355
356         i2c_set_clientdata(client, data);
357         data->type = id->driver_data;
358         mutex_init(&data->update_lock);
359
360         thmc50_init_client(client);
361
362         /* Register sysfs hooks */
363         if ((err = sysfs_create_group(&client->dev.kobj, &thmc50_group)))
364                 goto exit_free;
365
366         /* Register ADM1022 sysfs hooks */
367         if (data->has_temp3)
368                 if ((err = sysfs_create_group(&client->dev.kobj,
369                                               &temp3_group)))
370                         goto exit_remove_sysfs_thmc50;
371
372         /* Register a new directory entry with module sensors */
373         data->hwmon_dev = hwmon_device_register(&client->dev);
374         if (IS_ERR(data->hwmon_dev)) {
375                 err = PTR_ERR(data->hwmon_dev);
376                 goto exit_remove_sysfs;
377         }
378
379         return 0;
380
381 exit_remove_sysfs:
382         if (data->has_temp3)
383                 sysfs_remove_group(&client->dev.kobj, &temp3_group);
384 exit_remove_sysfs_thmc50:
385         sysfs_remove_group(&client->dev.kobj, &thmc50_group);
386 exit_free:
387         kfree(data);
388 exit:
389         return err;
390 }
391
392 static int thmc50_remove(struct i2c_client *client)
393 {
394         struct thmc50_data *data = i2c_get_clientdata(client);
395
396         hwmon_device_unregister(data->hwmon_dev);
397         sysfs_remove_group(&client->dev.kobj, &thmc50_group);
398         if (data->has_temp3)
399                 sysfs_remove_group(&client->dev.kobj, &temp3_group);
400
401         kfree(data);
402
403         return 0;
404 }
405
406 static void thmc50_init_client(struct i2c_client *client)
407 {
408         struct thmc50_data *data = i2c_get_clientdata(client);
409         int config;
410
411         data->analog_out = i2c_smbus_read_byte_data(client,
412                                                     THMC50_REG_ANALOG_OUT);
413         /* set up to at least 1 */
414         if (data->analog_out == 0) {
415                 data->analog_out = 1;
416                 i2c_smbus_write_byte_data(client, THMC50_REG_ANALOG_OUT,
417                                           data->analog_out);
418         }
419         config = i2c_smbus_read_byte_data(client, THMC50_REG_CONF);
420         config |= 0x1;  /* start the chip if it is in standby mode */
421         if (data->type == adm1022 && (config & (1 << 7)))
422                 data->has_temp3 = 1;
423         i2c_smbus_write_byte_data(client, THMC50_REG_CONF, config);
424 }
425
426 static struct thmc50_data *thmc50_update_device(struct device *dev)
427 {
428         struct i2c_client *client = to_i2c_client(dev);
429         struct thmc50_data *data = i2c_get_clientdata(client);
430         int timeout = HZ / 5 + (data->type == thmc50 ? HZ : 0);
431
432         mutex_lock(&data->update_lock);
433
434         if (time_after(jiffies, data->last_updated + timeout)
435             || !data->valid) {
436
437                 int temps = data->has_temp3 ? 3 : 2;
438                 int i;
439                 int prog = i2c_smbus_read_byte_data(client, THMC50_REG_CONF);
440
441                 prog &= THMC50_REG_CONF_PROGRAMMED;
442
443                 for (i = 0; i < temps; i++) {
444                         data->temp_input[i] = i2c_smbus_read_byte_data(client,
445                                                 THMC50_REG_TEMP[i]);
446                         data->temp_max[i] = i2c_smbus_read_byte_data(client,
447                                                 THMC50_REG_TEMP_MAX[i]);
448                         data->temp_min[i] = i2c_smbus_read_byte_data(client,
449                                                 THMC50_REG_TEMP_MIN[i]);
450                         data->temp_critical[i] =
451                                 i2c_smbus_read_byte_data(client,
452                                         prog ? THMC50_REG_TEMP_CRITICAL[i]
453                                              : THMC50_REG_TEMP_DEFAULT[i]);
454                 }
455                 data->analog_out =
456                     i2c_smbus_read_byte_data(client, THMC50_REG_ANALOG_OUT);
457                 data->alarms =
458                     i2c_smbus_read_byte_data(client, THMC50_REG_INTR);
459                 data->last_updated = jiffies;
460                 data->valid = 1;
461         }
462
463         mutex_unlock(&data->update_lock);
464
465         return data;
466 }
467
468 static int __init sm_thmc50_init(void)
469 {
470         return i2c_add_driver(&thmc50_driver);
471 }
472
473 static void __exit sm_thmc50_exit(void)
474 {
475         i2c_del_driver(&thmc50_driver);
476 }
477
478 MODULE_AUTHOR("Krzysztof Helt <krzysztof.h1@wp.pl>");
479 MODULE_DESCRIPTION("THMC50 driver");
480
481 module_init(sm_thmc50_init);
482 module_exit(sm_thmc50_exit);