4 * Copyright (C) 2009 Novell <trenn@suse.de>
6 * Most stuff taken over from hp-wmi
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.
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.
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
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/init.h>
28 #include <linux/types.h>
29 #include <linux/input.h>
30 #include <acpi/acpi_drivers.h>
31 #include <linux/acpi.h>
32 #include <linux/string.h>
33 #include <linux/hrtimer.h>
34 #include <linux/backlight.h>
36 MODULE_AUTHOR("Thomas Renninger <trenn@suse.de>");
37 MODULE_DESCRIPTION("MSI laptop WMI hotkeys driver");
38 MODULE_LICENSE("GPL");
41 module_param(debug, int, 0);
42 MODULE_PARM_DESC(debug, "Set this to 1 to let the driver be more verbose");
44 MODULE_ALIAS("wmi:551A1F84-FBDD-4125-91DB-3EA8F44F1D45");
45 MODULE_ALIAS("wmi:B6F3EEF2-3D2F-49DC-9DE3-85BCE18C62F2");
47 /* Temporary workaround until the WMI sysfs interface goes in
48 { "svn", DMI_SYS_VENDOR },
49 { "pn", DMI_PRODUCT_NAME },
50 { "pvr", DMI_PRODUCT_VERSION },
51 { "rvn", DMI_BOARD_VENDOR },
52 { "rn", DMI_BOARD_NAME },
55 MODULE_ALIAS("dmi:*:svnMICRO-STARINTERNATIONAL*:pnMS-6638:*");
57 #define DRV_NAME "msi-wmi"
58 #define DRV_PFX DRV_NAME ": "
60 #define MSIWMI_BIOS_GUID "551A1F84-FBDD-4125-91DB-3EA8F44F1D45"
61 #define MSIWMI_EVENT_GUID "B6F3EEF2-3D2F-49DC-9DE3-85BCE18C62F2"
63 #define dprintk(msg...) do { \
65 printk(KERN_INFO DRV_PFX msg); \
69 char type; /* See KE_* below */
77 * KE_KEY the only used key type, but keep this, others might also
78 * show up in the future. Compare with hp-wmi.c
80 enum { KE_KEY, KE_END };
82 static struct key_entry msi_wmi_keymap[] = {
83 { KE_KEY, 0xd0, KEY_BRIGHTNESSUP, 0, {0, } },
84 { KE_KEY, 0xd1, KEY_BRIGHTNESSDOWN, 1, {0, } },
85 { KE_KEY, 0xd2, KEY_VOLUMEUP, 2, {0, } },
86 { KE_KEY, 0xd3, KEY_VOLUMEDOWN, 3, {0, } },
90 struct backlight_device *backlight;
92 static int backlight_map[] = { 0x00, 0x33, 0x66, 0x99, 0xCC, 0xFF };
94 static struct input_dev *msi_wmi_input_dev;
96 static int msi_wmi_query_block(int instance, int *ret)
99 union acpi_object *obj;
101 struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL };
103 status = wmi_query_block(MSIWMI_BIOS_GUID, instance, &output);
105 obj = output.pointer;
107 if (!obj || obj->type != ACPI_TYPE_INTEGER) {
109 printk(KERN_ERR DRV_PFX "query block returned object "
110 "type: %d - buffer length:%d\n", obj->type,
111 obj->type == ACPI_TYPE_BUFFER ?
112 obj->buffer.length : 0);
117 *ret = obj->integer.value;
122 static int msi_wmi_set_block(int instance, int value)
126 struct acpi_buffer input = { sizeof(int), &value };
128 dprintk("Going to set block of instance: %d - value: %d\n",
131 status = wmi_set_block(MSIWMI_BIOS_GUID, instance, &input);
133 return ACPI_SUCCESS(status) ? 0 : 1;
136 static int bl_get(struct backlight_device *bd)
138 int level, err, ret = 0;
140 /* Instance 1 is "get backlight", cmp with DSDT */
141 err = msi_wmi_query_block(1, &ret);
143 printk(KERN_ERR DRV_PFX "Could not query backlight: %d\n", err);
144 dprintk("Get: Query block returned: %d\n", ret);
145 for (level = 0; level < ARRAY_SIZE(backlight_map); level++) {
146 if (backlight_map[level] == ret) {
147 dprintk("Current backlight level: 0x%X - index: %d\n",
148 backlight_map[level], level);
152 if (level == ARRAY_SIZE(backlight_map)) {
153 printk(KERN_ERR DRV_PFX "get: Invalid brightness value: 0x%X\n",
160 static int bl_set_status(struct backlight_device *bd)
162 int bright = bd->props.brightness;
163 if (bright >= ARRAY_SIZE(backlight_map) || bright < 0)
166 /* Instance 0 is "set backlight" */
167 return msi_wmi_set_block(0, backlight_map[bright]);
170 static struct backlight_ops msi_backlight_ops = {
171 .get_brightness = bl_get,
172 .update_status = bl_set_status,
175 static struct key_entry *msi_wmi_get_entry_by_scancode(int code)
177 struct key_entry *key;
179 for (key = msi_wmi_keymap; key->type != KE_END; key++)
180 if (code == key->code)
186 static struct key_entry *msi_wmi_get_entry_by_keycode(int keycode)
188 struct key_entry *key;
190 for (key = msi_wmi_keymap; key->type != KE_END; key++)
191 if (key->type == KE_KEY && keycode == key->keycode)
197 static int msi_wmi_getkeycode(struct input_dev *dev, int scancode, int *keycode)
199 struct key_entry *key = msi_wmi_get_entry_by_scancode(scancode);
201 if (key && key->type == KE_KEY) {
202 *keycode = key->keycode;
209 static int msi_wmi_setkeycode(struct input_dev *dev, int scancode, int keycode)
211 struct key_entry *key;
214 if (keycode < 0 || keycode > KEY_MAX)
217 key = msi_wmi_get_entry_by_scancode(scancode);
218 if (key && key->type == KE_KEY) {
219 old_keycode = key->keycode;
220 key->keycode = keycode;
221 set_bit(keycode, dev->keybit);
222 if (!msi_wmi_get_entry_by_keycode(old_keycode))
223 clear_bit(old_keycode, dev->keybit);
230 static void msi_wmi_notify(u32 value, void *context)
232 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
233 static struct key_entry *key;
234 union acpi_object *obj;
237 wmi_get_event_data(value, &response);
239 obj = (union acpi_object *)response.pointer;
241 if (obj && obj->type == ACPI_TYPE_INTEGER) {
242 int eventcode = obj->integer.value;
243 dprintk("Eventcode: 0x%x\n", eventcode);
244 key = msi_wmi_get_entry_by_scancode(eventcode);
246 cur = ktime_get_real();
247 /* Ignore event if the same event happened in a 50 ms
248 timeframe -> Key press may result in 10-20 GPEs */
249 if (ktime_to_us(ktime_sub(cur, key->last_pressed))
251 dprintk("Suppressed key event 0x%X - "
252 "Last press was %lld us ago\n",
254 ktime_to_us(ktime_sub(cur,
255 key->last_pressed)));
258 key->last_pressed = cur;
262 /* Brightness is served via acpi video driver */
264 (key->keycode == KEY_BRIGHTNESSUP ||
265 key->keycode == KEY_BRIGHTNESSDOWN))
268 dprintk("Send key: 0x%X - "
269 "Input layer keycode: %d\n", key->code,
271 input_report_key(msi_wmi_input_dev,
273 input_sync(msi_wmi_input_dev);
274 input_report_key(msi_wmi_input_dev,
276 input_sync(msi_wmi_input_dev);
280 printk(KERN_INFO "Unknown key pressed - %x\n",
283 printk(KERN_INFO DRV_PFX "Unknown event received\n");
284 kfree(response.pointer);
287 static int __init msi_wmi_input_setup(void)
289 struct key_entry *key;
292 msi_wmi_input_dev = input_allocate_device();
294 msi_wmi_input_dev->name = "MSI WMI hotkeys";
295 msi_wmi_input_dev->phys = "wmi/input0";
296 msi_wmi_input_dev->id.bustype = BUS_HOST;
297 msi_wmi_input_dev->getkeycode = msi_wmi_getkeycode;
298 msi_wmi_input_dev->setkeycode = msi_wmi_setkeycode;
300 for (key = msi_wmi_keymap; key->type != KE_END; key++) {
303 set_bit(EV_KEY, msi_wmi_input_dev->evbit);
304 set_bit(key->keycode, msi_wmi_input_dev->keybit);
309 err = input_register_device(msi_wmi_input_dev);
312 input_free_device(msi_wmi_input_dev);
319 static int __init msi_wmi_init(void)
323 if (wmi_has_guid(MSIWMI_EVENT_GUID)) {
324 err = wmi_install_notify_handler(MSIWMI_EVENT_GUID,
325 msi_wmi_notify, NULL);
329 err = msi_wmi_input_setup();
331 wmi_remove_notify_handler(MSIWMI_EVENT_GUID);
335 if (!acpi_video_backlight_support()) {
336 backlight = backlight_device_register(DRV_NAME,
337 NULL, NULL, &msi_backlight_ops);
338 if (IS_ERR(backlight)) {
339 wmi_remove_notify_handler(MSIWMI_EVENT_GUID);
340 input_unregister_device(msi_wmi_input_dev);
344 backlight->props.max_brightness = ARRAY_SIZE(backlight_map) - 1;
347 wmi_remove_notify_handler(MSIWMI_EVENT_GUID);
348 input_unregister_device(msi_wmi_input_dev);
349 backlight_device_unregister(backlight);
352 backlight->props.brightness = err;
355 printk(KERN_INFO DRV_PFX "Event handler installed\n");
359 static void __exit msi_wmi_exit(void)
361 if (wmi_has_guid(MSIWMI_EVENT_GUID)) {
362 wmi_remove_notify_handler(MSIWMI_EVENT_GUID);
363 input_unregister_device(msi_wmi_input_dev);
364 backlight_device_unregister(backlight);
368 module_init(msi_wmi_init);
369 module_exit(msi_wmi_exit);