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