linux/drivers/platform/x86/dell-wmi.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 * Dell WMI hotkeys
   4 *
   5 * Copyright (C) 2008 Red Hat <mjg@redhat.com>
   6 * Copyright (C) 2014-2015 Pali Rohár <pali.rohar@gmail.com>
   7 *
   8 * Portions based on wistron_btns.c:
   9 * Copyright (C) 2005 Miloslav Trmac <mitr@volny.cz>
  10 * Copyright (C) 2005 Bernhard Rosenkraenzer <bero@arklinux.org>
  11 * Copyright (C) 2005 Dmitry Torokhov <dtor@mail.ru>
  12 */
  13
  14#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  15
  16#include <linux/kernel.h>
  17#include <linux/module.h>
  18#include <linux/init.h>
  19#include <linux/slab.h>
  20#include <linux/types.h>
  21#include <linux/input.h>
  22#include <linux/input/sparse-keymap.h>
  23#include <linux/acpi.h>
  24#include <linux/string.h>
  25#include <linux/dmi.h>
  26#include <linux/wmi.h>
  27#include <acpi/video.h>
  28#include "dell-smbios.h"
  29#include "dell-wmi-descriptor.h"
  30
  31MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");
  32MODULE_AUTHOR("Pali Rohár <pali.rohar@gmail.com>");
  33MODULE_DESCRIPTION("Dell laptop WMI hotkeys driver");
  34MODULE_LICENSE("GPL");
  35
  36#define DELL_EVENT_GUID "9DBB5994-A997-11DA-B012-B622A1EF5492"
  37
  38static bool wmi_requires_smbios_request;
  39
  40struct dell_wmi_priv {
  41        struct input_dev *input_dev;
  42        u32 interface_version;
  43};
  44
  45static int __init dmi_matched(const struct dmi_system_id *dmi)
  46{
  47        wmi_requires_smbios_request = 1;
  48        return 1;
  49}
  50
  51static const struct dmi_system_id dell_wmi_smbios_list[] __initconst = {
  52        {
  53                .callback = dmi_matched,
  54                .ident = "Dell Inspiron M5110",
  55                .matches = {
  56                        DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
  57                        DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron M5110"),
  58                },
  59        },
  60        {
  61                .callback = dmi_matched,
  62                .ident = "Dell Vostro V131",
  63                .matches = {
  64                        DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
  65                        DMI_MATCH(DMI_PRODUCT_NAME, "Vostro V131"),
  66                },
  67        },
  68        { }
  69};
  70
  71/*
  72 * Keymap for WMI events of type 0x0000
  73 *
  74 * Certain keys are flagged as KE_IGNORE. All of these are either
  75 * notifications (rather than requests for change) or are also sent
  76 * via the keyboard controller so should not be sent again.
  77 */
  78static const struct key_entry dell_wmi_keymap_type_0000[] = {
  79        { KE_IGNORE, 0x003a, { KEY_CAPSLOCK } },
  80
  81        /* Key code is followed by brightness level */
  82        { KE_KEY,    0xe005, { KEY_BRIGHTNESSDOWN } },
  83        { KE_KEY,    0xe006, { KEY_BRIGHTNESSUP } },
  84
  85        /* Battery health status button */
  86        { KE_KEY,    0xe007, { KEY_BATTERY } },
  87
  88        /* Radio devices state change, key code is followed by other values */
  89        { KE_IGNORE, 0xe008, { KEY_RFKILL } },
  90
  91        { KE_KEY,    0xe009, { KEY_EJECTCD } },
  92
  93        /* Key code is followed by: next, active and attached devices */
  94        { KE_KEY,    0xe00b, { KEY_SWITCHVIDEOMODE } },
  95
  96        /* Key code is followed by keyboard illumination level */
  97        { KE_IGNORE, 0xe00c, { KEY_KBDILLUMTOGGLE } },
  98
  99        /* BIOS error detected */
 100        { KE_IGNORE, 0xe00d, { KEY_RESERVED } },
 101
 102        /* Battery was removed or inserted */
 103        { KE_IGNORE, 0xe00e, { KEY_RESERVED } },
 104
 105        /* Wifi Catcher */
 106        { KE_KEY,    0xe011, { KEY_WLAN } },
 107
 108        /* Ambient light sensor toggle */
 109        { KE_IGNORE, 0xe013, { KEY_RESERVED } },
 110
 111        { KE_IGNORE, 0xe020, { KEY_MUTE } },
 112
 113        /* Unknown, defined in ACPI DSDT */
 114        /* { KE_IGNORE, 0xe023, { KEY_RESERVED } }, */
 115
 116        /* Untested, Dell Instant Launch key on Inspiron 7520 */
 117        /* { KE_IGNORE, 0xe024, { KEY_RESERVED } }, */
 118
 119        /* Dell Instant Launch key */
 120        { KE_KEY,    0xe025, { KEY_PROG4 } },
 121
 122        /* Audio panel key */
 123        { KE_IGNORE, 0xe026, { KEY_RESERVED } },
 124
 125        /* LCD Display On/Off Control key */
 126        { KE_KEY,    0xe027, { KEY_DISPLAYTOGGLE } },
 127
 128        /* Untested, Multimedia key on Dell Vostro 3560 */
 129        /* { KE_IGNORE, 0xe028, { KEY_RESERVED } }, */
 130
 131        /* Dell Instant Launch key */
 132        { KE_KEY,    0xe029, { KEY_PROG4 } },
 133
 134        /* Untested, Windows Mobility Center button on Inspiron 7520 */
 135        /* { KE_IGNORE, 0xe02a, { KEY_RESERVED } }, */
 136
 137        /* Unknown, defined in ACPI DSDT */
 138        /* { KE_IGNORE, 0xe02b, { KEY_RESERVED } }, */
 139
 140        /* Untested, Dell Audio With Preset Switch button on Inspiron 7520 */
 141        /* { KE_IGNORE, 0xe02c, { KEY_RESERVED } }, */
 142
 143        { KE_IGNORE, 0xe02e, { KEY_VOLUMEDOWN } },
 144        { KE_IGNORE, 0xe030, { KEY_VOLUMEUP } },
 145        { KE_IGNORE, 0xe033, { KEY_KBDILLUMUP } },
 146        { KE_IGNORE, 0xe034, { KEY_KBDILLUMDOWN } },
 147        { KE_IGNORE, 0xe03a, { KEY_CAPSLOCK } },
 148
 149        /* NIC Link is Up */
 150        { KE_IGNORE, 0xe043, { KEY_RESERVED } },
 151
 152        /* NIC Link is Down */
 153        { KE_IGNORE, 0xe044, { KEY_RESERVED } },
 154
 155        /*
 156         * This entry is very suspicious!
 157         * Originally Matthew Garrett created this dell-wmi driver specially for
 158         * "button with a picture of a battery" which has event code 0xe045.
 159         * Later Mario Limonciello from Dell told us that event code 0xe045 is
 160         * reported by Num Lock and should be ignored because key is send also
 161         * by keyboard controller.
 162         * So for now we will ignore this event to prevent potential double
 163         * Num Lock key press.
 164         */
 165        { KE_IGNORE, 0xe045, { KEY_NUMLOCK } },
 166
 167        /* Scroll lock and also going to tablet mode on portable devices */
 168        { KE_IGNORE, 0xe046, { KEY_SCROLLLOCK } },
 169
 170        /* Untested, going from tablet mode on portable devices */
 171        /* { KE_IGNORE, 0xe047, { KEY_RESERVED } }, */
 172
 173        /* Dell Support Center key */
 174        { KE_IGNORE, 0xe06e, { KEY_RESERVED } },
 175
 176        { KE_IGNORE, 0xe0f7, { KEY_MUTE } },
 177        { KE_IGNORE, 0xe0f8, { KEY_VOLUMEDOWN } },
 178        { KE_IGNORE, 0xe0f9, { KEY_VOLUMEUP } },
 179};
 180
 181struct dell_bios_keymap_entry {
 182        u16 scancode;
 183        u16 keycode;
 184};
 185
 186struct dell_bios_hotkey_table {
 187        struct dmi_header header;
 188        struct dell_bios_keymap_entry keymap[];
 189
 190};
 191
 192struct dell_dmi_results {
 193        int err;
 194        int keymap_size;
 195        struct key_entry *keymap;
 196};
 197
 198/* Uninitialized entries here are KEY_RESERVED == 0. */
 199static const u16 bios_to_linux_keycode[256] = {
 200        [0]     = KEY_MEDIA,
 201        [1]     = KEY_NEXTSONG,
 202        [2]     = KEY_PLAYPAUSE,
 203        [3]     = KEY_PREVIOUSSONG,
 204        [4]     = KEY_STOPCD,
 205        [5]     = KEY_UNKNOWN,
 206        [6]     = KEY_UNKNOWN,
 207        [7]     = KEY_UNKNOWN,
 208        [8]     = KEY_WWW,
 209        [9]     = KEY_UNKNOWN,
 210        [10]    = KEY_VOLUMEDOWN,
 211        [11]    = KEY_MUTE,
 212        [12]    = KEY_VOLUMEUP,
 213        [13]    = KEY_UNKNOWN,
 214        [14]    = KEY_BATTERY,
 215        [15]    = KEY_EJECTCD,
 216        [16]    = KEY_UNKNOWN,
 217        [17]    = KEY_SLEEP,
 218        [18]    = KEY_PROG1,
 219        [19]    = KEY_BRIGHTNESSDOWN,
 220        [20]    = KEY_BRIGHTNESSUP,
 221        [21]    = KEY_BRIGHTNESS_AUTO,
 222        [22]    = KEY_KBDILLUMTOGGLE,
 223        [23]    = KEY_UNKNOWN,
 224        [24]    = KEY_SWITCHVIDEOMODE,
 225        [25]    = KEY_UNKNOWN,
 226        [26]    = KEY_UNKNOWN,
 227        [27]    = KEY_SWITCHVIDEOMODE,
 228        [28]    = KEY_UNKNOWN,
 229        [29]    = KEY_UNKNOWN,
 230        [30]    = KEY_PROG2,
 231        [31]    = KEY_UNKNOWN,
 232        [32]    = KEY_UNKNOWN,
 233        [33]    = KEY_UNKNOWN,
 234        [34]    = KEY_UNKNOWN,
 235        [35]    = KEY_UNKNOWN,
 236        [36]    = KEY_UNKNOWN,
 237        [37]    = KEY_UNKNOWN,
 238        [38]    = KEY_MICMUTE,
 239        [255]   = KEY_PROG3,
 240};
 241
 242/*
 243 * Keymap for WMI events of type 0x0010
 244 *
 245 * These are applied if the 0xB2 DMI hotkey table is present and doesn't
 246 * override them.
 247 */
 248static const struct key_entry dell_wmi_keymap_type_0010[] = {
 249        /* Fn-lock switched to function keys */
 250        { KE_IGNORE, 0x0, { KEY_RESERVED } },
 251
 252        /* Fn-lock switched to multimedia keys */
 253        { KE_IGNORE, 0x1, { KEY_RESERVED } },
 254
 255        /* Keyboard backlight change notification */
 256        { KE_IGNORE, 0x3f, { KEY_RESERVED } },
 257
 258        /* Mic mute */
 259        { KE_KEY, 0x150, { KEY_MICMUTE } },
 260
 261        /* Fn-lock */
 262        { KE_IGNORE, 0x151, { KEY_RESERVED } },
 263
 264        /* Change keyboard illumination */
 265        { KE_IGNORE, 0x152, { KEY_KBDILLUMTOGGLE } },
 266
 267        /*
 268         * Radio disable (notify only -- there is no model for which the
 269         * WMI event is supposed to trigger an action).
 270         */
 271        { KE_IGNORE, 0x153, { KEY_RFKILL } },
 272
 273        /* RGB keyboard backlight control */
 274        { KE_IGNORE, 0x154, { KEY_RESERVED } },
 275
 276        /*
 277         * Stealth mode toggle. This will "disable all lights and sounds".
 278         * The action is performed by the BIOS and EC; the WMI event is just
 279         * a notification. On the XPS 13 9350, this is Fn+F7, and there's
 280         * a BIOS setting to enable and disable the hotkey.
 281         */
 282        { KE_IGNORE, 0x155, { KEY_RESERVED } },
 283
 284        /* Rugged magnetic dock attach/detach events */
 285        { KE_IGNORE, 0x156, { KEY_RESERVED } },
 286        { KE_IGNORE, 0x157, { KEY_RESERVED } },
 287
 288        /* Rugged programmable (P1/P2/P3 keys) */
 289        { KE_KEY,    0x850, { KEY_PROG1 } },
 290        { KE_KEY,    0x851, { KEY_PROG2 } },
 291        { KE_KEY,    0x852, { KEY_PROG3 } },
 292
 293        /*
 294         * Radio disable (notify only -- there is no model for which the
 295         * WMI event is supposed to trigger an action).
 296         */
 297        { KE_IGNORE, 0xe008, { KEY_RFKILL } },
 298
 299        /* Fn-lock */
 300        { KE_IGNORE, 0xe035, { KEY_RESERVED } },
 301};
 302
 303/*
 304 * Keymap for WMI events of type 0x0011
 305 */
 306static const struct key_entry dell_wmi_keymap_type_0011[] = {
 307        /* Battery unplugged */
 308        { KE_IGNORE, 0xfff0, { KEY_RESERVED } },
 309
 310        /* Battery inserted */
 311        { KE_IGNORE, 0xfff1, { KEY_RESERVED } },
 312
 313        /* Keyboard backlight level changed */
 314        { KE_IGNORE, 0x01e1, { KEY_RESERVED } },
 315        { KE_IGNORE, 0x02ea, { KEY_RESERVED } },
 316        { KE_IGNORE, 0x02eb, { KEY_RESERVED } },
 317        { KE_IGNORE, 0x02ec, { KEY_RESERVED } },
 318        { KE_IGNORE, 0x02f6, { KEY_RESERVED } },
 319};
 320
 321static void dell_wmi_process_key(struct wmi_device *wdev, int type, int code)
 322{
 323        struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
 324        const struct key_entry *key;
 325
 326        key = sparse_keymap_entry_from_scancode(priv->input_dev,
 327                                                (type << 16) | code);
 328        if (!key) {
 329                pr_info("Unknown key with type 0x%04x and code 0x%04x pressed\n",
 330                        type, code);
 331                return;
 332        }
 333
 334        pr_debug("Key with type 0x%04x and code 0x%04x pressed\n", type, code);
 335
 336        /* Don't report brightness notifications that will also come via ACPI */
 337        if ((key->keycode == KEY_BRIGHTNESSUP ||
 338             key->keycode == KEY_BRIGHTNESSDOWN) &&
 339            acpi_video_handles_brightness_key_presses())
 340                return;
 341
 342        if (type == 0x0000 && code == 0xe025 && !wmi_requires_smbios_request)
 343                return;
 344
 345        if (key->keycode == KEY_KBDILLUMTOGGLE)
 346                dell_laptop_call_notifier(
 347                        DELL_LAPTOP_KBD_BACKLIGHT_BRIGHTNESS_CHANGED, NULL);
 348
 349        sparse_keymap_report_entry(priv->input_dev, key, 1, true);
 350}
 351
 352static void dell_wmi_notify(struct wmi_device *wdev,
 353                            union acpi_object *obj)
 354{
 355        struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
 356        u16 *buffer_entry, *buffer_end;
 357        acpi_size buffer_size;
 358        int len, i;
 359
 360        if (obj->type != ACPI_TYPE_BUFFER) {
 361                pr_warn("bad response type %x\n", obj->type);
 362                return;
 363        }
 364
 365        pr_debug("Received WMI event (%*ph)\n",
 366                obj->buffer.length, obj->buffer.pointer);
 367
 368        buffer_entry = (u16 *)obj->buffer.pointer;
 369        buffer_size = obj->buffer.length/2;
 370        buffer_end = buffer_entry + buffer_size;
 371
 372        /*
 373         * BIOS/ACPI on devices with WMI interface version 0 does not clear
 374         * buffer before filling it. So next time when BIOS/ACPI send WMI event
 375         * which is smaller as previous then it contains garbage in buffer from
 376         * previous event.
 377         *
 378         * BIOS/ACPI on devices with WMI interface version 1 clears buffer and
 379         * sometimes send more events in buffer at one call.
 380         *
 381         * So to prevent reading garbage from buffer we will process only first
 382         * one event on devices with WMI interface version 0.
 383         */
 384        if (priv->interface_version == 0 && buffer_entry < buffer_end)
 385                if (buffer_end > buffer_entry + buffer_entry[0] + 1)
 386                        buffer_end = buffer_entry + buffer_entry[0] + 1;
 387
 388        while (buffer_entry < buffer_end) {
 389
 390                len = buffer_entry[0];
 391                if (len == 0)
 392                        break;
 393
 394                len++;
 395
 396                if (buffer_entry + len > buffer_end) {
 397                        pr_warn("Invalid length of WMI event\n");
 398                        break;
 399                }
 400
 401                pr_debug("Process buffer (%*ph)\n", len*2, buffer_entry);
 402
 403                switch (buffer_entry[1]) {
 404                case 0x0000: /* One key pressed or event occurred */
 405                        if (len > 2)
 406                                dell_wmi_process_key(wdev, 0x0000,
 407                                                     buffer_entry[2]);
 408                        /* Other entries could contain additional information */
 409                        break;
 410                case 0x0010: /* Sequence of keys pressed */
 411                case 0x0011: /* Sequence of events occurred */
 412                        for (i = 2; i < len; ++i)
 413                                dell_wmi_process_key(wdev, buffer_entry[1],
 414                                                     buffer_entry[i]);
 415                        break;
 416                default: /* Unknown event */
 417                        pr_info("Unknown WMI event type 0x%x\n",
 418                                (int)buffer_entry[1]);
 419                        break;
 420                }
 421
 422                buffer_entry += len;
 423
 424        }
 425
 426}
 427
 428static bool have_scancode(u32 scancode, const struct key_entry *keymap, int len)
 429{
 430        int i;
 431
 432        for (i = 0; i < len; i++)
 433                if (keymap[i].code == scancode)
 434                        return true;
 435
 436        return false;
 437}
 438
 439static void handle_dmi_entry(const struct dmi_header *dm, void *opaque)
 440{
 441        struct dell_dmi_results *results = opaque;
 442        struct dell_bios_hotkey_table *table;
 443        int hotkey_num, i, pos = 0;
 444        struct key_entry *keymap;
 445
 446        if (results->err || results->keymap)
 447                return;         /* We already found the hotkey table. */
 448
 449        /* The Dell hotkey table is type 0xB2.  Scan until we find it. */
 450        if (dm->type != 0xb2)
 451                return;
 452
 453        table = container_of(dm, struct dell_bios_hotkey_table, header);
 454
 455        hotkey_num = (table->header.length -
 456                      sizeof(struct dell_bios_hotkey_table)) /
 457                                sizeof(struct dell_bios_keymap_entry);
 458        if (hotkey_num < 1) {
 459                /*
 460                 * Historically, dell-wmi would ignore a DMI entry of
 461                 * fewer than 7 bytes.  Sizes between 4 and 8 bytes are
 462                 * nonsensical (both the header and all entries are 4
 463                 * bytes), so we approximate the old behavior by
 464                 * ignoring tables with fewer than one entry.
 465                 */
 466                return;
 467        }
 468
 469        keymap = kcalloc(hotkey_num, sizeof(struct key_entry), GFP_KERNEL);
 470        if (!keymap) {
 471                results->err = -ENOMEM;
 472                return;
 473        }
 474
 475        for (i = 0; i < hotkey_num; i++) {
 476                const struct dell_bios_keymap_entry *bios_entry =
 477                                        &table->keymap[i];
 478
 479                /* Uninitialized entries are 0 aka KEY_RESERVED. */
 480                u16 keycode = (bios_entry->keycode <
 481                               ARRAY_SIZE(bios_to_linux_keycode)) ?
 482                        bios_to_linux_keycode[bios_entry->keycode] :
 483                        KEY_RESERVED;
 484
 485                /*
 486                 * Log if we find an entry in the DMI table that we don't
 487                 * understand.  If this happens, we should figure out what
 488                 * the entry means and add it to bios_to_linux_keycode.
 489                 */
 490                if (keycode == KEY_RESERVED) {
 491                        pr_info("firmware scancode 0x%x maps to unrecognized keycode 0x%x\n",
 492                                bios_entry->scancode, bios_entry->keycode);
 493                        continue;
 494                }
 495
 496                if (keycode == KEY_KBDILLUMTOGGLE)
 497                        keymap[pos].type = KE_IGNORE;
 498                else
 499                        keymap[pos].type = KE_KEY;
 500                keymap[pos].code = bios_entry->scancode;
 501                keymap[pos].keycode = keycode;
 502
 503                pos++;
 504        }
 505
 506        results->keymap = keymap;
 507        results->keymap_size = pos;
 508}
 509
 510static int dell_wmi_input_setup(struct wmi_device *wdev)
 511{
 512        struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
 513        struct dell_dmi_results dmi_results = {};
 514        struct key_entry *keymap;
 515        int err, i, pos = 0;
 516
 517        priv->input_dev = input_allocate_device();
 518        if (!priv->input_dev)
 519                return -ENOMEM;
 520
 521        priv->input_dev->name = "Dell WMI hotkeys";
 522        priv->input_dev->id.bustype = BUS_HOST;
 523        priv->input_dev->dev.parent = &wdev->dev;
 524
 525        if (dmi_walk(handle_dmi_entry, &dmi_results)) {
 526                /*
 527                 * Historically, dell-wmi ignored dmi_walk errors.  A failure
 528                 * is certainly surprising, but it probably just indicates
 529                 * a very old laptop.
 530                 */
 531                pr_warn("no DMI; using the old-style hotkey interface\n");
 532        }
 533
 534        if (dmi_results.err) {
 535                err = dmi_results.err;
 536                goto err_free_dev;
 537        }
 538
 539        keymap = kcalloc(dmi_results.keymap_size +
 540                         ARRAY_SIZE(dell_wmi_keymap_type_0000) +
 541                         ARRAY_SIZE(dell_wmi_keymap_type_0010) +
 542                         ARRAY_SIZE(dell_wmi_keymap_type_0011) +
 543                         1,
 544                         sizeof(struct key_entry), GFP_KERNEL);
 545        if (!keymap) {
 546                kfree(dmi_results.keymap);
 547                err = -ENOMEM;
 548                goto err_free_dev;
 549        }
 550
 551        /* Append table with events of type 0x0010 which comes from DMI */
 552        for (i = 0; i < dmi_results.keymap_size; i++) {
 553                keymap[pos] = dmi_results.keymap[i];
 554                keymap[pos].code |= (0x0010 << 16);
 555                pos++;
 556        }
 557
 558        kfree(dmi_results.keymap);
 559
 560        /* Append table with extra events of type 0x0010 which are not in DMI */
 561        for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0010); i++) {
 562                const struct key_entry *entry = &dell_wmi_keymap_type_0010[i];
 563
 564                /*
 565                 * Check if we've already found this scancode.  This takes
 566                 * quadratic time, but it doesn't matter unless the list
 567                 * of extra keys gets very long.
 568                 */
 569                if (dmi_results.keymap_size &&
 570                    have_scancode(entry->code | (0x0010 << 16),
 571                                  keymap, dmi_results.keymap_size)
 572                   )
 573                        continue;
 574
 575                keymap[pos] = *entry;
 576                keymap[pos].code |= (0x0010 << 16);
 577                pos++;
 578        }
 579
 580        /* Append table with events of type 0x0011 */
 581        for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0011); i++) {
 582                keymap[pos] = dell_wmi_keymap_type_0011[i];
 583                keymap[pos].code |= (0x0011 << 16);
 584                pos++;
 585        }
 586
 587        /*
 588         * Now append also table with "legacy" events of type 0x0000. Some of
 589         * them are reported also on laptops which have scancodes in DMI.
 590         */
 591        for (i = 0; i < ARRAY_SIZE(dell_wmi_keymap_type_0000); i++) {
 592                keymap[pos] = dell_wmi_keymap_type_0000[i];
 593                pos++;
 594        }
 595
 596        keymap[pos].type = KE_END;
 597
 598        err = sparse_keymap_setup(priv->input_dev, keymap, NULL);
 599        /*
 600         * Sparse keymap library makes a copy of keymap so we don't need the
 601         * original one that was allocated.
 602         */
 603        kfree(keymap);
 604        if (err)
 605                goto err_free_dev;
 606
 607        err = input_register_device(priv->input_dev);
 608        if (err)
 609                goto err_free_dev;
 610
 611        return 0;
 612
 613 err_free_dev:
 614        input_free_device(priv->input_dev);
 615        return err;
 616}
 617
 618static void dell_wmi_input_destroy(struct wmi_device *wdev)
 619{
 620        struct dell_wmi_priv *priv = dev_get_drvdata(&wdev->dev);
 621
 622        input_unregister_device(priv->input_dev);
 623}
 624
 625/*
 626 * According to Dell SMBIOS documentation:
 627 *
 628 * 17  3  Application Program Registration
 629 *
 630 *     cbArg1 Application ID 1 = 0x00010000
 631 *     cbArg2 Application ID 2
 632 *            QUICKSET/DCP = 0x51534554 "QSET"
 633 *            ALS Driver   = 0x416c7353 "AlsS"
 634 *            Latitude ON  = 0x4c6f6e52 "LonR"
 635 *     cbArg3 Application version or revision number
 636 *     cbArg4 0 = Unregister application
 637 *            1 = Register application
 638 *     cbRes1 Standard return codes (0, -1, -2)
 639 */
 640
 641static int dell_wmi_events_set_enabled(bool enable)
 642{
 643        struct calling_interface_buffer *buffer;
 644        int ret;
 645
 646        buffer = kzalloc(sizeof(struct calling_interface_buffer), GFP_KERNEL);
 647        if (!buffer)
 648                return -ENOMEM;
 649        buffer->cmd_class = CLASS_INFO;
 650        buffer->cmd_select = SELECT_APP_REGISTRATION;
 651        buffer->input[0] = 0x10000;
 652        buffer->input[1] = 0x51534554;
 653        buffer->input[3] = enable;
 654        ret = dell_smbios_call(buffer);
 655        if (ret == 0)
 656                ret = buffer->output[0];
 657        kfree(buffer);
 658
 659        return dell_smbios_error(ret);
 660}
 661
 662static int dell_wmi_probe(struct wmi_device *wdev, const void *context)
 663{
 664        struct dell_wmi_priv *priv;
 665        int ret;
 666
 667        ret = dell_wmi_get_descriptor_valid();
 668        if (ret)
 669                return ret;
 670
 671        priv = devm_kzalloc(
 672                &wdev->dev, sizeof(struct dell_wmi_priv), GFP_KERNEL);
 673        if (!priv)
 674                return -ENOMEM;
 675        dev_set_drvdata(&wdev->dev, priv);
 676
 677        if (!dell_wmi_get_interface_version(&priv->interface_version))
 678                return -EPROBE_DEFER;
 679
 680        return dell_wmi_input_setup(wdev);
 681}
 682
 683static int dell_wmi_remove(struct wmi_device *wdev)
 684{
 685        dell_wmi_input_destroy(wdev);
 686        return 0;
 687}
 688static const struct wmi_device_id dell_wmi_id_table[] = {
 689        { .guid_string = DELL_EVENT_GUID },
 690        { },
 691};
 692
 693static struct wmi_driver dell_wmi_driver = {
 694        .driver = {
 695                .name = "dell-wmi",
 696        },
 697        .id_table = dell_wmi_id_table,
 698        .probe = dell_wmi_probe,
 699        .remove = dell_wmi_remove,
 700        .notify = dell_wmi_notify,
 701};
 702
 703static int __init dell_wmi_init(void)
 704{
 705        int err;
 706
 707        dmi_check_system(dell_wmi_smbios_list);
 708
 709        if (wmi_requires_smbios_request) {
 710                err = dell_wmi_events_set_enabled(true);
 711                if (err) {
 712                        pr_err("Failed to enable WMI events\n");
 713                        return err;
 714                }
 715        }
 716
 717        return wmi_driver_register(&dell_wmi_driver);
 718}
 719late_initcall(dell_wmi_init);
 720
 721static void __exit dell_wmi_exit(void)
 722{
 723        if (wmi_requires_smbios_request)
 724                dell_wmi_events_set_enabled(false);
 725
 726        wmi_driver_unregister(&dell_wmi_driver);
 727}
 728module_exit(dell_wmi_exit);
 729
 730MODULE_DEVICE_TABLE(wmi, dell_wmi_id_table);
 731