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#include <linux/slab.h> 30 31MODULE_AUTHOR("Thomas Renninger <trenn@suse.de>"); 32MODULE_DESCRIPTION("MSI laptop WMI hotkeys driver"); 33MODULE_LICENSE("GPL"); 34 35MODULE_ALIAS("wmi:551A1F84-FBDD-4125-91DB-3EA8F44F1D45"); 36MODULE_ALIAS("wmi:B6F3EEF2-3D2F-49DC-9DE3-85BCE18C62F2"); 37 38#define DRV_NAME "msi-wmi" 39#define DRV_PFX DRV_NAME ": " 40 41#define MSIWMI_BIOS_GUID "551A1F84-FBDD-4125-91DB-3EA8F44F1D45" 42#define MSIWMI_EVENT_GUID "B6F3EEF2-3D2F-49DC-9DE3-85BCE18C62F2" 43 44#define dprintk(msg...) pr_debug(DRV_PFX msg) 45 46#define KEYCODE_BASE 0xD0 47#define MSI_WMI_BRIGHTNESSUP KEYCODE_BASE 48#define MSI_WMI_BRIGHTNESSDOWN (KEYCODE_BASE + 1) 49#define MSI_WMI_VOLUMEUP (KEYCODE_BASE + 2) 50#define MSI_WMI_VOLUMEDOWN (KEYCODE_BASE + 3) 51static struct key_entry msi_wmi_keymap[] = { 52 { KE_KEY, MSI_WMI_BRIGHTNESSUP, {KEY_BRIGHTNESSUP} }, 53 { KE_KEY, MSI_WMI_BRIGHTNESSDOWN, {KEY_BRIGHTNESSDOWN} }, 54 { KE_KEY, MSI_WMI_VOLUMEUP, {KEY_VOLUMEUP} }, 55 { KE_KEY, MSI_WMI_VOLUMEDOWN, {KEY_VOLUMEDOWN} }, 56 { KE_END, 0} 57}; 58static ktime_t last_pressed[ARRAY_SIZE(msi_wmi_keymap) - 1]; 59 60static struct backlight_device *backlight; 61 62static int backlight_map[] = { 0x00, 0x33, 0x66, 0x99, 0xCC, 0xFF }; 63 64static struct input_dev *msi_wmi_input_dev; 65 66static int msi_wmi_query_block(int instance, int *ret) 67{ 68 acpi_status status; 69 union acpi_object *obj; 70 71 struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL }; 72 73 status = wmi_query_block(MSIWMI_BIOS_GUID, instance, &output); 74 75 obj = output.pointer; 76 77 if (!obj || obj->type != ACPI_TYPE_INTEGER) { 78 if (obj) { 79 printk(KERN_ERR DRV_PFX "query block returned object " 80 "type: %d - buffer length:%d\n", obj->type, 81 obj->type == ACPI_TYPE_BUFFER ? 82 obj->buffer.length : 0); 83 } 84 kfree(obj); 85 return -EINVAL; 86 } 87 *ret = obj->integer.value; 88 kfree(obj); 89 return 0; 90} 91 92static int msi_wmi_set_block(int instance, int value) 93{ 94 acpi_status status; 95 96 struct acpi_buffer input = { sizeof(int), &value }; 97 98 dprintk("Going to set block of instance: %d - value: %d\n", 99 instance, value); 100 101 status = wmi_set_block(MSIWMI_BIOS_GUID, instance, &input); 102 103 return ACPI_SUCCESS(status) ? 0 : 1; 104} 105 106static int bl_get(struct backlight_device *bd) 107{ 108 int level, err, ret; 109 110 /* Instance 1 is "get backlight", cmp with DSDT */ 111 err = msi_wmi_query_block(1, &ret); 112 if (err) { 113 printk(KERN_ERR DRV_PFX "Could not query backlight: %d\n", err); 114 return -EINVAL; 115 } 116 dprintk("Get: Query block returned: %d\n", ret); 117 for (level = 0; level < ARRAY_SIZE(backlight_map); level++) { 118 if (backlight_map[level] == ret) { 119 dprintk("Current backlight level: 0x%X - index: %d\n", 120 backlight_map[level], level); 121 break; 122 } 123 } 124 if (level == ARRAY_SIZE(backlight_map)) { 125 printk(KERN_ERR DRV_PFX "get: Invalid brightness value: 0x%X\n", 126 ret); 127 return -EINVAL; 128 } 129 return level; 130} 131 132static int bl_set_status(struct backlight_device *bd) 133{ 134 int bright = bd->props.brightness; 135 if (bright >= ARRAY_SIZE(backlight_map) || bright < 0) 136 return -EINVAL; 137 138 /* Instance 0 is "set backlight" */ 139 return msi_wmi_set_block(0, backlight_map[bright]); 140} 141 142static const struct backlight_ops msi_backlight_ops = { 143 .get_brightness = bl_get, 144 .update_status = bl_set_status, 145}; 146 147static void msi_wmi_notify(u32 value, void *context) 148{ 149 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL }; 150 static struct key_entry *key; 151 union acpi_object *obj; 152 ktime_t cur; 153 acpi_status status; 154 155 status = wmi_get_event_data(value, &response); 156 if (status != AE_OK) { 157 printk(KERN_INFO DRV_PFX "bad event status 0x%x\n", status); 158 return; 159 } 160 161 obj = (union acpi_object *)response.pointer; 162 163 if (obj && obj->type == ACPI_TYPE_INTEGER) { 164 int eventcode = obj->integer.value; 165 dprintk("Eventcode: 0x%x\n", eventcode); 166 key = sparse_keymap_entry_from_scancode(msi_wmi_input_dev, 167 eventcode); 168 if (key) { 169 ktime_t diff; 170 cur = ktime_get_real(); 171 diff = ktime_sub(cur, last_pressed[key->code - 172 KEYCODE_BASE]); 173 /* Ignore event if the same event happened in a 50 ms 174 timeframe -> Key press may result in 10-20 GPEs */ 175 if (ktime_to_us(diff) < 1000 * 50) { 176 dprintk("Suppressed key event 0x%X - " 177 "Last press was %lld us ago\n", 178 key->code, ktime_to_us(diff)); 179 return; 180 } 181 last_pressed[key->code - KEYCODE_BASE] = cur; 182 183 if (key->type == KE_KEY && 184 /* Brightness is served via acpi video driver */ 185 (!acpi_video_backlight_support() || 186 (key->code != MSI_WMI_BRIGHTNESSUP && 187 key->code != MSI_WMI_BRIGHTNESSDOWN))) { 188 dprintk("Send key: 0x%X - " 189 "Input layer keycode: %d\n", key->code, 190 key->keycode); 191 sparse_keymap_report_entry(msi_wmi_input_dev, 192 key, 1, true); 193 } 194 } else 195 printk(KERN_INFO "Unknown key pressed - %x\n", 196 eventcode); 197 } else 198 printk(KERN_INFO DRV_PFX "Unknown event received\n"); 199 kfree(response.pointer); 200} 201 202static int __init msi_wmi_input_setup(void) 203{ 204 int err; 205 206 msi_wmi_input_dev = input_allocate_device(); 207 if (!msi_wmi_input_dev) 208 return -ENOMEM; 209 210 msi_wmi_input_dev->name = "MSI WMI hotkeys"; 211 msi_wmi_input_dev->phys = "wmi/input0"; 212 msi_wmi_input_dev->id.bustype = BUS_HOST; 213 214 err = sparse_keymap_setup(msi_wmi_input_dev, msi_wmi_keymap, NULL); 215 if (err) 216 goto err_free_dev; 217 218 err = input_register_device(msi_wmi_input_dev); 219 220 if (err) 221 goto err_free_keymap; 222 223 memset(last_pressed, 0, sizeof(last_pressed)); 224 225 return 0; 226 227err_free_keymap: 228 sparse_keymap_free(msi_wmi_input_dev); 229err_free_dev: 230 input_free_device(msi_wmi_input_dev); 231 return err; 232} 233 234static int __init msi_wmi_init(void) 235{ 236 int err; 237 238 if (!wmi_has_guid(MSIWMI_EVENT_GUID)) { 239 printk(KERN_ERR 240 "This machine doesn't have MSI-hotkeys through WMI\n"); 241 return -ENODEV; 242 } 243 err = wmi_install_notify_handler(MSIWMI_EVENT_GUID, 244 msi_wmi_notify, NULL); 245 if (ACPI_FAILURE(err)) 246 return -EINVAL; 247 248 err = msi_wmi_input_setup(); 249 if (err) 250 goto err_uninstall_notifier; 251 252 if (!acpi_video_backlight_support()) { 253 struct backlight_properties props; 254 memset(&props, 0, sizeof(struct backlight_properties)); 255 props.max_brightness = ARRAY_SIZE(backlight_map) - 1; 256 backlight = backlight_device_register(DRV_NAME, NULL, NULL, 257 &msi_backlight_ops, 258 &props); 259 if (IS_ERR(backlight)) { 260 err = PTR_ERR(backlight); 261 goto err_free_input; 262 } 263 264 err = bl_get(NULL); 265 if (err < 0) 266 goto err_free_backlight; 267 268 backlight->props.brightness = err; 269 } 270 dprintk("Event handler installed\n"); 271 272 return 0; 273 274err_free_backlight: 275 backlight_device_unregister(backlight); 276err_free_input: 277 input_unregister_device(msi_wmi_input_dev); 278err_uninstall_notifier: 279 wmi_remove_notify_handler(MSIWMI_EVENT_GUID); 280 return err; 281} 282 283static void __exit msi_wmi_exit(void) 284{ 285 if (wmi_has_guid(MSIWMI_EVENT_GUID)) { 286 wmi_remove_notify_handler(MSIWMI_EVENT_GUID); 287 sparse_keymap_free(msi_wmi_input_dev); 288 input_unregister_device(msi_wmi_input_dev); 289 backlight_device_unregister(backlight); 290 } 291} 292 293module_init(msi_wmi_init); 294module_exit(msi_wmi_exit); 295