xref: /openbmc/linux/drivers/platform/x86/intel/hid.c (revision b694e3c604e999343258c49e574abd7be012e726)
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 #include "../dual_accel_detect.h"
18 
19 enum intel_hid_tablet_sw_mode {
20 	TABLET_SW_AUTO = -1,
21 	TABLET_SW_OFF  = 0,
22 	TABLET_SW_AT_EVENT,
23 	TABLET_SW_AT_PROBE,
24 };
25 
26 static bool enable_5_button_array;
27 module_param(enable_5_button_array, bool, 0444);
28 MODULE_PARM_DESC(enable_5_button_array,
29 	"Enable 5 Button Array support. "
30 	"If you need this please report this to: platform-driver-x86@vger.kernel.org");
31 
32 static int enable_sw_tablet_mode = TABLET_SW_AUTO;
33 module_param(enable_sw_tablet_mode, int, 0444);
34 MODULE_PARM_DESC(enable_sw_tablet_mode,
35 	"Enable SW_TABLET_MODE reporting -1:auto 0:off 1:at-first-event 2:at-probe. "
36 	"If you need this please report this to: platform-driver-x86@vger.kernel.org");
37 
38 /* When NOT in tablet mode, VGBS returns with the flag 0x40 */
39 #define TABLET_MODE_FLAG BIT(6)
40 
41 MODULE_LICENSE("GPL");
42 MODULE_AUTHOR("Alex Hung");
43 
44 static const struct acpi_device_id intel_hid_ids[] = {
45 	{"INT33D5", 0},
46 	{"INTC1051", 0},
47 	{"INTC1054", 0},
48 	{"INTC1070", 0},
49 	{"INTC1076", 0},
50 	{"INTC1077", 0},
51 	{"INTC1078", 0},
52 	{"", 0},
53 };
54 MODULE_DEVICE_TABLE(acpi, intel_hid_ids);
55 
56 /* In theory, these are HID usages. */
57 static const struct key_entry intel_hid_keymap[] = {
58 	/* 1: LSuper (Page 0x07, usage 0xE3) -- unclear what to do */
59 	/* 2: Toggle SW_ROTATE_LOCK -- easy to implement if seen in wild */
60 	{ KE_KEY, 3, { KEY_NUMLOCK } },
61 	{ KE_KEY, 4, { KEY_HOME } },
62 	{ KE_KEY, 5, { KEY_END } },
63 	{ KE_KEY, 6, { KEY_PAGEUP } },
64 	{ KE_KEY, 7, { KEY_PAGEDOWN } },
65 	{ KE_KEY, 8, { KEY_RFKILL } },
66 	{ KE_KEY, 9, { KEY_POWER } },
67 	{ KE_KEY, 11, { KEY_SLEEP } },
68 	/* 13 has two different meanings in the spec -- ignore it. */
69 	{ KE_KEY, 14, { KEY_STOPCD } },
70 	{ KE_KEY, 15, { KEY_PLAYPAUSE } },
71 	{ KE_KEY, 16, { KEY_MUTE } },
72 	{ KE_KEY, 17, { KEY_VOLUMEUP } },
73 	{ KE_KEY, 18, { KEY_VOLUMEDOWN } },
74 	{ KE_KEY, 19, { KEY_BRIGHTNESSUP } },
75 	{ KE_KEY, 20, { KEY_BRIGHTNESSDOWN } },
76 	/* 27: wake -- needs special handling */
77 	{ KE_END },
78 };
79 
80 /* 5 button array notification value. */
81 static const struct key_entry intel_array_keymap[] = {
82 	{ KE_KEY,    0xC2, { KEY_LEFTMETA } },                /* Press */
83 	{ KE_IGNORE, 0xC3, { KEY_LEFTMETA } },                /* Release */
84 	{ KE_KEY,    0xC4, { KEY_VOLUMEUP } },                /* Press */
85 	{ KE_IGNORE, 0xC5, { KEY_VOLUMEUP } },                /* Release */
86 	{ KE_KEY,    0xC6, { KEY_VOLUMEDOWN } },              /* Press */
87 	{ KE_IGNORE, 0xC7, { KEY_VOLUMEDOWN } },              /* Release */
88 	{ KE_KEY,    0xC8, { KEY_ROTATE_LOCK_TOGGLE } },      /* Press */
89 	{ KE_IGNORE, 0xC9, { KEY_ROTATE_LOCK_TOGGLE } },      /* Release */
90 	{ KE_KEY,    0xCE, { KEY_POWER } },                   /* Press */
91 	{ KE_IGNORE, 0xCF, { KEY_POWER } },                   /* Release */
92 	{ KE_END },
93 };
94 
95 static const struct dmi_system_id button_array_table[] = {
96 	{
97 		.ident = "Wacom MobileStudio Pro 13",
98 		.matches = {
99 			DMI_MATCH(DMI_SYS_VENDOR, "Wacom Co.,Ltd"),
100 			DMI_MATCH(DMI_PRODUCT_NAME, "Wacom MobileStudio Pro 13"),
101 		},
102 	},
103 	{
104 		.ident = "Wacom MobileStudio Pro 16",
105 		.matches = {
106 			DMI_MATCH(DMI_SYS_VENDOR, "Wacom Co.,Ltd"),
107 			DMI_MATCH(DMI_PRODUCT_NAME, "Wacom MobileStudio Pro 16"),
108 		},
109 	},
110 	{
111 		.ident = "HP Spectre x2 (2015)",
112 		.matches = {
113 			DMI_MATCH(DMI_SYS_VENDOR, "HP"),
114 			DMI_MATCH(DMI_PRODUCT_NAME, "HP Spectre x2 Detachable"),
115 		},
116 	},
117 	{
118 		.ident = "Lenovo ThinkPad X1 Tablet Gen 2",
119 		.matches = {
120 			DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
121 			DMI_MATCH(DMI_PRODUCT_FAMILY, "ThinkPad X1 Tablet Gen 2"),
122 		},
123 	},
124 	{
125 		.ident = "Microsoft Surface Go 3",
126 		.matches = {
127 			DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
128 			DMI_MATCH(DMI_PRODUCT_NAME, "Surface Go 3"),
129 		},
130 	},
131 	{
132 		.ident = "Microsoft Surface Go 4",
133 		.matches = {
134 			DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
135 			DMI_MATCH(DMI_PRODUCT_NAME, "Surface Go 4"),
136 		},
137 	},
138 	{ }
139 };
140 
141 /*
142  * Some convertible use the intel-hid ACPI interface to report SW_TABLET_MODE,
143  * these need to be compared via a DMI based authorization list because some
144  * models have unreliable VGBS return which could cause incorrect
145  * SW_TABLET_MODE report.
146  */
147 static const struct dmi_system_id dmi_vgbs_allow_list[] = {
148 	{
149 		.matches = {
150 			DMI_MATCH(DMI_SYS_VENDOR, "HP"),
151 			DMI_MATCH(DMI_PRODUCT_NAME, "HP Spectre x360 Convertible 15-df0xxx"),
152 		},
153 	},
154 	{
155 		.matches = {
156 			DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
157 			DMI_MATCH(DMI_PRODUCT_NAME, "Surface Go"),
158 		},
159 	},
160 	{
161 		.matches = {
162 			DMI_MATCH(DMI_SYS_VENDOR, "HP"),
163 			DMI_MATCH(DMI_PRODUCT_NAME, "HP Elite Dragonfly G2 Notebook PC"),
164 		},
165 	},
166 	{ }
167 };
168 
169 /*
170  * Some devices, even non convertible ones, can send incorrect SW_TABLET_MODE
171  * reports. Accept such reports only from devices in this list.
172  */
173 static const struct dmi_system_id dmi_auto_add_switch[] = {
174 	{
175 		.matches = {
176 			DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "31" /* Convertible */),
177 		},
178 	},
179 	{
180 		.matches = {
181 			DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "32" /* Detachable */),
182 		},
183 	},
184 	{} /* Array terminator */
185 };
186 
187 struct intel_hid_priv {
188 	struct input_dev *input_dev;
189 	struct input_dev *array;
190 	struct input_dev *switches;
191 	bool wakeup_mode;
192 };
193 
194 #define HID_EVENT_FILTER_UUID	"eeec56b3-4442-408f-a792-4edd4d758054"
195 
196 enum intel_hid_dsm_fn_codes {
197 	INTEL_HID_DSM_FN_INVALID,
198 	INTEL_HID_DSM_BTNL_FN,
199 	INTEL_HID_DSM_HDMM_FN,
200 	INTEL_HID_DSM_HDSM_FN,
201 	INTEL_HID_DSM_HDEM_FN,
202 	INTEL_HID_DSM_BTNS_FN,
203 	INTEL_HID_DSM_BTNE_FN,
204 	INTEL_HID_DSM_HEBC_V1_FN,
205 	INTEL_HID_DSM_VGBS_FN,
206 	INTEL_HID_DSM_HEBC_V2_FN,
207 	INTEL_HID_DSM_FN_MAX
208 };
209 
210 static const char *intel_hid_dsm_fn_to_method[INTEL_HID_DSM_FN_MAX] = {
211 	NULL,
212 	"BTNL",
213 	"HDMM",
214 	"HDSM",
215 	"HDEM",
216 	"BTNS",
217 	"BTNE",
218 	"HEBC",
219 	"VGBS",
220 	"HEBC"
221 };
222 
223 static unsigned long long intel_hid_dsm_fn_mask;
224 static guid_t intel_dsm_guid;
225 
intel_hid_execute_method(acpi_handle handle,enum intel_hid_dsm_fn_codes fn_index,unsigned long long arg)226 static bool intel_hid_execute_method(acpi_handle handle,
227 				     enum intel_hid_dsm_fn_codes fn_index,
228 				     unsigned long long arg)
229 {
230 	union acpi_object *obj, argv4, req;
231 	acpi_status status;
232 	char *method_name;
233 
234 	if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
235 	    fn_index >= INTEL_HID_DSM_FN_MAX)
236 		return false;
237 
238 	method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
239 
240 	if (!(intel_hid_dsm_fn_mask & BIT(fn_index)))
241 		goto skip_dsm_exec;
242 
243 	/* All methods expects a package with one integer element */
244 	req.type = ACPI_TYPE_INTEGER;
245 	req.integer.value = arg;
246 
247 	argv4.type = ACPI_TYPE_PACKAGE;
248 	argv4.package.count = 1;
249 	argv4.package.elements = &req;
250 
251 	obj = acpi_evaluate_dsm(handle, &intel_dsm_guid, 1, fn_index, &argv4);
252 	if (obj) {
253 		acpi_handle_debug(handle, "Exec DSM Fn code: %d[%s] success\n",
254 				  fn_index, method_name);
255 		ACPI_FREE(obj);
256 		return true;
257 	}
258 
259 skip_dsm_exec:
260 	status = acpi_execute_simple_method(handle, method_name, arg);
261 	if (ACPI_SUCCESS(status))
262 		return true;
263 
264 	return false;
265 }
266 
intel_hid_evaluate_method(acpi_handle handle,enum intel_hid_dsm_fn_codes fn_index,unsigned long long * result)267 static bool intel_hid_evaluate_method(acpi_handle handle,
268 				      enum intel_hid_dsm_fn_codes fn_index,
269 				      unsigned long long *result)
270 {
271 	union acpi_object *obj;
272 	acpi_status status;
273 	char *method_name;
274 
275 	if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
276 	    fn_index >= INTEL_HID_DSM_FN_MAX)
277 		return false;
278 
279 	method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
280 
281 	if (!(intel_hid_dsm_fn_mask & BIT(fn_index)))
282 		goto skip_dsm_eval;
283 
284 	obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid,
285 				      1, fn_index,
286 				      NULL,  ACPI_TYPE_INTEGER);
287 	if (obj) {
288 		*result = obj->integer.value;
289 		acpi_handle_debug(handle,
290 				  "Eval DSM Fn code: %d[%s] results: 0x%llx\n",
291 				  fn_index, method_name, *result);
292 		ACPI_FREE(obj);
293 		return true;
294 	}
295 
296 skip_dsm_eval:
297 	status = acpi_evaluate_integer(handle, method_name, NULL, result);
298 	if (ACPI_SUCCESS(status))
299 		return true;
300 
301 	return false;
302 }
303 
intel_hid_init_dsm(acpi_handle handle)304 static void intel_hid_init_dsm(acpi_handle handle)
305 {
306 	union acpi_object *obj;
307 
308 	guid_parse(HID_EVENT_FILTER_UUID, &intel_dsm_guid);
309 
310 	obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid, 1, 0, NULL,
311 				      ACPI_TYPE_BUFFER);
312 	if (obj) {
313 		switch (obj->buffer.length) {
314 		default:
315 		case 2:
316 			intel_hid_dsm_fn_mask = *(u16 *)obj->buffer.pointer;
317 			break;
318 		case 1:
319 			intel_hid_dsm_fn_mask = *obj->buffer.pointer;
320 			break;
321 		case 0:
322 			acpi_handle_warn(handle, "intel_hid_dsm_fn_mask length is zero\n");
323 			intel_hid_dsm_fn_mask = 0;
324 			break;
325 		}
326 		ACPI_FREE(obj);
327 	}
328 
329 	acpi_handle_debug(handle, "intel_hid_dsm_fn_mask = %llx\n",
330 			  intel_hid_dsm_fn_mask);
331 }
332 
intel_hid_set_enable(struct device * device,bool enable)333 static int intel_hid_set_enable(struct device *device, bool enable)
334 {
335 	acpi_handle handle = ACPI_HANDLE(device);
336 
337 	/* Enable|disable features - power button is always enabled */
338 	if (!intel_hid_execute_method(handle, INTEL_HID_DSM_HDSM_FN,
339 				      enable)) {
340 		dev_warn(device, "failed to %sable hotkeys\n",
341 			 enable ? "en" : "dis");
342 		return -EIO;
343 	}
344 
345 	return 0;
346 }
347 
intel_button_array_enable(struct device * device,bool enable)348 static void intel_button_array_enable(struct device *device, bool enable)
349 {
350 	struct intel_hid_priv *priv = dev_get_drvdata(device);
351 	acpi_handle handle = ACPI_HANDLE(device);
352 	unsigned long long button_cap;
353 	acpi_status status;
354 
355 	if (!priv->array)
356 		return;
357 
358 	/* Query supported platform features */
359 	status = acpi_evaluate_integer(handle, "BTNC", NULL, &button_cap);
360 	if (ACPI_FAILURE(status)) {
361 		dev_warn(device, "failed to get button capability\n");
362 		return;
363 	}
364 
365 	/* Enable|disable features - power button is always enabled */
366 	if (!intel_hid_execute_method(handle, INTEL_HID_DSM_BTNE_FN,
367 				      enable ? button_cap : 1))
368 		dev_warn(device, "failed to set button capability\n");
369 }
370 
intel_hid_pm_prepare(struct device * device)371 static int intel_hid_pm_prepare(struct device *device)
372 {
373 	if (device_may_wakeup(device)) {
374 		struct intel_hid_priv *priv = dev_get_drvdata(device);
375 
376 		priv->wakeup_mode = true;
377 	}
378 	return 0;
379 }
380 
intel_hid_pm_complete(struct device * device)381 static void intel_hid_pm_complete(struct device *device)
382 {
383 	struct intel_hid_priv *priv = dev_get_drvdata(device);
384 
385 	priv->wakeup_mode = false;
386 }
387 
intel_hid_pl_suspend_handler(struct device * device)388 static int intel_hid_pl_suspend_handler(struct device *device)
389 {
390 	intel_button_array_enable(device, false);
391 
392 	if (!pm_suspend_no_platform())
393 		intel_hid_set_enable(device, false);
394 
395 	return 0;
396 }
397 
intel_hid_pl_resume_handler(struct device * device)398 static int intel_hid_pl_resume_handler(struct device *device)
399 {
400 	intel_hid_pm_complete(device);
401 
402 	if (!pm_suspend_no_platform())
403 		intel_hid_set_enable(device, true);
404 
405 	intel_button_array_enable(device, true);
406 	return 0;
407 }
408 
409 static const struct dev_pm_ops intel_hid_pl_pm_ops = {
410 	.prepare = intel_hid_pm_prepare,
411 	.complete = intel_hid_pm_complete,
412 	.freeze  = intel_hid_pl_suspend_handler,
413 	.thaw  = intel_hid_pl_resume_handler,
414 	.restore  = intel_hid_pl_resume_handler,
415 	.suspend  = intel_hid_pl_suspend_handler,
416 	.resume  = intel_hid_pl_resume_handler,
417 };
418 
intel_hid_input_setup(struct platform_device * device)419 static int intel_hid_input_setup(struct platform_device *device)
420 {
421 	struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
422 	int ret;
423 
424 	priv->input_dev = devm_input_allocate_device(&device->dev);
425 	if (!priv->input_dev)
426 		return -ENOMEM;
427 
428 	ret = sparse_keymap_setup(priv->input_dev, intel_hid_keymap, NULL);
429 	if (ret)
430 		return ret;
431 
432 	priv->input_dev->name = "Intel HID events";
433 	priv->input_dev->id.bustype = BUS_HOST;
434 
435 	return input_register_device(priv->input_dev);
436 }
437 
intel_button_array_input_setup(struct platform_device * device)438 static int intel_button_array_input_setup(struct platform_device *device)
439 {
440 	struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
441 	int ret;
442 
443 	/* Setup input device for 5 button array */
444 	priv->array = devm_input_allocate_device(&device->dev);
445 	if (!priv->array)
446 		return -ENOMEM;
447 
448 	ret = sparse_keymap_setup(priv->array, intel_array_keymap, NULL);
449 	if (ret)
450 		return ret;
451 
452 	priv->array->name = "Intel HID 5 button array";
453 	priv->array->id.bustype = BUS_HOST;
454 
455 	return input_register_device(priv->array);
456 }
457 
intel_hid_switches_setup(struct platform_device * device)458 static int intel_hid_switches_setup(struct platform_device *device)
459 {
460 	struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
461 
462 	/* Setup input device for switches */
463 	priv->switches = devm_input_allocate_device(&device->dev);
464 	if (!priv->switches)
465 		return -ENOMEM;
466 
467 	__set_bit(EV_SW, priv->switches->evbit);
468 	__set_bit(SW_TABLET_MODE, priv->switches->swbit);
469 
470 	priv->switches->name = "Intel HID switches";
471 	priv->switches->id.bustype = BUS_HOST;
472 	return input_register_device(priv->switches);
473 }
474 
report_tablet_mode_state(struct platform_device * device)475 static void report_tablet_mode_state(struct platform_device *device)
476 {
477 	struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
478 	acpi_handle handle = ACPI_HANDLE(&device->dev);
479 	unsigned long long vgbs;
480 	int m;
481 
482 	if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_VGBS_FN, &vgbs))
483 		return;
484 
485 	m = !(vgbs & TABLET_MODE_FLAG);
486 	input_report_switch(priv->switches, SW_TABLET_MODE, m);
487 	input_sync(priv->switches);
488 }
489 
report_tablet_mode_event(struct input_dev * input_dev,u32 event)490 static bool report_tablet_mode_event(struct input_dev *input_dev, u32 event)
491 {
492 	if (!input_dev)
493 		return false;
494 
495 	switch (event) {
496 	case 0xcc:
497 		input_report_switch(input_dev, SW_TABLET_MODE, 1);
498 		input_sync(input_dev);
499 		return true;
500 	case 0xcd:
501 		input_report_switch(input_dev, SW_TABLET_MODE, 0);
502 		input_sync(input_dev);
503 		return true;
504 	default:
505 		return false;
506 	}
507 }
508 
notify_handler(acpi_handle handle,u32 event,void * context)509 static void notify_handler(acpi_handle handle, u32 event, void *context)
510 {
511 	struct platform_device *device = context;
512 	struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
513 	unsigned long long ev_index;
514 	int err;
515 
516 	/*
517 	 * Some convertible have unreliable VGBS return which could cause incorrect
518 	 * SW_TABLET_MODE report, in these cases we enable support when receiving
519 	 * the first event instead of during driver setup.
520 	 */
521 	if (!priv->switches && enable_sw_tablet_mode == TABLET_SW_AT_EVENT &&
522 	    (event == 0xcc || event == 0xcd)) {
523 		dev_info(&device->dev, "switch event received, enable switches supports\n");
524 		err = intel_hid_switches_setup(device);
525 		if (err)
526 			pr_err("Failed to setup Intel HID switches\n");
527 	}
528 
529 	if (priv->wakeup_mode) {
530 		/*
531 		 * Needed for wakeup from suspend-to-idle to work on some
532 		 * platforms that don't expose the 5-button array, but still
533 		 * send notifies with the power button event code to this
534 		 * device object on power button actions while suspended.
535 		 */
536 		if (event == 0xce)
537 			goto wakeup;
538 
539 		/*
540 		 * Some devices send (duplicate) tablet-mode events when moved
541 		 * around even though the mode has not changed; and they do this
542 		 * even when suspended.
543 		 * Update the switch state in case it changed and then return
544 		 * without waking up to avoid spurious wakeups.
545 		 */
546 		if (event == 0xcc || event == 0xcd) {
547 			report_tablet_mode_event(priv->switches, event);
548 			return;
549 		}
550 
551 		/* Wake up on 5-button array events only. */
552 		if (event == 0xc0 || !priv->array)
553 			return;
554 
555 		if (!sparse_keymap_entry_from_scancode(priv->array, event)) {
556 			dev_info(&device->dev, "unknown event 0x%x\n", event);
557 			return;
558 		}
559 
560 wakeup:
561 		pm_wakeup_hard_event(&device->dev);
562 
563 		return;
564 	}
565 
566 	/*
567 	 * Needed for suspend to work on some platforms that don't expose
568 	 * the 5-button array, but still send notifies with power button
569 	 * event code to this device object on power button actions.
570 	 *
571 	 * Report the power button press and release.
572 	 */
573 	if (!priv->array) {
574 		if (event == 0xce) {
575 			input_report_key(priv->input_dev, KEY_POWER, 1);
576 			input_sync(priv->input_dev);
577 			return;
578 		}
579 
580 		if (event == 0xcf) {
581 			input_report_key(priv->input_dev, KEY_POWER, 0);
582 			input_sync(priv->input_dev);
583 			return;
584 		}
585 	}
586 
587 	if (report_tablet_mode_event(priv->switches, event))
588 		return;
589 
590 	/* 0xC0 is for HID events, other values are for 5 button array */
591 	if (event != 0xc0) {
592 		if (!priv->array ||
593 		    !sparse_keymap_report_event(priv->array, event, 1, true))
594 			dev_dbg(&device->dev, "unknown event 0x%x\n", event);
595 		return;
596 	}
597 
598 	if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDEM_FN,
599 				       &ev_index)) {
600 		dev_warn(&device->dev, "failed to get event index\n");
601 		return;
602 	}
603 
604 	if (!sparse_keymap_report_event(priv->input_dev, ev_index, 1, true))
605 		dev_dbg(&device->dev, "unknown event index 0x%llx\n",
606 			 ev_index);
607 }
608 
button_array_present(struct platform_device * device)609 static bool button_array_present(struct platform_device *device)
610 {
611 	acpi_handle handle = ACPI_HANDLE(&device->dev);
612 	unsigned long long event_cap;
613 
614 	if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V2_FN,
615 				      &event_cap)) {
616 		/* Check presence of 5 button array or v2 power button */
617 		if (event_cap & 0x60000)
618 			return true;
619 	}
620 
621 	if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V1_FN,
622 				      &event_cap)) {
623 		if (event_cap & 0x20000)
624 			return true;
625 	}
626 
627 	if (enable_5_button_array || dmi_check_system(button_array_table))
628 		return true;
629 
630 	return false;
631 }
632 
intel_hid_probe(struct platform_device * device)633 static int intel_hid_probe(struct platform_device *device)
634 {
635 	acpi_handle handle = ACPI_HANDLE(&device->dev);
636 	unsigned long long mode, dummy;
637 	struct intel_hid_priv *priv;
638 	acpi_status status;
639 	int err;
640 
641 	intel_hid_init_dsm(handle);
642 
643 	if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDMM_FN, &mode)) {
644 		dev_warn(&device->dev, "failed to read mode\n");
645 		return -ENODEV;
646 	}
647 
648 	if (mode != 0) {
649 		/*
650 		 * This driver only implements "simple" mode.  There appear
651 		 * to be no other modes, but we should be paranoid and check
652 		 * for compatibility.
653 		 */
654 		dev_info(&device->dev, "platform is not in simple mode\n");
655 		return -ENODEV;
656 	}
657 
658 	priv = devm_kzalloc(&device->dev, sizeof(*priv), GFP_KERNEL);
659 	if (!priv)
660 		return -ENOMEM;
661 	dev_set_drvdata(&device->dev, priv);
662 
663 	/* See dual_accel_detect.h for more info on the dual_accel check. */
664 	if (enable_sw_tablet_mode == TABLET_SW_AUTO) {
665 		if (dmi_check_system(dmi_vgbs_allow_list))
666 			enable_sw_tablet_mode = TABLET_SW_AT_PROBE;
667 		else if (dmi_check_system(dmi_auto_add_switch) && !dual_accel_detect())
668 			enable_sw_tablet_mode = TABLET_SW_AT_EVENT;
669 		else
670 			enable_sw_tablet_mode = TABLET_SW_OFF;
671 	}
672 
673 	err = intel_hid_input_setup(device);
674 	if (err) {
675 		pr_err("Failed to setup Intel HID hotkeys\n");
676 		return err;
677 	}
678 
679 	/* Setup 5 button array */
680 	if (button_array_present(device)) {
681 		dev_info(&device->dev, "platform supports 5 button array\n");
682 		err = intel_button_array_input_setup(device);
683 		if (err)
684 			pr_err("Failed to setup Intel 5 button array hotkeys\n");
685 	}
686 
687 	/* Setup switches for devices that we know VGBS return correctly */
688 	if (enable_sw_tablet_mode == TABLET_SW_AT_PROBE) {
689 		dev_info(&device->dev, "platform supports switches\n");
690 		err = intel_hid_switches_setup(device);
691 		if (err)
692 			pr_err("Failed to setup Intel HID switches\n");
693 		else
694 			report_tablet_mode_state(device);
695 	}
696 
697 	status = acpi_install_notify_handler(handle,
698 					     ACPI_DEVICE_NOTIFY,
699 					     notify_handler,
700 					     device);
701 	if (ACPI_FAILURE(status))
702 		return -EBUSY;
703 
704 	err = intel_hid_set_enable(&device->dev, true);
705 	if (err)
706 		goto err_remove_notify;
707 
708 	intel_button_array_enable(&device->dev, true);
709 
710 	/*
711 	 * Call button load method to enable HID power button
712 	 * Always do this since it activates events on some devices without
713 	 * a button array too.
714 	 */
715 	if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_BTNL_FN, &dummy))
716 		dev_warn(&device->dev, "failed to enable HID power button\n");
717 
718 	device_init_wakeup(&device->dev, true);
719 	/*
720 	 * In order for system wakeup to work, the EC GPE has to be marked as
721 	 * a wakeup one, so do that here (this setting will persist, but it has
722 	 * no effect until the wakeup mask is set for the EC GPE).
723 	 */
724 	acpi_ec_mark_gpe_for_wake();
725 	return 0;
726 
727 err_remove_notify:
728 	acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
729 
730 	return err;
731 }
732 
intel_hid_remove(struct platform_device * device)733 static void intel_hid_remove(struct platform_device *device)
734 {
735 	acpi_handle handle = ACPI_HANDLE(&device->dev);
736 
737 	device_init_wakeup(&device->dev, false);
738 	acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
739 	intel_hid_set_enable(&device->dev, false);
740 	intel_button_array_enable(&device->dev, false);
741 }
742 
743 static struct platform_driver intel_hid_pl_driver = {
744 	.driver = {
745 		.name = "intel-hid",
746 		.acpi_match_table = intel_hid_ids,
747 		.pm = &intel_hid_pl_pm_ops,
748 	},
749 	.probe = intel_hid_probe,
750 	.remove_new = intel_hid_remove,
751 };
752 
753 /*
754  * Unfortunately, some laptops provide a _HID="INT33D5" device with
755  * _CID="PNP0C02".  This causes the pnpacpi scan driver to claim the
756  * ACPI node, so no platform device will be created.  The pnpacpi
757  * driver rejects this device in subsequent processing, so no physical
758  * node is created at all.
759  *
760  * As a workaround until the ACPI core figures out how to handle
761  * this corner case, manually ask the ACPI platform device code to
762  * claim the ACPI node.
763  */
764 static acpi_status __init
check_acpi_dev(acpi_handle handle,u32 lvl,void * context,void ** rv)765 check_acpi_dev(acpi_handle handle, u32 lvl, void *context, void **rv)
766 {
767 	const struct acpi_device_id *ids = context;
768 	struct acpi_device *dev = acpi_fetch_acpi_dev(handle);
769 
770 	if (dev && acpi_match_device_ids(dev, ids) == 0)
771 		if (!IS_ERR_OR_NULL(acpi_create_platform_device(dev, NULL)))
772 			dev_info(&dev->dev,
773 				 "intel-hid: created platform device\n");
774 
775 	return AE_OK;
776 }
777 
intel_hid_init(void)778 static int __init intel_hid_init(void)
779 {
780 	acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
781 			    ACPI_UINT32_MAX, check_acpi_dev, NULL,
782 			    (void *)intel_hid_ids, NULL);
783 
784 	return platform_driver_register(&intel_hid_pl_driver);
785 }
786 module_init(intel_hid_init);
787 
intel_hid_exit(void)788 static void __exit intel_hid_exit(void)
789 {
790 	platform_driver_unregister(&intel_hid_pl_driver);
791 }
792 module_exit(intel_hid_exit);
793