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