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