2 * Intel HID event driver for Windows 8
4 * Copyright (C) 2015 Alex Hung <alex.hung@canonical.com>
5 * Copyright (C) 2015 Andrew Lutomirski <luto@kernel.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/input.h>
23 #include <linux/platform_device.h>
24 #include <linux/input/sparse-keymap.h>
25 #include <linux/acpi.h>
26 #include <acpi/acpi_bus.h>
28 MODULE_LICENSE("GPL");
29 MODULE_AUTHOR("Alex Hung");
31 static const struct acpi_device_id intel_hid_ids[] = {
36 /* In theory, these are HID usages. */
37 static const struct key_entry intel_hid_keymap[] = {
38 /* 1: LSuper (Page 0x07, usage 0xE3) -- unclear what to do */
39 /* 2: Toggle SW_ROTATE_LOCK -- easy to implement if seen in wild */
40 { KE_KEY, 3, { KEY_NUMLOCK } },
41 { KE_KEY, 4, { KEY_HOME } },
42 { KE_KEY, 5, { KEY_END } },
43 { KE_KEY, 6, { KEY_PAGEUP } },
44 { KE_KEY, 7, { KEY_PAGEDOWN } },
45 { KE_KEY, 8, { KEY_RFKILL } },
46 { KE_KEY, 9, { KEY_POWER } },
47 { KE_KEY, 11, { KEY_SLEEP } },
48 /* 13 has two different meanings in the spec -- ignore it. */
49 { KE_KEY, 14, { KEY_STOPCD } },
50 { KE_KEY, 15, { KEY_PLAYPAUSE } },
51 { KE_KEY, 16, { KEY_MUTE } },
52 { KE_KEY, 17, { KEY_VOLUMEUP } },
53 { KE_KEY, 18, { KEY_VOLUMEDOWN } },
54 { KE_KEY, 19, { KEY_BRIGHTNESSUP } },
55 { KE_KEY, 20, { KEY_BRIGHTNESSDOWN } },
56 /* 27: wake -- needs special handling */
60 struct intel_hid_priv {
61 struct input_dev *input_dev;
64 static int intel_hid_set_enable(struct device *device, int enable)
66 union acpi_object arg0 = { ACPI_TYPE_INTEGER };
67 struct acpi_object_list args = { 1, &arg0 };
70 arg0.integer.value = enable;
71 status = acpi_evaluate_object(ACPI_HANDLE(device), "HDSM", &args, NULL);
72 if (!ACPI_SUCCESS(status)) {
73 dev_warn(device, "failed to %sable hotkeys\n",
74 enable ? "en" : "dis");
81 static int intel_hid_pl_suspend_handler(struct device *device)
83 intel_hid_set_enable(device, 0);
87 static int intel_hid_pl_resume_handler(struct device *device)
89 intel_hid_set_enable(device, 1);
93 static const struct dev_pm_ops intel_hid_pl_pm_ops = {
94 .suspend = intel_hid_pl_suspend_handler,
95 .resume = intel_hid_pl_resume_handler,
98 static int intel_hid_input_setup(struct platform_device *device)
100 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
103 priv->input_dev = input_allocate_device();
104 if (!priv->input_dev)
107 ret = sparse_keymap_setup(priv->input_dev, intel_hid_keymap, NULL);
109 goto err_free_device;
111 priv->input_dev->dev.parent = &device->dev;
112 priv->input_dev->name = "Intel HID events";
113 priv->input_dev->id.bustype = BUS_HOST;
114 set_bit(KEY_RFKILL, priv->input_dev->keybit);
116 ret = input_register_device(priv->input_dev);
118 goto err_free_device;
123 input_free_device(priv->input_dev);
127 static void intel_hid_input_destroy(struct platform_device *device)
129 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
131 input_unregister_device(priv->input_dev);
134 static void notify_handler(acpi_handle handle, u32 event, void *context)
136 struct platform_device *device = context;
137 struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
138 unsigned long long ev_index;
141 /* The platform spec only defines one event code: 0xC0. */
143 dev_warn(&device->dev, "received unknown event (0x%x)\n",
148 status = acpi_evaluate_integer(handle, "HDEM", NULL, &ev_index);
149 if (!ACPI_SUCCESS(status)) {
150 dev_warn(&device->dev, "failed to get event index\n");
154 if (!sparse_keymap_report_event(priv->input_dev, ev_index, 1, true))
155 dev_info(&device->dev, "unknown event index 0x%llx\n",
159 static int intel_hid_probe(struct platform_device *device)
161 acpi_handle handle = ACPI_HANDLE(&device->dev);
162 struct intel_hid_priv *priv;
163 unsigned long long mode;
167 status = acpi_evaluate_integer(handle, "HDMM", NULL, &mode);
168 if (!ACPI_SUCCESS(status)) {
169 dev_warn(&device->dev, "failed to read mode\n");
175 * This driver only implements "simple" mode. There appear
176 * to be no other modes, but we should be paranoid and check
179 dev_info(&device->dev, "platform is not in simple mode\n");
183 priv = devm_kzalloc(&device->dev, sizeof(*priv), GFP_KERNEL);
186 dev_set_drvdata(&device->dev, priv);
188 err = intel_hid_input_setup(device);
190 pr_err("Failed to setup Intel HID hotkeys\n");
194 status = acpi_install_notify_handler(handle,
198 if (ACPI_FAILURE(status)) {
200 goto err_remove_input;
203 err = intel_hid_set_enable(&device->dev, 1);
205 goto err_remove_notify;
210 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
213 intel_hid_input_destroy(device);
218 static int intel_hid_remove(struct platform_device *device)
220 acpi_handle handle = ACPI_HANDLE(&device->dev);
222 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
223 intel_hid_input_destroy(device);
224 intel_hid_set_enable(&device->dev, 0);
225 acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
228 * Even if we failed to shut off the event stream, we can still
229 * safely detach from the device.
234 static struct platform_driver intel_hid_pl_driver = {
237 .acpi_match_table = intel_hid_ids,
238 .pm = &intel_hid_pl_pm_ops,
240 .probe = intel_hid_probe,
241 .remove = intel_hid_remove,
243 MODULE_DEVICE_TABLE(acpi, intel_hid_ids);
246 * Unfortunately, some laptops provide a _HID="INT33D5" device with
247 * _CID="PNP0C02". This causes the pnpacpi scan driver to claim the
248 * ACPI node, so no platform device will be created. The pnpacpi
249 * driver rejects this device in subsequent processing, so no physical
250 * node is created at all.
252 * As a workaround until the ACPI core figures out how to handle
253 * this corner case, manually ask the ACPI platform device code to
254 * claim the ACPI node.
256 static acpi_status __init
257 check_acpi_dev(acpi_handle handle, u32 lvl, void *context, void **rv)
259 const struct acpi_device_id *ids = context;
260 struct acpi_device *dev;
262 if (acpi_bus_get_device(handle, &dev) != 0)
265 if (acpi_match_device_ids(dev, ids) == 0)
266 if (acpi_create_platform_device(dev))
268 "intel-hid: created platform device\n");
273 static int __init intel_hid_init(void)
275 acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
276 ACPI_UINT32_MAX, check_acpi_dev, NULL,
277 (void *)intel_hid_ids, NULL);
279 return platform_driver_register(&intel_hid_pl_driver);
281 module_init(intel_hid_init);
283 static void __exit intel_hid_exit(void)
285 platform_driver_unregister(&intel_hid_pl_driver);
287 module_exit(intel_hid_exit);