Kconfig: fix copy/paste-ism for dell-wmi-aio driver
[zen-stable.git] / drivers / hwmon / asus_atk0110.c
blobb5e892017e0c57497f7726d59812a56144f35ea8
1 /*
2 * Copyright (C) 2007-2009 Luca Tettamanti <kronos.it@gmail.com>
4 * This file is released under the GPLv2
5 * See COPYING in the top level directory of the kernel tree.
6 */
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
18 #include <acpi/acpi.h>
19 #include <acpi/acpixf.h>
20 #include <acpi/acpi_drivers.h>
21 #include <acpi/acpi_bus.h>
24 #define ATK_HID "ATK0110"
26 static bool new_if;
27 module_param(new_if, bool, 0);
28 MODULE_PARM_DESC(new_if, "Override detection heuristic and force the use of the new ATK0110 interface");
30 static const struct dmi_system_id __initconst atk_force_new_if[] = {
32 /* Old interface has broken MCH temp monitoring */
33 .ident = "Asus Sabertooth X58",
34 .matches = {
35 DMI_MATCH(DMI_BOARD_NAME, "SABERTOOTH X58")
38 { }
41 /* Minimum time between readings, enforced in order to avoid
42 * hogging the CPU.
44 #define CACHE_TIME HZ
46 #define BOARD_ID "MBIF"
47 #define METHOD_ENUMERATE "GGRP"
48 #define METHOD_READ "GITM"
49 #define METHOD_WRITE "SITM"
50 #define METHOD_OLD_READ_TMP "RTMP"
51 #define METHOD_OLD_READ_VLT "RVLT"
52 #define METHOD_OLD_READ_FAN "RFAN"
53 #define METHOD_OLD_ENUM_TMP "TSIF"
54 #define METHOD_OLD_ENUM_VLT "VSIF"
55 #define METHOD_OLD_ENUM_FAN "FSIF"
57 #define ATK_MUX_HWMON 0x00000006ULL
58 #define ATK_MUX_MGMT 0x00000011ULL
60 #define ATK_CLASS_MASK 0xff000000ULL
61 #define ATK_CLASS_FREQ_CTL 0x03000000ULL
62 #define ATK_CLASS_FAN_CTL 0x04000000ULL
63 #define ATK_CLASS_HWMON 0x06000000ULL
64 #define ATK_CLASS_MGMT 0x11000000ULL
66 #define ATK_TYPE_MASK 0x00ff0000ULL
67 #define HWMON_TYPE_VOLT 0x00020000ULL
68 #define HWMON_TYPE_TEMP 0x00030000ULL
69 #define HWMON_TYPE_FAN 0x00040000ULL
71 #define ATK_ELEMENT_ID_MASK 0x0000ffffULL
73 #define ATK_EC_ID 0x11060004ULL
75 enum atk_pack_member {
76 HWMON_PACK_FLAGS,
77 HWMON_PACK_NAME,
78 HWMON_PACK_LIMIT1,
79 HWMON_PACK_LIMIT2,
80 HWMON_PACK_ENABLE
83 /* New package format */
84 #define _HWMON_NEW_PACK_SIZE 7
85 #define _HWMON_NEW_PACK_FLAGS 0
86 #define _HWMON_NEW_PACK_NAME 1
87 #define _HWMON_NEW_PACK_UNK1 2
88 #define _HWMON_NEW_PACK_UNK2 3
89 #define _HWMON_NEW_PACK_LIMIT1 4
90 #define _HWMON_NEW_PACK_LIMIT2 5
91 #define _HWMON_NEW_PACK_ENABLE 6
93 /* Old package format */
94 #define _HWMON_OLD_PACK_SIZE 5
95 #define _HWMON_OLD_PACK_FLAGS 0
96 #define _HWMON_OLD_PACK_NAME 1
97 #define _HWMON_OLD_PACK_LIMIT1 2
98 #define _HWMON_OLD_PACK_LIMIT2 3
99 #define _HWMON_OLD_PACK_ENABLE 4
102 struct atk_data {
103 struct device *hwmon_dev;
104 acpi_handle atk_handle;
105 struct acpi_device *acpi_dev;
107 bool old_interface;
109 /* old interface */
110 acpi_handle rtmp_handle;
111 acpi_handle rvlt_handle;
112 acpi_handle rfan_handle;
113 /* new inteface */
114 acpi_handle enumerate_handle;
115 acpi_handle read_handle;
116 acpi_handle write_handle;
118 bool disable_ec;
120 int voltage_count;
121 int temperature_count;
122 int fan_count;
123 struct list_head sensor_list;
125 struct {
126 struct dentry *root;
127 u32 id;
128 } debugfs;
132 typedef ssize_t (*sysfs_show_func)(struct device *dev,
133 struct device_attribute *attr, char *buf);
135 static const struct acpi_device_id atk_ids[] = {
136 {ATK_HID, 0},
137 {"", 0},
139 MODULE_DEVICE_TABLE(acpi, atk_ids);
141 #define ATTR_NAME_SIZE 16 /* Worst case is "tempN_input" */
143 struct atk_sensor_data {
144 struct list_head list;
145 struct atk_data *data;
146 struct device_attribute label_attr;
147 struct device_attribute input_attr;
148 struct device_attribute limit1_attr;
149 struct device_attribute limit2_attr;
150 char label_attr_name[ATTR_NAME_SIZE];
151 char input_attr_name[ATTR_NAME_SIZE];
152 char limit1_attr_name[ATTR_NAME_SIZE];
153 char limit2_attr_name[ATTR_NAME_SIZE];
154 u64 id;
155 u64 type;
156 u64 limit1;
157 u64 limit2;
158 u64 cached_value;
159 unsigned long last_updated; /* in jiffies */
160 bool is_valid;
161 char const *acpi_name;
164 /* Return buffer format:
165 * [0-3] "value" is valid flag
166 * [4-7] value
167 * [8- ] unknown stuff on newer mobos
169 struct atk_acpi_ret_buffer {
170 u32 flags;
171 u32 value;
172 u8 data[];
175 /* Input buffer used for GITM and SITM methods */
176 struct atk_acpi_input_buf {
177 u32 id;
178 u32 param1;
179 u32 param2;
182 static int atk_add(struct acpi_device *device);
183 static int atk_remove(struct acpi_device *device, int type);
184 static void atk_print_sensor(struct atk_data *data, union acpi_object *obj);
185 static int atk_read_value(struct atk_sensor_data *sensor, u64 *value);
186 static void atk_free_sensors(struct atk_data *data);
188 static struct acpi_driver atk_driver = {
189 .name = ATK_HID,
190 .class = "hwmon",
191 .ids = atk_ids,
192 .ops = {
193 .add = atk_add,
194 .remove = atk_remove,
198 #define input_to_atk_sensor(attr) \
199 container_of(attr, struct atk_sensor_data, input_attr)
201 #define label_to_atk_sensor(attr) \
202 container_of(attr, struct atk_sensor_data, label_attr)
204 #define limit1_to_atk_sensor(attr) \
205 container_of(attr, struct atk_sensor_data, limit1_attr)
207 #define limit2_to_atk_sensor(attr) \
208 container_of(attr, struct atk_sensor_data, limit2_attr)
210 static ssize_t atk_input_show(struct device *dev,
211 struct device_attribute *attr, char *buf)
213 struct atk_sensor_data *s = input_to_atk_sensor(attr);
214 u64 value;
215 int err;
217 err = atk_read_value(s, &value);
218 if (err)
219 return err;
221 if (s->type == HWMON_TYPE_TEMP)
222 /* ACPI returns decidegree */
223 value *= 100;
225 return sprintf(buf, "%llu\n", value);
228 static ssize_t atk_label_show(struct device *dev,
229 struct device_attribute *attr, char *buf)
231 struct atk_sensor_data *s = label_to_atk_sensor(attr);
233 return sprintf(buf, "%s\n", s->acpi_name);
236 static ssize_t atk_limit1_show(struct device *dev,
237 struct device_attribute *attr, char *buf)
239 struct atk_sensor_data *s = limit1_to_atk_sensor(attr);
240 u64 value = s->limit1;
242 if (s->type == HWMON_TYPE_TEMP)
243 value *= 100;
245 return sprintf(buf, "%lld\n", value);
248 static ssize_t atk_limit2_show(struct device *dev,
249 struct device_attribute *attr, char *buf)
251 struct atk_sensor_data *s = limit2_to_atk_sensor(attr);
252 u64 value = s->limit2;
254 if (s->type == HWMON_TYPE_TEMP)
255 value *= 100;
257 return sprintf(buf, "%lld\n", value);
260 static ssize_t atk_name_show(struct device *dev,
261 struct device_attribute *attr, char *buf)
263 return sprintf(buf, "atk0110\n");
265 static struct device_attribute atk_name_attr =
266 __ATTR(name, 0444, atk_name_show, NULL);
268 static void atk_init_attribute(struct device_attribute *attr, char *name,
269 sysfs_show_func show)
271 attr->attr.name = name;
272 attr->attr.mode = 0444;
273 attr->show = show;
274 attr->store = NULL;
278 static union acpi_object *atk_get_pack_member(struct atk_data *data,
279 union acpi_object *pack,
280 enum atk_pack_member m)
282 bool old_if = data->old_interface;
283 int offset;
285 switch (m) {
286 case HWMON_PACK_FLAGS:
287 offset = old_if ? _HWMON_OLD_PACK_FLAGS : _HWMON_NEW_PACK_FLAGS;
288 break;
289 case HWMON_PACK_NAME:
290 offset = old_if ? _HWMON_OLD_PACK_NAME : _HWMON_NEW_PACK_NAME;
291 break;
292 case HWMON_PACK_LIMIT1:
293 offset = old_if ? _HWMON_OLD_PACK_LIMIT1 :
294 _HWMON_NEW_PACK_LIMIT1;
295 break;
296 case HWMON_PACK_LIMIT2:
297 offset = old_if ? _HWMON_OLD_PACK_LIMIT2 :
298 _HWMON_NEW_PACK_LIMIT2;
299 break;
300 case HWMON_PACK_ENABLE:
301 offset = old_if ? _HWMON_OLD_PACK_ENABLE :
302 _HWMON_NEW_PACK_ENABLE;
303 break;
304 default:
305 return NULL;
308 return &pack->package.elements[offset];
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)
325 * The old package has the same format but it's missing the two unknown fields.
327 static int validate_hwmon_pack(struct atk_data *data, union acpi_object *obj)
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;
335 if (obj->type != ACPI_TYPE_PACKAGE) {
336 dev_warn(dev, "Invalid type: %d\n", obj->type);
337 return -EINVAL;
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;
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;
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;
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;
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;
371 #endif
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;
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;
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;
391 atk_print_sensor(data, obj);
393 return 0;
396 #ifdef DEBUG
397 static char const *atk_sensor_type(union acpi_object *flags)
399 u64 type = flags->integer.value & ATK_TYPE_MASK;
400 char const *what;
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;
417 return what;
419 #endif
421 static void atk_print_sensor(struct atk_data *data, union acpi_object *obj)
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;
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);
438 what = atk_sensor_type(flags);
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
448 static int atk_read_value_old(struct atk_sensor_data *sensor, u64 *value)
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;
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;
471 id.type = ACPI_TYPE_INTEGER;
472 id.integer.value = sensor->id;
474 params.count = 1;
475 params.pointer = &id;
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;
484 return 0;
487 static union acpi_object *atk_ggrp(struct atk_data *data, u16 mux)
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;
496 id.type = ACPI_TYPE_INTEGER;
497 id.integer.value = mux;
498 params.count = 1;
499 params.pointer = &id;
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);
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);
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);
520 return pack;
523 static union acpi_object *atk_gitm(struct atk_data *data, u64 id)
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;
533 buf.id = id;
534 buf.param1 = 0;
535 buf.param2 = 0;
537 tmp.type = ACPI_TYPE_BUFFER;
538 tmp.buffer.pointer = (u8 *)&buf;
539 tmp.buffer.length = sizeof(buf);
541 params.count = 1;
542 params.pointer = (void *)&tmp;
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);
552 obj = ret.pointer;
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);
561 return obj;
564 static union acpi_object *atk_sitm(struct atk_data *data,
565 struct atk_acpi_input_buf *buf)
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;
574 tmp.type = ACPI_TYPE_BUFFER;
575 tmp.buffer.pointer = (u8 *)buf;
576 tmp.buffer.length = sizeof(*buf);
578 params.count = 1;
579 params.pointer = &tmp;
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);
589 obj = ret.pointer;
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);
598 return obj;
601 static int atk_read_value_new(struct atk_sensor_data *sensor, u64 *value)
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;
609 obj = atk_gitm(data, sensor->id);
610 if (IS_ERR(obj))
611 return PTR_ERR(obj);
613 buf = (struct atk_acpi_ret_buffer *)obj->buffer.pointer;
614 if (buf->flags == 0) {
615 /* The reading is not valid, possible causes:
616 * - sensor failure
617 * - enumeration was FUBAR (and we didn't notice)
619 dev_warn(dev, "Read failed, sensor = %#llx\n", sensor->id);
620 err = -EIO;
621 goto out;
624 *value = buf->value;
625 out:
626 ACPI_FREE(obj);
627 return err;
630 static int atk_read_value(struct atk_sensor_data *sensor, u64 *value)
632 int err;
634 if (!sensor->is_valid ||
635 time_after(jiffies, sensor->last_updated + CACHE_TIME)) {
636 if (sensor->data->old_interface)
637 err = atk_read_value_old(sensor, value);
638 else
639 err = atk_read_value_new(sensor, value);
641 sensor->is_valid = true;
642 sensor->last_updated = jiffies;
643 sensor->cached_value = *value;
644 } else {
645 *value = sensor->cached_value;
646 err = 0;
649 return err;
652 #ifdef CONFIG_DEBUG_FS
653 static int atk_debugfs_gitm_get(void *p, u64 *val)
655 struct atk_data *data = p;
656 union acpi_object *ret;
657 struct atk_acpi_ret_buffer *buf;
658 int err = 0;
660 if (!data->read_handle)
661 return -ENODEV;
663 if (!data->debugfs.id)
664 return -EINVAL;
666 ret = atk_gitm(data, data->debugfs.id);
667 if (IS_ERR(ret))
668 return PTR_ERR(ret);
670 buf = (struct atk_acpi_ret_buffer *)ret->buffer.pointer;
671 if (buf->flags)
672 *val = buf->value;
673 else
674 err = -EIO;
676 return err;
679 DEFINE_SIMPLE_ATTRIBUTE(atk_debugfs_gitm,
680 atk_debugfs_gitm_get,
681 NULL,
682 "0x%08llx\n")
684 static int atk_acpi_print(char *buf, size_t sz, union acpi_object *obj)
686 int ret = 0;
688 switch (obj->type) {
689 case ACPI_TYPE_INTEGER:
690 ret = snprintf(buf, sz, "0x%08llx\n", obj->integer.value);
691 break;
692 case ACPI_TYPE_STRING:
693 ret = snprintf(buf, sz, "%s\n", obj->string.pointer);
694 break;
697 return ret;
700 static void atk_pack_print(char *buf, size_t sz, union acpi_object *pack)
702 int ret;
703 int i;
705 for (i = 0; i < pack->package.count; i++) {
706 union acpi_object *obj = &pack->package.elements[i];
708 ret = atk_acpi_print(buf, sz, obj);
709 if (ret >= sz)
710 break;
711 buf += ret;
712 sz -= ret;
716 static int atk_debugfs_ggrp_open(struct inode *inode, struct file *file)
718 struct atk_data *data = inode->i_private;
719 char *buf = NULL;
720 union acpi_object *ret;
721 u8 cls;
722 int i;
724 if (!data->enumerate_handle)
725 return -ENODEV;
726 if (!data->debugfs.id)
727 return -EINVAL;
729 cls = (data->debugfs.id & 0xff000000) >> 24;
730 ret = atk_ggrp(data, cls);
731 if (IS_ERR(ret))
732 return PTR_ERR(ret);
734 for (i = 0; i < ret->package.count; i++) {
735 union acpi_object *pack = &ret->package.elements[i];
736 union acpi_object *id;
738 if (pack->type != ACPI_TYPE_PACKAGE)
739 continue;
740 if (!pack->package.count)
741 continue;
742 id = &pack->package.elements[0];
743 if (id->integer.value == data->debugfs.id) {
744 /* Print the package */
745 buf = kzalloc(512, GFP_KERNEL);
746 if (!buf) {
747 ACPI_FREE(ret);
748 return -ENOMEM;
750 atk_pack_print(buf, 512, pack);
751 break;
754 ACPI_FREE(ret);
756 if (!buf)
757 return -EINVAL;
759 file->private_data = buf;
761 return nonseekable_open(inode, file);
764 static ssize_t atk_debugfs_ggrp_read(struct file *file, char __user *buf,
765 size_t count, loff_t *pos)
767 char *str = file->private_data;
768 size_t len = strlen(str);
770 return simple_read_from_buffer(buf, count, pos, str, len);
773 static int atk_debugfs_ggrp_release(struct inode *inode, struct file *file)
775 kfree(file->private_data);
776 return 0;
779 static const struct file_operations atk_debugfs_ggrp_fops = {
780 .read = atk_debugfs_ggrp_read,
781 .open = atk_debugfs_ggrp_open,
782 .release = atk_debugfs_ggrp_release,
783 .llseek = no_llseek,
786 static void atk_debugfs_init(struct atk_data *data)
788 struct dentry *d;
789 struct dentry *f;
791 data->debugfs.id = 0;
793 d = debugfs_create_dir("asus_atk0110", NULL);
794 if (!d || IS_ERR(d))
795 return;
797 f = debugfs_create_x32("id", S_IRUSR | S_IWUSR, d, &data->debugfs.id);
798 if (!f || IS_ERR(f))
799 goto cleanup;
801 f = debugfs_create_file("gitm", S_IRUSR, d, data,
802 &atk_debugfs_gitm);
803 if (!f || IS_ERR(f))
804 goto cleanup;
806 f = debugfs_create_file("ggrp", S_IRUSR, d, data,
807 &atk_debugfs_ggrp_fops);
808 if (!f || IS_ERR(f))
809 goto cleanup;
811 data->debugfs.root = d;
813 return;
814 cleanup:
815 debugfs_remove_recursive(d);
818 static void atk_debugfs_cleanup(struct atk_data *data)
820 debugfs_remove_recursive(data->debugfs.root);
823 #else /* CONFIG_DEBUG_FS */
825 static void atk_debugfs_init(struct atk_data *data)
829 static void atk_debugfs_cleanup(struct atk_data *data)
832 #endif
834 static int atk_add_sensor(struct atk_data *data, union acpi_object *obj)
836 struct device *dev = &data->acpi_dev->dev;
837 union acpi_object *flags;
838 union acpi_object *name;
839 union acpi_object *limit1;
840 union acpi_object *limit2;
841 union acpi_object *enable;
842 struct atk_sensor_data *sensor;
843 char const *base_name;
844 char const *limit1_name;
845 char const *limit2_name;
846 u64 type;
847 int err;
848 int *num;
849 int start;
851 if (obj->type != ACPI_TYPE_PACKAGE) {
852 /* wft is this? */
853 dev_warn(dev, "Unknown type for ACPI object: (%d)\n",
854 obj->type);
855 return -EINVAL;
858 err = validate_hwmon_pack(data, obj);
859 if (err)
860 return err;
862 /* Ok, we have a valid hwmon package */
863 type = atk_get_pack_member(data, obj, HWMON_PACK_FLAGS)->integer.value
864 & ATK_TYPE_MASK;
866 switch (type) {
867 case HWMON_TYPE_VOLT:
868 base_name = "in";
869 limit1_name = "min";
870 limit2_name = "max";
871 num = &data->voltage_count;
872 start = 0;
873 break;
874 case HWMON_TYPE_TEMP:
875 base_name = "temp";
876 limit1_name = "max";
877 limit2_name = "crit";
878 num = &data->temperature_count;
879 start = 1;
880 break;
881 case HWMON_TYPE_FAN:
882 base_name = "fan";
883 limit1_name = "min";
884 limit2_name = "max";
885 num = &data->fan_count;
886 start = 1;
887 break;
888 default:
889 dev_warn(dev, "Unknown sensor type: %#llx\n", type);
890 return -EINVAL;
893 enable = atk_get_pack_member(data, obj, HWMON_PACK_ENABLE);
894 if (!enable->integer.value)
895 /* sensor is disabled */
896 return 0;
898 flags = atk_get_pack_member(data, obj, HWMON_PACK_FLAGS);
899 name = atk_get_pack_member(data, obj, HWMON_PACK_NAME);
900 limit1 = atk_get_pack_member(data, obj, HWMON_PACK_LIMIT1);
901 limit2 = atk_get_pack_member(data, obj, HWMON_PACK_LIMIT2);
903 sensor = kzalloc(sizeof(*sensor), GFP_KERNEL);
904 if (!sensor)
905 return -ENOMEM;
907 sensor->acpi_name = kstrdup(name->string.pointer, GFP_KERNEL);
908 if (!sensor->acpi_name) {
909 err = -ENOMEM;
910 goto out;
913 INIT_LIST_HEAD(&sensor->list);
914 sensor->type = type;
915 sensor->data = data;
916 sensor->id = flags->integer.value;
917 sensor->limit1 = limit1->integer.value;
918 if (data->old_interface)
919 sensor->limit2 = limit2->integer.value;
920 else
921 /* The upper limit is expressed as delta from lower limit */
922 sensor->limit2 = sensor->limit1 + limit2->integer.value;
924 snprintf(sensor->input_attr_name, ATTR_NAME_SIZE,
925 "%s%d_input", base_name, start + *num);
926 atk_init_attribute(&sensor->input_attr,
927 sensor->input_attr_name,
928 atk_input_show);
930 snprintf(sensor->label_attr_name, ATTR_NAME_SIZE,
931 "%s%d_label", base_name, start + *num);
932 atk_init_attribute(&sensor->label_attr,
933 sensor->label_attr_name,
934 atk_label_show);
936 snprintf(sensor->limit1_attr_name, ATTR_NAME_SIZE,
937 "%s%d_%s", base_name, start + *num, limit1_name);
938 atk_init_attribute(&sensor->limit1_attr,
939 sensor->limit1_attr_name,
940 atk_limit1_show);
942 snprintf(sensor->limit2_attr_name, ATTR_NAME_SIZE,
943 "%s%d_%s", base_name, start + *num, limit2_name);
944 atk_init_attribute(&sensor->limit2_attr,
945 sensor->limit2_attr_name,
946 atk_limit2_show);
948 list_add(&sensor->list, &data->sensor_list);
949 (*num)++;
951 return 1;
952 out:
953 kfree(sensor->acpi_name);
954 kfree(sensor);
955 return err;
958 static int atk_enumerate_old_hwmon(struct atk_data *data)
960 struct device *dev = &data->acpi_dev->dev;
961 struct acpi_buffer buf;
962 union acpi_object *pack;
963 acpi_status status;
964 int i, ret;
965 int count = 0;
967 /* Voltages */
968 buf.length = ACPI_ALLOCATE_BUFFER;
969 status = acpi_evaluate_object_typed(data->atk_handle,
970 METHOD_OLD_ENUM_VLT, NULL, &buf, ACPI_TYPE_PACKAGE);
971 if (status != AE_OK) {
972 dev_warn(dev, METHOD_OLD_ENUM_VLT ": ACPI exception: %s\n",
973 acpi_format_exception(status));
975 return -ENODEV;
978 pack = buf.pointer;
979 for (i = 1; i < pack->package.count; i++) {
980 union acpi_object *obj = &pack->package.elements[i];
982 ret = atk_add_sensor(data, obj);
983 if (ret > 0)
984 count++;
986 ACPI_FREE(buf.pointer);
988 /* Temperatures */
989 buf.length = ACPI_ALLOCATE_BUFFER;
990 status = acpi_evaluate_object_typed(data->atk_handle,
991 METHOD_OLD_ENUM_TMP, NULL, &buf, ACPI_TYPE_PACKAGE);
992 if (status != AE_OK) {
993 dev_warn(dev, METHOD_OLD_ENUM_TMP ": ACPI exception: %s\n",
994 acpi_format_exception(status));
996 ret = -ENODEV;
997 goto cleanup;
1000 pack = buf.pointer;
1001 for (i = 1; i < pack->package.count; i++) {
1002 union acpi_object *obj = &pack->package.elements[i];
1004 ret = atk_add_sensor(data, obj);
1005 if (ret > 0)
1006 count++;
1008 ACPI_FREE(buf.pointer);
1010 /* Fans */
1011 buf.length = ACPI_ALLOCATE_BUFFER;
1012 status = acpi_evaluate_object_typed(data->atk_handle,
1013 METHOD_OLD_ENUM_FAN, NULL, &buf, ACPI_TYPE_PACKAGE);
1014 if (status != AE_OK) {
1015 dev_warn(dev, METHOD_OLD_ENUM_FAN ": ACPI exception: %s\n",
1016 acpi_format_exception(status));
1018 ret = -ENODEV;
1019 goto cleanup;
1022 pack = buf.pointer;
1023 for (i = 1; i < pack->package.count; i++) {
1024 union acpi_object *obj = &pack->package.elements[i];
1026 ret = atk_add_sensor(data, obj);
1027 if (ret > 0)
1028 count++;
1030 ACPI_FREE(buf.pointer);
1032 return count;
1033 cleanup:
1034 atk_free_sensors(data);
1035 return ret;
1038 static int atk_ec_present(struct atk_data *data)
1040 struct device *dev = &data->acpi_dev->dev;
1041 union acpi_object *pack;
1042 union acpi_object *ec;
1043 int ret;
1044 int i;
1046 pack = atk_ggrp(data, ATK_MUX_MGMT);
1047 if (IS_ERR(pack)) {
1048 if (PTR_ERR(pack) == -ENOENT) {
1049 /* The MGMT class does not exists - that's ok */
1050 dev_dbg(dev, "Class %#llx not found\n", ATK_MUX_MGMT);
1051 return 0;
1053 return PTR_ERR(pack);
1056 /* Search the EC */
1057 ec = NULL;
1058 for (i = 0; i < pack->package.count; i++) {
1059 union acpi_object *obj = &pack->package.elements[i];
1060 union acpi_object *id;
1062 if (obj->type != ACPI_TYPE_PACKAGE)
1063 continue;
1065 id = &obj->package.elements[0];
1066 if (id->type != ACPI_TYPE_INTEGER)
1067 continue;
1069 if (id->integer.value == ATK_EC_ID) {
1070 ec = obj;
1071 break;
1075 ret = (ec != NULL);
1076 if (!ret)
1077 /* The system has no EC */
1078 dev_dbg(dev, "EC not found\n");
1080 ACPI_FREE(pack);
1081 return ret;
1084 static int atk_ec_enabled(struct atk_data *data)
1086 struct device *dev = &data->acpi_dev->dev;
1087 union acpi_object *obj;
1088 struct atk_acpi_ret_buffer *buf;
1089 int err;
1091 obj = atk_gitm(data, ATK_EC_ID);
1092 if (IS_ERR(obj)) {
1093 dev_err(dev, "Unable to query EC status\n");
1094 return PTR_ERR(obj);
1096 buf = (struct atk_acpi_ret_buffer *)obj->buffer.pointer;
1098 if (buf->flags == 0) {
1099 dev_err(dev, "Unable to query EC status\n");
1100 err = -EIO;
1101 } else {
1102 err = (buf->value != 0);
1103 dev_dbg(dev, "EC is %sabled\n",
1104 err ? "en" : "dis");
1107 ACPI_FREE(obj);
1108 return err;
1111 static int atk_ec_ctl(struct atk_data *data, int enable)
1113 struct device *dev = &data->acpi_dev->dev;
1114 union acpi_object *obj;
1115 struct atk_acpi_input_buf sitm;
1116 struct atk_acpi_ret_buffer *ec_ret;
1117 int err = 0;
1119 sitm.id = ATK_EC_ID;
1120 sitm.param1 = enable;
1121 sitm.param2 = 0;
1123 obj = atk_sitm(data, &sitm);
1124 if (IS_ERR(obj)) {
1125 dev_err(dev, "Failed to %sable the EC\n",
1126 enable ? "en" : "dis");
1127 return PTR_ERR(obj);
1129 ec_ret = (struct atk_acpi_ret_buffer *)obj->buffer.pointer;
1130 if (ec_ret->flags == 0) {
1131 dev_err(dev, "Failed to %sable the EC\n",
1132 enable ? "en" : "dis");
1133 err = -EIO;
1134 } else {
1135 dev_info(dev, "EC %sabled\n",
1136 enable ? "en" : "dis");
1139 ACPI_FREE(obj);
1140 return err;
1143 static int atk_enumerate_new_hwmon(struct atk_data *data)
1145 struct device *dev = &data->acpi_dev->dev;
1146 union acpi_object *pack;
1147 int err;
1148 int i;
1150 err = atk_ec_present(data);
1151 if (err < 0)
1152 return err;
1153 if (err) {
1154 err = atk_ec_enabled(data);
1155 if (err < 0)
1156 return err;
1157 /* If the EC was disabled we will disable it again on unload */
1158 data->disable_ec = err;
1160 err = atk_ec_ctl(data, 1);
1161 if (err) {
1162 data->disable_ec = false;
1163 return err;
1167 dev_dbg(dev, "Enumerating hwmon sensors\n");
1169 pack = atk_ggrp(data, ATK_MUX_HWMON);
1170 if (IS_ERR(pack))
1171 return PTR_ERR(pack);
1173 for (i = 0; i < pack->package.count; i++) {
1174 union acpi_object *obj = &pack->package.elements[i];
1176 atk_add_sensor(data, obj);
1179 err = data->voltage_count + data->temperature_count + data->fan_count;
1181 ACPI_FREE(pack);
1182 return err;
1185 static int atk_create_files(struct atk_data *data)
1187 struct atk_sensor_data *s;
1188 int err;
1190 list_for_each_entry(s, &data->sensor_list, list) {
1191 sysfs_attr_init(&s->input_attr.attr);
1192 err = device_create_file(data->hwmon_dev, &s->input_attr);
1193 if (err)
1194 return err;
1195 sysfs_attr_init(&s->label_attr.attr);
1196 err = device_create_file(data->hwmon_dev, &s->label_attr);
1197 if (err)
1198 return err;
1199 sysfs_attr_init(&s->limit1_attr.attr);
1200 err = device_create_file(data->hwmon_dev, &s->limit1_attr);
1201 if (err)
1202 return err;
1203 sysfs_attr_init(&s->limit2_attr.attr);
1204 err = device_create_file(data->hwmon_dev, &s->limit2_attr);
1205 if (err)
1206 return err;
1209 err = device_create_file(data->hwmon_dev, &atk_name_attr);
1211 return err;
1214 static void atk_remove_files(struct atk_data *data)
1216 struct atk_sensor_data *s;
1218 list_for_each_entry(s, &data->sensor_list, list) {
1219 device_remove_file(data->hwmon_dev, &s->input_attr);
1220 device_remove_file(data->hwmon_dev, &s->label_attr);
1221 device_remove_file(data->hwmon_dev, &s->limit1_attr);
1222 device_remove_file(data->hwmon_dev, &s->limit2_attr);
1224 device_remove_file(data->hwmon_dev, &atk_name_attr);
1227 static void atk_free_sensors(struct atk_data *data)
1229 struct list_head *head = &data->sensor_list;
1230 struct atk_sensor_data *s, *tmp;
1232 list_for_each_entry_safe(s, tmp, head, list) {
1233 kfree(s->acpi_name);
1234 kfree(s);
1238 static int atk_register_hwmon(struct atk_data *data)
1240 struct device *dev = &data->acpi_dev->dev;
1241 int err;
1243 dev_dbg(dev, "registering hwmon device\n");
1244 data->hwmon_dev = hwmon_device_register(dev);
1245 if (IS_ERR(data->hwmon_dev))
1246 return PTR_ERR(data->hwmon_dev);
1248 dev_dbg(dev, "populating sysfs directory\n");
1249 err = atk_create_files(data);
1250 if (err)
1251 goto remove;
1253 return 0;
1254 remove:
1255 /* Cleanup the registered files */
1256 atk_remove_files(data);
1257 hwmon_device_unregister(data->hwmon_dev);
1258 return err;
1261 static int atk_probe_if(struct atk_data *data)
1263 struct device *dev = &data->acpi_dev->dev;
1264 acpi_handle ret;
1265 acpi_status status;
1266 int err = 0;
1268 /* RTMP: read temperature */
1269 status = acpi_get_handle(data->atk_handle, METHOD_OLD_READ_TMP, &ret);
1270 if (ACPI_SUCCESS(status))
1271 data->rtmp_handle = ret;
1272 else
1273 dev_dbg(dev, "method " METHOD_OLD_READ_TMP " not found: %s\n",
1274 acpi_format_exception(status));
1276 /* RVLT: read voltage */
1277 status = acpi_get_handle(data->atk_handle, METHOD_OLD_READ_VLT, &ret);
1278 if (ACPI_SUCCESS(status))
1279 data->rvlt_handle = ret;
1280 else
1281 dev_dbg(dev, "method " METHOD_OLD_READ_VLT " not found: %s\n",
1282 acpi_format_exception(status));
1284 /* RFAN: read fan status */
1285 status = acpi_get_handle(data->atk_handle, METHOD_OLD_READ_FAN, &ret);
1286 if (ACPI_SUCCESS(status))
1287 data->rfan_handle = ret;
1288 else
1289 dev_dbg(dev, "method " METHOD_OLD_READ_FAN " not found: %s\n",
1290 acpi_format_exception(status));
1292 /* Enumeration */
1293 status = acpi_get_handle(data->atk_handle, METHOD_ENUMERATE, &ret);
1294 if (ACPI_SUCCESS(status))
1295 data->enumerate_handle = ret;
1296 else
1297 dev_dbg(dev, "method " METHOD_ENUMERATE " not found: %s\n",
1298 acpi_format_exception(status));
1300 /* De-multiplexer (read) */
1301 status = acpi_get_handle(data->atk_handle, METHOD_READ, &ret);
1302 if (ACPI_SUCCESS(status))
1303 data->read_handle = ret;
1304 else
1305 dev_dbg(dev, "method " METHOD_READ " not found: %s\n",
1306 acpi_format_exception(status));
1308 /* De-multiplexer (write) */
1309 status = acpi_get_handle(data->atk_handle, METHOD_WRITE, &ret);
1310 if (ACPI_SUCCESS(status))
1311 data->write_handle = ret;
1312 else
1313 dev_dbg(dev, "method " METHOD_WRITE " not found: %s\n",
1314 acpi_format_exception(status));
1316 /* Check for hwmon methods: first check "old" style methods; note that
1317 * both may be present: in this case we stick to the old interface;
1318 * analysis of multiple DSDTs indicates that when both interfaces
1319 * are present the new one (GGRP/GITM) is not functional.
1321 if (new_if)
1322 dev_info(dev, "Overriding interface detection\n");
1323 if (data->rtmp_handle && data->rvlt_handle && data->rfan_handle && !new_if)
1324 data->old_interface = true;
1325 else if (data->enumerate_handle && data->read_handle &&
1326 data->write_handle)
1327 data->old_interface = false;
1328 else
1329 err = -ENODEV;
1331 return err;
1334 static int atk_add(struct acpi_device *device)
1336 acpi_status ret;
1337 int err;
1338 struct acpi_buffer buf;
1339 union acpi_object *obj;
1340 struct atk_data *data;
1342 dev_dbg(&device->dev, "adding...\n");
1344 data = kzalloc(sizeof(*data), GFP_KERNEL);
1345 if (!data)
1346 return -ENOMEM;
1348 data->acpi_dev = device;
1349 data->atk_handle = device->handle;
1350 INIT_LIST_HEAD(&data->sensor_list);
1351 data->disable_ec = false;
1353 buf.length = ACPI_ALLOCATE_BUFFER;
1354 ret = acpi_evaluate_object_typed(data->atk_handle, BOARD_ID, NULL,
1355 &buf, ACPI_TYPE_PACKAGE);
1356 if (ret != AE_OK) {
1357 dev_dbg(&device->dev, "atk: method MBIF not found\n");
1358 } else {
1359 obj = buf.pointer;
1360 if (obj->package.count >= 2) {
1361 union acpi_object *id = &obj->package.elements[1];
1362 if (id->type == ACPI_TYPE_STRING)
1363 dev_dbg(&device->dev, "board ID = %s\n",
1364 id->string.pointer);
1366 ACPI_FREE(buf.pointer);
1369 err = atk_probe_if(data);
1370 if (err) {
1371 dev_err(&device->dev, "No usable hwmon interface detected\n");
1372 goto out;
1375 if (data->old_interface) {
1376 dev_dbg(&device->dev, "Using old hwmon interface\n");
1377 err = atk_enumerate_old_hwmon(data);
1378 } else {
1379 dev_dbg(&device->dev, "Using new hwmon interface\n");
1380 err = atk_enumerate_new_hwmon(data);
1382 if (err < 0)
1383 goto out;
1384 if (err == 0) {
1385 dev_info(&device->dev,
1386 "No usable sensor detected, bailing out\n");
1387 err = -ENODEV;
1388 goto out;
1391 err = atk_register_hwmon(data);
1392 if (err)
1393 goto cleanup;
1395 atk_debugfs_init(data);
1397 device->driver_data = data;
1398 return 0;
1399 cleanup:
1400 atk_free_sensors(data);
1401 out:
1402 if (data->disable_ec)
1403 atk_ec_ctl(data, 0);
1404 kfree(data);
1405 return err;
1408 static int atk_remove(struct acpi_device *device, int type)
1410 struct atk_data *data = device->driver_data;
1411 dev_dbg(&device->dev, "removing...\n");
1413 device->driver_data = NULL;
1415 atk_debugfs_cleanup(data);
1417 atk_remove_files(data);
1418 atk_free_sensors(data);
1419 hwmon_device_unregister(data->hwmon_dev);
1421 if (data->disable_ec) {
1422 if (atk_ec_ctl(data, 0))
1423 dev_err(&device->dev, "Failed to disable EC\n");
1426 kfree(data);
1428 return 0;
1431 static int __init atk0110_init(void)
1433 int ret;
1435 /* Make sure it's safe to access the device through ACPI */
1436 if (!acpi_resources_are_enforced()) {
1437 pr_err("Resources not safely usable due to acpi_enforce_resources kernel parameter\n");
1438 return -EBUSY;
1441 if (dmi_check_system(atk_force_new_if))
1442 new_if = true;
1444 ret = acpi_bus_register_driver(&atk_driver);
1445 if (ret)
1446 pr_info("acpi_bus_register_driver failed: %d\n", ret);
1448 return ret;
1451 static void __exit atk0110_exit(void)
1453 acpi_bus_unregister_driver(&atk_driver);
1456 module_init(atk0110_init);
1457 module_exit(atk0110_exit);
1459 MODULE_LICENSE("GPL");