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