4 * Copyright (C) 2008 Red Hat <mjg@redhat.com>
5 * Copyright (C) 2014-2015 Pali Rohár <pali.rohar@gmail.com>
7 * Portions based on wistron_btns.c:
8 * Copyright (C) 2005 Miloslav Trmac <mitr@volny.cz>
9 * Copyright (C) 2005 Bernhard Rosenkraenzer <bero@arklinux.org>
10 * Copyright (C) 2005 Dmitry Torokhov <dtor@mail.ru>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
29 #include <linux/kernel.h>
30 #include <linux/module.h>
31 #include <linux/init.h>
32 #include <linux/slab.h>
33 #include <linux/types.h>
34 #include <linux/input.h>
35 #include <linux/input/sparse-keymap.h>
36 #include <linux/acpi.h>
37 #include <linux/string.h>
38 #include <linux/dmi.h>
39 #include <linux/wmi.h>
40 #include <acpi/video.h>
41 #include "dell-smbios.h"
42 #include "dell-wmi-descriptor.h"
44 MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");
45 MODULE_AUTHOR("Pali Rohár <pali.rohar@gmail.com>");
46 MODULE_DESCRIPTION("Dell laptop WMI hotkeys driver");
47 MODULE_LICENSE("GPL");
49 #define DELL_EVENT_GUID "9DBB5994-A997-11DA-B012-B622A1EF5492"
51 static bool wmi_requires_smbios_request;
53 MODULE_ALIAS("wmi:"DELL_EVENT_GUID);
55 struct dell_wmi_priv {
56 struct input_dev *input_dev;
57 u32 interface_version;
60 static int __init dmi_matched(const struct dmi_system_id *dmi)
62 wmi_requires_smbios_request = 1;
66 static const struct dmi_system_id dell_wmi_smbios_list[] __initconst = {
68 .callback = dmi_matched,
69 .ident = "Dell Inspiron M5110",
71 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
72 DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron M5110"),
76 .callback = dmi_matched,
77 .ident = "Dell Vostro V131",
79 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
80 DMI_MATCH(DMI_PRODUCT_NAME, "Vostro V131"),
87 * Keymap for WMI events of type 0x0000
89 * Certain keys are flagged as KE_IGNORE. All of these are either
90 * notifications (rather than requests for change) or are also sent
91 * via the keyboard controller so should not be sent again.
93 static const struct key_entry dell_wmi_keymap_type_0000[] = {
94 { KE_IGNORE, 0x003a, { KEY_CAPSLOCK } },
96 /* Key code is followed by brightness level */
97 { KE_KEY, 0xe005, { KEY_BRIGHTNESSDOWN } },
98 { KE_KEY, 0xe006, { KEY_BRIGHTNESSUP } },
100 /* Battery health status button */
101 { KE_KEY, 0xe007, { KEY_BATTERY } },
103 /* Radio devices state change, key code is followed by other values */
104 { KE_IGNORE, 0xe008, { KEY_RFKILL } },
106 { KE_KEY, 0xe009, { KEY_EJECTCD } },
108 /* Key code is followed by: next, active and attached devices */
109 { KE_KEY, 0xe00b, { KEY_SWITCHVIDEOMODE } },
111 /* Key code is followed by keyboard illumination level */
112 { KE_IGNORE, 0xe00c, { KEY_KBDILLUMTOGGLE } },
114 /* BIOS error detected */
115 { KE_IGNORE, 0xe00d, { KEY_RESERVED } },
117 /* Battery was removed or inserted */
118 { KE_IGNORE, 0xe00e, { KEY_RESERVED } },
121 { KE_KEY, 0xe011, { KEY_WLAN } },
123 /* Ambient light sensor toggle */
124 { KE_IGNORE, 0xe013, { KEY_RESERVED } },
126 { KE_IGNORE, 0xe020, { KEY_MUTE } },
128 /* Unknown, defined in ACPI DSDT */
129 /* { KE_IGNORE, 0xe023, { KEY_RESERVED } }, */
131 /* Untested, Dell Instant Launch key on Inspiron 7520 */
132 /* { KE_IGNORE, 0xe024, { KEY_RESERVED } }, */
134 /* Dell Instant Launch key */
135 { KE_KEY, 0xe025, { KEY_PROG4 } },
137 /* Audio panel key */
138 { KE_IGNORE, 0xe026, { KEY_RESERVED } },
140 /* LCD Display On/Off Control key */
141 { KE_KEY, 0xe027, { KEY_DISPLAYTOGGLE } },
143 /* Untested, Multimedia key on Dell Vostro 3560 */
144 /* { KE_IGNORE, 0xe028, { KEY_RESERVED } }, */
146 /* Dell Instant Launch key */
147 { KE_KEY, 0xe029, { KEY_PROG4 } },
149 /* Untested, Windows Mobility Center button on Inspiron 7520 */
150 /* { KE_IGNORE, 0xe02a, { KEY_RESERVED } }, */
152 /* Unknown, defined in ACPI DSDT */
153 /* { KE_IGNORE, 0xe02b, { KEY_RESERVED } }, */
155 /* Untested, Dell Audio With Preset Switch button on Inspiron 7520 */
156 /* { KE_IGNORE, 0xe02c, { KEY_RESERVED } }, */
158 { KE_IGNORE, 0xe02e, { KEY_VOLUMEDOWN } },
159 { KE_IGNORE, 0xe030, { KEY_VOLUMEUP } },
160 { KE_IGNORE, 0xe033, { KEY_KBDILLUMUP } },
161 { KE_IGNORE, 0xe034, { KEY_KBDILLUMDOWN } },
162 { KE_IGNORE, 0xe03a, { KEY_CAPSLOCK } },
165 { KE_IGNORE, 0xe043, { KEY_RESERVED } },
167 /* NIC Link is Down */
168 { KE_IGNORE, 0xe044, { KEY_RESERVED } },
171 * This entry is very suspicious!
172 * Originally Matthew Garrett created this dell-wmi driver specially for
173 * "button with a picture of a battery" which has event code 0xe045.
174 * Later Mario Limonciello from Dell told us that event code 0xe045 is
175 * reported by Num Lock and should be ignored because key is send also
176 * by keyboard controller.
177 * So for now we will ignore this event to prevent potential double
178 * Num Lock key press.
180 { KE_IGNORE, 0xe045, { KEY_NUMLOCK } },
182 /* Scroll lock and also going to tablet mode on portable devices */
183 { KE_IGNORE, 0xe046, { KEY_SCROLLLOCK } },
185 /* Untested, going from tablet mode on portable devices */
186 /* { KE_IGNORE, 0xe047, { KEY_RESERVED } }, */
188 /* Dell Support Center key */
189 { KE_IGNORE, 0xe06e, { KEY_RESERVED } },
191 { KE_IGNORE, 0xe0f7, { KEY_MUTE } },
192 { KE_IGNORE, 0xe0f8, { KEY_VOLUMEDOWN } },
193 { KE_IGNORE, 0xe0f9, { KEY_VOLUMEUP } },
196 struct dell_bios_keymap_entry {
201 struct dell_bios_hotkey_table {
202 struct dmi_header header;
203 struct dell_bios_keymap_entry keymap[];
207 struct dell_dmi_results {
210 struct key_entry *keymap;
213 /* Uninitialized entries here are KEY_RESERVED == 0. */
214 static const u16 bios_to_linux_keycode[256] = {
218 [3] = KEY_PREVIOUSSONG,
225 [10] = KEY_VOLUMEDOWN,
234 [19] = KEY_BRIGHTNESSDOWN,
235 [20] = KEY_BRIGHTNESSUP,
237 [22] = KEY_KBDILLUMTOGGLE,
239 [24] = KEY_SWITCHVIDEOMODE,
242 [27] = KEY_SWITCHVIDEOMODE,
258 * Keymap for WMI events of type 0x0010
260 * These are applied if the 0xB2 DMI hotkey table is present and doesn't
263 static const struct key_entry dell_wmi_keymap_type_0010[] = {
265 { KE_IGNORE, 0x151, { KEY_RESERVED } },
267 /* Change keyboard illumination */
268 { KE_IGNORE, 0x152, { KEY_KBDILLUMTOGGLE } },
271 * Radio disable (notify only -- there is no model for which the
272 * WMI event is supposed to trigger an action).
274 { KE_IGNORE, 0x153, { KEY_RFKILL } },
276 /* RGB keyboard backlight control */
277 { KE_IGNORE, 0x154, { KEY_RESERVED } },
280 * Stealth mode toggle. This will "disable all lights and sounds".
281 * The action is performed by the BIOS and EC; the WMI event is just
282 * a notification. On the XPS 13 9350, this is Fn+F7, and there's
283 * a BIOS setting to enable and disable the hotkey.
285 { KE_IGNORE, 0x155, { KEY_RESERVED } },
287 /* Rugged magnetic dock attach/detach events */
288 { KE_IGNORE, 0x156, { KEY_RESERVED } },
289 { KE_IGNORE, 0x157, { KEY_RESERVED } },
291 /* Rugged programmable (P1/P2/P3 keys) */
292 { KE_KEY, 0x850, { KEY_PROG1 } },
293 { KE_KEY, 0x851, { KEY_PROG2 } },
294 { KE_KEY, 0x852, { KEY_PROG3 } },
299 * Keymap for WMI events of type 0x0011
301 static const struct key_entry dell_wmi_keymap_type_0011[] = {
302 /* Battery unplugged */
303 { KE_IGNORE, 0xfff0, { KEY_RESERVED } },
305 /* Battery inserted */
306 { KE_IGNORE, 0xfff1, { KEY_RESERVED } },
308 /* Keyboard backlight level changed */
309 { KE_IGNORE, 0x01e1, { KEY_RESERVED } },
310 { KE_IGNORE, 0x02ea, { KEY_RESERVED } },
311 { KE_IGNORE, 0x02eb, { KEY_RESERVED } },
312 { KE_IGNORE, 0x02ec, { KEY_RESERVED } },
313 { KE_IGNORE, 0x02f6, { KEY_RESERVED } },
316 static void dell_wmi_process_key(struct wmi_device *wdev, int type, int code)
318 struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
319 const struct key_entry *key;
321 key = sparse_keymap_entry_from_scancode(priv->input_dev,
322 (type << 16) | code);
324 pr_info("Unknown key with type 0x%04x and code 0x%04x pressed\n",
329 pr_debug("Key with type 0x%04x and code 0x%04x pressed\n", type, code);
331 /* Don't report brightness notifications that will also come via ACPI */
332 if ((key->keycode == KEY_BRIGHTNESSUP ||
333 key->keycode == KEY_BRIGHTNESSDOWN) &&
334 acpi_video_handles_brightness_key_presses())
337 if (type == 0x0000 && code == 0xe025 && !wmi_requires_smbios_request)
340 if (key->keycode == KEY_KBDILLUMTOGGLE)
341 dell_laptop_call_notifier(
342 DELL_LAPTOP_KBD_BACKLIGHT_BRIGHTNESS_CHANGED, NULL);
344 sparse_keymap_report_entry(priv->input_dev, key, 1, true);
347 static void dell_wmi_notify(struct wmi_device *wdev,
348 union acpi_object *obj)
350 struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
351 u16 *buffer_entry, *buffer_end;
352 acpi_size buffer_size;
355 if (obj->type != ACPI_TYPE_BUFFER) {
356 pr_warn("bad response type %x\n", obj->type);
360 pr_debug("Received WMI event (%*ph)\n",
361 obj->buffer.length, obj->buffer.pointer);
363 buffer_entry = (u16 *)obj->buffer.pointer;
364 buffer_size = obj->buffer.length/2;
365 buffer_end = buffer_entry + buffer_size;
368 * BIOS/ACPI on devices with WMI interface version 0 does not clear
369 * buffer before filling it. So next time when BIOS/ACPI send WMI event
370 * which is smaller as previous then it contains garbage in buffer from
373 * BIOS/ACPI on devices with WMI interface version 1 clears buffer and
374 * sometimes send more events in buffer at one call.
376 * So to prevent reading garbage from buffer we will process only first
377 * one event on devices with WMI interface version 0.
379 if (priv->interface_version == 0 && buffer_entry < buffer_end)
380 if (buffer_end > buffer_entry + buffer_entry[0] + 1)
381 buffer_end = buffer_entry + buffer_entry[0] + 1;
383 while (buffer_entry < buffer_end) {
385 len = buffer_entry[0];
391 if (buffer_entry + len > buffer_end) {
392 pr_warn("Invalid length of WMI event\n");
396 pr_debug("Process buffer (%*ph)\n", len*2, buffer_entry);
398 switch (buffer_entry[1]) {
399 case 0x0000: /* One key pressed or event occurred */
401 dell_wmi_process_key(wdev, 0x0000,
403 /* Other entries could contain additional information */
405 case 0x0010: /* Sequence of keys pressed */
406 case 0x0011: /* Sequence of events occurred */
407 for (i = 2; i < len; ++i)
408 dell_wmi_process_key(wdev, buffer_entry[1],
411 default: /* Unknown event */
412 pr_info("Unknown WMI event type 0x%x\n",
413 (int)buffer_entry[1]);
423 static bool have_scancode(u32 scancode, const struct key_entry *keymap, int len)
427 for (i = 0; i < len; i++)
428 if (keymap[i].code == scancode)
434 static void handle_dmi_entry(const struct dmi_header *dm, void *opaque)
436 struct dell_dmi_results *results = opaque;
437 struct dell_bios_hotkey_table *table;
438 int hotkey_num, i, pos = 0;
439 struct key_entry *keymap;
441 if (results->err || results->keymap)
442 return; /* We already found the hotkey table. */
444 /* The Dell hotkey table is type 0xB2. Scan until we find it. */
445 if (dm->type != 0xb2)
448 table = container_of(dm, struct dell_bios_hotkey_table, header);
450 hotkey_num = (table->header.length -
451 sizeof(struct dell_bios_hotkey_table)) /
452 sizeof(struct dell_bios_keymap_entry);
453 if (hotkey_num < 1) {
455 * Historically, dell-wmi would ignore a DMI entry of
456 * fewer than 7 bytes. Sizes between 4 and 8 bytes are
457 * nonsensical (both the header and all entries are 4
458 * bytes), so we approximate the old behavior by
459 * ignoring tables with fewer than one entry.
464 keymap = kcalloc(hotkey_num, sizeof(struct key_entry), GFP_KERNEL);
466 results->err = -ENOMEM;
470 for (i = 0; i < hotkey_num; i++) {
471 const struct dell_bios_keymap_entry *bios_entry =
474 /* Uninitialized entries are 0 aka KEY_RESERVED. */
475 u16 keycode = (bios_entry->keycode <
476 ARRAY_SIZE(bios_to_linux_keycode)) ?
477 bios_to_linux_keycode[bios_entry->keycode] :
481 * Log if we find an entry in the DMI table that we don't
482 * understand. If this happens, we should figure out what
483 * the entry means and add it to bios_to_linux_keycode.
485 if (keycode == KEY_RESERVED) {
486 pr_info("firmware scancode 0x%x maps to unrecognized keycode 0x%x\n",
487 bios_entry->scancode, bios_entry->keycode);
491 if (keycode == KEY_KBDILLUMTOGGLE)
492 keymap[pos].type = KE_IGNORE;
494 keymap[pos].type = KE_KEY;
495 keymap[pos].code = bios_entry->scancode;
496 keymap[pos].keycode = keycode;
501 results->keymap = keymap;
502 results->keymap_size = pos;
505 static int dell_wmi_input_setup(struct wmi_device *wdev)
507 struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
508 struct dell_dmi_results dmi_results = {};
509 struct key_entry *keymap;
512 priv->input_dev = input_allocate_device();
513 if (!priv->input_dev)
516 priv->input_dev->name = "Dell WMI hotkeys";
517 priv->input_dev->id.bustype = BUS_HOST;
518 priv->input_dev->dev.parent = &wdev->dev;
520 if (dmi_walk(handle_dmi_entry, &dmi_results)) {
522 * Historically, dell-wmi ignored dmi_walk errors. A failure
523 * is certainly surprising, but it probably just indicates
526 pr_warn("no DMI; using the old-style hotkey interface\n");
529 if (dmi_results.err) {
530 err = dmi_results.err;
534 keymap = kcalloc(dmi_results.keymap_size +
535 ARRAY_SIZE(dell_wmi_keymap_type_0000) +
536 ARRAY_SIZE(dell_wmi_keymap_type_0010) +
537 ARRAY_SIZE(dell_wmi_keymap_type_0011) +
539 sizeof(struct key_entry), GFP_KERNEL);
541 kfree(dmi_results.keymap);
546 /* Append table with events of type 0x0010 which comes from DMI */
547 for (i = 0; i < dmi_results.keymap_size; i++) {
548 keymap[pos] = dmi_results.keymap[i];
549 keymap[pos].code |= (0x0010 << 16);
553 kfree(dmi_results.keymap);
555 /* Append table with extra events of type 0x0010 which are not in DMI */
556 for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0010); i++) {
557 const struct key_entry *entry = &dell_wmi_keymap_type_0010[i];
560 * Check if we've already found this scancode. This takes
561 * quadratic time, but it doesn't matter unless the list
562 * of extra keys gets very long.
564 if (dmi_results.keymap_size &&
565 have_scancode(entry->code | (0x0010 << 16),
566 keymap, dmi_results.keymap_size)
570 keymap[pos] = *entry;
571 keymap[pos].code |= (0x0010 << 16);
575 /* Append table with events of type 0x0011 */
576 for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0011); i++) {
577 keymap[pos] = dell_wmi_keymap_type_0011[i];
578 keymap[pos].code |= (0x0011 << 16);
583 * Now append also table with "legacy" events of type 0x0000. Some of
584 * them are reported also on laptops which have scancodes in DMI.
586 for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0000); i++) {
587 keymap[pos] = dell_wmi_keymap_type_0000[i];
591 keymap[pos].type = KE_END;
593 err = sparse_keymap_setup(priv->input_dev, keymap, NULL);
595 * Sparse keymap library makes a copy of keymap so we don't need the
596 * original one that was allocated.
602 err = input_register_device(priv->input_dev);
609 input_free_device(priv->input_dev);
613 static void dell_wmi_input_destroy(struct wmi_device *wdev)
615 struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
617 input_unregister_device(priv->input_dev);
621 * According to Dell SMBIOS documentation:
623 * 17 3 Application Program Registration
625 * cbArg1 Application ID 1 = 0x00010000
626 * cbArg2 Application ID 2
627 * QUICKSET/DCP = 0x51534554 "QSET"
628 * ALS Driver = 0x416c7353 "AlsS"
629 * Latitude ON = 0x4c6f6e52 "LonR"
630 * cbArg3 Application version or revision number
631 * cbArg4 0 = Unregister application
632 * 1 = Register application
633 * cbRes1 Standard return codes (0, -1, -2)
636 static int dell_wmi_events_set_enabled(bool enable)
638 struct calling_interface_buffer *buffer;
641 buffer = kzalloc(sizeof(struct calling_interface_buffer), GFP_KERNEL);
642 buffer->cmd_class = CLASS_INFO;
643 buffer->cmd_select = SELECT_APP_REGISTRATION;
644 buffer->input[0] = 0x10000;
645 buffer->input[1] = 0x51534554;
646 buffer->input[3] = enable;
647 ret = dell_smbios_call(buffer);
649 ret = buffer->output[0];
652 return dell_smbios_error(ret);
655 static int dell_wmi_probe(struct wmi_device *wdev)
657 struct dell_wmi_priv *priv;
660 ret = dell_wmi_get_descriptor_valid();
665 &wdev->dev, sizeof(struct dell_wmi_priv), GFP_KERNEL);
668 dev_set_drvdata(&wdev->dev, priv);
670 if (!dell_wmi_get_interface_version(&priv->interface_version))
671 return -EPROBE_DEFER;
673 return dell_wmi_input_setup(wdev);
676 static int dell_wmi_remove(struct wmi_device *wdev)
678 dell_wmi_input_destroy(wdev);
681 static const struct wmi_device_id dell_wmi_id_table[] = {
682 { .guid_string = DELL_EVENT_GUID },
686 static struct wmi_driver dell_wmi_driver = {
690 .id_table = dell_wmi_id_table,
691 .probe = dell_wmi_probe,
692 .remove = dell_wmi_remove,
693 .notify = dell_wmi_notify,
696 static int __init dell_wmi_init(void)
700 dmi_check_system(dell_wmi_smbios_list);
702 if (wmi_requires_smbios_request) {
703 err = dell_wmi_events_set_enabled(true);
705 pr_err("Failed to enable WMI events\n");
710 return wmi_driver_register(&dell_wmi_driver);
712 module_init(dell_wmi_init);
714 static void __exit dell_wmi_exit(void)
716 if (wmi_requires_smbios_request)
717 dell_wmi_events_set_enabled(false);
719 wmi_driver_unregister(&dell_wmi_driver);
721 module_exit(dell_wmi_exit);