drivers/hid/hid-input.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *  Copyright (c) 2000-2001 Vojtech Pavlik
   4  *  Copyright (c) 2006-2010 Jiri Kosina
   5  *
   6  *  HID to Linux Input mapping
   7  */
   8
   9 /*
  10  *
  11  * Should you need to contact me, the author, you can do so either by
  12  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  13  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/slab.h>
  18 #include <linux/kernel.h>
  19
  20 #include <linux/hid.h>
  21 #include <linux/hid-debug.h>
  22
  23 #include "hid-ids.h"
  24
  25 #define unk     KEY_UNKNOWN
  26
  27 static const unsigned char hid_keyboard[256] = {
  28           0,  0,  0,  0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36, 37, 38,
  29          50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45, 21, 44,  2,  3,
  30           4,  5,  6,  7,  8,  9, 10, 11, 28,  1, 14, 15, 57, 12, 13, 26,
  31          27, 43, 43, 39, 40, 41, 51, 52, 53, 58, 59, 60, 61, 62, 63, 64,
  32          65, 66, 67, 68, 87, 88, 99, 70,119,110,102,104,111,107,109,106,
  33         105,108,103, 69, 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71,
  34          72, 73, 82, 83, 86,127,116,117,183,184,185,186,187,188,189,190,
  35         191,192,193,194,134,138,130,132,128,129,131,137,133,135,136,113,
  36         115,114,unk,unk,unk,121,unk, 89, 93,124, 92, 94, 95,unk,unk,unk,
  37         122,123, 90, 91, 85,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,
  38         unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
  39         unk,unk,unk,unk,unk,unk,179,180,unk,unk,unk,unk,unk,unk,unk,unk,
  40         unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
  41         unk,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,unk,unk,unk,unk,
  42          29, 42, 56,125, 97, 54,100,126,164,166,165,163,161,115,114,113,
  43         150,158,159,128,136,177,178,176,142,152,173,140,unk,unk,unk,unk
  44 };
  45
  46 static const struct {
  47         __s32 x;
  48         __s32 y;
  49 }  hid_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
  50
  51 #define map_abs(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_ABS, (c))
  52 #define map_rel(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_REL, (c))
  53 #define map_key(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_KEY, (c))
  54 #define map_led(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_LED, (c))
  55
  56 #define map_abs_clear(c)        hid_map_usage_clear(hidinput, usage, &bit, \
  57                 &max, EV_ABS, (c))
  58 #define map_key_clear(c)        hid_map_usage_clear(hidinput, usage, &bit, \
  59                 &max, EV_KEY, (c))
  60
  61 static bool match_scancode(struct hid_usage *usage,
  62                            unsigned int cur_idx, unsigned int scancode)
  63 {
  64         return (usage->hid & (HID_USAGE_PAGE | HID_USAGE)) == scancode;
  65 }
  66
  67 static bool match_keycode(struct hid_usage *usage,
  68                           unsigned int cur_idx, unsigned int keycode)
  69 {
  70         /*
  71          * We should exclude unmapped usages when doing lookup by keycode.
  72          */
  73         return (usage->type == EV_KEY && usage->code == keycode);
  74 }
  75
  76 static bool match_index(struct hid_usage *usage,
  77                         unsigned int cur_idx, unsigned int idx)
  78 {
  79         return cur_idx == idx;
  80 }
  81
  82 typedef bool (*hid_usage_cmp_t)(struct hid_usage *usage,
  83                                 unsigned int cur_idx, unsigned int val);
  84
  85 static struct hid_usage *hidinput_find_key(struct hid_device *hid,
  86                                            hid_usage_cmp_t match,
  87                                            unsigned int value,
  88                                            unsigned int *usage_idx)
  89 {
  90         unsigned int i, j, k, cur_idx = 0;
  91         struct hid_report *report;
  92         struct hid_usage *usage;
  93
  94         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
  95                 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
  96                         for (i = 0; i < report->maxfield; i++) {
  97                                 for (j = 0; j < report->field[i]->maxusage; j++) {
  98                                         usage = report->field[i]->usage + j;
  99                                         if (usage->type == EV_KEY || usage->type == 0) {
 100                                                 if (match(usage, cur_idx, value)) {
 101                                                         if (usage_idx)
 102                                                                 *usage_idx = cur_idx;
 103                                                         return usage;
 104                                                 }
 105                                                 cur_idx++;
 106                                         }
 107                                 }
 108                         }
 109                 }
 110         }
 111         return NULL;
 112 }
 113
 114 static struct hid_usage *hidinput_locate_usage(struct hid_device *hid,
 115                                         const struct input_keymap_entry *ke,
 116                                         unsigned int *index)
 117 {
 118         struct hid_usage *usage;
 119         unsigned int scancode;
 120
 121         if (ke->flags & INPUT_KEYMAP_BY_INDEX)
 122                 usage = hidinput_find_key(hid, match_index, ke->index, index);
 123         else if (input_scancode_to_scalar(ke, &scancode) == 0)
 124                 usage = hidinput_find_key(hid, match_scancode, scancode, index);
 125         else
 126                 usage = NULL;
 127
 128         return usage;
 129 }
 130
 131 static int hidinput_getkeycode(struct input_dev *dev,
 132                                struct input_keymap_entry *ke)
 133 {
 134         struct hid_device *hid = input_get_drvdata(dev);
 135         struct hid_usage *usage;
 136         unsigned int scancode, index;
 137
 138         usage = hidinput_locate_usage(hid, ke, &index);
 139         if (usage) {
 140                 ke->keycode = usage->type == EV_KEY ?
 141                                 usage->code : KEY_RESERVED;
 142                 ke->index = index;
 143                 scancode = usage->hid & (HID_USAGE_PAGE | HID_USAGE);
 144                 ke->len = sizeof(scancode);
 145                 memcpy(ke->scancode, &scancode, sizeof(scancode));
 146                 return 0;
 147         }
 148
 149         return -EINVAL;
 150 }
 151
 152 static int hidinput_setkeycode(struct input_dev *dev,
 153                                const struct input_keymap_entry *ke,
 154                                unsigned int *old_keycode)
 155 {
 156         struct hid_device *hid = input_get_drvdata(dev);
 157         struct hid_usage *usage;
 158
 159         usage = hidinput_locate_usage(hid, ke, NULL);
 160         if (usage) {
 161                 *old_keycode = usage->type == EV_KEY ?
 162                                 usage->code : KEY_RESERVED;
 163                 usage->code = ke->keycode;
 164
 165                 clear_bit(*old_keycode, dev->keybit);
 166                 set_bit(usage->code, dev->keybit);
 167                 dbg_hid("Assigned keycode %d to HID usage code %x\n",
 168                         usage->code, usage->hid);
 169
 170                 /*
 171                  * Set the keybit for the old keycode if the old keycode is used
 172                  * by another key
 173                  */
 174                 if (hidinput_find_key(hid, match_keycode, *old_keycode, NULL))
 175                         set_bit(*old_keycode, dev->keybit);
 176
 177                 return 0;
 178         }
 179
 180         return -EINVAL;
 181 }
 182
 183
 184 /**
 185  * hidinput_calc_abs_res - calculate an absolute axis resolution
 186  * @field: the HID report field to calculate resolution for
 187  * @code: axis code
 188  *
 189  * The formula is:
 190  *                         (logical_maximum - logical_minimum)
 191  * resolution = ----------------------------------------------------------
 192  *              (physical_maximum - physical_minimum) * 10 ^ unit_exponent
 193  *
 194  * as seen in the HID specification v1.11 6.2.2.7 Global Items.
 195  *
 196  * Only exponent 1 length units are processed. Centimeters and inches are
 197  * converted to millimeters. Degrees are converted to radians.
 198  */
 199 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code)
 200 {
 201         __s32 unit_exponent = field->unit_exponent;
 202         __s32 logical_extents = field->logical_maximum -
 203                                         field->logical_minimum;
 204         __s32 physical_extents = field->physical_maximum -
 205                                         field->physical_minimum;
 206         __s32 prev;
 207
 208         /* Check if the extents are sane */
 209         if (logical_extents <= 0 || physical_extents <= 0)
 210                 return 0;
 211
 212         /*
 213          * Verify and convert units.
 214          * See HID specification v1.11 6.2.2.7 Global Items for unit decoding
 215          */
 216         switch (code) {
 217         case ABS_X:
 218         case ABS_Y:
 219         case ABS_Z:
 220         case ABS_MT_POSITION_X:
 221         case ABS_MT_POSITION_Y:
 222         case ABS_MT_TOOL_X:
 223         case ABS_MT_TOOL_Y:
 224         case ABS_MT_TOUCH_MAJOR:
 225         case ABS_MT_TOUCH_MINOR:
 226                 if (field->unit == 0x11) {              /* If centimeters */
 227                         /* Convert to millimeters */
 228                         unit_exponent += 1;
 229                 } else if (field->unit == 0x13) {       /* If inches */
 230                         /* Convert to millimeters */
 231                         prev = physical_extents;
 232                         physical_extents *= 254;
 233                         if (physical_extents < prev)
 234                                 return 0;
 235                         unit_exponent -= 1;
 236                 } else {
 237                         return 0;
 238                 }
 239                 break;
 240
 241         case ABS_RX:
 242         case ABS_RY:
 243         case ABS_RZ:
 244         case ABS_WHEEL:
 245         case ABS_TILT_X:
 246         case ABS_TILT_Y:
 247                 if (field->unit == 0x14) {              /* If degrees */
 248                         /* Convert to radians */
 249                         prev = logical_extents;
 250                         logical_extents *= 573;
 251                         if (logical_extents < prev)
 252                                 return 0;
 253                         unit_exponent += 1;
 254                 } else if (field->unit != 0x12) {       /* If not radians */
 255                         return 0;
 256                 }
 257                 break;
 258
 259         default:
 260                 return 0;
 261         }
 262
 263         /* Apply negative unit exponent */
 264         for (; unit_exponent < 0; unit_exponent++) {
 265                 prev = logical_extents;
 266                 logical_extents *= 10;
 267                 if (logical_extents < prev)
 268                         return 0;
 269         }
 270         /* Apply positive unit exponent */
 271         for (; unit_exponent > 0; unit_exponent--) {
 272                 prev = physical_extents;
 273                 physical_extents *= 10;
 274                 if (physical_extents < prev)
 275                         return 0;
 276         }
 277
 278         /* Calculate resolution */
 279         return DIV_ROUND_CLOSEST(logical_extents, physical_extents);
 280 }
 281 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res);
 282
 283 #ifdef CONFIG_HID_BATTERY_STRENGTH
 284 static enum power_supply_property hidinput_battery_props[] = {
 285         POWER_SUPPLY_PROP_PRESENT,
 286         POWER_SUPPLY_PROP_ONLINE,
 287         POWER_SUPPLY_PROP_CAPACITY,
 288         POWER_SUPPLY_PROP_MODEL_NAME,
 289         POWER_SUPPLY_PROP_STATUS,
 290         POWER_SUPPLY_PROP_SCOPE,
 291 };
 292
 293 #define HID_BATTERY_QUIRK_PERCENT       (1 << 0) /* always reports percent */
 294 #define HID_BATTERY_QUIRK_FEATURE       (1 << 1) /* ask for feature report */
 295 #define HID_BATTERY_QUIRK_IGNORE        (1 << 2) /* completely ignore the battery */
 296
 297 static const struct hid_device_id hid_battery_quirks[] = {
 298         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 299                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
 300           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
 301         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 302                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
 303           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
 304         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 305                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
 306           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
 307         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 308                                USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
 309           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
 310         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 311                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
 312           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
 313         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM,
 314                 USB_DEVICE_ID_ELECOM_BM084),
 315           HID_BATTERY_QUIRK_IGNORE },
 316         { HID_USB_DEVICE(USB_VENDOR_ID_SYMBOL,
 317                 USB_DEVICE_ID_SYMBOL_SCANNER_3),
 318           HID_BATTERY_QUIRK_IGNORE },
 319         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ASUSTEK,
 320                 USB_DEVICE_ID_ASUSTEK_T100CHI_KEYBOARD),
 321           HID_BATTERY_QUIRK_IGNORE },
 322         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH,
 323                 USB_DEVICE_ID_LOGITECH_DINOVO_EDGE_KBD),
 324           HID_BATTERY_QUIRK_IGNORE },
 325         { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_ASUS_UX550_TOUCHSCREEN),
 326           HID_BATTERY_QUIRK_IGNORE },
 327         { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_SPECTRE_X360_15),
 328           HID_BATTERY_QUIRK_IGNORE },
 329         { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_SURFACE_GO_TOUCHSCREEN),
 330           HID_BATTERY_QUIRK_IGNORE },
 331         {}
 332 };
 333
 334 static unsigned find_battery_quirk(struct hid_device *hdev)
 335 {
 336         unsigned quirks = 0;
 337         const struct hid_device_id *match;
 338
 339         match = hid_match_id(hdev, hid_battery_quirks);
 340         if (match != NULL)
 341                 quirks = match->driver_data;
 342
 343         return quirks;
 344 }
 345
 346 static int hidinput_scale_battery_capacity(struct hid_device *dev,
 347                                            int value)
 348 {
 349         if (dev->battery_min < dev->battery_max &&
 350             value >= dev->battery_min && value <= dev->battery_max)
 351                 value = ((value - dev->battery_min) * 100) /
 352                         (dev->battery_max - dev->battery_min);
 353
 354         return value;
 355 }
 356
 357 static int hidinput_query_battery_capacity(struct hid_device *dev)
 358 {
 359         u8 *buf;
 360         int ret;
 361
 362         buf = kmalloc(4, GFP_KERNEL);
 363         if (!buf)
 364                 return -ENOMEM;
 365
 366         ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 4,
 367                                  dev->battery_report_type, HID_REQ_GET_REPORT);
 368         if (ret < 2) {
 369                 kfree(buf);
 370                 return -ENODATA;
 371         }
 372
 373         ret = hidinput_scale_battery_capacity(dev, buf[1]);
 374         kfree(buf);
 375         return ret;
 376 }
 377
 378 static int hidinput_get_battery_property(struct power_supply *psy,
 379                                          enum power_supply_property prop,
 380                                          union power_supply_propval *val)
 381 {
 382         struct hid_device *dev = power_supply_get_drvdata(psy);
 383         int value;
 384         int ret = 0;
 385
 386         switch (prop) {
 387         case POWER_SUPPLY_PROP_PRESENT:
 388         case POWER_SUPPLY_PROP_ONLINE:
 389                 val->intval = 1;
 390                 break;
 391
 392         case POWER_SUPPLY_PROP_CAPACITY:
 393                 if (dev->battery_status != HID_BATTERY_REPORTED &&
 394                     !dev->battery_avoid_query) {
 395                         value = hidinput_query_battery_capacity(dev);
 396                         if (value < 0)
 397                                 return value;
 398                 } else  {
 399                         value = dev->battery_capacity;
 400                 }
 401
 402                 val->intval = value;
 403                 break;
 404
 405         case POWER_SUPPLY_PROP_MODEL_NAME:
 406                 val->strval = dev->name;
 407                 break;
 408
 409         case POWER_SUPPLY_PROP_STATUS:
 410                 if (dev->battery_status != HID_BATTERY_REPORTED &&
 411                     !dev->battery_avoid_query) {
 412                         value = hidinput_query_battery_capacity(dev);
 413                         if (value < 0)
 414                                 return value;
 415
 416                         dev->battery_capacity = value;
 417                         dev->battery_status = HID_BATTERY_QUERIED;
 418                 }
 419
 420                 if (dev->battery_status == HID_BATTERY_UNKNOWN)
 421                         val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
 422                 else if (dev->battery_capacity == 100)
 423                         val->intval = POWER_SUPPLY_STATUS_FULL;
 424                 else
 425                         val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
 426                 break;
 427
 428         case POWER_SUPPLY_PROP_SCOPE:
 429                 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
 430                 break;
 431
 432         default:
 433                 ret = -EINVAL;
 434                 break;
 435         }
 436
 437         return ret;
 438 }
 439
 440 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
 441                                   struct hid_field *field, bool is_percentage)
 442 {
 443         struct power_supply_desc *psy_desc;
 444         struct power_supply_config psy_cfg = { .drv_data = dev, };
 445         unsigned quirks;
 446         s32 min, max;
 447         int error;
 448
 449         if (dev->battery)
 450                 return 0;       /* already initialized? */
 451
 452         quirks = find_battery_quirk(dev);
 453
 454         hid_dbg(dev, "device %x:%x:%x %d quirks %d\n",
 455                 dev->bus, dev->vendor, dev->product, dev->version, quirks);
 456
 457         if (quirks & HID_BATTERY_QUIRK_IGNORE)
 458                 return 0;
 459
 460         psy_desc = kzalloc(sizeof(*psy_desc), GFP_KERNEL);
 461         if (!psy_desc)
 462                 return -ENOMEM;
 463
 464         psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery",
 465                                    strlen(dev->uniq) ?
 466                                         dev->uniq : dev_name(&dev->dev));
 467         if (!psy_desc->name) {
 468                 error = -ENOMEM;
 469                 goto err_free_mem;
 470         }
 471
 472         psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
 473         psy_desc->properties = hidinput_battery_props;
 474         psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props);
 475         psy_desc->use_for_apm = 0;
 476         psy_desc->get_property = hidinput_get_battery_property;
 477
 478         min = field->logical_minimum;
 479         max = field->logical_maximum;
 480
 481         if (is_percentage || (quirks & HID_BATTERY_QUIRK_PERCENT)) {
 482                 min = 0;
 483                 max = 100;
 484         }
 485
 486         if (quirks & HID_BATTERY_QUIRK_FEATURE)
 487                 report_type = HID_FEATURE_REPORT;
 488
 489         dev->battery_min = min;
 490         dev->battery_max = max;
 491         dev->battery_report_type = report_type;
 492         dev->battery_report_id = field->report->id;
 493
 494         /*
 495          * Stylus is normally not connected to the device and thus we
 496          * can't query the device and get meaningful battery strength.
 497          * We have to wait for the device to report it on its own.
 498          */
 499         dev->battery_avoid_query = report_type == HID_INPUT_REPORT &&
 500                                    field->physical == HID_DG_STYLUS;
 501
 502         dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg);
 503         if (IS_ERR(dev->battery)) {
 504                 error = PTR_ERR(dev->battery);
 505                 hid_warn(dev, "can't register power supply: %d\n", error);
 506                 goto err_free_name;
 507         }
 508
 509         power_supply_powers(dev->battery, &dev->dev);
 510         return 0;
 511
 512 err_free_name:
 513         kfree(psy_desc->name);
 514 err_free_mem:
 515         kfree(psy_desc);
 516         dev->battery = NULL;
 517         return error;
 518 }
 519
 520 static void hidinput_cleanup_battery(struct hid_device *dev)
 521 {
 522         const struct power_supply_desc *psy_desc;
 523
 524         if (!dev->battery)
 525                 return;
 526
 527         psy_desc = dev->battery->desc;
 528         power_supply_unregister(dev->battery);
 529         kfree(psy_desc->name);
 530         kfree(psy_desc);
 531         dev->battery = NULL;
 532 }
 533
 534 static void hidinput_update_battery(struct hid_device *dev, int value)
 535 {
 536         int capacity;
 537
 538         if (!dev->battery)
 539                 return;
 540
 541         if (value == 0 || value < dev->battery_min || value > dev->battery_max)
 542                 return;
 543
 544         capacity = hidinput_scale_battery_capacity(dev, value);
 545
 546         if (dev->battery_status != HID_BATTERY_REPORTED ||
 547             capacity != dev->battery_capacity ||
 548             ktime_after(ktime_get_coarse(), dev->battery_ratelimit_time)) {
 549                 dev->battery_capacity = capacity;
 550                 dev->battery_status = HID_BATTERY_REPORTED;
 551                 dev->battery_ratelimit_time =
 552                         ktime_add_ms(ktime_get_coarse(), 30 * 1000);
 553                 power_supply_changed(dev->battery);
 554         }
 555 }
 556 #else  /* !CONFIG_HID_BATTERY_STRENGTH */
 557 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
 558                                   struct hid_field *field, bool is_percentage)
 559 {
 560         return 0;
 561 }
 562
 563 static void hidinput_cleanup_battery(struct hid_device *dev)
 564 {
 565 }
 566
 567 static void hidinput_update_battery(struct hid_device *dev, int value)
 568 {
 569 }
 570 #endif  /* CONFIG_HID_BATTERY_STRENGTH */
 571
 572 static bool hidinput_field_in_collection(struct hid_device *device, struct hid_field *field,
 573                                          unsigned int type, unsigned int usage)
 574 {
 575         struct hid_collection *collection;
 576
 577         collection = &device->collection[field->usage->collection_index];
 578
 579         return collection->type == type && collection->usage == usage;
 580 }
 581
 582 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
 583                                      struct hid_usage *usage)
 584 {
 585         struct input_dev *input = hidinput->input;
 586         struct hid_device *device = input_get_drvdata(input);
 587         int max = 0, code;
 588         unsigned long *bit = NULL;
 589
 590         field->hidinput = hidinput;
 591
 592         if (field->flags & HID_MAIN_ITEM_CONSTANT)
 593                 goto ignore;
 594
 595         /* Ignore if report count is out of bounds. */
 596         if (field->report_count < 1)
 597                 goto ignore;
 598
 599         /* only LED usages are supported in output fields */
 600         if (field->report_type == HID_OUTPUT_REPORT &&
 601                         (usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
 602                 goto ignore;
 603         }
 604
 605         if (device->driver->input_mapping) {
 606                 int ret = device->driver->input_mapping(device, hidinput, field,
 607                                 usage, &bit, &max);
 608                 if (ret > 0)
 609                         goto mapped;
 610                 if (ret < 0)
 611                         goto ignore;
 612         }
 613
 614         switch (usage->hid & HID_USAGE_PAGE) {
 615         case HID_UP_UNDEFINED:
 616                 goto ignore;
 617
 618         case HID_UP_KEYBOARD:
 619                 set_bit(EV_REP, input->evbit);
 620
 621                 if ((usage->hid & HID_USAGE) < 256) {
 622                         if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
 623                         map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
 624                 } else
 625                         map_key(KEY_UNKNOWN);
 626
 627                 break;
 628
 629         case HID_UP_BUTTON:
 630                 code = ((usage->hid - 1) & HID_USAGE);
 631
 632                 switch (field->application) {
 633                 case HID_GD_MOUSE:
 634                 case HID_GD_POINTER:  code += BTN_MOUSE; break;
 635                 case HID_GD_JOYSTICK:
 636                                 if (code <= 0xf)
 637                                         code += BTN_JOYSTICK;
 638                                 else
 639                                         code += BTN_TRIGGER_HAPPY - 0x10;
 640                                 break;
 641                 case HID_GD_GAMEPAD:
 642                                 if (code <= 0xf)
 643                                         code += BTN_GAMEPAD;
 644                                 else
 645                                         code += BTN_TRIGGER_HAPPY - 0x10;
 646                                 break;
 647                 case HID_CP_CONSUMER_CONTROL:
 648                                 if (hidinput_field_in_collection(device, field,
 649                                                                  HID_COLLECTION_NAMED_ARRAY,
 650                                                                  HID_CP_PROGRAMMABLEBUTTONS)) {
 651                                         if (code <= 0x1d)
 652                                                 code += KEY_MACRO1;
 653                                         else
 654                                                 code += BTN_TRIGGER_HAPPY - 0x1e;
 655                                 } else {
 656                                         goto ignore;
 657                                 }
 658                                 break;
 659                 default:
 660                         switch (field->physical) {
 661                         case HID_GD_MOUSE:
 662                         case HID_GD_POINTER:  code += BTN_MOUSE; break;
 663                         case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break;
 664                         case HID_GD_GAMEPAD:  code += BTN_GAMEPAD; break;
 665                         default:              code += BTN_MISC;
 666                         }
 667                 }
 668
 669                 map_key(code);
 670                 break;
 671
 672         case HID_UP_SIMULATION:
 673                 switch (usage->hid & 0xffff) {
 674                 case 0xba: map_abs(ABS_RUDDER);   break;
 675                 case 0xbb: map_abs(ABS_THROTTLE); break;
 676                 case 0xc4: map_abs(ABS_GAS);      break;
 677                 case 0xc5: map_abs(ABS_BRAKE);    break;
 678                 case 0xc8: map_abs(ABS_WHEEL);    break;
 679                 default:   goto ignore;
 680                 }
 681                 break;
 682
 683         case HID_UP_GENDESK:
 684                 if ((usage->hid & 0xf0) == 0x80) {      /* SystemControl */
 685                         switch (usage->hid & 0xf) {
 686                         case 0x1: map_key_clear(KEY_POWER);  break;
 687                         case 0x2: map_key_clear(KEY_SLEEP);  break;
 688                         case 0x3: map_key_clear(KEY_WAKEUP); break;
 689                         case 0x4: map_key_clear(KEY_CONTEXT_MENU); break;
 690                         case 0x5: map_key_clear(KEY_MENU); break;
 691                         case 0x6: map_key_clear(KEY_PROG1); break;
 692                         case 0x7: map_key_clear(KEY_HELP); break;
 693                         case 0x8: map_key_clear(KEY_EXIT); break;
 694                         case 0x9: map_key_clear(KEY_SELECT); break;
 695                         case 0xa: map_key_clear(KEY_RIGHT); break;
 696                         case 0xb: map_key_clear(KEY_LEFT); break;
 697                         case 0xc: map_key_clear(KEY_UP); break;
 698                         case 0xd: map_key_clear(KEY_DOWN); break;
 699                         case 0xe: map_key_clear(KEY_POWER2); break;
 700                         case 0xf: map_key_clear(KEY_RESTART); break;
 701                         default: goto unknown;
 702                         }
 703                         break;
 704                 }
 705
 706                 if ((usage->hid & 0xf0) == 0xb0) {      /* SC - Display */
 707                         switch (usage->hid & 0xf) {
 708                         case 0x05: map_key_clear(KEY_SWITCHVIDEOMODE); break;
 709                         default: goto ignore;
 710                         }
 711                         break;
 712                 }
 713
 714                 /*
 715                  * Some lazy vendors declare 255 usages for System Control,
 716                  * leading to the creation of ABS_X|Y axis and too many others.
 717                  * It wouldn't be a problem if joydev doesn't consider the
 718                  * device as a joystick then.
 719                  */
 720                 if (field->application == HID_GD_SYSTEM_CONTROL)
 721                         goto ignore;
 722
 723                 if ((usage->hid & 0xf0) == 0x90) {      /* D-pad */
 724                         switch (usage->hid) {
 725                         case HID_GD_UP:    usage->hat_dir = 1; break;
 726                         case HID_GD_DOWN:  usage->hat_dir = 5; break;
 727                         case HID_GD_RIGHT: usage->hat_dir = 3; break;
 728                         case HID_GD_LEFT:  usage->hat_dir = 7; break;
 729                         default: goto unknown;
 730                         }
 731                         if (field->dpad) {
 732                                 map_abs(field->dpad);
 733                                 goto ignore;
 734                         }
 735                         map_abs(ABS_HAT0X);
 736                         break;
 737                 }
 738
 739                 switch (usage->hid) {
 740                 /* These usage IDs map directly to the usage codes. */
 741                 case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
 742                 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
 743                         if (field->flags & HID_MAIN_ITEM_RELATIVE)
 744                                 map_rel(usage->hid & 0xf);
 745                         else
 746                                 map_abs_clear(usage->hid & 0xf);
 747                         break;
 748
 749                 case HID_GD_WHEEL:
 750                         if (field->flags & HID_MAIN_ITEM_RELATIVE) {
 751                                 set_bit(REL_WHEEL, input->relbit);
 752                                 map_rel(REL_WHEEL_HI_RES);
 753                         } else {
 754                                 map_abs(usage->hid & 0xf);
 755                         }
 756                         break;
 757                 case HID_GD_SLIDER: case HID_GD_DIAL:
 758                         if (field->flags & HID_MAIN_ITEM_RELATIVE)
 759                                 map_rel(usage->hid & 0xf);
 760                         else
 761                                 map_abs(usage->hid & 0xf);
 762                         break;
 763
 764                 case HID_GD_HATSWITCH:
 765                         usage->hat_min = field->logical_minimum;
 766                         usage->hat_max = field->logical_maximum;
 767                         map_abs(ABS_HAT0X);
 768                         break;
 769
 770                 case HID_GD_START:      map_key_clear(BTN_START);       break;
 771                 case HID_GD_SELECT:     map_key_clear(BTN_SELECT);      break;
 772
 773                 case HID_GD_RFKILL_BTN:
 774                         /* MS wireless radio ctl extension, also check CA */
 775                         if (field->application == HID_GD_WIRELESS_RADIO_CTLS) {
 776                                 map_key_clear(KEY_RFKILL);
 777                                 /* We need to simulate the btn release */
 778                                 field->flags |= HID_MAIN_ITEM_RELATIVE;
 779                                 break;
 780                         }
 781                         goto unknown;
 782
 783                 default: goto unknown;
 784                 }
 785
 786                 break;
 787
 788         case HID_UP_LED:
 789                 switch (usage->hid & 0xffff) {                /* HID-Value:                   */
 790                 case 0x01:  map_led (LED_NUML);     break;    /*   "Num Lock"                 */
 791                 case 0x02:  map_led (LED_CAPSL);    break;    /*   "Caps Lock"                */
 792                 case 0x03:  map_led (LED_SCROLLL);  break;    /*   "Scroll Lock"              */
 793                 case 0x04:  map_led (LED_COMPOSE);  break;    /*   "Compose"                  */
 794                 case 0x05:  map_led (LED_KANA);     break;    /*   "Kana"                     */
 795                 case 0x27:  map_led (LED_SLEEP);    break;    /*   "Stand-By"                 */
 796                 case 0x4c:  map_led (LED_SUSPEND);  break;    /*   "System Suspend"           */
 797                 case 0x09:  map_led (LED_MUTE);     break;    /*   "Mute"                     */
 798                 case 0x4b:  map_led (LED_MISC);     break;    /*   "Generic Indicator"        */
 799                 case 0x19:  map_led (LED_MAIL);     break;    /*   "Message Waiting"          */
 800                 case 0x4d:  map_led (LED_CHARGING); break;    /*   "External Power Connected" */
 801
 802                 default: goto ignore;
 803                 }
 804                 break;
 805
 806         case HID_UP_DIGITIZER:
 807                 if ((field->application & 0xff) == 0x01) /* Digitizer */
 808                         __set_bit(INPUT_PROP_POINTER, input->propbit);
 809                 else if ((field->application & 0xff) == 0x02) /* Pen */
 810                         __set_bit(INPUT_PROP_DIRECT, input->propbit);
 811
 812                 switch (usage->hid & 0xff) {
 813                 case 0x00: /* Undefined */
 814                         goto ignore;
 815
 816                 case 0x30: /* TipPressure */
 817                         if (!test_bit(BTN_TOUCH, input->keybit)) {
 818                                 device->quirks |= HID_QUIRK_NOTOUCH;
 819                                 set_bit(EV_KEY, input->evbit);
 820                                 set_bit(BTN_TOUCH, input->keybit);
 821                         }
 822                         map_abs_clear(ABS_PRESSURE);
 823                         break;
 824
 825                 case 0x32: /* InRange */
 826                         switch (field->physical & 0xff) {
 827                         case 0x21: map_key(BTN_TOOL_MOUSE); break;
 828                         case 0x22: map_key(BTN_TOOL_FINGER); break;
 829                         default: map_key(BTN_TOOL_PEN); break;
 830                         }
 831                         break;
 832
 833                 case 0x3b: /* Battery Strength */
 834                         hidinput_setup_battery(device, HID_INPUT_REPORT, field, false);
 835                         usage->type = EV_PWR;
 836                         return;
 837
 838                 case 0x3c: /* Invert */
 839                         map_key_clear(BTN_TOOL_RUBBER);
 840                         break;
 841
 842                 case 0x3d: /* X Tilt */
 843                         map_abs_clear(ABS_TILT_X);
 844                         break;
 845
 846                 case 0x3e: /* Y Tilt */
 847                         map_abs_clear(ABS_TILT_Y);
 848                         break;
 849
 850                 case 0x33: /* Touch */
 851                 case 0x42: /* TipSwitch */
 852                 case 0x43: /* TipSwitch2 */
 853                         device->quirks &= ~HID_QUIRK_NOTOUCH;
 854                         map_key_clear(BTN_TOUCH);
 855                         break;
 856
 857                 case 0x44: /* BarrelSwitch */
 858                         map_key_clear(BTN_STYLUS);
 859                         break;
 860
 861                 case 0x45: /* ERASER */
 862                         /*
 863                          * This event is reported when eraser tip touches the surface.
 864                          * Actual eraser (BTN_TOOL_RUBBER) is set by Invert usage when
 865                          * tool gets in proximity.
 866                          */
 867                         map_key_clear(BTN_TOUCH);
 868                         break;
 869
 870                 case 0x46: /* TabletPick */
 871                 case 0x5a: /* SecondaryBarrelSwitch */
 872                         map_key_clear(BTN_STYLUS2);
 873                         break;
 874
 875                 case 0x5b: /* TransducerSerialNumber */
 876                         usage->type = EV_MSC;
 877                         usage->code = MSC_SERIAL;
 878                         bit = input->mscbit;
 879                         max = MSC_MAX;
 880                         break;
 881
 882                 default:  goto unknown;
 883                 }
 884                 break;
 885
 886         case HID_UP_TELEPHONY:
 887                 switch (usage->hid & HID_USAGE) {
 888                 case 0x2f: map_key_clear(KEY_MICMUTE);          break;
 889                 case 0xb0: map_key_clear(KEY_NUMERIC_0);        break;
 890                 case 0xb1: map_key_clear(KEY_NUMERIC_1);        break;
 891                 case 0xb2: map_key_clear(KEY_NUMERIC_2);        break;
 892                 case 0xb3: map_key_clear(KEY_NUMERIC_3);        break;
 893                 case 0xb4: map_key_clear(KEY_NUMERIC_4);        break;
 894                 case 0xb5: map_key_clear(KEY_NUMERIC_5);        break;
 895                 case 0xb6: map_key_clear(KEY_NUMERIC_6);        break;
 896                 case 0xb7: map_key_clear(KEY_NUMERIC_7);        break;
 897                 case 0xb8: map_key_clear(KEY_NUMERIC_8);        break;
 898                 case 0xb9: map_key_clear(KEY_NUMERIC_9);        break;
 899                 case 0xba: map_key_clear(KEY_NUMERIC_STAR);     break;
 900                 case 0xbb: map_key_clear(KEY_NUMERIC_POUND);    break;
 901                 case 0xbc: map_key_clear(KEY_NUMERIC_A);        break;
 902                 case 0xbd: map_key_clear(KEY_NUMERIC_B);        break;
 903                 case 0xbe: map_key_clear(KEY_NUMERIC_C);        break;
 904                 case 0xbf: map_key_clear(KEY_NUMERIC_D);        break;
 905                 default: goto ignore;
 906                 }
 907                 break;
 908
 909         case HID_UP_CONSUMER:   /* USB HUT v1.12, pages 75-84 */
 910                 switch (usage->hid & HID_USAGE) {
 911                 case 0x000: goto ignore;
 912                 case 0x030: map_key_clear(KEY_POWER);           break;
 913                 case 0x031: map_key_clear(KEY_RESTART);         break;
 914                 case 0x032: map_key_clear(KEY_SLEEP);           break;
 915                 case 0x034: map_key_clear(KEY_SLEEP);           break;
 916                 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE);  break;
 917                 case 0x036: map_key_clear(BTN_MISC);            break;
 918
 919                 case 0x040: map_key_clear(KEY_MENU);            break; /* Menu */
 920                 case 0x041: map_key_clear(KEY_SELECT);          break; /* Menu Pick */
 921                 case 0x042: map_key_clear(KEY_UP);              break; /* Menu Up */
 922                 case 0x043: map_key_clear(KEY_DOWN);            break; /* Menu Down */
 923                 case 0x044: map_key_clear(KEY_LEFT);            break; /* Menu Left */
 924                 case 0x045: map_key_clear(KEY_RIGHT);           break; /* Menu Right */
 925                 case 0x046: map_key_clear(KEY_ESC);             break; /* Menu Escape */
 926                 case 0x047: map_key_clear(KEY_KPPLUS);          break; /* Menu Value Increase */
 927                 case 0x048: map_key_clear(KEY_KPMINUS);         break; /* Menu Value Decrease */
 928
 929                 case 0x060: map_key_clear(KEY_INFO);            break; /* Data On Screen */
 930                 case 0x061: map_key_clear(KEY_SUBTITLE);        break; /* Closed Caption */
 931                 case 0x063: map_key_clear(KEY_VCR);             break; /* VCR/TV */
 932                 case 0x065: map_key_clear(KEY_CAMERA);          break; /* Snapshot */
 933                 case 0x069: map_key_clear(KEY_RED);             break;
 934                 case 0x06a: map_key_clear(KEY_GREEN);           break;
 935                 case 0x06b: map_key_clear(KEY_BLUE);            break;
 936                 case 0x06c: map_key_clear(KEY_YELLOW);          break;
 937                 case 0x06d: map_key_clear(KEY_ASPECT_RATIO);    break;
 938
 939                 case 0x06f: map_key_clear(KEY_BRIGHTNESSUP);            break;
 940                 case 0x070: map_key_clear(KEY_BRIGHTNESSDOWN);          break;
 941                 case 0x072: map_key_clear(KEY_BRIGHTNESS_TOGGLE);       break;
 942                 case 0x073: map_key_clear(KEY_BRIGHTNESS_MIN);          break;
 943                 case 0x074: map_key_clear(KEY_BRIGHTNESS_MAX);          break;
 944                 case 0x075: map_key_clear(KEY_BRIGHTNESS_AUTO);         break;
 945
 946                 case 0x079: map_key_clear(KEY_KBDILLUMUP);      break;
 947                 case 0x07a: map_key_clear(KEY_KBDILLUMDOWN);    break;
 948                 case 0x07c: map_key_clear(KEY_KBDILLUMTOGGLE);  break;
 949
 950                 case 0x082: map_key_clear(KEY_VIDEO_NEXT);      break;
 951                 case 0x083: map_key_clear(KEY_LAST);            break;
 952                 case 0x084: map_key_clear(KEY_ENTER);           break;
 953                 case 0x088: map_key_clear(KEY_PC);              break;
 954                 case 0x089: map_key_clear(KEY_TV);              break;
 955                 case 0x08a: map_key_clear(KEY_WWW);             break;
 956                 case 0x08b: map_key_clear(KEY_DVD);             break;
 957                 case 0x08c: map_key_clear(KEY_PHONE);           break;
 958                 case 0x08d: map_key_clear(KEY_PROGRAM);         break;
 959                 case 0x08e: map_key_clear(KEY_VIDEOPHONE);      break;
 960                 case 0x08f: map_key_clear(KEY_GAMES);           break;
 961                 case 0x090: map_key_clear(KEY_MEMO);            break;
 962                 case 0x091: map_key_clear(KEY_CD);              break;
 963                 case 0x092: map_key_clear(KEY_VCR);             break;
 964                 case 0x093: map_key_clear(KEY_TUNER);           break;
 965                 case 0x094: map_key_clear(KEY_EXIT);            break;
 966                 case 0x095: map_key_clear(KEY_HELP);            break;
 967                 case 0x096: map_key_clear(KEY_TAPE);            break;
 968                 case 0x097: map_key_clear(KEY_TV2);             break;
 969                 case 0x098: map_key_clear(KEY_SAT);             break;
 970                 case 0x09a: map_key_clear(KEY_PVR);             break;
 971
 972                 case 0x09c: map_key_clear(KEY_CHANNELUP);       break;
 973                 case 0x09d: map_key_clear(KEY_CHANNELDOWN);     break;
 974                 case 0x0a0: map_key_clear(KEY_VCR2);            break;
 975
 976                 case 0x0b0: map_key_clear(KEY_PLAY);            break;
 977                 case 0x0b1: map_key_clear(KEY_PAUSE);           break;
 978                 case 0x0b2: map_key_clear(KEY_RECORD);          break;
 979                 case 0x0b3: map_key_clear(KEY_FASTFORWARD);     break;
 980                 case 0x0b4: map_key_clear(KEY_REWIND);          break;
 981                 case 0x0b5: map_key_clear(KEY_NEXTSONG);        break;
 982                 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG);    break;
 983                 case 0x0b7: map_key_clear(KEY_STOPCD);          break;
 984                 case 0x0b8: map_key_clear(KEY_EJECTCD);         break;
 985                 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT);    break;
 986                 case 0x0b9: map_key_clear(KEY_SHUFFLE);         break;
 987                 case 0x0bf: map_key_clear(KEY_SLOW);            break;
 988
 989                 case 0x0cd: map_key_clear(KEY_PLAYPAUSE);       break;
 990                 case 0x0cf: map_key_clear(KEY_VOICECOMMAND);    break;
 991
 992                 case 0x0d9: map_key_clear(KEY_EMOJI_PICKER);    break;
 993
 994                 case 0x0e0: map_abs_clear(ABS_VOLUME);          break;
 995                 case 0x0e2: map_key_clear(KEY_MUTE);            break;
 996                 case 0x0e5: map_key_clear(KEY_BASSBOOST);       break;
 997                 case 0x0e9: map_key_clear(KEY_VOLUMEUP);        break;
 998                 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN);      break;
 999                 case 0x0f5: map_key_clear(KEY_SLOW);            break;
1000
1001                 case 0x181: map_key_clear(KEY_BUTTONCONFIG);    break;
1002                 case 0x182: map_key_clear(KEY_BOOKMARKS);       break;
1003                 case 0x183: map_key_clear(KEY_CONFIG);          break;
1004                 case 0x184: map_key_clear(KEY_WORDPROCESSOR);   break;
1005                 case 0x185: map_key_clear(KEY_EDITOR);          break;
1006                 case 0x186: map_key_clear(KEY_SPREADSHEET);     break;
1007                 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR);  break;
1008                 case 0x188: map_key_clear(KEY_PRESENTATION);    break;
1009                 case 0x189: map_key_clear(KEY_DATABASE);        break;
1010                 case 0x18a: map_key_clear(KEY_MAIL);            break;
1011                 case 0x18b: map_key_clear(KEY_NEWS);            break;
1012                 case 0x18c: map_key_clear(KEY_VOICEMAIL);       break;
1013                 case 0x18d: map_key_clear(KEY_ADDRESSBOOK);     break;
1014                 case 0x18e: map_key_clear(KEY_CALENDAR);        break;
1015                 case 0x18f: map_key_clear(KEY_TASKMANAGER);     break;
1016                 case 0x190: map_key_clear(KEY_JOURNAL);         break;
1017                 case 0x191: map_key_clear(KEY_FINANCE);         break;
1018                 case 0x192: map_key_clear(KEY_CALC);            break;
1019                 case 0x193: map_key_clear(KEY_PLAYER);          break;
1020                 case 0x194: map_key_clear(KEY_FILE);            break;
1021                 case 0x196: map_key_clear(KEY_WWW);             break;
1022                 case 0x199: map_key_clear(KEY_CHAT);            break;
1023                 case 0x19c: map_key_clear(KEY_LOGOFF);          break;
1024                 case 0x19e: map_key_clear(KEY_COFFEE);          break;
1025                 case 0x19f: map_key_clear(KEY_CONTROLPANEL);            break;
1026                 case 0x1a2: map_key_clear(KEY_APPSELECT);               break;
1027                 case 0x1a3: map_key_clear(KEY_NEXT);            break;
1028                 case 0x1a4: map_key_clear(KEY_PREVIOUS);        break;
1029                 case 0x1a6: map_key_clear(KEY_HELP);            break;
1030                 case 0x1a7: map_key_clear(KEY_DOCUMENTS);       break;
1031                 case 0x1ab: map_key_clear(KEY_SPELLCHECK);      break;
1032                 case 0x1ae: map_key_clear(KEY_KEYBOARD);        break;
1033                 case 0x1b1: map_key_clear(KEY_SCREENSAVER);             break;
1034                 case 0x1b4: map_key_clear(KEY_FILE);            break;
1035                 case 0x1b6: map_key_clear(KEY_IMAGES);          break;
1036                 case 0x1b7: map_key_clear(KEY_AUDIO);           break;
1037                 case 0x1b8: map_key_clear(KEY_VIDEO);           break;
1038                 case 0x1bc: map_key_clear(KEY_MESSENGER);       break;
1039                 case 0x1bd: map_key_clear(KEY_INFO);            break;
1040                 case 0x1cb: map_key_clear(KEY_ASSISTANT);       break;
1041                 case 0x201: map_key_clear(KEY_NEW);             break;
1042                 case 0x202: map_key_clear(KEY_OPEN);            break;
1043                 case 0x203: map_key_clear(KEY_CLOSE);           break;
1044                 case 0x204: map_key_clear(KEY_EXIT);            break;
1045                 case 0x207: map_key_clear(KEY_SAVE);            break;
1046                 case 0x208: map_key_clear(KEY_PRINT);           break;
1047                 case 0x209: map_key_clear(KEY_PROPS);           break;
1048                 case 0x21a: map_key_clear(KEY_UNDO);            break;
1049                 case 0x21b: map_key_clear(KEY_COPY);            break;
1050                 case 0x21c: map_key_clear(KEY_CUT);             break;
1051                 case 0x21d: map_key_clear(KEY_PASTE);           break;
1052                 case 0x21f: map_key_clear(KEY_FIND);            break;
1053                 case 0x221: map_key_clear(KEY_SEARCH);          break;
1054                 case 0x222: map_key_clear(KEY_GOTO);            break;
1055                 case 0x223: map_key_clear(KEY_HOMEPAGE);        break;
1056                 case 0x224: map_key_clear(KEY_BACK);            break;
1057                 case 0x225: map_key_clear(KEY_FORWARD);         break;
1058                 case 0x226: map_key_clear(KEY_STOP);            break;
1059                 case 0x227: map_key_clear(KEY_REFRESH);         break;
1060                 case 0x22a: map_key_clear(KEY_BOOKMARKS);       break;
1061                 case 0x22d: map_key_clear(KEY_ZOOMIN);          break;
1062                 case 0x22e: map_key_clear(KEY_ZOOMOUT);         break;
1063                 case 0x22f: map_key_clear(KEY_ZOOMRESET);       break;
1064                 case 0x232: map_key_clear(KEY_FULL_SCREEN);     break;
1065                 case 0x233: map_key_clear(KEY_SCROLLUP);        break;
1066                 case 0x234: map_key_clear(KEY_SCROLLDOWN);      break;
1067                 case 0x238: /* AC Pan */
1068                         set_bit(REL_HWHEEL, input->relbit);
1069                         map_rel(REL_HWHEEL_HI_RES);
1070                         break;
1071                 case 0x23d: map_key_clear(KEY_EDIT);            break;
1072                 case 0x25f: map_key_clear(KEY_CANCEL);          break;
1073                 case 0x269: map_key_clear(KEY_INSERT);          break;
1074                 case 0x26a: map_key_clear(KEY_DELETE);          break;
1075                 case 0x279: map_key_clear(KEY_REDO);            break;
1076
1077                 case 0x289: map_key_clear(KEY_REPLY);           break;
1078                 case 0x28b: map_key_clear(KEY_FORWARDMAIL);     break;
1079                 case 0x28c: map_key_clear(KEY_SEND);            break;
1080
1081                 case 0x29d: map_key_clear(KEY_KBD_LAYOUT_NEXT); break;
1082
1083                 case 0x2c7: map_key_clear(KEY_KBDINPUTASSIST_PREV);             break;
1084                 case 0x2c8: map_key_clear(KEY_KBDINPUTASSIST_NEXT);             break;
1085                 case 0x2c9: map_key_clear(KEY_KBDINPUTASSIST_PREVGROUP);                break;
1086                 case 0x2ca: map_key_clear(KEY_KBDINPUTASSIST_NEXTGROUP);                break;
1087                 case 0x2cb: map_key_clear(KEY_KBDINPUTASSIST_ACCEPT);   break;
1088                 case 0x2cc: map_key_clear(KEY_KBDINPUTASSIST_CANCEL);   break;
1089
1090                 case 0x29f: map_key_clear(KEY_SCALE);           break;
1091
1092                 default: map_key_clear(KEY_UNKNOWN);
1093                 }
1094                 break;
1095
1096         case HID_UP_GENDEVCTRLS:
1097                 switch (usage->hid) {
1098                 case HID_DC_BATTERYSTRENGTH:
1099                         hidinput_setup_battery(device, HID_INPUT_REPORT, field, false);
1100                         usage->type = EV_PWR;
1101                         return;
1102                 }
1103                 goto unknown;
1104
1105         case HID_UP_BATTERY:
1106                 switch (usage->hid) {
1107                 case HID_BAT_ABSOLUTESTATEOFCHARGE:
1108                         hidinput_setup_battery(device, HID_INPUT_REPORT, field, true);
1109                         usage->type = EV_PWR;
1110                         return;
1111                 }
1112                 goto unknown;
1113
1114         case HID_UP_HPVENDOR:   /* Reported on a Dutch layout HP5308 */
1115                 set_bit(EV_REP, input->evbit);
1116                 switch (usage->hid & HID_USAGE) {
1117                 case 0x021: map_key_clear(KEY_PRINT);           break;
1118                 case 0x070: map_key_clear(KEY_HP);              break;
1119                 case 0x071: map_key_clear(KEY_CAMERA);          break;
1120                 case 0x072: map_key_clear(KEY_SOUND);           break;
1121                 case 0x073: map_key_clear(KEY_QUESTION);        break;
1122                 case 0x080: map_key_clear(KEY_EMAIL);           break;
1123                 case 0x081: map_key_clear(KEY_CHAT);            break;
1124                 case 0x082: map_key_clear(KEY_SEARCH);          break;
1125                 case 0x083: map_key_clear(KEY_CONNECT);         break;
1126                 case 0x084: map_key_clear(KEY_FINANCE);         break;
1127                 case 0x085: map_key_clear(KEY_SPORT);           break;
1128                 case 0x086: map_key_clear(KEY_SHOP);            break;
1129                 default:    goto ignore;
1130                 }
1131                 break;
1132
1133         case HID_UP_HPVENDOR2:
1134                 set_bit(EV_REP, input->evbit);
1135                 switch (usage->hid & HID_USAGE) {
1136                 case 0x001: map_key_clear(KEY_MICMUTE);         break;
1137                 case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN);  break;
1138                 case 0x004: map_key_clear(KEY_BRIGHTNESSUP);    break;
1139                 default:    goto ignore;
1140                 }
1141                 break;
1142
1143         case HID_UP_MSVENDOR:
1144                 goto ignore;
1145
1146         case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
1147                 set_bit(EV_REP, input->evbit);
1148                 goto ignore;
1149
1150         case HID_UP_LOGIVENDOR:
1151                 /* intentional fallback */
1152         case HID_UP_LOGIVENDOR2:
1153                 /* intentional fallback */
1154         case HID_UP_LOGIVENDOR3:
1155                 goto ignore;
1156
1157         case HID_UP_PID:
1158                 switch (usage->hid & HID_USAGE) {
1159                 case 0xa4: map_key_clear(BTN_DEAD);     break;
1160                 default: goto ignore;
1161                 }
1162                 break;
1163
1164         default:
1165         unknown:
1166                 if (field->report_size == 1) {
1167                         if (field->report->type == HID_OUTPUT_REPORT) {
1168                                 map_led(LED_MISC);
1169                                 break;
1170                         }
1171                         map_key(BTN_MISC);
1172                         break;
1173                 }
1174                 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
1175                         map_rel(REL_MISC);
1176                         break;
1177                 }
1178                 map_abs(ABS_MISC);
1179                 break;
1180         }
1181
1182 mapped:
1183         /* Mapping failed, bail out */
1184         if (!bit)
1185                 return;
1186
1187         if (device->driver->input_mapped &&
1188             device->driver->input_mapped(device, hidinput, field, usage,
1189                                          &bit, &max) < 0) {
1190                 /*
1191                  * The driver indicated that no further generic handling
1192                  * of the usage is desired.
1193                  */
1194                 return;
1195         }
1196
1197         set_bit(usage->type, input->evbit);
1198
1199         /*
1200          * This part is *really* controversial:
1201          * - HID aims at being generic so we should do our best to export
1202          *   all incoming events
1203          * - HID describes what events are, so there is no reason for ABS_X
1204          *   to be mapped to ABS_Y
1205          * - HID is using *_MISC+N as a default value, but nothing prevents
1206          *   *_MISC+N to overwrite a legitimate even, which confuses userspace
1207          *   (for instance ABS_MISC + 7 is ABS_MT_SLOT, which has a different
1208          *   processing)
1209          *
1210          * If devices still want to use this (at their own risk), they will
1211          * have to use the quirk HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE, but
1212          * the default should be a reliable mapping.
1213          */
1214         while (usage->code <= max && test_and_set_bit(usage->code, bit)) {
1215                 if (device->quirks & HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE) {
1216                         usage->code = find_next_zero_bit(bit,
1217                                                          max + 1,
1218                                                          usage->code);
1219                 } else {
1220                         device->status |= HID_STAT_DUP_DETECTED;
1221                         goto ignore;
1222                 }
1223         }
1224
1225         if (usage->code > max)
1226                 goto ignore;
1227
1228         if (usage->type == EV_ABS) {
1229
1230                 int a = field->logical_minimum;
1231                 int b = field->logical_maximum;
1232
1233                 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
1234                         a = field->logical_minimum = 0;
1235                         b = field->logical_maximum = 255;
1236                 }
1237
1238                 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
1239                         input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
1240                 else    input_set_abs_params(input, usage->code, a, b, 0, 0);
1241
1242                 input_abs_set_res(input, usage->code,
1243                                   hidinput_calc_abs_res(field, usage->code));
1244
1245                 /* use a larger default input buffer for MT devices */
1246                 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
1247                         input_set_events_per_packet(input, 60);
1248         }
1249
1250         if (usage->type == EV_ABS &&
1251             (usage->hat_min < usage->hat_max || usage->hat_dir)) {
1252                 int i;
1253                 for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
1254                         input_set_abs_params(input, i, -1, 1, 0, 0);
1255                         set_bit(i, input->absbit);
1256                 }
1257                 if (usage->hat_dir && !field->dpad)
1258                         field->dpad = usage->code;
1259         }
1260
1261         /* for those devices which produce Consumer volume usage as relative,
1262          * we emulate pressing volumeup/volumedown appropriate number of times
1263          * in hidinput_hid_event()
1264          */
1265         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1266                         (usage->code == ABS_VOLUME)) {
1267                 set_bit(KEY_VOLUMEUP, input->keybit);
1268                 set_bit(KEY_VOLUMEDOWN, input->keybit);
1269         }
1270
1271         if (usage->type == EV_KEY) {
1272                 set_bit(EV_MSC, input->evbit);
1273                 set_bit(MSC_SCAN, input->mscbit);
1274         }
1275
1276         return;
1277
1278 ignore:
1279         usage->type = 0;
1280         usage->code = 0;
1281 }
1282
1283 static void hidinput_handle_scroll(struct hid_usage *usage,
1284                                    struct input_dev *input,
1285                                    __s32 value)
1286 {
1287         int code;
1288         int hi_res, lo_res;
1289
1290         if (value == 0)
1291                 return;
1292
1293         if (usage->code == REL_WHEEL_HI_RES)
1294                 code = REL_WHEEL;
1295         else
1296                 code = REL_HWHEEL;
1297
1298         /*
1299          * Windows reports one wheel click as value 120. Where a high-res
1300          * scroll wheel is present, a fraction of 120 is reported instead.
1301          * Our REL_WHEEL_HI_RES axis does the same because all HW must
1302          * adhere to the 120 expectation.
1303          */
1304         hi_res = value * 120/usage->resolution_multiplier;
1305
1306         usage->wheel_accumulated += hi_res;
1307         lo_res = usage->wheel_accumulated/120;
1308         if (lo_res)
1309                 usage->wheel_accumulated -= lo_res * 120;
1310
1311         input_event(input, EV_REL, code, lo_res);
1312         input_event(input, EV_REL, usage->code, hi_res);
1313 }
1314
1315 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
1316 {
1317         struct input_dev *input;
1318         unsigned *quirks = &hid->quirks;
1319
1320         if (!usage->type)
1321                 return;
1322
1323         if (usage->type == EV_PWR) {
1324                 hidinput_update_battery(hid, value);
1325                 return;
1326         }
1327
1328         if (!field->hidinput)
1329                 return;
1330
1331         input = field->hidinput->input;
1332
1333         if (usage->hat_min < usage->hat_max || usage->hat_dir) {
1334                 int hat_dir = usage->hat_dir;
1335                 if (!hat_dir)
1336                         hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
1337                 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
1338                 input_event(input, usage->type, usage->code    , hid_hat_to_axis[hat_dir].x);
1339                 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
1340                 return;
1341         }
1342
1343         if (usage->hid == HID_DG_INVERT) {
1344                 *quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
1345                 return;
1346         }
1347
1348         if (usage->hid == HID_DG_INRANGE) {
1349                 if (value) {
1350                         input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
1351                         return;
1352                 }
1353                 input_event(input, usage->type, usage->code, 0);
1354                 input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
1355                 return;
1356         }
1357
1358         if (usage->hid == HID_DG_TIPPRESSURE && (*quirks & HID_QUIRK_NOTOUCH)) {
1359                 int a = field->logical_minimum;
1360                 int b = field->logical_maximum;
1361                 input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
1362         }
1363
1364         if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
1365                 dbg_hid("Maximum Effects - %d\n",value);
1366                 return;
1367         }
1368
1369         if (usage->hid == (HID_UP_PID | 0x7fUL)) {
1370                 dbg_hid("PID Pool Report\n");
1371                 return;
1372         }
1373
1374         if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1375                 return;
1376
1377         if ((usage->type == EV_REL) && (usage->code == REL_WHEEL_HI_RES ||
1378                                         usage->code == REL_HWHEEL_HI_RES)) {
1379                 hidinput_handle_scroll(usage, input, value);
1380                 return;
1381         }
1382
1383         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1384                         (usage->code == ABS_VOLUME)) {
1385                 int count = abs(value);
1386                 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
1387                 int i;
1388
1389                 for (i = 0; i < count; i++) {
1390                         input_event(input, EV_KEY, direction, 1);
1391                         input_sync(input);
1392                         input_event(input, EV_KEY, direction, 0);
1393                         input_sync(input);
1394                 }
1395                 return;
1396         }
1397
1398         /*
1399          * Ignore out-of-range values as per HID specification,
1400          * section 5.10 and 6.2.25, when NULL state bit is present.
1401          * When it's not, clamp the value to match Microsoft's input
1402          * driver as mentioned in "Required HID usages for digitizers":
1403          * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp
1404          *
1405          * The logical_minimum < logical_maximum check is done so that we
1406          * don't unintentionally discard values sent by devices which
1407          * don't specify logical min and max.
1408          */
1409         if ((field->flags & HID_MAIN_ITEM_VARIABLE) &&
1410             (field->logical_minimum < field->logical_maximum)) {
1411                 if (field->flags & HID_MAIN_ITEM_NULL_STATE &&
1412                     (value < field->logical_minimum ||
1413                      value > field->logical_maximum)) {
1414                         dbg_hid("Ignoring out-of-range value %x\n", value);
1415                         return;
1416                 }
1417                 value = clamp(value,
1418                               field->logical_minimum,
1419                               field->logical_maximum);
1420         }
1421
1422         /*
1423          * Ignore reports for absolute data if the data didn't change. This is
1424          * not only an optimization but also fixes 'dead' key reports. Some
1425          * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID
1426          * 0x31 and 0x32) report multiple keys, even though a localized keyboard
1427          * can only have one of them physically available. The 'dead' keys
1428          * report constant 0. As all map to the same keycode, they'd confuse
1429          * the input layer. If we filter the 'dead' keys on the HID level, we
1430          * skip the keycode translation and only forward real events.
1431          */
1432         if (!(field->flags & (HID_MAIN_ITEM_RELATIVE |
1433                               HID_MAIN_ITEM_BUFFERED_BYTE)) &&
1434                               (field->flags & HID_MAIN_ITEM_VARIABLE) &&
1435             usage->usage_index < field->maxusage &&
1436             value == field->value[usage->usage_index])
1437                 return;
1438
1439         /* report the usage code as scancode if the key status has changed */
1440         if (usage->type == EV_KEY &&
1441             (!test_bit(usage->code, input->key)) == value)
1442                 input_event(input, EV_MSC, MSC_SCAN, usage->hid);
1443
1444         input_event(input, usage->type, usage->code, value);
1445
1446         if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1447             usage->type == EV_KEY && value) {
1448                 input_sync(input);
1449                 input_event(input, usage->type, usage->code, 0);
1450         }
1451 }
1452
1453 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
1454 {
1455         struct hid_input *hidinput;
1456
1457         if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
1458                 return;
1459
1460         list_for_each_entry(hidinput, &hid->inputs, list)
1461                 input_sync(hidinput->input);
1462 }
1463 EXPORT_SYMBOL_GPL(hidinput_report_event);
1464
1465 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
1466 {
1467         struct hid_report *report;
1468         int i, j;
1469
1470         list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
1471                 for (i = 0; i < report->maxfield; i++) {
1472                         *field = report->field[i];
1473                         for (j = 0; j < (*field)->maxusage; j++)
1474                                 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1475                                         return j;
1476                 }
1477         }
1478         return -1;
1479 }
1480 EXPORT_SYMBOL_GPL(hidinput_find_field);
1481
1482 struct hid_field *hidinput_get_led_field(struct hid_device *hid)
1483 {
1484         struct hid_report *report;
1485         struct hid_field *field;
1486         int i, j;
1487
1488         list_for_each_entry(report,
1489                             &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1490                             list) {
1491                 for (i = 0; i < report->maxfield; i++) {
1492                         field = report->field[i];
1493                         for (j = 0; j < field->maxusage; j++)
1494                                 if (field->usage[j].type == EV_LED)
1495                                         return field;
1496                 }
1497         }
1498         return NULL;
1499 }
1500 EXPORT_SYMBOL_GPL(hidinput_get_led_field);
1501
1502 unsigned int hidinput_count_leds(struct hid_device *hid)
1503 {
1504         struct hid_report *report;
1505         struct hid_field *field;
1506         int i, j;
1507         unsigned int count = 0;
1508
1509         list_for_each_entry(report,
1510                             &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1511                             list) {
1512                 for (i = 0; i < report->maxfield; i++) {
1513                         field = report->field[i];
1514                         for (j = 0; j < field->maxusage; j++)
1515                                 if (field->usage[j].type == EV_LED &&
1516                                     field->value[j])
1517                                         count += 1;
1518                 }
1519         }
1520         return count;
1521 }
1522 EXPORT_SYMBOL_GPL(hidinput_count_leds);
1523
1524 static void hidinput_led_worker(struct work_struct *work)
1525 {
1526         struct hid_device *hid = container_of(work, struct hid_device,
1527                                               led_work);
1528         struct hid_field *field;
1529         struct hid_report *report;
1530         int ret;
1531         u32 len;
1532         __u8 *buf;
1533
1534         field = hidinput_get_led_field(hid);
1535         if (!field)
1536                 return;
1537
1538         /*
1539          * field->report is accessed unlocked regarding HID core. So there might
1540          * be another incoming SET-LED request from user-space, which changes
1541          * the LED state while we assemble our outgoing buffer. However, this
1542          * doesn't matter as hid_output_report() correctly converts it into a
1543          * boolean value no matter what information is currently set on the LED
1544          * field (even garbage). So the remote device will always get a valid
1545          * request.
1546          * And in case we send a wrong value, a next led worker is spawned
1547          * for every SET-LED request so the following worker will send the
1548          * correct value, guaranteed!
1549          */
1550
1551         report = field->report;
1552
1553         /* use custom SET_REPORT request if possible (asynchronous) */
1554         if (hid->ll_driver->request)
1555                 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT);
1556
1557         /* fall back to generic raw-output-report */
1558         len = hid_report_len(report);
1559         buf = hid_alloc_report_buf(report, GFP_KERNEL);
1560         if (!buf)
1561                 return;
1562
1563         hid_output_report(report, buf);
1564         /* synchronous output report */
1565         ret = hid_hw_output_report(hid, buf, len);
1566         if (ret == -ENOSYS)
1567                 hid_hw_raw_request(hid, report->id, buf, len, HID_OUTPUT_REPORT,
1568                                 HID_REQ_SET_REPORT);
1569         kfree(buf);
1570 }
1571
1572 static int hidinput_input_event(struct input_dev *dev, unsigned int type,
1573                                 unsigned int code, int value)
1574 {
1575         struct hid_device *hid = input_get_drvdata(dev);
1576         struct hid_field *field;
1577         int offset;
1578
1579         if (type == EV_FF)
1580                 return input_ff_event(dev, type, code, value);
1581
1582         if (type != EV_LED)
1583                 return -1;
1584
1585         if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
1586                 hid_warn(dev, "event field not found\n");
1587                 return -1;
1588         }
1589
1590         hid_set_field(field, offset, value);
1591
1592         schedule_work(&hid->led_work);
1593         return 0;
1594 }
1595
1596 static int hidinput_open(struct input_dev *dev)
1597 {
1598         struct hid_device *hid = input_get_drvdata(dev);
1599
1600         return hid_hw_open(hid);
1601 }
1602
1603 static void hidinput_close(struct input_dev *dev)
1604 {
1605         struct hid_device *hid = input_get_drvdata(dev);
1606
1607         hid_hw_close(hid);
1608 }
1609
1610 static bool __hidinput_change_resolution_multipliers(struct hid_device *hid,
1611                 struct hid_report *report, bool use_logical_max)
1612 {
1613         struct hid_usage *usage;
1614         bool update_needed = false;
1615         bool get_report_completed = false;
1616         int i, j;
1617
1618         if (report->maxfield == 0)
1619                 return false;
1620
1621         for (i = 0; i < report->maxfield; i++) {
1622                 __s32 value = use_logical_max ?
1623                               report->field[i]->logical_maximum :
1624                               report->field[i]->logical_minimum;
1625
1626                 /* There is no good reason for a Resolution
1627                  * Multiplier to have a count other than 1.
1628                  * Ignore that case.
1629                  */
1630                 if (report->field[i]->report_count != 1)
1631                         continue;
1632
1633                 for (j = 0; j < report->field[i]->maxusage; j++) {
1634                         usage = &report->field[i]->usage[j];
1635
1636                         if (usage->hid != HID_GD_RESOLUTION_MULTIPLIER)
1637                                 continue;
1638
1639                         /*
1640                          * If we have more than one feature within this
1641                          * report we need to fill in the bits from the
1642                          * others before we can overwrite the ones for the
1643                          * Resolution Multiplier.
1644                          *
1645                          * But if we're not allowed to read from the device,
1646                          * we just bail. Such a device should not exist
1647                          * anyway.
1648                          */
1649                         if (!get_report_completed && report->maxfield > 1) {
1650                                 if (hid->quirks & HID_QUIRK_NO_INIT_REPORTS)
1651                                         return update_needed;
1652
1653                                 hid_hw_request(hid, report, HID_REQ_GET_REPORT);
1654                                 hid_hw_wait(hid);
1655                                 get_report_completed = true;
1656                         }
1657
1658                         report->field[i]->value[j] = value;
1659                         update_needed = true;
1660                 }
1661         }
1662
1663         return update_needed;
1664 }
1665
1666 static void hidinput_change_resolution_multipliers(struct hid_device *hid)
1667 {
1668         struct hid_report_enum *rep_enum;
1669         struct hid_report *rep;
1670         int ret;
1671
1672         rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1673         list_for_each_entry(rep, &rep_enum->report_list, list) {
1674                 bool update_needed = __hidinput_change_resolution_multipliers(hid,
1675                                                                      rep, true);
1676
1677                 if (update_needed) {
1678                         ret = __hid_request(hid, rep, HID_REQ_SET_REPORT);
1679                         if (ret) {
1680                                 __hidinput_change_resolution_multipliers(hid,
1681                                                                     rep, false);
1682                                 return;
1683                         }
1684                 }
1685         }
1686
1687         /* refresh our structs */
1688         hid_setup_resolution_multiplier(hid);
1689 }
1690
1691 static void report_features(struct hid_device *hid)
1692 {
1693         struct hid_driver *drv = hid->driver;
1694         struct hid_report_enum *rep_enum;
1695         struct hid_report *rep;
1696         struct hid_usage *usage;
1697         int i, j;
1698
1699         rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1700         list_for_each_entry(rep, &rep_enum->report_list, list)
1701                 for (i = 0; i < rep->maxfield; i++) {
1702                         /* Ignore if report count is out of bounds. */
1703                         if (rep->field[i]->report_count < 1)
1704                                 continue;
1705
1706                         for (j = 0; j < rep->field[i]->maxusage; j++) {
1707                                 usage = &rep->field[i]->usage[j];
1708
1709                                 /* Verify if Battery Strength feature is available */
1710                                 if (usage->hid == HID_DC_BATTERYSTRENGTH)
1711                                         hidinput_setup_battery(hid, HID_FEATURE_REPORT,
1712                                                                rep->field[i], false);
1713
1714                                 if (drv->feature_mapping)
1715                                         drv->feature_mapping(hid, rep->field[i], usage);
1716                         }
1717                 }
1718 }
1719
1720 static struct hid_input *hidinput_allocate(struct hid_device *hid,
1721                                            unsigned int application)
1722 {
1723         struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
1724         struct input_dev *input_dev = input_allocate_device();
1725         const char *suffix = NULL;
1726         size_t suffix_len, name_len;
1727
1728         if (!hidinput || !input_dev)
1729                 goto fail;
1730
1731         if ((hid->quirks & HID_QUIRK_INPUT_PER_APP) &&
1732             hid->maxapplication > 1) {
1733                 switch (application) {
1734                 case HID_GD_KEYBOARD:
1735                         suffix = "Keyboard";
1736                         break;
1737                 case HID_GD_KEYPAD:
1738                         suffix = "Keypad";
1739                         break;
1740                 case HID_GD_MOUSE:
1741                         suffix = "Mouse";
1742                         break;
1743                 case HID_DG_STYLUS:
1744                         suffix = "Pen";
1745                         break;
1746                 case HID_DG_TOUCHSCREEN:
1747                         suffix = "Touchscreen";
1748                         break;
1749                 case HID_DG_TOUCHPAD:
1750                         suffix = "Touchpad";
1751                         break;
1752                 case HID_GD_SYSTEM_CONTROL:
1753                         suffix = "System Control";
1754                         break;
1755                 case HID_CP_CONSUMER_CONTROL:
1756                         suffix = "Consumer Control";
1757                         break;
1758                 case HID_GD_WIRELESS_RADIO_CTLS:
1759                         suffix = "Wireless Radio Control";
1760                         break;
1761                 case HID_GD_SYSTEM_MULTIAXIS:
1762                         suffix = "System Multi Axis";
1763                         break;
1764                 default:
1765                         break;
1766                 }
1767         }
1768
1769         if (suffix) {
1770                 name_len = strlen(hid->name);
1771                 suffix_len = strlen(suffix);
1772                 if ((name_len < suffix_len) ||
1773                     strcmp(hid->name + name_len - suffix_len, suffix)) {
1774                         hidinput->name = kasprintf(GFP_KERNEL, "%s %s",
1775                                                    hid->name, suffix);
1776                         if (!hidinput->name)
1777                                 goto fail;
1778                 }
1779         }
1780
1781         input_set_drvdata(input_dev, hid);
1782         input_dev->event = hidinput_input_event;
1783         input_dev->open = hidinput_open;
1784         input_dev->close = hidinput_close;
1785         input_dev->setkeycode = hidinput_setkeycode;
1786         input_dev->getkeycode = hidinput_getkeycode;
1787
1788         input_dev->name = hidinput->name ? hidinput->name : hid->name;
1789         input_dev->phys = hid->phys;
1790         input_dev->uniq = hid->uniq;
1791         input_dev->id.bustype = hid->bus;
1792         input_dev->id.vendor  = hid->vendor;
1793         input_dev->id.product = hid->product;
1794         input_dev->id.version = hid->version;
1795         input_dev->dev.parent = &hid->dev;
1796
1797         hidinput->input = input_dev;
1798         hidinput->application = application;
1799         list_add_tail(&hidinput->list, &hid->inputs);
1800
1801         INIT_LIST_HEAD(&hidinput->reports);
1802
1803         return hidinput;
1804
1805 fail:
1806         kfree(hidinput);
1807         input_free_device(input_dev);
1808         hid_err(hid, "Out of memory during hid input probe\n");
1809         return NULL;
1810 }
1811
1812 static bool hidinput_has_been_populated(struct hid_input *hidinput)
1813 {
1814         int i;
1815         unsigned long r = 0;
1816
1817         for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++)
1818                 r |= hidinput->input->evbit[i];
1819
1820         for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++)
1821                 r |= hidinput->input->keybit[i];
1822
1823         for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++)
1824                 r |= hidinput->input->relbit[i];
1825
1826         for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++)
1827                 r |= hidinput->input->absbit[i];
1828
1829         for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++)
1830                 r |= hidinput->input->mscbit[i];
1831
1832         for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++)
1833                 r |= hidinput->input->ledbit[i];
1834
1835         for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++)
1836                 r |= hidinput->input->sndbit[i];
1837
1838         for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++)
1839                 r |= hidinput->input->ffbit[i];
1840
1841         for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++)
1842                 r |= hidinput->input->swbit[i];
1843
1844         return !!r;
1845 }
1846
1847 static void hidinput_cleanup_hidinput(struct hid_device *hid,
1848                 struct hid_input *hidinput)
1849 {
1850         struct hid_report *report;
1851         int i, k;
1852
1853         list_del(&hidinput->list);
1854         input_free_device(hidinput->input);
1855         kfree(hidinput->name);
1856
1857         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1858                 if (k == HID_OUTPUT_REPORT &&
1859                         hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1860                         continue;
1861
1862                 list_for_each_entry(report, &hid->report_enum[k].report_list,
1863                                     list) {
1864
1865                         for (i = 0; i < report->maxfield; i++)
1866                                 if (report->field[i]->hidinput == hidinput)
1867                                         report->field[i]->hidinput = NULL;
1868                 }
1869         }
1870
1871         kfree(hidinput);
1872 }
1873
1874 static struct hid_input *hidinput_match(struct hid_report *report)
1875 {
1876         struct hid_device *hid = report->device;
1877         struct hid_input *hidinput;
1878
1879         list_for_each_entry(hidinput, &hid->inputs, list) {
1880                 if (hidinput->report &&
1881                     hidinput->report->id == report->id)
1882                         return hidinput;
1883         }
1884
1885         return NULL;
1886 }
1887
1888 static struct hid_input *hidinput_match_application(struct hid_report *report)
1889 {
1890         struct hid_device *hid = report->device;
1891         struct hid_input *hidinput;
1892
1893         list_for_each_entry(hidinput, &hid->inputs, list) {
1894                 if (hidinput->application == report->application)
1895                         return hidinput;
1896
1897                 /*
1898                  * Keep SystemControl and ConsumerControl applications together
1899                  * with the main keyboard, if present.
1900                  */
1901                 if ((report->application == HID_GD_SYSTEM_CONTROL ||
1902                      report->application == HID_CP_CONSUMER_CONTROL) &&
1903                     hidinput->application == HID_GD_KEYBOARD) {
1904                         return hidinput;
1905                 }
1906         }
1907
1908         return NULL;
1909 }
1910
1911 static inline void hidinput_configure_usages(struct hid_input *hidinput,
1912                                              struct hid_report *report)
1913 {
1914         int i, j;
1915
1916         for (i = 0; i < report->maxfield; i++)
1917                 for (j = 0; j < report->field[i]->maxusage; j++)
1918                         hidinput_configure_usage(hidinput, report->field[i],
1919                                                  report->field[i]->usage + j);
1920 }
1921
1922 /*
1923  * Register the input device; print a message.
1924  * Configure the input layer interface
1925  * Read all reports and initialize the absolute field values.
1926  */
1927
1928 int hidinput_connect(struct hid_device *hid, unsigned int force)
1929 {
1930         struct hid_driver *drv = hid->driver;
1931         struct hid_report *report;
1932         struct hid_input *next, *hidinput = NULL;
1933         unsigned int application;
1934         int i, k;
1935
1936         INIT_LIST_HEAD(&hid->inputs);
1937         INIT_WORK(&hid->led_work, hidinput_led_worker);
1938
1939         hid->status &= ~HID_STAT_DUP_DETECTED;
1940
1941         if (!force) {
1942                 for (i = 0; i < hid->maxcollection; i++) {
1943                         struct hid_collection *col = &hid->collection[i];
1944                         if (col->type == HID_COLLECTION_APPLICATION ||
1945                                         col->type == HID_COLLECTION_PHYSICAL)
1946                                 if (IS_INPUT_APPLICATION(col->usage))
1947                                         break;
1948                 }
1949
1950                 if (i == hid->maxcollection)
1951                         return -1;
1952         }
1953
1954         report_features(hid);
1955
1956         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1957                 if (k == HID_OUTPUT_REPORT &&
1958                         hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1959                         continue;
1960
1961                 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
1962
1963                         if (!report->maxfield)
1964                                 continue;
1965
1966                         application = report->application;
1967
1968                         /*
1969                          * Find the previous hidinput report attached
1970                          * to this report id.
1971                          */
1972                         if (hid->quirks & HID_QUIRK_MULTI_INPUT)
1973                                 hidinput = hidinput_match(report);
1974                         else if (hid->maxapplication > 1 &&
1975                                  (hid->quirks & HID_QUIRK_INPUT_PER_APP))
1976                                 hidinput = hidinput_match_application(report);
1977
1978                         if (!hidinput) {
1979                                 hidinput = hidinput_allocate(hid, application);
1980                                 if (!hidinput)
1981                                         goto out_unwind;
1982                         }
1983
1984                         hidinput_configure_usages(hidinput, report);
1985
1986                         if (hid->quirks & HID_QUIRK_MULTI_INPUT)
1987                                 hidinput->report = report;
1988
1989                         list_add_tail(&report->hidinput_list,
1990                                       &hidinput->reports);
1991                 }
1992         }
1993
1994         hidinput_change_resolution_multipliers(hid);
1995
1996         list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1997                 if (drv->input_configured &&
1998                     drv->input_configured(hid, hidinput))
1999                         goto out_unwind;
2000
2001                 if (!hidinput_has_been_populated(hidinput)) {
2002                         /* no need to register an input device not populated */
2003                         hidinput_cleanup_hidinput(hid, hidinput);
2004                         continue;
2005                 }
2006
2007                 if (input_register_device(hidinput->input))
2008                         goto out_unwind;
2009                 hidinput->registered = true;
2010         }
2011
2012         if (list_empty(&hid->inputs)) {
2013                 hid_err(hid, "No inputs registered, leaving\n");
2014                 goto out_unwind;
2015         }
2016
2017         if (hid->status & HID_STAT_DUP_DETECTED)
2018                 hid_dbg(hid,
2019                         "Some usages could not be mapped, please use HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE if this is legitimate.\n");
2020
2021         return 0;
2022
2023 out_unwind:
2024         /* unwind the ones we already registered */
2025         hidinput_disconnect(hid);
2026
2027         return -1;
2028 }
2029 EXPORT_SYMBOL_GPL(hidinput_connect);
2030
2031 void hidinput_disconnect(struct hid_device *hid)
2032 {
2033         struct hid_input *hidinput, *next;
2034
2035         hidinput_cleanup_battery(hid);
2036
2037         list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
2038                 list_del(&hidinput->list);
2039                 if (hidinput->registered)
2040                         input_unregister_device(hidinput->input);
2041                 else
2042                         input_free_device(hidinput->input);
2043                 kfree(hidinput->name);
2044                 kfree(hidinput);
2045         }
2046
2047         /* led_work is spawned by input_dev callbacks, but doesn't access the
2048          * parent input_dev at all. Once all input devices are removed, we
2049          * know that led_work will never get restarted, so we can cancel it
2050          * synchronously and are safe. */
2051         cancel_work_sync(&hid->led_work);
2052 }
2053 EXPORT_SYMBOL_GPL(hidinput_disconnect);