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