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