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