dell-wmi: mask off upper bytes of event response
[firefly-linux-kernel-4.4.55.git] / drivers / platform / x86 / dell-wmi.c
1 /*
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
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/init.h>
29 #include <linux/types.h>
30 #include <linux/input.h>
31 #include <acpi/acpi_drivers.h>
32 #include <linux/acpi.h>
33 #include <linux/string.h>
34
35 MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");
36 MODULE_DESCRIPTION("Dell laptop WMI hotkeys driver");
37 MODULE_LICENSE("GPL");
38
39 #define DELL_EVENT_GUID "9DBB5994-A997-11DA-B012-B622A1EF5492"
40
41 MODULE_ALIAS("wmi:"DELL_EVENT_GUID);
42
43 struct key_entry {
44         char type;              /* See KE_* below */
45         u16 code;
46         u16 keycode;
47 };
48
49 enum { KE_KEY, KE_SW, KE_END };
50
51 static struct key_entry dell_wmi_keymap[] = {
52         {KE_KEY, 0xe045, KEY_PROG1},
53         {KE_END, 0}
54 };
55
56 static struct input_dev *dell_wmi_input_dev;
57
58 static struct key_entry *dell_wmi_get_entry_by_scancode(int code)
59 {
60         struct key_entry *key;
61
62         for (key = dell_wmi_keymap; key->type != KE_END; key++)
63                 if (code == key->code)
64                         return key;
65
66         return NULL;
67 }
68
69 static struct key_entry *dell_wmi_get_entry_by_keycode(int keycode)
70 {
71         struct key_entry *key;
72
73         for (key = dell_wmi_keymap; key->type != KE_END; key++)
74                 if (key->type == KE_KEY && keycode == key->keycode)
75                         return key;
76
77         return NULL;
78 }
79
80 static int dell_wmi_getkeycode(struct input_dev *dev, int scancode,
81                                int *keycode)
82 {
83         struct key_entry *key = dell_wmi_get_entry_by_scancode(scancode);
84
85         if (key && key->type == KE_KEY) {
86                 *keycode = key->keycode;
87                 return 0;
88         }
89
90         return -EINVAL;
91 }
92
93 static int dell_wmi_setkeycode(struct input_dev *dev, int scancode, int keycode)
94 {
95         struct key_entry *key;
96         int old_keycode;
97
98         if (keycode < 0 || keycode > KEY_MAX)
99                 return -EINVAL;
100
101         key = dell_wmi_get_entry_by_scancode(scancode);
102         if (key && key->type == KE_KEY) {
103                 old_keycode = key->keycode;
104                 key->keycode = keycode;
105                 set_bit(keycode, dev->keybit);
106                 if (!dell_wmi_get_entry_by_keycode(old_keycode))
107                         clear_bit(old_keycode, dev->keybit);
108                 return 0;
109         }
110         return -EINVAL;
111 }
112
113 static void dell_wmi_notify(u32 value, void *context)
114 {
115         struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
116         static struct key_entry *key;
117         union acpi_object *obj;
118
119         wmi_get_event_data(value, &response);
120
121         obj = (union acpi_object *)response.pointer;
122
123         if (obj && obj->type == ACPI_TYPE_BUFFER) {
124                 int *buffer = (int *)obj->buffer.pointer;
125                 /*
126                  *  The upper bytes of the event may contain
127                  *  additional information, so mask them off for the
128                  *  scancode lookup
129                  */
130                 key = dell_wmi_get_entry_by_scancode(buffer[1] & 0xFFFF);
131                 if (key) {
132                         input_report_key(dell_wmi_input_dev, key->keycode, 1);
133                         input_sync(dell_wmi_input_dev);
134                         input_report_key(dell_wmi_input_dev, key->keycode, 0);
135                         input_sync(dell_wmi_input_dev);
136                 } else
137                         printk(KERN_INFO "dell-wmi: Unknown key %x pressed\n",
138                                buffer[1]);
139         }
140 }
141
142 static int __init dell_wmi_input_setup(void)
143 {
144         struct key_entry *key;
145         int err;
146
147         dell_wmi_input_dev = input_allocate_device();
148
149         if (!dell_wmi_input_dev)
150                 return -ENOMEM;
151
152         dell_wmi_input_dev->name = "Dell WMI hotkeys";
153         dell_wmi_input_dev->phys = "wmi/input0";
154         dell_wmi_input_dev->id.bustype = BUS_HOST;
155         dell_wmi_input_dev->getkeycode = dell_wmi_getkeycode;
156         dell_wmi_input_dev->setkeycode = dell_wmi_setkeycode;
157
158         for (key = dell_wmi_keymap; key->type != KE_END; key++) {
159                 switch (key->type) {
160                 case KE_KEY:
161                         set_bit(EV_KEY, dell_wmi_input_dev->evbit);
162                         set_bit(key->keycode, dell_wmi_input_dev->keybit);
163                         break;
164                 case KE_SW:
165                         set_bit(EV_SW, dell_wmi_input_dev->evbit);
166                         set_bit(key->keycode, dell_wmi_input_dev->swbit);
167                         break;
168                 }
169         }
170
171         err = input_register_device(dell_wmi_input_dev);
172
173         if (err) {
174                 input_free_device(dell_wmi_input_dev);
175                 return err;
176         }
177
178         return 0;
179 }
180
181 static int __init dell_wmi_init(void)
182 {
183         int err;
184
185         if (wmi_has_guid(DELL_EVENT_GUID)) {
186                 err = dell_wmi_input_setup();
187
188                 if (err)
189                         return err;
190
191                 err = wmi_install_notify_handler(DELL_EVENT_GUID,
192                                                  dell_wmi_notify, NULL);
193                 if (err) {
194                         input_unregister_device(dell_wmi_input_dev);
195                         printk(KERN_ERR "dell-wmi: Unable to register"
196                                " notify handler - %d\n", err);
197                         return err;
198                 }
199
200         } else
201                 printk(KERN_WARNING "dell-wmi: No known WMI GUID found\n");
202
203         return 0;
204 }
205
206 static void __exit dell_wmi_exit(void)
207 {
208         if (wmi_has_guid(DELL_EVENT_GUID)) {
209                 wmi_remove_notify_handler(DELL_EVENT_GUID);
210                 input_unregister_device(dell_wmi_input_dev);
211         }
212 }
213
214 module_init(dell_wmi_init);
215 module_exit(dell_wmi_exit);