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