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
match_scancode(struct hid_usage * usage,unsigned int cur_idx,unsigned int scancode)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
match_keycode(struct hid_usage * usage,unsigned int cur_idx,unsigned int keycode)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
match_index(struct hid_usage * usage,unsigned int cur_idx,unsigned int idx)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
hidinput_find_key(struct hid_device * hid,hid_usage_cmp_t match,unsigned int value,unsigned int * usage_idx)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
hidinput_locate_usage(struct hid_device * hid,const struct input_keymap_entry * ke,unsigned int * index)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
hidinput_getkeycode(struct input_dev * dev,struct input_keymap_entry * ke)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
hidinput_setkeycode(struct input_dev * dev,const struct input_keymap_entry * ke,unsigned int * old_keycode)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 */
hidinput_calc_abs_res(const struct hid_field * field,__u16 code)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_TILT_X:
257 case ABS_TILT_Y:
258 if (field->unit == 0x14) { /* If degrees */
259 /* Convert to radians */
260 prev = logical_extents;
261 logical_extents *= 573;
262 if (logical_extents < prev)
263 return 0;
264 unit_exponent += 1;
265 } else if (field->unit != 0x12) { /* If not radians */
266 return 0;
267 }
268 break;
269
270 default:
271 return 0;
272 }
273
274 /* Apply negative unit exponent */
275 for (; unit_exponent < 0; unit_exponent++) {
276 prev = logical_extents;
277 logical_extents *= 10;
278 if (logical_extents < prev)
279 return 0;
280 }
281 /* Apply positive unit exponent */
282 for (; unit_exponent > 0; unit_exponent--) {
283 prev = physical_extents;
284 physical_extents *= 10;
285 if (physical_extents < prev)
286 return 0;
287 }
288
289 /* Calculate resolution */
290 return DIV_ROUND_CLOSEST(logical_extents, physical_extents);
291 }
292 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res);
293
294 #ifdef CONFIG_HID_BATTERY_STRENGTH
295 static enum power_supply_property hidinput_battery_props[] = {
296 POWER_SUPPLY_PROP_PRESENT,
297 POWER_SUPPLY_PROP_ONLINE,
298 POWER_SUPPLY_PROP_CAPACITY,
299 POWER_SUPPLY_PROP_MODEL_NAME,
300 POWER_SUPPLY_PROP_STATUS,
301 POWER_SUPPLY_PROP_SCOPE,
302 };
303
304 #define HID_BATTERY_QUIRK_PERCENT (1 << 0) /* always reports percent */
305 #define HID_BATTERY_QUIRK_FEATURE (1 << 1) /* ask for feature report */
306 #define HID_BATTERY_QUIRK_IGNORE (1 << 2) /* completely ignore the battery */
307
308 static const struct hid_device_id hid_battery_quirks[] = {
309 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
310 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
311 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
312 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
313 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
314 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
315 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
316 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
317 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
318 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
319 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
320 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
321 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
322 USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
323 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
324 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM,
325 USB_DEVICE_ID_ELECOM_BM084),
326 HID_BATTERY_QUIRK_IGNORE },
327 {}
328 };
329
find_battery_quirk(struct hid_device * hdev)330 static unsigned find_battery_quirk(struct hid_device *hdev)
331 {
332 unsigned quirks = 0;
333 const struct hid_device_id *match;
334
335 match = hid_match_id(hdev, hid_battery_quirks);
336 if (match != NULL)
337 quirks = match->driver_data;
338
339 return quirks;
340 }
341
hidinput_scale_battery_capacity(struct hid_device * dev,int value)342 static int hidinput_scale_battery_capacity(struct hid_device *dev,
343 int value)
344 {
345 if (dev->battery_min < dev->battery_max &&
346 value >= dev->battery_min && value <= dev->battery_max)
347 value = ((value - dev->battery_min) * 100) /
348 (dev->battery_max - dev->battery_min);
349
350 return value;
351 }
352
hidinput_query_battery_capacity(struct hid_device * dev)353 static int hidinput_query_battery_capacity(struct hid_device *dev)
354 {
355 u8 *buf;
356 int ret;
357
358 buf = kmalloc(2, GFP_KERNEL);
359 if (!buf)
360 return -ENOMEM;
361
362 ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 2,
363 dev->battery_report_type, HID_REQ_GET_REPORT);
364 if (ret != 2) {
365 kfree(buf);
366 return -ENODATA;
367 }
368
369 ret = hidinput_scale_battery_capacity(dev, buf[1]);
370 kfree(buf);
371 return ret;
372 }
373
hidinput_get_battery_property(struct power_supply * psy,enum power_supply_property prop,union power_supply_propval * val)374 static int hidinput_get_battery_property(struct power_supply *psy,
375 enum power_supply_property prop,
376 union power_supply_propval *val)
377 {
378 struct hid_device *dev = power_supply_get_drvdata(psy);
379 int value;
380 int ret = 0;
381
382 switch (prop) {
383 case POWER_SUPPLY_PROP_PRESENT:
384 case POWER_SUPPLY_PROP_ONLINE:
385 val->intval = 1;
386 break;
387
388 case POWER_SUPPLY_PROP_CAPACITY:
389 if (dev->battery_report_type == HID_FEATURE_REPORT) {
390 value = hidinput_query_battery_capacity(dev);
391 if (value < 0)
392 return value;
393 } else {
394 value = dev->battery_capacity;
395 }
396
397 val->intval = value;
398 break;
399
400 case POWER_SUPPLY_PROP_MODEL_NAME:
401 val->strval = dev->name;
402 break;
403
404 case POWER_SUPPLY_PROP_STATUS:
405 if (!dev->battery_reported &&
406 dev->battery_report_type == HID_FEATURE_REPORT) {
407 value = hidinput_query_battery_capacity(dev);
408 if (value < 0)
409 return value;
410
411 dev->battery_capacity = value;
412 dev->battery_reported = true;
413 }
414
415 if (!dev->battery_reported)
416 val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
417 else if (dev->battery_capacity == 100)
418 val->intval = POWER_SUPPLY_STATUS_FULL;
419 else
420 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
421 break;
422
423 case POWER_SUPPLY_PROP_SCOPE:
424 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
425 break;
426
427 default:
428 ret = -EINVAL;
429 break;
430 }
431
432 return ret;
433 }
434
hidinput_setup_battery(struct hid_device * dev,unsigned report_type,struct hid_field * field)435 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type, struct hid_field *field)
436 {
437 struct power_supply_desc *psy_desc;
438 struct power_supply_config psy_cfg = { .drv_data = dev, };
439 unsigned quirks;
440 s32 min, max;
441 int error;
442
443 if (dev->battery)
444 return 0; /* already initialized? */
445
446 quirks = find_battery_quirk(dev);
447
448 hid_dbg(dev, "device %x:%x:%x %d quirks %d\n",
449 dev->bus, dev->vendor, dev->product, dev->version, quirks);
450
451 if (quirks & HID_BATTERY_QUIRK_IGNORE)
452 return 0;
453
454 psy_desc = kzalloc(sizeof(*psy_desc), GFP_KERNEL);
455 if (!psy_desc)
456 return -ENOMEM;
457
458 psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery", dev->uniq);
459 if (!psy_desc->name) {
460 error = -ENOMEM;
461 goto err_free_mem;
462 }
463
464 psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
465 psy_desc->properties = hidinput_battery_props;
466 psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props);
467 psy_desc->use_for_apm = 0;
468 psy_desc->get_property = hidinput_get_battery_property;
469
470 min = field->logical_minimum;
471 max = field->logical_maximum;
472
473 if (quirks & HID_BATTERY_QUIRK_PERCENT) {
474 min = 0;
475 max = 100;
476 }
477
478 if (quirks & HID_BATTERY_QUIRK_FEATURE)
479 report_type = HID_FEATURE_REPORT;
480
481 dev->battery_min = min;
482 dev->battery_max = max;
483 dev->battery_report_type = report_type;
484 dev->battery_report_id = field->report->id;
485
486 dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg);
487 if (IS_ERR(dev->battery)) {
488 error = PTR_ERR(dev->battery);
489 hid_warn(dev, "can't register power supply: %d\n", error);
490 goto err_free_name;
491 }
492
493 power_supply_powers(dev->battery, &dev->dev);
494 return 0;
495
496 err_free_name:
497 kfree(psy_desc->name);
498 err_free_mem:
499 kfree(psy_desc);
500 dev->battery = NULL;
501 return error;
502 }
503
hidinput_cleanup_battery(struct hid_device * dev)504 static void hidinput_cleanup_battery(struct hid_device *dev)
505 {
506 const struct power_supply_desc *psy_desc;
507
508 if (!dev->battery)
509 return;
510
511 psy_desc = dev->battery->desc;
512 power_supply_unregister(dev->battery);
513 kfree(psy_desc->name);
514 kfree(psy_desc);
515 dev->battery = NULL;
516 }
517
hidinput_update_battery(struct hid_device * dev,int value)518 static void hidinput_update_battery(struct hid_device *dev, int value)
519 {
520 if (!dev->battery)
521 return;
522
523 if (value == 0 || value < dev->battery_min || value > dev->battery_max)
524 return;
525
526 dev->battery_capacity = hidinput_scale_battery_capacity(dev, value);
527 dev->battery_reported = true;
528 power_supply_changed(dev->battery);
529 }
530 #else /* !CONFIG_HID_BATTERY_STRENGTH */
hidinput_setup_battery(struct hid_device * dev,unsigned report_type,struct hid_field * field)531 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
532 struct hid_field *field)
533 {
534 return 0;
535 }
536
hidinput_cleanup_battery(struct hid_device * dev)537 static void hidinput_cleanup_battery(struct hid_device *dev)
538 {
539 }
540
hidinput_update_battery(struct hid_device * dev,int value)541 static void hidinput_update_battery(struct hid_device *dev, int value)
542 {
543 }
544 #endif /* CONFIG_HID_BATTERY_STRENGTH */
545
hidinput_configure_usage(struct hid_input * hidinput,struct hid_field * field,struct hid_usage * usage)546 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
547 struct hid_usage *usage)
548 {
549 struct input_dev *input = hidinput->input;
550 struct hid_device *device = input_get_drvdata(input);
551 int max = 0, code;
552 unsigned long *bit = NULL;
553
554 field->hidinput = hidinput;
555
556 if (field->flags & HID_MAIN_ITEM_CONSTANT)
557 goto ignore;
558
559 /* Ignore if report count is out of bounds. */
560 if (field->report_count < 1)
561 goto ignore;
562
563 /* only LED usages are supported in output fields */
564 if (field->report_type == HID_OUTPUT_REPORT &&
565 (usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
566 goto ignore;
567 }
568
569 if (device->driver->input_mapping) {
570 int ret = device->driver->input_mapping(device, hidinput, field,
571 usage, &bit, &max);
572 if (ret > 0)
573 goto mapped;
574 if (ret < 0)
575 goto ignore;
576 }
577
578 switch (usage->hid & HID_USAGE_PAGE) {
579 case HID_UP_UNDEFINED:
580 goto ignore;
581
582 case HID_UP_KEYBOARD:
583 set_bit(EV_REP, input->evbit);
584
585 if ((usage->hid & HID_USAGE) < 256) {
586 if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
587 map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
588 } else
589 map_key(KEY_UNKNOWN);
590
591 break;
592
593 case HID_UP_BUTTON:
594 code = ((usage->hid - 1) & HID_USAGE);
595
596 switch (field->application) {
597 case HID_GD_MOUSE:
598 case HID_GD_POINTER: code += BTN_MOUSE; break;
599 case HID_GD_JOYSTICK:
600 if (code <= 0xf)
601 code += BTN_JOYSTICK;
602 else
603 code += BTN_TRIGGER_HAPPY - 0x10;
604 break;
605 case HID_GD_GAMEPAD:
606 if (code <= 0xf)
607 code += BTN_GAMEPAD;
608 else
609 code += BTN_TRIGGER_HAPPY - 0x10;
610 break;
611 default:
612 switch (field->physical) {
613 case HID_GD_MOUSE:
614 case HID_GD_POINTER: code += BTN_MOUSE; break;
615 case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break;
616 case HID_GD_GAMEPAD: code += BTN_GAMEPAD; break;
617 default: code += BTN_MISC;
618 }
619 }
620
621 map_key(code);
622 break;
623
624 case HID_UP_SIMULATION:
625 switch (usage->hid & 0xffff) {
626 case 0xba: map_abs(ABS_RUDDER); break;
627 case 0xbb: map_abs(ABS_THROTTLE); break;
628 case 0xc4: map_abs(ABS_GAS); break;
629 case 0xc5: map_abs(ABS_BRAKE); break;
630 case 0xc8: map_abs(ABS_WHEEL); break;
631 default: goto ignore;
632 }
633 break;
634
635 case HID_UP_GENDESK:
636 if ((usage->hid & 0xf0) == 0x80) { /* SystemControl */
637 switch (usage->hid & 0xf) {
638 case 0x1: map_key_clear(KEY_POWER); break;
639 case 0x2: map_key_clear(KEY_SLEEP); break;
640 case 0x3: map_key_clear(KEY_WAKEUP); break;
641 case 0x4: map_key_clear(KEY_CONTEXT_MENU); break;
642 case 0x5: map_key_clear(KEY_MENU); break;
643 case 0x6: map_key_clear(KEY_PROG1); break;
644 case 0x7: map_key_clear(KEY_HELP); break;
645 case 0x8: map_key_clear(KEY_EXIT); break;
646 case 0x9: map_key_clear(KEY_SELECT); break;
647 case 0xa: map_key_clear(KEY_RIGHT); break;
648 case 0xb: map_key_clear(KEY_LEFT); break;
649 case 0xc: map_key_clear(KEY_UP); break;
650 case 0xd: map_key_clear(KEY_DOWN); break;
651 case 0xe: map_key_clear(KEY_POWER2); break;
652 case 0xf: map_key_clear(KEY_RESTART); break;
653 default: goto unknown;
654 }
655 break;
656 }
657
658 if ((usage->hid & 0xf0) == 0x90) { /* D-pad */
659 switch (usage->hid) {
660 case HID_GD_UP: usage->hat_dir = 1; break;
661 case HID_GD_DOWN: usage->hat_dir = 5; break;
662 case HID_GD_RIGHT: usage->hat_dir = 3; break;
663 case HID_GD_LEFT: usage->hat_dir = 7; break;
664 default: goto unknown;
665 }
666 if (field->dpad) {
667 map_abs(field->dpad);
668 goto ignore;
669 }
670 map_abs(ABS_HAT0X);
671 break;
672 }
673
674 switch (usage->hid) {
675 /* These usage IDs map directly to the usage codes. */
676 case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
677 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
678 if (field->flags & HID_MAIN_ITEM_RELATIVE)
679 map_rel(usage->hid & 0xf);
680 else
681 map_abs_clear(usage->hid & 0xf);
682 break;
683
684 case HID_GD_SLIDER: case HID_GD_DIAL: case HID_GD_WHEEL:
685 if (field->flags & HID_MAIN_ITEM_RELATIVE)
686 map_rel(usage->hid & 0xf);
687 else
688 map_abs(usage->hid & 0xf);
689 break;
690
691 case HID_GD_HATSWITCH:
692 usage->hat_min = field->logical_minimum;
693 usage->hat_max = field->logical_maximum;
694 map_abs(ABS_HAT0X);
695 break;
696
697 case HID_GD_START: map_key_clear(BTN_START); break;
698 case HID_GD_SELECT: map_key_clear(BTN_SELECT); break;
699
700 default: goto unknown;
701 }
702
703 break;
704
705 case HID_UP_LED:
706 switch (usage->hid & 0xffff) { /* HID-Value: */
707 case 0x01: map_led (LED_NUML); break; /* "Num Lock" */
708 case 0x02: map_led (LED_CAPSL); break; /* "Caps Lock" */
709 case 0x03: map_led (LED_SCROLLL); break; /* "Scroll Lock" */
710 case 0x04: map_led (LED_COMPOSE); break; /* "Compose" */
711 case 0x05: map_led (LED_KANA); break; /* "Kana" */
712 case 0x27: map_led (LED_SLEEP); break; /* "Stand-By" */
713 case 0x4c: map_led (LED_SUSPEND); break; /* "System Suspend" */
714 case 0x09: map_led (LED_MUTE); break; /* "Mute" */
715 case 0x4b: map_led (LED_MISC); break; /* "Generic Indicator" */
716 case 0x19: map_led (LED_MAIL); break; /* "Message Waiting" */
717 case 0x4d: map_led (LED_CHARGING); break; /* "External Power Connected" */
718
719 default: goto ignore;
720 }
721 break;
722
723 case HID_UP_DIGITIZER:
724 switch (usage->hid & 0xff) {
725 case 0x00: /* Undefined */
726 goto ignore;
727
728 case 0x30: /* TipPressure */
729 if (!test_bit(BTN_TOUCH, input->keybit)) {
730 device->quirks |= HID_QUIRK_NOTOUCH;
731 set_bit(EV_KEY, input->evbit);
732 set_bit(BTN_TOUCH, input->keybit);
733 }
734 map_abs_clear(ABS_PRESSURE);
735 break;
736
737 case 0x32: /* InRange */
738 switch (field->physical & 0xff) {
739 case 0x21: map_key(BTN_TOOL_MOUSE); break;
740 case 0x22: map_key(BTN_TOOL_FINGER); break;
741 default: map_key(BTN_TOOL_PEN); break;
742 }
743 break;
744
745 case 0x3b: /* Battery Strength */
746 hidinput_setup_battery(device, HID_INPUT_REPORT, field);
747 usage->type = EV_PWR;
748 goto ignore;
749
750 case 0x3c: /* Invert */
751 map_key_clear(BTN_TOOL_RUBBER);
752 break;
753
754 case 0x3d: /* X Tilt */
755 map_abs_clear(ABS_TILT_X);
756 break;
757
758 case 0x3e: /* Y Tilt */
759 map_abs_clear(ABS_TILT_Y);
760 break;
761
762 case 0x33: /* Touch */
763 case 0x42: /* TipSwitch */
764 case 0x43: /* TipSwitch2 */
765 device->quirks &= ~HID_QUIRK_NOTOUCH;
766 map_key_clear(BTN_TOUCH);
767 break;
768
769 case 0x44: /* BarrelSwitch */
770 map_key_clear(BTN_STYLUS);
771 break;
772
773 case 0x46: /* TabletPick */
774 case 0x5a: /* SecondaryBarrelSwitch */
775 map_key_clear(BTN_STYLUS2);
776 break;
777
778 case 0x5b: /* TransducerSerialNumber */
779 usage->type = EV_MSC;
780 usage->code = MSC_SERIAL;
781 bit = input->mscbit;
782 max = MSC_MAX;
783 break;
784
785 default: goto unknown;
786 }
787 break;
788
789 case HID_UP_TELEPHONY:
790 switch (usage->hid & HID_USAGE) {
791 case 0x2f: map_key_clear(KEY_MICMUTE); break;
792 case 0xb0: map_key_clear(KEY_NUMERIC_0); break;
793 case 0xb1: map_key_clear(KEY_NUMERIC_1); break;
794 case 0xb2: map_key_clear(KEY_NUMERIC_2); break;
795 case 0xb3: map_key_clear(KEY_NUMERIC_3); break;
796 case 0xb4: map_key_clear(KEY_NUMERIC_4); break;
797 case 0xb5: map_key_clear(KEY_NUMERIC_5); break;
798 case 0xb6: map_key_clear(KEY_NUMERIC_6); break;
799 case 0xb7: map_key_clear(KEY_NUMERIC_7); break;
800 case 0xb8: map_key_clear(KEY_NUMERIC_8); break;
801 case 0xb9: map_key_clear(KEY_NUMERIC_9); break;
802 case 0xba: map_key_clear(KEY_NUMERIC_STAR); break;
803 case 0xbb: map_key_clear(KEY_NUMERIC_POUND); break;
804 case 0xbc: map_key_clear(KEY_NUMERIC_A); break;
805 case 0xbd: map_key_clear(KEY_NUMERIC_B); break;
806 case 0xbe: map_key_clear(KEY_NUMERIC_C); break;
807 case 0xbf: map_key_clear(KEY_NUMERIC_D); break;
808 default: goto ignore;
809 }
810 break;
811
812 case HID_UP_CONSUMER: /* USB HUT v1.12, pages 75-84 */
813 switch (usage->hid & HID_USAGE) {
814 case 0x000: goto ignore;
815 case 0x030: map_key_clear(KEY_POWER); break;
816 case 0x031: map_key_clear(KEY_RESTART); break;
817 case 0x032: map_key_clear(KEY_SLEEP); break;
818 case 0x034: map_key_clear(KEY_SLEEP); break;
819 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE); break;
820 case 0x036: map_key_clear(BTN_MISC); break;
821
822 case 0x040: map_key_clear(KEY_MENU); break; /* Menu */
823 case 0x041: map_key_clear(KEY_SELECT); break; /* Menu Pick */
824 case 0x042: map_key_clear(KEY_UP); break; /* Menu Up */
825 case 0x043: map_key_clear(KEY_DOWN); break; /* Menu Down */
826 case 0x044: map_key_clear(KEY_LEFT); break; /* Menu Left */
827 case 0x045: map_key_clear(KEY_RIGHT); break; /* Menu Right */
828 case 0x046: map_key_clear(KEY_ESC); break; /* Menu Escape */
829 case 0x047: map_key_clear(KEY_KPPLUS); break; /* Menu Value Increase */
830 case 0x048: map_key_clear(KEY_KPMINUS); break; /* Menu Value Decrease */
831
832 case 0x060: map_key_clear(KEY_INFO); break; /* Data On Screen */
833 case 0x061: map_key_clear(KEY_SUBTITLE); break; /* Closed Caption */
834 case 0x063: map_key_clear(KEY_VCR); break; /* VCR/TV */
835 case 0x065: map_key_clear(KEY_CAMERA); break; /* Snapshot */
836 case 0x069: map_key_clear(KEY_RED); break;
837 case 0x06a: map_key_clear(KEY_GREEN); break;
838 case 0x06b: map_key_clear(KEY_BLUE); break;
839 case 0x06c: map_key_clear(KEY_YELLOW); break;
840 case 0x06d: map_key_clear(KEY_ZOOM); break;
841
842 case 0x06f: map_key_clear(KEY_BRIGHTNESSUP); break;
843 case 0x070: map_key_clear(KEY_BRIGHTNESSDOWN); break;
844 case 0x072: map_key_clear(KEY_BRIGHTNESS_TOGGLE); break;
845 case 0x073: map_key_clear(KEY_BRIGHTNESS_MIN); break;
846 case 0x074: map_key_clear(KEY_BRIGHTNESS_MAX); break;
847 case 0x075: map_key_clear(KEY_BRIGHTNESS_AUTO); break;
848
849 case 0x079: map_key_clear(KEY_KBDILLUMUP); break;
850 case 0x07a: map_key_clear(KEY_KBDILLUMDOWN); break;
851 case 0x07c: map_key_clear(KEY_KBDILLUMTOGGLE); break;
852
853 case 0x082: map_key_clear(KEY_VIDEO_NEXT); break;
854 case 0x083: map_key_clear(KEY_LAST); break;
855 case 0x084: map_key_clear(KEY_ENTER); break;
856 case 0x088: map_key_clear(KEY_PC); break;
857 case 0x089: map_key_clear(KEY_TV); break;
858 case 0x08a: map_key_clear(KEY_WWW); break;
859 case 0x08b: map_key_clear(KEY_DVD); break;
860 case 0x08c: map_key_clear(KEY_PHONE); break;
861 case 0x08d: map_key_clear(KEY_PROGRAM); break;
862 case 0x08e: map_key_clear(KEY_VIDEOPHONE); break;
863 case 0x08f: map_key_clear(KEY_GAMES); break;
864 case 0x090: map_key_clear(KEY_MEMO); break;
865 case 0x091: map_key_clear(KEY_CD); break;
866 case 0x092: map_key_clear(KEY_VCR); break;
867 case 0x093: map_key_clear(KEY_TUNER); break;
868 case 0x094: map_key_clear(KEY_EXIT); break;
869 case 0x095: map_key_clear(KEY_HELP); break;
870 case 0x096: map_key_clear(KEY_TAPE); break;
871 case 0x097: map_key_clear(KEY_TV2); break;
872 case 0x098: map_key_clear(KEY_SAT); break;
873 case 0x09a: map_key_clear(KEY_PVR); break;
874
875 case 0x09c: map_key_clear(KEY_CHANNELUP); break;
876 case 0x09d: map_key_clear(KEY_CHANNELDOWN); break;
877 case 0x0a0: map_key_clear(KEY_VCR2); break;
878
879 case 0x0b0: map_key_clear(KEY_PLAY); break;
880 case 0x0b1: map_key_clear(KEY_PAUSE); break;
881 case 0x0b2: map_key_clear(KEY_RECORD); break;
882 case 0x0b3: map_key_clear(KEY_FASTFORWARD); break;
883 case 0x0b4: map_key_clear(KEY_REWIND); break;
884 case 0x0b5: map_key_clear(KEY_NEXTSONG); break;
885 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG); break;
886 case 0x0b7: map_key_clear(KEY_STOPCD); break;
887 case 0x0b8: map_key_clear(KEY_EJECTCD); break;
888 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT); break;
889 case 0x0b9: map_key_clear(KEY_SHUFFLE); break;
890 case 0x0bf: map_key_clear(KEY_SLOW); break;
891
892 case 0x0cd: map_key_clear(KEY_PLAYPAUSE); break;
893 case 0x0cf: map_key_clear(KEY_VOICECOMMAND); break;
894 case 0x0e0: map_abs_clear(ABS_VOLUME); break;
895 case 0x0e2: map_key_clear(KEY_MUTE); break;
896 case 0x0e5: map_key_clear(KEY_BASSBOOST); break;
897 case 0x0e9: map_key_clear(KEY_VOLUMEUP); break;
898 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN); break;
899 case 0x0f5: map_key_clear(KEY_SLOW); break;
900
901 case 0x181: map_key_clear(KEY_BUTTONCONFIG); break;
902 case 0x182: map_key_clear(KEY_BOOKMARKS); break;
903 case 0x183: map_key_clear(KEY_CONFIG); break;
904 case 0x184: map_key_clear(KEY_WORDPROCESSOR); break;
905 case 0x185: map_key_clear(KEY_EDITOR); break;
906 case 0x186: map_key_clear(KEY_SPREADSHEET); break;
907 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR); break;
908 case 0x188: map_key_clear(KEY_PRESENTATION); break;
909 case 0x189: map_key_clear(KEY_DATABASE); break;
910 case 0x18a: map_key_clear(KEY_MAIL); break;
911 case 0x18b: map_key_clear(KEY_NEWS); break;
912 case 0x18c: map_key_clear(KEY_VOICEMAIL); break;
913 case 0x18d: map_key_clear(KEY_ADDRESSBOOK); break;
914 case 0x18e: map_key_clear(KEY_CALENDAR); break;
915 case 0x18f: map_key_clear(KEY_TASKMANAGER); break;
916 case 0x190: map_key_clear(KEY_JOURNAL); break;
917 case 0x191: map_key_clear(KEY_FINANCE); break;
918 case 0x192: map_key_clear(KEY_CALC); break;
919 case 0x193: map_key_clear(KEY_PLAYER); break;
920 case 0x194: map_key_clear(KEY_FILE); break;
921 case 0x196: map_key_clear(KEY_WWW); break;
922 case 0x199: map_key_clear(KEY_CHAT); break;
923 case 0x19c: map_key_clear(KEY_LOGOFF); break;
924 case 0x19e: map_key_clear(KEY_COFFEE); break;
925 case 0x19f: map_key_clear(KEY_CONTROLPANEL); break;
926 case 0x1a2: map_key_clear(KEY_APPSELECT); break;
927 case 0x1a3: map_key_clear(KEY_NEXT); break;
928 case 0x1a4: map_key_clear(KEY_PREVIOUS); break;
929 case 0x1a6: map_key_clear(KEY_HELP); break;
930 case 0x1a7: map_key_clear(KEY_DOCUMENTS); break;
931 case 0x1ab: map_key_clear(KEY_SPELLCHECK); break;
932 case 0x1ae: map_key_clear(KEY_KEYBOARD); break;
933 case 0x1b1: map_key_clear(KEY_SCREENSAVER); break;
934 case 0x1b4: map_key_clear(KEY_FILE); break;
935 case 0x1b6: map_key_clear(KEY_IMAGES); break;
936 case 0x1b7: map_key_clear(KEY_AUDIO); break;
937 case 0x1b8: map_key_clear(KEY_VIDEO); break;
938 case 0x1bc: map_key_clear(KEY_MESSENGER); break;
939 case 0x1bd: map_key_clear(KEY_INFO); break;
940 case 0x201: map_key_clear(KEY_NEW); break;
941 case 0x202: map_key_clear(KEY_OPEN); break;
942 case 0x203: map_key_clear(KEY_CLOSE); break;
943 case 0x204: map_key_clear(KEY_EXIT); break;
944 case 0x207: map_key_clear(KEY_SAVE); break;
945 case 0x208: map_key_clear(KEY_PRINT); break;
946 case 0x209: map_key_clear(KEY_PROPS); break;
947 case 0x21a: map_key_clear(KEY_UNDO); break;
948 case 0x21b: map_key_clear(KEY_COPY); break;
949 case 0x21c: map_key_clear(KEY_CUT); break;
950 case 0x21d: map_key_clear(KEY_PASTE); break;
951 case 0x21f: map_key_clear(KEY_FIND); break;
952 case 0x221: map_key_clear(KEY_SEARCH); break;
953 case 0x222: map_key_clear(KEY_GOTO); break;
954 case 0x223: map_key_clear(KEY_HOMEPAGE); break;
955 case 0x224: map_key_clear(KEY_BACK); break;
956 case 0x225: map_key_clear(KEY_FORWARD); break;
957 case 0x226: map_key_clear(KEY_STOP); break;
958 case 0x227: map_key_clear(KEY_REFRESH); break;
959 case 0x22a: map_key_clear(KEY_BOOKMARKS); break;
960 case 0x22d: map_key_clear(KEY_ZOOMIN); break;
961 case 0x22e: map_key_clear(KEY_ZOOMOUT); break;
962 case 0x22f: map_key_clear(KEY_ZOOMRESET); break;
963 case 0x233: map_key_clear(KEY_SCROLLUP); break;
964 case 0x234: map_key_clear(KEY_SCROLLDOWN); break;
965 case 0x238: map_rel(REL_HWHEEL); break;
966 case 0x23d: map_key_clear(KEY_EDIT); break;
967 case 0x25f: map_key_clear(KEY_CANCEL); break;
968 case 0x269: map_key_clear(KEY_INSERT); break;
969 case 0x26a: map_key_clear(KEY_DELETE); break;
970 case 0x279: map_key_clear(KEY_REDO); break;
971
972 case 0x289: map_key_clear(KEY_REPLY); break;
973 case 0x28b: map_key_clear(KEY_FORWARDMAIL); break;
974 case 0x28c: map_key_clear(KEY_SEND); break;
975
976 case 0x2c7: map_key_clear(KEY_KBDINPUTASSIST_PREV); break;
977 case 0x2c8: map_key_clear(KEY_KBDINPUTASSIST_NEXT); break;
978 case 0x2c9: map_key_clear(KEY_KBDINPUTASSIST_PREVGROUP); break;
979 case 0x2ca: map_key_clear(KEY_KBDINPUTASSIST_NEXTGROUP); break;
980 case 0x2cb: map_key_clear(KEY_KBDINPUTASSIST_ACCEPT); break;
981 case 0x2cc: map_key_clear(KEY_KBDINPUTASSIST_CANCEL); break;
982
983 case 0x29f: map_key_clear(KEY_SCALE); break;
984
985 default: map_key_clear(KEY_UNKNOWN);
986 }
987 break;
988
989 case HID_UP_GENDEVCTRLS:
990 switch (usage->hid) {
991 case HID_DC_BATTERYSTRENGTH:
992 hidinput_setup_battery(device, HID_INPUT_REPORT, field);
993 usage->type = EV_PWR;
994 goto ignore;
995 }
996 goto unknown;
997
998 case HID_UP_HPVENDOR: /* Reported on a Dutch layout HP5308 */
999 set_bit(EV_REP, input->evbit);
1000 switch (usage->hid & HID_USAGE) {
1001 case 0x021: map_key_clear(KEY_PRINT); break;
1002 case 0x070: map_key_clear(KEY_HP); break;
1003 case 0x071: map_key_clear(KEY_CAMERA); break;
1004 case 0x072: map_key_clear(KEY_SOUND); break;
1005 case 0x073: map_key_clear(KEY_QUESTION); break;
1006 case 0x080: map_key_clear(KEY_EMAIL); break;
1007 case 0x081: map_key_clear(KEY_CHAT); break;
1008 case 0x082: map_key_clear(KEY_SEARCH); break;
1009 case 0x083: map_key_clear(KEY_CONNECT); break;
1010 case 0x084: map_key_clear(KEY_FINANCE); break;
1011 case 0x085: map_key_clear(KEY_SPORT); break;
1012 case 0x086: map_key_clear(KEY_SHOP); break;
1013 default: goto ignore;
1014 }
1015 break;
1016
1017 case HID_UP_HPVENDOR2:
1018 set_bit(EV_REP, input->evbit);
1019 switch (usage->hid & HID_USAGE) {
1020 case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN); break;
1021 case 0x004: map_key_clear(KEY_BRIGHTNESSUP); break;
1022 default: goto ignore;
1023 }
1024 break;
1025
1026 case HID_UP_MSVENDOR:
1027 goto ignore;
1028
1029 case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
1030 set_bit(EV_REP, input->evbit);
1031 goto ignore;
1032
1033 case HID_UP_LOGIVENDOR:
1034 goto ignore;
1035
1036 case HID_UP_PID:
1037 switch (usage->hid & HID_USAGE) {
1038 case 0xa4: map_key_clear(BTN_DEAD); break;
1039 default: goto ignore;
1040 }
1041 break;
1042
1043 default:
1044 unknown:
1045 if (field->report_size == 1) {
1046 if (field->report->type == HID_OUTPUT_REPORT) {
1047 map_led(LED_MISC);
1048 break;
1049 }
1050 map_key(BTN_MISC);
1051 break;
1052 }
1053 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
1054 map_rel(REL_MISC);
1055 break;
1056 }
1057 map_abs(ABS_MISC);
1058 break;
1059 }
1060
1061 mapped:
1062 /* Mapping failed, bail out */
1063 if (!bit)
1064 return;
1065
1066 if (device->driver->input_mapped &&
1067 device->driver->input_mapped(device, hidinput, field, usage,
1068 &bit, &max) < 0) {
1069 /*
1070 * The driver indicated that no further generic handling
1071 * of the usage is desired.
1072 */
1073 return;
1074 }
1075
1076 set_bit(usage->type, input->evbit);
1077
1078 while (usage->code <= max && test_and_set_bit(usage->code, bit))
1079 usage->code = find_next_zero_bit(bit, max + 1, usage->code);
1080
1081 if (usage->code > max)
1082 goto ignore;
1083
1084 if (usage->type == EV_ABS) {
1085
1086 int a = field->logical_minimum;
1087 int b = field->logical_maximum;
1088
1089 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
1090 a = field->logical_minimum = 0;
1091 b = field->logical_maximum = 255;
1092 }
1093
1094 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
1095 input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
1096 else input_set_abs_params(input, usage->code, a, b, 0, 0);
1097
1098 input_abs_set_res(input, usage->code,
1099 hidinput_calc_abs_res(field, usage->code));
1100
1101 /* use a larger default input buffer for MT devices */
1102 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
1103 input_set_events_per_packet(input, 60);
1104 }
1105
1106 if (usage->type == EV_ABS &&
1107 (usage->hat_min < usage->hat_max || usage->hat_dir)) {
1108 int i;
1109 for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
1110 input_set_abs_params(input, i, -1, 1, 0, 0);
1111 set_bit(i, input->absbit);
1112 }
1113 if (usage->hat_dir && !field->dpad)
1114 field->dpad = usage->code;
1115 }
1116
1117 /* for those devices which produce Consumer volume usage as relative,
1118 * we emulate pressing volumeup/volumedown appropriate number of times
1119 * in hidinput_hid_event()
1120 */
1121 if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1122 (usage->code == ABS_VOLUME)) {
1123 set_bit(KEY_VOLUMEUP, input->keybit);
1124 set_bit(KEY_VOLUMEDOWN, input->keybit);
1125 }
1126
1127 if (usage->type == EV_KEY) {
1128 set_bit(EV_MSC, input->evbit);
1129 set_bit(MSC_SCAN, input->mscbit);
1130 }
1131
1132 return;
1133
1134 ignore:
1135 usage->type = 0;
1136 usage->code = 0;
1137 }
1138
hidinput_hid_event(struct hid_device * hid,struct hid_field * field,struct hid_usage * usage,__s32 value)1139 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
1140 {
1141 struct input_dev *input;
1142 unsigned *quirks = &hid->quirks;
1143
1144 if (!usage->type)
1145 return;
1146
1147 if (usage->type == EV_PWR) {
1148 hidinput_update_battery(hid, value);
1149 return;
1150 }
1151
1152 if (!field->hidinput)
1153 return;
1154
1155 input = field->hidinput->input;
1156
1157 if (usage->hat_min < usage->hat_max || usage->hat_dir) {
1158 int hat_dir = usage->hat_dir;
1159 if (!hat_dir)
1160 hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
1161 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
1162 input_event(input, usage->type, usage->code , hid_hat_to_axis[hat_dir].x);
1163 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
1164 return;
1165 }
1166
1167 if (usage->hid == (HID_UP_DIGITIZER | 0x003c)) { /* Invert */
1168 *quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
1169 return;
1170 }
1171
1172 if (usage->hid == (HID_UP_DIGITIZER | 0x0032)) { /* InRange */
1173 if (value) {
1174 input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
1175 return;
1176 }
1177 input_event(input, usage->type, usage->code, 0);
1178 input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
1179 return;
1180 }
1181
1182 if (usage->hid == (HID_UP_DIGITIZER | 0x0030) && (*quirks & HID_QUIRK_NOTOUCH)) { /* Pressure */
1183 int a = field->logical_minimum;
1184 int b = field->logical_maximum;
1185 input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
1186 }
1187
1188 if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
1189 dbg_hid("Maximum Effects - %d\n",value);
1190 return;
1191 }
1192
1193 if (usage->hid == (HID_UP_PID | 0x7fUL)) {
1194 dbg_hid("PID Pool Report\n");
1195 return;
1196 }
1197
1198 if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1199 return;
1200
1201 if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1202 (usage->code == ABS_VOLUME)) {
1203 int count = abs(value);
1204 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
1205 int i;
1206
1207 for (i = 0; i < count; i++) {
1208 input_event(input, EV_KEY, direction, 1);
1209 input_sync(input);
1210 input_event(input, EV_KEY, direction, 0);
1211 input_sync(input);
1212 }
1213 return;
1214 }
1215
1216 /*
1217 * Ignore out-of-range values as per HID specification,
1218 * section 5.10 and 6.2.25, when NULL state bit is present.
1219 * When it's not, clamp the value to match Microsoft's input
1220 * driver as mentioned in "Required HID usages for digitizers":
1221 * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp
1222 *
1223 * The logical_minimum < logical_maximum check is done so that we
1224 * don't unintentionally discard values sent by devices which
1225 * don't specify logical min and max.
1226 */
1227 if ((field->flags & HID_MAIN_ITEM_VARIABLE) &&
1228 (field->logical_minimum < field->logical_maximum)) {
1229 if (field->flags & HID_MAIN_ITEM_NULL_STATE &&
1230 (value < field->logical_minimum ||
1231 value > field->logical_maximum)) {
1232 dbg_hid("Ignoring out-of-range value %x\n", value);
1233 return;
1234 }
1235 value = clamp(value,
1236 field->logical_minimum,
1237 field->logical_maximum);
1238 }
1239
1240 /*
1241 * Ignore reports for absolute data if the data didn't change. This is
1242 * not only an optimization but also fixes 'dead' key reports. Some
1243 * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID
1244 * 0x31 and 0x32) report multiple keys, even though a localized keyboard
1245 * can only have one of them physically available. The 'dead' keys
1246 * report constant 0. As all map to the same keycode, they'd confuse
1247 * the input layer. If we filter the 'dead' keys on the HID level, we
1248 * skip the keycode translation and only forward real events.
1249 */
1250 if (!(field->flags & (HID_MAIN_ITEM_RELATIVE |
1251 HID_MAIN_ITEM_BUFFERED_BYTE)) &&
1252 (field->flags & HID_MAIN_ITEM_VARIABLE) &&
1253 usage->usage_index < field->maxusage &&
1254 value == field->value[usage->usage_index])
1255 return;
1256
1257 /* report the usage code as scancode if the key status has changed */
1258 if (usage->type == EV_KEY &&
1259 (!test_bit(usage->code, input->key)) == value)
1260 input_event(input, EV_MSC, MSC_SCAN, usage->hid);
1261
1262 input_event(input, usage->type, usage->code, value);
1263
1264 if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1265 usage->type == EV_KEY && value) {
1266 input_sync(input);
1267 input_event(input, usage->type, usage->code, 0);
1268 }
1269 }
1270
hidinput_report_event(struct hid_device * hid,struct hid_report * report)1271 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
1272 {
1273 struct hid_input *hidinput;
1274
1275 if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
1276 return;
1277
1278 list_for_each_entry(hidinput, &hid->inputs, list)
1279 input_sync(hidinput->input);
1280 }
1281 EXPORT_SYMBOL_GPL(hidinput_report_event);
1282
hidinput_find_field(struct hid_device * hid,unsigned int type,unsigned int code,struct hid_field ** field)1283 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
1284 {
1285 struct hid_report *report;
1286 int i, j;
1287
1288 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
1289 for (i = 0; i < report->maxfield; i++) {
1290 *field = report->field[i];
1291 for (j = 0; j < (*field)->maxusage; j++)
1292 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1293 return j;
1294 }
1295 }
1296 return -1;
1297 }
1298 EXPORT_SYMBOL_GPL(hidinput_find_field);
1299
hidinput_get_led_field(struct hid_device * hid)1300 struct hid_field *hidinput_get_led_field(struct hid_device *hid)
1301 {
1302 struct hid_report *report;
1303 struct hid_field *field;
1304 int i, j;
1305
1306 list_for_each_entry(report,
1307 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1308 list) {
1309 for (i = 0; i < report->maxfield; i++) {
1310 field = report->field[i];
1311 for (j = 0; j < field->maxusage; j++)
1312 if (field->usage[j].type == EV_LED)
1313 return field;
1314 }
1315 }
1316 return NULL;
1317 }
1318 EXPORT_SYMBOL_GPL(hidinput_get_led_field);
1319
hidinput_count_leds(struct hid_device * hid)1320 unsigned int hidinput_count_leds(struct hid_device *hid)
1321 {
1322 struct hid_report *report;
1323 struct hid_field *field;
1324 int i, j;
1325 unsigned int count = 0;
1326
1327 list_for_each_entry(report,
1328 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1329 list) {
1330 for (i = 0; i < report->maxfield; i++) {
1331 field = report->field[i];
1332 for (j = 0; j < field->maxusage; j++)
1333 if (field->usage[j].type == EV_LED &&
1334 field->value[j])
1335 count += 1;
1336 }
1337 }
1338 return count;
1339 }
1340 EXPORT_SYMBOL_GPL(hidinput_count_leds);
1341
hidinput_led_worker(struct work_struct * work)1342 static void hidinput_led_worker(struct work_struct *work)
1343 {
1344 struct hid_device *hid = container_of(work, struct hid_device,
1345 led_work);
1346 struct hid_field *field;
1347 struct hid_report *report;
1348 int ret;
1349 u32 len;
1350 __u8 *buf;
1351
1352 field = hidinput_get_led_field(hid);
1353 if (!field)
1354 return;
1355
1356 /*
1357 * field->report is accessed unlocked regarding HID core. So there might
1358 * be another incoming SET-LED request from user-space, which changes
1359 * the LED state while we assemble our outgoing buffer. However, this
1360 * doesn't matter as hid_output_report() correctly converts it into a
1361 * boolean value no matter what information is currently set on the LED
1362 * field (even garbage). So the remote device will always get a valid
1363 * request.
1364 * And in case we send a wrong value, a next led worker is spawned
1365 * for every SET-LED request so the following worker will send the
1366 * correct value, guaranteed!
1367 */
1368
1369 report = field->report;
1370
1371 /* use custom SET_REPORT request if possible (asynchronous) */
1372 if (hid->ll_driver->request)
1373 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT);
1374
1375 /* fall back to generic raw-output-report */
1376 len = hid_report_len(report);
1377 buf = hid_alloc_report_buf(report, GFP_KERNEL);
1378 if (!buf)
1379 return;
1380
1381 hid_output_report(report, buf);
1382 /* synchronous output report */
1383 ret = hid_hw_output_report(hid, buf, len);
1384 if (ret == -ENOSYS)
1385 hid_hw_raw_request(hid, report->id, buf, len, HID_OUTPUT_REPORT,
1386 HID_REQ_SET_REPORT);
1387 kfree(buf);
1388 }
1389
hidinput_input_event(struct input_dev * dev,unsigned int type,unsigned int code,int value)1390 static int hidinput_input_event(struct input_dev *dev, unsigned int type,
1391 unsigned int code, int value)
1392 {
1393 struct hid_device *hid = input_get_drvdata(dev);
1394 struct hid_field *field;
1395 int offset;
1396
1397 if (type == EV_FF)
1398 return input_ff_event(dev, type, code, value);
1399
1400 if (type != EV_LED)
1401 return -1;
1402
1403 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
1404 hid_warn(dev, "event field not found\n");
1405 return -1;
1406 }
1407
1408 hid_set_field(field, offset, value);
1409
1410 schedule_work(&hid->led_work);
1411 return 0;
1412 }
1413
hidinput_open(struct input_dev * dev)1414 static int hidinput_open(struct input_dev *dev)
1415 {
1416 struct hid_device *hid = input_get_drvdata(dev);
1417
1418 return hid_hw_open(hid);
1419 }
1420
hidinput_close(struct input_dev * dev)1421 static void hidinput_close(struct input_dev *dev)
1422 {
1423 struct hid_device *hid = input_get_drvdata(dev);
1424
1425 hid_hw_close(hid);
1426 }
1427
report_features(struct hid_device * hid)1428 static void report_features(struct hid_device *hid)
1429 {
1430 struct hid_driver *drv = hid->driver;
1431 struct hid_report_enum *rep_enum;
1432 struct hid_report *rep;
1433 struct hid_usage *usage;
1434 int i, j;
1435
1436 rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1437 list_for_each_entry(rep, &rep_enum->report_list, list)
1438 for (i = 0; i < rep->maxfield; i++) {
1439 /* Ignore if report count is out of bounds. */
1440 if (rep->field[i]->report_count < 1)
1441 continue;
1442
1443 for (j = 0; j < rep->field[i]->maxusage; j++) {
1444 usage = &rep->field[i]->usage[j];
1445
1446 /* Verify if Battery Strength feature is available */
1447 if (usage->hid == HID_DC_BATTERYSTRENGTH)
1448 hidinput_setup_battery(hid, HID_FEATURE_REPORT,
1449 rep->field[i]);
1450
1451 if (drv->feature_mapping)
1452 drv->feature_mapping(hid, rep->field[i], usage);
1453 }
1454 }
1455 }
1456
hidinput_allocate(struct hid_device * hid)1457 static struct hid_input *hidinput_allocate(struct hid_device *hid)
1458 {
1459 struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
1460 struct input_dev *input_dev = input_allocate_device();
1461 if (!hidinput || !input_dev) {
1462 kfree(hidinput);
1463 input_free_device(input_dev);
1464 hid_err(hid, "Out of memory during hid input probe\n");
1465 return NULL;
1466 }
1467
1468 input_set_drvdata(input_dev, hid);
1469 input_dev->event = hidinput_input_event;
1470 input_dev->open = hidinput_open;
1471 input_dev->close = hidinput_close;
1472 input_dev->setkeycode = hidinput_setkeycode;
1473 input_dev->getkeycode = hidinput_getkeycode;
1474
1475 input_dev->name = hid->name;
1476 input_dev->phys = hid->phys;
1477 input_dev->uniq = hid->uniq;
1478 input_dev->id.bustype = hid->bus;
1479 input_dev->id.vendor = hid->vendor;
1480 input_dev->id.product = hid->product;
1481 input_dev->id.version = hid->version;
1482 input_dev->dev.parent = &hid->dev;
1483 hidinput->input = input_dev;
1484 list_add_tail(&hidinput->list, &hid->inputs);
1485
1486 return hidinput;
1487 }
1488
hidinput_has_been_populated(struct hid_input * hidinput)1489 static bool hidinput_has_been_populated(struct hid_input *hidinput)
1490 {
1491 int i;
1492 unsigned long r = 0;
1493
1494 for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++)
1495 r |= hidinput->input->evbit[i];
1496
1497 for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++)
1498 r |= hidinput->input->keybit[i];
1499
1500 for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++)
1501 r |= hidinput->input->relbit[i];
1502
1503 for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++)
1504 r |= hidinput->input->absbit[i];
1505
1506 for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++)
1507 r |= hidinput->input->mscbit[i];
1508
1509 for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++)
1510 r |= hidinput->input->ledbit[i];
1511
1512 for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++)
1513 r |= hidinput->input->sndbit[i];
1514
1515 for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++)
1516 r |= hidinput->input->ffbit[i];
1517
1518 for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++)
1519 r |= hidinput->input->swbit[i];
1520
1521 return !!r;
1522 }
1523
hidinput_cleanup_hidinput(struct hid_device * hid,struct hid_input * hidinput)1524 static void hidinput_cleanup_hidinput(struct hid_device *hid,
1525 struct hid_input *hidinput)
1526 {
1527 struct hid_report *report;
1528 int i, k;
1529
1530 list_del(&hidinput->list);
1531 input_free_device(hidinput->input);
1532
1533 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1534 if (k == HID_OUTPUT_REPORT &&
1535 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1536 continue;
1537
1538 list_for_each_entry(report, &hid->report_enum[k].report_list,
1539 list) {
1540
1541 for (i = 0; i < report->maxfield; i++)
1542 if (report->field[i]->hidinput == hidinput)
1543 report->field[i]->hidinput = NULL;
1544 }
1545 }
1546
1547 kfree(hidinput);
1548 }
1549
1550 /*
1551 * Register the input device; print a message.
1552 * Configure the input layer interface
1553 * Read all reports and initialize the absolute field values.
1554 */
1555
hidinput_connect(struct hid_device * hid,unsigned int force)1556 int hidinput_connect(struct hid_device *hid, unsigned int force)
1557 {
1558 struct hid_driver *drv = hid->driver;
1559 struct hid_report *report;
1560 struct hid_input *hidinput = NULL;
1561 int i, j, k;
1562
1563 INIT_LIST_HEAD(&hid->inputs);
1564 INIT_WORK(&hid->led_work, hidinput_led_worker);
1565
1566 if (!force) {
1567 for (i = 0; i < hid->maxcollection; i++) {
1568 struct hid_collection *col = &hid->collection[i];
1569 if (col->type == HID_COLLECTION_APPLICATION ||
1570 col->type == HID_COLLECTION_PHYSICAL)
1571 if (IS_INPUT_APPLICATION(col->usage))
1572 break;
1573 }
1574
1575 if (i == hid->maxcollection)
1576 return -1;
1577 }
1578
1579 report_features(hid);
1580
1581 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1582 if (k == HID_OUTPUT_REPORT &&
1583 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1584 continue;
1585
1586 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
1587
1588 if (!report->maxfield)
1589 continue;
1590
1591 if (!hidinput) {
1592 hidinput = hidinput_allocate(hid);
1593 if (!hidinput)
1594 goto out_unwind;
1595 }
1596
1597 for (i = 0; i < report->maxfield; i++)
1598 for (j = 0; j < report->field[i]->maxusage; j++)
1599 hidinput_configure_usage(hidinput, report->field[i],
1600 report->field[i]->usage + j);
1601
1602 if ((hid->quirks & HID_QUIRK_NO_EMPTY_INPUT) &&
1603 !hidinput_has_been_populated(hidinput))
1604 continue;
1605
1606 if (hid->quirks & HID_QUIRK_MULTI_INPUT) {
1607 /* This will leave hidinput NULL, so that it
1608 * allocates another one if we have more inputs on
1609 * the same interface. Some devices (e.g. Happ's
1610 * UGCI) cram a lot of unrelated inputs into the
1611 * same interface. */
1612 hidinput->report = report;
1613 if (drv->input_configured &&
1614 drv->input_configured(hid, hidinput))
1615 goto out_cleanup;
1616 if (input_register_device(hidinput->input))
1617 goto out_cleanup;
1618 hidinput = NULL;
1619 }
1620 }
1621 }
1622
1623 if (hidinput && (hid->quirks & HID_QUIRK_NO_EMPTY_INPUT) &&
1624 !hidinput_has_been_populated(hidinput)) {
1625 /* no need to register an input device not populated */
1626 hidinput_cleanup_hidinput(hid, hidinput);
1627 hidinput = NULL;
1628 }
1629
1630 if (list_empty(&hid->inputs)) {
1631 hid_err(hid, "No inputs registered, leaving\n");
1632 goto out_unwind;
1633 }
1634
1635 if (hidinput) {
1636 if (drv->input_configured &&
1637 drv->input_configured(hid, hidinput))
1638 goto out_cleanup;
1639 if (input_register_device(hidinput->input))
1640 goto out_cleanup;
1641 }
1642
1643 return 0;
1644
1645 out_cleanup:
1646 list_del(&hidinput->list);
1647 input_free_device(hidinput->input);
1648 kfree(hidinput);
1649 out_unwind:
1650 /* unwind the ones we already registered */
1651 hidinput_disconnect(hid);
1652
1653 return -1;
1654 }
1655 EXPORT_SYMBOL_GPL(hidinput_connect);
1656
hidinput_disconnect(struct hid_device * hid)1657 void hidinput_disconnect(struct hid_device *hid)
1658 {
1659 struct hid_input *hidinput, *next;
1660
1661 hidinput_cleanup_battery(hid);
1662
1663 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1664 list_del(&hidinput->list);
1665 input_unregister_device(hidinput->input);
1666 kfree(hidinput);
1667 }
1668
1669 /* led_work is spawned by input_dev callbacks, but doesn't access the
1670 * parent input_dev at all. Once all input devices are removed, we
1671 * know that led_work will never get restarted, so we can cancel it
1672 * synchronously and are safe. */
1673 cancel_work_sync(&hid->led_work);
1674 }
1675 EXPORT_SYMBOL_GPL(hidinput_disconnect);
1676
1677