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