msi-wmi: switch to using input sparse keymap library
[safe/jmp/linux-2.6] / drivers / platform / x86 / msi-wmi.c
1 /*
2  * MSI WMI hotkeys
3  *
4  * Copyright (C) 2009 Novell <trenn@suse.de>
5  *
6  * Most stuff taken over from hp-wmi
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; either version 2 of the License, or
11  *  (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  *  GNU General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  */
22
23
24 #include <linux/kernel.h>
25 #include <linux/input.h>
26 #include <linux/input/sparse-keymap.h>
27 #include <linux/acpi.h>
28 #include <linux/backlight.h>
29
30 MODULE_AUTHOR("Thomas Renninger <trenn@suse.de>");
31 MODULE_DESCRIPTION("MSI laptop WMI hotkeys driver");
32 MODULE_LICENSE("GPL");
33
34 MODULE_ALIAS("wmi:551A1F84-FBDD-4125-91DB-3EA8F44F1D45");
35 MODULE_ALIAS("wmi:B6F3EEF2-3D2F-49DC-9DE3-85BCE18C62F2");
36
37 /* Temporary workaround until the WMI sysfs interface goes in
38                 { "svn", DMI_SYS_VENDOR },
39                 { "pn",  DMI_PRODUCT_NAME },
40                 { "pvr", DMI_PRODUCT_VERSION },
41                 { "rvn", DMI_BOARD_VENDOR },
42                 { "rn",  DMI_BOARD_NAME },
43 */
44
45 MODULE_ALIAS("dmi:*:svnMICRO-STARINTERNATIONAL*:pnMS-6638:*");
46
47 #define DRV_NAME "msi-wmi"
48 #define DRV_PFX DRV_NAME ": "
49
50 #define MSIWMI_BIOS_GUID "551A1F84-FBDD-4125-91DB-3EA8F44F1D45"
51 #define MSIWMI_EVENT_GUID "B6F3EEF2-3D2F-49DC-9DE3-85BCE18C62F2"
52
53 #define dprintk(msg...) pr_debug(DRV_PFX msg)
54
55 #define KEYCODE_BASE 0xD0
56 static struct key_entry msi_wmi_keymap[] = {
57         { KE_KEY, KEYCODE_BASE,     {KEY_BRIGHTNESSUP} },
58         { KE_KEY, KEYCODE_BASE + 1, {KEY_BRIGHTNESSDOWN} },
59         { KE_KEY, KEYCODE_BASE + 2, {KEY_VOLUMEUP} },
60         { KE_KEY, KEYCODE_BASE + 3, {KEY_VOLUMEDOWN} },
61         { KE_END, 0}
62 };
63 static ktime_t last_pressed[ARRAY_SIZE(msi_wmi_keymap) - 1];
64
65 struct backlight_device *backlight;
66
67 static int backlight_map[] = { 0x00, 0x33, 0x66, 0x99, 0xCC, 0xFF };
68
69 static struct input_dev *msi_wmi_input_dev;
70
71 static int msi_wmi_query_block(int instance, int *ret)
72 {
73         acpi_status status;
74         union acpi_object *obj;
75
76         struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL };
77
78         status = wmi_query_block(MSIWMI_BIOS_GUID, instance, &output);
79
80         obj = output.pointer;
81
82         if (!obj || obj->type != ACPI_TYPE_INTEGER) {
83                 if (obj) {
84                         printk(KERN_ERR DRV_PFX "query block returned object "
85                                "type: %d - buffer length:%d\n", obj->type,
86                                obj->type == ACPI_TYPE_BUFFER ?
87                                obj->buffer.length : 0);
88                 }
89                 kfree(obj);
90                 return -EINVAL;
91         }
92         *ret = obj->integer.value;
93         kfree(obj);
94         return 0;
95 }
96
97 static int msi_wmi_set_block(int instance, int value)
98 {
99         acpi_status status;
100
101         struct acpi_buffer input = { sizeof(int), &value };
102
103         dprintk("Going to set block of instance: %d - value: %d\n",
104                 instance, value);
105
106         status = wmi_set_block(MSIWMI_BIOS_GUID, instance, &input);
107
108         return ACPI_SUCCESS(status) ? 0 : 1;
109 }
110
111 static int bl_get(struct backlight_device *bd)
112 {
113         int level, err, ret = 0;
114
115         /* Instance 1 is "get backlight", cmp with DSDT */
116         err = msi_wmi_query_block(1, &ret);
117         if (err)
118                 printk(KERN_ERR DRV_PFX "Could not query backlight: %d\n", err);
119         dprintk("Get: Query block returned: %d\n", ret);
120         for (level = 0; level < ARRAY_SIZE(backlight_map); level++) {
121                 if (backlight_map[level] == ret) {
122                         dprintk("Current backlight level: 0x%X - index: %d\n",
123                                 backlight_map[level], level);
124                         break;
125                 }
126         }
127         if (level == ARRAY_SIZE(backlight_map)) {
128                 printk(KERN_ERR DRV_PFX "get: Invalid brightness value: 0x%X\n",
129                        ret);
130                 return -EINVAL;
131         }
132         return level;
133 }
134
135 static int bl_set_status(struct backlight_device *bd)
136 {
137         int bright = bd->props.brightness;
138         if (bright >= ARRAY_SIZE(backlight_map) || bright < 0)
139                 return -EINVAL;
140
141         /* Instance 0 is "set backlight" */
142         return msi_wmi_set_block(0, backlight_map[bright]);
143 }
144
145 static struct backlight_ops msi_backlight_ops = {
146         .get_brightness = bl_get,
147         .update_status  = bl_set_status,
148 };
149
150 static void msi_wmi_notify(u32 value, void *context)
151 {
152         struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
153         static struct key_entry *key;
154         union acpi_object *obj;
155         ktime_t cur;
156
157         wmi_get_event_data(value, &response);
158
159         obj = (union acpi_object *)response.pointer;
160
161         if (obj && obj->type == ACPI_TYPE_INTEGER) {
162                 int eventcode = obj->integer.value;
163                 dprintk("Eventcode: 0x%x\n", eventcode);
164                 key = sparse_keymap_entry_from_scancode(msi_wmi_input_dev,
165                                 eventcode);
166                 if (key) {
167                         ktime_t diff;
168                         cur = ktime_get_real();
169                         diff = ktime_sub(cur, last_pressed[key->code -
170                                         KEYCODE_BASE]);
171                         /* Ignore event if the same event happened in a 50 ms
172                            timeframe -> Key press may result in 10-20 GPEs */
173                         if (ktime_to_us(diff) < 1000 * 50) {
174                                 dprintk("Suppressed key event 0x%X - "
175                                         "Last press was %lld us ago\n",
176                                          key->code, ktime_to_us(diff));
177                                 return;
178                         }
179                         last_pressed[key->code - KEYCODE_BASE] = cur;
180
181                         if (key->type == KE_KEY &&
182                         /* Brightness is served via acpi video driver */
183                         (backlight || (key->keycode != KEY_BRIGHTNESSUP &&
184                         key->keycode != KEY_BRIGHTNESSDOWN))) {
185                                 dprintk("Send key: 0x%X - "
186                                         "Input layer keycode: %d\n", key->code,
187                                          key->keycode);
188                                 sparse_keymap_report_entry(msi_wmi_input_dev,
189                                                 key, 1, true);
190                         }
191                 } else
192                         printk(KERN_INFO "Unknown key pressed - %x\n",
193                                eventcode);
194         } else
195                 printk(KERN_INFO DRV_PFX "Unknown event received\n");
196         kfree(response.pointer);
197 }
198
199 static int __init msi_wmi_input_setup(void)
200 {
201         int err;
202
203         msi_wmi_input_dev = input_allocate_device();
204         if (!msi_wmi_input_dev)
205                 return -ENOMEM;
206
207         msi_wmi_input_dev->name = "MSI WMI hotkeys";
208         msi_wmi_input_dev->phys = "wmi/input0";
209         msi_wmi_input_dev->id.bustype = BUS_HOST;
210
211         err = sparse_keymap_setup(msi_wmi_input_dev, msi_wmi_keymap, NULL);
212         if (err)
213                 goto err_free_dev;
214
215         err = input_register_device(msi_wmi_input_dev);
216
217         if (err)
218                 goto err_free_keymap;
219
220         memset(last_pressed, 0, sizeof(last_pressed));
221
222         return 0;
223
224 err_free_keymap:
225         sparse_keymap_free(msi_wmi_input_dev);
226 err_free_dev:
227         input_free_device(msi_wmi_input_dev);
228         return err;
229 }
230
231 static int __init msi_wmi_init(void)
232 {
233         int err;
234
235         if (!wmi_has_guid(MSIWMI_EVENT_GUID)) {
236                 printk(KERN_ERR
237                        "This machine doesn't have MSI-hotkeys through WMI\n");
238                 return -ENODEV;
239         }
240         err = wmi_install_notify_handler(MSIWMI_EVENT_GUID,
241                         msi_wmi_notify, NULL);
242         if (err)
243                 return -EINVAL;
244
245         err = msi_wmi_input_setup();
246         if (err)
247                 goto err_uninstall_notifier;
248
249         if (!acpi_video_backlight_support()) {
250                 backlight = backlight_device_register(DRV_NAME,
251                                 NULL, NULL, &msi_backlight_ops);
252                 if (IS_ERR(backlight))
253                         goto err_free_input;
254
255                 backlight->props.max_brightness = ARRAY_SIZE(backlight_map) - 1;
256                 err = bl_get(NULL);
257                 if (err < 0)
258                         goto err_free_backlight;
259
260                 backlight->props.brightness = err;
261         }
262         dprintk("Event handler installed\n");
263
264         return 0;
265
266 err_free_backlight:
267         backlight_device_unregister(backlight);
268 err_free_input:
269         input_unregister_device(msi_wmi_input_dev);
270 err_uninstall_notifier:
271         wmi_remove_notify_handler(MSIWMI_EVENT_GUID);
272         return err;
273 }
274
275 static void __exit msi_wmi_exit(void)
276 {
277         if (wmi_has_guid(MSIWMI_EVENT_GUID)) {
278                 wmi_remove_notify_handler(MSIWMI_EVENT_GUID);
279                 sparse_keymap_free(msi_wmi_input_dev);
280                 input_unregister_device(msi_wmi_input_dev);
281                 backlight_device_unregister(backlight);
282         }
283 }
284
285 module_init(msi_wmi_init);
286 module_exit(msi_wmi_exit);