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