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