blob: 60e0900bc117995e6373bfb5bedfcc1c8aac2aed [file] [log] [blame]
Matthew Garrett0b3f6102009-01-09 20:17:11 +00001/*
2 * Dell WMI hotkeys
3 *
4 * Copyright (C) 2008 Red Hat <mjg@redhat.com>
5 *
6 * Portions based on wistron_btns.c:
7 * Copyright (C) 2005 Miloslav Trmac <mitr@volny.cz>
8 * Copyright (C) 2005 Bernhard Rosenkraenzer <bero@arklinux.org>
9 * Copyright (C) 2005 Dmitry Torokhov <dtor@mail.ru>
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 */
25
Joe Percheseb889522011-03-29 15:21:37 -070026#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
27
Matthew Garrett0b3f6102009-01-09 20:17:11 +000028#include <linux/kernel.h>
29#include <linux/module.h>
30#include <linux/init.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090031#include <linux/slab.h>
Matthew Garrett0b3f6102009-01-09 20:17:11 +000032#include <linux/types.h>
33#include <linux/input.h>
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070034#include <linux/input/sparse-keymap.h>
Matthew Garrett0b3f6102009-01-09 20:17:11 +000035#include <acpi/acpi_drivers.h>
36#include <linux/acpi.h>
37#include <linux/string.h>
Rezwanul Kabir5ea25592009-11-02 12:00:42 -050038#include <linux/dmi.h>
Matthew Garrett0b3f6102009-01-09 20:17:11 +000039
40MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");
41MODULE_DESCRIPTION("Dell laptop WMI hotkeys driver");
42MODULE_LICENSE("GPL");
43
44#define DELL_EVENT_GUID "9DBB5994-A997-11DA-B012-B622A1EF5492"
45
Rezwanul Kabir5ea25592009-11-02 12:00:42 -050046static int acpi_video;
47
Matthew Garrett0b3f6102009-01-09 20:17:11 +000048MODULE_ALIAS("wmi:"DELL_EVENT_GUID);
49
Mario Limonciello5cab0092009-06-10 19:40:47 +000050/*
51 * Certain keys are flagged as KE_IGNORE. All of these are either
52 * notifications (rather than requests for change) or are also sent
53 * via the keyboard controller so should not be sent again.
54 */
Matthew Garrett0b3f6102009-01-09 20:17:11 +000055
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070056static const struct key_entry dell_wmi_legacy_keymap[] __initconst = {
Seth Forsheef1566f02011-08-01 15:46:10 -050057 { KE_IGNORE, 0x003a, { KEY_CAPSLOCK } },
58
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070059 { KE_KEY, 0xe045, { KEY_PROG1 } },
60 { KE_KEY, 0xe009, { KEY_EJECTCD } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000061
62 /* These also contain the brightness level at offset 6 */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070063 { KE_KEY, 0xe006, { KEY_BRIGHTNESSUP } },
64 { KE_KEY, 0xe005, { KEY_BRIGHTNESSDOWN } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000065
66 /* Battery health status button */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070067 { KE_KEY, 0xe007, { KEY_BATTERY } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000068
69 /* This is actually for all radios. Although physically a
70 * switch, the notification does not provide an indication of
71 * state and so it should be reported as a key */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070072 { KE_KEY, 0xe008, { KEY_WLAN } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000073
74 /* The next device is at offset 6, the active devices are at
75 offset 8 and the attached devices at offset 10 */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070076 { KE_KEY, 0xe00b, { KEY_SWITCHVIDEOMODE } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000077
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070078 { KE_IGNORE, 0xe00c, { KEY_KBDILLUMTOGGLE } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000079
80 /* BIOS error detected */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070081 { KE_IGNORE, 0xe00d, { KEY_RESERVED } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000082
83 /* Wifi Catcher */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070084 { KE_KEY, 0xe011, {KEY_PROG2 } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000085
86 /* Ambient light sensor toggle */
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070087 { KE_IGNORE, 0xe013, { KEY_RESERVED } },
Mario Limonciello5cab0092009-06-10 19:40:47 +000088
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070089 { KE_IGNORE, 0xe020, { KEY_MUTE } },
Seth Forsheef1566f02011-08-01 15:46:10 -050090
91 /* Shortcut and audio panel keys */
92 { KE_IGNORE, 0xe025, { KEY_RESERVED } },
93 { KE_IGNORE, 0xe026, { KEY_RESERVED } },
94
Dmitry Torokhov890a7c82010-08-04 22:30:08 -070095 { KE_IGNORE, 0xe02e, { KEY_VOLUMEDOWN } },
96 { KE_IGNORE, 0xe030, { KEY_VOLUMEUP } },
97 { KE_IGNORE, 0xe033, { KEY_KBDILLUMUP } },
98 { KE_IGNORE, 0xe034, { KEY_KBDILLUMDOWN } },
99 { KE_IGNORE, 0xe03a, { KEY_CAPSLOCK } },
100 { KE_IGNORE, 0xe045, { KEY_NUMLOCK } },
101 { KE_IGNORE, 0xe046, { KEY_SCROLLLOCK } },
Seth Forsheef1566f02011-08-01 15:46:10 -0500102 { KE_IGNORE, 0xe0f7, { KEY_MUTE } },
103 { KE_IGNORE, 0xe0f8, { KEY_VOLUMEDOWN } },
104 { KE_IGNORE, 0xe0f9, { KEY_VOLUMEUP } },
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700105 { KE_END, 0 }
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000106};
107
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500108static bool dell_new_hk_type;
109
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700110struct dell_bios_keymap_entry {
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500111 u16 scancode;
112 u16 keycode;
113};
114
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700115struct dell_bios_hotkey_table {
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500116 struct dmi_header header;
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700117 struct dell_bios_keymap_entry keymap[];
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500118
119};
120
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700121static const struct dell_bios_hotkey_table *dell_bios_hotkey_table;
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500122
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700123static const u16 bios_to_linux_keycode[256] __initconst = {
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500124
125 KEY_MEDIA, KEY_NEXTSONG, KEY_PLAYPAUSE, KEY_PREVIOUSSONG,
126 KEY_STOPCD, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
127 KEY_WWW, KEY_UNKNOWN, KEY_VOLUMEDOWN, KEY_MUTE,
128 KEY_VOLUMEUP, KEY_UNKNOWN, KEY_BATTERY, KEY_EJECTCD,
129 KEY_UNKNOWN, KEY_SLEEP, KEY_PROG1, KEY_BRIGHTNESSDOWN,
130 KEY_BRIGHTNESSUP, KEY_UNKNOWN, KEY_KBDILLUMTOGGLE,
131 KEY_UNKNOWN, KEY_SWITCHVIDEOMODE, KEY_UNKNOWN, KEY_UNKNOWN,
132 KEY_SWITCHVIDEOMODE, KEY_UNKNOWN, KEY_UNKNOWN, KEY_PROG2,
Alex Hungcfb743b2013-11-12 11:09:22 +0800133 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN,
134 KEY_UNKNOWN, KEY_UNKNOWN, KEY_UNKNOWN, KEY_MICMUTE,
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500135 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
136 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
137 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
138 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
139 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
140 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
141 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
142 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
Alex Hungcfb743b2013-11-12 11:09:22 +0800143 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
144 0, 0, 0, 0, 0, 0, 0, 0, 0, KEY_PROG3
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500145};
146
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000147static struct input_dev *dell_wmi_input_dev;
148
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000149static void dell_wmi_notify(u32 value, void *context)
150{
151 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000152 union acpi_object *obj;
Len Brownfda11e62009-12-26 23:02:24 -0500153 acpi_status status;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000154
Len Brownfda11e62009-12-26 23:02:24 -0500155 status = wmi_get_event_data(value, &response);
156 if (status != AE_OK) {
Joe Percheseb889522011-03-29 15:21:37 -0700157 pr_info("bad event status 0x%x\n", status);
Len Brownfda11e62009-12-26 23:02:24 -0500158 return;
159 }
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000160
161 obj = (union acpi_object *)response.pointer;
162
163 if (obj && obj->type == ACPI_TYPE_BUFFER) {
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700164 const struct key_entry *key;
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500165 int reported_key;
166 u16 *buffer_entry = (u16 *)obj->buffer.pointer;
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700167
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500168 if (dell_new_hk_type && (buffer_entry[1] != 0x10)) {
Joe Percheseb889522011-03-29 15:21:37 -0700169 pr_info("Received unknown WMI event (0x%x)\n",
170 buffer_entry[1]);
Yong Wanga0624a92010-04-05 21:09:40 +0800171 kfree(obj);
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500172 return;
173 }
174
Islam Amerd5164db2010-06-24 13:39:47 -0400175 if (dell_new_hk_type || buffer_entry[1] == 0x0)
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500176 reported_key = (int)buffer_entry[2];
177 else
178 reported_key = (int)buffer_entry[1] & 0xffff;
179
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700180 key = sparse_keymap_entry_from_scancode(dell_wmi_input_dev,
181 reported_key);
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500182 if (!key) {
Joe Percheseb889522011-03-29 15:21:37 -0700183 pr_info("Unknown key %x pressed\n", reported_key);
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500184 } else if ((key->keycode == KEY_BRIGHTNESSUP ||
185 key->keycode == KEY_BRIGHTNESSDOWN) && acpi_video) {
186 /* Don't report brightness notifications that will also
187 * come via ACPI */
Yong Wanga0624a92010-04-05 21:09:40 +0800188 ;
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500189 } else {
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700190 sparse_keymap_report_entry(dell_wmi_input_dev, key,
191 1, true);
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500192 }
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000193 }
Anisse Astier3e9b9882009-12-04 10:10:09 +0100194 kfree(obj);
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000195}
196
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700197static const struct key_entry * __init dell_wmi_prepare_new_keymap(void)
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500198{
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700199 int hotkey_num = (dell_bios_hotkey_table->header.length - 4) /
200 sizeof(struct dell_bios_keymap_entry);
201 struct key_entry *keymap;
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500202 int i;
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500203
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700204 keymap = kcalloc(hotkey_num + 1, sizeof(struct key_entry), GFP_KERNEL);
205 if (!keymap)
206 return NULL;
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500207
208 for (i = 0; i < hotkey_num; i++) {
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700209 const struct dell_bios_keymap_entry *bios_entry =
210 &dell_bios_hotkey_table->keymap[i];
211 keymap[i].type = KE_KEY;
212 keymap[i].code = bios_entry->scancode;
213 keymap[i].keycode = bios_entry->keycode < 256 ?
214 bios_to_linux_keycode[bios_entry->keycode] :
215 KEY_RESERVED;
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500216 }
217
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700218 keymap[hotkey_num].type = KE_END;
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500219
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700220 return keymap;
Rezwanul Kabir5ea25592009-11-02 12:00:42 -0500221}
222
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000223static int __init dell_wmi_input_setup(void)
224{
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000225 int err;
226
227 dell_wmi_input_dev = input_allocate_device();
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000228 if (!dell_wmi_input_dev)
229 return -ENOMEM;
230
231 dell_wmi_input_dev->name = "Dell WMI hotkeys";
232 dell_wmi_input_dev->phys = "wmi/input0";
233 dell_wmi_input_dev->id.bustype = BUS_HOST;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000234
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700235 if (dell_new_hk_type) {
236 const struct key_entry *keymap = dell_wmi_prepare_new_keymap();
237 if (!keymap) {
238 err = -ENOMEM;
239 goto err_free_dev;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000240 }
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700241
242 err = sparse_keymap_setup(dell_wmi_input_dev, keymap, NULL);
243
244 /*
245 * Sparse keymap library makes a copy of keymap so we
246 * don't need the original one that was allocated.
247 */
248 kfree(keymap);
249 } else {
250 err = sparse_keymap_setup(dell_wmi_input_dev,
251 dell_wmi_legacy_keymap, NULL);
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000252 }
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700253 if (err)
254 goto err_free_dev;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000255
256 err = input_register_device(dell_wmi_input_dev);
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700257 if (err)
258 goto err_free_keymap;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000259
260 return 0;
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700261
262 err_free_keymap:
263 sparse_keymap_free(dell_wmi_input_dev);
264 err_free_dev:
265 input_free_device(dell_wmi_input_dev);
266 return err;
267}
268
269static void dell_wmi_input_destroy(void)
270{
271 sparse_keymap_free(dell_wmi_input_dev);
272 input_unregister_device(dell_wmi_input_dev);
273}
274
275static void __init find_hk_type(const struct dmi_header *dm, void *dummy)
276{
277 if (dm->type == 0xb2 && dm->length > 6) {
278 dell_new_hk_type = true;
279 dell_bios_hotkey_table =
280 container_of(dm, struct dell_bios_hotkey_table, header);
281 }
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000282}
283
284static int __init dell_wmi_init(void)
285{
286 int err;
Len Brownabb631b2009-12-26 21:51:38 -0500287 acpi_status status;
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000288
Dmitry Torokhov7a9568f2009-12-25 11:49:35 -0800289 if (!wmi_has_guid(DELL_EVENT_GUID)) {
Joe Percheseb889522011-03-29 15:21:37 -0700290 pr_warn("No known WMI GUID found\n");
Dmitry Torokhov1fdd4072009-12-17 22:19:42 -0800291 return -ENODEV;
292 }
293
294 dmi_walk(find_hk_type, NULL);
295 acpi_video = acpi_video_backlight_support();
296
297 err = dell_wmi_input_setup();
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700298 if (err)
Dmitry Torokhov1fdd4072009-12-17 22:19:42 -0800299 return err;
300
Len Brownabb631b2009-12-26 21:51:38 -0500301 status = wmi_install_notify_handler(DELL_EVENT_GUID,
Dmitry Torokhov1fdd4072009-12-17 22:19:42 -0800302 dell_wmi_notify, NULL);
Len Brownabb631b2009-12-26 21:51:38 -0500303 if (ACPI_FAILURE(status)) {
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700304 dell_wmi_input_destroy();
Joe Percheseb889522011-03-29 15:21:37 -0700305 pr_err("Unable to register notify handler - %d\n", status);
Len Brownabb631b2009-12-26 21:51:38 -0500306 return -ENODEV;
Dmitry Torokhov1fdd4072009-12-17 22:19:42 -0800307 }
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000308
309 return 0;
310}
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700311module_init(dell_wmi_init);
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000312
313static void __exit dell_wmi_exit(void)
314{
Dmitry Torokhov1fdd4072009-12-17 22:19:42 -0800315 wmi_remove_notify_handler(DELL_EVENT_GUID);
Dmitry Torokhov890a7c82010-08-04 22:30:08 -0700316 dell_wmi_input_destroy();
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000317}
Matthew Garrett0b3f6102009-01-09 20:17:11 +0000318module_exit(dell_wmi_exit);