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