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