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