1 // SPDX-License-Identifier: GPL-2.0+
3 * Intel HID event & 5 button array driver
5 * Copyright (C) 2015 Alex Hung <alex.hung@canonical.com>
6 * Copyright (C) 2015 Andrew Lutomirski <luto@kernel.org>
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>
18 /* When NOT in tablet mode, VGBS returns with the flag 0x40 */
19 #define TABLET_MODE_FLAG BIT(6)
21 MODULE_LICENSE("GPL");
22 MODULE_AUTHOR("Alex Hung");
24 static const struct acpi_device_id intel_hid_ids[] = {
30 MODULE_DEVICE_TABLE(acpi, intel_hid_ids);
32 /* In theory, these are HID usages. */
33 static const struct key_entry intel_hid_keymap[] = {
34 /* 1: LSuper (Page 0x07, usage 0xE3) -- unclear what to do */
35 /* 2: Toggle SW_ROTATE_LOCK -- easy to implement if seen in wild */
36 { KE_KEY, 3, { KEY_NUMLOCK } },
37 { KE_KEY, 4, { KEY_HOME } },
38 { KE_KEY, 5, { KEY_END } },
39 { KE_KEY, 6, { KEY_PAGEUP } },
40 { KE_KEY, 7, { KEY_PAGEDOWN } },
41 { KE_KEY, 8, { KEY_RFKILL } },
42 { KE_KEY, 9, { KEY_POWER } },
43 { KE_KEY, 11, { KEY_SLEEP } },
44 /* 13 has two different meanings in the spec -- ignore it. */
45 { KE_KEY, 14, { KEY_STOPCD } },
46 { KE_KEY, 15, { KEY_PLAYPAUSE } },
47 { KE_KEY, 16, { KEY_MUTE } },
48 { KE_KEY, 17, { KEY_VOLUMEUP } },
49 { KE_KEY, 18, { KEY_VOLUMEDOWN } },
50 { KE_KEY, 19, { KEY_BRIGHTNESSUP } },
51 { KE_KEY, 20, { KEY_BRIGHTNESSDOWN } },
52 /* 27: wake -- needs special handling */
56 /* 5 button array notification value. */
57 static const struct key_entry intel_array_keymap[] = {
58 { KE_KEY, 0xC2, { KEY_LEFTMETA } }, /* Press */
59 { KE_IGNORE, 0xC3, { KEY_LEFTMETA } }, /* Release */
60 { KE_KEY, 0xC4, { KEY_VOLUMEUP } }, /* Press */
61 { KE_IGNORE, 0xC5, { KEY_VOLUMEUP } }, /* Release */
62 { KE_KEY, 0xC6, { KEY_VOLUMEDOWN } }, /* Press */
63 { KE_IGNORE, 0xC7, { KEY_VOLUMEDOWN } }, /* Release */
64 { KE_KEY, 0xC8, { KEY_ROTATE_LOCK_TOGGLE } }, /* Press */
65 { KE_IGNORE, 0xC9, { KEY_ROTATE_LOCK_TOGGLE } }, /* Release */
66 { KE_KEY, 0xCE, { KEY_POWER } }, /* Press */
67 { KE_IGNORE, 0xCF, { KEY_POWER } }, /* Release */
71 static const struct dmi_system_id button_array_table[] = {
73 .ident = "Wacom MobileStudio Pro 13",
75 DMI_MATCH(DMI_SYS_VENDOR, "Wacom Co.,Ltd"),
76 DMI_MATCH(DMI_PRODUCT_NAME, "Wacom MobileStudio Pro 13"),
80 .ident = "Wacom MobileStudio Pro 16",
82 DMI_MATCH(DMI_SYS_VENDOR, "Wacom Co.,Ltd"),
83 DMI_MATCH(DMI_PRODUCT_NAME, "Wacom MobileStudio Pro 16"),
87 .ident = "HP Spectre x2 (2015)",
89 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
90 DMI_MATCH(DMI_PRODUCT_NAME, "HP Spectre x2 Detachable"),
94 .ident = "Lenovo ThinkPad X1 Tablet Gen 2",
96 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
97 DMI_MATCH(DMI_PRODUCT_FAMILY, "ThinkPad X1 Tablet Gen 2"),
104 * Some convertible use the intel-hid ACPI interface to report SW_TABLET_MODE,
105 * these need to be compared via a DMI based authorization list because some
106 * models have unreliable VGBS return which could cause incorrect
107 * SW_TABLET_MODE report.
109 static const struct dmi_system_id dmi_vgbs_allow_list[] = {
112 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
113 DMI_MATCH(DMI_PRODUCT_NAME, "HP Spectre x360 Convertible 15-df0xxx"),
119 struct intel_hid_priv {
120 struct input_dev *input_dev;
121 struct input_dev *array;
122 struct input_dev *switches;
126 #define HID_EVENT_FILTER_UUID "eeec56b3-4442-408f-a792-4edd4d758054"
128 enum intel_hid_dsm_fn_codes {
129 INTEL_HID_DSM_FN_INVALID,
130 INTEL_HID_DSM_BTNL_FN,
131 INTEL_HID_DSM_HDMM_FN,
132 INTEL_HID_DSM_HDSM_FN,
133 INTEL_HID_DSM_HDEM_FN,
134 INTEL_HID_DSM_BTNS_FN,
135 INTEL_HID_DSM_BTNE_FN,
136 INTEL_HID_DSM_HEBC_V1_FN,
137 INTEL_HID_DSM_VGBS_FN,
138 INTEL_HID_DSM_HEBC_V2_FN,
142 static const char *intel_hid_dsm_fn_to_method[INTEL_HID_DSM_FN_MAX] = {
155 static unsigned long long intel_hid_dsm_fn_mask;
156 static guid_t intel_dsm_guid;
158 static bool intel_hid_execute_method(acpi_handle handle,
159 enum intel_hid_dsm_fn_codes fn_index,
160 unsigned long long arg)
162 union acpi_object *obj, argv4, req;
166 if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
167 fn_index >= INTEL_HID_DSM_FN_MAX)
170 method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
172 if (!(intel_hid_dsm_fn_mask & BIT(fn_index)))
175 /* All methods expects a package with one integer element */
176 req.type = ACPI_TYPE_INTEGER;
177 req.integer.value = arg;
179 argv4.type = ACPI_TYPE_PACKAGE;
180 argv4.package.count = 1;
181 argv4.package.elements = &req;
183 obj = acpi_evaluate_dsm(handle, &intel_dsm_guid, 1, fn_index, &argv4);
185 acpi_handle_debug(handle, "Exec DSM Fn code: %d[%s] success\n",
186 fn_index, method_name);
192 status = acpi_execute_simple_method(handle, method_name, arg);
193 if (ACPI_SUCCESS(status))
199 static bool intel_hid_evaluate_method(acpi_handle handle,
200 enum intel_hid_dsm_fn_codes fn_index,
201 unsigned long long *result)
203 union acpi_object *obj;
207 if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
208 fn_index >= INTEL_HID_DSM_FN_MAX)
211 method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
213 if (!(intel_hid_dsm_fn_mask & fn_index))
216 obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid,
218 NULL, ACPI_TYPE_INTEGER);
220 *result = obj->integer.value;
221 acpi_handle_debug(handle,
222 "Eval DSM Fn code: %d[%s] results: 0x%llx\n",
223 fn_index, method_name, *result);
229 status = acpi_evaluate_integer(handle, method_name, NULL, result);
230 if (ACPI_SUCCESS(status))
236 static void intel_hid_init_dsm(acpi_handle handle)
238 union acpi_object *obj;
240 guid_parse(HID_EVENT_FILTER_UUID, &intel_dsm_guid);
242 obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid, 1, 0, NULL,
245 switch (obj->buffer.length) {
248 intel_hid_dsm_fn_mask = *(u16 *)obj->buffer.pointer;
251 intel_hid_dsm_fn_mask = *obj->buffer.pointer;
254 acpi_handle_warn(handle, "intel_hid_dsm_fn_mask length is zero\n");
255 intel_hid_dsm_fn_mask = 0;
261 acpi_handle_debug(handle, "intel_hid_dsm_fn_mask = %llx\n",
262 intel_hid_dsm_fn_mask);
265 static int intel_hid_set_enable(struct device *device, bool enable)
267 acpi_handle handle = ACPI_HANDLE(device);
269 /* Enable|disable features - power button is always enabled */
270 if (!intel_hid_execute_method(handle, INTEL_HID_DSM_HDSM_FN,
272 dev_warn(device, "failed to %sable hotkeys\n",
273 enable ? "en" : "dis");
280 static void intel_button_array_enable(struct device *device, bool enable)
282 struct intel_hid_priv *priv = dev_get_drvdata(device);
283 acpi_handle handle = ACPI_HANDLE(device);
284 unsigned long long button_cap;
290 /* Query supported platform features */
291 status = acpi_evaluate_integer(handle, "BTNC", NULL, &button_cap);
292 if (ACPI_FAILURE(status)) {
293 dev_warn(device, "failed to get button capability\n");
297 /* Enable|disable features - power button is always enabled */
298 if (!intel_hid_execute_method(handle, INTEL_HID_DSM_BTNE_FN,
299 enable ? button_cap : 1))
300 dev_warn(device, "failed to set button capability\n");
303 static int intel_hid_pm_prepare(struct device *device)
305 if (device_may_wakeup(device)) {
306 struct intel_hid_priv *priv = dev_get_drvdata(device);
308 priv->wakeup_mode = true;
313 static void intel_hid_pm_complete(struct device *device)
315 struct intel_hid_priv *priv = dev_get_drvdata(device);
317 priv->wakeup_mode = false;
320 static int intel_hid_pl_suspend_handler(struct device *device)
322 intel_button_array_enable(device, false);
324 if (!pm_suspend_no_platform())
325 intel_hid_set_enable(device, false);
330 static int intel_hid_pl_resume_handler(struct device *device)
332 intel_hid_pm_complete(device);
334 if (!pm_suspend_no_platform())
335 intel_hid_set_enable(device, true);
337 intel_button_array_enable(device, true);
341 static const struct dev_pm_ops intel_hid_pl_pm_ops = {
342 .prepare = intel_hid_pm_prepare,
343 .complete = intel_hid_pm_complete,
344 .freeze = intel_hid_pl_suspend_handler,
345 .thaw = intel_hid_pl_resume_handler,
346 .restore = intel_hid_pl_resume_handler,
347 .suspend = intel_hid_pl_suspend_handler,
348 .resume = intel_hid_pl_resume_handler,
351 static int intel_hid_input_setup(struct platform_device *device)
353 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
356 priv->input_dev = devm_input_allocate_device(&device->dev);
357 if (!priv->input_dev)
360 ret = sparse_keymap_setup(priv->input_dev, intel_hid_keymap, NULL);
364 priv->input_dev->name = "Intel HID events";
365 priv->input_dev->id.bustype = BUS_HOST;
367 return input_register_device(priv->input_dev);
370 static int intel_button_array_input_setup(struct platform_device *device)
372 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
375 /* Setup input device for 5 button array */
376 priv->array = devm_input_allocate_device(&device->dev);
380 ret = sparse_keymap_setup(priv->array, intel_array_keymap, NULL);
384 priv->array->name = "Intel HID 5 button array";
385 priv->array->id.bustype = BUS_HOST;
387 return input_register_device(priv->array);
390 static int intel_hid_switches_setup(struct platform_device *device)
392 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
394 /* Setup input device for switches */
395 priv->switches = devm_input_allocate_device(&device->dev);
399 __set_bit(EV_SW, priv->switches->evbit);
400 __set_bit(SW_TABLET_MODE, priv->switches->swbit);
402 priv->switches->name = "Intel HID switches";
403 priv->switches->id.bustype = BUS_HOST;
404 return input_register_device(priv->switches);
407 static void report_tablet_mode_state(struct platform_device *device)
409 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
410 acpi_handle handle = ACPI_HANDLE(&device->dev);
411 unsigned long long vgbs;
414 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_VGBS_FN, &vgbs))
417 m = !(vgbs & TABLET_MODE_FLAG);
418 input_report_switch(priv->switches, SW_TABLET_MODE, m);
419 input_sync(priv->switches);
422 static bool report_tablet_mode_event(struct input_dev *input_dev, u32 event)
429 input_report_switch(input_dev, SW_TABLET_MODE, 1);
430 input_sync(input_dev);
433 input_report_switch(input_dev, SW_TABLET_MODE, 0);
434 input_sync(input_dev);
441 static void notify_handler(acpi_handle handle, u32 event, void *context)
443 struct platform_device *device = context;
444 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
445 unsigned long long ev_index;
449 * Some convertible have unreliable VGBS return which could cause incorrect
450 * SW_TABLET_MODE report, in these cases we enable support when receiving
451 * the first event instead of during driver setup.
453 * Some 360 degree hinges (yoga) style 2-in-1 devices use 2 accelerometers
454 * to allow the OS to determine the angle between the display and the base
455 * of the device. On Windows these are read by a special HingeAngleService
456 * process which calls an ACPI DSM (Device Specific Method) on the
457 * ACPI KIOX010A device node for the sensor in the display, to let the
458 * firmware know if the 2-in-1 is in tablet- or laptop-mode so that it can
459 * disable the kbd and touchpad to avoid spurious input in tablet-mode.
461 * The linux kxcjk1013 driver calls the DSM for this once at probe time
462 * to ensure that the builtin kbd and touchpad work. On some devices this
463 * causes a "spurious" 0xcd event on the intel-hid ACPI dev. In this case
464 * there is not a functional tablet-mode switch, so we should not register
465 * the tablet-mode switch device.
467 if (!priv->switches && (event == 0xcc || event == 0xcd) &&
468 !acpi_dev_present("KIOX010A", NULL, -1)) {
469 dev_info(&device->dev, "switch event received, enable switches supports\n");
470 err = intel_hid_switches_setup(device);
472 pr_err("Failed to setup Intel HID switches\n");
475 if (priv->wakeup_mode) {
477 * Needed for wakeup from suspend-to-idle to work on some
478 * platforms that don't expose the 5-button array, but still
479 * send notifies with the power button event code to this
480 * device object on power button actions while suspended.
486 * Some devices send (duplicate) tablet-mode events when moved
487 * around even though the mode has not changed; and they do this
488 * even when suspended.
489 * Update the switch state in case it changed and then return
490 * without waking up to avoid spurious wakeups.
492 if (event == 0xcc || event == 0xcd) {
493 report_tablet_mode_event(priv->switches, event);
497 /* Wake up on 5-button array events only. */
498 if (event == 0xc0 || !priv->array)
501 if (!sparse_keymap_entry_from_scancode(priv->array, event)) {
502 dev_info(&device->dev, "unknown event 0x%x\n", event);
507 pm_wakeup_hard_event(&device->dev);
513 * Needed for suspend to work on some platforms that don't expose
514 * the 5-button array, but still send notifies with power button
515 * event code to this device object on power button actions.
517 * Report the power button press and release.
521 input_report_key(priv->input_dev, KEY_POWER, 1);
522 input_sync(priv->input_dev);
527 input_report_key(priv->input_dev, KEY_POWER, 0);
528 input_sync(priv->input_dev);
533 if (report_tablet_mode_event(priv->switches, event))
536 /* 0xC0 is for HID events, other values are for 5 button array */
539 !sparse_keymap_report_event(priv->array, event, 1, true))
540 dev_dbg(&device->dev, "unknown event 0x%x\n", event);
544 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDEM_FN,
546 dev_warn(&device->dev, "failed to get event index\n");
550 if (!sparse_keymap_report_event(priv->input_dev, ev_index, 1, true))
551 dev_dbg(&device->dev, "unknown event index 0x%llx\n",
555 static bool button_array_present(struct platform_device *device)
557 acpi_handle handle = ACPI_HANDLE(&device->dev);
558 unsigned long long event_cap;
560 if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V2_FN,
562 /* Check presence of 5 button array or v2 power button */
563 if (event_cap & 0x60000)
567 if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V1_FN,
569 if (event_cap & 0x20000)
573 if (dmi_check_system(button_array_table))
579 static int intel_hid_probe(struct platform_device *device)
581 acpi_handle handle = ACPI_HANDLE(&device->dev);
582 unsigned long long mode;
583 struct intel_hid_priv *priv;
587 intel_hid_init_dsm(handle);
589 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDMM_FN, &mode)) {
590 dev_warn(&device->dev, "failed to read mode\n");
596 * This driver only implements "simple" mode. There appear
597 * to be no other modes, but we should be paranoid and check
600 dev_info(&device->dev, "platform is not in simple mode\n");
604 priv = devm_kzalloc(&device->dev, sizeof(*priv), GFP_KERNEL);
607 dev_set_drvdata(&device->dev, priv);
609 err = intel_hid_input_setup(device);
611 pr_err("Failed to setup Intel HID hotkeys\n");
615 /* Setup 5 button array */
616 if (button_array_present(device)) {
617 dev_info(&device->dev, "platform supports 5 button array\n");
618 err = intel_button_array_input_setup(device);
620 pr_err("Failed to setup Intel 5 button array hotkeys\n");
623 /* Setup switches for devices that we know VGBS return correctly */
624 if (dmi_check_system(dmi_vgbs_allow_list)) {
625 dev_info(&device->dev, "platform supports switches\n");
626 err = intel_hid_switches_setup(device);
628 pr_err("Failed to setup Intel HID switches\n");
630 report_tablet_mode_state(device);
633 status = acpi_install_notify_handler(handle,
637 if (ACPI_FAILURE(status))
640 err = intel_hid_set_enable(&device->dev, true);
642 goto err_remove_notify;
645 unsigned long long dummy;
647 intel_button_array_enable(&device->dev, true);
649 /* Call button load method to enable HID power button */
650 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_BTNL_FN,
652 dev_warn(&device->dev,
653 "failed to enable HID power button\n");
657 device_init_wakeup(&device->dev, true);
659 * In order for system wakeup to work, the EC GPE has to be marked as
660 * a wakeup one, so do that here (this setting will persist, but it has
661 * no effect until the wakeup mask is set for the EC GPE).
663 acpi_ec_mark_gpe_for_wake();
667 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
672 static int intel_hid_remove(struct platform_device *device)
674 acpi_handle handle = ACPI_HANDLE(&device->dev);
676 device_init_wakeup(&device->dev, false);
677 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
678 intel_hid_set_enable(&device->dev, false);
679 intel_button_array_enable(&device->dev, false);
682 * Even if we failed to shut off the event stream, we can still
683 * safely detach from the device.
688 static struct platform_driver intel_hid_pl_driver = {
691 .acpi_match_table = intel_hid_ids,
692 .pm = &intel_hid_pl_pm_ops,
694 .probe = intel_hid_probe,
695 .remove = intel_hid_remove,
699 * Unfortunately, some laptops provide a _HID="INT33D5" device with
700 * _CID="PNP0C02". This causes the pnpacpi scan driver to claim the
701 * ACPI node, so no platform device will be created. The pnpacpi
702 * driver rejects this device in subsequent processing, so no physical
703 * node is created at all.
705 * As a workaround until the ACPI core figures out how to handle
706 * this corner case, manually ask the ACPI platform device code to
707 * claim the ACPI node.
709 static acpi_status __init
710 check_acpi_dev(acpi_handle handle, u32 lvl, void *context, void **rv)
712 const struct acpi_device_id *ids = context;
713 struct acpi_device *dev;
715 if (acpi_bus_get_device(handle, &dev) != 0)
718 if (acpi_match_device_ids(dev, ids) == 0)
719 if (!IS_ERR_OR_NULL(acpi_create_platform_device(dev, NULL)))
721 "intel-hid: created platform device\n");
726 static int __init intel_hid_init(void)
728 acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
729 ACPI_UINT32_MAX, check_acpi_dev, NULL,
730 (void *)intel_hid_ids, NULL);
732 return platform_driver_register(&intel_hid_pl_driver);
734 module_init(intel_hid_init);
736 static void __exit intel_hid_exit(void)
738 platform_driver_unregister(&intel_hid_pl_driver);
740 module_exit(intel_hid_exit);