blob: 1f565fb6909884c2551dd588a24a78ef1c9dabfc [file] [log] [blame]
Thomas Gleixner1a59d1b82019-05-27 08:55:05 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Matthew Garrett0b3f6102009-01-09 20:17:11 +00002/*
3 * Dell WMI hotkeys
4 *
5 * Copyright (C) 2008 Red Hat <mjg@redhat.com>
Pali Rohár595773a42016-01-04 22:26:35 +01006 * Copyright (C) 2014-2015 Pali Rohár <pali.rohar@gmail.com>
Matthew Garrett0b3f6102009-01-09 20:17:11 +00007 *
8 * Portions based on wistron_btns.c:
9 * Copyright (C) 2005 Miloslav Trmac <mitr@volny.cz>
10 * Copyright (C) 2005 Bernhard Rosenkraenzer <bero@arklinux.org>
11 * Copyright (C) 2005 Dmitry Torokhov <dtor@mail.ru>
Matthew Garrett0b3f6102009-01-09 20:17:11 +000012 */
13
Joe Percheseb889522011-03-29 15:21:37 -070014#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15
Matthew Garrett0b3f6102009-01-09 20:17:11 +000016#include <linux/kernel.h>
17#include <linux/module.h>
18#include <linux/init.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090019#include <linux/slab.h>
Matthew Garrett0b3f6102009-01-09 20:17:11 +000020#include <linux/types.h>
21#include <linux/input.h>
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070022#include <linux/input/sparse-keymap.h>
Matthew Garrett0b3f6102009-01-09 20:17:11 +000023#include <linux/acpi.h>
24#include <linux/string.h>
Rezwanul Kabir5ea25592009-11-02 12:00:42 -050025#include <linux/dmi.h>
Andy Lutomirskibff589b2015-11-25 07:53:13 -080026#include <linux/wmi.h>
Hans de Goede18bd7692015-06-16 16:28:01 +020027#include <acpi/video.h>
Michał Kępieńe09c4d52016-03-04 14:09:08 +010028#include "dell-smbios.h"
Mario Limonciello92b8c542017-11-01 14:25:27 -050029#include "dell-wmi-descriptor.h"
Matthew Garrett0b3f6102009-01-09 20:17:11 +000030
31MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");
Pali Rohár595773a42016-01-04 22:26:35 +010032MODULE_AUTHOR("Pali Rohár <pali.rohar@gmail.com>");
Matthew Garrett0b3f6102009-01-09 20:17:11 +000033MODULE_DESCRIPTION("Dell laptop WMI hotkeys driver");
34MODULE_LICENSE("GPL");
35
36#define DELL_EVENT_GUID "9DBB5994-A997-11DA-B012-B622A1EF5492"
37
Michał Kępieńe09c4d52016-03-04 14:09:08 +010038static bool wmi_requires_smbios_request;
Matthew Garrett0b3f6102009-01-09 20:17:11 +000039
Andy Lutomirskibff589b2015-11-25 07:53:13 -080040struct dell_wmi_priv {
41 struct input_dev *input_dev;
Andy Lutomirski00ebbeb2017-08-01 08:37:27 -070042 u32 interface_version;
Andy Lutomirskibff589b2015-11-25 07:53:13 -080043};
44
Michał Kępieńe09c4d52016-03-04 14:09:08 +010045static int __init dmi_matched(const struct dmi_system_id *dmi)
46{
47 wmi_requires_smbios_request = 1;
48 return 1;
49}
50
51static const struct dmi_system_id dell_wmi_smbios_list[] __initconst = {
52 {
53 .callback = dmi_matched,
Michał Kępieńaaf3a5e2016-03-04 14:09:10 +010054 .ident = "Dell Inspiron M5110",
55 .matches = {
56 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
57 DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron M5110"),
58 },
59 },
60 {
61 .callback = dmi_matched,
Michał Kępieńe09c4d52016-03-04 14:09:08 +010062 .ident = "Dell Vostro V131",
63 .matches = {
64 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
65 DMI_MATCH(DMI_PRODUCT_NAME, "Vostro V131"),
66 },
67 },
68 { }
69};
70
Mario Limonciello5cab0092009-06-10 19:40:47 +000071/*
Pali Roháre075b3c2016-06-15 21:49:13 +020072 * Keymap for WMI events of type 0x0000
73 *
Mario Limonciello5cab0092009-06-10 19:40:47 +000074 * Certain keys are flagged as KE_IGNORE. All of these are either
75 * notifications (rather than requests for change) or are also sent
76 * via the keyboard controller so should not be sent again.
77 */
Andy Lutomirskibff589b2015-11-25 07:53:13 -080078static const struct key_entry dell_wmi_keymap_type_0000[] = {
Seth Forsheef1566f02011-08-01 15:46:10 -050079 { KE_IGNORE, 0x003a, { KEY_CAPSLOCK } },
80
Pali Rohár6a4d2602016-06-15 21:49:11 +020081 /* Key code is followed by brightness level */
82 { KE_KEY, 0xe005, { KEY_BRIGHTNESSDOWN } },
83 { KE_KEY, 0xe006, { KEY_BRIGHTNESSUP } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000084
85 /* Battery health status button */
Pali Rohár6a4d2602016-06-15 21:49:11 +020086 { KE_KEY, 0xe007, { KEY_BATTERY } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000087
Pali Rohár6a4d2602016-06-15 21:49:11 +020088 /* Radio devices state change, key code is followed by other values */
Gabriele Mazzotta8f8d75e2014-12-04 00:16:21 +010089 { KE_IGNORE, 0xe008, { KEY_RFKILL } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000090
Pali Rohár6a4d2602016-06-15 21:49:11 +020091 { KE_KEY, 0xe009, { KEY_EJECTCD } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000092
Pali Rohár6a4d2602016-06-15 21:49:11 +020093 /* Key code is followed by: next, active and attached devices */
94 { KE_KEY, 0xe00b, { KEY_SWITCHVIDEOMODE } },
95
96 /* Key code is followed by keyboard illumination level */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070097 { KE_IGNORE, 0xe00c, { KEY_KBDILLUMTOGGLE } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000098
99 /* BIOS error detected */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700100 { KE_IGNORE, 0xe00d, { KEY_RESERVED } },
Mario Limonciello5cab0092009-06-10 19:40:47 +0000101
Pali Rohár65a97a62016-07-27 09:34:42 +0200102 /* Battery was removed or inserted */
103 { KE_IGNORE, 0xe00e, { KEY_RESERVED } },
Pali Rohár3237a862016-06-15 21:49:12 +0200104
Mario Limonciello5cab0092009-06-10 19:40:47 +0000105 /* Wifi Catcher */
Mario Limonciello915ac052016-07-28 12:53:47 -0500106 { KE_KEY, 0xe011, { KEY_WLAN } },
Mario Limonciello5cab0092009-06-10 19:40:47 +0000107
108 /* Ambient light sensor toggle */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700109 { KE_IGNORE, 0xe013, { KEY_RESERVED } },
Mario Limonciello5cab0092009-06-10 19:40:47 +0000110
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700111 { KE_IGNORE, 0xe020, { KEY_MUTE } },
Seth Forsheef1566f02011-08-01 15:46:10 -0500112
Pali Rohár3237a862016-06-15 21:49:12 +0200113 /* Unknown, defined in ACPI DSDT */
114 /* { KE_IGNORE, 0xe023, { KEY_RESERVED } }, */
115
116 /* Untested, Dell Instant Launch key on Inspiron 7520 */
117 /* { KE_IGNORE, 0xe024, { KEY_RESERVED } }, */
118
Michał Kępieńaaf3a5e2016-03-04 14:09:10 +0100119 /* Dell Instant Launch key */
Pali Rohár6a4d2602016-06-15 21:49:11 +0200120 { KE_KEY, 0xe025, { KEY_PROG4 } },
Michał Kępieńaaf3a5e2016-03-04 14:09:10 +0100121
122 /* Audio panel key */
Seth Forsheef1566f02011-08-01 15:46:10 -0500123 { KE_IGNORE, 0xe026, { KEY_RESERVED } },
124
Alex Hungab9bb11c2016-06-17 11:44:27 +0800125 /* LCD Display On/Off Control key */
126 { KE_KEY, 0xe027, { KEY_DISPLAYTOGGLE } },
127
Pali Rohár3237a862016-06-15 21:49:12 +0200128 /* Untested, Multimedia key on Dell Vostro 3560 */
129 /* { KE_IGNORE, 0xe028, { KEY_RESERVED } }, */
130
Pali Rohár6a4d2602016-06-15 21:49:11 +0200131 /* Dell Instant Launch key */
132 { KE_KEY, 0xe029, { KEY_PROG4 } },
133
Pali Rohár3237a862016-06-15 21:49:12 +0200134 /* Untested, Windows Mobility Center button on Inspiron 7520 */
135 /* { KE_IGNORE, 0xe02a, { KEY_RESERVED } }, */
136
137 /* Unknown, defined in ACPI DSDT */
138 /* { KE_IGNORE, 0xe02b, { KEY_RESERVED } }, */
139
140 /* Untested, Dell Audio With Preset Switch button on Inspiron 7520 */
141 /* { KE_IGNORE, 0xe02c, { KEY_RESERVED } }, */
142
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700143 { KE_IGNORE, 0xe02e, { KEY_VOLUMEDOWN } },
144 { KE_IGNORE, 0xe030, { KEY_VOLUMEUP } },
145 { KE_IGNORE, 0xe033, { KEY_KBDILLUMUP } },
146 { KE_IGNORE, 0xe034, { KEY_KBDILLUMDOWN } },
147 { KE_IGNORE, 0xe03a, { KEY_CAPSLOCK } },
Pali Rohár3de59bc2016-06-15 21:49:10 +0200148
Pali Rohár3237a862016-06-15 21:49:12 +0200149 /* NIC Link is Up */
150 { KE_IGNORE, 0xe043, { KEY_RESERVED } },
151
152 /* NIC Link is Down */
153 { KE_IGNORE, 0xe044, { KEY_RESERVED } },
154
Pali Rohár3de59bc2016-06-15 21:49:10 +0200155 /*
156 * This entry is very suspicious!
157 * Originally Matthew Garrett created this dell-wmi driver specially for
158 * "button with a picture of a battery" which has event code 0xe045.
159 * Later Mario Limonciello from Dell told us that event code 0xe045 is
160 * reported by Num Lock and should be ignored because key is send also
161 * by keyboard controller.
162 * So for now we will ignore this event to prevent potential double
163 * Num Lock key press.
164 */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700165 { KE_IGNORE, 0xe045, { KEY_NUMLOCK } },
Pali Rohár3de59bc2016-06-15 21:49:10 +0200166
Pali Rohár3237a862016-06-15 21:49:12 +0200167 /* Scroll lock and also going to tablet mode on portable devices */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700168 { KE_IGNORE, 0xe046, { KEY_SCROLLLOCK } },
Pali Rohár3237a862016-06-15 21:49:12 +0200169
170 /* Untested, going from tablet mode on portable devices */
171 /* { KE_IGNORE, 0xe047, { KEY_RESERVED } }, */
172
173 /* Dell Support Center key */
174 { KE_IGNORE, 0xe06e, { KEY_RESERVED } },
175
Seth Forsheef1566f02011-08-01 15:46:10 -0500176 { KE_IGNORE, 0xe0f7, { KEY_MUTE } },
177 { KE_IGNORE, 0xe0f8, { KEY_VOLUMEDOWN } },
178 { KE_IGNORE, 0xe0f9, { KEY_VOLUMEUP } },
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000179};
180
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700181struct dell_bios_keymap_entry {
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500182 u16 scancode;
183 u16 keycode;
184};
185
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700186struct dell_bios_hotkey_table {
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500187 struct dmi_header header;
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700188 struct dell_bios_keymap_entry keymap[];
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500189
190};
191
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800192struct dell_dmi_results {
193 int err;
Pali Roháre075b3c2016-06-15 21:49:13 +0200194 int keymap_size;
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800195 struct key_entry *keymap;
196};
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500197
Andy Lutomirskicbc61f12015-11-30 17:02:01 -0800198/* Uninitialized entries here are KEY_RESERVED == 0. */
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800199static const u16 bios_to_linux_keycode[256] = {
Andy Lutomirski394cb772015-11-13 21:49:31 -0800200 [0] = KEY_MEDIA,
201 [1] = KEY_NEXTSONG,
202 [2] = KEY_PLAYPAUSE,
203 [3] = KEY_PREVIOUSSONG,
204 [4] = KEY_STOPCD,
205 [5] = KEY_UNKNOWN,
206 [6] = KEY_UNKNOWN,
207 [7] = KEY_UNKNOWN,
208 [8] = KEY_WWW,
209 [9] = KEY_UNKNOWN,
210 [10] = KEY_VOLUMEDOWN,
211 [11] = KEY_MUTE,
212 [12] = KEY_VOLUMEUP,
213 [13] = KEY_UNKNOWN,
214 [14] = KEY_BATTERY,
215 [15] = KEY_EJECTCD,
216 [16] = KEY_UNKNOWN,
217 [17] = KEY_SLEEP,
218 [18] = KEY_PROG1,
219 [19] = KEY_BRIGHTNESSDOWN,
220 [20] = KEY_BRIGHTNESSUP,
Henk8b069582018-05-01 13:11:54 +0200221 [21] = KEY_BRIGHTNESS_AUTO,
Andy Lutomirski394cb772015-11-13 21:49:31 -0800222 [22] = KEY_KBDILLUMTOGGLE,
223 [23] = KEY_UNKNOWN,
224 [24] = KEY_SWITCHVIDEOMODE,
225 [25] = KEY_UNKNOWN,
226 [26] = KEY_UNKNOWN,
227 [27] = KEY_SWITCHVIDEOMODE,
228 [28] = KEY_UNKNOWN,
229 [29] = KEY_UNKNOWN,
230 [30] = KEY_PROG2,
231 [31] = KEY_UNKNOWN,
232 [32] = KEY_UNKNOWN,
233 [33] = KEY_UNKNOWN,
234 [34] = KEY_UNKNOWN,
235 [35] = KEY_UNKNOWN,
236 [36] = KEY_UNKNOWN,
237 [37] = KEY_UNKNOWN,
238 [38] = KEY_MICMUTE,
239 [255] = KEY_PROG3,
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500240};
241
Andy Lutomirskia464afb2016-02-15 08:32:36 -0800242/*
Pali Roháre075b3c2016-06-15 21:49:13 +0200243 * Keymap for WMI events of type 0x0010
244 *
Andy Lutomirskia464afb2016-02-15 08:32:36 -0800245 * These are applied if the 0xB2 DMI hotkey table is present and doesn't
246 * override them.
247 */
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800248static const struct key_entry dell_wmi_keymap_type_0010[] = {
Kai Heng Feng64b82462018-06-01 11:23:22 +0800249 /* Fn-lock switched to function keys */
250 { KE_IGNORE, 0x0, { KEY_RESERVED } },
251
252 /* Fn-lock switched to multimedia keys */
253 { KE_IGNORE, 0x1, { KEY_RESERVED } },
254
Kai-Heng Feng38f250b2018-12-12 14:41:25 +0800255 /* Keyboard backlight change notification */
256 { KE_IGNORE, 0x3f, { KEY_RESERVED } },
257
Shih-Yuan Lee (FourDollars)842b8542017-12-19 17:39:49 +0800258 /* Mic mute */
259 { KE_KEY, 0x150, { KEY_MICMUTE } },
260
Andy Lutomirskia464afb2016-02-15 08:32:36 -0800261 /* Fn-lock */
262 { KE_IGNORE, 0x151, { KEY_RESERVED } },
263
264 /* Change keyboard illumination */
265 { KE_IGNORE, 0x152, { KEY_KBDILLUMTOGGLE } },
266
267 /*
268 * Radio disable (notify only -- there is no model for which the
269 * WMI event is supposed to trigger an action).
270 */
271 { KE_IGNORE, 0x153, { KEY_RFKILL } },
272
273 /* RGB keyboard backlight control */
274 { KE_IGNORE, 0x154, { KEY_RESERVED } },
275
Andy Lutomirskie4f2e3f2016-02-17 12:38:07 -0800276 /*
277 * Stealth mode toggle. This will "disable all lights and sounds".
278 * The action is performed by the BIOS and EC; the WMI event is just
279 * a notification. On the XPS 13 9350, this is Fn+F7, and there's
280 * a BIOS setting to enable and disable the hotkey.
281 */
Andy Lutomirskia464afb2016-02-15 08:32:36 -0800282 { KE_IGNORE, 0x155, { KEY_RESERVED } },
Mario Limonciello5dc444b2016-07-28 12:53:48 -0500283
284 /* Rugged magnetic dock attach/detach events */
285 { KE_IGNORE, 0x156, { KEY_RESERVED } },
286 { KE_IGNORE, 0x157, { KEY_RESERVED } },
287
288 /* Rugged programmable (P1/P2/P3 keys) */
289 { KE_KEY, 0x850, { KEY_PROG1 } },
290 { KE_KEY, 0x851, { KEY_PROG2 } },
291 { KE_KEY, 0x852, { KEY_PROG3 } },
292
Kai Heng Feng64b82462018-06-01 11:23:22 +0800293 /*
294 * Radio disable (notify only -- there is no model for which the
295 * WMI event is supposed to trigger an action).
296 */
297 { KE_IGNORE, 0xe008, { KEY_RFKILL } },
298
299 /* Fn-lock */
300 { KE_IGNORE, 0xe035, { KEY_RESERVED } },
Andy Lutomirskia464afb2016-02-15 08:32:36 -0800301};
302
Pali Roháre075b3c2016-06-15 21:49:13 +0200303/*
304 * Keymap for WMI events of type 0x0011
305 */
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800306static const struct key_entry dell_wmi_keymap_type_0011[] = {
Pali Roháre075b3c2016-06-15 21:49:13 +0200307 /* Battery unplugged */
308 { KE_IGNORE, 0xfff0, { KEY_RESERVED } },
309
310 /* Battery inserted */
311 { KE_IGNORE, 0xfff1, { KEY_RESERVED } },
312
313 /* Keyboard backlight level changed */
314 { KE_IGNORE, 0x01e1, { KEY_RESERVED } },
315 { KE_IGNORE, 0x02ea, { KEY_RESERVED } },
316 { KE_IGNORE, 0x02eb, { KEY_RESERVED } },
317 { KE_IGNORE, 0x02ec, { KEY_RESERVED } },
318 { KE_IGNORE, 0x02f6, { KEY_RESERVED } },
319};
320
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800321static void dell_wmi_process_key(struct wmi_device *wdev, int type, int code)
Pali Rohár83fc44c2014-11-11 20:21:22 +0100322{
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800323 struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
Pali Rohár83fc44c2014-11-11 20:21:22 +0100324 const struct key_entry *key;
325
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800326 key = sparse_keymap_entry_from_scancode(priv->input_dev,
Pali Roháre075b3c2016-06-15 21:49:13 +0200327 (type << 16) | code);
Pali Rohár83fc44c2014-11-11 20:21:22 +0100328 if (!key) {
Pali Roháre075b3c2016-06-15 21:49:13 +0200329 pr_info("Unknown key with type 0x%04x and code 0x%04x pressed\n",
330 type, code);
Pali Rohár83fc44c2014-11-11 20:21:22 +0100331 return;
332 }
333
Pali Roháre075b3c2016-06-15 21:49:13 +0200334 pr_debug("Key with type 0x%04x and code 0x%04x pressed\n", type, code);
Pali Rohár83fc44c2014-11-11 20:21:22 +0100335
336 /* Don't report brightness notifications that will also come via ACPI */
337 if ((key->keycode == KEY_BRIGHTNESSUP ||
Hans de Goede61679c72015-12-22 19:09:49 +0100338 key->keycode == KEY_BRIGHTNESSDOWN) &&
339 acpi_video_handles_brightness_key_presses())
Pali Rohár83fc44c2014-11-11 20:21:22 +0100340 return;
341
Pali Roháre075b3c2016-06-15 21:49:13 +0200342 if (type == 0x0000 && code == 0xe025 && !wmi_requires_smbios_request)
Michał Kępień13f50592016-03-04 14:09:09 +0100343 return;
344
Hans de Goede9c656b02017-03-16 11:55:35 +0100345 if (key->keycode == KEY_KBDILLUMTOGGLE)
346 dell_laptop_call_notifier(
347 DELL_LAPTOP_KBD_BACKLIGHT_BRIGHTNESS_CHANGED, NULL);
348
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800349 sparse_keymap_report_entry(priv->input_dev, key, 1, true);
Pali Rohár83fc44c2014-11-11 20:21:22 +0100350}
351
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800352static void dell_wmi_notify(struct wmi_device *wdev,
353 union acpi_object *obj)
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000354{
Andy Lutomirski00ebbeb2017-08-01 08:37:27 -0700355 struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
Pali Rohár83fc44c2014-11-11 20:21:22 +0100356 u16 *buffer_entry, *buffer_end;
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800357 acpi_size buffer_size;
Pali Rohár83fc44c2014-11-11 20:21:22 +0100358 int len, i;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000359
Pali Rohár83fc44c2014-11-11 20:21:22 +0100360 if (obj->type != ACPI_TYPE_BUFFER) {
361 pr_warn("bad response type %x\n", obj->type);
Pali Rohár83fc44c2014-11-11 20:21:22 +0100362 return;
363 }
364
365 pr_debug("Received WMI event (%*ph)\n",
366 obj->buffer.length, obj->buffer.pointer);
367
368 buffer_entry = (u16 *)obj->buffer.pointer;
369 buffer_size = obj->buffer.length/2;
Pali Rohár83fc44c2014-11-11 20:21:22 +0100370 buffer_end = buffer_entry + buffer_size;
371
Pali Rohár481fe5b2016-01-04 22:26:36 +0100372 /*
373 * BIOS/ACPI on devices with WMI interface version 0 does not clear
374 * buffer before filling it. So next time when BIOS/ACPI send WMI event
375 * which is smaller as previous then it contains garbage in buffer from
376 * previous event.
377 *
378 * BIOS/ACPI on devices with WMI interface version 1 clears buffer and
379 * sometimes send more events in buffer at one call.
380 *
381 * So to prevent reading garbage from buffer we will process only first
382 * one event on devices with WMI interface version 0.
383 */
Andy Lutomirski00ebbeb2017-08-01 08:37:27 -0700384 if (priv->interface_version == 0 && buffer_entry < buffer_end)
Pali Rohár481fe5b2016-01-04 22:26:36 +0100385 if (buffer_end > buffer_entry + buffer_entry[0] + 1)
386 buffer_end = buffer_entry + buffer_entry[0] + 1;
387
Pali Rohár83fc44c2014-11-11 20:21:22 +0100388 while (buffer_entry < buffer_end) {
389
390 len = buffer_entry[0];
391 if (len == 0)
392 break;
393
394 len++;
395
396 if (buffer_entry + len > buffer_end) {
397 pr_warn("Invalid length of WMI event\n");
398 break;
399 }
400
401 pr_debug("Process buffer (%*ph)\n", len*2, buffer_entry);
402
403 switch (buffer_entry[1]) {
Pali Roháre075b3c2016-06-15 21:49:13 +0200404 case 0x0000: /* One key pressed or event occurred */
405 if (len > 2)
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800406 dell_wmi_process_key(wdev, 0x0000,
407 buffer_entry[2]);
Pali Roháre075b3c2016-06-15 21:49:13 +0200408 /* Other entries could contain additional information */
Pali Rohár83fc44c2014-11-11 20:21:22 +0100409 break;
Pali Roháre075b3c2016-06-15 21:49:13 +0200410 case 0x0010: /* Sequence of keys pressed */
411 case 0x0011: /* Sequence of events occurred */
Pali Rohár83fc44c2014-11-11 20:21:22 +0100412 for (i = 2; i < len; ++i)
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800413 dell_wmi_process_key(wdev, buffer_entry[1],
Pali Roháre075b3c2016-06-15 21:49:13 +0200414 buffer_entry[i]);
Pali Rohár83fc44c2014-11-11 20:21:22 +0100415 break;
Pali Roháre075b3c2016-06-15 21:49:13 +0200416 default: /* Unknown event */
Pali Rohár83fc44c2014-11-11 20:21:22 +0100417 pr_info("Unknown WMI event type 0x%x\n",
418 (int)buffer_entry[1]);
419 break;
420 }
421
422 buffer_entry += len;
423
424 }
425
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000426}
427
Andy Lutomirskia464afb2016-02-15 08:32:36 -0800428static bool have_scancode(u32 scancode, const struct key_entry *keymap, int len)
429{
430 int i;
431
432 for (i = 0; i < len; i++)
433 if (keymap[i].code == scancode)
434 return true;
435
436 return false;
437}
438
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800439static void handle_dmi_entry(const struct dmi_header *dm, void *opaque)
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500440{
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800441 struct dell_dmi_results *results = opaque;
442 struct dell_bios_hotkey_table *table;
Andy Lutomirskia464afb2016-02-15 08:32:36 -0800443 int hotkey_num, i, pos = 0;
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700444 struct key_entry *keymap;
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800445
446 if (results->err || results->keymap)
447 return; /* We already found the hotkey table. */
448
Andy Lutomirski074df51c2016-02-17 12:34:34 -0800449 /* The Dell hotkey table is type 0xB2. Scan until we find it. */
Andy Lutomirskib13de702016-02-15 08:32:35 -0800450 if (dm->type != 0xb2)
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800451 return;
452
453 table = container_of(dm, struct dell_bios_hotkey_table, header);
454
Andy Lutomirskib13de702016-02-15 08:32:35 -0800455 hotkey_num = (table->header.length -
456 sizeof(struct dell_bios_hotkey_table)) /
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800457 sizeof(struct dell_bios_keymap_entry);
Andy Lutomirskib13de702016-02-15 08:32:35 -0800458 if (hotkey_num < 1) {
459 /*
460 * Historically, dell-wmi would ignore a DMI entry of
461 * fewer than 7 bytes. Sizes between 4 and 8 bytes are
462 * nonsensical (both the header and all entries are 4
463 * bytes), so we approximate the old behavior by
464 * ignoring tables with fewer than one entry.
465 */
466 return;
467 }
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500468
Pali Roháre075b3c2016-06-15 21:49:13 +0200469 keymap = kcalloc(hotkey_num, sizeof(struct key_entry), GFP_KERNEL);
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800470 if (!keymap) {
471 results->err = -ENOMEM;
472 return;
473 }
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500474
475 for (i = 0; i < hotkey_num; i++) {
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700476 const struct dell_bios_keymap_entry *bios_entry =
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800477 &table->keymap[i];
Andy Lutomirskicbc61f12015-11-30 17:02:01 -0800478
479 /* Uninitialized entries are 0 aka KEY_RESERVED. */
480 u16 keycode = (bios_entry->keycode <
481 ARRAY_SIZE(bios_to_linux_keycode)) ?
482 bios_to_linux_keycode[bios_entry->keycode] :
483 KEY_RESERVED;
484
485 /*
486 * Log if we find an entry in the DMI table that we don't
487 * understand. If this happens, we should figure out what
488 * the entry means and add it to bios_to_linux_keycode.
489 */
490 if (keycode == KEY_RESERVED) {
491 pr_info("firmware scancode 0x%x maps to unrecognized keycode 0x%x\n",
492 bios_entry->scancode, bios_entry->keycode);
493 continue;
494 }
Gabriele Mazzotta8cb8e632014-12-04 00:16:23 +0100495
496 if (keycode == KEY_KBDILLUMTOGGLE)
Andy Lutomirskia464afb2016-02-15 08:32:36 -0800497 keymap[pos].type = KE_IGNORE;
Gabriele Mazzotta8cb8e632014-12-04 00:16:23 +0100498 else
Andy Lutomirskia464afb2016-02-15 08:32:36 -0800499 keymap[pos].type = KE_KEY;
500 keymap[pos].code = bios_entry->scancode;
501 keymap[pos].keycode = keycode;
502
503 pos++;
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500504 }
505
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800506 results->keymap = keymap;
Pali Roháre075b3c2016-06-15 21:49:13 +0200507 results->keymap_size = pos;
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500508}
509
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800510static int dell_wmi_input_setup(struct wmi_device *wdev)
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000511{
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800512 struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800513 struct dell_dmi_results dmi_results = {};
Pali Roháre075b3c2016-06-15 21:49:13 +0200514 struct key_entry *keymap;
515 int err, i, pos = 0;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000516
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800517 priv->input_dev = input_allocate_device();
518 if (!priv->input_dev)
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000519 return -ENOMEM;
520
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800521 priv->input_dev->name = "Dell WMI hotkeys";
522 priv->input_dev->id.bustype = BUS_HOST;
523 priv->input_dev->dev.parent = &wdev->dev;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000524
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800525 if (dmi_walk(handle_dmi_entry, &dmi_results)) {
526 /*
527 * Historically, dell-wmi ignored dmi_walk errors. A failure
528 * is certainly surprising, but it probably just indicates
529 * a very old laptop.
530 */
531 pr_warn("no DMI; using the old-style hotkey interface\n");
532 }
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700533
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800534 if (dmi_results.err) {
535 err = dmi_results.err;
536 goto err_free_dev;
537 }
538
Pali Roháre075b3c2016-06-15 21:49:13 +0200539 keymap = kcalloc(dmi_results.keymap_size +
540 ARRAY_SIZE(dell_wmi_keymap_type_0000) +
541 ARRAY_SIZE(dell_wmi_keymap_type_0010) +
542 ARRAY_SIZE(dell_wmi_keymap_type_0011) +
543 1,
544 sizeof(struct key_entry), GFP_KERNEL);
545 if (!keymap) {
546 kfree(dmi_results.keymap);
547 err = -ENOMEM;
548 goto err_free_dev;
549 }
Andy Lutomirski18b6f802016-02-15 08:32:33 -0800550
Pali Roháre075b3c2016-06-15 21:49:13 +0200551 /* Append table with events of type 0x0010 which comes from DMI */
552 for (i = 0; i < dmi_results.keymap_size; i++) {
553 keymap[pos] = dmi_results.keymap[i];
554 keymap[pos].code |= (0x0010 << 16);
555 pos++;
556 }
557
558 kfree(dmi_results.keymap);
559
560 /* Append table with extra events of type 0x0010 which are not in DMI */
561 for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0010); i++) {
562 const struct key_entry *entry = &dell_wmi_keymap_type_0010[i];
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700563
564 /*
Pali Roháre075b3c2016-06-15 21:49:13 +0200565 * Check if we've already found this scancode. This takes
566 * quadratic time, but it doesn't matter unless the list
567 * of extra keys gets very long.
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700568 */
Pali Roháre075b3c2016-06-15 21:49:13 +0200569 if (dmi_results.keymap_size &&
570 have_scancode(entry->code | (0x0010 << 16),
571 keymap, dmi_results.keymap_size)
572 )
573 continue;
574
575 keymap[pos] = *entry;
576 keymap[pos].code |= (0x0010 << 16);
577 pos++;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000578 }
Pali Roháre075b3c2016-06-15 21:49:13 +0200579
580 /* Append table with events of type 0x0011 */
581 for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0011); i++) {
582 keymap[pos] = dell_wmi_keymap_type_0011[i];
583 keymap[pos].code |= (0x0011 << 16);
584 pos++;
585 }
586
587 /*
588 * Now append also table with "legacy" events of type 0x0000. Some of
589 * them are reported also on laptops which have scancodes in DMI.
590 */
591 for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0000); i++) {
592 keymap[pos] = dell_wmi_keymap_type_0000[i];
593 pos++;
594 }
595
596 keymap[pos].type = KE_END;
597
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800598 err = sparse_keymap_setup(priv->input_dev, keymap, NULL);
Pali Roháre075b3c2016-06-15 21:49:13 +0200599 /*
600 * Sparse keymap library makes a copy of keymap so we don't need the
601 * original one that was allocated.
602 */
603 kfree(keymap);
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700604 if (err)
605 goto err_free_dev;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000606
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800607 err = input_register_device(priv->input_dev);
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700608 if (err)
Michał Kępień815edfe2017-03-09 13:11:41 +0100609 goto err_free_dev;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000610
611 return 0;
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700612
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700613 err_free_dev:
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800614 input_free_device(priv->input_dev);
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700615 return err;
616}
617
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800618static void dell_wmi_input_destroy(struct wmi_device *wdev)
619{
620 struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
621
622 input_unregister_device(priv->input_dev);
623}
624
Pali Rohár595773a42016-01-04 22:26:35 +0100625/*
Michał Kępieńe09c4d52016-03-04 14:09:08 +0100626 * According to Dell SMBIOS documentation:
627 *
628 * 17 3 Application Program Registration
629 *
630 * cbArg1 Application ID 1 = 0x00010000
631 * cbArg2 Application ID 2
632 * QUICKSET/DCP = 0x51534554 "QSET"
633 * ALS Driver = 0x416c7353 "AlsS"
634 * Latitude ON = 0x4c6f6e52 "LonR"
635 * cbArg3 Application version or revision number
636 * cbArg4 0 = Unregister application
637 * 1 = Register application
638 * cbRes1 Standard return codes (0, -1, -2)
639 */
640
641static int dell_wmi_events_set_enabled(bool enable)
642{
643 struct calling_interface_buffer *buffer;
644 int ret;
645
Mario Limonciello549b4932017-11-01 14:25:31 -0500646 buffer = kzalloc(sizeof(struct calling_interface_buffer), GFP_KERNEL);
Dan Carpenter91c73e82017-12-11 13:54:27 +0300647 if (!buffer)
648 return -ENOMEM;
Mario Limonciello549b4932017-11-01 14:25:31 -0500649 buffer->cmd_class = CLASS_INFO;
650 buffer->cmd_select = SELECT_APP_REGISTRATION;
Michał Kępieńe09c4d52016-03-04 14:09:08 +0100651 buffer->input[0] = 0x10000;
652 buffer->input[1] = 0x51534554;
653 buffer->input[3] = enable;
Mario Limonciello549b4932017-11-01 14:25:31 -0500654 ret = dell_smbios_call(buffer);
655 if (ret == 0)
656 ret = buffer->output[0];
657 kfree(buffer);
Michał Kępieńe09c4d52016-03-04 14:09:08 +0100658
659 return dell_smbios_error(ret);
660}
661
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800662static int dell_wmi_probe(struct wmi_device *wdev)
663{
Andy Lutomirski00ebbeb2017-08-01 08:37:27 -0700664 struct dell_wmi_priv *priv;
Mario Limonciello868b8d32017-11-09 11:49:10 -0600665 int ret;
Mario Limonciello92b8c542017-11-01 14:25:27 -0500666
Mario Limonciello868b8d32017-11-09 11:49:10 -0600667 ret = dell_wmi_get_descriptor_valid();
668 if (ret)
669 return ret;
Andy Lutomirskibaa54802017-08-01 08:37:26 -0700670
Andy Lutomirski00ebbeb2017-08-01 08:37:27 -0700671 priv = devm_kzalloc(
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800672 &wdev->dev, sizeof(struct dell_wmi_priv), GFP_KERNEL);
Andy Lutomirski00ebbeb2017-08-01 08:37:27 -0700673 if (!priv)
674 return -ENOMEM;
675 dev_set_drvdata(&wdev->dev, priv);
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800676
Mario Limonciello92b8c542017-11-01 14:25:27 -0500677 if (!dell_wmi_get_interface_version(&priv->interface_version))
678 return -EPROBE_DEFER;
Andy Lutomirskibaa54802017-08-01 08:37:26 -0700679
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800680 return dell_wmi_input_setup(wdev);
681}
682
683static int dell_wmi_remove(struct wmi_device *wdev)
684{
685 dell_wmi_input_destroy(wdev);
686 return 0;
687}
688static const struct wmi_device_id dell_wmi_id_table[] = {
689 { .guid_string = DELL_EVENT_GUID },
690 { },
691};
692
693static struct wmi_driver dell_wmi_driver = {
694 .driver = {
695 .name = "dell-wmi",
696 },
697 .id_table = dell_wmi_id_table,
698 .probe = dell_wmi_probe,
699 .remove = dell_wmi_remove,
700 .notify = dell_wmi_notify,
701};
702
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000703static int __init dell_wmi_init(void)
704{
705 int err;
Dmitry Torokhov1fdd4072009-12-17 22:19:42 -0800706
Michał Kępieńe09c4d52016-03-04 14:09:08 +0100707 dmi_check_system(dell_wmi_smbios_list);
708
709 if (wmi_requires_smbios_request) {
710 err = dell_wmi_events_set_enabled(true);
711 if (err) {
712 pr_err("Failed to enable WMI events\n");
Michał Kępieńe09c4d52016-03-04 14:09:08 +0100713 return err;
714 }
715 }
716
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800717 return wmi_driver_register(&dell_wmi_driver);
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000718}
Darren Hart (VMware)49368c12018-03-12 23:28:00 -0700719late_initcall(dell_wmi_init);
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000720
721static void __exit dell_wmi_exit(void)
722{
Michał Kępieńe09c4d52016-03-04 14:09:08 +0100723 if (wmi_requires_smbios_request)
724 dell_wmi_events_set_enabled(false);
Andy Lutomirskibff589b2015-11-25 07:53:13 -0800725
726 wmi_driver_unregister(&dell_wmi_driver);
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000727}
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000728module_exit(dell_wmi_exit);
Mattias Jacobssonf44b3752019-02-19 20:59:53 +0100729
730MODULE_DEVICE_TABLE(wmi, dell_wmi_id_table);