]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/platform/x86/dell-wmi.c
Merge remote-tracking branches 'asoc/topic/sgtl5000', 'asoc/topic/simple', 'asoc...
[mirror_ubuntu-zesty-kernel.git] / drivers / platform / x86 / dell-wmi.c
CommitLineData
0b3f6109
MG
1/*
2 * Dell WMI hotkeys
3 *
4 * Copyright (C) 2008 Red Hat <mjg@redhat.com>
595773a4 5 * Copyright (C) 2014-2015 Pali Rohár <pali.rohar@gmail.com>
0b3f6109
MG
6 *
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>
11 *
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.
16 *
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.
21 *
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
25 */
26
eb889524
JP
27#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
28
0b3f6109
MG
29#include <linux/kernel.h>
30#include <linux/module.h>
31#include <linux/init.h>
5a0e3ad6 32#include <linux/slab.h>
0b3f6109
MG
33#include <linux/types.h>
34#include <linux/input.h>
890a7c8e 35#include <linux/input/sparse-keymap.h>
0b3f6109
MG
36#include <linux/acpi.h>
37#include <linux/string.h>
5ea25597 38#include <linux/dmi.h>
18bd7696 39#include <acpi/video.h>
e09c4d5b 40#include "dell-smbios.h"
0b3f6109
MG
41
42MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");
595773a4 43MODULE_AUTHOR("Pali Rohár <pali.rohar@gmail.com>");
0b3f6109
MG
44MODULE_DESCRIPTION("Dell laptop WMI hotkeys driver");
45MODULE_LICENSE("GPL");
46
47#define DELL_EVENT_GUID "9DBB5994-A997-11DA-B012-B622A1EF5492"
595773a4 48#define DELL_DESCRIPTOR_GUID "8D9DDCBC-A997-11DA-B012-B622A1EF5492"
0b3f6109 49
595773a4 50static u32 dell_wmi_interface_version;
e09c4d5b 51static bool wmi_requires_smbios_request;
0b3f6109
MG
52
53MODULE_ALIAS("wmi:"DELL_EVENT_GUID);
595773a4 54MODULE_ALIAS("wmi:"DELL_DESCRIPTOR_GUID);
0b3f6109 55
e09c4d5b
MK
56static int __init dmi_matched(const struct dmi_system_id *dmi)
57{
58 wmi_requires_smbios_request = 1;
59 return 1;
60}
61
62static const struct dmi_system_id dell_wmi_smbios_list[] __initconst = {
aaf3a5e7
MK
63 {
64 .callback = dmi_matched,
65 .ident = "Dell Inspiron M5110",
66 .matches = {
67 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
68 DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron M5110"),
69 },
70 },
e09c4d5b
MK
71 {
72 .callback = dmi_matched,
73 .ident = "Dell Vostro V131",
74 .matches = {
75 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
76 DMI_MATCH(DMI_PRODUCT_NAME, "Vostro V131"),
77 },
78 },
79 { }
80};
81
5cab0098 82/*
e075b3c8
PR
83 * Keymap for WMI events of type 0x0000
84 *
5cab0098
ML
85 * Certain keys are flagged as KE_IGNORE. All of these are either
86 * notifications (rather than requests for change) or are also sent
87 * via the keyboard controller so should not be sent again.
88 */
e075b3c8 89static const struct key_entry dell_wmi_keymap_type_0000[] __initconst = {
f1566f0d
SF
90 { KE_IGNORE, 0x003a, { KEY_CAPSLOCK } },
91
6a4d260a
PR
92 /* Key code is followed by brightness level */
93 { KE_KEY, 0xe005, { KEY_BRIGHTNESSDOWN } },
94 { KE_KEY, 0xe006, { KEY_BRIGHTNESSUP } },
5cab0098
ML
95
96 /* Battery health status button */
6a4d260a 97 { KE_KEY, 0xe007, { KEY_BATTERY } },
5cab0098 98
6a4d260a 99 /* Radio devices state change, key code is followed by other values */
8f8d75eb 100 { KE_IGNORE, 0xe008, { KEY_RFKILL } },
5cab0098 101
6a4d260a
PR
102 { KE_KEY, 0xe009, { KEY_EJECTCD } },
103
104 /* Key code is followed by: next, active and attached devices */
105 { KE_KEY, 0xe00b, { KEY_SWITCHVIDEOMODE } },
5cab0098 106
6a4d260a 107 /* Key code is followed by keyboard illumination level */
890a7c8e 108 { KE_IGNORE, 0xe00c, { KEY_KBDILLUMTOGGLE } },
5cab0098
ML
109
110 /* BIOS error detected */
890a7c8e 111 { KE_IGNORE, 0xe00d, { KEY_RESERVED } },
5cab0098 112
65a97a67
PR
113 /* Battery was removed or inserted */
114 { KE_IGNORE, 0xe00e, { KEY_RESERVED } },
3237a861 115
5cab0098 116 /* Wifi Catcher */
6a4d260a 117 { KE_KEY, 0xe011, { KEY_PROG2 } },
5cab0098
ML
118
119 /* Ambient light sensor toggle */
890a7c8e
DT
120 { KE_IGNORE, 0xe013, { KEY_RESERVED } },
121
122 { KE_IGNORE, 0xe020, { KEY_MUTE } },
f1566f0d 123
3237a861
PR
124 /* Unknown, defined in ACPI DSDT */
125 /* { KE_IGNORE, 0xe023, { KEY_RESERVED } }, */
126
127 /* Untested, Dell Instant Launch key on Inspiron 7520 */
128 /* { KE_IGNORE, 0xe024, { KEY_RESERVED } }, */
129
aaf3a5e7 130 /* Dell Instant Launch key */
6a4d260a 131 { KE_KEY, 0xe025, { KEY_PROG4 } },
aaf3a5e7
MK
132
133 /* Audio panel key */
f1566f0d
SF
134 { KE_IGNORE, 0xe026, { KEY_RESERVED } },
135
ab9bb11c
AH
136 /* LCD Display On/Off Control key */
137 { KE_KEY, 0xe027, { KEY_DISPLAYTOGGLE } },
138
3237a861
PR
139 /* Untested, Multimedia key on Dell Vostro 3560 */
140 /* { KE_IGNORE, 0xe028, { KEY_RESERVED } }, */
141
6a4d260a
PR
142 /* Dell Instant Launch key */
143 { KE_KEY, 0xe029, { KEY_PROG4 } },
144
3237a861
PR
145 /* Untested, Windows Mobility Center button on Inspiron 7520 */
146 /* { KE_IGNORE, 0xe02a, { KEY_RESERVED } }, */
147
148 /* Unknown, defined in ACPI DSDT */
149 /* { KE_IGNORE, 0xe02b, { KEY_RESERVED } }, */
150
151 /* Untested, Dell Audio With Preset Switch button on Inspiron 7520 */
152 /* { KE_IGNORE, 0xe02c, { KEY_RESERVED } }, */
153
890a7c8e
DT
154 { KE_IGNORE, 0xe02e, { KEY_VOLUMEDOWN } },
155 { KE_IGNORE, 0xe030, { KEY_VOLUMEUP } },
156 { KE_IGNORE, 0xe033, { KEY_KBDILLUMUP } },
157 { KE_IGNORE, 0xe034, { KEY_KBDILLUMDOWN } },
158 { KE_IGNORE, 0xe03a, { KEY_CAPSLOCK } },
3de59bcd 159
3237a861
PR
160 /* NIC Link is Up */
161 { KE_IGNORE, 0xe043, { KEY_RESERVED } },
162
163 /* NIC Link is Down */
164 { KE_IGNORE, 0xe044, { KEY_RESERVED } },
165
3de59bcd
PR
166 /*
167 * This entry is very suspicious!
168 * Originally Matthew Garrett created this dell-wmi driver specially for
169 * "button with a picture of a battery" which has event code 0xe045.
170 * Later Mario Limonciello from Dell told us that event code 0xe045 is
171 * reported by Num Lock and should be ignored because key is send also
172 * by keyboard controller.
173 * So for now we will ignore this event to prevent potential double
174 * Num Lock key press.
175 */
890a7c8e 176 { KE_IGNORE, 0xe045, { KEY_NUMLOCK } },
3de59bcd 177
3237a861 178 /* Scroll lock and also going to tablet mode on portable devices */
890a7c8e 179 { KE_IGNORE, 0xe046, { KEY_SCROLLLOCK } },
3237a861
PR
180
181 /* Untested, going from tablet mode on portable devices */
182 /* { KE_IGNORE, 0xe047, { KEY_RESERVED } }, */
183
184 /* Dell Support Center key */
185 { KE_IGNORE, 0xe06e, { KEY_RESERVED } },
186
f1566f0d
SF
187 { KE_IGNORE, 0xe0f7, { KEY_MUTE } },
188 { KE_IGNORE, 0xe0f8, { KEY_VOLUMEDOWN } },
189 { KE_IGNORE, 0xe0f9, { KEY_VOLUMEUP } },
0b3f6109
MG
190};
191
890a7c8e 192struct dell_bios_keymap_entry {
5ea25597
RK
193 u16 scancode;
194 u16 keycode;
195};
196
890a7c8e 197struct dell_bios_hotkey_table {
5ea25597 198 struct dmi_header header;
890a7c8e 199 struct dell_bios_keymap_entry keymap[];
5ea25597
RK
200
201};
202
18b6f80f
AL
203struct dell_dmi_results {
204 int err;
e075b3c8 205 int keymap_size;
18b6f80f
AL
206 struct key_entry *keymap;
207};
5ea25597 208
cbc61f11 209/* Uninitialized entries here are KEY_RESERVED == 0. */
890a7c8e 210static const u16 bios_to_linux_keycode[256] __initconst = {
394cb778
AL
211 [0] = KEY_MEDIA,
212 [1] = KEY_NEXTSONG,
213 [2] = KEY_PLAYPAUSE,
214 [3] = KEY_PREVIOUSSONG,
215 [4] = KEY_STOPCD,
216 [5] = KEY_UNKNOWN,
217 [6] = KEY_UNKNOWN,
218 [7] = KEY_UNKNOWN,
219 [8] = KEY_WWW,
220 [9] = KEY_UNKNOWN,
221 [10] = KEY_VOLUMEDOWN,
222 [11] = KEY_MUTE,
223 [12] = KEY_VOLUMEUP,
224 [13] = KEY_UNKNOWN,
225 [14] = KEY_BATTERY,
226 [15] = KEY_EJECTCD,
227 [16] = KEY_UNKNOWN,
228 [17] = KEY_SLEEP,
229 [18] = KEY_PROG1,
230 [19] = KEY_BRIGHTNESSDOWN,
231 [20] = KEY_BRIGHTNESSUP,
232 [21] = KEY_UNKNOWN,
233 [22] = KEY_KBDILLUMTOGGLE,
234 [23] = KEY_UNKNOWN,
235 [24] = KEY_SWITCHVIDEOMODE,
236 [25] = KEY_UNKNOWN,
237 [26] = KEY_UNKNOWN,
238 [27] = KEY_SWITCHVIDEOMODE,
239 [28] = KEY_UNKNOWN,
240 [29] = KEY_UNKNOWN,
241 [30] = KEY_PROG2,
242 [31] = KEY_UNKNOWN,
243 [32] = KEY_UNKNOWN,
244 [33] = KEY_UNKNOWN,
245 [34] = KEY_UNKNOWN,
246 [35] = KEY_UNKNOWN,
247 [36] = KEY_UNKNOWN,
248 [37] = KEY_UNKNOWN,
249 [38] = KEY_MICMUTE,
250 [255] = KEY_PROG3,
5ea25597
RK
251};
252
a464afb9 253/*
e075b3c8
PR
254 * Keymap for WMI events of type 0x0010
255 *
a464afb9
AL
256 * These are applied if the 0xB2 DMI hotkey table is present and doesn't
257 * override them.
258 */
e075b3c8 259static const struct key_entry dell_wmi_keymap_type_0010[] __initconst = {
a464afb9
AL
260 /* Fn-lock */
261 { KE_IGNORE, 0x151, { KEY_RESERVED } },
262
263 /* Change keyboard illumination */
264 { KE_IGNORE, 0x152, { KEY_KBDILLUMTOGGLE } },
265
266 /*
267 * Radio disable (notify only -- there is no model for which the
268 * WMI event is supposed to trigger an action).
269 */
270 { KE_IGNORE, 0x153, { KEY_RFKILL } },
271
272 /* RGB keyboard backlight control */
273 { KE_IGNORE, 0x154, { KEY_RESERVED } },
274
275 /* Stealth mode toggle */
276 { KE_IGNORE, 0x155, { KEY_RESERVED } },
277};
278
e075b3c8
PR
279/*
280 * Keymap for WMI events of type 0x0011
281 */
282static const struct key_entry dell_wmi_keymap_type_0011[] __initconst = {
283 /* Battery unplugged */
284 { KE_IGNORE, 0xfff0, { KEY_RESERVED } },
285
286 /* Battery inserted */
287 { KE_IGNORE, 0xfff1, { KEY_RESERVED } },
288
289 /* Keyboard backlight level changed */
290 { KE_IGNORE, 0x01e1, { KEY_RESERVED } },
291 { KE_IGNORE, 0x02ea, { KEY_RESERVED } },
292 { KE_IGNORE, 0x02eb, { KEY_RESERVED } },
293 { KE_IGNORE, 0x02ec, { KEY_RESERVED } },
294 { KE_IGNORE, 0x02f6, { KEY_RESERVED } },
295};
296
0b3f6109
MG
297static struct input_dev *dell_wmi_input_dev;
298
e075b3c8 299static void dell_wmi_process_key(int type, int code)
83fc44c3
PR
300{
301 const struct key_entry *key;
302
303 key = sparse_keymap_entry_from_scancode(dell_wmi_input_dev,
e075b3c8 304 (type << 16) | code);
83fc44c3 305 if (!key) {
e075b3c8
PR
306 pr_info("Unknown key with type 0x%04x and code 0x%04x pressed\n",
307 type, code);
83fc44c3
PR
308 return;
309 }
310
e075b3c8 311 pr_debug("Key with type 0x%04x and code 0x%04x pressed\n", type, code);
83fc44c3
PR
312
313 /* Don't report brightness notifications that will also come via ACPI */
314 if ((key->keycode == KEY_BRIGHTNESSUP ||
61679c72
HG
315 key->keycode == KEY_BRIGHTNESSDOWN) &&
316 acpi_video_handles_brightness_key_presses())
83fc44c3
PR
317 return;
318
e075b3c8 319 if (type == 0x0000 && code == 0xe025 && !wmi_requires_smbios_request)
13f5059a
MK
320 return;
321
83fc44c3
PR
322 sparse_keymap_report_entry(dell_wmi_input_dev, key, 1, true);
323}
324
0b3f6109
MG
325static void dell_wmi_notify(u32 value, void *context)
326{
327 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
0b3f6109 328 union acpi_object *obj;
fda11e61 329 acpi_status status;
83fc44c3
PR
330 acpi_size buffer_size;
331 u16 *buffer_entry, *buffer_end;
332 int len, i;
0b3f6109 333
fda11e61
LB
334 status = wmi_get_event_data(value, &response);
335 if (status != AE_OK) {
83fc44c3 336 pr_warn("bad event status 0x%x\n", status);
fda11e61
LB
337 return;
338 }
0b3f6109
MG
339
340 obj = (union acpi_object *)response.pointer;
83fc44c3
PR
341 if (!obj) {
342 pr_warn("no response\n");
343 return;
344 }
0b3f6109 345
83fc44c3
PR
346 if (obj->type != ACPI_TYPE_BUFFER) {
347 pr_warn("bad response type %x\n", obj->type);
348 kfree(obj);
349 return;
350 }
351
352 pr_debug("Received WMI event (%*ph)\n",
353 obj->buffer.length, obj->buffer.pointer);
5ea25597 354
83fc44c3
PR
355 buffer_entry = (u16 *)obj->buffer.pointer;
356 buffer_size = obj->buffer.length/2;
83fc44c3
PR
357 buffer_end = buffer_entry + buffer_size;
358
481fe5be
PR
359 /*
360 * BIOS/ACPI on devices with WMI interface version 0 does not clear
361 * buffer before filling it. So next time when BIOS/ACPI send WMI event
362 * which is smaller as previous then it contains garbage in buffer from
363 * previous event.
364 *
365 * BIOS/ACPI on devices with WMI interface version 1 clears buffer and
366 * sometimes send more events in buffer at one call.
367 *
368 * So to prevent reading garbage from buffer we will process only first
369 * one event on devices with WMI interface version 0.
370 */
371 if (dell_wmi_interface_version == 0 && buffer_entry < buffer_end)
372 if (buffer_end > buffer_entry + buffer_entry[0] + 1)
373 buffer_end = buffer_entry + buffer_entry[0] + 1;
374
83fc44c3
PR
375 while (buffer_entry < buffer_end) {
376
377 len = buffer_entry[0];
378 if (len == 0)
379 break;
380
381 len++;
382
383 if (buffer_entry + len > buffer_end) {
384 pr_warn("Invalid length of WMI event\n");
385 break;
a666b6ff 386 }
5ea25597 387
83fc44c3
PR
388 pr_debug("Process buffer (%*ph)\n", len*2, buffer_entry);
389
390 switch (buffer_entry[1]) {
e075b3c8
PR
391 case 0x0000: /* One key pressed or event occurred */
392 if (len > 2)
393 dell_wmi_process_key(0x0000, buffer_entry[2]);
394 /* Other entries could contain additional information */
83fc44c3 395 break;
e075b3c8
PR
396 case 0x0010: /* Sequence of keys pressed */
397 case 0x0011: /* Sequence of events occurred */
83fc44c3 398 for (i = 2; i < len; ++i)
e075b3c8
PR
399 dell_wmi_process_key(buffer_entry[1],
400 buffer_entry[i]);
83fc44c3 401 break;
e075b3c8 402 default: /* Unknown event */
83fc44c3
PR
403 pr_info("Unknown WMI event type 0x%x\n",
404 (int)buffer_entry[1]);
405 break;
5ea25597 406 }
83fc44c3
PR
407
408 buffer_entry += len;
409
0b3f6109 410 }
83fc44c3 411
3e9b988e 412 kfree(obj);
0b3f6109
MG
413}
414
a464afb9
AL
415static bool have_scancode(u32 scancode, const struct key_entry *keymap, int len)
416{
417 int i;
418
419 for (i = 0; i < len; i++)
420 if (keymap[i].code == scancode)
421 return true;
422
423 return false;
424}
425
18b6f80f
AL
426static void __init handle_dmi_entry(const struct dmi_header *dm,
427 void *opaque)
a464afb9 428
5ea25597 429{
18b6f80f
AL
430 struct dell_dmi_results *results = opaque;
431 struct dell_bios_hotkey_table *table;
a464afb9 432 int hotkey_num, i, pos = 0;
890a7c8e 433 struct key_entry *keymap;
18b6f80f
AL
434
435 if (results->err || results->keymap)
436 return; /* We already found the hotkey table. */
437
b13de701 438 if (dm->type != 0xb2)
18b6f80f
AL
439 return;
440
441 table = container_of(dm, struct dell_bios_hotkey_table, header);
442
b13de701
AL
443 hotkey_num = (table->header.length -
444 sizeof(struct dell_bios_hotkey_table)) /
18b6f80f 445 sizeof(struct dell_bios_keymap_entry);
b13de701
AL
446 if (hotkey_num < 1) {
447 /*
448 * Historically, dell-wmi would ignore a DMI entry of
449 * fewer than 7 bytes. Sizes between 4 and 8 bytes are
450 * nonsensical (both the header and all entries are 4
451 * bytes), so we approximate the old behavior by
452 * ignoring tables with fewer than one entry.
453 */
454 return;
455 }
5ea25597 456
e075b3c8 457 keymap = kcalloc(hotkey_num, sizeof(struct key_entry), GFP_KERNEL);
18b6f80f
AL
458 if (!keymap) {
459 results->err = -ENOMEM;
460 return;
461 }
5ea25597
RK
462
463 for (i = 0; i < hotkey_num; i++) {
890a7c8e 464 const struct dell_bios_keymap_entry *bios_entry =
18b6f80f 465 &table->keymap[i];
cbc61f11
AL
466
467 /* Uninitialized entries are 0 aka KEY_RESERVED. */
468 u16 keycode = (bios_entry->keycode <
469 ARRAY_SIZE(bios_to_linux_keycode)) ?
470 bios_to_linux_keycode[bios_entry->keycode] :
471 KEY_RESERVED;
472
473 /*
474 * Log if we find an entry in the DMI table that we don't
475 * understand. If this happens, we should figure out what
476 * the entry means and add it to bios_to_linux_keycode.
477 */
478 if (keycode == KEY_RESERVED) {
479 pr_info("firmware scancode 0x%x maps to unrecognized keycode 0x%x\n",
480 bios_entry->scancode, bios_entry->keycode);
481 continue;
482 }
8cb8e63b
GM
483
484 if (keycode == KEY_KBDILLUMTOGGLE)
a464afb9 485 keymap[pos].type = KE_IGNORE;
8cb8e63b 486 else
a464afb9
AL
487 keymap[pos].type = KE_KEY;
488 keymap[pos].code = bios_entry->scancode;
489 keymap[pos].keycode = keycode;
490
491 pos++;
492 }
493
18b6f80f 494 results->keymap = keymap;
e075b3c8 495 results->keymap_size = pos;
5ea25597
RK
496}
497
0b3f6109
MG
498static int __init dell_wmi_input_setup(void)
499{
18b6f80f 500 struct dell_dmi_results dmi_results = {};
e075b3c8
PR
501 struct key_entry *keymap;
502 int err, i, pos = 0;
0b3f6109
MG
503
504 dell_wmi_input_dev = input_allocate_device();
0b3f6109
MG
505 if (!dell_wmi_input_dev)
506 return -ENOMEM;
507
508 dell_wmi_input_dev->name = "Dell WMI hotkeys";
509 dell_wmi_input_dev->phys = "wmi/input0";
510 dell_wmi_input_dev->id.bustype = BUS_HOST;
890a7c8e 511
18b6f80f
AL
512 if (dmi_walk(handle_dmi_entry, &dmi_results)) {
513 /*
514 * Historically, dell-wmi ignored dmi_walk errors. A failure
515 * is certainly surprising, but it probably just indicates
516 * a very old laptop.
517 */
518 pr_warn("no DMI; using the old-style hotkey interface\n");
519 }
520
521 if (dmi_results.err) {
522 err = dmi_results.err;
523 goto err_free_dev;
524 }
525
e075b3c8
PR
526 keymap = kcalloc(dmi_results.keymap_size +
527 ARRAY_SIZE(dell_wmi_keymap_type_0000) +
528 ARRAY_SIZE(dell_wmi_keymap_type_0010) +
529 ARRAY_SIZE(dell_wmi_keymap_type_0011) +
530 1,
531 sizeof(struct key_entry), GFP_KERNEL);
532 if (!keymap) {
533 kfree(dmi_results.keymap);
534 err = -ENOMEM;
535 goto err_free_dev;
536 }
0b3f6109 537
e075b3c8
PR
538 /* Append table with events of type 0x0010 which comes from DMI */
539 for (i = 0; i < dmi_results.keymap_size; i++) {
540 keymap[pos] = dmi_results.keymap[i];
541 keymap[pos].code |= (0x0010 << 16);
542 pos++;
543 }
544
545 kfree(dmi_results.keymap);
546
547 /* Append table with extra events of type 0x0010 which are not in DMI */
548 for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0010); i++) {
549 const struct key_entry *entry = &dell_wmi_keymap_type_0010[i];
0b3f6109 550
890a7c8e 551 /*
e075b3c8
PR
552 * Check if we've already found this scancode. This takes
553 * quadratic time, but it doesn't matter unless the list
554 * of extra keys gets very long.
890a7c8e 555 */
e075b3c8
PR
556 if (dmi_results.keymap_size &&
557 have_scancode(entry->code | (0x0010 << 16),
558 keymap, dmi_results.keymap_size)
559 )
560 continue;
561
562 keymap[pos] = *entry;
563 keymap[pos].code |= (0x0010 << 16);
564 pos++;
565 }
566
567 /* Append table with events of type 0x0011 */
568 for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0011); i++) {
569 keymap[pos] = dell_wmi_keymap_type_0011[i];
570 keymap[pos].code |= (0x0011 << 16);
571 pos++;
0b3f6109 572 }
e075b3c8
PR
573
574 /*
575 * Now append also table with "legacy" events of type 0x0000. Some of
576 * them are reported also on laptops which have scancodes in DMI.
577 */
578 for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0000); i++) {
579 keymap[pos] = dell_wmi_keymap_type_0000[i];
580 pos++;
581 }
582
583 keymap[pos].type = KE_END;
584
585 err = sparse_keymap_setup(dell_wmi_input_dev, keymap, NULL);
586 /*
587 * Sparse keymap library makes a copy of keymap so we don't need the
588 * original one that was allocated.
589 */
590 kfree(keymap);
890a7c8e
DT
591 if (err)
592 goto err_free_dev;
593
594 err = input_register_device(dell_wmi_input_dev);
595 if (err)
596 goto err_free_keymap;
0b3f6109
MG
597
598 return 0;
890a7c8e
DT
599
600 err_free_keymap:
601 sparse_keymap_free(dell_wmi_input_dev);
602 err_free_dev:
603 input_free_device(dell_wmi_input_dev);
604 return err;
605}
606
607static void dell_wmi_input_destroy(void)
608{
609 sparse_keymap_free(dell_wmi_input_dev);
610 input_unregister_device(dell_wmi_input_dev);
611}
612
595773a4
PR
613/*
614 * Descriptor buffer is 128 byte long and contains:
615 *
616 * Name Offset Length Value
617 * Vendor Signature 0 4 "DELL"
618 * Object Signature 4 4 " WMI"
619 * WMI Interface Version 8 4 <version>
620 * WMI buffer length 12 4 4096
621 */
622static int __init dell_wmi_check_descriptor_buffer(void)
623{
624 struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL };
625 union acpi_object *obj;
626 acpi_status status;
627 u32 *buffer;
628
629 status = wmi_query_block(DELL_DESCRIPTOR_GUID, 0, &out);
630 if (ACPI_FAILURE(status)) {
631 pr_err("Cannot read Dell descriptor buffer - %d\n", status);
632 return status;
633 }
634
635 obj = (union acpi_object *)out.pointer;
636 if (!obj) {
637 pr_err("Dell descriptor buffer is empty\n");
638 return -EINVAL;
639 }
640
641 if (obj->type != ACPI_TYPE_BUFFER) {
642 pr_err("Cannot read Dell descriptor buffer\n");
643 kfree(obj);
644 return -EINVAL;
645 }
646
647 if (obj->buffer.length != 128) {
648 pr_err("Dell descriptor buffer has invalid length (%d)\n",
649 obj->buffer.length);
650 if (obj->buffer.length < 16) {
651 kfree(obj);
652 return -EINVAL;
653 }
654 }
655
656 buffer = (u32 *)obj->buffer.pointer;
657
658 if (buffer[0] != 0x4C4C4544 && buffer[1] != 0x494D5720)
659 pr_warn("Dell descriptor buffer has invalid signature (%*ph)\n",
660 8, buffer);
661
662 if (buffer[2] != 0 && buffer[2] != 1)
663 pr_warn("Dell descriptor buffer has unknown version (%d)\n",
664 buffer[2]);
665
666 if (buffer[3] != 4096)
667 pr_warn("Dell descriptor buffer has invalid buffer length (%d)\n",
668 buffer[3]);
669
670 dell_wmi_interface_version = buffer[2];
671
672 pr_info("Detected Dell WMI interface version %u\n",
673 dell_wmi_interface_version);
674
675 kfree(obj);
676 return 0;
677}
678
e09c4d5b
MK
679/*
680 * According to Dell SMBIOS documentation:
681 *
682 * 17 3 Application Program Registration
683 *
684 * cbArg1 Application ID 1 = 0x00010000
685 * cbArg2 Application ID 2
686 * QUICKSET/DCP = 0x51534554 "QSET"
687 * ALS Driver = 0x416c7353 "AlsS"
688 * Latitude ON = 0x4c6f6e52 "LonR"
689 * cbArg3 Application version or revision number
690 * cbArg4 0 = Unregister application
691 * 1 = Register application
692 * cbRes1 Standard return codes (0, -1, -2)
693 */
694
695static int dell_wmi_events_set_enabled(bool enable)
696{
697 struct calling_interface_buffer *buffer;
698 int ret;
699
700 buffer = dell_smbios_get_buffer();
701 buffer->input[0] = 0x10000;
702 buffer->input[1] = 0x51534554;
703 buffer->input[3] = enable;
704 dell_smbios_send_request(17, 3);
705 ret = buffer->output[0];
706 dell_smbios_release_buffer();
707
708 return dell_smbios_error(ret);
709}
710
0b3f6109
MG
711static int __init dell_wmi_init(void)
712{
713 int err;
abb631bf 714 acpi_status status;
0b3f6109 715
595773a4
PR
716 if (!wmi_has_guid(DELL_EVENT_GUID) ||
717 !wmi_has_guid(DELL_DESCRIPTOR_GUID)) {
718 pr_warn("Dell WMI GUID were not found\n");
1fdd407f
DT
719 return -ENODEV;
720 }
5ea25597 721
595773a4
PR
722 err = dell_wmi_check_descriptor_buffer();
723 if (err)
724 return err;
725
1fdd407f 726 err = dell_wmi_input_setup();
890a7c8e 727 if (err)
1fdd407f 728 return err;
5ea25597 729
abb631bf 730 status = wmi_install_notify_handler(DELL_EVENT_GUID,
1fdd407f 731 dell_wmi_notify, NULL);
abb631bf 732 if (ACPI_FAILURE(status)) {
890a7c8e 733 dell_wmi_input_destroy();
eb889524 734 pr_err("Unable to register notify handler - %d\n", status);
abb631bf 735 return -ENODEV;
1fdd407f 736 }
0b3f6109 737
e09c4d5b
MK
738 dmi_check_system(dell_wmi_smbios_list);
739
740 if (wmi_requires_smbios_request) {
741 err = dell_wmi_events_set_enabled(true);
742 if (err) {
743 pr_err("Failed to enable WMI events\n");
744 wmi_remove_notify_handler(DELL_EVENT_GUID);
745 dell_wmi_input_destroy();
746 return err;
747 }
748 }
749
0b3f6109
MG
750 return 0;
751}
890a7c8e 752module_init(dell_wmi_init);
0b3f6109
MG
753
754static void __exit dell_wmi_exit(void)
755{
e09c4d5b
MK
756 if (wmi_requires_smbios_request)
757 dell_wmi_events_set_enabled(false);
1fdd407f 758 wmi_remove_notify_handler(DELL_EVENT_GUID);
890a7c8e 759 dell_wmi_input_destroy();
0b3f6109 760}
0b3f6109 761module_exit(dell_wmi_exit);