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