blob: 13f8cf70b9aee559d17fcb100abc748652a9b68a [file] [log] [blame]
Andy Shevchenko31daa5d2018-09-26 18:27:40 +03001// SPDX-License-Identifier: GPL-2.0+
Alex Hungecc83e52015-12-18 23:31:10 +08002/*
Alex Hungbd5762a2017-02-14 15:20:34 +08003 * Intel HID event & 5 button array driver
Alex Hungecc83e52015-12-18 23:31:10 +08004 *
5 * Copyright (C) 2015 Alex Hung <alex.hung@canonical.com>
6 * Copyright (C) 2015 Andrew Lutomirski <luto@kernel.org>
Alex Hungecc83e52015-12-18 23:31:10 +08007 */
8
Alex Hung28e8ed22018-03-15 16:22:51 -07009#include <linux/acpi.h>
10#include <linux/dmi.h>
11#include <linux/input.h>
12#include <linux/input/sparse-keymap.h>
Alex Hungecc83e52015-12-18 23:31:10 +080013#include <linux/kernel.h>
14#include <linux/module.h>
Alex Hungecc83e52015-12-18 23:31:10 +080015#include <linux/platform_device.h>
Rafael J. Wysockief884112017-06-08 02:16:13 +020016#include <linux/suspend.h>
Kate Hsuanc3d35862021-08-20 14:04:53 +030017#include "../dual_accel_detect.h"
Alex Hungecc83e52015-12-18 23:31:10 +080018
Elia Devito537b0dd42020-12-04 17:01:22 +010019/* When NOT in tablet mode, VGBS returns with the flag 0x40 */
20#define TABLET_MODE_FLAG BIT(6)
21
Alex Hungecc83e52015-12-18 23:31:10 +080022MODULE_LICENSE("GPL");
23MODULE_AUTHOR("Alex Hung");
24
25static const struct acpi_device_id intel_hid_ids[] = {
26 {"INT33D5", 0},
Gayatri Kammelad5764dc2020-03-27 14:28:20 -070027 {"INTC1051", 0},
Alex Hung7067be72020-12-07 19:06:20 -070028 {"INTC1054", 0},
Ping Baoa59c7b62021-07-21 15:56:15 -070029 {"INTC1070", 0},
Alex Hungecc83e52015-12-18 23:31:10 +080030 {"", 0},
31};
Andy Shevchenko57ba2632020-01-28 12:26:21 +020032MODULE_DEVICE_TABLE(acpi, intel_hid_ids);
Alex Hungecc83e52015-12-18 23:31:10 +080033
34/* In theory, these are HID usages. */
35static const struct key_entry intel_hid_keymap[] = {
36 /* 1: LSuper (Page 0x07, usage 0xE3) -- unclear what to do */
37 /* 2: Toggle SW_ROTATE_LOCK -- easy to implement if seen in wild */
38 { KE_KEY, 3, { KEY_NUMLOCK } },
39 { KE_KEY, 4, { KEY_HOME } },
40 { KE_KEY, 5, { KEY_END } },
41 { KE_KEY, 6, { KEY_PAGEUP } },
Alex Hung1c319e72016-01-27 21:35:00 +080042 { KE_KEY, 7, { KEY_PAGEDOWN } },
Alex Hungecc83e52015-12-18 23:31:10 +080043 { KE_KEY, 8, { KEY_RFKILL } },
44 { KE_KEY, 9, { KEY_POWER } },
45 { KE_KEY, 11, { KEY_SLEEP } },
46 /* 13 has two different meanings in the spec -- ignore it. */
47 { KE_KEY, 14, { KEY_STOPCD } },
48 { KE_KEY, 15, { KEY_PLAYPAUSE } },
49 { KE_KEY, 16, { KEY_MUTE } },
50 { KE_KEY, 17, { KEY_VOLUMEUP } },
51 { KE_KEY, 18, { KEY_VOLUMEDOWN } },
52 { KE_KEY, 19, { KEY_BRIGHTNESSUP } },
53 { KE_KEY, 20, { KEY_BRIGHTNESSDOWN } },
54 /* 27: wake -- needs special handling */
55 { KE_END },
56};
57
Alex Hungbd5762a2017-02-14 15:20:34 +080058/* 5 button array notification value. */
59static const struct key_entry intel_array_keymap[] = {
60 { KE_KEY, 0xC2, { KEY_LEFTMETA } }, /* Press */
61 { KE_IGNORE, 0xC3, { KEY_LEFTMETA } }, /* Release */
62 { KE_KEY, 0xC4, { KEY_VOLUMEUP } }, /* Press */
63 { KE_IGNORE, 0xC5, { KEY_VOLUMEUP } }, /* Release */
64 { KE_KEY, 0xC6, { KEY_VOLUMEDOWN } }, /* Press */
65 { KE_IGNORE, 0xC7, { KEY_VOLUMEDOWN } }, /* Release */
Alex Hung2b5de0c2018-03-30 16:54:54 -070066 { KE_KEY, 0xC8, { KEY_ROTATE_LOCK_TOGGLE } }, /* Press */
67 { KE_IGNORE, 0xC9, { KEY_ROTATE_LOCK_TOGGLE } }, /* Release */
Alex Hungbd5762a2017-02-14 15:20:34 +080068 { KE_KEY, 0xCE, { KEY_POWER } }, /* Press */
69 { KE_IGNORE, 0xCF, { KEY_POWER } }, /* Release */
70 { KE_END },
71};
72
Alex Hungc454a992017-12-07 11:40:23 +080073static const struct dmi_system_id button_array_table[] = {
74 {
75 .ident = "Wacom MobileStudio Pro 13",
76 .matches = {
77 DMI_MATCH(DMI_SYS_VENDOR, "Wacom Co.,Ltd"),
78 DMI_MATCH(DMI_PRODUCT_NAME, "Wacom MobileStudio Pro 13"),
79 },
80 },
81 {
82 .ident = "Wacom MobileStudio Pro 16",
83 .matches = {
84 DMI_MATCH(DMI_SYS_VENDOR, "Wacom Co.,Ltd"),
85 DMI_MATCH(DMI_PRODUCT_NAME, "Wacom MobileStudio Pro 16"),
86 },
87 },
Nickolai Kozachenko8fe63eb2020-05-30 22:07:20 +050088 {
89 .ident = "HP Spectre x2 (2015)",
90 .matches = {
91 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
92 DMI_MATCH(DMI_PRODUCT_NAME, "HP Spectre x2 Detachable"),
93 },
94 },
Alban Bedel56678a52021-02-22 15:15:59 +010095 {
96 .ident = "Lenovo ThinkPad X1 Tablet Gen 2",
97 .matches = {
98 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
99 DMI_MATCH(DMI_PRODUCT_FAMILY, "ThinkPad X1 Tablet Gen 2"),
100 },
101 },
Alex Hung7d0c0092021-12-03 14:28:10 -0700102 {
103 .ident = "Microsoft Surface Go 3",
104 .matches = {
105 DMI_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
106 DMI_MATCH(DMI_PRODUCT_NAME, "Surface Go 3"),
107 },
108 },
Alex Hungc454a992017-12-07 11:40:23 +0800109 { }
110};
111
Elia Devito537b0dd42020-12-04 17:01:22 +0100112/*
113 * Some convertible use the intel-hid ACPI interface to report SW_TABLET_MODE,
114 * these need to be compared via a DMI based authorization list because some
115 * models have unreliable VGBS return which could cause incorrect
116 * SW_TABLET_MODE report.
117 */
118static const struct dmi_system_id dmi_vgbs_allow_list[] = {
119 {
120 .matches = {
121 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
122 DMI_MATCH(DMI_PRODUCT_NAME, "HP Spectre x360 Convertible 15-df0xxx"),
123 },
124 },
125 { }
126};
127
José Expósitob201cb02021-09-20 18:03:12 +0200128/*
129 * Some devices, even non convertible ones, can send incorrect SW_TABLET_MODE
130 * reports. Accept such reports only from devices in this list.
131 */
132static const struct dmi_system_id dmi_auto_add_switch[] = {
133 {
134 .matches = {
135 DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "31" /* Convertible */),
136 },
137 },
138 {
139 .matches = {
140 DMI_EXACT_MATCH(DMI_CHASSIS_TYPE, "32" /* Detachable */),
141 },
142 },
143 {} /* Array terminator */
144};
145
Alex Hungecc83e52015-12-18 23:31:10 +0800146struct intel_hid_priv {
147 struct input_dev *input_dev;
Alex Hungbd5762a2017-02-14 15:20:34 +0800148 struct input_dev *array;
Elia Devito537b0dd42020-12-04 17:01:22 +0100149 struct input_dev *switches;
Rafael J. Wysockief884112017-06-08 02:16:13 +0200150 bool wakeup_mode;
José Expósitob201cb02021-09-20 18:03:12 +0200151 bool auto_add_switch;
Alex Hungecc83e52015-12-18 23:31:10 +0800152};
153
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700154#define HID_EVENT_FILTER_UUID "eeec56b3-4442-408f-a792-4edd4d758054"
155
156enum intel_hid_dsm_fn_codes {
157 INTEL_HID_DSM_FN_INVALID,
158 INTEL_HID_DSM_BTNL_FN,
159 INTEL_HID_DSM_HDMM_FN,
160 INTEL_HID_DSM_HDSM_FN,
161 INTEL_HID_DSM_HDEM_FN,
162 INTEL_HID_DSM_BTNS_FN,
163 INTEL_HID_DSM_BTNE_FN,
164 INTEL_HID_DSM_HEBC_V1_FN,
165 INTEL_HID_DSM_VGBS_FN,
166 INTEL_HID_DSM_HEBC_V2_FN,
167 INTEL_HID_DSM_FN_MAX
168};
169
170static const char *intel_hid_dsm_fn_to_method[INTEL_HID_DSM_FN_MAX] = {
171 NULL,
172 "BTNL",
173 "HDMM",
174 "HDSM",
175 "HDEM",
176 "BTNS",
177 "BTNE",
178 "HEBC",
179 "VGBS",
180 "HEBC"
181};
182
183static unsigned long long intel_hid_dsm_fn_mask;
184static guid_t intel_dsm_guid;
185
186static bool intel_hid_execute_method(acpi_handle handle,
187 enum intel_hid_dsm_fn_codes fn_index,
188 unsigned long long arg)
189{
190 union acpi_object *obj, argv4, req;
191 acpi_status status;
192 char *method_name;
193
194 if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
195 fn_index >= INTEL_HID_DSM_FN_MAX)
196 return false;
197
198 method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
199
Zhen Gong97ab4512020-11-08 01:23:19 -0800200 if (!(intel_hid_dsm_fn_mask & BIT(fn_index)))
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700201 goto skip_dsm_exec;
202
203 /* All methods expects a package with one integer element */
204 req.type = ACPI_TYPE_INTEGER;
205 req.integer.value = arg;
206
207 argv4.type = ACPI_TYPE_PACKAGE;
208 argv4.package.count = 1;
209 argv4.package.elements = &req;
210
211 obj = acpi_evaluate_dsm(handle, &intel_dsm_guid, 1, fn_index, &argv4);
212 if (obj) {
213 acpi_handle_debug(handle, "Exec DSM Fn code: %d[%s] success\n",
214 fn_index, method_name);
215 ACPI_FREE(obj);
216 return true;
217 }
218
219skip_dsm_exec:
220 status = acpi_execute_simple_method(handle, method_name, arg);
221 if (ACPI_SUCCESS(status))
222 return true;
223
224 return false;
225}
226
227static bool intel_hid_evaluate_method(acpi_handle handle,
228 enum intel_hid_dsm_fn_codes fn_index,
229 unsigned long long *result)
230{
231 union acpi_object *obj;
232 acpi_status status;
233 char *method_name;
234
235 if (fn_index <= INTEL_HID_DSM_FN_INVALID ||
236 fn_index >= INTEL_HID_DSM_FN_MAX)
237 return false;
238
239 method_name = (char *)intel_hid_dsm_fn_to_method[fn_index];
240
241 if (!(intel_hid_dsm_fn_mask & fn_index))
242 goto skip_dsm_eval;
243
244 obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid,
245 1, fn_index,
246 NULL, ACPI_TYPE_INTEGER);
247 if (obj) {
248 *result = obj->integer.value;
249 acpi_handle_debug(handle,
250 "Eval DSM Fn code: %d[%s] results: 0x%llx\n",
251 fn_index, method_name, *result);
252 ACPI_FREE(obj);
253 return true;
254 }
255
256skip_dsm_eval:
257 status = acpi_evaluate_integer(handle, method_name, NULL, result);
258 if (ACPI_SUCCESS(status))
259 return true;
260
261 return false;
262}
263
264static void intel_hid_init_dsm(acpi_handle handle)
265{
266 union acpi_object *obj;
267
268 guid_parse(HID_EVENT_FILTER_UUID, &intel_dsm_guid);
269
270 obj = acpi_evaluate_dsm_typed(handle, &intel_dsm_guid, 1, 0, NULL,
271 ACPI_TYPE_BUFFER);
272 if (obj) {
Zhen Gong97ab4512020-11-08 01:23:19 -0800273 switch (obj->buffer.length) {
274 default:
275 case 2:
276 intel_hid_dsm_fn_mask = *(u16 *)obj->buffer.pointer;
277 break;
278 case 1:
279 intel_hid_dsm_fn_mask = *obj->buffer.pointer;
280 break;
281 case 0:
282 acpi_handle_warn(handle, "intel_hid_dsm_fn_mask length is zero\n");
283 intel_hid_dsm_fn_mask = 0;
284 break;
285 }
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700286 ACPI_FREE(obj);
287 }
288
289 acpi_handle_debug(handle, "intel_hid_dsm_fn_mask = %llx\n",
290 intel_hid_dsm_fn_mask);
291}
292
Michał Kępień99a75e7b2017-02-24 11:33:07 +0100293static int intel_hid_set_enable(struct device *device, bool enable)
Alex Hungecc83e52015-12-18 23:31:10 +0800294{
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700295 acpi_handle handle = ACPI_HANDLE(device);
Alex Hungecc83e52015-12-18 23:31:10 +0800296
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700297 /* Enable|disable features - power button is always enabled */
298 if (!intel_hid_execute_method(handle, INTEL_HID_DSM_HDSM_FN,
299 enable)) {
Alex Hungecc83e52015-12-18 23:31:10 +0800300 dev_warn(device, "failed to %sable hotkeys\n",
301 enable ? "en" : "dis");
302 return -EIO;
303 }
304
305 return 0;
306}
307
Alex Hungbd5762a2017-02-14 15:20:34 +0800308static void intel_button_array_enable(struct device *device, bool enable)
309{
310 struct intel_hid_priv *priv = dev_get_drvdata(device);
311 acpi_handle handle = ACPI_HANDLE(device);
312 unsigned long long button_cap;
313 acpi_status status;
314
315 if (!priv->array)
316 return;
317
318 /* Query supported platform features */
319 status = acpi_evaluate_integer(handle, "BTNC", NULL, &button_cap);
320 if (ACPI_FAILURE(status)) {
321 dev_warn(device, "failed to get button capability\n");
322 return;
323 }
324
325 /* Enable|disable features - power button is always enabled */
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700326 if (!intel_hid_execute_method(handle, INTEL_HID_DSM_BTNE_FN,
327 enable ? button_cap : 1))
Alex Hungbd5762a2017-02-14 15:20:34 +0800328 dev_warn(device, "failed to set button capability\n");
329}
330
Rafael J. Wysockief884112017-06-08 02:16:13 +0200331static int intel_hid_pm_prepare(struct device *device)
332{
Rafael J. Wysocki10a08fd2019-07-30 11:55:59 +0200333 if (device_may_wakeup(device)) {
334 struct intel_hid_priv *priv = dev_get_drvdata(device);
Rafael J. Wysockief884112017-06-08 02:16:13 +0200335
Rafael J. Wysocki10a08fd2019-07-30 11:55:59 +0200336 priv->wakeup_mode = true;
Rafael J. Wysocki10a08fd2019-07-30 11:55:59 +0200337 }
Rafael J. Wysockief884112017-06-08 02:16:13 +0200338 return 0;
339}
340
Rafael J. Wysocki31eb8452019-08-08 11:39:17 +0200341static void intel_hid_pm_complete(struct device *device)
342{
343 struct intel_hid_priv *priv = dev_get_drvdata(device);
344
Rafael J. Wysockib90ff352019-08-21 11:40:19 +0200345 priv->wakeup_mode = false;
Rafael J. Wysocki31eb8452019-08-08 11:39:17 +0200346}
347
Alex Hungecc83e52015-12-18 23:31:10 +0800348static int intel_hid_pl_suspend_handler(struct device *device)
349{
Rafael J. Wysockid19bdb82019-08-08 11:39:23 +0200350 intel_button_array_enable(device, false);
351
352 if (!pm_suspend_no_platform())
Rafael J. Wysockief884112017-06-08 02:16:13 +0200353 intel_hid_set_enable(device, false);
Rafael J. Wysockid19bdb82019-08-08 11:39:23 +0200354
Alex Hungecc83e52015-12-18 23:31:10 +0800355 return 0;
356}
357
358static int intel_hid_pl_resume_handler(struct device *device)
359{
Rafael J. Wysocki31eb8452019-08-08 11:39:17 +0200360 intel_hid_pm_complete(device);
Alex Hungbd5762a2017-02-14 15:20:34 +0800361
Rafael J. Wysockid19bdb82019-08-08 11:39:23 +0200362 if (!pm_suspend_no_platform())
Rafael J. Wysockief884112017-06-08 02:16:13 +0200363 intel_hid_set_enable(device, true);
Rafael J. Wysockid19bdb82019-08-08 11:39:23 +0200364
365 intel_button_array_enable(device, true);
Alex Hungecc83e52015-12-18 23:31:10 +0800366 return 0;
367}
368
369static const struct dev_pm_ops intel_hid_pl_pm_ops = {
Rafael J. Wysockief884112017-06-08 02:16:13 +0200370 .prepare = intel_hid_pm_prepare,
Rafael J. Wysocki31eb8452019-08-08 11:39:17 +0200371 .complete = intel_hid_pm_complete,
Alex Hung45aa56c2016-03-21 16:08:42 +0800372 .freeze = intel_hid_pl_suspend_handler,
Rafael J. Wysockib8998302017-04-18 15:49:06 +0200373 .thaw = intel_hid_pl_resume_handler,
Alex Hung45aa56c2016-03-21 16:08:42 +0800374 .restore = intel_hid_pl_resume_handler,
Alex Hungecc83e52015-12-18 23:31:10 +0800375 .suspend = intel_hid_pl_suspend_handler,
376 .resume = intel_hid_pl_resume_handler,
377};
378
379static int intel_hid_input_setup(struct platform_device *device)
380{
381 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
382 int ret;
383
Michał Kępień175cc9b2017-02-24 11:33:08 +0100384 priv->input_dev = devm_input_allocate_device(&device->dev);
Alex Hungecc83e52015-12-18 23:31:10 +0800385 if (!priv->input_dev)
386 return -ENOMEM;
387
388 ret = sparse_keymap_setup(priv->input_dev, intel_hid_keymap, NULL);
389 if (ret)
Michał Kępień175cc9b2017-02-24 11:33:08 +0100390 return ret;
Alex Hungecc83e52015-12-18 23:31:10 +0800391
Alex Hungecc83e52015-12-18 23:31:10 +0800392 priv->input_dev->name = "Intel HID events";
393 priv->input_dev->id.bustype = BUS_HOST;
Alex Hungecc83e52015-12-18 23:31:10 +0800394
Michał Kępień175cc9b2017-02-24 11:33:08 +0100395 return input_register_device(priv->input_dev);
Alex Hungecc83e52015-12-18 23:31:10 +0800396}
397
Alex Hungbd5762a2017-02-14 15:20:34 +0800398static int intel_button_array_input_setup(struct platform_device *device)
399{
400 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
401 int ret;
402
403 /* Setup input device for 5 button array */
404 priv->array = devm_input_allocate_device(&device->dev);
405 if (!priv->array)
406 return -ENOMEM;
407
408 ret = sparse_keymap_setup(priv->array, intel_array_keymap, NULL);
409 if (ret)
410 return ret;
411
Alex Hungbd5762a2017-02-14 15:20:34 +0800412 priv->array->name = "Intel HID 5 button array";
413 priv->array->id.bustype = BUS_HOST;
414
415 return input_register_device(priv->array);
416}
417
Elia Devito537b0dd42020-12-04 17:01:22 +0100418static int intel_hid_switches_setup(struct platform_device *device)
419{
420 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
421
422 /* Setup input device for switches */
423 priv->switches = devm_input_allocate_device(&device->dev);
424 if (!priv->switches)
425 return -ENOMEM;
426
427 __set_bit(EV_SW, priv->switches->evbit);
428 __set_bit(SW_TABLET_MODE, priv->switches->swbit);
429
430 priv->switches->name = "Intel HID switches";
431 priv->switches->id.bustype = BUS_HOST;
432 return input_register_device(priv->switches);
433}
434
435static void report_tablet_mode_state(struct platform_device *device)
436{
437 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
438 acpi_handle handle = ACPI_HANDLE(&device->dev);
439 unsigned long long vgbs;
440 int m;
441
442 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_VGBS_FN, &vgbs))
443 return;
444
445 m = !(vgbs & TABLET_MODE_FLAG);
446 input_report_switch(priv->switches, SW_TABLET_MODE, m);
447 input_sync(priv->switches);
448}
449
450static bool report_tablet_mode_event(struct input_dev *input_dev, u32 event)
451{
452 if (!input_dev)
453 return false;
454
455 switch (event) {
456 case 0xcc:
457 input_report_switch(input_dev, SW_TABLET_MODE, 1);
458 input_sync(input_dev);
459 return true;
460 case 0xcd:
461 input_report_switch(input_dev, SW_TABLET_MODE, 0);
462 input_sync(input_dev);
463 return true;
464 default:
465 return false;
466 }
467}
468
Alex Hungecc83e52015-12-18 23:31:10 +0800469static void notify_handler(acpi_handle handle, u32 event, void *context)
470{
471 struct platform_device *device = context;
472 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
473 unsigned long long ev_index;
Elia Devitoac32bae2020-12-04 17:02:35 +0100474 int err;
475
476 /*
477 * Some convertible have unreliable VGBS return which could cause incorrect
478 * SW_TABLET_MODE report, in these cases we enable support when receiving
479 * the first event instead of during driver setup.
480 */
José Expósitob201cb02021-09-20 18:03:12 +0200481 if (!priv->switches && priv->auto_add_switch && (event == 0xcc || event == 0xcd)) {
Elia Devitoac32bae2020-12-04 17:02:35 +0100482 dev_info(&device->dev, "switch event received, enable switches supports\n");
483 err = intel_hid_switches_setup(device);
484 if (err)
485 pr_err("Failed to setup Intel HID switches\n");
486 }
Alex Hungecc83e52015-12-18 23:31:10 +0800487
Rafael J. Wysockief884112017-06-08 02:16:13 +0200488 if (priv->wakeup_mode) {
Rafael J. Wysocki635173a2017-07-28 02:06:36 +0200489 /*
490 * Needed for wakeup from suspend-to-idle to work on some
491 * platforms that don't expose the 5-button array, but still
492 * send notifies with the power button event code to this
493 * device object on power button actions while suspended.
494 */
495 if (event == 0xce)
496 goto wakeup;
497
Elia Devito537b0dd42020-12-04 17:01:22 +0100498 /*
Hans de Goedea3790a82021-04-04 16:38:31 +0200499 * Some devices send (duplicate) tablet-mode events when moved
500 * around even though the mode has not changed; and they do this
501 * even when suspended.
502 * Update the switch state in case it changed and then return
503 * without waking up to avoid spurious wakeups.
Elia Devito537b0dd42020-12-04 17:01:22 +0100504 */
Hans de Goedea3790a82021-04-04 16:38:31 +0200505 if (event == 0xcc || event == 0xcd) {
506 report_tablet_mode_event(priv->switches, event);
507 return;
508 }
Elia Devito537b0dd42020-12-04 17:01:22 +0100509
Rafael J. Wysockief884112017-06-08 02:16:13 +0200510 /* Wake up on 5-button array events only. */
511 if (event == 0xc0 || !priv->array)
512 return;
513
Rafael J. Wysocki635173a2017-07-28 02:06:36 +0200514 if (!sparse_keymap_entry_from_scancode(priv->array, event)) {
Rafael J. Wysockief884112017-06-08 02:16:13 +0200515 dev_info(&device->dev, "unknown event 0x%x\n", event);
Rafael J. Wysocki635173a2017-07-28 02:06:36 +0200516 return;
517 }
Rafael J. Wysockief884112017-06-08 02:16:13 +0200518
Rafael J. Wysocki635173a2017-07-28 02:06:36 +0200519wakeup:
520 pm_wakeup_hard_event(&device->dev);
Elia Devito537b0dd42020-12-04 17:01:22 +0100521
Rafael J. Wysockief884112017-06-08 02:16:13 +0200522 return;
523 }
524
Jérôme de Bretagne821b8532017-09-18 00:57:12 +0200525 /*
526 * Needed for suspend to work on some platforms that don't expose
527 * the 5-button array, but still send notifies with power button
528 * event code to this device object on power button actions.
529 *
Jérôme de Bretagnee97a3452019-01-06 18:56:44 +0100530 * Report the power button press and release.
Jérôme de Bretagne821b8532017-09-18 00:57:12 +0200531 */
532 if (!priv->array) {
533 if (event == 0xce) {
534 input_report_key(priv->input_dev, KEY_POWER, 1);
535 input_sync(priv->input_dev);
536 return;
537 }
538
Jérôme de Bretagnee97a3452019-01-06 18:56:44 +0100539 if (event == 0xcf) {
540 input_report_key(priv->input_dev, KEY_POWER, 0);
541 input_sync(priv->input_dev);
Jérôme de Bretagne821b8532017-09-18 00:57:12 +0200542 return;
Jérôme de Bretagnee97a3452019-01-06 18:56:44 +0100543 }
Jérôme de Bretagne821b8532017-09-18 00:57:12 +0200544 }
545
Elia Devito537b0dd42020-12-04 17:01:22 +0100546 if (report_tablet_mode_event(priv->switches, event))
547 return;
548
Alex Hungbd5762a2017-02-14 15:20:34 +0800549 /* 0xC0 is for HID events, other values are for 5 button array */
Alex Hungecc83e52015-12-18 23:31:10 +0800550 if (event != 0xc0) {
Alex Hungbd5762a2017-02-14 15:20:34 +0800551 if (!priv->array ||
552 !sparse_keymap_report_event(priv->array, event, 1, true))
Alex Hungd496c872017-07-20 20:58:08 -0700553 dev_dbg(&device->dev, "unknown event 0x%x\n", event);
Alex Hungecc83e52015-12-18 23:31:10 +0800554 return;
555 }
556
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700557 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDEM_FN,
558 &ev_index)) {
Alex Hungecc83e52015-12-18 23:31:10 +0800559 dev_warn(&device->dev, "failed to get event index\n");
560 return;
561 }
562
563 if (!sparse_keymap_report_event(priv->input_dev, ev_index, 1, true))
Alex Hungd496c872017-07-20 20:58:08 -0700564 dev_dbg(&device->dev, "unknown event index 0x%llx\n",
Alex Hungecc83e52015-12-18 23:31:10 +0800565 ev_index);
566}
567
Alex Hungc454a992017-12-07 11:40:23 +0800568static bool button_array_present(struct platform_device *device)
569{
570 acpi_handle handle = ACPI_HANDLE(&device->dev);
571 unsigned long long event_cap;
Alex Hungc454a992017-12-07 11:40:23 +0800572
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700573 if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V2_FN,
574 &event_cap)) {
575 /* Check presence of 5 button array or v2 power button */
576 if (event_cap & 0x60000)
577 return true;
578 }
579
580 if (intel_hid_evaluate_method(handle, INTEL_HID_DSM_HEBC_V1_FN,
581 &event_cap)) {
582 if (event_cap & 0x20000)
583 return true;
584 }
Alex Hungc454a992017-12-07 11:40:23 +0800585
586 if (dmi_check_system(button_array_table))
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700587 return true;
Alex Hungc454a992017-12-07 11:40:23 +0800588
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700589 return false;
Alex Hungc454a992017-12-07 11:40:23 +0800590}
591
Alex Hungecc83e52015-12-18 23:31:10 +0800592static int intel_hid_probe(struct platform_device *device)
593{
594 acpi_handle handle = ACPI_HANDLE(&device->dev);
Alex Hungc454a992017-12-07 11:40:23 +0800595 unsigned long long mode;
Alex Hungecc83e52015-12-18 23:31:10 +0800596 struct intel_hid_priv *priv;
Alex Hungecc83e52015-12-18 23:31:10 +0800597 acpi_status status;
598 int err;
599
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700600 intel_hid_init_dsm(handle);
601
602 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_HDMM_FN, &mode)) {
Alex Hungecc83e52015-12-18 23:31:10 +0800603 dev_warn(&device->dev, "failed to read mode\n");
604 return -ENODEV;
605 }
606
607 if (mode != 0) {
608 /*
609 * This driver only implements "simple" mode. There appear
610 * to be no other modes, but we should be paranoid and check
611 * for compatibility.
612 */
613 dev_info(&device->dev, "platform is not in simple mode\n");
614 return -ENODEV;
615 }
616
Wolfram Sange8b69a52016-02-21 15:22:27 +0100617 priv = devm_kzalloc(&device->dev, sizeof(*priv), GFP_KERNEL);
Alex Hungecc83e52015-12-18 23:31:10 +0800618 if (!priv)
619 return -ENOMEM;
620 dev_set_drvdata(&device->dev, priv);
621
José Expósitob201cb02021-09-20 18:03:12 +0200622 /* See dual_accel_detect.h for more info on the dual_accel check. */
623 priv->auto_add_switch = dmi_check_system(dmi_auto_add_switch) && !dual_accel_detect();
Hans de Goede153cca92021-07-29 10:21:34 +0200624
Alex Hungecc83e52015-12-18 23:31:10 +0800625 err = intel_hid_input_setup(device);
626 if (err) {
627 pr_err("Failed to setup Intel HID hotkeys\n");
628 return err;
629 }
630
Alex Hungbd5762a2017-02-14 15:20:34 +0800631 /* Setup 5 button array */
Alex Hungc454a992017-12-07 11:40:23 +0800632 if (button_array_present(device)) {
Alex Hungbd5762a2017-02-14 15:20:34 +0800633 dev_info(&device->dev, "platform supports 5 button array\n");
634 err = intel_button_array_input_setup(device);
635 if (err)
636 pr_err("Failed to setup Intel 5 button array hotkeys\n");
637 }
638
Elia Devito537b0dd42020-12-04 17:01:22 +0100639 /* Setup switches for devices that we know VGBS return correctly */
640 if (dmi_check_system(dmi_vgbs_allow_list)) {
641 dev_info(&device->dev, "platform supports switches\n");
642 err = intel_hid_switches_setup(device);
643 if (err)
644 pr_err("Failed to setup Intel HID switches\n");
645 else
646 report_tablet_mode_state(device);
647 }
648
Alex Hungecc83e52015-12-18 23:31:10 +0800649 status = acpi_install_notify_handler(handle,
650 ACPI_DEVICE_NOTIFY,
651 notify_handler,
652 device);
Michał Kępień175cc9b2017-02-24 11:33:08 +0100653 if (ACPI_FAILURE(status))
654 return -EBUSY;
Alex Hungecc83e52015-12-18 23:31:10 +0800655
Michał Kępień99a75e7b2017-02-24 11:33:07 +0100656 err = intel_hid_set_enable(&device->dev, true);
Alex Hungecc83e52015-12-18 23:31:10 +0800657 if (err)
658 goto err_remove_notify;
659
Alex Hungbd5762a2017-02-14 15:20:34 +0800660 if (priv->array) {
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700661 unsigned long long dummy;
662
Alex Hungbd5762a2017-02-14 15:20:34 +0800663 intel_button_array_enable(&device->dev, true);
664
665 /* Call button load method to enable HID power button */
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700666 if (!intel_hid_evaluate_method(handle, INTEL_HID_DSM_BTNL_FN,
667 &dummy)) {
Alex Hungbd5762a2017-02-14 15:20:34 +0800668 dev_warn(&device->dev,
669 "failed to enable HID power button\n");
Srinivas Pandruvada5bf24e22018-06-28 11:19:06 -0700670 }
Alex Hungbd5762a2017-02-14 15:20:34 +0800671 }
672
Rafael J. Wysockief884112017-06-08 02:16:13 +0200673 device_init_wakeup(&device->dev, true);
Rafael J. Wysocki10a08fd2019-07-30 11:55:59 +0200674 /*
675 * In order for system wakeup to work, the EC GPE has to be marked as
676 * a wakeup one, so do that here (this setting will persist, but it has
677 * no effect until the wakeup mask is set for the EC GPE).
678 */
679 acpi_ec_mark_gpe_for_wake();
Alex Hungecc83e52015-12-18 23:31:10 +0800680 return 0;
681
682err_remove_notify:
683 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
684
Alex Hungecc83e52015-12-18 23:31:10 +0800685 return err;
686}
687
688static int intel_hid_remove(struct platform_device *device)
689{
690 acpi_handle handle = ACPI_HANDLE(&device->dev);
691
Rafael J. Wysocki356b5772018-02-28 12:10:59 +0100692 device_init_wakeup(&device->dev, false);
Alex Hungecc83e52015-12-18 23:31:10 +0800693 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
Michał Kępień99a75e7b2017-02-24 11:33:07 +0100694 intel_hid_set_enable(&device->dev, false);
Alex Hungbd5762a2017-02-14 15:20:34 +0800695 intel_button_array_enable(&device->dev, false);
Alex Hungecc83e52015-12-18 23:31:10 +0800696
697 /*
698 * Even if we failed to shut off the event stream, we can still
699 * safely detach from the device.
700 */
701 return 0;
702}
703
704static struct platform_driver intel_hid_pl_driver = {
705 .driver = {
706 .name = "intel-hid",
707 .acpi_match_table = intel_hid_ids,
708 .pm = &intel_hid_pl_pm_ops,
709 },
710 .probe = intel_hid_probe,
711 .remove = intel_hid_remove,
712};
Alex Hungecc83e52015-12-18 23:31:10 +0800713
714/*
715 * Unfortunately, some laptops provide a _HID="INT33D5" device with
716 * _CID="PNP0C02". This causes the pnpacpi scan driver to claim the
717 * ACPI node, so no platform device will be created. The pnpacpi
718 * driver rejects this device in subsequent processing, so no physical
719 * node is created at all.
720 *
721 * As a workaround until the ACPI core figures out how to handle
722 * this corner case, manually ask the ACPI platform device code to
723 * claim the ACPI node.
724 */
725static acpi_status __init
726check_acpi_dev(acpi_handle handle, u32 lvl, void *context, void **rv)
727{
728 const struct acpi_device_id *ids = context;
729 struct acpi_device *dev;
730
731 if (acpi_bus_get_device(handle, &dev) != 0)
732 return AE_OK;
733
734 if (acpi_match_device_ids(dev, ids) == 0)
Lu Wei71fbe882020-07-10 17:30:17 +0800735 if (!IS_ERR_OR_NULL(acpi_create_platform_device(dev, NULL)))
Alex Hungecc83e52015-12-18 23:31:10 +0800736 dev_info(&dev->dev,
737 "intel-hid: created platform device\n");
738
739 return AE_OK;
740}
741
742static int __init intel_hid_init(void)
743{
744 acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
745 ACPI_UINT32_MAX, check_acpi_dev, NULL,
746 (void *)intel_hid_ids, NULL);
747
748 return platform_driver_register(&intel_hid_pl_driver);
749}
750module_init(intel_hid_init);
751
752static void __exit intel_hid_exit(void)
753{
754 platform_driver_unregister(&intel_hid_pl_driver);
755}
756module_exit(intel_hid_exit);