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 .ident = "HP Spectre x2 (2015)",
84 .matches = {
85 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
86 DMI_MATCH(DMI_PRODUCT_NAME, "HP Spectre x2 Detachable"),
87 },
88 },
89 {
90 .ident = "Lenovo ThinkPad X1 Tablet Gen 2",
91 .matches = {
92 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
93 DMI_MATCH(DMI_PRODUCT_FAMILY, "ThinkPad X1 Tablet Gen 2"),
94 },
95 },
96 { }
97 };
98
99 struct intel_hid_priv {
100 struct input_dev *input_dev;
101 struct input_dev *array;
102 bool wakeup_mode;
103 };
104
105 #define HID_EVENT_FILTER_UUID "eeec56b3-4442-408f-a792-4edd4d758054"
106
107 enum intel_hid_dsm_fn_codes {
108 INTEL_HID_DSM_FN_INVALID,
109 INTEL_HID_DSM_BTNL_FN,
110 INTEL_HID_DSM_HDMM_FN,
111 INTEL_HID_DSM_HDSM_FN,
112 INTEL_HID_DSM_HDEM_FN,
113 INTEL_HID_DSM_BTNS_FN,
114 INTEL_HID_DSM_BTNE_FN,
115 INTEL_HID_DSM_HEBC_V1_FN,
116 INTEL_HID_DSM_VGBS_FN,
117 INTEL_HID_DSM_HEBC_V2_FN,
118 INTEL_HID_DSM_FN_MAX
119 };
120
121 static const char *intel_hid_dsm_fn_to_method[INTEL_HID_DSM_FN_MAX] = {
122 NULL,
123 "BTNL",
124 "HDMM",
125 "HDSM",
126 "HDEM",
127 "BTNS",
128 "BTNE",
129 "HEBC",
130 "VGBS",
131 "HEBC"
132 };
133
134 static unsigned long long intel_hid_dsm_fn_mask;
135 static guid_t intel_dsm_guid;
136
intel_hid_execute_method(acpi_handle handle,enum intel_hid_dsm_fn_codes fn_index,unsigned long long arg)137 static bool intel_hid_execute_method(acpi_handle handle,
138 enum intel_hid_dsm_fn_codes fn_index,
139 unsigned long long arg)
140 {
141 union acpi_object *obj, argv4, req;
142 acpi_status status;
143 char *method_name;
144
145 if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
146 fn_index >= INTEL_HID_DSM_FN_MAX)
147 return false;
148
149 method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
150
151 if (!(intel_hid_dsm_fn_mask & fn_index))
152 goto skip_dsm_exec;
153
154 /* All methods expects a package with one integer element */
155 req.type = ACPI_TYPE_INTEGER;
156 req.integer.value = arg;
157
158 argv4.type = ACPI_TYPE_PACKAGE;
159 argv4.package.count = 1;
160 argv4.package.elements = &req;
161
162 obj = acpi_evaluate_dsm(handle, &intel_dsm_guid, 1, fn_index, &argv4);
163 if (obj) {
164 acpi_handle_debug(handle, "Exec DSM Fn code: %d[%s] success\n",
165 fn_index, method_name);
166 ACPI_FREE(obj);
167 return true;
168 }
169
170 skip_dsm_exec:
171 status = acpi_execute_simple_method(handle, method_name, arg);
172 if (ACPI_SUCCESS(status))
173 return true;
174
175 return false;
176 }
177
intel_hid_evaluate_method(acpi_handle handle,enum intel_hid_dsm_fn_codes fn_index,unsigned long long * result)178 static bool intel_hid_evaluate_method(acpi_handle handle,
179 enum intel_hid_dsm_fn_codes fn_index,
180 unsigned long long *result)
181 {
182 union acpi_object *obj;
183 acpi_status status;
184 char *method_name;
185
186 if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
187 fn_index >= INTEL_HID_DSM_FN_MAX)
188 return false;
189
190 method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
191
192 if (!(intel_hid_dsm_fn_mask & fn_index))
193 goto skip_dsm_eval;
194
195 obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid,
196 1, fn_index,
197 NULL, ACPI_TYPE_INTEGER);
198 if (obj) {
199 *result = obj->integer.value;
200 acpi_handle_debug(handle,
201 "Eval DSM Fn code: %d[%s] results: 0x%llx\n",
202 fn_index, method_name, *result);
203 ACPI_FREE(obj);
204 return true;
205 }
206
207 skip_dsm_eval:
208 status = acpi_evaluate_integer(handle, method_name, NULL, result);
209 if (ACPI_SUCCESS(status))
210 return true;
211
212 return false;
213 }
214
intel_hid_init_dsm(acpi_handle handle)215 static void intel_hid_init_dsm(acpi_handle handle)
216 {
217 union acpi_object *obj;
218
219 guid_parse(HID_EVENT_FILTER_UUID, &intel_dsm_guid);
220
221 obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid, 1, 0, NULL,
222 ACPI_TYPE_BUFFER);
223 if (obj) {
224 intel_hid_dsm_fn_mask = *obj->buffer.pointer;
225 ACPI_FREE(obj);
226 }
227
228 acpi_handle_debug(handle, "intel_hid_dsm_fn_mask = %llx\n",
229 intel_hid_dsm_fn_mask);
230 }
231
intel_hid_set_enable(struct device * device,bool enable)232 static int intel_hid_set_enable(struct device *device, bool enable)
233 {
234 acpi_handle handle = ACPI_HANDLE(device);
235
236 /* Enable|disable features - power button is always enabled */
237 if (!intel_hid_execute_method(handle, INTEL_HID_DSM_HDSM_FN,
238 enable)) {
239 dev_warn(device, "failed to %sable hotkeys\n",
240 enable ? "en" : "dis");
241 return -EIO;
242 }
243
244 return 0;
245 }
246
intel_button_array_enable(struct device * device,bool enable)247 static void intel_button_array_enable(struct device *device, bool enable)
248 {
249 struct intel_hid_priv *priv = dev_get_drvdata(device);
250 acpi_handle handle = ACPI_HANDLE(device);
251 unsigned long long button_cap;
252 acpi_status status;
253
254 if (!priv->array)
255 return;
256
257 /* Query supported platform features */
258 status = acpi_evaluate_integer(handle, "BTNC", NULL, &button_cap);
259 if (ACPI_FAILURE(status)) {
260 dev_warn(device, "failed to get button capability\n");
261 return;
262 }
263
264 /* Enable|disable features - power button is always enabled */
265 if (!intel_hid_execute_method(handle, INTEL_HID_DSM_BTNE_FN,
266 enable ? button_cap : 1))
267 dev_warn(device, "failed to set button capability\n");
268 }
269
intel_hid_pm_prepare(struct device * device)270 static int intel_hid_pm_prepare(struct device *device)
271 {
272 if (device_may_wakeup(device)) {
273 struct intel_hid_priv *priv = dev_get_drvdata(device);
274
275 priv->wakeup_mode = true;
276 }
277 return 0;
278 }
279
intel_hid_pm_complete(struct device * device)280 static void intel_hid_pm_complete(struct device *device)
281 {
282 struct intel_hid_priv *priv = dev_get_drvdata(device);
283
284 priv->wakeup_mode = false;
285 }
286
intel_hid_pl_suspend_handler(struct device * device)287 static int intel_hid_pl_suspend_handler(struct device *device)
288 {
289 intel_button_array_enable(device, false);
290
291 if (!pm_suspend_no_platform())
292 intel_hid_set_enable(device, false);
293
294 return 0;
295 }
296
intel_hid_pl_resume_handler(struct device * device)297 static int intel_hid_pl_resume_handler(struct device *device)
298 {
299 intel_hid_pm_complete(device);
300
301 if (!pm_suspend_no_platform())
302 intel_hid_set_enable(device, true);
303
304 intel_button_array_enable(device, true);
305 return 0;
306 }
307
308 static const struct dev_pm_ops intel_hid_pl_pm_ops = {
309 .prepare = intel_hid_pm_prepare,
310 .complete = intel_hid_pm_complete,
311 .freeze = intel_hid_pl_suspend_handler,
312 .thaw = intel_hid_pl_resume_handler,
313 .restore = intel_hid_pl_resume_handler,
314 .suspend = intel_hid_pl_suspend_handler,
315 .resume = intel_hid_pl_resume_handler,
316 };
317
intel_hid_input_setup(struct platform_device * device)318 static int intel_hid_input_setup(struct platform_device *device)
319 {
320 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
321 int ret;
322
323 priv->input_dev = devm_input_allocate_device(&device->dev);
324 if (!priv->input_dev)
325 return -ENOMEM;
326
327 ret = sparse_keymap_setup(priv->input_dev, intel_hid_keymap, NULL);
328 if (ret)
329 return ret;
330
331 priv->input_dev->name = "Intel HID events";
332 priv->input_dev->id.bustype = BUS_HOST;
333
334 return input_register_device(priv->input_dev);
335 }
336
intel_button_array_input_setup(struct platform_device * device)337 static int intel_button_array_input_setup(struct platform_device *device)
338 {
339 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
340 int ret;
341
342 /* Setup input device for 5 button array */
343 priv->array = devm_input_allocate_device(&device->dev);
344 if (!priv->array)
345 return -ENOMEM;
346
347 ret = sparse_keymap_setup(priv->array, intel_array_keymap, NULL);
348 if (ret)
349 return ret;
350
351 priv->array->name = "Intel HID 5 button array";
352 priv->array->id.bustype = BUS_HOST;
353
354 return input_register_device(priv->array);
355 }
356
notify_handler(acpi_handle handle,u32 event,void * context)357 static void notify_handler(acpi_handle handle, u32 event, void *context)
358 {
359 struct platform_device *device = context;
360 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
361 unsigned long long ev_index;
362
363 if (priv->wakeup_mode) {
364 /*
365 * Needed for wakeup from suspend-to-idle to work on some
366 * platforms that don't expose the 5-button array, but still
367 * send notifies with the power button event code to this
368 * device object on power button actions while suspended.
369 */
370 if (event == 0xce)
371 goto wakeup;
372
373 /* Wake up on 5-button array events only. */
374 if (event == 0xc0 || !priv->array)
375 return;
376
377 if (!sparse_keymap_entry_from_scancode(priv->array, event)) {
378 dev_info(&device->dev, "unknown event 0x%x\n", event);
379 return;
380 }
381
382 wakeup:
383 pm_wakeup_hard_event(&device->dev);
384 return;
385 }
386
387 /*
388 * Needed for suspend to work on some platforms that don't expose
389 * the 5-button array, but still send notifies with power button
390 * event code to this device object on power button actions.
391 *
392 * Report the power button press and release.
393 */
394 if (!priv->array) {
395 if (event == 0xce) {
396 input_report_key(priv->input_dev, KEY_POWER, 1);
397 input_sync(priv->input_dev);
398 return;
399 }
400
401 if (event == 0xcf) {
402 input_report_key(priv->input_dev, KEY_POWER, 0);
403 input_sync(priv->input_dev);
404 return;
405 }
406 }
407
408 /* 0xC0 is for HID events, other values are for 5 button array */
409 if (event != 0xc0) {
410 if (!priv->array ||
411 !sparse_keymap_report_event(priv->array, event, 1, true))
412 dev_dbg(&device->dev, "unknown event 0x%x\n", event);
413 return;
414 }
415
416 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDEM_FN,
417 &ev_index)) {
418 dev_warn(&device->dev, "failed to get event index\n");
419 return;
420 }
421
422 if (!sparse_keymap_report_event(priv->input_dev, ev_index, 1, true))
423 dev_dbg(&device->dev, "unknown event index 0x%llx\n",
424 ev_index);
425 }
426
button_array_present(struct platform_device * device)427 static bool button_array_present(struct platform_device *device)
428 {
429 acpi_handle handle = ACPI_HANDLE(&device->dev);
430 unsigned long long event_cap;
431
432 if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V2_FN,
433 &event_cap)) {
434 /* Check presence of 5 button array or v2 power button */
435 if (event_cap & 0x60000)
436 return true;
437 }
438
439 if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V1_FN,
440 &event_cap)) {
441 if (event_cap & 0x20000)
442 return true;
443 }
444
445 if (dmi_check_system(button_array_table))
446 return true;
447
448 return false;
449 }
450
intel_hid_probe(struct platform_device * device)451 static int intel_hid_probe(struct platform_device *device)
452 {
453 acpi_handle handle = ACPI_HANDLE(&device->dev);
454 unsigned long long mode;
455 struct intel_hid_priv *priv;
456 acpi_status status;
457 int err;
458
459 intel_hid_init_dsm(handle);
460
461 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDMM_FN, &mode)) {
462 dev_warn(&device->dev, "failed to read mode\n");
463 return -ENODEV;
464 }
465
466 if (mode != 0) {
467 /*
468 * This driver only implements "simple" mode. There appear
469 * to be no other modes, but we should be paranoid and check
470 * for compatibility.
471 */
472 dev_info(&device->dev, "platform is not in simple mode\n");
473 return -ENODEV;
474 }
475
476 priv = devm_kzalloc(&device->dev, sizeof(*priv), GFP_KERNEL);
477 if (!priv)
478 return -ENOMEM;
479 dev_set_drvdata(&device->dev, priv);
480
481 err = intel_hid_input_setup(device);
482 if (err) {
483 pr_err("Failed to setup Intel HID hotkeys\n");
484 return err;
485 }
486
487 /* Setup 5 button array */
488 if (button_array_present(device)) {
489 dev_info(&device->dev, "platform supports 5 button array\n");
490 err = intel_button_array_input_setup(device);
491 if (err)
492 pr_err("Failed to setup Intel 5 button array hotkeys\n");
493 }
494
495 status = acpi_install_notify_handler(handle,
496 ACPI_DEVICE_NOTIFY,
497 notify_handler,
498 device);
499 if (ACPI_FAILURE(status))
500 return -EBUSY;
501
502 err = intel_hid_set_enable(&device->dev, true);
503 if (err)
504 goto err_remove_notify;
505
506 if (priv->array) {
507 unsigned long long dummy;
508
509 intel_button_array_enable(&device->dev, true);
510
511 /* Call button load method to enable HID power button */
512 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_BTNL_FN,
513 &dummy)) {
514 dev_warn(&device->dev,
515 "failed to enable HID power button\n");
516 }
517 }
518
519 device_init_wakeup(&device->dev, true);
520 /*
521 * In order for system wakeup to work, the EC GPE has to be marked as
522 * a wakeup one, so do that here (this setting will persist, but it has
523 * no effect until the wakeup mask is set for the EC GPE).
524 */
525 acpi_ec_mark_gpe_for_wake();
526 return 0;
527
528 err_remove_notify:
529 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
530
531 return err;
532 }
533
intel_hid_remove(struct platform_device * device)534 static int intel_hid_remove(struct platform_device *device)
535 {
536 acpi_handle handle = ACPI_HANDLE(&device->dev);
537
538 device_init_wakeup(&device->dev, false);
539 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
540 intel_hid_set_enable(&device->dev, false);
541 intel_button_array_enable(&device->dev, false);
542
543 /*
544 * Even if we failed to shut off the event stream, we can still
545 * safely detach from the device.
546 */
547 return 0;
548 }
549
550 static struct platform_driver intel_hid_pl_driver = {
551 .driver = {
552 .name = "intel-hid",
553 .acpi_match_table = intel_hid_ids,
554 .pm = &intel_hid_pl_pm_ops,
555 },
556 .probe = intel_hid_probe,
557 .remove = intel_hid_remove,
558 };
559
560 /*
561 * Unfortunately, some laptops provide a _HID="INT33D5" device with
562 * _CID="PNP0C02". This causes the pnpacpi scan driver to claim the
563 * ACPI node, so no platform device will be created. The pnpacpi
564 * driver rejects this device in subsequent processing, so no physical
565 * node is created at all.
566 *
567 * As a workaround until the ACPI core figures out how to handle
568 * this corner case, manually ask the ACPI platform device code to
569 * claim the ACPI node.
570 */
571 static acpi_status __init
check_acpi_dev(acpi_handle handle,u32 lvl,void * context,void ** rv)572 check_acpi_dev(acpi_handle handle, u32 lvl, void *context, void **rv)
573 {
574 const struct acpi_device_id *ids = context;
575 struct acpi_device *dev;
576
577 if (acpi_bus_get_device(handle, &dev) != 0)
578 return AE_OK;
579
580 if (acpi_match_device_ids(dev, ids) == 0)
581 if (!IS_ERR_OR_NULL(acpi_create_platform_device(dev, NULL)))
582 dev_info(&dev->dev,
583 "intel-hid: created platform device\n");
584
585 return AE_OK;
586 }
587
intel_hid_init(void)588 static int __init intel_hid_init(void)
589 {
590 acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
591 ACPI_UINT32_MAX, check_acpi_dev, NULL,
592 (void *)intel_hid_ids, NULL);
593
594 return platform_driver_register(&intel_hid_pl_driver);
595 }
596 module_init(intel_hid_init);
597
intel_hid_exit(void)598 static void __exit intel_hid_exit(void)
599 {
600 platform_driver_unregister(&intel_hid_pl_driver);
601 }
602 module_exit(intel_hid_exit);
603