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 int 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, ¶ms, 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, ¶ms, &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, ¶ms, 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, ¶ms, 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 struct dentry *f; 793 794 data->debugfs.id = 0; 795 796 d = debugfs_create_dir("asus_atk0110", NULL); 797 if (!d || IS_ERR(d)) 798 return; 799 800 f = debugfs_create_x32("id", 0600, d, &data->debugfs.id); 801 if (!f || IS_ERR(f)) 802 goto cleanup; 803 804 f = debugfs_create_file_unsafe("gitm", 0400, d, data, 805 &atk_debugfs_gitm); 806 if (!f || IS_ERR(f)) 807 goto cleanup; 808 809 f = debugfs_create_file("ggrp", 0400, d, data, 810 &atk_debugfs_ggrp_fops); 811 if (!f || IS_ERR(f)) 812 goto cleanup; 813 814 data->debugfs.root = d; 815 816 return; 817 cleanup: 818 debugfs_remove_recursive(d); 819 } 820 821 static void atk_debugfs_cleanup(struct atk_data *data) 822 { 823 debugfs_remove_recursive(data->debugfs.root); 824 } 825 826 #else /* CONFIG_DEBUG_FS */ 827 828 static void atk_debugfs_init(struct atk_data *data) 829 { 830 } 831 832 static void atk_debugfs_cleanup(struct atk_data *data) 833 { 834 } 835 #endif 836 837 static int atk_add_sensor(struct atk_data *data, union acpi_object *obj) 838 { 839 struct device *dev = &data->acpi_dev->dev; 840 union acpi_object *flags; 841 union acpi_object *name; 842 union acpi_object *limit1; 843 union acpi_object *limit2; 844 union acpi_object *enable; 845 struct atk_sensor_data *sensor; 846 char const *base_name; 847 char const *limit1_name; 848 char const *limit2_name; 849 u64 type; 850 int err; 851 int *num; 852 int start; 853 854 if (obj->type != ACPI_TYPE_PACKAGE) { 855 /* wft is this? */ 856 dev_warn(dev, "Unknown type for ACPI object: (%d)\n", 857 obj->type); 858 return -EINVAL; 859 } 860 861 err = validate_hwmon_pack(data, obj); 862 if (err) 863 return err; 864 865 /* Ok, we have a valid hwmon package */ 866 type = atk_get_pack_member(data, obj, HWMON_PACK_FLAGS)->integer.value 867 & ATK_TYPE_MASK; 868 869 switch (type) { 870 case HWMON_TYPE_VOLT: 871 base_name = "in"; 872 limit1_name = "min"; 873 limit2_name = "max"; 874 num = &data->voltage_count; 875 start = 0; 876 break; 877 case HWMON_TYPE_TEMP: 878 base_name = "temp"; 879 limit1_name = "max"; 880 limit2_name = "crit"; 881 num = &data->temperature_count; 882 start = 1; 883 break; 884 case HWMON_TYPE_FAN: 885 base_name = "fan"; 886 limit1_name = "min"; 887 limit2_name = "max"; 888 num = &data->fan_count; 889 start = 1; 890 break; 891 default: 892 dev_warn(dev, "Unknown sensor type: %#llx\n", type); 893 return -EINVAL; 894 } 895 896 enable = atk_get_pack_member(data, obj, HWMON_PACK_ENABLE); 897 if (!enable->integer.value) 898 /* sensor is disabled */ 899 return 0; 900 901 flags = atk_get_pack_member(data, obj, HWMON_PACK_FLAGS); 902 name = atk_get_pack_member(data, obj, HWMON_PACK_NAME); 903 limit1 = atk_get_pack_member(data, obj, HWMON_PACK_LIMIT1); 904 limit2 = atk_get_pack_member(data, obj, HWMON_PACK_LIMIT2); 905 906 sensor = devm_kzalloc(dev, sizeof(*sensor), GFP_KERNEL); 907 if (!sensor) 908 return -ENOMEM; 909 910 sensor->acpi_name = devm_kstrdup(dev, name->string.pointer, GFP_KERNEL); 911 if (!sensor->acpi_name) 912 return -ENOMEM; 913 914 INIT_LIST_HEAD(&sensor->list); 915 sensor->type = type; 916 sensor->data = data; 917 sensor->id = flags->integer.value; 918 sensor->limit1 = limit1->integer.value; 919 if (data->old_interface) 920 sensor->limit2 = limit2->integer.value; 921 else 922 /* The upper limit is expressed as delta from lower limit */ 923 sensor->limit2 = sensor->limit1 + limit2->integer.value; 924 925 snprintf(sensor->input_attr_name, ATTR_NAME_SIZE, 926 "%s%d_input", base_name, start + *num); 927 atk_init_attribute(&sensor->input_attr, 928 sensor->input_attr_name, 929 atk_input_show); 930 931 snprintf(sensor->label_attr_name, ATTR_NAME_SIZE, 932 "%s%d_label", base_name, start + *num); 933 atk_init_attribute(&sensor->label_attr, 934 sensor->label_attr_name, 935 atk_label_show); 936 937 snprintf(sensor->limit1_attr_name, ATTR_NAME_SIZE, 938 "%s%d_%s", base_name, start + *num, limit1_name); 939 atk_init_attribute(&sensor->limit1_attr, 940 sensor->limit1_attr_name, 941 atk_limit1_show); 942 943 snprintf(sensor->limit2_attr_name, ATTR_NAME_SIZE, 944 "%s%d_%s", base_name, start + *num, limit2_name); 945 atk_init_attribute(&sensor->limit2_attr, 946 sensor->limit2_attr_name, 947 atk_limit2_show); 948 949 list_add(&sensor->list, &data->sensor_list); 950 (*num)++; 951 952 return 1; 953 } 954 955 static int atk_enumerate_old_hwmon(struct atk_data *data) 956 { 957 struct device *dev = &data->acpi_dev->dev; 958 struct acpi_buffer buf; 959 union acpi_object *pack; 960 acpi_status status; 961 int i, ret; 962 int count = 0; 963 964 /* Voltages */ 965 buf.length = ACPI_ALLOCATE_BUFFER; 966 status = acpi_evaluate_object_typed(data->atk_handle, 967 METHOD_OLD_ENUM_VLT, NULL, &buf, ACPI_TYPE_PACKAGE); 968 if (status != AE_OK) { 969 dev_warn(dev, METHOD_OLD_ENUM_VLT ": ACPI exception: %s\n", 970 acpi_format_exception(status)); 971 972 return -ENODEV; 973 } 974 975 pack = buf.pointer; 976 for (i = 1; i < pack->package.count; i++) { 977 union acpi_object *obj = &pack->package.elements[i]; 978 979 ret = atk_add_sensor(data, obj); 980 if (ret > 0) 981 count++; 982 } 983 ACPI_FREE(buf.pointer); 984 985 /* Temperatures */ 986 buf.length = ACPI_ALLOCATE_BUFFER; 987 status = acpi_evaluate_object_typed(data->atk_handle, 988 METHOD_OLD_ENUM_TMP, NULL, &buf, ACPI_TYPE_PACKAGE); 989 if (status != AE_OK) { 990 dev_warn(dev, METHOD_OLD_ENUM_TMP ": ACPI exception: %s\n", 991 acpi_format_exception(status)); 992 993 return -ENODEV; 994 } 995 996 pack = buf.pointer; 997 for (i = 1; i < pack->package.count; i++) { 998 union acpi_object *obj = &pack->package.elements[i]; 999 1000 ret = atk_add_sensor(data, obj); 1001 if (ret > 0) 1002 count++; 1003 } 1004 ACPI_FREE(buf.pointer); 1005 1006 /* Fans */ 1007 buf.length = ACPI_ALLOCATE_BUFFER; 1008 status = acpi_evaluate_object_typed(data->atk_handle, 1009 METHOD_OLD_ENUM_FAN, NULL, &buf, ACPI_TYPE_PACKAGE); 1010 if (status != AE_OK) { 1011 dev_warn(dev, METHOD_OLD_ENUM_FAN ": ACPI exception: %s\n", 1012 acpi_format_exception(status)); 1013 1014 return -ENODEV; 1015 } 1016 1017 pack = buf.pointer; 1018 for (i = 1; i < pack->package.count; i++) { 1019 union acpi_object *obj = &pack->package.elements[i]; 1020 1021 ret = atk_add_sensor(data, obj); 1022 if (ret > 0) 1023 count++; 1024 } 1025 ACPI_FREE(buf.pointer); 1026 1027 return count; 1028 } 1029 1030 static int atk_ec_present(struct atk_data *data) 1031 { 1032 struct device *dev = &data->acpi_dev->dev; 1033 union acpi_object *pack; 1034 union acpi_object *ec; 1035 int ret; 1036 int i; 1037 1038 pack = atk_ggrp(data, ATK_MUX_MGMT); 1039 if (IS_ERR(pack)) { 1040 if (PTR_ERR(pack) == -ENOENT) { 1041 /* The MGMT class does not exists - that's ok */ 1042 dev_dbg(dev, "Class %#llx not found\n", ATK_MUX_MGMT); 1043 return 0; 1044 } 1045 return PTR_ERR(pack); 1046 } 1047 1048 /* Search the EC */ 1049 ec = NULL; 1050 for (i = 0; i < pack->package.count; i++) { 1051 union acpi_object *obj = &pack->package.elements[i]; 1052 union acpi_object *id; 1053 1054 if (obj->type != ACPI_TYPE_PACKAGE) 1055 continue; 1056 1057 id = &obj->package.elements[0]; 1058 if (id->type != ACPI_TYPE_INTEGER) 1059 continue; 1060 1061 if (id->integer.value == ATK_EC_ID) { 1062 ec = obj; 1063 break; 1064 } 1065 } 1066 1067 ret = (ec != NULL); 1068 if (!ret) 1069 /* The system has no EC */ 1070 dev_dbg(dev, "EC not found\n"); 1071 1072 ACPI_FREE(pack); 1073 return ret; 1074 } 1075 1076 static int atk_ec_enabled(struct atk_data *data) 1077 { 1078 struct device *dev = &data->acpi_dev->dev; 1079 union acpi_object *obj; 1080 struct atk_acpi_ret_buffer *buf; 1081 int err; 1082 1083 obj = atk_gitm(data, ATK_EC_ID); 1084 if (IS_ERR(obj)) { 1085 dev_err(dev, "Unable to query EC status\n"); 1086 return PTR_ERR(obj); 1087 } 1088 buf = (struct atk_acpi_ret_buffer *)obj->buffer.pointer; 1089 1090 if (buf->flags == 0) { 1091 dev_err(dev, "Unable to query EC status\n"); 1092 err = -EIO; 1093 } else { 1094 err = (buf->value != 0); 1095 dev_dbg(dev, "EC is %sabled\n", 1096 err ? "en" : "dis"); 1097 } 1098 1099 ACPI_FREE(obj); 1100 return err; 1101 } 1102 1103 static int atk_ec_ctl(struct atk_data *data, int enable) 1104 { 1105 struct device *dev = &data->acpi_dev->dev; 1106 union acpi_object *obj; 1107 struct atk_acpi_input_buf sitm; 1108 struct atk_acpi_ret_buffer *ec_ret; 1109 int err = 0; 1110 1111 sitm.id = ATK_EC_ID; 1112 sitm.param1 = enable; 1113 sitm.param2 = 0; 1114 1115 obj = atk_sitm(data, &sitm); 1116 if (IS_ERR(obj)) { 1117 dev_err(dev, "Failed to %sable the EC\n", 1118 enable ? "en" : "dis"); 1119 return PTR_ERR(obj); 1120 } 1121 ec_ret = (struct atk_acpi_ret_buffer *)obj->buffer.pointer; 1122 if (ec_ret->flags == 0) { 1123 dev_err(dev, "Failed to %sable the EC\n", 1124 enable ? "en" : "dis"); 1125 err = -EIO; 1126 } else { 1127 dev_info(dev, "EC %sabled\n", 1128 enable ? "en" : "dis"); 1129 } 1130 1131 ACPI_FREE(obj); 1132 return err; 1133 } 1134 1135 static int atk_enumerate_new_hwmon(struct atk_data *data) 1136 { 1137 struct device *dev = &data->acpi_dev->dev; 1138 union acpi_object *pack; 1139 int err; 1140 int i; 1141 1142 err = atk_ec_present(data); 1143 if (err < 0) 1144 return err; 1145 if (err) { 1146 err = atk_ec_enabled(data); 1147 if (err < 0) 1148 return err; 1149 /* If the EC was disabled we will disable it again on unload */ 1150 data->disable_ec = err; 1151 1152 err = atk_ec_ctl(data, 1); 1153 if (err) { 1154 data->disable_ec = false; 1155 return err; 1156 } 1157 } 1158 1159 dev_dbg(dev, "Enumerating hwmon sensors\n"); 1160 1161 pack = atk_ggrp(data, ATK_MUX_HWMON); 1162 if (IS_ERR(pack)) 1163 return PTR_ERR(pack); 1164 1165 for (i = 0; i < pack->package.count; i++) { 1166 union acpi_object *obj = &pack->package.elements[i]; 1167 1168 atk_add_sensor(data, obj); 1169 } 1170 1171 err = data->voltage_count + data->temperature_count + data->fan_count; 1172 1173 ACPI_FREE(pack); 1174 return err; 1175 } 1176 1177 static int atk_init_attribute_groups(struct atk_data *data) 1178 { 1179 struct device *dev = &data->acpi_dev->dev; 1180 struct atk_sensor_data *s; 1181 struct attribute **attrs; 1182 int i = 0; 1183 int len = (data->voltage_count + data->temperature_count 1184 + data->fan_count) * 4 + 1; 1185 1186 attrs = devm_kcalloc(dev, len, sizeof(struct attribute *), GFP_KERNEL); 1187 if (!attrs) 1188 return -ENOMEM; 1189 1190 list_for_each_entry(s, &data->sensor_list, list) { 1191 attrs[i++] = &s->input_attr.attr; 1192 attrs[i++] = &s->label_attr.attr; 1193 attrs[i++] = &s->limit1_attr.attr; 1194 attrs[i++] = &s->limit2_attr.attr; 1195 } 1196 1197 data->attr_group.attrs = attrs; 1198 data->attr_groups[0] = &data->attr_group; 1199 1200 return 0; 1201 } 1202 1203 static int atk_register_hwmon(struct atk_data *data) 1204 { 1205 struct device *dev = &data->acpi_dev->dev; 1206 1207 dev_dbg(dev, "registering hwmon device\n"); 1208 data->hwmon_dev = hwmon_device_register_with_groups(dev, "atk0110", 1209 data, 1210 data->attr_groups); 1211 1212 return PTR_ERR_OR_ZERO(data->hwmon_dev); 1213 } 1214 1215 static int atk_probe_if(struct atk_data *data) 1216 { 1217 struct device *dev = &data->acpi_dev->dev; 1218 acpi_handle ret; 1219 acpi_status status; 1220 int err = 0; 1221 1222 /* RTMP: read temperature */ 1223 status = acpi_get_handle(data->atk_handle, METHOD_OLD_READ_TMP, &ret); 1224 if (ACPI_SUCCESS(status)) 1225 data->rtmp_handle = ret; 1226 else 1227 dev_dbg(dev, "method " METHOD_OLD_READ_TMP " not found: %s\n", 1228 acpi_format_exception(status)); 1229 1230 /* RVLT: read voltage */ 1231 status = acpi_get_handle(data->atk_handle, METHOD_OLD_READ_VLT, &ret); 1232 if (ACPI_SUCCESS(status)) 1233 data->rvlt_handle = ret; 1234 else 1235 dev_dbg(dev, "method " METHOD_OLD_READ_VLT " not found: %s\n", 1236 acpi_format_exception(status)); 1237 1238 /* RFAN: read fan status */ 1239 status = acpi_get_handle(data->atk_handle, METHOD_OLD_READ_FAN, &ret); 1240 if (ACPI_SUCCESS(status)) 1241 data->rfan_handle = ret; 1242 else 1243 dev_dbg(dev, "method " METHOD_OLD_READ_FAN " not found: %s\n", 1244 acpi_format_exception(status)); 1245 1246 /* Enumeration */ 1247 status = acpi_get_handle(data->atk_handle, METHOD_ENUMERATE, &ret); 1248 if (ACPI_SUCCESS(status)) 1249 data->enumerate_handle = ret; 1250 else 1251 dev_dbg(dev, "method " METHOD_ENUMERATE " not found: %s\n", 1252 acpi_format_exception(status)); 1253 1254 /* De-multiplexer (read) */ 1255 status = acpi_get_handle(data->atk_handle, METHOD_READ, &ret); 1256 if (ACPI_SUCCESS(status)) 1257 data->read_handle = ret; 1258 else 1259 dev_dbg(dev, "method " METHOD_READ " not found: %s\n", 1260 acpi_format_exception(status)); 1261 1262 /* De-multiplexer (write) */ 1263 status = acpi_get_handle(data->atk_handle, METHOD_WRITE, &ret); 1264 if (ACPI_SUCCESS(status)) 1265 data->write_handle = ret; 1266 else 1267 dev_dbg(dev, "method " METHOD_WRITE " not found: %s\n", 1268 acpi_format_exception(status)); 1269 1270 /* 1271 * Check for hwmon methods: first check "old" style methods; note that 1272 * both may be present: in this case we stick to the old interface; 1273 * analysis of multiple DSDTs indicates that when both interfaces 1274 * are present the new one (GGRP/GITM) is not functional. 1275 */ 1276 if (new_if) 1277 dev_info(dev, "Overriding interface detection\n"); 1278 if (data->rtmp_handle && 1279 data->rvlt_handle && data->rfan_handle && !new_if) 1280 data->old_interface = true; 1281 else if (data->enumerate_handle && data->read_handle && 1282 data->write_handle) 1283 data->old_interface = false; 1284 else 1285 err = -ENODEV; 1286 1287 return err; 1288 } 1289 1290 static int atk_add(struct acpi_device *device) 1291 { 1292 acpi_status ret; 1293 int err; 1294 struct acpi_buffer buf; 1295 union acpi_object *obj; 1296 struct atk_data *data; 1297 1298 dev_dbg(&device->dev, "adding...\n"); 1299 1300 data = devm_kzalloc(&device->dev, sizeof(*data), GFP_KERNEL); 1301 if (!data) 1302 return -ENOMEM; 1303 1304 data->acpi_dev = device; 1305 data->atk_handle = device->handle; 1306 INIT_LIST_HEAD(&data->sensor_list); 1307 data->disable_ec = false; 1308 1309 buf.length = ACPI_ALLOCATE_BUFFER; 1310 ret = acpi_evaluate_object_typed(data->atk_handle, BOARD_ID, NULL, 1311 &buf, ACPI_TYPE_PACKAGE); 1312 if (ret != AE_OK) { 1313 dev_dbg(&device->dev, "atk: method MBIF not found\n"); 1314 } else { 1315 obj = buf.pointer; 1316 if (obj->package.count >= 2) { 1317 union acpi_object *id = &obj->package.elements[1]; 1318 if (id->type == ACPI_TYPE_STRING) 1319 dev_dbg(&device->dev, "board ID = %s\n", 1320 id->string.pointer); 1321 } 1322 ACPI_FREE(buf.pointer); 1323 } 1324 1325 err = atk_probe_if(data); 1326 if (err) { 1327 dev_err(&device->dev, "No usable hwmon interface detected\n"); 1328 goto out; 1329 } 1330 1331 if (data->old_interface) { 1332 dev_dbg(&device->dev, "Using old hwmon interface\n"); 1333 err = atk_enumerate_old_hwmon(data); 1334 } else { 1335 dev_dbg(&device->dev, "Using new hwmon interface\n"); 1336 err = atk_enumerate_new_hwmon(data); 1337 } 1338 if (err < 0) 1339 goto out; 1340 if (err == 0) { 1341 dev_info(&device->dev, 1342 "No usable sensor detected, bailing out\n"); 1343 err = -ENODEV; 1344 goto out; 1345 } 1346 1347 err = atk_init_attribute_groups(data); 1348 if (err) 1349 goto out; 1350 err = atk_register_hwmon(data); 1351 if (err) 1352 goto out; 1353 1354 atk_debugfs_init(data); 1355 1356 device->driver_data = data; 1357 return 0; 1358 out: 1359 if (data->disable_ec) 1360 atk_ec_ctl(data, 0); 1361 return err; 1362 } 1363 1364 static int atk_remove(struct acpi_device *device) 1365 { 1366 struct atk_data *data = device->driver_data; 1367 dev_dbg(&device->dev, "removing...\n"); 1368 1369 device->driver_data = NULL; 1370 1371 atk_debugfs_cleanup(data); 1372 1373 hwmon_device_unregister(data->hwmon_dev); 1374 1375 if (data->disable_ec) { 1376 if (atk_ec_ctl(data, 0)) 1377 dev_err(&device->dev, "Failed to disable EC\n"); 1378 } 1379 1380 return 0; 1381 } 1382 1383 static int __init atk0110_init(void) 1384 { 1385 int ret; 1386 1387 /* Make sure it's safe to access the device through ACPI */ 1388 if (!acpi_resources_are_enforced()) { 1389 pr_err("Resources not safely usable due to acpi_enforce_resources kernel parameter\n"); 1390 return -EBUSY; 1391 } 1392 1393 if (dmi_check_system(atk_force_new_if)) 1394 new_if = true; 1395 1396 ret = acpi_bus_register_driver(&atk_driver); 1397 if (ret) 1398 pr_info("acpi_bus_register_driver failed: %d\n", ret); 1399 1400 return ret; 1401 } 1402 1403 static void __exit atk0110_exit(void) 1404 { 1405 acpi_bus_unregister_driver(&atk_driver); 1406 } 1407 1408 module_init(atk0110_init); 1409 module_exit(atk0110_exit); 1410 1411 MODULE_LICENSE("GPL"); 1412