drivers/platform/x86/intel-hid.c

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