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