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