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