drivers/platform/x86/intel-hid.c

   1 /*
   2  *  Intel HID event & 5 button array driver
   3  *
   4  *  Copyright (C) 2015 Alex Hung <alex.hung@canonical.com>
   5  *  Copyright (C) 2015 Andrew Lutomirski <luto@kernel.org>
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; either version 2 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  */
  18
  19 #include <linux/acpi.h>
  20 #include <linux/dmi.h>
  21 #include <linux/input.h>
  22 #include <linux/input/sparse-keymap.h>
  23 #include <linux/kernel.h>
  24 #include <linux/module.h>
  25 #include <linux/platform_device.h>
  26 #include <linux/suspend.h>
  27
  28 MODULE_LICENSE("GPL");
  29 MODULE_AUTHOR("Alex Hung");
  30
  31 static const struct acpi_device_id intel_hid_ids[] = {
  32         {"INT33D5", 0},
  33         {"", 0},
  34 };
  35
  36 /* In theory, these are HID usages. */
  37 static const struct key_entry intel_hid_keymap[] = {
  38         /* 1: LSuper (Page 0x07, usage 0xE3) -- unclear what to do */
  39         /* 2: Toggle SW_ROTATE_LOCK -- easy to implement if seen in wild */
  40         { KE_KEY, 3, { KEY_NUMLOCK } },
  41         { KE_KEY, 4, { KEY_HOME } },
  42         { KE_KEY, 5, { KEY_END } },
  43         { KE_KEY, 6, { KEY_PAGEUP } },
  44         { KE_KEY, 7, { KEY_PAGEDOWN } },
  45         { KE_KEY, 8, { KEY_RFKILL } },
  46         { KE_KEY, 9, { KEY_POWER } },
  47         { KE_KEY, 11, { KEY_SLEEP } },
  48         /* 13 has two different meanings in the spec -- ignore it. */
  49         { KE_KEY, 14, { KEY_STOPCD } },
  50         { KE_KEY, 15, { KEY_PLAYPAUSE } },
  51         { KE_KEY, 16, { KEY_MUTE } },
  52         { KE_KEY, 17, { KEY_VOLUMEUP } },
  53         { KE_KEY, 18, { KEY_VOLUMEDOWN } },
  54         { KE_KEY, 19, { KEY_BRIGHTNESSUP } },
  55         { KE_KEY, 20, { KEY_BRIGHTNESSDOWN } },
  56         /* 27: wake -- needs special handling */
  57         { KE_END },
  58 };
  59
  60 /* 5 button array notification value. */
  61 static const struct key_entry intel_array_keymap[] = {
  62         { KE_KEY,    0xC2, { KEY_LEFTMETA } },                /* Press */
  63         { KE_IGNORE, 0xC3, { KEY_LEFTMETA } },                /* Release */
  64         { KE_KEY,    0xC4, { KEY_VOLUMEUP } },                /* Press */
  65         { KE_IGNORE, 0xC5, { KEY_VOLUMEUP } },                /* Release */
  66         { KE_KEY,    0xC6, { KEY_VOLUMEDOWN } },              /* Press */
  67         { KE_IGNORE, 0xC7, { KEY_VOLUMEDOWN } },              /* Release */
  68         { KE_KEY,    0xC8, { KEY_ROTATE_LOCK_TOGGLE } },      /* Press */
  69         { KE_IGNORE, 0xC9, { KEY_ROTATE_LOCK_TOGGLE } },      /* Release */
  70         { KE_KEY,    0xCE, { KEY_POWER } },                   /* Press */
  71         { KE_IGNORE, 0xCF, { KEY_POWER } },                   /* Release */
  72         { KE_END },
  73 };
  74
  75 static const struct dmi_system_id button_array_table[] = {
  76         {
  77                 .ident = "Wacom MobileStudio Pro 13",
  78                 .matches = {
  79                         DMI_MATCH(DMI_SYS_VENDOR, "Wacom Co.,Ltd"),
  80                         DMI_MATCH(DMI_PRODUCT_NAME, "Wacom MobileStudio Pro 13"),
  81                 },
  82         },
  83         {
  84                 .ident = "Wacom MobileStudio Pro 16",
  85                 .matches = {
  86                         DMI_MATCH(DMI_SYS_VENDOR, "Wacom Co.,Ltd"),
  87                         DMI_MATCH(DMI_PRODUCT_NAME, "Wacom MobileStudio Pro 16"),
  88                 },
  89         },
  90         {
  91                 .ident = "HP Spectre x2 (2015)",
  92                 .matches = {
  93                         DMI_MATCH(DMI_SYS_VENDOR, "HP"),
  94                         DMI_MATCH(DMI_PRODUCT_NAME, "HP Spectre x2 Detachable"),
  95                 },
  96         },
  97         { }
  98 };
  99
 100 struct intel_hid_priv {
 101         struct input_dev *input_dev;
 102         struct input_dev *array;
 103         bool wakeup_mode;
 104 };
 105
 106 #define HID_EVENT_FILTER_UUID   "eeec56b3-4442-408f-a792-4edd4d758054"
 107
 108 enum intel_hid_dsm_fn_codes {
 109         INTEL_HID_DSM_FN_INVALID,
 110         INTEL_HID_DSM_BTNL_FN,
 111         INTEL_HID_DSM_HDMM_FN,
 112         INTEL_HID_DSM_HDSM_FN,
 113         INTEL_HID_DSM_HDEM_FN,
 114         INTEL_HID_DSM_BTNS_FN,
 115         INTEL_HID_DSM_BTNE_FN,
 116         INTEL_HID_DSM_HEBC_V1_FN,
 117         INTEL_HID_DSM_VGBS_FN,
 118         INTEL_HID_DSM_HEBC_V2_FN,
 119         INTEL_HID_DSM_FN_MAX
 120 };
 121
 122 static const char *intel_hid_dsm_fn_to_method[INTEL_HID_DSM_FN_MAX] = {
 123         NULL,
 124         "BTNL",
 125         "HDMM",
 126         "HDSM",
 127         "HDEM",
 128         "BTNS",
 129         "BTNE",
 130         "HEBC",
 131         "VGBS",
 132         "HEBC"
 133 };
 134
 135 static unsigned long long intel_hid_dsm_fn_mask;
 136 static guid_t intel_dsm_guid;
 137
 138 static bool intel_hid_execute_method(acpi_handle handle,
 139                                      enum intel_hid_dsm_fn_codes fn_index,
 140                                      unsigned long long arg)
 141 {
 142         union acpi_object *obj, argv4, req;
 143         acpi_status status;
 144         char *method_name;
 145
 146         if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
 147             fn_index >= INTEL_HID_DSM_FN_MAX)
 148                 return false;
 149
 150         method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
 151
 152         if (!(intel_hid_dsm_fn_mask & fn_index))
 153                 goto skip_dsm_exec;
 154
 155         /* All methods expects a package with one integer element */
 156         req.type = ACPI_TYPE_INTEGER;
 157         req.integer.value = arg;
 158
 159         argv4.type = ACPI_TYPE_PACKAGE;
 160         argv4.package.count = 1;
 161         argv4.package.elements = &req;
 162
 163         obj = acpi_evaluate_dsm(handle, &intel_dsm_guid, 1, fn_index, &argv4);
 164         if (obj) {
 165                 acpi_handle_debug(handle, "Exec DSM Fn code: %d[%s] success\n",
 166                                   fn_index, method_name);
 167                 ACPI_FREE(obj);
 168                 return true;
 169         }
 170
 171 skip_dsm_exec:
 172         status = acpi_execute_simple_method(handle, method_name, arg);
 173         if (ACPI_SUCCESS(status))
 174                 return true;
 175
 176         return false;
 177 }
 178
 179 static bool intel_hid_evaluate_method(acpi_handle handle,
 180                                       enum intel_hid_dsm_fn_codes fn_index,
 181                                       unsigned long long *result)
 182 {
 183         union acpi_object *obj;
 184         acpi_status status;
 185         char *method_name;
 186
 187         if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
 188             fn_index >= INTEL_HID_DSM_FN_MAX)
 189                 return false;
 190
 191         method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
 192
 193         if (!(intel_hid_dsm_fn_mask & fn_index))
 194                 goto skip_dsm_eval;
 195
 196         obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid,
 197                                       1, fn_index,
 198                                       NULL,  ACPI_TYPE_INTEGER);
 199         if (obj) {
 200                 *result = obj->integer.value;
 201                 acpi_handle_debug(handle,
 202                                   "Eval DSM Fn code: %d[%s] results: 0x%llx\n",
 203                                   fn_index, method_name, *result);
 204                 ACPI_FREE(obj);
 205                 return true;
 206         }
 207
 208 skip_dsm_eval:
 209         status = acpi_evaluate_integer(handle, method_name, NULL, result);
 210         if (ACPI_SUCCESS(status))
 211                 return true;
 212
 213         return false;
 214 }
 215
 216 static void intel_hid_init_dsm(acpi_handle handle)
 217 {
 218         union acpi_object *obj;
 219
 220         guid_parse(HID_EVENT_FILTER_UUID, &intel_dsm_guid);
 221
 222         obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid, 1, 0, NULL,
 223                                       ACPI_TYPE_BUFFER);
 224         if (obj) {
 225                 intel_hid_dsm_fn_mask = *obj->buffer.pointer;
 226                 ACPI_FREE(obj);
 227         }
 228
 229         acpi_handle_debug(handle, "intel_hid_dsm_fn_mask = %llx\n",
 230                           intel_hid_dsm_fn_mask);
 231 }
 232
 233 static int intel_hid_set_enable(struct device *device, bool enable)
 234 {
 235         acpi_handle handle = ACPI_HANDLE(device);
 236
 237         /* Enable|disable features - power button is always enabled */
 238         if (!intel_hid_execute_method(handle, INTEL_HID_DSM_HDSM_FN,
 239                                       enable)) {
 240                 dev_warn(device, "failed to %sable hotkeys\n",
 241                          enable ? "en" : "dis");
 242                 return -EIO;
 243         }
 244
 245         return 0;
 246 }
 247
 248 static void intel_button_array_enable(struct device *device, bool enable)
 249 {
 250         struct intel_hid_priv *priv = dev_get_drvdata(device);
 251         acpi_handle handle = ACPI_HANDLE(device);
 252         unsigned long long button_cap;
 253         acpi_status status;
 254
 255         if (!priv->array)
 256                 return;
 257
 258         /* Query supported platform features */
 259         status = acpi_evaluate_integer(handle, "BTNC", NULL, &button_cap);
 260         if (ACPI_FAILURE(status)) {
 261                 dev_warn(device, "failed to get button capability\n");
 262                 return;
 263         }
 264
 265         /* Enable|disable features - power button is always enabled */
 266         if (!intel_hid_execute_method(handle, INTEL_HID_DSM_BTNE_FN,
 267                                       enable ? button_cap : 1))
 268                 dev_warn(device, "failed to set button capability\n");
 269 }
 270
 271 static int intel_hid_pm_prepare(struct device *device)
 272 {
 273         struct intel_hid_priv *priv = dev_get_drvdata(device);
 274
 275         priv->wakeup_mode = true;
 276         return 0;
 277 }
 278
 279 static int intel_hid_pl_suspend_handler(struct device *device)
 280 {
 281         if (pm_suspend_via_firmware()) {
 282                 intel_hid_set_enable(device, false);
 283                 intel_button_array_enable(device, false);
 284         }
 285         return 0;
 286 }
 287
 288 static int intel_hid_pl_resume_handler(struct device *device)
 289 {
 290         struct intel_hid_priv *priv = dev_get_drvdata(device);
 291
 292         priv->wakeup_mode = false;
 293         if (pm_resume_via_firmware()) {
 294                 intel_hid_set_enable(device, true);
 295                 intel_button_array_enable(device, true);
 296         }
 297         return 0;
 298 }
 299
 300 static const struct dev_pm_ops intel_hid_pl_pm_ops = {
 301         .prepare = intel_hid_pm_prepare,
 302         .freeze  = intel_hid_pl_suspend_handler,
 303         .thaw  = intel_hid_pl_resume_handler,
 304         .restore  = intel_hid_pl_resume_handler,
 305         .suspend  = intel_hid_pl_suspend_handler,
 306         .resume  = intel_hid_pl_resume_handler,
 307 };
 308
 309 static int intel_hid_input_setup(struct platform_device *device)
 310 {
 311         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 312         int ret;
 313
 314         priv->input_dev = devm_input_allocate_device(&device->dev);
 315         if (!priv->input_dev)
 316                 return -ENOMEM;
 317
 318         ret = sparse_keymap_setup(priv->input_dev, intel_hid_keymap, NULL);
 319         if (ret)
 320                 return ret;
 321
 322         priv->input_dev->name = "Intel HID events";
 323         priv->input_dev->id.bustype = BUS_HOST;
 324
 325         return input_register_device(priv->input_dev);
 326 }
 327
 328 static int intel_button_array_input_setup(struct platform_device *device)
 329 {
 330         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 331         int ret;
 332
 333         /* Setup input device for 5 button array */
 334         priv->array = devm_input_allocate_device(&device->dev);
 335         if (!priv->array)
 336                 return -ENOMEM;
 337
 338         ret = sparse_keymap_setup(priv->array, intel_array_keymap, NULL);
 339         if (ret)
 340                 return ret;
 341
 342         priv->array->name = "Intel HID 5 button array";
 343         priv->array->id.bustype = BUS_HOST;
 344
 345         return input_register_device(priv->array);
 346 }
 347
 348 static void notify_handler(acpi_handle handle, u32 event, void *context)
 349 {
 350         struct platform_device *device = context;
 351         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 352         unsigned long long ev_index;
 353
 354         if (priv->wakeup_mode) {
 355                 /*
 356                  * Needed for wakeup from suspend-to-idle to work on some
 357                  * platforms that don't expose the 5-button array, but still
 358                  * send notifies with the power button event code to this
 359                  * device object on power button actions while suspended.
 360                  */
 361                 if (event == 0xce)
 362                         goto wakeup;
 363
 364                 /* Wake up on 5-button array events only. */
 365                 if (event == 0xc0 || !priv->array)
 366                         return;
 367
 368                 if (!sparse_keymap_entry_from_scancode(priv->array, event)) {
 369                         dev_info(&device->dev, "unknown event 0x%x\n", event);
 370                         return;
 371                 }
 372
 373 wakeup:
 374                 pm_wakeup_hard_event(&device->dev);
 375                 return;
 376         }
 377
 378         /*
 379          * Needed for suspend to work on some platforms that don't expose
 380          * the 5-button array, but still send notifies with power button
 381          * event code to this device object on power button actions.
 382          *
 383          * Report the power button press and release.
 384          */
 385         if (!priv->array) {
 386                 if (event == 0xce) {
 387                         input_report_key(priv->input_dev, KEY_POWER, 1);
 388                         input_sync(priv->input_dev);
 389                         return;
 390                 }
 391
 392                 if (event == 0xcf) {
 393                         input_report_key(priv->input_dev, KEY_POWER, 0);
 394                         input_sync(priv->input_dev);
 395                         return;
 396                 }
 397         }
 398
 399         /* 0xC0 is for HID events, other values are for 5 button array */
 400         if (event != 0xc0) {
 401                 if (!priv->array ||
 402                     !sparse_keymap_report_event(priv->array, event, 1, true))
 403                         dev_dbg(&device->dev, "unknown event 0x%x\n", event);
 404                 return;
 405         }
 406
 407         if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDEM_FN,
 408                                        &ev_index)) {
 409                 dev_warn(&device->dev, "failed to get event index\n");
 410                 return;
 411         }
 412
 413         if (!sparse_keymap_report_event(priv->input_dev, ev_index, 1, true))
 414                 dev_dbg(&device->dev, "unknown event index 0x%llx\n",
 415                          ev_index);
 416 }
 417
 418 static bool button_array_present(struct platform_device *device)
 419 {
 420         acpi_handle handle = ACPI_HANDLE(&device->dev);
 421         unsigned long long event_cap;
 422
 423         if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V2_FN,
 424                                       &event_cap)) {
 425                 /* Check presence of 5 button array or v2 power button */
 426                 if (event_cap & 0x60000)
 427                         return true;
 428         }
 429
 430         if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V1_FN,
 431                                       &event_cap)) {
 432                 if (event_cap & 0x20000)
 433                         return true;
 434         }
 435
 436         if (dmi_check_system(button_array_table))
 437                 return true;
 438
 439         return false;
 440 }
 441
 442 static int intel_hid_probe(struct platform_device *device)
 443 {
 444         acpi_handle handle = ACPI_HANDLE(&device->dev);
 445         unsigned long long mode;
 446         struct intel_hid_priv *priv;
 447         acpi_status status;
 448         int err;
 449
 450         intel_hid_init_dsm(handle);
 451
 452         if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDMM_FN, &mode)) {
 453                 dev_warn(&device->dev, "failed to read mode\n");
 454                 return -ENODEV;
 455         }
 456
 457         if (mode != 0) {
 458                 /*
 459                  * This driver only implements "simple" mode.  There appear
 460                  * to be no other modes, but we should be paranoid and check
 461                  * for compatibility.
 462                  */
 463                 dev_info(&device->dev, "platform is not in simple mode\n");
 464                 return -ENODEV;
 465         }
 466
 467         priv = devm_kzalloc(&device->dev, sizeof(*priv), GFP_KERNEL);
 468         if (!priv)
 469                 return -ENOMEM;
 470         dev_set_drvdata(&device->dev, priv);
 471
 472         err = intel_hid_input_setup(device);
 473         if (err) {
 474                 pr_err("Failed to setup Intel HID hotkeys\n");
 475                 return err;
 476         }
 477
 478         /* Setup 5 button array */
 479         if (button_array_present(device)) {
 480                 dev_info(&device->dev, "platform supports 5 button array\n");
 481                 err = intel_button_array_input_setup(device);
 482                 if (err)
 483                         pr_err("Failed to setup Intel 5 button array hotkeys\n");
 484         }
 485
 486         status = acpi_install_notify_handler(handle,
 487                                              ACPI_DEVICE_NOTIFY,
 488                                              notify_handler,
 489                                              device);
 490         if (ACPI_FAILURE(status))
 491                 return -EBUSY;
 492
 493         err = intel_hid_set_enable(&device->dev, true);
 494         if (err)
 495                 goto err_remove_notify;
 496
 497         if (priv->array) {
 498                 unsigned long long dummy;
 499
 500                 intel_button_array_enable(&device->dev, true);
 501
 502                 /* Call button load method to enable HID power button */
 503                 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_BTNL_FN,
 504                                                &dummy)) {
 505                         dev_warn(&device->dev,
 506                                  "failed to enable HID power button\n");
 507                 }
 508         }
 509
 510         device_init_wakeup(&device->dev, true);
 511         return 0;
 512
 513 err_remove_notify:
 514         acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
 515
 516         return err;
 517 }
 518
 519 static int intel_hid_remove(struct platform_device *device)
 520 {
 521         acpi_handle handle = ACPI_HANDLE(&device->dev);
 522
 523         device_init_wakeup(&device->dev, false);
 524         acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
 525         intel_hid_set_enable(&device->dev, false);
 526         intel_button_array_enable(&device->dev, false);
 527
 528         /*
 529          * Even if we failed to shut off the event stream, we can still
 530          * safely detach from the device.
 531          */
 532         return 0;
 533 }
 534
 535 static struct platform_driver intel_hid_pl_driver = {
 536         .driver = {
 537                 .name = "intel-hid",
 538                 .acpi_match_table = intel_hid_ids,
 539                 .pm = &intel_hid_pl_pm_ops,
 540         },
 541         .probe = intel_hid_probe,
 542         .remove = intel_hid_remove,
 543 };
 544 MODULE_DEVICE_TABLE(acpi, intel_hid_ids);
 545
 546 /*
 547  * Unfortunately, some laptops provide a _HID="INT33D5" device with
 548  * _CID="PNP0C02".  This causes the pnpacpi scan driver to claim the
 549  * ACPI node, so no platform device will be created.  The pnpacpi
 550  * driver rejects this device in subsequent processing, so no physical
 551  * node is created at all.
 552  *
 553  * As a workaround until the ACPI core figures out how to handle
 554  * this corner case, manually ask the ACPI platform device code to
 555  * claim the ACPI node.
 556  */
 557 static acpi_status __init
 558 check_acpi_dev(acpi_handle handle, u32 lvl, void *context, void **rv)
 559 {
 560         const struct acpi_device_id *ids = context;
 561         struct acpi_device *dev;
 562
 563         if (acpi_bus_get_device(handle, &dev) != 0)
 564                 return AE_OK;
 565
 566         if (acpi_match_device_ids(dev, ids) == 0)
 567                 if (acpi_create_platform_device(dev, NULL))
 568                         dev_info(&dev->dev,
 569                                  "intel-hid: created platform device\n");
 570
 571         return AE_OK;
 572 }
 573
 574 static int __init intel_hid_init(void)
 575 {
 576         acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
 577                             ACPI_UINT32_MAX, check_acpi_dev, NULL,
 578                             (void *)intel_hid_ids, NULL);
 579
 580         return platform_driver_register(&intel_hid_pl_driver);
 581 }
 582 module_init(intel_hid_init);
 583
 584 static void __exit intel_hid_exit(void)
 585 {
 586         platform_driver_unregister(&intel_hid_pl_driver);
 587 }
 588 module_exit(intel_hid_exit);