1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * Intel HID event & 5 button array driver 4 * 5 * Copyright (C) 2015 Alex Hung <alex.hung@canonical.com> 6 * Copyright (C) 2015 Andrew Lutomirski <luto@kernel.org> 7 */ 8 9 #include <linux/acpi.h> 10 #include <linux/dmi.h> 11 #include <linux/input.h> 12 #include <linux/input/sparse-keymap.h> 13 #include <linux/kernel.h> 14 #include <linux/module.h> 15 #include <linux/platform_device.h> 16 #include <linux/string_choices.h> 17 #include <linux/suspend.h> 18 #include "../dual_accel_detect.h" 19 20 enum intel_hid_tablet_sw_mode { 21 TABLET_SW_AUTO = -1, 22 TABLET_SW_OFF = 0, 23 TABLET_SW_AT_EVENT, 24 TABLET_SW_AT_PROBE, 25 }; 26 27 static bool enable_5_button_array; 28 module_param(enable_5_button_array, bool, 0444); 29 MODULE_PARM_DESC(enable_5_button_array, 30 "Enable 5 Button Array support. " 31 "If you need this please report this to: platform-driver-x86@vger.kernel.org"); 32 33 static int enable_sw_tablet_mode = TABLET_SW_AUTO; 34 module_param(enable_sw_tablet_mode, int, 0444); 35 MODULE_PARM_DESC(enable_sw_tablet_mode, 36 "Enable SW_TABLET_MODE reporting -1:auto 0:off 1:at-first-event 2:at-probe. " 37 "If you need this please report this to: platform-driver-x86@vger.kernel.org"); 38 39 /* When NOT in tablet mode, VGBS returns with the flag 0x40 */ 40 #define TABLET_MODE_FLAG BIT(6) 41 42 MODULE_DESCRIPTION("Intel HID Event hotkey driver"); 43 MODULE_LICENSE("GPL"); 44 MODULE_AUTHOR("Alex Hung"); 45 46 static const struct acpi_device_id intel_hid_ids[] = { 47 { "INT33D5" }, 48 { "INTC1051" }, 49 { "INTC1054" }, 50 { "INTC1070" }, 51 { "INTC1076" }, 52 { "INTC1077" }, 53 { "INTC1078" }, 54 { "INTC107B" }, 55 { "INTC10CB" }, 56 { "INTC10CC" }, 57 { "INTC10F1" }, 58 { "INTC10F2" }, 59 { } 60 }; 61 MODULE_DEVICE_TABLE(acpi, intel_hid_ids); 62 63 /* In theory, these are HID usages. */ 64 static const struct key_entry intel_hid_keymap[] = { 65 /* 1: LSuper (Page 0x07, usage 0xE3) -- unclear what to do */ 66 /* 2: Toggle SW_ROTATE_LOCK -- easy to implement if seen in wild */ 67 { KE_KEY, 3, { KEY_NUMLOCK } }, 68 { KE_KEY, 4, { KEY_HOME } }, 69 { KE_KEY, 5, { KEY_END } }, 70 { KE_KEY, 6, { KEY_PAGEUP } }, 71 { KE_KEY, 7, { KEY_PAGEDOWN } }, 72 { KE_KEY, 8, { KEY_RFKILL } }, 73 { KE_KEY, 9, { KEY_POWER } }, 74 { KE_KEY, 11, { KEY_SLEEP } }, 75 /* 13 has two different meanings in the spec -- ignore it. */ 76 { KE_KEY, 14, { KEY_STOPCD } }, 77 { KE_KEY, 15, { KEY_PLAYPAUSE } }, 78 { KE_KEY, 16, { KEY_MUTE } }, 79 { KE_KEY, 17, { KEY_VOLUMEUP } }, 80 { KE_KEY, 18, { KEY_VOLUMEDOWN } }, 81 { KE_KEY, 19, { KEY_BRIGHTNESSUP } }, 82 { KE_KEY, 20, { KEY_BRIGHTNESSDOWN } }, 83 /* 27: wake -- needs special handling */ 84 { KE_END }, 85 }; 86 87 /* 5 button array notification value. */ 88 static const struct key_entry intel_array_keymap[] = { 89 { KE_KEY, 0xC2, { KEY_LEFTMETA } }, /* Press */ 90 { KE_IGNORE, 0xC3, { KEY_LEFTMETA } }, /* Release */ 91 { KE_KEY, 0xC4, { KEY_VOLUMEUP } }, /* Press */ 92 { KE_IGNORE, 0xC5, { KEY_VOLUMEUP } }, /* Release */ 93 { KE_KEY, 0xC6, { KEY_VOLUMEDOWN } }, /* Press */ 94 { KE_IGNORE, 0xC7, { KEY_VOLUMEDOWN } }, /* Release */ 95 { KE_KEY, 0xC8, { KEY_ROTATE_LOCK_TOGGLE } }, /* Press */ 96 { KE_IGNORE, 0xC9, { KEY_ROTATE_LOCK_TOGGLE } }, /* Release */ 97 { KE_KEY, 0xCE, { KEY_POWER } }, /* Press */ 98 { KE_IGNORE, 0xCF, { KEY_POWER } }, /* Release */ 99 { KE_END }, 100 }; 101 102 static const struct dmi_system_id button_array_table[] = { 103 { 104 .ident = "Wacom MobileStudio Pro 13", 105 .matches = { 106 DMI_MATCH(DMI_SYS_VENDOR, "Wacom Co.,Ltd"), 107 DMI_MATCH(DMI_PRODUCT_NAME, "Wacom MobileStudio Pro 13"), 108 }, 109 }, 110 { 111 .ident = "Wacom MobileStudio Pro 16", 112 .matches = { 113 DMI_MATCH(DMI_SYS_VENDOR, "Wacom Co.,Ltd"), 114 DMI_MATCH(DMI_PRODUCT_NAME, "Wacom MobileStudio Pro 16"), 115 }, 116 }, 117 { 118 .ident = "HP Spectre x2 (2015)", 119 .matches = { 120 DMI_MATCH(DMI_SYS_VENDOR, "HP"), 121 DMI_MATCH(DMI_PRODUCT_NAME, "HP Spectre x2 Detachable"), 122 }, 123 }, 124 { 125 .ident = "Lenovo ThinkPad X1 Tablet Gen 1", 126 .matches = { 127 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"), 128 DMI_MATCH(DMI_PRODUCT_FAMILY, "ThinkPad X12 Detachable Gen 1"), 129 }, 130 }, 131 { 132 .ident = "Lenovo ThinkPad X1 Tablet Gen 2", 133 .matches = { 134 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"), 135 DMI_MATCH(DMI_PRODUCT_FAMILY, "ThinkPad X1 Tablet Gen 2"), 136 }, 137 }, 138 { 139 .ident = "Microsoft Surface Go 3", 140 .matches = { 141 DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"), 142 DMI_MATCH(DMI_PRODUCT_NAME, "Surface Go 3"), 143 }, 144 }, 145 { 146 .ident = "Microsoft Surface Go 4", 147 .matches = { 148 DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"), 149 DMI_MATCH(DMI_PRODUCT_NAME, "Surface Go 4"), 150 }, 151 }, 152 { } 153 }; 154 155 /* 156 * Some convertible use the intel-hid ACPI interface to report SW_TABLET_MODE, 157 * these need to be compared via a DMI based authorization list because some 158 * models have unreliable VGBS return which could cause incorrect 159 * SW_TABLET_MODE report. 160 */ 161 static const struct dmi_system_id dmi_vgbs_allow_list[] = { 162 { 163 .matches = { 164 DMI_MATCH(DMI_SYS_VENDOR, "HP"), 165 DMI_MATCH(DMI_PRODUCT_NAME, "HP Spectre x360 Convertible 15-df0xxx"), 166 }, 167 }, 168 { 169 .matches = { 170 DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"), 171 DMI_MATCH(DMI_PRODUCT_NAME, "Surface Go"), 172 }, 173 }, 174 { 175 .matches = { 176 DMI_MATCH(DMI_SYS_VENDOR, "HP"), 177 DMI_MATCH(DMI_PRODUCT_NAME, "HP Elite Dragonfly G2 Notebook PC"), 178 }, 179 }, 180 { 181 .matches = { 182 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."), 183 DMI_MATCH(DMI_PRODUCT_NAME, "Dell Pro Rugged 10 Tablet RA00260"), 184 }, 185 }, 186 { 187 .matches = { 188 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."), 189 DMI_MATCH(DMI_PRODUCT_NAME, "Dell Pro Rugged 12 Tablet RA02260"), 190 }, 191 }, 192 { } 193 }; 194 195 /* 196 * Some devices, even non convertible ones, can send incorrect SW_TABLET_MODE 197 * reports. Accept such reports only from devices in this list. 198 */ 199 static const struct dmi_system_id dmi_auto_add_switch[] = { 200 { 201 .matches = { 202 DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "31" /* Convertible */), 203 }, 204 }, 205 { 206 .matches = { 207 DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "32" /* Detachable */), 208 }, 209 }, 210 {} /* Array terminator */ 211 }; 212 213 struct intel_hid_priv { 214 struct input_dev *input_dev; 215 struct input_dev *array; 216 struct input_dev *switches; 217 bool wakeup_mode; 218 }; 219 220 #define HID_EVENT_FILTER_UUID "eeec56b3-4442-408f-a792-4edd4d758054" 221 222 enum intel_hid_dsm_fn_codes { 223 INTEL_HID_DSM_FN_INVALID, 224 INTEL_HID_DSM_BTNL_FN, 225 INTEL_HID_DSM_HDMM_FN, 226 INTEL_HID_DSM_HDSM_FN, 227 INTEL_HID_DSM_HDEM_FN, 228 INTEL_HID_DSM_BTNS_FN, 229 INTEL_HID_DSM_BTNE_FN, 230 INTEL_HID_DSM_HEBC_V1_FN, 231 INTEL_HID_DSM_VGBS_FN, 232 INTEL_HID_DSM_HEBC_V2_FN, 233 INTEL_HID_DSM_FN_MAX 234 }; 235 236 static const char *intel_hid_dsm_fn_to_method[INTEL_HID_DSM_FN_MAX] = { 237 NULL, 238 "BTNL", 239 "HDMM", 240 "HDSM", 241 "HDEM", 242 "BTNS", 243 "BTNE", 244 "HEBC", 245 "VGBS", 246 "HEBC" 247 }; 248 249 static unsigned long long intel_hid_dsm_fn_mask; 250 static guid_t intel_dsm_guid; 251 252 static bool intel_hid_execute_method(acpi_handle handle, 253 enum intel_hid_dsm_fn_codes fn_index, 254 unsigned long long arg) 255 { 256 union acpi_object *obj, argv4, req; 257 acpi_status status; 258 char *method_name; 259 260 if (fn_index <= INTEL_HID_DSM_FN_INVALID || 261 fn_index >= INTEL_HID_DSM_FN_MAX) 262 return false; 263 264 method_name = (char *)intel_hid_dsm_fn_to_method[fn_index]; 265 266 if (!(intel_hid_dsm_fn_mask & BIT(fn_index))) 267 goto skip_dsm_exec; 268 269 /* All methods expects a package with one integer element */ 270 req.type = ACPI_TYPE_INTEGER; 271 req.integer.value = arg; 272 273 argv4.type = ACPI_TYPE_PACKAGE; 274 argv4.package.count = 1; 275 argv4.package.elements = &req; 276 277 obj = acpi_evaluate_dsm(handle, &intel_dsm_guid, 1, fn_index, &argv4); 278 if (obj) { 279 acpi_handle_debug(handle, "Exec DSM Fn code: %d[%s] success\n", 280 fn_index, method_name); 281 ACPI_FREE(obj); 282 return true; 283 } 284 285 skip_dsm_exec: 286 status = acpi_execute_simple_method(handle, method_name, arg); 287 if (ACPI_SUCCESS(status)) 288 return true; 289 290 return false; 291 } 292 293 static bool intel_hid_evaluate_method(acpi_handle handle, 294 enum intel_hid_dsm_fn_codes fn_index, 295 unsigned long long *result) 296 { 297 union acpi_object *obj; 298 acpi_status status; 299 char *method_name; 300 301 if (fn_index <= INTEL_HID_DSM_FN_INVALID || 302 fn_index >= INTEL_HID_DSM_FN_MAX) 303 return false; 304 305 method_name = (char *)intel_hid_dsm_fn_to_method[fn_index]; 306 307 if (!(intel_hid_dsm_fn_mask & BIT(fn_index))) 308 goto skip_dsm_eval; 309 310 obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid, 311 1, fn_index, 312 NULL, ACPI_TYPE_INTEGER); 313 if (obj) { 314 *result = obj->integer.value; 315 acpi_handle_debug(handle, 316 "Eval DSM Fn code: %d[%s] results: 0x%llx\n", 317 fn_index, method_name, *result); 318 ACPI_FREE(obj); 319 return true; 320 } 321 322 skip_dsm_eval: 323 status = acpi_evaluate_integer(handle, method_name, NULL, result); 324 if (ACPI_SUCCESS(status)) 325 return true; 326 327 return false; 328 } 329 330 static void intel_hid_init_dsm(acpi_handle handle) 331 { 332 union acpi_object *obj; 333 334 guid_parse(HID_EVENT_FILTER_UUID, &intel_dsm_guid); 335 336 obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid, 1, 0, NULL, 337 ACPI_TYPE_BUFFER); 338 if (obj) { 339 switch (obj->buffer.length) { 340 default: 341 case 2: 342 intel_hid_dsm_fn_mask = *(u16 *)obj->buffer.pointer; 343 break; 344 case 1: 345 intel_hid_dsm_fn_mask = *obj->buffer.pointer; 346 break; 347 case 0: 348 acpi_handle_warn(handle, "intel_hid_dsm_fn_mask length is zero\n"); 349 intel_hid_dsm_fn_mask = 0; 350 break; 351 } 352 ACPI_FREE(obj); 353 } 354 355 acpi_handle_debug(handle, "intel_hid_dsm_fn_mask = %llx\n", 356 intel_hid_dsm_fn_mask); 357 } 358 359 static int intel_hid_set_enable(struct device *device, bool enable) 360 { 361 acpi_handle handle = ACPI_HANDLE(device); 362 363 /* Enable|disable features - power button is always enabled */ 364 if (!intel_hid_execute_method(handle, INTEL_HID_DSM_HDSM_FN, enable)) { 365 dev_warn(device, "failed to %s hotkeys\n", str_enable_disable(enable)); 366 return -EIO; 367 } 368 369 return 0; 370 } 371 372 static void intel_button_array_enable(struct device *device, bool enable) 373 { 374 struct intel_hid_priv *priv = dev_get_drvdata(device); 375 acpi_handle handle = ACPI_HANDLE(device); 376 unsigned long long button_cap; 377 acpi_status status; 378 379 if (!priv->array) 380 return; 381 382 /* Query supported platform features */ 383 status = acpi_evaluate_integer(handle, "BTNC", NULL, &button_cap); 384 if (ACPI_FAILURE(status)) { 385 dev_warn(device, "failed to get button capability\n"); 386 return; 387 } 388 389 /* Enable|disable features - power button is always enabled */ 390 if (!intel_hid_execute_method(handle, INTEL_HID_DSM_BTNE_FN, 391 enable ? button_cap : 1)) 392 dev_warn(device, "failed to set button capability\n"); 393 } 394 395 static int intel_hid_pm_prepare(struct device *device) 396 { 397 if (device_may_wakeup(device)) { 398 struct intel_hid_priv *priv = dev_get_drvdata(device); 399 400 priv->wakeup_mode = true; 401 } 402 return 0; 403 } 404 405 static void intel_hid_pm_complete(struct device *device) 406 { 407 struct intel_hid_priv *priv = dev_get_drvdata(device); 408 409 priv->wakeup_mode = false; 410 } 411 412 static int intel_hid_pl_suspend_handler(struct device *device) 413 { 414 intel_button_array_enable(device, false); 415 416 if (!pm_suspend_no_platform()) 417 intel_hid_set_enable(device, false); 418 419 return 0; 420 } 421 422 static int intel_hid_pl_resume_handler(struct device *device) 423 { 424 intel_hid_pm_complete(device); 425 426 if (!pm_suspend_no_platform()) 427 intel_hid_set_enable(device, true); 428 429 intel_button_array_enable(device, true); 430 return 0; 431 } 432 433 static const struct dev_pm_ops intel_hid_pl_pm_ops = { 434 .prepare = intel_hid_pm_prepare, 435 .complete = intel_hid_pm_complete, 436 .freeze = intel_hid_pl_suspend_handler, 437 .thaw = intel_hid_pl_resume_handler, 438 .restore = intel_hid_pl_resume_handler, 439 .suspend = intel_hid_pl_suspend_handler, 440 .resume = intel_hid_pl_resume_handler, 441 }; 442 443 static int intel_hid_input_setup(struct platform_device *device) 444 { 445 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev); 446 int ret; 447 448 priv->input_dev = devm_input_allocate_device(&device->dev); 449 if (!priv->input_dev) 450 return -ENOMEM; 451 452 ret = sparse_keymap_setup(priv->input_dev, intel_hid_keymap, NULL); 453 if (ret) 454 return ret; 455 456 priv->input_dev->name = "Intel HID events"; 457 priv->input_dev->id.bustype = BUS_HOST; 458 459 return input_register_device(priv->input_dev); 460 } 461 462 static int intel_button_array_input_setup(struct platform_device *device) 463 { 464 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev); 465 int ret; 466 467 /* Setup input device for 5 button array */ 468 priv->array = devm_input_allocate_device(&device->dev); 469 if (!priv->array) 470 return -ENOMEM; 471 472 ret = sparse_keymap_setup(priv->array, intel_array_keymap, NULL); 473 if (ret) 474 return ret; 475 476 priv->array->name = "Intel HID 5 button array"; 477 priv->array->id.bustype = BUS_HOST; 478 479 return input_register_device(priv->array); 480 } 481 482 static int intel_hid_switches_setup(struct platform_device *device) 483 { 484 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev); 485 486 /* Setup input device for switches */ 487 priv->switches = devm_input_allocate_device(&device->dev); 488 if (!priv->switches) 489 return -ENOMEM; 490 491 __set_bit(EV_SW, priv->switches->evbit); 492 __set_bit(SW_TABLET_MODE, priv->switches->swbit); 493 494 priv->switches->name = "Intel HID switches"; 495 priv->switches->id.bustype = BUS_HOST; 496 return input_register_device(priv->switches); 497 } 498 499 static void report_tablet_mode_state(struct platform_device *device) 500 { 501 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev); 502 acpi_handle handle = ACPI_HANDLE(&device->dev); 503 unsigned long long vgbs; 504 int m; 505 506 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_VGBS_FN, &vgbs)) 507 return; 508 509 m = !(vgbs & TABLET_MODE_FLAG); 510 input_report_switch(priv->switches, SW_TABLET_MODE, m); 511 input_sync(priv->switches); 512 } 513 514 static bool report_tablet_mode_event(struct input_dev *input_dev, u32 event) 515 { 516 if (!input_dev) 517 return false; 518 519 switch (event) { 520 case 0xcc: 521 input_report_switch(input_dev, SW_TABLET_MODE, 1); 522 input_sync(input_dev); 523 return true; 524 case 0xcd: 525 input_report_switch(input_dev, SW_TABLET_MODE, 0); 526 input_sync(input_dev); 527 return true; 528 default: 529 return false; 530 } 531 } 532 533 static void notify_handler(acpi_handle handle, u32 event, void *context) 534 { 535 struct platform_device *device = context; 536 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev); 537 unsigned long long ev_index; 538 struct key_entry *ke; 539 int err; 540 541 /* 542 * Some convertible have unreliable VGBS return which could cause incorrect 543 * SW_TABLET_MODE report, in these cases we enable support when receiving 544 * the first event instead of during driver setup. 545 */ 546 if (!priv->switches && enable_sw_tablet_mode == TABLET_SW_AT_EVENT && 547 (event == 0xcc || event == 0xcd)) { 548 dev_info(&device->dev, "switch event received, enable switches supports\n"); 549 err = intel_hid_switches_setup(device); 550 if (err) 551 pr_err("Failed to setup Intel HID switches\n"); 552 } 553 554 if (priv->wakeup_mode) { 555 /* 556 * Needed for wakeup from suspend-to-idle to work on some 557 * platforms that don't expose the 5-button array, but still 558 * send notifies with the power button event code to this 559 * device object on power button actions while suspended. 560 */ 561 if (event == 0xce) 562 goto wakeup; 563 564 /* 565 * Some devices send (duplicate) tablet-mode events when moved 566 * around even though the mode has not changed; and they do this 567 * even when suspended. 568 * Update the switch state in case it changed and then return 569 * without waking up to avoid spurious wakeups. 570 */ 571 if (event == 0xcc || event == 0xcd) { 572 report_tablet_mode_event(priv->switches, event); 573 return; 574 } 575 576 /* Wake up on 5-button array events only. */ 577 if (event == 0xc0 || !priv->array) 578 return; 579 580 ke = sparse_keymap_entry_from_scancode(priv->array, event); 581 if (!ke) { 582 dev_info(&device->dev, "unknown event 0x%x\n", event); 583 return; 584 } 585 586 if (ke->type == KE_IGNORE) 587 return; 588 589 wakeup: 590 pm_wakeup_hard_event(&device->dev); 591 592 return; 593 } 594 595 /* 596 * Needed for suspend to work on some platforms that don't expose 597 * the 5-button array, but still send notifies with power button 598 * event code to this device object on power button actions. 599 * 600 * Report the power button press and release. 601 */ 602 if (!priv->array) { 603 if (event == 0xce) { 604 input_report_key(priv->input_dev, KEY_POWER, 1); 605 input_sync(priv->input_dev); 606 return; 607 } 608 609 if (event == 0xcf) { 610 input_report_key(priv->input_dev, KEY_POWER, 0); 611 input_sync(priv->input_dev); 612 return; 613 } 614 } 615 616 if (report_tablet_mode_event(priv->switches, event)) 617 return; 618 619 /* 0xC0 is for HID events, other values are for 5 button array */ 620 if (event != 0xc0) { 621 if (!priv->array || 622 !sparse_keymap_report_event(priv->array, event, 1, true)) 623 dev_dbg(&device->dev, "unknown event 0x%x\n", event); 624 return; 625 } 626 627 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDEM_FN, 628 &ev_index)) { 629 dev_warn(&device->dev, "failed to get event index\n"); 630 return; 631 } 632 633 if (!sparse_keymap_report_event(priv->input_dev, ev_index, 1, true)) 634 dev_dbg(&device->dev, "unknown event index 0x%llx\n", 635 ev_index); 636 } 637 638 static bool button_array_present(struct platform_device *device) 639 { 640 acpi_handle handle = ACPI_HANDLE(&device->dev); 641 unsigned long long event_cap; 642 643 if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V2_FN, 644 &event_cap)) { 645 /* Check presence of 5 button array or v2 power button */ 646 if (event_cap & 0x60000) 647 return true; 648 } 649 650 if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V1_FN, 651 &event_cap)) { 652 if (event_cap & 0x20000) 653 return true; 654 } 655 656 if (enable_5_button_array || dmi_check_system(button_array_table)) 657 return true; 658 659 return false; 660 } 661 662 static int intel_hid_probe(struct platform_device *device) 663 { 664 acpi_handle handle = ACPI_HANDLE(&device->dev); 665 unsigned long long mode, dummy; 666 struct intel_hid_priv *priv; 667 acpi_status status; 668 int err; 669 670 intel_hid_init_dsm(handle); 671 672 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDMM_FN, &mode)) { 673 dev_warn(&device->dev, "failed to read mode\n"); 674 return -ENODEV; 675 } 676 677 if (mode != 0) { 678 /* 679 * This driver only implements "simple" mode. There appear 680 * to be no other modes, but we should be paranoid and check 681 * for compatibility. 682 */ 683 dev_info(&device->dev, "platform is not in simple mode\n"); 684 return -ENODEV; 685 } 686 687 priv = devm_kzalloc(&device->dev, sizeof(*priv), GFP_KERNEL); 688 if (!priv) 689 return -ENOMEM; 690 dev_set_drvdata(&device->dev, priv); 691 692 /* See dual_accel_detect.h for more info on the dual_accel check. */ 693 if (enable_sw_tablet_mode == TABLET_SW_AUTO) { 694 if (dmi_check_system(dmi_vgbs_allow_list)) 695 enable_sw_tablet_mode = TABLET_SW_AT_PROBE; 696 else if (dmi_check_system(dmi_auto_add_switch) && !dual_accel_detect()) 697 enable_sw_tablet_mode = TABLET_SW_AT_EVENT; 698 else 699 enable_sw_tablet_mode = TABLET_SW_OFF; 700 } 701 702 err = intel_hid_input_setup(device); 703 if (err) { 704 pr_err("Failed to setup Intel HID hotkeys\n"); 705 return err; 706 } 707 708 /* Setup 5 button array */ 709 if (button_array_present(device)) { 710 dev_info(&device->dev, "platform supports 5 button array\n"); 711 err = intel_button_array_input_setup(device); 712 if (err) 713 pr_err("Failed to setup Intel 5 button array hotkeys\n"); 714 } 715 716 /* Setup switches for devices that we know VGBS return correctly */ 717 if (enable_sw_tablet_mode == TABLET_SW_AT_PROBE) { 718 dev_info(&device->dev, "platform supports switches\n"); 719 err = intel_hid_switches_setup(device); 720 if (err) 721 pr_err("Failed to setup Intel HID switches\n"); 722 else 723 report_tablet_mode_state(device); 724 } 725 726 status = acpi_install_notify_handler(handle, 727 ACPI_DEVICE_NOTIFY, 728 notify_handler, 729 device); 730 if (ACPI_FAILURE(status)) 731 return -EBUSY; 732 733 err = intel_hid_set_enable(&device->dev, true); 734 if (err) 735 goto err_remove_notify; 736 737 intel_button_array_enable(&device->dev, true); 738 739 /* 740 * Call button load method to enable HID power button 741 * Always do this since it activates events on some devices without 742 * a button array too. 743 */ 744 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_BTNL_FN, &dummy)) 745 dev_warn(&device->dev, "failed to enable HID power button\n"); 746 747 device_init_wakeup(&device->dev, true); 748 /* 749 * In order for system wakeup to work, the EC GPE has to be marked as 750 * a wakeup one, so do that here (this setting will persist, but it has 751 * no effect until the wakeup mask is set for the EC GPE). 752 */ 753 acpi_ec_mark_gpe_for_wake(); 754 return 0; 755 756 err_remove_notify: 757 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler); 758 759 return err; 760 } 761 762 static void intel_hid_remove(struct platform_device *device) 763 { 764 acpi_handle handle = ACPI_HANDLE(&device->dev); 765 766 device_init_wakeup(&device->dev, false); 767 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler); 768 intel_hid_set_enable(&device->dev, false); 769 intel_button_array_enable(&device->dev, false); 770 } 771 772 static struct platform_driver intel_hid_pl_driver = { 773 .driver = { 774 .name = "intel-hid", 775 .acpi_match_table = intel_hid_ids, 776 .pm = &intel_hid_pl_pm_ops, 777 }, 778 .probe = intel_hid_probe, 779 .remove = intel_hid_remove, 780 }; 781 782 /* 783 * Unfortunately, some laptops provide a _HID="INT33D5" device with 784 * _CID="PNP0C02". This causes the pnpacpi scan driver to claim the 785 * ACPI node, so no platform device will be created. The pnpacpi 786 * driver rejects this device in subsequent processing, so no physical 787 * node is created at all. 788 * 789 * As a workaround until the ACPI core figures out how to handle 790 * this corner case, manually ask the ACPI platform device code to 791 * claim the ACPI node. 792 */ 793 static acpi_status __init 794 check_acpi_dev(acpi_handle handle, u32 lvl, void *context, void **rv) 795 { 796 const struct acpi_device_id *ids = context; 797 struct acpi_device *dev = acpi_fetch_acpi_dev(handle); 798 799 if (dev && acpi_match_device_ids(dev, ids) == 0) 800 if (!IS_ERR_OR_NULL(acpi_create_platform_device(dev, NULL))) 801 dev_info(&dev->dev, 802 "intel-hid: created platform device\n"); 803 804 return AE_OK; 805 } 806 807 static int __init intel_hid_init(void) 808 { 809 acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT, 810 ACPI_UINT32_MAX, check_acpi_dev, NULL, 811 (void *)intel_hid_ids, NULL); 812 813 return platform_driver_register(&intel_hid_pl_driver); 814 } 815 module_init(intel_hid_init); 816 817 static void __exit intel_hid_exit(void) 818 { 819 platform_driver_unregister(&intel_hid_pl_driver); 820 } 821 module_exit(intel_hid_exit); 822