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