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