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