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