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 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: platform-driver-x86@vger.kernel.org");
  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: platform-driver-x86@vger.kernel.org");
  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                 .matches = {
 155                         DMI_MATCH(DMI_SYS_VENDOR, "HP"),
 156                         DMI_MATCH(DMI_PRODUCT_NAME, "HP Elite Dragonfly G2 Notebook PC"),
 157                 },
 158         },
 159         { }
 160 };
 161
 162 /*
 163  * Some devices, even non convertible ones, can send incorrect SW_TABLET_MODE
 164  * reports. Accept such reports only from devices in this list.
 165  */
 166 static const struct dmi_system_id dmi_auto_add_switch[] = {
 167         {
 168                 .matches = {
 169                         DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "31" /* Convertible */),
 170                 },
 171         },
 172         {
 173                 .matches = {
 174                         DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "32" /* Detachable */),
 175                 },
 176         },
 177         {} /* Array terminator */
 178 };
 179
 180 struct intel_hid_priv {
 181         struct input_dev *input_dev;
 182         struct input_dev *array;
 183         struct input_dev *switches;
 184         bool wakeup_mode;
 185 };
 186
 187 #define HID_EVENT_FILTER_UUID   "eeec56b3-4442-408f-a792-4edd4d758054"
 188
 189 enum intel_hid_dsm_fn_codes {
 190         INTEL_HID_DSM_FN_INVALID,
 191         INTEL_HID_DSM_BTNL_FN,
 192         INTEL_HID_DSM_HDMM_FN,
 193         INTEL_HID_DSM_HDSM_FN,
 194         INTEL_HID_DSM_HDEM_FN,
 195         INTEL_HID_DSM_BTNS_FN,
 196         INTEL_HID_DSM_BTNE_FN,
 197         INTEL_HID_DSM_HEBC_V1_FN,
 198         INTEL_HID_DSM_VGBS_FN,
 199         INTEL_HID_DSM_HEBC_V2_FN,
 200         INTEL_HID_DSM_FN_MAX
 201 };
 202
 203 static const char *intel_hid_dsm_fn_to_method[INTEL_HID_DSM_FN_MAX] = {
 204         NULL,
 205         "BTNL",
 206         "HDMM",
 207         "HDSM",
 208         "HDEM",
 209         "BTNS",
 210         "BTNE",
 211         "HEBC",
 212         "VGBS",
 213         "HEBC"
 214 };
 215
 216 static unsigned long long intel_hid_dsm_fn_mask;
 217 static guid_t intel_dsm_guid;
 218
 219 static bool intel_hid_execute_method(acpi_handle handle,
 220                                      enum intel_hid_dsm_fn_codes fn_index,
 221                                      unsigned long long arg)
 222 {
 223         union acpi_object *obj, argv4, req;
 224         acpi_status status;
 225         char *method_name;
 226
 227         if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
 228             fn_index >= INTEL_HID_DSM_FN_MAX)
 229                 return false;
 230
 231         method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
 232
 233         if (!(intel_hid_dsm_fn_mask & BIT(fn_index)))
 234                 goto skip_dsm_exec;
 235
 236         /* All methods expects a package with one integer element */
 237         req.type = ACPI_TYPE_INTEGER;
 238         req.integer.value = arg;
 239
 240         argv4.type = ACPI_TYPE_PACKAGE;
 241         argv4.package.count = 1;
 242         argv4.package.elements = &req;
 243
 244         obj = acpi_evaluate_dsm(handle, &intel_dsm_guid, 1, fn_index, &argv4);
 245         if (obj) {
 246                 acpi_handle_debug(handle, "Exec DSM Fn code: %d[%s] success\n",
 247                                   fn_index, method_name);
 248                 ACPI_FREE(obj);
 249                 return true;
 250         }
 251
 252 skip_dsm_exec:
 253         status = acpi_execute_simple_method(handle, method_name, arg);
 254         if (ACPI_SUCCESS(status))
 255                 return true;
 256
 257         return false;
 258 }
 259
 260 static bool intel_hid_evaluate_method(acpi_handle handle,
 261                                       enum intel_hid_dsm_fn_codes fn_index,
 262                                       unsigned long long *result)
 263 {
 264         union acpi_object *obj;
 265         acpi_status status;
 266         char *method_name;
 267
 268         if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
 269             fn_index >= INTEL_HID_DSM_FN_MAX)
 270                 return false;
 271
 272         method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
 273
 274         if (!(intel_hid_dsm_fn_mask & BIT(fn_index)))
 275                 goto skip_dsm_eval;
 276
 277         obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid,
 278                                       1, fn_index,
 279                                       NULL,  ACPI_TYPE_INTEGER);
 280         if (obj) {
 281                 *result = obj->integer.value;
 282                 acpi_handle_debug(handle,
 283                                   "Eval DSM Fn code: %d[%s] results: 0x%llx\n",
 284                                   fn_index, method_name, *result);
 285                 ACPI_FREE(obj);
 286                 return true;
 287         }
 288
 289 skip_dsm_eval:
 290         status = acpi_evaluate_integer(handle, method_name, NULL, result);
 291         if (ACPI_SUCCESS(status))
 292                 return true;
 293
 294         return false;
 295 }
 296
 297 static void intel_hid_init_dsm(acpi_handle handle)
 298 {
 299         union acpi_object *obj;
 300
 301         guid_parse(HID_EVENT_FILTER_UUID, &intel_dsm_guid);
 302
 303         obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid, 1, 0, NULL,
 304                                       ACPI_TYPE_BUFFER);
 305         if (obj) {
 306                 switch (obj->buffer.length) {
 307                 default:
 308                 case 2:
 309                         intel_hid_dsm_fn_mask = *(u16 *)obj->buffer.pointer;
 310                         break;
 311                 case 1:
 312                         intel_hid_dsm_fn_mask = *obj->buffer.pointer;
 313                         break;
 314                 case 0:
 315                         acpi_handle_warn(handle, "intel_hid_dsm_fn_mask length is zero\n");
 316                         intel_hid_dsm_fn_mask = 0;
 317                         break;
 318                 }
 319                 ACPI_FREE(obj);
 320         }
 321
 322         acpi_handle_debug(handle, "intel_hid_dsm_fn_mask = %llx\n",
 323                           intel_hid_dsm_fn_mask);
 324 }
 325
 326 static int intel_hid_set_enable(struct device *device, bool enable)
 327 {
 328         acpi_handle handle = ACPI_HANDLE(device);
 329
 330         /* Enable|disable features - power button is always enabled */
 331         if (!intel_hid_execute_method(handle, INTEL_HID_DSM_HDSM_FN,
 332                                       enable)) {
 333                 dev_warn(device, "failed to %sable hotkeys\n",
 334                          enable ? "en" : "dis");
 335                 return -EIO;
 336         }
 337
 338         return 0;
 339 }
 340
 341 static void intel_button_array_enable(struct device *device, bool enable)
 342 {
 343         struct intel_hid_priv *priv = dev_get_drvdata(device);
 344         acpi_handle handle = ACPI_HANDLE(device);
 345         unsigned long long button_cap;
 346         acpi_status status;
 347
 348         if (!priv->array)
 349                 return;
 350
 351         /* Query supported platform features */
 352         status = acpi_evaluate_integer(handle, "BTNC", NULL, &button_cap);
 353         if (ACPI_FAILURE(status)) {
 354                 dev_warn(device, "failed to get button capability\n");
 355                 return;
 356         }
 357
 358         /* Enable|disable features - power button is always enabled */
 359         if (!intel_hid_execute_method(handle, INTEL_HID_DSM_BTNE_FN,
 360                                       enable ? button_cap : 1))
 361                 dev_warn(device, "failed to set button capability\n");
 362 }
 363
 364 static int intel_hid_pm_prepare(struct device *device)
 365 {
 366         if (device_may_wakeup(device)) {
 367                 struct intel_hid_priv *priv = dev_get_drvdata(device);
 368
 369                 priv->wakeup_mode = true;
 370         }
 371         return 0;
 372 }
 373
 374 static void intel_hid_pm_complete(struct device *device)
 375 {
 376         struct intel_hid_priv *priv = dev_get_drvdata(device);
 377
 378         priv->wakeup_mode = false;
 379 }
 380
 381 static int intel_hid_pl_suspend_handler(struct device *device)
 382 {
 383         intel_button_array_enable(device, false);
 384
 385         if (!pm_suspend_no_platform())
 386                 intel_hid_set_enable(device, false);
 387
 388         return 0;
 389 }
 390
 391 static int intel_hid_pl_resume_handler(struct device *device)
 392 {
 393         intel_hid_pm_complete(device);
 394
 395         if (!pm_suspend_no_platform())
 396                 intel_hid_set_enable(device, true);
 397
 398         intel_button_array_enable(device, true);
 399         return 0;
 400 }
 401
 402 static const struct dev_pm_ops intel_hid_pl_pm_ops = {
 403         .prepare = intel_hid_pm_prepare,
 404         .complete = intel_hid_pm_complete,
 405         .freeze  = intel_hid_pl_suspend_handler,
 406         .thaw  = intel_hid_pl_resume_handler,
 407         .restore  = intel_hid_pl_resume_handler,
 408         .suspend  = intel_hid_pl_suspend_handler,
 409         .resume  = intel_hid_pl_resume_handler,
 410 };
 411
 412 static int intel_hid_input_setup(struct platform_device *device)
 413 {
 414         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 415         int ret;
 416
 417         priv->input_dev = devm_input_allocate_device(&device->dev);
 418         if (!priv->input_dev)
 419                 return -ENOMEM;
 420
 421         ret = sparse_keymap_setup(priv->input_dev, intel_hid_keymap, NULL);
 422         if (ret)
 423                 return ret;
 424
 425         priv->input_dev->name = "Intel HID events";
 426         priv->input_dev->id.bustype = BUS_HOST;
 427
 428         return input_register_device(priv->input_dev);
 429 }
 430
 431 static int intel_button_array_input_setup(struct platform_device *device)
 432 {
 433         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 434         int ret;
 435
 436         /* Setup input device for 5 button array */
 437         priv->array = devm_input_allocate_device(&device->dev);
 438         if (!priv->array)
 439                 return -ENOMEM;
 440
 441         ret = sparse_keymap_setup(priv->array, intel_array_keymap, NULL);
 442         if (ret)
 443                 return ret;
 444
 445         priv->array->name = "Intel HID 5 button array";
 446         priv->array->id.bustype = BUS_HOST;
 447
 448         return input_register_device(priv->array);
 449 }
 450
 451 static int intel_hid_switches_setup(struct platform_device *device)
 452 {
 453         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 454
 455         /* Setup input device for switches */
 456         priv->switches = devm_input_allocate_device(&device->dev);
 457         if (!priv->switches)
 458                 return -ENOMEM;
 459
 460         __set_bit(EV_SW, priv->switches->evbit);
 461         __set_bit(SW_TABLET_MODE, priv->switches->swbit);
 462
 463         priv->switches->name = "Intel HID switches";
 464         priv->switches->id.bustype = BUS_HOST;
 465         return input_register_device(priv->switches);
 466 }
 467
 468 static void report_tablet_mode_state(struct platform_device *device)
 469 {
 470         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 471         acpi_handle handle = ACPI_HANDLE(&device->dev);
 472         unsigned long long vgbs;
 473         int m;
 474
 475         if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_VGBS_FN, &vgbs))
 476                 return;
 477
 478         m = !(vgbs & TABLET_MODE_FLAG);
 479         input_report_switch(priv->switches, SW_TABLET_MODE, m);
 480         input_sync(priv->switches);
 481 }
 482
 483 static bool report_tablet_mode_event(struct input_dev *input_dev, u32 event)
 484 {
 485         if (!input_dev)
 486                 return false;
 487
 488         switch (event) {
 489         case 0xcc:
 490                 input_report_switch(input_dev, SW_TABLET_MODE, 1);
 491                 input_sync(input_dev);
 492                 return true;
 493         case 0xcd:
 494                 input_report_switch(input_dev, SW_TABLET_MODE, 0);
 495                 input_sync(input_dev);
 496                 return true;
 497         default:
 498                 return false;
 499         }
 500 }
 501
 502 static void notify_handler(acpi_handle handle, u32 event, void *context)
 503 {
 504         struct platform_device *device = context;
 505         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 506         unsigned long long ev_index;
 507         int err;
 508
 509         /*
 510          * Some convertible have unreliable VGBS return which could cause incorrect
 511          * SW_TABLET_MODE report, in these cases we enable support when receiving
 512          * the first event instead of during driver setup.
 513          */
 514         if (!priv->switches && enable_sw_tablet_mode == TABLET_SW_AT_EVENT &&
 515             (event == 0xcc || event == 0xcd)) {
 516                 dev_info(&device->dev, "switch event received, enable switches supports\n");
 517                 err = intel_hid_switches_setup(device);
 518                 if (err)
 519                         pr_err("Failed to setup Intel HID switches\n");
 520         }
 521
 522         if (priv->wakeup_mode) {
 523                 /*
 524                  * Needed for wakeup from suspend-to-idle to work on some
 525                  * platforms that don't expose the 5-button array, but still
 526                  * send notifies with the power button event code to this
 527                  * device object on power button actions while suspended.
 528                  */
 529                 if (event == 0xce)
 530                         goto wakeup;
 531
 532                 /*
 533                  * Some devices send (duplicate) tablet-mode events when moved
 534                  * around even though the mode has not changed; and they do this
 535                  * even when suspended.
 536                  * Update the switch state in case it changed and then return
 537                  * without waking up to avoid spurious wakeups.
 538                  */
 539                 if (event == 0xcc || event == 0xcd) {
 540                         report_tablet_mode_event(priv->switches, event);
 541                         return;
 542                 }
 543
 544                 /* Wake up on 5-button array events only. */
 545                 if (event == 0xc0 || !priv->array)
 546                         return;
 547
 548                 if (!sparse_keymap_entry_from_scancode(priv->array, event)) {
 549                         dev_info(&device->dev, "unknown event 0x%x\n", event);
 550                         return;
 551                 }
 552
 553 wakeup:
 554                 pm_wakeup_hard_event(&device->dev);
 555
 556                 return;
 557         }
 558
 559         /*
 560          * Needed for suspend to work on some platforms that don't expose
 561          * the 5-button array, but still send notifies with power button
 562          * event code to this device object on power button actions.
 563          *
 564          * Report the power button press and release.
 565          */
 566         if (!priv->array) {
 567                 if (event == 0xce) {
 568                         input_report_key(priv->input_dev, KEY_POWER, 1);
 569                         input_sync(priv->input_dev);
 570                         return;
 571                 }
 572
 573                 if (event == 0xcf) {
 574                         input_report_key(priv->input_dev, KEY_POWER, 0);
 575                         input_sync(priv->input_dev);
 576                         return;
 577                 }
 578         }
 579
 580         if (report_tablet_mode_event(priv->switches, event))
 581                 return;
 582
 583         /* 0xC0 is for HID events, other values are for 5 button array */
 584         if (event != 0xc0) {
 585                 if (!priv->array ||
 586                     !sparse_keymap_report_event(priv->array, event, 1, true))
 587                         dev_dbg(&device->dev, "unknown event 0x%x\n", event);
 588                 return;
 589         }
 590
 591         if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDEM_FN,
 592                                        &ev_index)) {
 593                 dev_warn(&device->dev, "failed to get event index\n");
 594                 return;
 595         }
 596
 597         if (!sparse_keymap_report_event(priv->input_dev, ev_index, 1, true))
 598                 dev_dbg(&device->dev, "unknown event index 0x%llx\n",
 599                          ev_index);
 600 }
 601
 602 static bool button_array_present(struct platform_device *device)
 603 {
 604         acpi_handle handle = ACPI_HANDLE(&device->dev);
 605         unsigned long long event_cap;
 606
 607         if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V2_FN,
 608                                       &event_cap)) {
 609                 /* Check presence of 5 button array or v2 power button */
 610                 if (event_cap & 0x60000)
 611                         return true;
 612         }
 613
 614         if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V1_FN,
 615                                       &event_cap)) {
 616                 if (event_cap & 0x20000)
 617                         return true;
 618         }
 619
 620         if (enable_5_button_array || dmi_check_system(button_array_table))
 621                 return true;
 622
 623         return false;
 624 }
 625
 626 static int intel_hid_probe(struct platform_device *device)
 627 {
 628         acpi_handle handle = ACPI_HANDLE(&device->dev);
 629         unsigned long long mode, dummy;
 630         struct intel_hid_priv *priv;
 631         acpi_status status;
 632         int err;
 633
 634         intel_hid_init_dsm(handle);
 635
 636         if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDMM_FN, &mode)) {
 637                 dev_warn(&device->dev, "failed to read mode\n");
 638                 return -ENODEV;
 639         }
 640
 641         if (mode != 0) {
 642                 /*
 643                  * This driver only implements "simple" mode.  There appear
 644                  * to be no other modes, but we should be paranoid and check
 645                  * for compatibility.
 646                  */
 647                 dev_info(&device->dev, "platform is not in simple mode\n");
 648                 return -ENODEV;
 649         }
 650
 651         priv = devm_kzalloc(&device->dev, sizeof(*priv), GFP_KERNEL);
 652         if (!priv)
 653                 return -ENOMEM;
 654         dev_set_drvdata(&device->dev, priv);
 655
 656         /* See dual_accel_detect.h for more info on the dual_accel check. */
 657         if (enable_sw_tablet_mode == TABLET_SW_AUTO) {
 658                 if (dmi_check_system(dmi_vgbs_allow_list))
 659                         enable_sw_tablet_mode = TABLET_SW_AT_PROBE;
 660                 else if (dmi_check_system(dmi_auto_add_switch) && !dual_accel_detect())
 661                         enable_sw_tablet_mode = TABLET_SW_AT_EVENT;
 662                 else
 663                         enable_sw_tablet_mode = TABLET_SW_OFF;
 664         }
 665
 666         err = intel_hid_input_setup(device);
 667         if (err) {
 668                 pr_err("Failed to setup Intel HID hotkeys\n");
 669                 return err;
 670         }
 671
 672         /* Setup 5 button array */
 673         if (button_array_present(device)) {
 674                 dev_info(&device->dev, "platform supports 5 button array\n");
 675                 err = intel_button_array_input_setup(device);
 676                 if (err)
 677                         pr_err("Failed to setup Intel 5 button array hotkeys\n");
 678         }
 679
 680         /* Setup switches for devices that we know VGBS return correctly */
 681         if (enable_sw_tablet_mode == TABLET_SW_AT_PROBE) {
 682                 dev_info(&device->dev, "platform supports switches\n");
 683                 err = intel_hid_switches_setup(device);
 684                 if (err)
 685                         pr_err("Failed to setup Intel HID switches\n");
 686                 else
 687                         report_tablet_mode_state(device);
 688         }
 689
 690         status = acpi_install_notify_handler(handle,
 691                                              ACPI_DEVICE_NOTIFY,
 692                                              notify_handler,
 693                                              device);
 694         if (ACPI_FAILURE(status))
 695                 return -EBUSY;
 696
 697         err = intel_hid_set_enable(&device->dev, true);
 698         if (err)
 699                 goto err_remove_notify;
 700
 701         intel_button_array_enable(&device->dev, true);
 702
 703         /*
 704          * Call button load method to enable HID power button
 705          * Always do this since it activates events on some devices without
 706          * a button array too.
 707          */
 708         if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_BTNL_FN, &dummy))
 709                 dev_warn(&device->dev, "failed to enable HID power button\n");
 710
 711         device_init_wakeup(&device->dev, true);
 712         /*
 713          * In order for system wakeup to work, the EC GPE has to be marked as
 714          * a wakeup one, so do that here (this setting will persist, but it has
 715          * no effect until the wakeup mask is set for the EC GPE).
 716          */
 717         acpi_ec_mark_gpe_for_wake();
 718         return 0;
 719
 720 err_remove_notify:
 721         acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
 722
 723         return err;
 724 }
 725
 726 static void intel_hid_remove(struct platform_device *device)
 727 {
 728         acpi_handle handle = ACPI_HANDLE(&device->dev);
 729
 730         device_init_wakeup(&device->dev, false);
 731         acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
 732         intel_hid_set_enable(&device->dev, false);
 733         intel_button_array_enable(&device->dev, false);
 734 }
 735
 736 static struct platform_driver intel_hid_pl_driver = {
 737         .driver = {
 738                 .name = "intel-hid",
 739                 .acpi_match_table = intel_hid_ids,
 740                 .pm = &intel_hid_pl_pm_ops,
 741         },
 742         .probe = intel_hid_probe,
 743         .remove_new = intel_hid_remove,
 744 };
 745
 746 /*
 747  * Unfortunately, some laptops provide a _HID="INT33D5" device with
 748  * _CID="PNP0C02".  This causes the pnpacpi scan driver to claim the
 749  * ACPI node, so no platform device will be created.  The pnpacpi
 750  * driver rejects this device in subsequent processing, so no physical
 751  * node is created at all.
 752  *
 753  * As a workaround until the ACPI core figures out how to handle
 754  * this corner case, manually ask the ACPI platform device code to
 755  * claim the ACPI node.
 756  */
 757 static acpi_status __init
 758 check_acpi_dev(acpi_handle handle, u32 lvl, void *context, void **rv)
 759 {
 760         const struct acpi_device_id *ids = context;
 761         struct acpi_device *dev = acpi_fetch_acpi_dev(handle);
 762
 763         if (dev && acpi_match_device_ids(dev, ids) == 0)
 764                 if (!IS_ERR_OR_NULL(acpi_create_platform_device(dev, NULL)))
 765                         dev_info(&dev->dev,
 766                                  "intel-hid: created platform device\n");
 767
 768         return AE_OK;
 769 }
 770
 771 static int __init intel_hid_init(void)
 772 {
 773         acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
 774                             ACPI_UINT32_MAX, check_acpi_dev, NULL,
 775                             (void *)intel_hid_ids, NULL);
 776
 777         return platform_driver_register(&intel_hid_pl_driver);
 778 }
 779 module_init(intel_hid_init);
 780
 781 static void __exit intel_hid_exit(void)
 782 {
 783         platform_driver_unregister(&intel_hid_pl_driver);
 784 }
 785 module_exit(intel_hid_exit);