drivers/platform/x86/msi-wmi.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * MSI WMI hotkeys
   4  *
   5  * Copyright (C) 2009 Novell <trenn@suse.de>
   6  *
   7  * Most stuff taken over from hp-wmi
   8  */
   9
  10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  11
  12 #include <linux/kernel.h>
  13 #include <linux/input.h>
  14 #include <linux/input/sparse-keymap.h>
  15 #include <linux/acpi.h>
  16 #include <linux/backlight.h>
  17 #include <linux/slab.h>
  18 #include <linux/module.h>
  19 #include <acpi/video.h>
  20
  21 MODULE_AUTHOR("Thomas Renninger <trenn@suse.de>");
  22 MODULE_DESCRIPTION("MSI laptop WMI hotkeys driver");
  23 MODULE_LICENSE("GPL");
  24
  25 #define DRV_NAME "msi-wmi"
  26
  27 #define MSIWMI_BIOS_GUID "551A1F84-FBDD-4125-91DB-3EA8F44F1D45"
  28 #define MSIWMI_MSI_EVENT_GUID "B6F3EEF2-3D2F-49DC-9DE3-85BCE18C62F2"
  29 #define MSIWMI_WIND_EVENT_GUID "5B3CC38A-40D9-7245-8AE6-1145B751BE3F"
  30
  31 MODULE_ALIAS("wmi:" MSIWMI_BIOS_GUID);
  32 MODULE_ALIAS("wmi:" MSIWMI_MSI_EVENT_GUID);
  33 MODULE_ALIAS("wmi:" MSIWMI_WIND_EVENT_GUID);
  34
  35 enum msi_scancodes {
  36         /* Generic MSI keys (not present on MSI Wind) */
  37         MSI_KEY_BRIGHTNESSUP    = 0xD0,
  38         MSI_KEY_BRIGHTNESSDOWN,
  39         MSI_KEY_VOLUMEUP,
  40         MSI_KEY_VOLUMEDOWN,
  41         MSI_KEY_MUTE,
  42         /* MSI Wind keys */
  43         WIND_KEY_TOUCHPAD       = 0x08, /* Fn+F3 touchpad toggle */
  44         WIND_KEY_BLUETOOTH      = 0x56, /* Fn+F11 Bluetooth toggle */
  45         WIND_KEY_CAMERA,                /* Fn+F6 webcam toggle */
  46         WIND_KEY_WLAN           = 0x5f, /* Fn+F11 Wi-Fi toggle */
  47         WIND_KEY_TURBO,                 /* Fn+F10 turbo mode toggle */
  48         WIND_KEY_ECO            = 0x69, /* Fn+F10 ECO mode toggle */
  49 };
  50 static struct key_entry msi_wmi_keymap[] = {
  51         { KE_KEY, MSI_KEY_BRIGHTNESSUP,         {KEY_BRIGHTNESSUP} },
  52         { KE_KEY, MSI_KEY_BRIGHTNESSDOWN,       {KEY_BRIGHTNESSDOWN} },
  53         { KE_KEY, MSI_KEY_VOLUMEUP,             {KEY_VOLUMEUP} },
  54         { KE_KEY, MSI_KEY_VOLUMEDOWN,           {KEY_VOLUMEDOWN} },
  55         { KE_KEY, MSI_KEY_MUTE,                 {KEY_MUTE} },
  56
  57         /* These keys work without WMI. Ignore them to avoid double keycodes */
  58         { KE_IGNORE, WIND_KEY_TOUCHPAD,         {KEY_TOUCHPAD_TOGGLE} },
  59         { KE_IGNORE, WIND_KEY_BLUETOOTH,        {KEY_BLUETOOTH} },
  60         { KE_IGNORE, WIND_KEY_CAMERA,           {KEY_CAMERA} },
  61         { KE_IGNORE, WIND_KEY_WLAN,             {KEY_WLAN} },
  62
  63         /* These are unknown WMI events found on MSI Wind */
  64         { KE_IGNORE, 0x00 },
  65         { KE_IGNORE, 0x62 },
  66         { KE_IGNORE, 0x63 },
  67
  68         /* These are MSI Wind keys that should be handled via WMI */
  69         { KE_KEY, WIND_KEY_TURBO,               {KEY_PROG1} },
  70         { KE_KEY, WIND_KEY_ECO,                 {KEY_PROG2} },
  71
  72         { KE_END, 0 }
  73 };
  74
  75 static ktime_t last_pressed;
  76
  77 static const struct {
  78         const char *guid;
  79         bool quirk_last_pressed;
  80 } *event_wmi, event_wmis[] = {
  81         { MSIWMI_MSI_EVENT_GUID, true },
  82         { MSIWMI_WIND_EVENT_GUID, false },
  83 };
  84
  85 static struct backlight_device *backlight;
  86
  87 static int backlight_map[] = { 0x00, 0x33, 0x66, 0x99, 0xCC, 0xFF };
  88
  89 static struct input_dev *msi_wmi_input_dev;
  90
  91 static int msi_wmi_query_block(int instance, int *ret)
  92 {
  93         acpi_status status;
  94         union acpi_object *obj;
  95
  96         struct acpi_buffer output = { ACPI_ALLOCATE_BUFFER, NULL };
  97
  98         status = wmi_query_block(MSIWMI_BIOS_GUID, instance, &output);
  99
 100         obj = output.pointer;
 101
 102         if (!obj || obj->type != ACPI_TYPE_INTEGER) {
 103                 if (obj) {
 104                         pr_err("query block returned object "
 105                                "type: %d - buffer length:%d\n", obj->type,
 106                                obj->type == ACPI_TYPE_BUFFER ?
 107                                obj->buffer.length : 0);
 108                 }
 109                 kfree(obj);
 110                 return -EINVAL;
 111         }
 112         *ret = obj->integer.value;
 113         kfree(obj);
 114         return 0;
 115 }
 116
 117 static int msi_wmi_set_block(int instance, int value)
 118 {
 119         acpi_status status;
 120
 121         struct acpi_buffer input = { sizeof(int), &value };
 122
 123         pr_debug("Going to set block of instance: %d - value: %d\n",
 124                  instance, value);
 125
 126         status = wmi_set_block(MSIWMI_BIOS_GUID, instance, &input);
 127
 128         return ACPI_SUCCESS(status) ? 0 : 1;
 129 }
 130
 131 static int bl_get(struct backlight_device *bd)
 132 {
 133         int level, err, ret;
 134
 135         /* Instance 1 is "get backlight", cmp with DSDT */
 136         err = msi_wmi_query_block(1, &ret);
 137         if (err) {
 138                 pr_err("Could not query backlight: %d\n", err);
 139                 return -EINVAL;
 140         }
 141         pr_debug("Get: Query block returned: %d\n", ret);
 142         for (level = 0; level < ARRAY_SIZE(backlight_map); level++) {
 143                 if (backlight_map[level] == ret) {
 144                         pr_debug("Current backlight level: 0x%X - index: %d\n",
 145                                  backlight_map[level], level);
 146                         break;
 147                 }
 148         }
 149         if (level == ARRAY_SIZE(backlight_map)) {
 150                 pr_err("get: Invalid brightness value: 0x%X\n", ret);
 151                 return -EINVAL;
 152         }
 153         return level;
 154 }
 155
 156 static int bl_set_status(struct backlight_device *bd)
 157 {
 158         int bright = bd->props.brightness;
 159         if (bright >= ARRAY_SIZE(backlight_map) || bright < 0)
 160                 return -EINVAL;
 161
 162         /* Instance 0 is "set backlight" */
 163         return msi_wmi_set_block(0, backlight_map[bright]);
 164 }
 165
 166 static const struct backlight_ops msi_backlight_ops = {
 167         .get_brightness = bl_get,
 168         .update_status  = bl_set_status,
 169 };
 170
 171 static void msi_wmi_notify(u32 value, void *context)
 172 {
 173         struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
 174         struct key_entry *key;
 175         union acpi_object *obj;
 176         acpi_status status;
 177
 178         status = wmi_get_event_data(value, &response);
 179         if (status != AE_OK) {
 180                 pr_info("bad event status 0x%x\n", status);
 181                 return;
 182         }
 183
 184         obj = (union acpi_object *)response.pointer;
 185
 186         if (obj && obj->type == ACPI_TYPE_INTEGER) {
 187                 int eventcode = obj->integer.value;
 188                 pr_debug("Eventcode: 0x%x\n", eventcode);
 189                 key = sparse_keymap_entry_from_scancode(msi_wmi_input_dev,
 190                                 eventcode);
 191                 if (!key) {
 192                         pr_info("Unknown key pressed - %x\n", eventcode);
 193                         goto msi_wmi_notify_exit;
 194                 }
 195
 196                 if (event_wmi->quirk_last_pressed) {
 197                         ktime_t cur = ktime_get_real();
 198                         ktime_t diff = ktime_sub(cur, last_pressed);
 199                         /* Ignore event if any event happened in a 50 ms
 200                            timeframe -> Key press may result in 10-20 GPEs */
 201                         if (ktime_to_us(diff) < 1000 * 50) {
 202                                 pr_debug("Suppressed key event 0x%X - "
 203                                          "Last press was %lld us ago\n",
 204                                          key->code, ktime_to_us(diff));
 205                                 goto msi_wmi_notify_exit;
 206                         }
 207                         last_pressed = cur;
 208                 }
 209
 210                 if (key->type == KE_KEY &&
 211                 /* Brightness is served via acpi video driver */
 212                 (backlight ||
 213                 (key->code != MSI_KEY_BRIGHTNESSUP &&
 214                 key->code != MSI_KEY_BRIGHTNESSDOWN))) {
 215                         pr_debug("Send key: 0x%X - Input layer keycode: %d\n",
 216                                  key->code, key->keycode);
 217                         sparse_keymap_report_entry(msi_wmi_input_dev, key, 1,
 218                                                    true);
 219                 }
 220         } else
 221                 pr_info("Unknown event received\n");
 222
 223 msi_wmi_notify_exit:
 224         kfree(response.pointer);
 225 }
 226
 227 static int __init msi_wmi_backlight_setup(void)
 228 {
 229         int err;
 230         struct backlight_properties props;
 231
 232         memset(&props, 0, sizeof(struct backlight_properties));
 233         props.type = BACKLIGHT_PLATFORM;
 234         props.max_brightness = ARRAY_SIZE(backlight_map) - 1;
 235         backlight = backlight_device_register(DRV_NAME, NULL, NULL,
 236                                               &msi_backlight_ops,
 237                                               &props);
 238         if (IS_ERR(backlight))
 239                 return PTR_ERR(backlight);
 240
 241         err = bl_get(NULL);
 242         if (err < 0) {
 243                 backlight_device_unregister(backlight);
 244                 return err;
 245         }
 246
 247         backlight->props.brightness = err;
 248
 249         return 0;
 250 }
 251
 252 static int __init msi_wmi_input_setup(void)
 253 {
 254         int err;
 255
 256         msi_wmi_input_dev = input_allocate_device();
 257         if (!msi_wmi_input_dev)
 258                 return -ENOMEM;
 259
 260         msi_wmi_input_dev->name = "MSI WMI hotkeys";
 261         msi_wmi_input_dev->phys = "wmi/input0";
 262         msi_wmi_input_dev->id.bustype = BUS_HOST;
 263
 264         err = sparse_keymap_setup(msi_wmi_input_dev, msi_wmi_keymap, NULL);
 265         if (err)
 266                 goto err_free_dev;
 267
 268         err = input_register_device(msi_wmi_input_dev);
 269
 270         if (err)
 271                 goto err_free_dev;
 272
 273         last_pressed = 0;
 274
 275         return 0;
 276
 277 err_free_dev:
 278         input_free_device(msi_wmi_input_dev);
 279         return err;
 280 }
 281
 282 static int __init msi_wmi_init(void)
 283 {
 284         int err;
 285         int i;
 286
 287         for (i = 0; i < ARRAY_SIZE(event_wmis); i++) {
 288                 if (!wmi_has_guid(event_wmis[i].guid))
 289                         continue;
 290
 291                 err = msi_wmi_input_setup();
 292                 if (err) {
 293                         pr_err("Unable to setup input device\n");
 294                         return err;
 295                 }
 296
 297                 err = wmi_install_notify_handler(event_wmis[i].guid,
 298                         msi_wmi_notify, NULL);
 299                 if (ACPI_FAILURE(err)) {
 300                         pr_err("Unable to setup WMI notify handler\n");
 301                         goto err_free_input;
 302                 }
 303
 304                 pr_debug("Event handler installed\n");
 305                 event_wmi = &event_wmis[i];
 306                 break;
 307         }
 308
 309         if (wmi_has_guid(MSIWMI_BIOS_GUID) &&
 310             acpi_video_get_backlight_type() == acpi_backlight_vendor) {
 311                 err = msi_wmi_backlight_setup();
 312                 if (err) {
 313                         pr_err("Unable to setup backlight device\n");
 314                         goto err_uninstall_handler;
 315                 }
 316                 pr_debug("Backlight device created\n");
 317         }
 318
 319         if (!event_wmi && !backlight) {
 320                 pr_err("This machine doesn't have neither MSI-hotkeys nor backlight through WMI\n");
 321                 return -ENODEV;
 322         }
 323
 324         return 0;
 325
 326 err_uninstall_handler:
 327         if (event_wmi)
 328                 wmi_remove_notify_handler(event_wmi->guid);
 329 err_free_input:
 330         if (event_wmi)
 331                 input_unregister_device(msi_wmi_input_dev);
 332         return err;
 333 }
 334
 335 static void __exit msi_wmi_exit(void)
 336 {
 337         if (event_wmi) {
 338                 wmi_remove_notify_handler(event_wmi->guid);
 339                 input_unregister_device(msi_wmi_input_dev);
 340         }
 341         backlight_device_unregister(backlight);
 342 }
 343
 344 module_init(msi_wmi_init);
 345 module_exit(msi_wmi_exit);