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