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