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