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