7 * Portions based on wistron_btns.c:
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 <acpi/video.h>
40 #include "dell-smbios.h"
44 MODULE_DESCRIPTION("Dell laptop WMI hotkeys driver");
45 MODULE_LICENSE("GPL");
47 #define DELL_EVENT_GUID "9DBB5994-A997-11DA-B012-B622A1EF5492"
48 #define DELL_DESCRIPTOR_GUID "8D9DDCBC-A997-11DA-B012-B622A1EF5492"
50 static u32 dell_wmi_interface_version;
51 static bool wmi_requires_smbios_request;
53 MODULE_ALIAS("wmi:"DELL_EVENT_GUID);
54 MODULE_ALIAS("wmi:"DELL_DESCRIPTOR_GUID);
56 static int __init dmi_matched(const struct dmi_system_id *dmi)
58 wmi_requires_smbios_request = 1;
62 static const struct dmi_system_id dell_wmi_smbios_list[] __initconst = {
64 .callback = dmi_matched,
65 .ident = "Dell Inspiron M5110",
67 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
68 DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron M5110"),
72 .callback = dmi_matched,
73 .ident = "Dell Vostro V131",
75 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
76 DMI_MATCH(DMI_PRODUCT_NAME, "Vostro V131"),
83 * Certain keys are flagged as KE_IGNORE. All of these are either
84 * notifications (rather than requests for change) or are also sent
85 * via the keyboard controller so should not be sent again.
88 static const struct key_entry dell_wmi_legacy_keymap[] __initconst = {
89 { KE_IGNORE, 0x003a, { KEY_CAPSLOCK } },
91 { KE_KEY, 0xe045, { KEY_PROG1 } },
92 { KE_KEY, 0xe009, { KEY_EJECTCD } },
94 /* These also contain the brightness level at offset 6 */
95 { KE_KEY, 0xe006, { KEY_BRIGHTNESSUP } },
96 { KE_KEY, 0xe005, { KEY_BRIGHTNESSDOWN } },
98 /* Battery health status button */
99 { KE_KEY, 0xe007, { KEY_BATTERY } },
101 /* Radio devices state change */
102 { KE_IGNORE, 0xe008, { KEY_RFKILL } },
104 /* The next device is at offset 6, the active devices are at
105 offset 8 and the attached devices at offset 10 */
106 { KE_KEY, 0xe00b, { KEY_SWITCHVIDEOMODE } },
108 { KE_IGNORE, 0xe00c, { KEY_KBDILLUMTOGGLE } },
110 /* BIOS error detected */
111 { KE_IGNORE, 0xe00d, { KEY_RESERVED } },
114 { KE_KEY, 0xe011, {KEY_PROG2 } },
116 /* Ambient light sensor toggle */
117 { KE_IGNORE, 0xe013, { KEY_RESERVED } },
119 { KE_IGNORE, 0xe020, { KEY_MUTE } },
121 /* Dell Instant Launch key */
122 { KE_KEY, 0xe025, { KEY_PROG4 } },
123 { KE_KEY, 0xe029, { KEY_PROG4 } },
125 /* Audio panel key */
126 { KE_IGNORE, 0xe026, { KEY_RESERVED } },
128 { KE_IGNORE, 0xe02e, { KEY_VOLUMEDOWN } },
129 { KE_IGNORE, 0xe030, { KEY_VOLUMEUP } },
130 { KE_IGNORE, 0xe033, { KEY_KBDILLUMUP } },
131 { KE_IGNORE, 0xe034, { KEY_KBDILLUMDOWN } },
132 { KE_IGNORE, 0xe03a, { KEY_CAPSLOCK } },
133 { KE_IGNORE, 0xe045, { KEY_NUMLOCK } },
134 { KE_IGNORE, 0xe046, { KEY_SCROLLLOCK } },
135 { KE_IGNORE, 0xe0f7, { KEY_MUTE } },
136 { KE_IGNORE, 0xe0f8, { KEY_VOLUMEDOWN } },
137 { KE_IGNORE, 0xe0f9, { KEY_VOLUMEUP } },
141 static bool dell_new_hk_type;
143 struct dell_bios_keymap_entry {
148 struct dell_bios_hotkey_table {
149 struct dmi_header header;
150 struct dell_bios_keymap_entry keymap[];
154 struct dell_dmi_results {
156 struct key_entry *keymap;
159 /* Uninitialized entries here are KEY_RESERVED == 0. */
160 static const u16 bios_to_linux_keycode[256] __initconst = {
164 [3] = KEY_PREVIOUSSONG,
171 [10] = KEY_VOLUMEDOWN,
180 [19] = KEY_BRIGHTNESSDOWN,
181 [20] = KEY_BRIGHTNESSUP,
183 [22] = KEY_KBDILLUMTOGGLE,
185 [24] = KEY_SWITCHVIDEOMODE,
188 [27] = KEY_SWITCHVIDEOMODE,
204 * These are applied if the 0xB2 DMI hotkey table is present and doesn't
207 static const struct key_entry dell_wmi_extra_keymap[] __initconst = {
209 { KE_IGNORE, 0x151, { KEY_RESERVED } },
211 /* Change keyboard illumination */
212 { KE_IGNORE, 0x152, { KEY_KBDILLUMTOGGLE } },
215 * Radio disable (notify only -- there is no model for which the
216 * WMI event is supposed to trigger an action).
218 { KE_IGNORE, 0x153, { KEY_RFKILL } },
220 /* RGB keyboard backlight control */
221 { KE_IGNORE, 0x154, { KEY_RESERVED } },
223 /* Stealth mode toggle */
224 { KE_IGNORE, 0x155, { KEY_RESERVED } },
227 static struct input_dev *dell_wmi_input_dev;
229 static void dell_wmi_process_key(int reported_key)
231 const struct key_entry *key;
233 key = sparse_keymap_entry_from_scancode(dell_wmi_input_dev,
236 pr_info("Unknown key with scancode 0x%x pressed\n",
241 pr_debug("Key %x pressed\n", reported_key);
243 /* Don't report brightness notifications that will also come via ACPI */
244 if ((key->keycode == KEY_BRIGHTNESSUP ||
245 key->keycode == KEY_BRIGHTNESSDOWN) &&
246 acpi_video_handles_brightness_key_presses())
249 if (reported_key == 0xe025 && !wmi_requires_smbios_request)
252 sparse_keymap_report_entry(dell_wmi_input_dev, key, 1, true);
255 static void dell_wmi_notify(u32 value, void *context)
257 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
258 union acpi_object *obj;
260 acpi_size buffer_size;
261 u16 *buffer_entry, *buffer_end;
264 status = wmi_get_event_data(value, &response);
265 if (status != AE_OK) {
266 pr_warn("bad event status 0x%x\n", status);
270 obj = (union acpi_object *)response.pointer;
272 pr_warn("no response\n");
276 if (obj->type != ACPI_TYPE_BUFFER) {
277 pr_warn("bad response type %x\n", obj->type);
282 pr_debug("Received WMI event (%*ph)\n",
283 obj->buffer.length, obj->buffer.pointer);
285 buffer_entry = (u16 *)obj->buffer.pointer;
286 buffer_size = obj->buffer.length/2;
288 if (!dell_new_hk_type) {
289 if (buffer_size >= 3 && buffer_entry[1] == 0x0)
290 dell_wmi_process_key(buffer_entry[2]);
291 else if (buffer_size >= 2)
292 dell_wmi_process_key(buffer_entry[1]);
294 pr_info("Received unknown WMI event\n");
299 buffer_end = buffer_entry + buffer_size;
302 * BIOS/ACPI on devices with WMI interface version 0 does not clear
303 * buffer before filling it. So next time when BIOS/ACPI send WMI event
304 * which is smaller as previous then it contains garbage in buffer from
307 * BIOS/ACPI on devices with WMI interface version 1 clears buffer and
308 * sometimes send more events in buffer at one call.
310 * So to prevent reading garbage from buffer we will process only first
311 * one event on devices with WMI interface version 0.
313 if (dell_wmi_interface_version == 0 && buffer_entry < buffer_end)
314 if (buffer_end > buffer_entry + buffer_entry[0] + 1)
315 buffer_end = buffer_entry + buffer_entry[0] + 1;
317 while (buffer_entry < buffer_end) {
319 len = buffer_entry[0];
325 if (buffer_entry + len > buffer_end) {
326 pr_warn("Invalid length of WMI event\n");
330 pr_debug("Process buffer (%*ph)\n", len*2, buffer_entry);
332 switch (buffer_entry[1]) {
334 for (i = 2; i < len; ++i) {
335 switch (buffer_entry[i]) {
338 pr_debug("NIC Link is Up\n");
341 /* NIC Link is Down */
342 pr_debug("NIC Link is Down\n");
345 /* Unknown event but defined in DSDT */
348 pr_info("Unknown WMI event type 0x00: "
349 "0x%x\n", (int)buffer_entry[i]);
356 for (i = 2; i < len; ++i)
357 dell_wmi_process_key(buffer_entry[i]);
360 for (i = 2; i < len; ++i) {
361 switch (buffer_entry[i]) {
363 /* Battery unplugged */
364 pr_debug("Battery unplugged\n");
367 /* Battery inserted */
368 pr_debug("Battery inserted\n");
375 /* Keyboard backlight level changed */
376 pr_debug("Keyboard backlight level "
381 pr_info("Unknown WMI event type 0x11: "
382 "0x%x\n", (int)buffer_entry[i]);
389 pr_info("Unknown WMI event type 0x%x\n",
390 (int)buffer_entry[1]);
401 static bool have_scancode(u32 scancode, const struct key_entry *keymap, int len)
405 for (i = 0; i < len; i++)
406 if (keymap[i].code == scancode)
412 static void __init handle_dmi_entry(const struct dmi_header *dm,
417 struct dell_dmi_results *results = opaque;
418 struct dell_bios_hotkey_table *table;
419 int hotkey_num, i, pos = 0;
420 struct key_entry *keymap;
423 if (results->err || results->keymap)
424 return; /* We already found the hotkey table. */
426 if (dm->type != 0xb2)
429 table = container_of(dm, struct dell_bios_hotkey_table, header);
431 hotkey_num = (table->header.length -
432 sizeof(struct dell_bios_hotkey_table)) /
433 sizeof(struct dell_bios_keymap_entry);
434 if (hotkey_num < 1) {
436 * Historically, dell-wmi would ignore a DMI entry of
437 * fewer than 7 bytes. Sizes between 4 and 8 bytes are
438 * nonsensical (both the header and all entries are 4
439 * bytes), so we approximate the old behavior by
440 * ignoring tables with fewer than one entry.
445 keymap = kcalloc(hotkey_num + ARRAY_SIZE(dell_wmi_extra_keymap) + 1,
446 sizeof(struct key_entry), GFP_KERNEL);
448 results->err = -ENOMEM;
452 for (i = 0; i < hotkey_num; i++) {
453 const struct dell_bios_keymap_entry *bios_entry =
456 /* Uninitialized entries are 0 aka KEY_RESERVED. */
457 u16 keycode = (bios_entry->keycode <
458 ARRAY_SIZE(bios_to_linux_keycode)) ?
459 bios_to_linux_keycode[bios_entry->keycode] :
463 * Log if we find an entry in the DMI table that we don't
464 * understand. If this happens, we should figure out what
465 * the entry means and add it to bios_to_linux_keycode.
467 if (keycode == KEY_RESERVED) {
468 pr_info("firmware scancode 0x%x maps to unrecognized keycode 0x%x\n",
469 bios_entry->scancode, bios_entry->keycode);
473 if (keycode == KEY_KBDILLUMTOGGLE)
474 keymap[pos].type = KE_IGNORE;
476 keymap[pos].type = KE_KEY;
477 keymap[pos].code = bios_entry->scancode;
478 keymap[pos].keycode = keycode;
485 for (i = 0; i < ARRAY_SIZE(dell_wmi_extra_keymap); i++) {
486 const struct key_entry *entry = &dell_wmi_extra_keymap[i];
489 * Check if we've already found this scancode. This takes
490 * quadratic time, but it doesn't matter unless the list
491 * of extra keys gets very long.
493 if (!have_scancode(entry->code, keymap, num_bios_keys)) {
494 keymap[pos] = *entry;
499 keymap[pos].type = KE_END;
501 results->keymap = keymap;
504 static int __init dell_wmi_input_setup(void)
506 struct dell_dmi_results dmi_results = {};
509 dell_wmi_input_dev = input_allocate_device();
510 if (!dell_wmi_input_dev)
513 dell_wmi_input_dev->name = "Dell WMI hotkeys";
514 dell_wmi_input_dev->phys = "wmi/input0";
515 dell_wmi_input_dev->id.bustype = BUS_HOST;
517 if (dmi_walk(handle_dmi_entry, &dmi_results)) {
519 * Historically, dell-wmi ignored dmi_walk errors. A failure
520 * is certainly surprising, but it probably just indicates
523 pr_warn("no DMI; using the old-style hotkey interface\n");
526 if (dmi_results.err) {
527 err = dmi_results.err;
531 if (dmi_results.keymap) {
532 dell_new_hk_type = true;
534 err = sparse_keymap_setup(dell_wmi_input_dev,
535 dmi_results.keymap, NULL);
538 * Sparse keymap library makes a copy of keymap so we
539 * don't need the original one that was allocated.
541 kfree(dmi_results.keymap);
543 err = sparse_keymap_setup(dell_wmi_input_dev,
544 dell_wmi_legacy_keymap, NULL);
549 err = input_register_device(dell_wmi_input_dev);
551 goto err_free_keymap;
556 sparse_keymap_free(dell_wmi_input_dev);
558 input_free_device(dell_wmi_input_dev);
562 static void dell_wmi_input_destroy(void)
564 sparse_keymap_free(dell_wmi_input_dev);
565 input_unregister_device(dell_wmi_input_dev);
569 * Descriptor buffer is 128 byte long and contains:
571 * Name Offset Length Value
572 * Vendor Signature 0 4 "DELL"
573 * Object Signature 4 4 " WMI"
574 * WMI Interface Version 8 4 <version>
575 * WMI buffer length 12 4 4096
577 static int __init dell_wmi_check_descriptor_buffer(void)
579 struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL };
580 union acpi_object *obj;
584 status = wmi_query_block(DELL_DESCRIPTOR_GUID, 0, &out);
585 if (ACPI_FAILURE(status)) {
586 pr_err("Cannot read Dell descriptor buffer - %d\n", status);
590 obj = (union acpi_object *)out.pointer;
592 pr_err("Dell descriptor buffer is empty\n");
596 if (obj->type != ACPI_TYPE_BUFFER) {
597 pr_err("Cannot read Dell descriptor buffer\n");
602 if (obj->buffer.length != 128) {
603 pr_err("Dell descriptor buffer has invalid length (%d)\n",
605 if (obj->buffer.length < 16) {
611 buffer = (u32 *)obj->buffer.pointer;
613 if (buffer[0] != 0x4C4C4544 && buffer[1] != 0x494D5720)
614 pr_warn("Dell descriptor buffer has invalid signature (%*ph)\n",
617 if (buffer[2] != 0 && buffer[2] != 1)
618 pr_warn("Dell descriptor buffer has unknown version (%d)\n",
621 if (buffer[3] != 4096)
622 pr_warn("Dell descriptor buffer has invalid buffer length (%d)\n",
625 dell_wmi_interface_version = buffer[2];
627 pr_info("Detected Dell WMI interface version %u\n",
628 dell_wmi_interface_version);
635 * According to Dell SMBIOS documentation:
637 * 17 3 Application Program Registration
639 * cbArg1 Application ID 1 = 0x00010000
640 * cbArg2 Application ID 2
641 * QUICKSET/DCP = 0x51534554 "QSET"
642 * ALS Driver = 0x416c7353 "AlsS"
643 * Latitude ON = 0x4c6f6e52 "LonR"
644 * cbArg3 Application version or revision number
645 * cbArg4 0 = Unregister application
646 * 1 = Register application
647 * cbRes1 Standard return codes (0, -1, -2)
650 static int dell_wmi_events_set_enabled(bool enable)
652 struct calling_interface_buffer *buffer;
655 buffer = dell_smbios_get_buffer();
656 buffer->input[0] = 0x10000;
657 buffer->input[1] = 0x51534554;
658 buffer->input[3] = enable;
659 dell_smbios_send_request(17, 3);
660 ret = buffer->output[0];
661 dell_smbios_release_buffer();
663 return dell_smbios_error(ret);
666 static int __init dell_wmi_init(void)
671 if (!wmi_has_guid(DELL_EVENT_GUID) ||
672 !wmi_has_guid(DELL_DESCRIPTOR_GUID)) {
673 pr_warn("Dell WMI GUID were not found\n");
677 err = dell_wmi_check_descriptor_buffer();
681 err = dell_wmi_input_setup();
685 status = wmi_install_notify_handler(DELL_EVENT_GUID,
686 dell_wmi_notify, NULL);
687 if (ACPI_FAILURE(status)) {
688 dell_wmi_input_destroy();
689 pr_err("Unable to register notify handler - %d\n", status);
693 dmi_check_system(dell_wmi_smbios_list);
695 if (wmi_requires_smbios_request) {
696 err = dell_wmi_events_set_enabled(true);
698 pr_err("Failed to enable WMI events\n");
699 wmi_remove_notify_handler(DELL_EVENT_GUID);
700 dell_wmi_input_destroy();
707 module_init(dell_wmi_init);
709 static void __exit dell_wmi_exit(void)
711 if (wmi_requires_smbios_request)
712 dell_wmi_events_set_enabled(false);
713 wmi_remove_notify_handler(DELL_EVENT_GUID);
714 dell_wmi_input_destroy();
716 module_exit(dell_wmi_exit);