drivers/platform/x86/intel-hid.c

   1 /*
   2  *  Intel HID event & 5 button array driver
   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 /* 5 button array notification value. */
  61 static const struct key_entry intel_array_keymap[] = {
  62         { KE_KEY,    0xC2, { KEY_LEFTMETA } },                /* Press */
  63         { KE_IGNORE, 0xC3, { KEY_LEFTMETA } },                /* Release */
  64         { KE_KEY,    0xC4, { KEY_VOLUMEUP } },                /* Press */
  65         { KE_IGNORE, 0xC5, { KEY_VOLUMEUP } },                /* Release */
  66         { KE_KEY,    0xC6, { KEY_VOLUMEDOWN } },              /* Press */
  67         { KE_IGNORE, 0xC7, { KEY_VOLUMEDOWN } },              /* Release */
  68         { KE_SW,     0xC8, { .sw = { SW_ROTATE_LOCK, 1 } } }, /* Press */
  69         { KE_SW,     0xC9, { .sw = { SW_ROTATE_LOCK, 0 } } }, /* Release */
  70         { KE_KEY,    0xCE, { KEY_POWER } },                   /* Press */
  71         { KE_IGNORE, 0xCF, { KEY_POWER } },                   /* Release */
  72         { KE_END },
  73 };
  74
  75 struct intel_hid_priv {
  76         struct input_dev *input_dev;
  77         struct input_dev *array;
  78 };
  79
  80 static int intel_hid_set_enable(struct device *device, bool enable)
  81 {
  82         acpi_status status;
  83
  84         status = acpi_execute_simple_method(ACPI_HANDLE(device), "HDSM",
  85                                             enable);
  86         if (ACPI_FAILURE(status)) {
  87                 dev_warn(device, "failed to %sable hotkeys\n",
  88                          enable ? "en" : "dis");
  89                 return -EIO;
  90         }
  91
  92         return 0;
  93 }
  94
  95 static void intel_button_array_enable(struct device *device, bool enable)
  96 {
  97         struct intel_hid_priv *priv = dev_get_drvdata(device);
  98         acpi_handle handle = ACPI_HANDLE(device);
  99         unsigned long long button_cap;
 100         acpi_status status;
 101
 102         if (!priv->array)
 103                 return;
 104
 105         /* Query supported platform features */
 106         status = acpi_evaluate_integer(handle, "BTNC", NULL, &button_cap);
 107         if (ACPI_FAILURE(status)) {
 108                 dev_warn(device, "failed to get button capability\n");
 109                 return;
 110         }
 111
 112         /* Enable|disable features - power button is always enabled */
 113         status = acpi_execute_simple_method(handle, "BTNE",
 114                                             enable ? button_cap : 1);
 115         if (ACPI_FAILURE(status))
 116                 dev_warn(device, "failed to set button capability\n");
 117 }
 118
 119 static int intel_hid_pl_suspend_handler(struct device *device)
 120 {
 121         intel_hid_set_enable(device, false);
 122         intel_button_array_enable(device, false);
 123
 124         return 0;
 125 }
 126
 127 static int intel_hid_pl_resume_handler(struct device *device)
 128 {
 129         intel_hid_set_enable(device, true);
 130         intel_button_array_enable(device, true);
 131
 132         return 0;
 133 }
 134
 135 static const struct dev_pm_ops intel_hid_pl_pm_ops = {
 136         .freeze  = intel_hid_pl_suspend_handler,
 137         .restore  = intel_hid_pl_resume_handler,
 138         .suspend  = intel_hid_pl_suspend_handler,
 139         .resume  = intel_hid_pl_resume_handler,
 140 };
 141
 142 static int intel_hid_input_setup(struct platform_device *device)
 143 {
 144         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 145         int ret;
 146
 147         priv->input_dev = devm_input_allocate_device(&device->dev);
 148         if (!priv->input_dev)
 149                 return -ENOMEM;
 150
 151         ret = sparse_keymap_setup(priv->input_dev, intel_hid_keymap, NULL);
 152         if (ret)
 153                 return ret;
 154
 155         priv->input_dev->name = "Intel HID events";
 156         priv->input_dev->id.bustype = BUS_HOST;
 157
 158         return input_register_device(priv->input_dev);
 159 }
 160
 161 static int intel_button_array_input_setup(struct platform_device *device)
 162 {
 163         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 164         int ret;
 165
 166         /* Setup input device for 5 button array */
 167         priv->array = devm_input_allocate_device(&device->dev);
 168         if (!priv->array)
 169                 return -ENOMEM;
 170
 171         ret = sparse_keymap_setup(priv->array, intel_array_keymap, NULL);
 172         if (ret)
 173                 return ret;
 174
 175         priv->array->name = "Intel HID 5 button array";
 176         priv->array->id.bustype = BUS_HOST;
 177
 178         return input_register_device(priv->array);
 179 }
 180
 181 static void notify_handler(acpi_handle handle, u32 event, void *context)
 182 {
 183         struct platform_device *device = context;
 184         struct intel_hid_priv *priv = dev_get_drvdata(&device->dev);
 185         unsigned long long ev_index;
 186         acpi_status status;
 187
 188         /* 0xC0 is for HID events, other values are for 5 button array */
 189         if (event != 0xc0) {
 190                 if (!priv->array ||
 191                     !sparse_keymap_report_event(priv->array, event, 1, true))
 192                         dev_info(&device->dev, "unknown event 0x%x\n", event);
 193                 return;
 194         }
 195
 196         status = acpi_evaluate_integer(handle, "HDEM", NULL, &ev_index);
 197         if (ACPI_FAILURE(status)) {
 198                 dev_warn(&device->dev, "failed to get event index\n");
 199                 return;
 200         }
 201
 202         if (!sparse_keymap_report_event(priv->input_dev, ev_index, 1, true))
 203                 dev_info(&device->dev, "unknown event index 0x%llx\n",
 204                          ev_index);
 205 }
 206
 207 static int intel_hid_probe(struct platform_device *device)
 208 {
 209         acpi_handle handle = ACPI_HANDLE(&device->dev);
 210         unsigned long long event_cap, mode;
 211         struct intel_hid_priv *priv;
 212         acpi_status status;
 213         int err;
 214
 215         status = acpi_evaluate_integer(handle, "HDMM", NULL, &mode);
 216         if (ACPI_FAILURE(status)) {
 217                 dev_warn(&device->dev, "failed to read mode\n");
 218                 return -ENODEV;
 219         }
 220
 221         if (mode != 0) {
 222                 /*
 223                  * This driver only implements "simple" mode.  There appear
 224                  * to be no other modes, but we should be paranoid and check
 225                  * for compatibility.
 226                  */
 227                 dev_info(&device->dev, "platform is not in simple mode\n");
 228                 return -ENODEV;
 229         }
 230
 231         priv = devm_kzalloc(&device->dev, sizeof(*priv), GFP_KERNEL);
 232         if (!priv)
 233                 return -ENOMEM;
 234         dev_set_drvdata(&device->dev, priv);
 235
 236         err = intel_hid_input_setup(device);
 237         if (err) {
 238                 pr_err("Failed to setup Intel HID hotkeys\n");
 239                 return err;
 240         }
 241
 242         /* Setup 5 button array */
 243         status = acpi_evaluate_integer(handle, "HEBC", NULL, &event_cap);
 244         if (ACPI_SUCCESS(status) && (event_cap & 0x20000)) {
 245                 dev_info(&device->dev, "platform supports 5 button array\n");
 246                 err = intel_button_array_input_setup(device);
 247                 if (err)
 248                         pr_err("Failed to setup Intel 5 button array hotkeys\n");
 249         }
 250
 251         status = acpi_install_notify_handler(handle,
 252                                              ACPI_DEVICE_NOTIFY,
 253                                              notify_handler,
 254                                              device);
 255         if (ACPI_FAILURE(status))
 256                 return -EBUSY;
 257
 258         err = intel_hid_set_enable(&device->dev, true);
 259         if (err)
 260                 goto err_remove_notify;
 261
 262         if (priv->array) {
 263                 intel_button_array_enable(&device->dev, true);
 264
 265                 /* Call button load method to enable HID power button */
 266                 status = acpi_evaluate_object(handle, "BTNL", NULL, NULL);
 267                 if (ACPI_FAILURE(status))
 268                         dev_warn(&device->dev,
 269                                  "failed to enable HID power button\n");
 270         }
 271
 272         return 0;
 273
 274 err_remove_notify:
 275         acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
 276
 277         return err;
 278 }
 279
 280 static int intel_hid_remove(struct platform_device *device)
 281 {
 282         acpi_handle handle = ACPI_HANDLE(&device->dev);
 283
 284         acpi_remove_notify_handler(handle, ACPI_DEVICE_NOTIFY, notify_handler);
 285         intel_hid_set_enable(&device->dev, false);
 286         intel_button_array_enable(&device->dev, false);
 287
 288         /*
 289          * Even if we failed to shut off the event stream, we can still
 290          * safely detach from the device.
 291          */
 292         return 0;
 293 }
 294
 295 static struct platform_driver intel_hid_pl_driver = {
 296         .driver = {
 297                 .name = "intel-hid",
 298                 .acpi_match_table = intel_hid_ids,
 299                 .pm = &intel_hid_pl_pm_ops,
 300         },
 301         .probe = intel_hid_probe,
 302         .remove = intel_hid_remove,
 303 };
 304 MODULE_DEVICE_TABLE(acpi, intel_hid_ids);
 305
 306 /*
 307  * Unfortunately, some laptops provide a _HID="INT33D5" device with
 308  * _CID="PNP0C02".  This causes the pnpacpi scan driver to claim the
 309  * ACPI node, so no platform device will be created.  The pnpacpi
 310  * driver rejects this device in subsequent processing, so no physical
 311  * node is created at all.
 312  *
 313  * As a workaround until the ACPI core figures out how to handle
 314  * this corner case, manually ask the ACPI platform device code to
 315  * claim the ACPI node.
 316  */
 317 static acpi_status __init
 318 check_acpi_dev(acpi_handle handle, u32 lvl, void *context, void **rv)
 319 {
 320         const struct acpi_device_id *ids = context;
 321         struct acpi_device *dev;
 322
 323         if (acpi_bus_get_device(handle, &dev) != 0)
 324                 return AE_OK;
 325
 326         if (acpi_match_device_ids(dev, ids) == 0)
 327                 if (acpi_create_platform_device(dev, NULL))
 328                         dev_info(&dev->dev,
 329                                  "intel-hid: created platform device\n");
 330
 331         return AE_OK;
 332 }
 333
 334 static int __init intel_hid_init(void)
 335 {
 336         acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
 337                             ACPI_UINT32_MAX, check_acpi_dev, NULL,
 338                             (void *)intel_hid_ids, NULL);
 339
 340         return platform_driver_register(&intel_hid_pl_driver);
 341 }
 342 module_init(intel_hid_init);
 343
 344 static void __exit intel_hid_exit(void)
 345 {
 346         platform_driver_unregister(&intel_hid_pl_driver);
 347 }
 348 module_exit(intel_hid_exit);