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