1 // SPDX-License-Identifier: GPL-2.0+
3 * Intel Virtual Button driver for Windows 8.1+
5 * Copyright (C) 2016 AceLan Kao <acelan.kao@canonical.com>
6 * Copyright (C) 2016 Alex Hung <alex.hung@canonical.com>
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 /* Returned when NOT in tablet mode on some HP Stream x360 11 models */
19 #define VGBS_TABLET_MODE_FLAG_ALT 0x10
20 /* When NOT in tablet mode, VGBS returns with the flag 0x40 */
21 #define VGBS_TABLET_MODE_FLAG 0x40
22 #define VGBS_DOCK_MODE_FLAG 0x80
24 #define VGBS_TABLET_MODE_FLAGS (VGBS_TABLET_MODE_FLAG | VGBS_TABLET_MODE_FLAG_ALT)
26 MODULE_LICENSE("GPL");
27 MODULE_AUTHOR("AceLan Kao");
29 static const struct acpi_device_id intel_vbtn_ids[] = {
33 MODULE_DEVICE_TABLE(acpi, intel_vbtn_ids);
35 /* In theory, these are HID usages. */
36 static const struct key_entry intel_vbtn_keymap[] = {
37 { KE_KEY, 0xC0, { KEY_POWER } }, /* power key press */
38 { KE_IGNORE, 0xC1, { KEY_POWER } }, /* power key release */
39 { KE_KEY, 0xC2, { KEY_LEFTMETA } }, /* 'Windows' key press */
40 { KE_KEY, 0xC3, { KEY_LEFTMETA } }, /* 'Windows' key release */
41 { KE_KEY, 0xC4, { KEY_VOLUMEUP } }, /* volume-up key press */
42 { KE_IGNORE, 0xC5, { KEY_VOLUMEUP } }, /* volume-up key release */
43 { KE_KEY, 0xC6, { KEY_VOLUMEDOWN } }, /* volume-down key press */
44 { KE_IGNORE, 0xC7, { KEY_VOLUMEDOWN } }, /* volume-down key release */
45 { KE_KEY, 0xC8, { KEY_ROTATE_LOCK_TOGGLE } }, /* rotate-lock key press */
46 { KE_KEY, 0xC9, { KEY_ROTATE_LOCK_TOGGLE } }, /* rotate-lock key release */
50 static const struct key_entry intel_vbtn_switchmap[] = {
52 * SW_DOCK should only be reported for docking stations, but DSDTs using the
53 * intel-vbtn code, always seem to use this for 2-in-1s / convertibles and set
54 * SW_DOCK=1 when in laptop-mode (in tandem with setting SW_TABLET_MODE=0).
55 * This causes userspace to think the laptop is docked to a port-replicator
56 * and to disable suspend-on-lid-close, which is undesirable.
57 * Map the dock events to KEY_IGNORE to avoid this broken SW_DOCK reporting.
59 { KE_IGNORE, 0xCA, { .sw = { SW_DOCK, 1 } } }, /* Docked */
60 { KE_IGNORE, 0xCB, { .sw = { SW_DOCK, 0 } } }, /* Undocked */
61 { KE_SW, 0xCC, { .sw = { SW_TABLET_MODE, 1 } } }, /* Tablet */
62 { KE_SW, 0xCD, { .sw = { SW_TABLET_MODE, 0 } } }, /* Laptop */
66 struct intel_vbtn_priv {
67 struct input_dev *buttons_dev;
68 struct input_dev *switches_dev;
74 static void detect_tablet_mode(struct platform_device *device)
76 struct intel_vbtn_priv *priv = dev_get_drvdata(&device->dev);
77 acpi_handle handle = ACPI_HANDLE(&device->dev);
78 unsigned long long vgbs;
82 status = acpi_evaluate_integer(handle, "VGBS", NULL, &vgbs);
83 if (ACPI_FAILURE(status))
86 m = !(vgbs & VGBS_TABLET_MODE_FLAGS);
87 input_report_switch(priv->switches_dev, SW_TABLET_MODE, m);
88 m = (vgbs & VGBS_DOCK_MODE_FLAG) ? 1 : 0;
89 input_report_switch(priv->switches_dev, SW_DOCK, m);
93 * Note this unconditionally creates the 2 input_dev-s and sets up
94 * the sparse-keymaps. Only the registration is conditional on
95 * have_buttons / have_switches. This is done so that the notify
96 * handler can always call sparse_keymap_entry_from_scancode()
97 * on the input_dev-s do determine the event type.
99 static int intel_vbtn_input_setup(struct platform_device *device)
101 struct intel_vbtn_priv *priv = dev_get_drvdata(&device->dev);
104 priv->buttons_dev = devm_input_allocate_device(&device->dev);
105 if (!priv->buttons_dev)
108 ret = sparse_keymap_setup(priv->buttons_dev, intel_vbtn_keymap, NULL);
112 priv->buttons_dev->dev.parent = &device->dev;
113 priv->buttons_dev->name = "Intel Virtual Buttons";
114 priv->buttons_dev->id.bustype = BUS_HOST;
116 if (priv->has_buttons) {
117 ret = input_register_device(priv->buttons_dev);
122 priv->switches_dev = devm_input_allocate_device(&device->dev);
123 if (!priv->switches_dev)
126 ret = sparse_keymap_setup(priv->switches_dev, intel_vbtn_switchmap, NULL);
130 priv->switches_dev->dev.parent = &device->dev;
131 priv->switches_dev->name = "Intel Virtual Switches";
132 priv->switches_dev->id.bustype = BUS_HOST;
134 if (priv->has_switches) {
135 detect_tablet_mode(device);
137 ret = input_register_device(priv->switches_dev);
145 static void notify_handler(acpi_handle handle, u32 event, void *context)
147 struct platform_device *device = context;
148 struct intel_vbtn_priv *priv = dev_get_drvdata(&device->dev);
149 unsigned int val = !(event & 1); /* Even=press, Odd=release */
150 const struct key_entry *ke, *ke_rel;
151 struct input_dev *input_dev;
155 if ((ke = sparse_keymap_entry_from_scancode(priv->buttons_dev, event))) {
156 if (!priv->has_buttons) {
157 dev_warn(&device->dev, "Warning: received a button event on a device without buttons, please report this.\n");
160 input_dev = priv->buttons_dev;
161 } else if ((ke = sparse_keymap_entry_from_scancode(priv->switches_dev, event))) {
162 if (!priv->has_switches) {
163 dev_info(&device->dev, "Registering Intel Virtual Switches input-dev after receiving a switch event\n");
164 ret = input_register_device(priv->switches_dev);
168 priv->has_switches = true;
170 input_dev = priv->switches_dev;
172 dev_dbg(&device->dev, "unknown event index 0x%x\n", event);
176 if (priv->wakeup_mode) {
177 pm_wakeup_hard_event(&device->dev);
180 * Skip reporting an evdev event for button wake events,
181 * mirroring how the drivers/acpi/button.c code skips this too.
183 if (ke->type == KE_KEY)
188 * Even press events are autorelease if there is no corresponding odd
189 * release event, or if the odd event is KE_IGNORE.
191 ke_rel = sparse_keymap_entry_from_scancode(input_dev, event | 1);
192 autorelease = val && (!ke_rel || ke_rel->type == KE_IGNORE);
194 sparse_keymap_report_event(input_dev, event, val, autorelease);
198 * There are several laptops (non 2-in-1) models out there which support VGBS,
199 * but simply always return 0, which we translate to SW_TABLET_MODE=1. This in
200 * turn causes userspace (libinput) to suppress events from the builtin
201 * keyboard and touchpad, making the laptop essentially unusable.
203 * Since the problem of wrongly reporting SW_TABLET_MODE=1 in combination
204 * with libinput, leads to a non-usable system. Where as OTOH many people will
205 * not even notice when SW_TABLET_MODE is not being reported, a DMI based allow
206 * list is used here. This list mainly matches on the chassis-type of 2-in-1s.
208 * There are also some 2-in-1s which use the intel-vbtn ACPI interface to report
209 * SW_TABLET_MODE with a chassis-type of 8 ("Portable") or 10 ("Notebook"),
210 * these are matched on a per model basis, since many normal laptops with a
211 * possible broken VGBS ACPI-method also use these chassis-types.
213 static const struct dmi_system_id dmi_switches_allow_list[] = {
216 DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "31" /* Convertible */),
221 DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "32" /* Detachable */),
226 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
227 DMI_MATCH(DMI_PRODUCT_NAME, "Venue 11 Pro 7130"),
232 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
233 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion 13 x360 PC"),
238 DMI_MATCH(DMI_SYS_VENDOR, "Acer"),
239 DMI_MATCH(DMI_PRODUCT_NAME, "Switch SA5-271"),
244 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
245 DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 7352"),
248 {} /* Array terminator */
251 static bool intel_vbtn_has_switches(acpi_handle handle)
253 unsigned long long vgbs;
256 if (!dmi_check_system(dmi_switches_allow_list))
259 status = acpi_evaluate_integer(handle, "VGBS", NULL, &vgbs);
260 return ACPI_SUCCESS(status);
263 static int intel_vbtn_probe(struct platform_device *device)
265 acpi_handle handle = ACPI_HANDLE(&device->dev);
266 bool has_buttons, has_switches;
267 struct intel_vbtn_priv *priv;
271 has_buttons = acpi_has_method(handle, "VBDL");
272 has_switches = intel_vbtn_has_switches(handle);
274 if (!has_buttons && !has_switches) {
275 dev_warn(&device->dev, "failed to read Intel Virtual Button driver\n");
279 priv = devm_kzalloc(&device->dev, sizeof(*priv), GFP_KERNEL);
282 dev_set_drvdata(&device->dev, priv);
284 priv->has_buttons = has_buttons;
285 priv->has_switches = has_switches;
287 err = intel_vbtn_input_setup(device);
289 pr_err("Failed to setup Intel Virtual Button\n");
293 status = acpi_install_notify_handler(handle,
297 if (ACPI_FAILURE(status))
301 status = acpi_evaluate_object(handle, "VBDL", NULL, NULL);
302 if (ACPI_FAILURE(status))
303 dev_err(&device->dev, "Error VBDL failed with ACPI status %d\n", status);
306 device_init_wakeup(&device->dev, true);
308 * In order for system wakeup to work, the EC GPE has to be marked as
309 * a wakeup one, so do that here (this setting will persist, but it has
310 * no effect until the wakeup mask is set for the EC GPE).
312 acpi_ec_mark_gpe_for_wake();
316 static int intel_vbtn_remove(struct platform_device *device)
318 acpi_handle handle = ACPI_HANDLE(&device->dev);
320 device_init_wakeup(&device->dev, false);
321 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
324 * Even if we failed to shut off the event stream, we can still
325 * safely detach from the device.
330 static int intel_vbtn_pm_prepare(struct device *dev)
332 if (device_may_wakeup(dev)) {
333 struct intel_vbtn_priv *priv = dev_get_drvdata(dev);
335 priv->wakeup_mode = true;
340 static void intel_vbtn_pm_complete(struct device *dev)
342 struct intel_vbtn_priv *priv = dev_get_drvdata(dev);
344 priv->wakeup_mode = false;
347 static int intel_vbtn_pm_resume(struct device *dev)
349 intel_vbtn_pm_complete(dev);
353 static const struct dev_pm_ops intel_vbtn_pm_ops = {
354 .prepare = intel_vbtn_pm_prepare,
355 .complete = intel_vbtn_pm_complete,
356 .resume = intel_vbtn_pm_resume,
357 .restore = intel_vbtn_pm_resume,
358 .thaw = intel_vbtn_pm_resume,
361 static struct platform_driver intel_vbtn_pl_driver = {
363 .name = "intel-vbtn",
364 .acpi_match_table = intel_vbtn_ids,
365 .pm = &intel_vbtn_pm_ops,
367 .probe = intel_vbtn_probe,
368 .remove = intel_vbtn_remove,
371 static acpi_status __init
372 check_acpi_dev(acpi_handle handle, u32 lvl, void *context, void **rv)
374 const struct acpi_device_id *ids = context;
375 struct acpi_device *dev;
377 if (acpi_bus_get_device(handle, &dev) != 0)
380 if (acpi_match_device_ids(dev, ids) == 0)
381 if (!IS_ERR_OR_NULL(acpi_create_platform_device(dev, NULL)))
383 "intel-vbtn: created platform device\n");
388 static int __init intel_vbtn_init(void)
390 acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
391 ACPI_UINT32_MAX, check_acpi_dev, NULL,
392 (void *)intel_vbtn_ids, NULL);
394 return platform_driver_register(&intel_vbtn_pl_driver);
396 module_init(intel_vbtn_init);
398 static void __exit intel_vbtn_exit(void)
400 platform_driver_unregister(&intel_vbtn_pl_driver);
402 module_exit(intel_vbtn_exit);