SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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
  25 #include <linux/kernel.h>
  26 #include <linux/input.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 struct key_entry {
  56         char type;              /* See KE_* below */
  57         u16 code;
  58         u16 keycode;
  59         int instance;
  60         ktime_t last_pressed;
  61 };
  62
  63 /*
  64  * KE_KEY the only used key type, but keep this, others might also
  65  * show up in the future. Compare with hp-wmi.c
  66  */
  67 enum { KE_KEY, KE_END };
  68
  69 static struct key_entry msi_wmi_keymap[] = {
  70         { KE_KEY, 0xd0, KEY_BRIGHTNESSUP,   0, {0, } },
  71         { KE_KEY, 0xd1, KEY_BRIGHTNESSDOWN, 1, {0, } },
  72         { KE_KEY, 0xd2, KEY_VOLUMEUP,   2, {0, } },
  73         { KE_KEY, 0xd3, KEY_VOLUMEDOWN, 3, {0, } },
  74         { KE_END, 0}
  75 };
  76
  77 struct backlight_device *backlight;
  78
  79 static int backlight_map[] = { 0x00, 0x33, 0x66, 0x99, 0xCC, 0xFF };
  80
  81 static struct input_dev *msi_wmi_input_dev;
  82
  83 static int msi_wmi_query_block(int instance, int *ret)
  84 {
  85         acpi_status status;
  86         union acpi_object *obj;
  87
  88         struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL };
  89
  90         status = wmi_query_block(MSIWMI_BIOS_GUID, instance, &output);
  91
  92         obj = output.pointer;
  93
  94         if (!obj || obj->type != ACPI_TYPE_INTEGER) {
  95                 if (obj) {
  96                         printk(KERN_ERR DRV_PFX "query block returned object "
  97                                "type: %d - buffer length:%d\n", obj->type,
  98                                obj->type == ACPI_TYPE_BUFFER ?
  99                                obj->buffer.length : 0);
 100                 }
 101                 kfree(obj);
 102                 return -EINVAL;
 103         }
 104         *ret = obj->integer.value;
 105         kfree(obj);
 106         return 0;
 107 }
 108
 109 static int msi_wmi_set_block(int instance, int value)
 110 {
 111         acpi_status status;
 112
 113         struct acpi_buffer input = { sizeof(int), &value };
 114
 115         dprintk("Going to set block of instance: %d - value: %d\n",
 116                 instance, value);
 117
 118         status = wmi_set_block(MSIWMI_BIOS_GUID, instance, &input);
 119
 120         return ACPI_SUCCESS(status) ? 0 : 1;
 121 }
 122
 123 static int bl_get(struct backlight_device *bd)
 124 {
 125         int level, err, ret = 0;
 126
 127         /* Instance 1 is "get backlight", cmp with DSDT */
 128         err = msi_wmi_query_block(1, &ret);
 129         if (err)
 130                 printk(KERN_ERR DRV_PFX "Could not query backlight: %d\n", err);
 131         dprintk("Get: Query block returned: %d\n", ret);
 132         for (level = 0; level < ARRAY_SIZE(backlight_map); level++) {
 133                 if (backlight_map[level] == ret) {
 134                         dprintk("Current backlight level: 0x%X - index: %d\n",
 135                                 backlight_map[level], level);
 136                         break;
 137                 }
 138         }
 139         if (level == ARRAY_SIZE(backlight_map)) {
 140                 printk(KERN_ERR DRV_PFX "get: Invalid brightness value: 0x%X\n",
 141                        ret);
 142                 return -EINVAL;
 143         }
 144         return level;
 145 }
 146
 147 static int bl_set_status(struct backlight_device *bd)
 148 {
 149         int bright = bd->props.brightness;
 150         if (bright >= ARRAY_SIZE(backlight_map) || bright < 0)
 151                 return -EINVAL;
 152
 153         /* Instance 0 is "set backlight" */
 154         return msi_wmi_set_block(0, backlight_map[bright]);
 155 }
 156
 157 static struct backlight_ops msi_backlight_ops = {
 158         .get_brightness = bl_get,
 159         .update_status  = bl_set_status,
 160 };
 161
 162 static struct key_entry *msi_wmi_get_entry_by_scancode(int code)
 163 {
 164         struct key_entry *key;
 165
 166         for (key = msi_wmi_keymap; key->type != KE_END; key++)
 167                 if (code == key->code)
 168                         return key;
 169
 170         return NULL;
 171 }
 172
 173 static struct key_entry *msi_wmi_get_entry_by_keycode(int keycode)
 174 {
 175         struct key_entry *key;
 176
 177         for (key = msi_wmi_keymap; key->type != KE_END; key++)
 178                 if (key->type == KE_KEY && keycode == key->keycode)
 179                         return key;
 180
 181         return NULL;
 182 }
 183
 184 static int msi_wmi_getkeycode(struct input_dev *dev, int scancode, int *keycode)
 185 {
 186         struct key_entry *key = msi_wmi_get_entry_by_scancode(scancode);
 187
 188         if (key && key->type == KE_KEY) {
 189                 *keycode = key->keycode;
 190                 return 0;
 191         }
 192
 193         return -EINVAL;
 194 }
 195
 196 static int msi_wmi_setkeycode(struct input_dev *dev, int scancode, int keycode)
 197 {
 198         struct key_entry *key;
 199         int old_keycode;
 200
 201         if (keycode < 0 || keycode > KEY_MAX)
 202                 return -EINVAL;
 203
 204         key = msi_wmi_get_entry_by_scancode(scancode);
 205         if (key && key->type == KE_KEY) {
 206                 old_keycode = key->keycode;
 207                 key->keycode = keycode;
 208                 set_bit(keycode, dev->keybit);
 209                 if (!msi_wmi_get_entry_by_keycode(old_keycode))
 210                         clear_bit(old_keycode, dev->keybit);
 211                 return 0;
 212         }
 213
 214         return -EINVAL;
 215 }
 216
 217 static void msi_wmi_notify(u32 value, void *context)
 218 {
 219         struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
 220         static struct key_entry *key;
 221         union acpi_object *obj;
 222         ktime_t cur;
 223
 224         wmi_get_event_data(value, &response);
 225
 226         obj = (union acpi_object *)response.pointer;
 227
 228         if (obj && obj->type == ACPI_TYPE_INTEGER) {
 229                 int eventcode = obj->integer.value;
 230                 dprintk("Eventcode: 0x%x\n", eventcode);
 231                 key = msi_wmi_get_entry_by_scancode(eventcode);
 232                 if (key) {
 233                         cur = ktime_get_real();
 234                         /* Ignore event if the same event happened in a 50 ms
 235                            timeframe -> Key press may result in 10-20 GPEs */
 236                         if (ktime_to_us(ktime_sub(cur, key->last_pressed))
 237                             < 1000 * 50) {
 238                                 dprintk("Suppressed key event 0x%X - "
 239                                         "Last press was %lld us ago\n",
 240                                          key->code,
 241                                          ktime_to_us(ktime_sub(cur,
 242                                                        key->last_pressed)));
 243                                 return;
 244                         }
 245                         key->last_pressed = cur;
 246
 247                         switch (key->type) {
 248                         case KE_KEY:
 249                                 /* Brightness is served via acpi video driver */
 250                                 if (!backlight &&
 251                                     (key->keycode == KEY_BRIGHTNESSUP ||
 252                                      key->keycode == KEY_BRIGHTNESSDOWN))
 253                                         break;
 254
 255                                 dprintk("Send key: 0x%X - "
 256                                         "Input layer keycode: %d\n", key->code,
 257                                          key->keycode);
 258                                 input_report_key(msi_wmi_input_dev,
 259                                                  key->keycode, 1);
 260                                 input_sync(msi_wmi_input_dev);
 261                                 input_report_key(msi_wmi_input_dev,
 262                                                  key->keycode, 0);
 263                                 input_sync(msi_wmi_input_dev);
 264                                 break;
 265                         }
 266                 } else
 267                         printk(KERN_INFO "Unknown key pressed - %x\n",
 268                                eventcode);
 269         } else
 270                 printk(KERN_INFO DRV_PFX "Unknown event received\n");
 271         kfree(response.pointer);
 272 }
 273
 274 static int __init msi_wmi_input_setup(void)
 275 {
 276         struct key_entry *key;
 277         int err;
 278
 279         msi_wmi_input_dev = input_allocate_device();
 280         if (!msi_wmi_input_dev)
 281                 return -ENOMEM;
 282
 283         msi_wmi_input_dev->name = "MSI WMI hotkeys";
 284         msi_wmi_input_dev->phys = "wmi/input0";
 285         msi_wmi_input_dev->id.bustype = BUS_HOST;
 286         msi_wmi_input_dev->getkeycode = msi_wmi_getkeycode;
 287         msi_wmi_input_dev->setkeycode = msi_wmi_setkeycode;
 288
 289         for (key = msi_wmi_keymap; key->type != KE_END; key++) {
 290                 switch (key->type) {
 291                 case KE_KEY:
 292                         set_bit(EV_KEY, msi_wmi_input_dev->evbit);
 293                         set_bit(key->keycode, msi_wmi_input_dev->keybit);
 294                         break;
 295                 }
 296         }
 297
 298         err = input_register_device(msi_wmi_input_dev);
 299
 300         if (err) {
 301                 input_free_device(msi_wmi_input_dev);
 302                 return err;
 303         }
 304
 305         return 0;
 306 }
 307
 308 static int __init msi_wmi_init(void)
 309 {
 310         int err;
 311
 312         if (!wmi_has_guid(MSIWMI_EVENT_GUID)) {
 313                 printk(KERN_ERR
 314                        "This machine doesn't have MSI-hotkeys through WMI\n");
 315                 return -ENODEV;
 316         }
 317         err = wmi_install_notify_handler(MSIWMI_EVENT_GUID,
 318                         msi_wmi_notify, NULL);
 319         if (err)
 320                 return -EINVAL;
 321
 322         err = msi_wmi_input_setup();
 323         if (err)
 324                 goto err_uninstall_notifier;
 325
 326         if (!acpi_video_backlight_support()) {
 327                 backlight = backlight_device_register(DRV_NAME,
 328                                 NULL, NULL, &msi_backlight_ops);
 329                 if (IS_ERR(backlight))
 330                         goto err_free_input;
 331
 332                 backlight->props.max_brightness = ARRAY_SIZE(backlight_map) - 1;
 333                 err = bl_get(NULL);
 334                 if (err < 0)
 335                         goto err_free_backlight;
 336
 337                 backlight->props.brightness = err;
 338         }
 339         dprintk("Event handler installed\n");
 340
 341         return 0;
 342
 343 err_free_backlight:
 344         backlight_device_unregister(backlight);
 345 err_free_input:
 346         input_unregister_device(msi_wmi_input_dev);
 347 err_uninstall_notifier:
 348         wmi_remove_notify_handler(MSIWMI_EVENT_GUID);
 349         return err;
 350 }
 351
 352 static void __exit msi_wmi_exit(void)
 353 {
 354         if (wmi_has_guid(MSIWMI_EVENT_GUID)) {
 355                 wmi_remove_notify_handler(MSIWMI_EVENT_GUID);
 356                 input_unregister_device(msi_wmi_input_dev);
 357                 backlight_device_unregister(backlight);
 358         }
 359 }
 360
 361 module_init(msi_wmi_init);
 362 module_exit(msi_wmi_exit);