drivers/platform/x86/intel-hid.c

   1 /*
   2  *  Intel HID event driver for Windows 8
   3  *
   4  *  Copyright (C) 2015 Alex Hung <alex.hung@canonical.com>
   5  *  Copyright (C) 2015 Andrew Lutomirski <luto@kernel.org>
   6  *
   7  *  This program is free software; you can redistribute it and/or modify
   8  *  it under the terms of the GNU General Public License as published by
   9  *  the Free Software Foundation; either version 2 of the License, or
  10  *  (at your option) any later version.
  11  *
  12  *  This program is distributed in the hope that it will be useful,
  13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  *  GNU General Public License for more details.
  16  *
  17  */
  18
  19 #include <linux/kernel.h>
  20 #include <linux/module.h>
  21 #include <linux/init.h>
  22 #include <linux/input.h>
  23 #include <linux/platform_device.h>
  24 #include <linux/input/sparse-keymap.h>
  25 #include <linux/acpi.h>
  26 #include <acpi/acpi_bus.h>
  27
  28 MODULE_LICENSE("GPL");
  29 MODULE_AUTHOR("Alex Hung");
  30
  31 static const struct acpi_device_id intel_hid_ids[] = {
  32         {"INT33D5", 0},
  33         {"", 0},
  34 };
  35
  36 /* In theory, these are HID usages. */
  37 static const struct key_entry intel_hid_keymap[] = {
  38         /* 1: LSuper (Page 0x07, usage 0xE3) -- unclear what to do */
  39         /* 2: Toggle SW_ROTATE_LOCK -- easy to implement if seen in wild */
  40         { KE_KEY, 3, { KEY_NUMLOCK } },
  41         { KE_KEY, 4, { KEY_HOME } },
  42         { KE_KEY, 5, { KEY_END } },
  43         { KE_KEY, 6, { KEY_PAGEUP } },
  44         { KE_KEY, 7, { KEY_PAGEDOWN } },
  45         { KE_KEY, 8, { KEY_RFKILL } },
  46         { KE_KEY, 9, { KEY_POWER } },
  47         { KE_KEY, 11, { KEY_SLEEP } },
  48         /* 13 has two different meanings in the spec -- ignore it. */
  49         { KE_KEY, 14, { KEY_STOPCD } },
  50         { KE_KEY, 15, { KEY_PLAYPAUSE } },
  51         { KE_KEY, 16, { KEY_MUTE } },
  52         { KE_KEY, 17, { KEY_VOLUMEUP } },
  53         { KE_KEY, 18, { KEY_VOLUMEDOWN } },
  54         { KE_KEY, 19, { KEY_BRIGHTNESSUP } },
  55         { KE_KEY, 20, { KEY_BRIGHTNESSDOWN } },
  56         /* 27: wake -- needs special handling */
  57         { KE_END },
  58 };
  59
  60 struct intel_hid_priv {
  61         struct input_dev *input_dev;
  62 };
  63
  64 static int intel_hid_set_enable(struct device *device, int enable)
  65 {
  66         union acpi_object arg0 = { ACPI_TYPE_INTEGER };
  67         struct acpi_object_list args = { 1, &arg0 };
  68         acpi_status status;
  69
  70         arg0.integer.value = enable;
  71         status = acpi_evaluate_object(ACPI_HANDLE(device), "HDSM", &args, NULL);
  72         if (!ACPI_SUCCESS(status)) {
  73                 dev_warn(device, "failed to %sable hotkeys\n",
  74                          enable ? "en" : "dis");
  75                 return -EIO;
  76         }
  77
  78         return 0;
  79 }
  80
  81 static int intel_hid_pl_suspend_handler(struct device *device)
  82 {
  83         intel_hid_set_enable(device, 0);
  84         return 0;
  85 }
  86
  87 static int intel_hid_pl_resume_handler(struct device *device)
  88 {
  89         intel_hid_set_enable(device, 1);
  90         return 0;
  91 }
  92
  93 static const struct dev_pm_ops intel_hid_pl_pm_ops = {
  94         .suspend  = intel_hid_pl_suspend_handler,
  95         .resume  = intel_hid_pl_resume_handler,
  96 };
  97
  98 static int intel_hid_input_setup(struct platform_device *device)
  99 {
 100         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 101         int ret;
 102
 103         priv->input_dev = input_allocate_device();
 104         if (!priv->input_dev)
 105                 return -ENOMEM;
 106
 107         ret = sparse_keymap_setup(priv->input_dev, intel_hid_keymap, NULL);
 108         if (ret)
 109                 goto err_free_device;
 110
 111         priv->input_dev->dev.parent = &device->dev;
 112         priv->input_dev->name = "Intel HID events";
 113         priv->input_dev->id.bustype = BUS_HOST;
 114         set_bit(KEY_RFKILL, priv->input_dev->keybit);
 115
 116         ret = input_register_device(priv->input_dev);
 117         if (ret)
 118                 goto err_free_device;
 119
 120         return 0;
 121
 122 err_free_device:
 123                 input_free_device(priv->input_dev);
 124                 return ret;
 125 }
 126
 127 static void intel_hid_input_destroy(struct platform_device *device)
 128 {
 129         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 130
 131         input_unregister_device(priv->input_dev);
 132 }
 133
 134 static void notify_handler(acpi_handle handle, u32 event, void *context)
 135 {
 136         struct platform_device *device = context;
 137         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 138         unsigned long long ev_index;
 139         acpi_status status;
 140
 141         /* The platform spec only defines one event code: 0xC0. */
 142         if (event != 0xc0) {
 143                 dev_warn(&device->dev, "received unknown event (0x%x)\n",
 144                          event);
 145                 return;
 146         }
 147
 148         status = acpi_evaluate_integer(handle, "HDEM", NULL, &ev_index);
 149         if (!ACPI_SUCCESS(status)) {
 150                 dev_warn(&device->dev, "failed to get event index\n");
 151                 return;
 152         }
 153
 154         if (!sparse_keymap_report_event(priv->input_dev, ev_index, 1, true))
 155                 dev_info(&device->dev, "unknown event index 0x%llx\n",
 156                          ev_index);
 157 }
 158
 159 static int intel_hid_probe(struct platform_device *device)
 160 {
 161         acpi_handle handle = ACPI_HANDLE(&device->dev);
 162         struct intel_hid_priv *priv;
 163         unsigned long long mode;
 164         acpi_status status;
 165         int err;
 166
 167         status = acpi_evaluate_integer(handle, "HDMM", NULL, &mode);
 168         if (!ACPI_SUCCESS(status)) {
 169                 dev_warn(&device->dev, "failed to read mode\n");
 170                 return -ENODEV;
 171         }
 172
 173         if (mode != 0) {
 174                 /*
 175                  * This driver only implements "simple" mode.  There appear
 176                  * to be no other modes, but we should be paranoid and check
 177                  * for compatibility.
 178                  */
 179                 dev_info(&device->dev, "platform is not in simple mode\n");
 180                 return -ENODEV;
 181         }
 182
 183         priv = devm_kzalloc(&device->dev, sizeof(*priv), GFP_KERNEL);
 184         if (!priv)
 185                 return -ENOMEM;
 186         dev_set_drvdata(&device->dev, priv);
 187
 188         err = intel_hid_input_setup(device);
 189         if (err) {
 190                 pr_err("Failed to setup Intel HID hotkeys\n");
 191                 return err;
 192         }
 193
 194         status = acpi_install_notify_handler(handle,
 195                                              ACPI_DEVICE_NOTIFY,
 196                                              notify_handler,
 197                                              device);
 198         if (ACPI_FAILURE(status)) {
 199                 err = -EBUSY;
 200                 goto err_remove_input;
 201         }
 202
 203         err = intel_hid_set_enable(&device->dev, 1);
 204         if (err)
 205                 goto err_remove_notify;
 206
 207         return 0;
 208
 209 err_remove_notify:
 210         acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
 211
 212 err_remove_input:
 213         intel_hid_input_destroy(device);
 214
 215         return err;
 216 }
 217
 218 static int intel_hid_remove(struct platform_device *device)
 219 {
 220         acpi_handle handle = ACPI_HANDLE(&device->dev);
 221
 222         acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
 223         intel_hid_input_destroy(device);
 224         intel_hid_set_enable(&device->dev, 0);
 225         acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
 226
 227         /*
 228          * Even if we failed to shut off the event stream, we can still
 229          * safely detach from the device.
 230          */
 231         return 0;
 232 }
 233
 234 static struct platform_driver intel_hid_pl_driver = {
 235         .driver = {
 236                 .name = "intel-hid",
 237                 .acpi_match_table = intel_hid_ids,
 238                 .pm = &intel_hid_pl_pm_ops,
 239         },
 240         .probe = intel_hid_probe,
 241         .remove = intel_hid_remove,
 242 };
 243 MODULE_DEVICE_TABLE(acpi, intel_hid_ids);
 244
 245 /*
 246  * Unfortunately, some laptops provide a _HID="INT33D5" device with
 247  * _CID="PNP0C02".  This causes the pnpacpi scan driver to claim the
 248  * ACPI node, so no platform device will be created.  The pnpacpi
 249  * driver rejects this device in subsequent processing, so no physical
 250  * node is created at all.
 251  *
 252  * As a workaround until the ACPI core figures out how to handle
 253  * this corner case, manually ask the ACPI platform device code to
 254  * claim the ACPI node.
 255  */
 256 static acpi_status __init
 257 check_acpi_dev(acpi_handle handle, u32 lvl, void *context, void **rv)
 258 {
 259         const struct acpi_device_id *ids = context;
 260         struct acpi_device *dev;
 261
 262         if (acpi_bus_get_device(handle, &dev) != 0)
 263                 return AE_OK;
 264
 265         if (acpi_match_device_ids(dev, ids) == 0)
 266                 if (acpi_create_platform_device(dev))
 267                         dev_info(&dev->dev,
 268                                  "intel-hid: created platform device\n");
 269
 270         return AE_OK;
 271 }
 272
 273 static int __init intel_hid_init(void)
 274 {
 275         acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
 276                             ACPI_UINT32_MAX, check_acpi_dev, NULL,
 277                             (void *)intel_hid_ids, NULL);
 278
 279         return platform_driver_register(&intel_hid_pl_driver);
 280 }
 281 module_init(intel_hid_init);
 282
 283 static void __exit intel_hid_exit(void)
 284 {
 285         platform_driver_unregister(&intel_hid_pl_driver);
 286 }
 287 module_exit(intel_hid_exit);