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