include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit...
[linux-3.10.git] / drivers / hwmon / asus_atk0110.c
1 /*
2  * Copyright (C) 2007-2009 Luca Tettamanti <kronos.it@gmail.com>
3  *
4  * This file is released under the GPLv2
5  * See COPYING in the top level directory of the kernel tree.
6  */
7
8 #include <linux/debugfs.h>
9 #include <linux/kernel.h>
10 #include <linux/hwmon.h>
11 #include <linux/list.h>
12 #include <linux/module.h>
13 #include <linux/slab.h>
14
15 #include <acpi/acpi.h>
16 #include <acpi/acpixf.h>
17 #include <acpi/acpi_drivers.h>
18 #include <acpi/acpi_bus.h>
19
20
21 #define ATK_HID "ATK0110"
22
23 /* Minimum time between readings, enforced in order to avoid
24  * hogging the CPU.
25  */
26 #define CACHE_TIME              HZ
27
28 #define BOARD_ID                "MBIF"
29 #define METHOD_ENUMERATE        "GGRP"
30 #define METHOD_READ             "GITM"
31 #define METHOD_WRITE            "SITM"
32 #define METHOD_OLD_READ_TMP     "RTMP"
33 #define METHOD_OLD_READ_VLT     "RVLT"
34 #define METHOD_OLD_READ_FAN     "RFAN"
35 #define METHOD_OLD_ENUM_TMP     "TSIF"
36 #define METHOD_OLD_ENUM_VLT     "VSIF"
37 #define METHOD_OLD_ENUM_FAN     "FSIF"
38
39 #define ATK_MUX_HWMON           0x00000006ULL
40 #define ATK_MUX_MGMT            0x00000011ULL
41
42 #define ATK_CLASS_MASK          0xff000000ULL
43 #define ATK_CLASS_FREQ_CTL      0x03000000ULL
44 #define ATK_CLASS_FAN_CTL       0x04000000ULL
45 #define ATK_CLASS_HWMON         0x06000000ULL
46 #define ATK_CLASS_MGMT          0x11000000ULL
47
48 #define ATK_TYPE_MASK           0x00ff0000ULL
49 #define HWMON_TYPE_VOLT         0x00020000ULL
50 #define HWMON_TYPE_TEMP         0x00030000ULL
51 #define HWMON_TYPE_FAN          0x00040000ULL
52
53 #define ATK_ELEMENT_ID_MASK     0x0000ffffULL
54
55 #define ATK_EC_ID               0x11060004ULL
56
57 enum atk_pack_member {
58         HWMON_PACK_FLAGS,
59         HWMON_PACK_NAME,
60         HWMON_PACK_LIMIT1,
61         HWMON_PACK_LIMIT2,
62         HWMON_PACK_ENABLE
63 };
64
65 /* New package format */
66 #define _HWMON_NEW_PACK_SIZE    7
67 #define _HWMON_NEW_PACK_FLAGS   0
68 #define _HWMON_NEW_PACK_NAME    1
69 #define _HWMON_NEW_PACK_UNK1    2
70 #define _HWMON_NEW_PACK_UNK2    3
71 #define _HWMON_NEW_PACK_LIMIT1  4
72 #define _HWMON_NEW_PACK_LIMIT2  5
73 #define _HWMON_NEW_PACK_ENABLE  6
74
75 /* Old package format */
76 #define _HWMON_OLD_PACK_SIZE    5
77 #define _HWMON_OLD_PACK_FLAGS   0
78 #define _HWMON_OLD_PACK_NAME    1
79 #define _HWMON_OLD_PACK_LIMIT1  2
80 #define _HWMON_OLD_PACK_LIMIT2  3
81 #define _HWMON_OLD_PACK_ENABLE  4
82
83
84 struct atk_data {
85         struct device *hwmon_dev;
86         acpi_handle atk_handle;
87         struct acpi_device *acpi_dev;
88
89         bool old_interface;
90
91         /* old interface */
92         acpi_handle rtmp_handle;
93         acpi_handle rvlt_handle;
94         acpi_handle rfan_handle;
95         /* new inteface */
96         acpi_handle enumerate_handle;
97         acpi_handle read_handle;
98         acpi_handle write_handle;
99
100         bool disable_ec;
101
102         int voltage_count;
103         int temperature_count;
104         int fan_count;
105         struct list_head sensor_list;
106
107         struct {
108                 struct dentry *root;
109                 u32 id;
110         } debugfs;
111 };
112
113
114 typedef ssize_t (*sysfs_show_func)(struct device *dev,
115                         struct device_attribute *attr, char *buf);
116
117 static const struct acpi_device_id atk_ids[] = {
118         {ATK_HID, 0},
119         {"", 0},
120 };
121 MODULE_DEVICE_TABLE(acpi, atk_ids);
122
123 #define ATTR_NAME_SIZE 16 /* Worst case is "tempN_input" */
124
125 struct atk_sensor_data {
126         struct list_head list;
127         struct atk_data *data;
128         struct device_attribute label_attr;
129         struct device_attribute input_attr;
130         struct device_attribute limit1_attr;
131         struct device_attribute limit2_attr;
132         char label_attr_name[ATTR_NAME_SIZE];
133         char input_attr_name[ATTR_NAME_SIZE];
134         char limit1_attr_name[ATTR_NAME_SIZE];
135         char limit2_attr_name[ATTR_NAME_SIZE];
136         u64 id;
137         u64 type;
138         u64 limit1;
139         u64 limit2;
140         u64 cached_value;
141         unsigned long last_updated; /* in jiffies */
142         bool is_valid;
143         char const *acpi_name;
144 };
145
146 /* Return buffer format:
147  * [0-3] "value" is valid flag
148  * [4-7] value
149  * [8- ] unknown stuff on newer mobos
150  */
151 struct atk_acpi_ret_buffer {
152         u32 flags;
153         u32 value;
154         u8 data[];
155 };
156
157 /* Input buffer used for GITM and SITM methods */
158 struct atk_acpi_input_buf {
159         u32 id;
160         u32 param1;
161         u32 param2;
162 };
163
164 static int atk_add(struct acpi_device *device);
165 static int atk_remove(struct acpi_device *device, int type);
166 static void atk_print_sensor(struct atk_data *data, union acpi_object *obj);
167 static int atk_read_value(struct atk_sensor_data *sensor, u64 *value);
168 static void atk_free_sensors(struct atk_data *data);
169
170 static struct acpi_driver atk_driver = {
171         .name   = ATK_HID,
172         .class  = "hwmon",
173         .ids    = atk_ids,
174         .ops    = {
175                 .add    = atk_add,
176                 .remove = atk_remove,
177         },
178 };
179
180 #define input_to_atk_sensor(attr) \
181         container_of(attr, struct atk_sensor_data, input_attr)
182
183 #define label_to_atk_sensor(attr) \
184         container_of(attr, struct atk_sensor_data, label_attr)
185
186 #define limit1_to_atk_sensor(attr) \
187         container_of(attr, struct atk_sensor_data, limit1_attr)
188
189 #define limit2_to_atk_sensor(attr) \
190         container_of(attr, struct atk_sensor_data, limit2_attr)
191
192 static ssize_t atk_input_show(struct device *dev,
193                 struct device_attribute *attr, char *buf)
194 {
195         struct atk_sensor_data *s = input_to_atk_sensor(attr);
196         u64 value;
197         int err;
198
199         err = atk_read_value(s, &value);
200         if (err)
201                 return err;
202
203         if (s->type == HWMON_TYPE_TEMP)
204                 /* ACPI returns decidegree */
205                 value *= 100;
206
207         return sprintf(buf, "%llu\n", value);
208 }
209
210 static ssize_t atk_label_show(struct device *dev,
211                 struct device_attribute *attr, char *buf)
212 {
213         struct atk_sensor_data *s = label_to_atk_sensor(attr);
214
215         return sprintf(buf, "%s\n", s->acpi_name);
216 }
217
218 static ssize_t atk_limit1_show(struct device *dev,
219                 struct device_attribute *attr, char *buf)
220 {
221         struct atk_sensor_data *s = limit1_to_atk_sensor(attr);
222         u64 value = s->limit1;
223
224         if (s->type == HWMON_TYPE_TEMP)
225                 value *= 100;
226
227         return sprintf(buf, "%lld\n", value);
228 }
229
230 static ssize_t atk_limit2_show(struct device *dev,
231                 struct device_attribute *attr, char *buf)
232 {
233         struct atk_sensor_data *s = limit2_to_atk_sensor(attr);
234         u64 value = s->limit2;
235
236         if (s->type == HWMON_TYPE_TEMP)
237                 value *= 100;
238
239         return sprintf(buf, "%lld\n", value);
240 }
241
242 static ssize_t atk_name_show(struct device *dev,
243                                 struct device_attribute *attr, char *buf)
244 {
245         return sprintf(buf, "atk0110\n");
246 }
247 static struct device_attribute atk_name_attr =
248                 __ATTR(name, 0444, atk_name_show, NULL);
249
250 static void atk_init_attribute(struct device_attribute *attr, char *name,
251                 sysfs_show_func show)
252 {
253         attr->attr.name = name;
254         attr->attr.mode = 0444;
255         attr->show = show;
256         attr->store = NULL;
257 }
258
259
260 static union acpi_object *atk_get_pack_member(struct atk_data *data,
261                                                 union acpi_object *pack,
262                                                 enum atk_pack_member m)
263 {
264         bool old_if = data->old_interface;
265         int offset;
266
267         switch (m) {
268         case HWMON_PACK_FLAGS:
269                 offset = old_if ? _HWMON_OLD_PACK_FLAGS : _HWMON_NEW_PACK_FLAGS;
270                 break;
271         case HWMON_PACK_NAME:
272                 offset = old_if ? _HWMON_OLD_PACK_NAME : _HWMON_NEW_PACK_NAME;
273                 break;
274         case HWMON_PACK_LIMIT1:
275                 offset = old_if ? _HWMON_OLD_PACK_LIMIT1 :
276                                   _HWMON_NEW_PACK_LIMIT1;
277                 break;
278         case HWMON_PACK_LIMIT2:
279                 offset = old_if ? _HWMON_OLD_PACK_LIMIT2 :
280                                   _HWMON_NEW_PACK_LIMIT2;
281                 break;
282         case HWMON_PACK_ENABLE:
283                 offset = old_if ? _HWMON_OLD_PACK_ENABLE :
284                                   _HWMON_NEW_PACK_ENABLE;
285                 break;
286         default:
287                 return NULL;
288         }
289
290         return &pack->package.elements[offset];
291 }
292
293
294 /* New package format is:
295  * - flag (int)
296  *      class - used for de-muxing the request to the correct GITn
297  *      type (volt, temp, fan)
298  *      sensor id |
299  *      sensor id - used for de-muxing the request _inside_ the GITn
300  * - name (str)
301  * - unknown (int)
302  * - unknown (int)
303  * - limit1 (int)
304  * - limit2 (int)
305  * - enable (int)
306  *
307  * The old package has the same format but it's missing the two unknown fields.
308  */
309 static int validate_hwmon_pack(struct atk_data *data, union acpi_object *obj)
310 {
311         struct device *dev = &data->acpi_dev->dev;
312         union acpi_object *tmp;
313         bool old_if = data->old_interface;
314         int const expected_size = old_if ? _HWMON_OLD_PACK_SIZE :
315                                            _HWMON_NEW_PACK_SIZE;
316
317         if (obj->type != ACPI_TYPE_PACKAGE) {
318                 dev_warn(dev, "Invalid type: %d\n", obj->type);
319                 return -EINVAL;
320         }
321
322         if (obj->package.count != expected_size) {
323                 dev_warn(dev, "Invalid package size: %d, expected: %d\n",
324                                 obj->package.count, expected_size);
325                 return -EINVAL;
326         }
327
328         tmp = atk_get_pack_member(data, obj, HWMON_PACK_FLAGS);
329         if (tmp->type != ACPI_TYPE_INTEGER) {
330                 dev_warn(dev, "Invalid type (flag): %d\n", tmp->type);
331                 return -EINVAL;
332         }
333
334         tmp = atk_get_pack_member(data, obj, HWMON_PACK_NAME);
335         if (tmp->type != ACPI_TYPE_STRING) {
336                 dev_warn(dev, "Invalid type (name): %d\n", tmp->type);
337                 return -EINVAL;
338         }
339
340         /* Don't check... we don't know what they're useful for anyway */
341 #if 0
342         tmp = &obj->package.elements[HWMON_PACK_UNK1];
343         if (tmp->type != ACPI_TYPE_INTEGER) {
344                 dev_warn(dev, "Invalid type (unk1): %d\n", tmp->type);
345                 return -EINVAL;
346         }
347
348         tmp = &obj->package.elements[HWMON_PACK_UNK2];
349         if (tmp->type != ACPI_TYPE_INTEGER) {
350                 dev_warn(dev, "Invalid type (unk2): %d\n", tmp->type);
351                 return -EINVAL;
352         }
353 #endif
354
355         tmp = atk_get_pack_member(data, obj, HWMON_PACK_LIMIT1);
356         if (tmp->type != ACPI_TYPE_INTEGER) {
357                 dev_warn(dev, "Invalid type (limit1): %d\n", tmp->type);
358                 return -EINVAL;
359         }
360
361         tmp = atk_get_pack_member(data, obj, HWMON_PACK_LIMIT2);
362         if (tmp->type != ACPI_TYPE_INTEGER) {
363                 dev_warn(dev, "Invalid type (limit2): %d\n", tmp->type);
364                 return -EINVAL;
365         }
366
367         tmp = atk_get_pack_member(data, obj, HWMON_PACK_ENABLE);
368         if (tmp->type != ACPI_TYPE_INTEGER) {
369                 dev_warn(dev, "Invalid type (enable): %d\n", tmp->type);
370                 return -EINVAL;
371         }
372
373         atk_print_sensor(data, obj);
374
375         return 0;
376 }
377
378 #ifdef DEBUG
379 static char const *atk_sensor_type(union acpi_object *flags)
380 {
381         u64 type = flags->integer.value & ATK_TYPE_MASK;
382         char const *what;
383
384         switch (type) {
385         case HWMON_TYPE_VOLT:
386                 what = "voltage";
387                 break;
388         case HWMON_TYPE_TEMP:
389                 what = "temperature";
390                 break;
391         case HWMON_TYPE_FAN:
392                 what = "fan";
393                 break;
394         default:
395                 what = "unknown";
396                 break;
397         }
398
399         return what;
400 }
401 #endif
402
403 static void atk_print_sensor(struct atk_data *data, union acpi_object *obj)
404 {
405 #ifdef DEBUG
406         struct device *dev = &data->acpi_dev->dev;
407         union acpi_object *flags;
408         union acpi_object *name;
409         union acpi_object *limit1;
410         union acpi_object *limit2;
411         union acpi_object *enable;
412         char const *what;
413
414         flags = atk_get_pack_member(data, obj, HWMON_PACK_FLAGS);
415         name = atk_get_pack_member(data, obj, HWMON_PACK_NAME);
416         limit1 = atk_get_pack_member(data, obj, HWMON_PACK_LIMIT1);
417         limit2 = atk_get_pack_member(data, obj, HWMON_PACK_LIMIT2);
418         enable = atk_get_pack_member(data, obj, HWMON_PACK_ENABLE);
419
420         what = atk_sensor_type(flags);
421
422         dev_dbg(dev, "%s: %#llx %s [%llu-%llu] %s\n", what,
423                         flags->integer.value,
424                         name->string.pointer,
425                         limit1->integer.value, limit2->integer.value,
426                         enable->integer.value ? "enabled" : "disabled");
427 #endif
428 }
429
430 static int atk_read_value_old(struct atk_sensor_data *sensor, u64 *value)
431 {
432         struct atk_data *data = sensor->data;
433         struct device *dev = &data->acpi_dev->dev;
434         struct acpi_object_list params;
435         union acpi_object id;
436         acpi_status status;
437         acpi_handle method;
438
439         switch (sensor->type) {
440         case HWMON_TYPE_VOLT:
441                 method = data->rvlt_handle;
442                 break;
443         case HWMON_TYPE_TEMP:
444                 method = data->rtmp_handle;
445                 break;
446         case HWMON_TYPE_FAN:
447                 method = data->rfan_handle;
448                 break;
449         default:
450                 return -EINVAL;
451         }
452
453         id.type = ACPI_TYPE_INTEGER;
454         id.integer.value = sensor->id;
455
456         params.count = 1;
457         params.pointer = &id;
458
459         status = acpi_evaluate_integer(method, NULL, &params, value);
460         if (status != AE_OK) {
461                 dev_warn(dev, "%s: ACPI exception: %s\n", __func__,
462                                 acpi_format_exception(status));
463                 return -EIO;
464         }
465
466         return 0;
467 }
468
469 static union acpi_object *atk_ggrp(struct atk_data *data, u16 mux)
470 {
471         struct device *dev = &data->acpi_dev->dev;
472         struct acpi_buffer buf;
473         acpi_status ret;
474         struct acpi_object_list params;
475         union acpi_object id;
476         union acpi_object *pack;
477
478         id.type = ACPI_TYPE_INTEGER;
479         id.integer.value = mux;
480         params.count = 1;
481         params.pointer = &id;
482
483         buf.length = ACPI_ALLOCATE_BUFFER;
484         ret = acpi_evaluate_object(data->enumerate_handle, NULL, &params, &buf);
485         if (ret != AE_OK) {
486                 dev_err(dev, "GGRP[%#x] ACPI exception: %s\n", mux,
487                                 acpi_format_exception(ret));
488                 return ERR_PTR(-EIO);
489         }
490         pack = buf.pointer;
491         if (pack->type != ACPI_TYPE_PACKAGE) {
492                 /* Execution was successful, but the id was not found */
493                 ACPI_FREE(pack);
494                 return ERR_PTR(-ENOENT);
495         }
496
497         if (pack->package.count < 1) {
498                 dev_err(dev, "GGRP[%#x] package is too small\n", mux);
499                 ACPI_FREE(pack);
500                 return ERR_PTR(-EIO);
501         }
502         return pack;
503 }
504
505 static union acpi_object *atk_gitm(struct atk_data *data, u64 id)
506 {
507         struct device *dev = &data->acpi_dev->dev;
508         struct atk_acpi_input_buf buf;
509         union acpi_object tmp;
510         struct acpi_object_list params;
511         struct acpi_buffer ret;
512         union acpi_object *obj;
513         acpi_status status;
514
515         buf.id = id;
516         buf.param1 = 0;
517         buf.param2 = 0;
518
519         tmp.type = ACPI_TYPE_BUFFER;
520         tmp.buffer.pointer = (u8 *)&buf;
521         tmp.buffer.length = sizeof(buf);
522
523         params.count = 1;
524         params.pointer = (void *)&tmp;
525
526         ret.length = ACPI_ALLOCATE_BUFFER;
527         status = acpi_evaluate_object_typed(data->read_handle, NULL, &params,
528                         &ret, ACPI_TYPE_BUFFER);
529         if (status != AE_OK) {
530                 dev_warn(dev, "GITM[%#llx] ACPI exception: %s\n", id,
531                                 acpi_format_exception(status));
532                 return ERR_PTR(-EIO);
533         }
534         obj = ret.pointer;
535
536         /* Sanity check */
537         if (obj->buffer.length < 8) {
538                 dev_warn(dev, "Unexpected ASBF length: %u\n",
539                                 obj->buffer.length);
540                 ACPI_FREE(obj);
541                 return ERR_PTR(-EIO);
542         }
543         return obj;
544 }
545
546 static union acpi_object *atk_sitm(struct atk_data *data,
547                 struct atk_acpi_input_buf *buf)
548 {
549         struct device *dev = &data->acpi_dev->dev;
550         struct acpi_object_list params;
551         union acpi_object tmp;
552         struct acpi_buffer ret;
553         union acpi_object *obj;
554         acpi_status status;
555
556         tmp.type = ACPI_TYPE_BUFFER;
557         tmp.buffer.pointer = (u8 *)buf;
558         tmp.buffer.length = sizeof(*buf);
559
560         params.count = 1;
561         params.pointer = &tmp;
562
563         ret.length = ACPI_ALLOCATE_BUFFER;
564         status = acpi_evaluate_object_typed(data->write_handle, NULL, &params,
565                         &ret, ACPI_TYPE_BUFFER);
566         if (status != AE_OK) {
567                 dev_warn(dev, "SITM[%#x] ACPI exception: %s\n", buf->id,
568                                 acpi_format_exception(status));
569                 return ERR_PTR(-EIO);
570         }
571         obj = ret.pointer;
572
573         /* Sanity check */
574         if (obj->buffer.length < 8) {
575                 dev_warn(dev, "Unexpected ASBF length: %u\n",
576                                 obj->buffer.length);
577                 ACPI_FREE(obj);
578                 return ERR_PTR(-EIO);
579         }
580         return obj;
581 }
582
583 static int atk_read_value_new(struct atk_sensor_data *sensor, u64 *value)
584 {
585         struct atk_data *data = sensor->data;
586         struct device *dev = &data->acpi_dev->dev;
587         union acpi_object *obj;
588         struct atk_acpi_ret_buffer *buf;
589         int err = 0;
590
591         obj = atk_gitm(data, sensor->id);
592         if (IS_ERR(obj))
593                 return PTR_ERR(obj);
594
595         buf = (struct atk_acpi_ret_buffer *)obj->buffer.pointer;
596         if (buf->flags == 0) {
597                 /* The reading is not valid, possible causes:
598                  * - sensor failure
599                  * - enumeration was FUBAR (and we didn't notice)
600                  */
601                 dev_warn(dev, "Read failed, sensor = %#llx\n", sensor->id);
602                 err = -EIO;
603                 goto out;
604         }
605
606         *value = buf->value;
607 out:
608         ACPI_FREE(obj);
609         return err;
610 }
611
612 static int atk_read_value(struct atk_sensor_data *sensor, u64 *value)
613 {
614         int err;
615
616         if (!sensor->is_valid ||
617             time_after(jiffies, sensor->last_updated + CACHE_TIME)) {
618                 if (sensor->data->old_interface)
619                         err = atk_read_value_old(sensor, value);
620                 else
621                         err = atk_read_value_new(sensor, value);
622
623                 sensor->is_valid = true;
624                 sensor->last_updated = jiffies;
625                 sensor->cached_value = *value;
626         } else {
627                 *value = sensor->cached_value;
628                 err = 0;
629         }
630
631         return err;
632 }
633
634 #ifdef CONFIG_DEBUG_FS
635 static int atk_debugfs_gitm_get(void *p, u64 *val)
636 {
637         struct atk_data *data = p;
638         union acpi_object *ret;
639         struct atk_acpi_ret_buffer *buf;
640         int err = 0;
641
642         if (!data->read_handle)
643                 return -ENODEV;
644
645         if (!data->debugfs.id)
646                 return -EINVAL;
647
648         ret = atk_gitm(data, data->debugfs.id);
649         if (IS_ERR(ret))
650                 return PTR_ERR(ret);
651
652         buf = (struct atk_acpi_ret_buffer *)ret->buffer.pointer;
653         if (buf->flags)
654                 *val = buf->value;
655         else
656                 err = -EIO;
657
658         return err;
659 }
660
661 DEFINE_SIMPLE_ATTRIBUTE(atk_debugfs_gitm,
662                         atk_debugfs_gitm_get,
663                         NULL,
664                         "0x%08llx\n")
665
666 static int atk_acpi_print(char *buf, size_t sz, union acpi_object *obj)
667 {
668         int ret = 0;
669
670         switch (obj->type) {
671         case ACPI_TYPE_INTEGER:
672                 ret = snprintf(buf, sz, "0x%08llx\n", obj->integer.value);
673                 break;
674         case ACPI_TYPE_STRING:
675                 ret = snprintf(buf, sz, "%s\n", obj->string.pointer);
676                 break;
677         }
678
679         return ret;
680 }
681
682 static void atk_pack_print(char *buf, size_t sz, union acpi_object *pack)
683 {
684         int ret;
685         int i;
686
687         for (i = 0; i < pack->package.count; i++) {
688                 union acpi_object *obj = &pack->package.elements[i];
689
690                 ret = atk_acpi_print(buf, sz, obj);
691                 if (ret >= sz)
692                         break;
693                 buf += ret;
694                 sz -= ret;
695         }
696 }
697
698 static int atk_debugfs_ggrp_open(struct inode *inode, struct file *file)
699 {
700         struct atk_data *data = inode->i_private;
701         char *buf = NULL;
702         union acpi_object *ret;
703         u8 cls;
704         int i;
705
706         if (!data->enumerate_handle)
707                 return -ENODEV;
708         if (!data->debugfs.id)
709                 return -EINVAL;
710
711         cls = (data->debugfs.id & 0xff000000) >> 24;
712         ret = atk_ggrp(data, cls);
713         if (IS_ERR(ret))
714                 return PTR_ERR(ret);
715
716         for (i = 0; i < ret->package.count; i++) {
717                 union acpi_object *pack = &ret->package.elements[i];
718                 union acpi_object *id;
719
720                 if (pack->type != ACPI_TYPE_PACKAGE)
721                         continue;
722                 if (!pack->package.count)
723                         continue;
724                 id = &pack->package.elements[0];
725                 if (id->integer.value == data->debugfs.id) {
726                         /* Print the package */
727                         buf = kzalloc(512, GFP_KERNEL);
728                         if (!buf) {
729                                 ACPI_FREE(ret);
730                                 return -ENOMEM;
731                         }
732                         atk_pack_print(buf, 512, pack);
733                         break;
734                 }
735         }
736         ACPI_FREE(ret);
737
738         if (!buf)
739                 return -EINVAL;
740
741         file->private_data = buf;
742
743         return nonseekable_open(inode, file);
744 }
745
746 static ssize_t atk_debugfs_ggrp_read(struct file *file, char __user *buf,
747                 size_t count, loff_t *pos)
748 {
749         char *str = file->private_data;
750         size_t len = strlen(str);
751
752         return simple_read_from_buffer(buf, count, pos, str, len);
753 }
754
755 static int atk_debugfs_ggrp_release(struct inode *inode, struct file *file)
756 {
757         kfree(file->private_data);
758         return 0;
759 }
760
761 static const struct file_operations atk_debugfs_ggrp_fops = {
762         .read           = atk_debugfs_ggrp_read,
763         .open           = atk_debugfs_ggrp_open,
764         .release        = atk_debugfs_ggrp_release,
765 };
766
767 static void atk_debugfs_init(struct atk_data *data)
768 {
769         struct dentry *d;
770         struct dentry *f;
771
772         data->debugfs.id = 0;
773
774         d = debugfs_create_dir("asus_atk0110", NULL);
775         if (!d || IS_ERR(d))
776                 return;
777
778         f = debugfs_create_x32("id", S_IRUSR | S_IWUSR, d, &data->debugfs.id);
779         if (!f || IS_ERR(f))
780                 goto cleanup;
781
782         f = debugfs_create_file("gitm", S_IRUSR, d, data,
783                         &atk_debugfs_gitm);
784         if (!f || IS_ERR(f))
785                 goto cleanup;
786
787         f = debugfs_create_file("ggrp", S_IRUSR, d, data,
788                         &atk_debugfs_ggrp_fops);
789         if (!f || IS_ERR(f))
790                 goto cleanup;
791
792         data->debugfs.root = d;
793
794         return;
795 cleanup:
796         debugfs_remove_recursive(d);
797 }
798
799 static void atk_debugfs_cleanup(struct atk_data *data)
800 {
801         debugfs_remove_recursive(data->debugfs.root);
802 }
803
804 #else /* CONFIG_DEBUG_FS */
805
806 static void atk_debugfs_init(struct atk_data *data)
807 {
808 }
809
810 static void atk_debugfs_cleanup(struct atk_data *data)
811 {
812 }
813 #endif
814
815 static int atk_add_sensor(struct atk_data *data, union acpi_object *obj)
816 {
817         struct device *dev = &data->acpi_dev->dev;
818         union acpi_object *flags;
819         union acpi_object *name;
820         union acpi_object *limit1;
821         union acpi_object *limit2;
822         union acpi_object *enable;
823         struct atk_sensor_data *sensor;
824         char const *base_name;
825         char const *limit1_name;
826         char const *limit2_name;
827         u64 type;
828         int err;
829         int *num;
830         int start;
831
832         if (obj->type != ACPI_TYPE_PACKAGE) {
833                 /* wft is this? */
834                 dev_warn(dev, "Unknown type for ACPI object: (%d)\n",
835                                 obj->type);
836                 return -EINVAL;
837         }
838
839         err = validate_hwmon_pack(data, obj);
840         if (err)
841                 return err;
842
843         /* Ok, we have a valid hwmon package */
844         type = atk_get_pack_member(data, obj, HWMON_PACK_FLAGS)->integer.value
845                & ATK_TYPE_MASK;
846
847         switch (type) {
848         case HWMON_TYPE_VOLT:
849                 base_name = "in";
850                 limit1_name = "min";
851                 limit2_name = "max";
852                 num = &data->voltage_count;
853                 start = 0;
854                 break;
855         case HWMON_TYPE_TEMP:
856                 base_name = "temp";
857                 limit1_name = "max";
858                 limit2_name = "crit";
859                 num = &data->temperature_count;
860                 start = 1;
861                 break;
862         case HWMON_TYPE_FAN:
863                 base_name = "fan";
864                 limit1_name = "min";
865                 limit2_name = "max";
866                 num = &data->fan_count;
867                 start = 1;
868                 break;
869         default:
870                 dev_warn(dev, "Unknown sensor type: %#llx\n", type);
871                 return -EINVAL;
872         }
873
874         enable = atk_get_pack_member(data, obj, HWMON_PACK_ENABLE);
875         if (!enable->integer.value)
876                 /* sensor is disabled */
877                 return 0;
878
879         flags = atk_get_pack_member(data, obj, HWMON_PACK_FLAGS);
880         name = atk_get_pack_member(data, obj, HWMON_PACK_NAME);
881         limit1 = atk_get_pack_member(data, obj, HWMON_PACK_LIMIT1);
882         limit2 = atk_get_pack_member(data, obj, HWMON_PACK_LIMIT2);
883
884         sensor = kzalloc(sizeof(*sensor), GFP_KERNEL);
885         if (!sensor)
886                 return -ENOMEM;
887
888         sensor->acpi_name = kstrdup(name->string.pointer, GFP_KERNEL);
889         if (!sensor->acpi_name) {
890                 err = -ENOMEM;
891                 goto out;
892         }
893
894         INIT_LIST_HEAD(&sensor->list);
895         sensor->type = type;
896         sensor->data = data;
897         sensor->id = flags->integer.value;
898         sensor->limit1 = limit1->integer.value;
899         if (data->old_interface)
900                 sensor->limit2 = limit2->integer.value;
901         else
902                 /* The upper limit is expressed as delta from lower limit */
903                 sensor->limit2 = sensor->limit1 + limit2->integer.value;
904
905         snprintf(sensor->input_attr_name, ATTR_NAME_SIZE,
906                         "%s%d_input", base_name, start + *num);
907         atk_init_attribute(&sensor->input_attr,
908                         sensor->input_attr_name,
909                         atk_input_show);
910
911         snprintf(sensor->label_attr_name, ATTR_NAME_SIZE,
912                         "%s%d_label", base_name, start + *num);
913         atk_init_attribute(&sensor->label_attr,
914                         sensor->label_attr_name,
915                         atk_label_show);
916
917         snprintf(sensor->limit1_attr_name, ATTR_NAME_SIZE,
918                         "%s%d_%s", base_name, start + *num, limit1_name);
919         atk_init_attribute(&sensor->limit1_attr,
920                         sensor->limit1_attr_name,
921                         atk_limit1_show);
922
923         snprintf(sensor->limit2_attr_name, ATTR_NAME_SIZE,
924                         "%s%d_%s", base_name, start + *num, limit2_name);
925         atk_init_attribute(&sensor->limit2_attr,
926                         sensor->limit2_attr_name,
927                         atk_limit2_show);
928
929         list_add(&sensor->list, &data->sensor_list);
930         (*num)++;
931
932         return 1;
933 out:
934         kfree(sensor->acpi_name);
935         kfree(sensor);
936         return err;
937 }
938
939 static int atk_enumerate_old_hwmon(struct atk_data *data)
940 {
941         struct device *dev = &data->acpi_dev->dev;
942         struct acpi_buffer buf;
943         union acpi_object *pack;
944         acpi_status status;
945         int i, ret;
946         int count = 0;
947
948         /* Voltages */
949         buf.length = ACPI_ALLOCATE_BUFFER;
950         status = acpi_evaluate_object_typed(data->atk_handle,
951                         METHOD_OLD_ENUM_VLT, NULL, &buf, ACPI_TYPE_PACKAGE);
952         if (status != AE_OK) {
953                 dev_warn(dev, METHOD_OLD_ENUM_VLT ": ACPI exception: %s\n",
954                                 acpi_format_exception(status));
955
956                 return -ENODEV;
957         }
958
959         pack = buf.pointer;
960         for (i = 1; i < pack->package.count; i++) {
961                 union acpi_object *obj = &pack->package.elements[i];
962
963                 ret = atk_add_sensor(data, obj);
964                 if (ret > 0)
965                         count++;
966         }
967         ACPI_FREE(buf.pointer);
968
969         /* Temperatures */
970         buf.length = ACPI_ALLOCATE_BUFFER;
971         status = acpi_evaluate_object_typed(data->atk_handle,
972                         METHOD_OLD_ENUM_TMP, NULL, &buf, ACPI_TYPE_PACKAGE);
973         if (status != AE_OK) {
974                 dev_warn(dev, METHOD_OLD_ENUM_TMP ": ACPI exception: %s\n",
975                                 acpi_format_exception(status));
976
977                 ret = -ENODEV;
978                 goto cleanup;
979         }
980
981         pack = buf.pointer;
982         for (i = 1; i < pack->package.count; i++) {
983                 union acpi_object *obj = &pack->package.elements[i];
984
985                 ret = atk_add_sensor(data, obj);
986                 if (ret > 0)
987                         count++;
988         }
989         ACPI_FREE(buf.pointer);
990
991         /* Fans */
992         buf.length = ACPI_ALLOCATE_BUFFER;
993         status = acpi_evaluate_object_typed(data->atk_handle,
994                         METHOD_OLD_ENUM_FAN, NULL, &buf, ACPI_TYPE_PACKAGE);
995         if (status != AE_OK) {
996                 dev_warn(dev, METHOD_OLD_ENUM_FAN ": ACPI exception: %s\n",
997                                 acpi_format_exception(status));
998
999                 ret = -ENODEV;
1000                 goto cleanup;
1001         }
1002
1003         pack = buf.pointer;
1004         for (i = 1; i < pack->package.count; i++) {
1005                 union acpi_object *obj = &pack->package.elements[i];
1006
1007                 ret = atk_add_sensor(data, obj);
1008                 if (ret > 0)
1009                         count++;
1010         }
1011         ACPI_FREE(buf.pointer);
1012
1013         return count;
1014 cleanup:
1015         atk_free_sensors(data);
1016         return ret;
1017 }
1018
1019 static int atk_ec_present(struct atk_data *data)
1020 {
1021         struct device *dev = &data->acpi_dev->dev;
1022         union acpi_object *pack;
1023         union acpi_object *ec;
1024         int ret;
1025         int i;
1026
1027         pack = atk_ggrp(data, ATK_MUX_MGMT);
1028         if (IS_ERR(pack)) {
1029                 if (PTR_ERR(pack) == -ENOENT) {
1030                         /* The MGMT class does not exists - that's ok */
1031                         dev_dbg(dev, "Class %#llx not found\n", ATK_MUX_MGMT);
1032                         return 0;
1033                 }
1034                 return PTR_ERR(pack);
1035         }
1036
1037         /* Search the EC */
1038         ec = NULL;
1039         for (i = 0; i < pack->package.count; i++) {
1040                 union acpi_object *obj = &pack->package.elements[i];
1041                 union acpi_object *id;
1042
1043                 if (obj->type != ACPI_TYPE_PACKAGE)
1044                         continue;
1045
1046                 id = &obj->package.elements[0];
1047                 if (id->type != ACPI_TYPE_INTEGER)
1048                         continue;
1049
1050                 if (id->integer.value == ATK_EC_ID) {
1051                         ec = obj;
1052                         break;
1053                 }
1054         }
1055
1056         ret = (ec != NULL);
1057         if (!ret)
1058                 /* The system has no EC */
1059                 dev_dbg(dev, "EC not found\n");
1060
1061         ACPI_FREE(pack);
1062         return ret;
1063 }
1064
1065 static int atk_ec_enabled(struct atk_data *data)
1066 {
1067         struct device *dev = &data->acpi_dev->dev;
1068         union acpi_object *obj;
1069         struct atk_acpi_ret_buffer *buf;
1070         int err;
1071
1072         obj = atk_gitm(data, ATK_EC_ID);
1073         if (IS_ERR(obj)) {
1074                 dev_err(dev, "Unable to query EC status\n");
1075                 return PTR_ERR(obj);
1076         }
1077         buf = (struct atk_acpi_ret_buffer *)obj->buffer.pointer;
1078
1079         if (buf->flags == 0) {
1080                 dev_err(dev, "Unable to query EC status\n");
1081                 err = -EIO;
1082         } else {
1083                 err = (buf->value != 0);
1084                 dev_dbg(dev, "EC is %sabled\n",
1085                                 err ? "en" : "dis");
1086         }
1087
1088         ACPI_FREE(obj);
1089         return err;
1090 }
1091
1092 static int atk_ec_ctl(struct atk_data *data, int enable)
1093 {
1094         struct device *dev = &data->acpi_dev->dev;
1095         union acpi_object *obj;
1096         struct atk_acpi_input_buf sitm;
1097         struct atk_acpi_ret_buffer *ec_ret;
1098         int err = 0;
1099
1100         sitm.id = ATK_EC_ID;
1101         sitm.param1 = enable;
1102         sitm.param2 = 0;
1103
1104         obj = atk_sitm(data, &sitm);
1105         if (IS_ERR(obj)) {
1106                 dev_err(dev, "Failed to %sable the EC\n",
1107                                 enable ? "en" : "dis");
1108                 return PTR_ERR(obj);
1109         }
1110         ec_ret = (struct atk_acpi_ret_buffer *)obj->buffer.pointer;
1111         if (ec_ret->flags == 0) {
1112                 dev_err(dev, "Failed to %sable the EC\n",
1113                                 enable ? "en" : "dis");
1114                 err = -EIO;
1115         } else {
1116                 dev_info(dev, "EC %sabled\n",
1117                                 enable ? "en" : "dis");
1118         }
1119
1120         ACPI_FREE(obj);
1121         return err;
1122 }
1123
1124 static int atk_enumerate_new_hwmon(struct atk_data *data)
1125 {
1126         struct device *dev = &data->acpi_dev->dev;
1127         union acpi_object *pack;
1128         int err;
1129         int i;
1130
1131         err = atk_ec_present(data);
1132         if (err < 0)
1133                 return err;
1134         if (err) {
1135                 err = atk_ec_enabled(data);
1136                 if (err < 0)
1137                         return err;
1138                 /* If the EC was disabled we will disable it again on unload */
1139                 data->disable_ec = err;
1140
1141                 err = atk_ec_ctl(data, 1);
1142                 if (err) {
1143                         data->disable_ec = false;
1144                         return err;
1145                 }
1146         }
1147
1148         dev_dbg(dev, "Enumerating hwmon sensors\n");
1149
1150         pack = atk_ggrp(data, ATK_MUX_HWMON);
1151         if (IS_ERR(pack))
1152                 return PTR_ERR(pack);
1153
1154         for (i = 0; i < pack->package.count; i++) {
1155                 union acpi_object *obj = &pack->package.elements[i];
1156
1157                 atk_add_sensor(data, obj);
1158         }
1159
1160         err = data->voltage_count + data->temperature_count + data->fan_count;
1161
1162         ACPI_FREE(pack);
1163         return err;
1164 }
1165
1166 static int atk_create_files(struct atk_data *data)
1167 {
1168         struct atk_sensor_data *s;
1169         int err;
1170
1171         list_for_each_entry(s, &data->sensor_list, list) {
1172                 err = device_create_file(data->hwmon_dev, &s->input_attr);
1173                 if (err)
1174                         return err;
1175                 err = device_create_file(data->hwmon_dev, &s->label_attr);
1176                 if (err)
1177                         return err;
1178                 err = device_create_file(data->hwmon_dev, &s->limit1_attr);
1179                 if (err)
1180                         return err;
1181                 err = device_create_file(data->hwmon_dev, &s->limit2_attr);
1182                 if (err)
1183                         return err;
1184         }
1185
1186         err = device_create_file(data->hwmon_dev, &atk_name_attr);
1187
1188         return err;
1189 }
1190
1191 static void atk_remove_files(struct atk_data *data)
1192 {
1193         struct atk_sensor_data *s;
1194
1195         list_for_each_entry(s, &data->sensor_list, list) {
1196                 device_remove_file(data->hwmon_dev, &s->input_attr);
1197                 device_remove_file(data->hwmon_dev, &s->label_attr);
1198                 device_remove_file(data->hwmon_dev, &s->limit1_attr);
1199                 device_remove_file(data->hwmon_dev, &s->limit2_attr);
1200         }
1201         device_remove_file(data->hwmon_dev, &atk_name_attr);
1202 }
1203
1204 static void atk_free_sensors(struct atk_data *data)
1205 {
1206         struct list_head *head = &data->sensor_list;
1207         struct atk_sensor_data *s, *tmp;
1208
1209         list_for_each_entry_safe(s, tmp, head, list) {
1210                 kfree(s->acpi_name);
1211                 kfree(s);
1212         }
1213 }
1214
1215 static int atk_register_hwmon(struct atk_data *data)
1216 {
1217         struct device *dev = &data->acpi_dev->dev;
1218         int err;
1219
1220         dev_dbg(dev, "registering hwmon device\n");
1221         data->hwmon_dev = hwmon_device_register(dev);
1222         if (IS_ERR(data->hwmon_dev))
1223                 return PTR_ERR(data->hwmon_dev);
1224
1225         dev_dbg(dev, "populating sysfs directory\n");
1226         err = atk_create_files(data);
1227         if (err)
1228                 goto remove;
1229
1230         return 0;
1231 remove:
1232         /* Cleanup the registered files */
1233         atk_remove_files(data);
1234         hwmon_device_unregister(data->hwmon_dev);
1235         return err;
1236 }
1237
1238 static int atk_probe_if(struct atk_data *data)
1239 {
1240         struct device *dev = &data->acpi_dev->dev;
1241         acpi_handle ret;
1242         acpi_status status;
1243         int err = 0;
1244
1245         /* RTMP: read temperature */
1246         status = acpi_get_handle(data->atk_handle, METHOD_OLD_READ_TMP, &ret);
1247         if (ACPI_SUCCESS(status))
1248                 data->rtmp_handle = ret;
1249         else
1250                 dev_dbg(dev, "method " METHOD_OLD_READ_TMP " not found: %s\n",
1251                                 acpi_format_exception(status));
1252
1253         /* RVLT: read voltage */
1254         status = acpi_get_handle(data->atk_handle, METHOD_OLD_READ_VLT, &ret);
1255         if (ACPI_SUCCESS(status))
1256                 data->rvlt_handle = ret;
1257         else
1258                 dev_dbg(dev, "method " METHOD_OLD_READ_VLT " not found: %s\n",
1259                                 acpi_format_exception(status));
1260
1261         /* RFAN: read fan status */
1262         status = acpi_get_handle(data->atk_handle, METHOD_OLD_READ_FAN, &ret);
1263         if (ACPI_SUCCESS(status))
1264                 data->rfan_handle = ret;
1265         else
1266                 dev_dbg(dev, "method " METHOD_OLD_READ_FAN " not found: %s\n",
1267                                 acpi_format_exception(status));
1268
1269         /* Enumeration */
1270         status = acpi_get_handle(data->atk_handle, METHOD_ENUMERATE, &ret);
1271         if (ACPI_SUCCESS(status))
1272                 data->enumerate_handle = ret;
1273         else
1274                 dev_dbg(dev, "method " METHOD_ENUMERATE " not found: %s\n",
1275                                 acpi_format_exception(status));
1276
1277         /* De-multiplexer (read) */
1278         status = acpi_get_handle(data->atk_handle, METHOD_READ, &ret);
1279         if (ACPI_SUCCESS(status))
1280                 data->read_handle = ret;
1281         else
1282                 dev_dbg(dev, "method " METHOD_READ " not found: %s\n",
1283                                 acpi_format_exception(status));
1284
1285         /* De-multiplexer (write) */
1286         status = acpi_get_handle(data->atk_handle, METHOD_WRITE, &ret);
1287         if (ACPI_SUCCESS(status))
1288                 data->write_handle = ret;
1289         else
1290                 dev_dbg(dev, "method " METHOD_WRITE " not found: %s\n",
1291                                  acpi_format_exception(status));
1292
1293         /* Check for hwmon methods: first check "old" style methods; note that
1294          * both may be present: in this case we stick to the old interface;
1295          * analysis of multiple DSDTs indicates that when both interfaces
1296          * are present the new one (GGRP/GITM) is not functional.
1297          */
1298         if (data->rtmp_handle && data->rvlt_handle && data->rfan_handle)
1299                 data->old_interface = true;
1300         else if (data->enumerate_handle && data->read_handle &&
1301                         data->write_handle)
1302                 data->old_interface = false;
1303         else
1304                 err = -ENODEV;
1305
1306         return err;
1307 }
1308
1309 static int atk_add(struct acpi_device *device)
1310 {
1311         acpi_status ret;
1312         int err;
1313         struct acpi_buffer buf;
1314         union acpi_object *obj;
1315         struct atk_data *data;
1316
1317         dev_dbg(&device->dev, "adding...\n");
1318
1319         data = kzalloc(sizeof(*data), GFP_KERNEL);
1320         if (!data)
1321                 return -ENOMEM;
1322
1323         data->acpi_dev = device;
1324         data->atk_handle = device->handle;
1325         INIT_LIST_HEAD(&data->sensor_list);
1326         data->disable_ec = false;
1327
1328         buf.length = ACPI_ALLOCATE_BUFFER;
1329         ret = acpi_evaluate_object_typed(data->atk_handle, BOARD_ID, NULL,
1330                         &buf, ACPI_TYPE_PACKAGE);
1331         if (ret != AE_OK) {
1332                 dev_dbg(&device->dev, "atk: method MBIF not found\n");
1333         } else {
1334                 obj = buf.pointer;
1335                 if (obj->package.count >= 2) {
1336                         union acpi_object *id = &obj->package.elements[1];
1337                         if (id->type == ACPI_TYPE_STRING)
1338                                 dev_dbg(&device->dev, "board ID = %s\n",
1339                                         id->string.pointer);
1340                 }
1341                 ACPI_FREE(buf.pointer);
1342         }
1343
1344         err = atk_probe_if(data);
1345         if (err) {
1346                 dev_err(&device->dev, "No usable hwmon interface detected\n");
1347                 goto out;
1348         }
1349
1350         if (data->old_interface) {
1351                 dev_dbg(&device->dev, "Using old hwmon interface\n");
1352                 err = atk_enumerate_old_hwmon(data);
1353         } else {
1354                 dev_dbg(&device->dev, "Using new hwmon interface\n");
1355                 err = atk_enumerate_new_hwmon(data);
1356         }
1357         if (err < 0)
1358                 goto out;
1359         if (err == 0) {
1360                 dev_info(&device->dev,
1361                          "No usable sensor detected, bailing out\n");
1362                 err = -ENODEV;
1363                 goto out;
1364         }
1365
1366         err = atk_register_hwmon(data);
1367         if (err)
1368                 goto cleanup;
1369
1370         atk_debugfs_init(data);
1371
1372         device->driver_data = data;
1373         return 0;
1374 cleanup:
1375         atk_free_sensors(data);
1376 out:
1377         if (data->disable_ec)
1378                 atk_ec_ctl(data, 0);
1379         kfree(data);
1380         return err;
1381 }
1382
1383 static int atk_remove(struct acpi_device *device, int type)
1384 {
1385         struct atk_data *data = device->driver_data;
1386         dev_dbg(&device->dev, "removing...\n");
1387
1388         device->driver_data = NULL;
1389
1390         atk_debugfs_cleanup(data);
1391
1392         atk_remove_files(data);
1393         atk_free_sensors(data);
1394         hwmon_device_unregister(data->hwmon_dev);
1395
1396         if (data->disable_ec) {
1397                 if (atk_ec_ctl(data, 0))
1398                         dev_err(&device->dev, "Failed to disable EC\n");
1399         }
1400
1401         kfree(data);
1402
1403         return 0;
1404 }
1405
1406 static int __init atk0110_init(void)
1407 {
1408         int ret;
1409
1410         ret = acpi_bus_register_driver(&atk_driver);
1411         if (ret)
1412                 pr_info("atk: acpi_bus_register_driver failed: %d\n", ret);
1413
1414         return ret;
1415 }
1416
1417 static void __exit atk0110_exit(void)
1418 {
1419         acpi_bus_unregister_driver(&atk_driver);
1420 }
1421
1422 module_init(atk0110_init);
1423 module_exit(atk0110_exit);
1424
1425 MODULE_LICENSE("GPL");