Linux 4.18.10
[linux/fpc-iii.git] / drivers / hid / hid-input.c
blobb23c4b5854d8ba974ee6fa6331e51aebd4b14adb
1 /*
2 * Copyright (c) 2000-2001 Vojtech Pavlik
3 * Copyright (c) 2006-2010 Jiri Kosina
5 * HID to Linux Input mapping
6 */
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.
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.
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
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
28 #include <linux/module.h>
29 #include <linux/slab.h>
30 #include <linux/kernel.h>
32 #include <linux/hid.h>
33 #include <linux/hid-debug.h>
35 #include "hid-ids.h"
37 #define unk KEY_UNKNOWN
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
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}};
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))
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))
73 static bool match_scancode(struct hid_usage *usage,
74 unsigned int cur_idx, unsigned int scancode)
76 return (usage->hid & (HID_USAGE_PAGE | HID_USAGE)) == scancode;
79 static bool match_keycode(struct hid_usage *usage,
80 unsigned int cur_idx, unsigned int keycode)
83 * We should exclude unmapped usages when doing lookup by keycode.
85 return (usage->type == EV_KEY && usage->code == keycode);
88 static bool match_index(struct hid_usage *usage,
89 unsigned int cur_idx, unsigned int idx)
91 return cur_idx == idx;
94 typedef bool (*hid_usage_cmp_t)(struct hid_usage *usage,
95 unsigned int cur_idx, unsigned int val);
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)
102 unsigned int i, j, k, cur_idx = 0;
103 struct hid_report *report;
104 struct hid_usage *usage;
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;
117 cur_idx++;
123 return NULL;
126 static struct hid_usage *hidinput_locate_usage(struct hid_device *hid,
127 const struct input_keymap_entry *ke,
128 unsigned int *index)
130 struct hid_usage *usage;
131 unsigned int scancode;
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;
140 return usage;
143 static int hidinput_getkeycode(struct input_dev *dev,
144 struct input_keymap_entry *ke)
146 struct hid_device *hid = input_get_drvdata(dev);
147 struct hid_usage *usage;
148 unsigned int scancode, index;
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;
161 return -EINVAL;
164 static int hidinput_setkeycode(struct input_dev *dev,
165 const struct input_keymap_entry *ke,
166 unsigned int *old_keycode)
168 struct hid_device *hid = input_get_drvdata(dev);
169 struct hid_usage *usage;
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;
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);
183 * Set the keybit for the old keycode if the old keycode is used
184 * by another key
186 if (hidinput_find_key(hid, match_keycode, *old_keycode, NULL))
187 set_bit(*old_keycode, dev->keybit);
189 return 0;
192 return -EINVAL;
197 * hidinput_calc_abs_res - calculate an absolute axis resolution
198 * @field: the HID report field to calculate resolution for
199 * @code: axis code
201 * The formula is:
202 * (logical_maximum - logical_minimum)
203 * resolution = ----------------------------------------------------------
204 * (physical_maximum - physical_minimum) * 10 ^ unit_exponent
206 * as seen in the HID specification v1.11 6.2.2.7 Global Items.
208 * Only exponent 1 length units are processed. Centimeters and inches are
209 * converted to millimeters. Degrees are converted to radians.
211 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code)
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;
220 /* Check if the extents are sane */
221 if (logical_extents <= 0 || physical_extents <= 0)
222 return 0;
225 * Verify and convert units.
226 * See HID specification v1.11 6.2.2.7 Global Items for unit decoding
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;
251 break;
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;
269 break;
271 default:
272 return 0;
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;
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;
290 /* Calculate resolution */
291 return DIV_ROUND_CLOSEST(logical_extents, physical_extents);
293 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res);
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,
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 */
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 },
331 static unsigned find_battery_quirk(struct hid_device *hdev)
333 unsigned quirks = 0;
334 const struct hid_device_id *match;
336 match = hid_match_id(hdev, hid_battery_quirks);
337 if (match != NULL)
338 quirks = match->driver_data;
340 return quirks;
343 static int hidinput_scale_battery_capacity(struct hid_device *dev,
344 int value)
346 if (dev->battery_min < dev->battery_max &&
347 value >= dev->battery_min && value <= dev->battery_max)
348 value = ((value - dev->battery_min) * 100) /
349 (dev->battery_max - dev->battery_min);
351 return value;
354 static int hidinput_query_battery_capacity(struct hid_device *dev)
356 u8 *buf;
357 int ret;
359 buf = kmalloc(2, GFP_KERNEL);
360 if (!buf)
361 return -ENOMEM;
363 ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 2,
364 dev->battery_report_type, HID_REQ_GET_REPORT);
365 if (ret != 2) {
366 kfree(buf);
367 return -ENODATA;
370 ret = hidinput_scale_battery_capacity(dev, buf[1]);
371 kfree(buf);
372 return ret;
375 static int hidinput_get_battery_property(struct power_supply *psy,
376 enum power_supply_property prop,
377 union power_supply_propval *val)
379 struct hid_device *dev = power_supply_get_drvdata(psy);
380 int value;
381 int ret = 0;
383 switch (prop) {
384 case POWER_SUPPLY_PROP_PRESENT:
385 case POWER_SUPPLY_PROP_ONLINE:
386 val->intval = 1;
387 break;
389 case POWER_SUPPLY_PROP_CAPACITY:
390 if (dev->battery_status != HID_BATTERY_REPORTED &&
391 !dev->battery_avoid_query) {
392 value = hidinput_query_battery_capacity(dev);
393 if (value < 0)
394 return value;
395 } else {
396 value = dev->battery_capacity;
399 val->intval = value;
400 break;
402 case POWER_SUPPLY_PROP_MODEL_NAME:
403 val->strval = dev->name;
404 break;
406 case POWER_SUPPLY_PROP_STATUS:
407 if (dev->battery_status != HID_BATTERY_REPORTED &&
408 !dev->battery_avoid_query) {
409 value = hidinput_query_battery_capacity(dev);
410 if (value < 0)
411 return value;
413 dev->battery_capacity = value;
414 dev->battery_status = HID_BATTERY_QUERIED;
417 if (dev->battery_status == HID_BATTERY_UNKNOWN)
418 val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
419 else if (dev->battery_capacity == 100)
420 val->intval = POWER_SUPPLY_STATUS_FULL;
421 else
422 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
423 break;
425 case POWER_SUPPLY_PROP_SCOPE:
426 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
427 break;
429 default:
430 ret = -EINVAL;
431 break;
434 return ret;
437 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type, struct hid_field *field)
439 struct power_supply_desc *psy_desc;
440 struct power_supply_config psy_cfg = { .drv_data = dev, };
441 unsigned quirks;
442 s32 min, max;
443 int error;
445 if (dev->battery)
446 return 0; /* already initialized? */
448 quirks = find_battery_quirk(dev);
450 hid_dbg(dev, "device %x:%x:%x %d quirks %d\n",
451 dev->bus, dev->vendor, dev->product, dev->version, quirks);
453 if (quirks & HID_BATTERY_QUIRK_IGNORE)
454 return 0;
456 psy_desc = kzalloc(sizeof(*psy_desc), GFP_KERNEL);
457 if (!psy_desc)
458 return -ENOMEM;
460 psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery",
461 strlen(dev->uniq) ?
462 dev->uniq : dev_name(&dev->dev));
463 if (!psy_desc->name) {
464 error = -ENOMEM;
465 goto err_free_mem;
468 psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
469 psy_desc->properties = hidinput_battery_props;
470 psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props);
471 psy_desc->use_for_apm = 0;
472 psy_desc->get_property = hidinput_get_battery_property;
474 min = field->logical_minimum;
475 max = field->logical_maximum;
477 if (quirks & HID_BATTERY_QUIRK_PERCENT) {
478 min = 0;
479 max = 100;
482 if (quirks & HID_BATTERY_QUIRK_FEATURE)
483 report_type = HID_FEATURE_REPORT;
485 dev->battery_min = min;
486 dev->battery_max = max;
487 dev->battery_report_type = report_type;
488 dev->battery_report_id = field->report->id;
491 * Stylus is normally not connected to the device and thus we
492 * can't query the device and get meaningful battery strength.
493 * We have to wait for the device to report it on its own.
495 dev->battery_avoid_query = report_type == HID_INPUT_REPORT &&
496 field->physical == HID_DG_STYLUS;
498 dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg);
499 if (IS_ERR(dev->battery)) {
500 error = PTR_ERR(dev->battery);
501 hid_warn(dev, "can't register power supply: %d\n", error);
502 goto err_free_name;
505 power_supply_powers(dev->battery, &dev->dev);
506 return 0;
508 err_free_name:
509 kfree(psy_desc->name);
510 err_free_mem:
511 kfree(psy_desc);
512 dev->battery = NULL;
513 return error;
516 static void hidinput_cleanup_battery(struct hid_device *dev)
518 const struct power_supply_desc *psy_desc;
520 if (!dev->battery)
521 return;
523 psy_desc = dev->battery->desc;
524 power_supply_unregister(dev->battery);
525 kfree(psy_desc->name);
526 kfree(psy_desc);
527 dev->battery = NULL;
530 static void hidinput_update_battery(struct hid_device *dev, int value)
532 int capacity;
534 if (!dev->battery)
535 return;
537 if (value == 0 || value < dev->battery_min || value > dev->battery_max)
538 return;
540 capacity = hidinput_scale_battery_capacity(dev, value);
542 if (dev->battery_status != HID_BATTERY_REPORTED ||
543 capacity != dev->battery_capacity) {
544 dev->battery_capacity = capacity;
545 dev->battery_status = HID_BATTERY_REPORTED;
546 power_supply_changed(dev->battery);
549 #else /* !CONFIG_HID_BATTERY_STRENGTH */
550 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
551 struct hid_field *field)
553 return 0;
556 static void hidinput_cleanup_battery(struct hid_device *dev)
560 static void hidinput_update_battery(struct hid_device *dev, int value)
563 #endif /* CONFIG_HID_BATTERY_STRENGTH */
565 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
566 struct hid_usage *usage)
568 struct input_dev *input = hidinput->input;
569 struct hid_device *device = input_get_drvdata(input);
570 int max = 0, code;
571 unsigned long *bit = NULL;
573 field->hidinput = hidinput;
575 if (field->flags & HID_MAIN_ITEM_CONSTANT)
576 goto ignore;
578 /* Ignore if report count is out of bounds. */
579 if (field->report_count < 1)
580 goto ignore;
582 /* only LED usages are supported in output fields */
583 if (field->report_type == HID_OUTPUT_REPORT &&
584 (usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
585 goto ignore;
588 if (device->driver->input_mapping) {
589 int ret = device->driver->input_mapping(device, hidinput, field,
590 usage, &bit, &max);
591 if (ret > 0)
592 goto mapped;
593 if (ret < 0)
594 goto ignore;
597 switch (usage->hid & HID_USAGE_PAGE) {
598 case HID_UP_UNDEFINED:
599 goto ignore;
601 case HID_UP_KEYBOARD:
602 set_bit(EV_REP, input->evbit);
604 if ((usage->hid & HID_USAGE) < 256) {
605 if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
606 map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
607 } else
608 map_key(KEY_UNKNOWN);
610 break;
612 case HID_UP_BUTTON:
613 code = ((usage->hid - 1) & HID_USAGE);
615 switch (field->application) {
616 case HID_GD_MOUSE:
617 case HID_GD_POINTER: code += BTN_MOUSE; break;
618 case HID_GD_JOYSTICK:
619 if (code <= 0xf)
620 code += BTN_JOYSTICK;
621 else
622 code += BTN_TRIGGER_HAPPY - 0x10;
623 break;
624 case HID_GD_GAMEPAD:
625 if (code <= 0xf)
626 code += BTN_GAMEPAD;
627 else
628 code += BTN_TRIGGER_HAPPY - 0x10;
629 break;
630 default:
631 switch (field->physical) {
632 case HID_GD_MOUSE:
633 case HID_GD_POINTER: code += BTN_MOUSE; break;
634 case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break;
635 case HID_GD_GAMEPAD: code += BTN_GAMEPAD; break;
636 default: code += BTN_MISC;
640 map_key(code);
641 break;
643 case HID_UP_SIMULATION:
644 switch (usage->hid & 0xffff) {
645 case 0xba: map_abs(ABS_RUDDER); break;
646 case 0xbb: map_abs(ABS_THROTTLE); break;
647 case 0xc4: map_abs(ABS_GAS); break;
648 case 0xc5: map_abs(ABS_BRAKE); break;
649 case 0xc8: map_abs(ABS_WHEEL); break;
650 default: goto ignore;
652 break;
654 case HID_UP_GENDESK:
655 if ((usage->hid & 0xf0) == 0x80) { /* SystemControl */
656 switch (usage->hid & 0xf) {
657 case 0x1: map_key_clear(KEY_POWER); break;
658 case 0x2: map_key_clear(KEY_SLEEP); break;
659 case 0x3: map_key_clear(KEY_WAKEUP); break;
660 case 0x4: map_key_clear(KEY_CONTEXT_MENU); break;
661 case 0x5: map_key_clear(KEY_MENU); break;
662 case 0x6: map_key_clear(KEY_PROG1); break;
663 case 0x7: map_key_clear(KEY_HELP); break;
664 case 0x8: map_key_clear(KEY_EXIT); break;
665 case 0x9: map_key_clear(KEY_SELECT); break;
666 case 0xa: map_key_clear(KEY_RIGHT); break;
667 case 0xb: map_key_clear(KEY_LEFT); break;
668 case 0xc: map_key_clear(KEY_UP); break;
669 case 0xd: map_key_clear(KEY_DOWN); break;
670 case 0xe: map_key_clear(KEY_POWER2); break;
671 case 0xf: map_key_clear(KEY_RESTART); break;
672 default: goto unknown;
674 break;
678 * Some lazy vendors declare 255 usages for System Control,
679 * leading to the creation of ABS_X|Y axis and too many others.
680 * It wouldn't be a problem if joydev doesn't consider the
681 * device as a joystick then.
683 if (field->application == HID_GD_SYSTEM_CONTROL)
684 goto ignore;
686 if ((usage->hid & 0xf0) == 0x90) { /* D-pad */
687 switch (usage->hid) {
688 case HID_GD_UP: usage->hat_dir = 1; break;
689 case HID_GD_DOWN: usage->hat_dir = 5; break;
690 case HID_GD_RIGHT: usage->hat_dir = 3; break;
691 case HID_GD_LEFT: usage->hat_dir = 7; break;
692 default: goto unknown;
694 if (field->dpad) {
695 map_abs(field->dpad);
696 goto ignore;
698 map_abs(ABS_HAT0X);
699 break;
702 switch (usage->hid) {
703 /* These usage IDs map directly to the usage codes. */
704 case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
705 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
706 if (field->flags & HID_MAIN_ITEM_RELATIVE)
707 map_rel(usage->hid & 0xf);
708 else
709 map_abs_clear(usage->hid & 0xf);
710 break;
712 case HID_GD_SLIDER: case HID_GD_DIAL: case HID_GD_WHEEL:
713 if (field->flags & HID_MAIN_ITEM_RELATIVE)
714 map_rel(usage->hid & 0xf);
715 else
716 map_abs(usage->hid & 0xf);
717 break;
719 case HID_GD_HATSWITCH:
720 usage->hat_min = field->logical_minimum;
721 usage->hat_max = field->logical_maximum;
722 map_abs(ABS_HAT0X);
723 break;
725 case HID_GD_START: map_key_clear(BTN_START); break;
726 case HID_GD_SELECT: map_key_clear(BTN_SELECT); break;
728 case HID_GD_RFKILL_BTN:
729 /* MS wireless radio ctl extension, also check CA */
730 if (field->application == HID_GD_WIRELESS_RADIO_CTLS) {
731 map_key_clear(KEY_RFKILL);
732 /* We need to simulate the btn release */
733 field->flags |= HID_MAIN_ITEM_RELATIVE;
734 break;
737 default: goto unknown;
740 break;
742 case HID_UP_LED:
743 switch (usage->hid & 0xffff) { /* HID-Value: */
744 case 0x01: map_led (LED_NUML); break; /* "Num Lock" */
745 case 0x02: map_led (LED_CAPSL); break; /* "Caps Lock" */
746 case 0x03: map_led (LED_SCROLLL); break; /* "Scroll Lock" */
747 case 0x04: map_led (LED_COMPOSE); break; /* "Compose" */
748 case 0x05: map_led (LED_KANA); break; /* "Kana" */
749 case 0x27: map_led (LED_SLEEP); break; /* "Stand-By" */
750 case 0x4c: map_led (LED_SUSPEND); break; /* "System Suspend" */
751 case 0x09: map_led (LED_MUTE); break; /* "Mute" */
752 case 0x4b: map_led (LED_MISC); break; /* "Generic Indicator" */
753 case 0x19: map_led (LED_MAIL); break; /* "Message Waiting" */
754 case 0x4d: map_led (LED_CHARGING); break; /* "External Power Connected" */
756 default: goto ignore;
758 break;
760 case HID_UP_DIGITIZER:
761 switch (usage->hid & 0xff) {
762 case 0x00: /* Undefined */
763 goto ignore;
765 case 0x30: /* TipPressure */
766 if (!test_bit(BTN_TOUCH, input->keybit)) {
767 device->quirks |= HID_QUIRK_NOTOUCH;
768 set_bit(EV_KEY, input->evbit);
769 set_bit(BTN_TOUCH, input->keybit);
771 map_abs_clear(ABS_PRESSURE);
772 break;
774 case 0x32: /* InRange */
775 switch (field->physical & 0xff) {
776 case 0x21: map_key(BTN_TOOL_MOUSE); break;
777 case 0x22: map_key(BTN_TOOL_FINGER); break;
778 default: map_key(BTN_TOOL_PEN); break;
780 break;
782 case 0x3b: /* Battery Strength */
783 hidinput_setup_battery(device, HID_INPUT_REPORT, field);
784 usage->type = EV_PWR;
785 goto ignore;
787 case 0x3c: /* Invert */
788 map_key_clear(BTN_TOOL_RUBBER);
789 break;
791 case 0x3d: /* X Tilt */
792 map_abs_clear(ABS_TILT_X);
793 break;
795 case 0x3e: /* Y Tilt */
796 map_abs_clear(ABS_TILT_Y);
797 break;
799 case 0x33: /* Touch */
800 case 0x42: /* TipSwitch */
801 case 0x43: /* TipSwitch2 */
802 device->quirks &= ~HID_QUIRK_NOTOUCH;
803 map_key_clear(BTN_TOUCH);
804 break;
806 case 0x44: /* BarrelSwitch */
807 map_key_clear(BTN_STYLUS);
808 break;
810 case 0x45: /* ERASER */
812 * This event is reported when eraser tip touches the surface.
813 * Actual eraser (BTN_TOOL_RUBBER) is set by Invert usage when
814 * tool gets in proximity.
816 map_key_clear(BTN_TOUCH);
817 break;
819 case 0x46: /* TabletPick */
820 case 0x5a: /* SecondaryBarrelSwitch */
821 map_key_clear(BTN_STYLUS2);
822 break;
824 case 0x5b: /* TransducerSerialNumber */
825 usage->type = EV_MSC;
826 usage->code = MSC_SERIAL;
827 bit = input->mscbit;
828 max = MSC_MAX;
829 break;
831 default: goto unknown;
833 break;
835 case HID_UP_TELEPHONY:
836 switch (usage->hid & HID_USAGE) {
837 case 0x2f: map_key_clear(KEY_MICMUTE); break;
838 case 0xb0: map_key_clear(KEY_NUMERIC_0); break;
839 case 0xb1: map_key_clear(KEY_NUMERIC_1); break;
840 case 0xb2: map_key_clear(KEY_NUMERIC_2); break;
841 case 0xb3: map_key_clear(KEY_NUMERIC_3); break;
842 case 0xb4: map_key_clear(KEY_NUMERIC_4); break;
843 case 0xb5: map_key_clear(KEY_NUMERIC_5); break;
844 case 0xb6: map_key_clear(KEY_NUMERIC_6); break;
845 case 0xb7: map_key_clear(KEY_NUMERIC_7); break;
846 case 0xb8: map_key_clear(KEY_NUMERIC_8); break;
847 case 0xb9: map_key_clear(KEY_NUMERIC_9); break;
848 case 0xba: map_key_clear(KEY_NUMERIC_STAR); break;
849 case 0xbb: map_key_clear(KEY_NUMERIC_POUND); break;
850 case 0xbc: map_key_clear(KEY_NUMERIC_A); break;
851 case 0xbd: map_key_clear(KEY_NUMERIC_B); break;
852 case 0xbe: map_key_clear(KEY_NUMERIC_C); break;
853 case 0xbf: map_key_clear(KEY_NUMERIC_D); break;
854 default: goto ignore;
856 break;
858 case HID_UP_CONSUMER: /* USB HUT v1.12, pages 75-84 */
859 switch (usage->hid & HID_USAGE) {
860 case 0x000: goto ignore;
861 case 0x030: map_key_clear(KEY_POWER); break;
862 case 0x031: map_key_clear(KEY_RESTART); break;
863 case 0x032: map_key_clear(KEY_SLEEP); break;
864 case 0x034: map_key_clear(KEY_SLEEP); break;
865 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE); break;
866 case 0x036: map_key_clear(BTN_MISC); break;
868 case 0x040: map_key_clear(KEY_MENU); break; /* Menu */
869 case 0x041: map_key_clear(KEY_SELECT); break; /* Menu Pick */
870 case 0x042: map_key_clear(KEY_UP); break; /* Menu Up */
871 case 0x043: map_key_clear(KEY_DOWN); break; /* Menu Down */
872 case 0x044: map_key_clear(KEY_LEFT); break; /* Menu Left */
873 case 0x045: map_key_clear(KEY_RIGHT); break; /* Menu Right */
874 case 0x046: map_key_clear(KEY_ESC); break; /* Menu Escape */
875 case 0x047: map_key_clear(KEY_KPPLUS); break; /* Menu Value Increase */
876 case 0x048: map_key_clear(KEY_KPMINUS); break; /* Menu Value Decrease */
878 case 0x060: map_key_clear(KEY_INFO); break; /* Data On Screen */
879 case 0x061: map_key_clear(KEY_SUBTITLE); break; /* Closed Caption */
880 case 0x063: map_key_clear(KEY_VCR); break; /* VCR/TV */
881 case 0x065: map_key_clear(KEY_CAMERA); break; /* Snapshot */
882 case 0x069: map_key_clear(KEY_RED); break;
883 case 0x06a: map_key_clear(KEY_GREEN); break;
884 case 0x06b: map_key_clear(KEY_BLUE); break;
885 case 0x06c: map_key_clear(KEY_YELLOW); break;
886 case 0x06d: map_key_clear(KEY_ZOOM); break;
888 case 0x06f: map_key_clear(KEY_BRIGHTNESSUP); break;
889 case 0x070: map_key_clear(KEY_BRIGHTNESSDOWN); break;
890 case 0x072: map_key_clear(KEY_BRIGHTNESS_TOGGLE); break;
891 case 0x073: map_key_clear(KEY_BRIGHTNESS_MIN); break;
892 case 0x074: map_key_clear(KEY_BRIGHTNESS_MAX); break;
893 case 0x075: map_key_clear(KEY_BRIGHTNESS_AUTO); break;
895 case 0x082: map_key_clear(KEY_VIDEO_NEXT); break;
896 case 0x083: map_key_clear(KEY_LAST); break;
897 case 0x084: map_key_clear(KEY_ENTER); break;
898 case 0x088: map_key_clear(KEY_PC); break;
899 case 0x089: map_key_clear(KEY_TV); break;
900 case 0x08a: map_key_clear(KEY_WWW); break;
901 case 0x08b: map_key_clear(KEY_DVD); break;
902 case 0x08c: map_key_clear(KEY_PHONE); break;
903 case 0x08d: map_key_clear(KEY_PROGRAM); break;
904 case 0x08e: map_key_clear(KEY_VIDEOPHONE); break;
905 case 0x08f: map_key_clear(KEY_GAMES); break;
906 case 0x090: map_key_clear(KEY_MEMO); break;
907 case 0x091: map_key_clear(KEY_CD); break;
908 case 0x092: map_key_clear(KEY_VCR); break;
909 case 0x093: map_key_clear(KEY_TUNER); break;
910 case 0x094: map_key_clear(KEY_EXIT); break;
911 case 0x095: map_key_clear(KEY_HELP); break;
912 case 0x096: map_key_clear(KEY_TAPE); break;
913 case 0x097: map_key_clear(KEY_TV2); break;
914 case 0x098: map_key_clear(KEY_SAT); break;
915 case 0x09a: map_key_clear(KEY_PVR); break;
917 case 0x09c: map_key_clear(KEY_CHANNELUP); break;
918 case 0x09d: map_key_clear(KEY_CHANNELDOWN); break;
919 case 0x0a0: map_key_clear(KEY_VCR2); break;
921 case 0x0b0: map_key_clear(KEY_PLAY); break;
922 case 0x0b1: map_key_clear(KEY_PAUSE); break;
923 case 0x0b2: map_key_clear(KEY_RECORD); break;
924 case 0x0b3: map_key_clear(KEY_FASTFORWARD); break;
925 case 0x0b4: map_key_clear(KEY_REWIND); break;
926 case 0x0b5: map_key_clear(KEY_NEXTSONG); break;
927 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG); break;
928 case 0x0b7: map_key_clear(KEY_STOPCD); break;
929 case 0x0b8: map_key_clear(KEY_EJECTCD); break;
930 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT); break;
931 case 0x0b9: map_key_clear(KEY_SHUFFLE); break;
932 case 0x0bf: map_key_clear(KEY_SLOW); break;
934 case 0x0cd: map_key_clear(KEY_PLAYPAUSE); break;
935 case 0x0cf: map_key_clear(KEY_VOICECOMMAND); break;
936 case 0x0e0: map_abs_clear(ABS_VOLUME); break;
937 case 0x0e2: map_key_clear(KEY_MUTE); break;
938 case 0x0e5: map_key_clear(KEY_BASSBOOST); break;
939 case 0x0e9: map_key_clear(KEY_VOLUMEUP); break;
940 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN); break;
941 case 0x0f5: map_key_clear(KEY_SLOW); break;
943 case 0x181: map_key_clear(KEY_BUTTONCONFIG); break;
944 case 0x182: map_key_clear(KEY_BOOKMARKS); break;
945 case 0x183: map_key_clear(KEY_CONFIG); break;
946 case 0x184: map_key_clear(KEY_WORDPROCESSOR); break;
947 case 0x185: map_key_clear(KEY_EDITOR); break;
948 case 0x186: map_key_clear(KEY_SPREADSHEET); break;
949 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR); break;
950 case 0x188: map_key_clear(KEY_PRESENTATION); break;
951 case 0x189: map_key_clear(KEY_DATABASE); break;
952 case 0x18a: map_key_clear(KEY_MAIL); break;
953 case 0x18b: map_key_clear(KEY_NEWS); break;
954 case 0x18c: map_key_clear(KEY_VOICEMAIL); break;
955 case 0x18d: map_key_clear(KEY_ADDRESSBOOK); break;
956 case 0x18e: map_key_clear(KEY_CALENDAR); break;
957 case 0x18f: map_key_clear(KEY_TASKMANAGER); break;
958 case 0x190: map_key_clear(KEY_JOURNAL); break;
959 case 0x191: map_key_clear(KEY_FINANCE); break;
960 case 0x192: map_key_clear(KEY_CALC); break;
961 case 0x193: map_key_clear(KEY_PLAYER); break;
962 case 0x194: map_key_clear(KEY_FILE); break;
963 case 0x196: map_key_clear(KEY_WWW); break;
964 case 0x199: map_key_clear(KEY_CHAT); break;
965 case 0x19c: map_key_clear(KEY_LOGOFF); break;
966 case 0x19e: map_key_clear(KEY_COFFEE); break;
967 case 0x19f: map_key_clear(KEY_CONTROLPANEL); break;
968 case 0x1a2: map_key_clear(KEY_APPSELECT); break;
969 case 0x1a3: map_key_clear(KEY_NEXT); break;
970 case 0x1a4: map_key_clear(KEY_PREVIOUS); break;
971 case 0x1a6: map_key_clear(KEY_HELP); break;
972 case 0x1a7: map_key_clear(KEY_DOCUMENTS); break;
973 case 0x1ab: map_key_clear(KEY_SPELLCHECK); break;
974 case 0x1ae: map_key_clear(KEY_KEYBOARD); break;
975 case 0x1b1: map_key_clear(KEY_SCREENSAVER); break;
976 case 0x1b4: map_key_clear(KEY_FILE); break;
977 case 0x1b6: map_key_clear(KEY_IMAGES); break;
978 case 0x1b7: map_key_clear(KEY_AUDIO); break;
979 case 0x1b8: map_key_clear(KEY_VIDEO); break;
980 case 0x1bc: map_key_clear(KEY_MESSENGER); break;
981 case 0x1bd: map_key_clear(KEY_INFO); break;
982 case 0x201: map_key_clear(KEY_NEW); break;
983 case 0x202: map_key_clear(KEY_OPEN); break;
984 case 0x203: map_key_clear(KEY_CLOSE); break;
985 case 0x204: map_key_clear(KEY_EXIT); break;
986 case 0x207: map_key_clear(KEY_SAVE); break;
987 case 0x208: map_key_clear(KEY_PRINT); break;
988 case 0x209: map_key_clear(KEY_PROPS); break;
989 case 0x21a: map_key_clear(KEY_UNDO); break;
990 case 0x21b: map_key_clear(KEY_COPY); break;
991 case 0x21c: map_key_clear(KEY_CUT); break;
992 case 0x21d: map_key_clear(KEY_PASTE); break;
993 case 0x21f: map_key_clear(KEY_FIND); break;
994 case 0x221: map_key_clear(KEY_SEARCH); break;
995 case 0x222: map_key_clear(KEY_GOTO); break;
996 case 0x223: map_key_clear(KEY_HOMEPAGE); break;
997 case 0x224: map_key_clear(KEY_BACK); break;
998 case 0x225: map_key_clear(KEY_FORWARD); break;
999 case 0x226: map_key_clear(KEY_STOP); break;
1000 case 0x227: map_key_clear(KEY_REFRESH); break;
1001 case 0x22a: map_key_clear(KEY_BOOKMARKS); break;
1002 case 0x22d: map_key_clear(KEY_ZOOMIN); break;
1003 case 0x22e: map_key_clear(KEY_ZOOMOUT); break;
1004 case 0x22f: map_key_clear(KEY_ZOOMRESET); break;
1005 case 0x233: map_key_clear(KEY_SCROLLUP); break;
1006 case 0x234: map_key_clear(KEY_SCROLLDOWN); break;
1007 case 0x238: map_rel(REL_HWHEEL); break;
1008 case 0x23d: map_key_clear(KEY_EDIT); break;
1009 case 0x25f: map_key_clear(KEY_CANCEL); break;
1010 case 0x269: map_key_clear(KEY_INSERT); break;
1011 case 0x26a: map_key_clear(KEY_DELETE); break;
1012 case 0x279: map_key_clear(KEY_REDO); break;
1014 case 0x289: map_key_clear(KEY_REPLY); break;
1015 case 0x28b: map_key_clear(KEY_FORWARDMAIL); break;
1016 case 0x28c: map_key_clear(KEY_SEND); break;
1018 case 0x2c7: map_key_clear(KEY_KBDINPUTASSIST_PREV); break;
1019 case 0x2c8: map_key_clear(KEY_KBDINPUTASSIST_NEXT); break;
1020 case 0x2c9: map_key_clear(KEY_KBDINPUTASSIST_PREVGROUP); break;
1021 case 0x2ca: map_key_clear(KEY_KBDINPUTASSIST_NEXTGROUP); break;
1022 case 0x2cb: map_key_clear(KEY_KBDINPUTASSIST_ACCEPT); break;
1023 case 0x2cc: map_key_clear(KEY_KBDINPUTASSIST_CANCEL); break;
1025 default: map_key_clear(KEY_UNKNOWN);
1027 break;
1029 case HID_UP_GENDEVCTRLS:
1030 switch (usage->hid) {
1031 case HID_DC_BATTERYSTRENGTH:
1032 hidinput_setup_battery(device, HID_INPUT_REPORT, field);
1033 usage->type = EV_PWR;
1034 goto ignore;
1036 goto unknown;
1038 case HID_UP_HPVENDOR: /* Reported on a Dutch layout HP5308 */
1039 set_bit(EV_REP, input->evbit);
1040 switch (usage->hid & HID_USAGE) {
1041 case 0x021: map_key_clear(KEY_PRINT); break;
1042 case 0x070: map_key_clear(KEY_HP); break;
1043 case 0x071: map_key_clear(KEY_CAMERA); break;
1044 case 0x072: map_key_clear(KEY_SOUND); break;
1045 case 0x073: map_key_clear(KEY_QUESTION); break;
1046 case 0x080: map_key_clear(KEY_EMAIL); break;
1047 case 0x081: map_key_clear(KEY_CHAT); break;
1048 case 0x082: map_key_clear(KEY_SEARCH); break;
1049 case 0x083: map_key_clear(KEY_CONNECT); break;
1050 case 0x084: map_key_clear(KEY_FINANCE); break;
1051 case 0x085: map_key_clear(KEY_SPORT); break;
1052 case 0x086: map_key_clear(KEY_SHOP); break;
1053 default: goto ignore;
1055 break;
1057 case HID_UP_HPVENDOR2:
1058 set_bit(EV_REP, input->evbit);
1059 switch (usage->hid & HID_USAGE) {
1060 case 0x001: map_key_clear(KEY_MICMUTE); break;
1061 case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN); break;
1062 case 0x004: map_key_clear(KEY_BRIGHTNESSUP); break;
1063 default: goto ignore;
1065 break;
1067 case HID_UP_MSVENDOR:
1068 goto ignore;
1070 case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
1071 set_bit(EV_REP, input->evbit);
1072 goto ignore;
1074 case HID_UP_LOGIVENDOR:
1075 /* intentional fallback */
1076 case HID_UP_LOGIVENDOR2:
1077 /* intentional fallback */
1078 case HID_UP_LOGIVENDOR3:
1079 goto ignore;
1081 case HID_UP_PID:
1082 switch (usage->hid & HID_USAGE) {
1083 case 0xa4: map_key_clear(BTN_DEAD); break;
1084 default: goto ignore;
1086 break;
1088 default:
1089 unknown:
1090 if (field->report_size == 1) {
1091 if (field->report->type == HID_OUTPUT_REPORT) {
1092 map_led(LED_MISC);
1093 break;
1095 map_key(BTN_MISC);
1096 break;
1098 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
1099 map_rel(REL_MISC);
1100 break;
1102 map_abs(ABS_MISC);
1103 break;
1106 mapped:
1107 if (device->driver->input_mapped && device->driver->input_mapped(device,
1108 hidinput, field, usage, &bit, &max) < 0)
1109 goto ignore;
1111 set_bit(usage->type, input->evbit);
1114 * This part is *really* controversial:
1115 * - HID aims at being generic so we should do our best to export
1116 * all incoming events
1117 * - HID describes what events are, so there is no reason for ABS_X
1118 * to be mapped to ABS_Y
1119 * - HID is using *_MISC+N as a default value, but nothing prevents
1120 * *_MISC+N to overwrite a legitimate even, which confuses userspace
1121 * (for instance ABS_MISC + 7 is ABS_MT_SLOT, which has a different
1122 * processing)
1124 * If devices still want to use this (at their own risk), they will
1125 * have to use the quirk HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE, but
1126 * the default should be a reliable mapping.
1128 while (usage->code <= max && test_and_set_bit(usage->code, bit)) {
1129 if (device->quirks & HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE) {
1130 usage->code = find_next_zero_bit(bit,
1131 max + 1,
1132 usage->code);
1133 } else {
1134 device->status |= HID_STAT_DUP_DETECTED;
1135 goto ignore;
1139 if (usage->code > max)
1140 goto ignore;
1142 if (usage->type == EV_ABS) {
1144 int a = field->logical_minimum;
1145 int b = field->logical_maximum;
1147 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
1148 a = field->logical_minimum = 0;
1149 b = field->logical_maximum = 255;
1152 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
1153 input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
1154 else input_set_abs_params(input, usage->code, a, b, 0, 0);
1156 input_abs_set_res(input, usage->code,
1157 hidinput_calc_abs_res(field, usage->code));
1159 /* use a larger default input buffer for MT devices */
1160 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
1161 input_set_events_per_packet(input, 60);
1164 if (usage->type == EV_ABS &&
1165 (usage->hat_min < usage->hat_max || usage->hat_dir)) {
1166 int i;
1167 for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
1168 input_set_abs_params(input, i, -1, 1, 0, 0);
1169 set_bit(i, input->absbit);
1171 if (usage->hat_dir && !field->dpad)
1172 field->dpad = usage->code;
1175 /* for those devices which produce Consumer volume usage as relative,
1176 * we emulate pressing volumeup/volumedown appropriate number of times
1177 * in hidinput_hid_event()
1179 if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1180 (usage->code == ABS_VOLUME)) {
1181 set_bit(KEY_VOLUMEUP, input->keybit);
1182 set_bit(KEY_VOLUMEDOWN, input->keybit);
1185 if (usage->type == EV_KEY) {
1186 set_bit(EV_MSC, input->evbit);
1187 set_bit(MSC_SCAN, input->mscbit);
1190 ignore:
1191 return;
1195 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
1197 struct input_dev *input;
1198 unsigned *quirks = &hid->quirks;
1200 if (!usage->type)
1201 return;
1203 if (usage->type == EV_PWR) {
1204 hidinput_update_battery(hid, value);
1205 return;
1208 if (!field->hidinput)
1209 return;
1211 input = field->hidinput->input;
1213 if (usage->hat_min < usage->hat_max || usage->hat_dir) {
1214 int hat_dir = usage->hat_dir;
1215 if (!hat_dir)
1216 hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
1217 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
1218 input_event(input, usage->type, usage->code , hid_hat_to_axis[hat_dir].x);
1219 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
1220 return;
1223 if (usage->hid == (HID_UP_DIGITIZER | 0x003c)) { /* Invert */
1224 *quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
1225 return;
1228 if (usage->hid == (HID_UP_DIGITIZER | 0x0032)) { /* InRange */
1229 if (value) {
1230 input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
1231 return;
1233 input_event(input, usage->type, usage->code, 0);
1234 input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
1235 return;
1238 if (usage->hid == (HID_UP_DIGITIZER | 0x0030) && (*quirks & HID_QUIRK_NOTOUCH)) { /* Pressure */
1239 int a = field->logical_minimum;
1240 int b = field->logical_maximum;
1241 input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
1244 if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
1245 dbg_hid("Maximum Effects - %d\n",value);
1246 return;
1249 if (usage->hid == (HID_UP_PID | 0x7fUL)) {
1250 dbg_hid("PID Pool Report\n");
1251 return;
1254 if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1255 return;
1257 if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1258 (usage->code == ABS_VOLUME)) {
1259 int count = abs(value);
1260 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
1261 int i;
1263 for (i = 0; i < count; i++) {
1264 input_event(input, EV_KEY, direction, 1);
1265 input_sync(input);
1266 input_event(input, EV_KEY, direction, 0);
1267 input_sync(input);
1269 return;
1273 * Ignore out-of-range values as per HID specification,
1274 * section 5.10 and 6.2.25, when NULL state bit is present.
1275 * When it's not, clamp the value to match Microsoft's input
1276 * driver as mentioned in "Required HID usages for digitizers":
1277 * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp
1279 * The logical_minimum < logical_maximum check is done so that we
1280 * don't unintentionally discard values sent by devices which
1281 * don't specify logical min and max.
1283 if ((field->flags & HID_MAIN_ITEM_VARIABLE) &&
1284 (field->logical_minimum < field->logical_maximum)) {
1285 if (field->flags & HID_MAIN_ITEM_NULL_STATE &&
1286 (value < field->logical_minimum ||
1287 value > field->logical_maximum)) {
1288 dbg_hid("Ignoring out-of-range value %x\n", value);
1289 return;
1291 value = clamp(value,
1292 field->logical_minimum,
1293 field->logical_maximum);
1297 * Ignore reports for absolute data if the data didn't change. This is
1298 * not only an optimization but also fixes 'dead' key reports. Some
1299 * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID
1300 * 0x31 and 0x32) report multiple keys, even though a localized keyboard
1301 * can only have one of them physically available. The 'dead' keys
1302 * report constant 0. As all map to the same keycode, they'd confuse
1303 * the input layer. If we filter the 'dead' keys on the HID level, we
1304 * skip the keycode translation and only forward real events.
1306 if (!(field->flags & (HID_MAIN_ITEM_RELATIVE |
1307 HID_MAIN_ITEM_BUFFERED_BYTE)) &&
1308 (field->flags & HID_MAIN_ITEM_VARIABLE) &&
1309 usage->usage_index < field->maxusage &&
1310 value == field->value[usage->usage_index])
1311 return;
1313 /* report the usage code as scancode if the key status has changed */
1314 if (usage->type == EV_KEY &&
1315 (!test_bit(usage->code, input->key)) == value)
1316 input_event(input, EV_MSC, MSC_SCAN, usage->hid);
1318 input_event(input, usage->type, usage->code, value);
1320 if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1321 usage->type == EV_KEY && value) {
1322 input_sync(input);
1323 input_event(input, usage->type, usage->code, 0);
1327 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
1329 struct hid_input *hidinput;
1331 if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
1332 return;
1334 list_for_each_entry(hidinput, &hid->inputs, list)
1335 input_sync(hidinput->input);
1337 EXPORT_SYMBOL_GPL(hidinput_report_event);
1339 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
1341 struct hid_report *report;
1342 int i, j;
1344 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
1345 for (i = 0; i < report->maxfield; i++) {
1346 *field = report->field[i];
1347 for (j = 0; j < (*field)->maxusage; j++)
1348 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1349 return j;
1352 return -1;
1354 EXPORT_SYMBOL_GPL(hidinput_find_field);
1356 struct hid_field *hidinput_get_led_field(struct hid_device *hid)
1358 struct hid_report *report;
1359 struct hid_field *field;
1360 int i, j;
1362 list_for_each_entry(report,
1363 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1364 list) {
1365 for (i = 0; i < report->maxfield; i++) {
1366 field = report->field[i];
1367 for (j = 0; j < field->maxusage; j++)
1368 if (field->usage[j].type == EV_LED)
1369 return field;
1372 return NULL;
1374 EXPORT_SYMBOL_GPL(hidinput_get_led_field);
1376 unsigned int hidinput_count_leds(struct hid_device *hid)
1378 struct hid_report *report;
1379 struct hid_field *field;
1380 int i, j;
1381 unsigned int count = 0;
1383 list_for_each_entry(report,
1384 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1385 list) {
1386 for (i = 0; i < report->maxfield; i++) {
1387 field = report->field[i];
1388 for (j = 0; j < field->maxusage; j++)
1389 if (field->usage[j].type == EV_LED &&
1390 field->value[j])
1391 count += 1;
1394 return count;
1396 EXPORT_SYMBOL_GPL(hidinput_count_leds);
1398 static void hidinput_led_worker(struct work_struct *work)
1400 struct hid_device *hid = container_of(work, struct hid_device,
1401 led_work);
1402 struct hid_field *field;
1403 struct hid_report *report;
1404 int ret;
1405 u32 len;
1406 __u8 *buf;
1408 field = hidinput_get_led_field(hid);
1409 if (!field)
1410 return;
1413 * field->report is accessed unlocked regarding HID core. So there might
1414 * be another incoming SET-LED request from user-space, which changes
1415 * the LED state while we assemble our outgoing buffer. However, this
1416 * doesn't matter as hid_output_report() correctly converts it into a
1417 * boolean value no matter what information is currently set on the LED
1418 * field (even garbage). So the remote device will always get a valid
1419 * request.
1420 * And in case we send a wrong value, a next led worker is spawned
1421 * for every SET-LED request so the following worker will send the
1422 * correct value, guaranteed!
1425 report = field->report;
1427 /* use custom SET_REPORT request if possible (asynchronous) */
1428 if (hid->ll_driver->request)
1429 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT);
1431 /* fall back to generic raw-output-report */
1432 len = hid_report_len(report);
1433 buf = hid_alloc_report_buf(report, GFP_KERNEL);
1434 if (!buf)
1435 return;
1437 hid_output_report(report, buf);
1438 /* synchronous output report */
1439 ret = hid_hw_output_report(hid, buf, len);
1440 if (ret == -ENOSYS)
1441 hid_hw_raw_request(hid, report->id, buf, len, HID_OUTPUT_REPORT,
1442 HID_REQ_SET_REPORT);
1443 kfree(buf);
1446 static int hidinput_input_event(struct input_dev *dev, unsigned int type,
1447 unsigned int code, int value)
1449 struct hid_device *hid = input_get_drvdata(dev);
1450 struct hid_field *field;
1451 int offset;
1453 if (type == EV_FF)
1454 return input_ff_event(dev, type, code, value);
1456 if (type != EV_LED)
1457 return -1;
1459 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
1460 hid_warn(dev, "event field not found\n");
1461 return -1;
1464 hid_set_field(field, offset, value);
1466 schedule_work(&hid->led_work);
1467 return 0;
1470 static int hidinput_open(struct input_dev *dev)
1472 struct hid_device *hid = input_get_drvdata(dev);
1474 return hid_hw_open(hid);
1477 static void hidinput_close(struct input_dev *dev)
1479 struct hid_device *hid = input_get_drvdata(dev);
1481 hid_hw_close(hid);
1484 static void report_features(struct hid_device *hid)
1486 struct hid_driver *drv = hid->driver;
1487 struct hid_report_enum *rep_enum;
1488 struct hid_report *rep;
1489 struct hid_usage *usage;
1490 int i, j;
1492 rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1493 list_for_each_entry(rep, &rep_enum->report_list, list)
1494 for (i = 0; i < rep->maxfield; i++) {
1495 /* Ignore if report count is out of bounds. */
1496 if (rep->field[i]->report_count < 1)
1497 continue;
1499 for (j = 0; j < rep->field[i]->maxusage; j++) {
1500 usage = &rep->field[i]->usage[j];
1502 /* Verify if Battery Strength feature is available */
1503 if (usage->hid == HID_DC_BATTERYSTRENGTH)
1504 hidinput_setup_battery(hid, HID_FEATURE_REPORT,
1505 rep->field[i]);
1507 if (drv->feature_mapping)
1508 drv->feature_mapping(hid, rep->field[i], usage);
1513 static struct hid_input *hidinput_allocate(struct hid_device *hid,
1514 unsigned int application)
1516 struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
1517 struct input_dev *input_dev = input_allocate_device();
1518 const char *suffix = NULL;
1520 if (!hidinput || !input_dev)
1521 goto fail;
1523 if ((hid->quirks & HID_QUIRK_INPUT_PER_APP) &&
1524 hid->maxapplication > 1) {
1525 switch (application) {
1526 case HID_GD_KEYBOARD:
1527 suffix = "Keyboard";
1528 break;
1529 case HID_GD_KEYPAD:
1530 suffix = "Keypad";
1531 break;
1532 case HID_GD_MOUSE:
1533 suffix = "Mouse";
1534 break;
1535 case HID_DG_STYLUS:
1536 suffix = "Pen";
1537 break;
1538 case HID_DG_TOUCHSCREEN:
1539 suffix = "Touchscreen";
1540 break;
1541 case HID_DG_TOUCHPAD:
1542 suffix = "Touchpad";
1543 break;
1544 case HID_GD_SYSTEM_CONTROL:
1545 suffix = "System Control";
1546 break;
1547 case HID_CP_CONSUMER_CONTROL:
1548 suffix = "Consumer Control";
1549 break;
1550 case HID_GD_WIRELESS_RADIO_CTLS:
1551 suffix = "Wireless Radio Control";
1552 break;
1553 default:
1554 break;
1558 if (suffix) {
1559 hidinput->name = kasprintf(GFP_KERNEL, "%s %s",
1560 hid->name, suffix);
1561 if (!hidinput->name)
1562 goto fail;
1565 input_set_drvdata(input_dev, hid);
1566 input_dev->event = hidinput_input_event;
1567 input_dev->open = hidinput_open;
1568 input_dev->close = hidinput_close;
1569 input_dev->setkeycode = hidinput_setkeycode;
1570 input_dev->getkeycode = hidinput_getkeycode;
1572 input_dev->name = hidinput->name ? hidinput->name : hid->name;
1573 input_dev->phys = hid->phys;
1574 input_dev->uniq = hid->uniq;
1575 input_dev->id.bustype = hid->bus;
1576 input_dev->id.vendor = hid->vendor;
1577 input_dev->id.product = hid->product;
1578 input_dev->id.version = hid->version;
1579 input_dev->dev.parent = &hid->dev;
1581 hidinput->input = input_dev;
1582 hidinput->application = application;
1583 list_add_tail(&hidinput->list, &hid->inputs);
1585 INIT_LIST_HEAD(&hidinput->reports);
1587 return hidinput;
1589 fail:
1590 kfree(hidinput);
1591 input_free_device(input_dev);
1592 hid_err(hid, "Out of memory during hid input probe\n");
1593 return NULL;
1596 static bool hidinput_has_been_populated(struct hid_input *hidinput)
1598 int i;
1599 unsigned long r = 0;
1601 for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++)
1602 r |= hidinput->input->evbit[i];
1604 for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++)
1605 r |= hidinput->input->keybit[i];
1607 for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++)
1608 r |= hidinput->input->relbit[i];
1610 for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++)
1611 r |= hidinput->input->absbit[i];
1613 for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++)
1614 r |= hidinput->input->mscbit[i];
1616 for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++)
1617 r |= hidinput->input->ledbit[i];
1619 for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++)
1620 r |= hidinput->input->sndbit[i];
1622 for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++)
1623 r |= hidinput->input->ffbit[i];
1625 for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++)
1626 r |= hidinput->input->swbit[i];
1628 return !!r;
1631 static void hidinput_cleanup_hidinput(struct hid_device *hid,
1632 struct hid_input *hidinput)
1634 struct hid_report *report;
1635 int i, k;
1637 list_del(&hidinput->list);
1638 input_free_device(hidinput->input);
1639 kfree(hidinput->name);
1641 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1642 if (k == HID_OUTPUT_REPORT &&
1643 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1644 continue;
1646 list_for_each_entry(report, &hid->report_enum[k].report_list,
1647 list) {
1649 for (i = 0; i < report->maxfield; i++)
1650 if (report->field[i]->hidinput == hidinput)
1651 report->field[i]->hidinput = NULL;
1655 kfree(hidinput);
1658 static struct hid_input *hidinput_match(struct hid_report *report)
1660 struct hid_device *hid = report->device;
1661 struct hid_input *hidinput;
1663 list_for_each_entry(hidinput, &hid->inputs, list) {
1664 if (hidinput->report &&
1665 hidinput->report->id == report->id)
1666 return hidinput;
1669 return NULL;
1672 static struct hid_input *hidinput_match_application(struct hid_report *report)
1674 struct hid_device *hid = report->device;
1675 struct hid_input *hidinput;
1677 list_for_each_entry(hidinput, &hid->inputs, list) {
1678 if (hidinput->application == report->application)
1679 return hidinput;
1682 return NULL;
1685 static inline void hidinput_configure_usages(struct hid_input *hidinput,
1686 struct hid_report *report)
1688 int i, j;
1690 for (i = 0; i < report->maxfield; i++)
1691 for (j = 0; j < report->field[i]->maxusage; j++)
1692 hidinput_configure_usage(hidinput, report->field[i],
1693 report->field[i]->usage + j);
1697 * Register the input device; print a message.
1698 * Configure the input layer interface
1699 * Read all reports and initialize the absolute field values.
1702 int hidinput_connect(struct hid_device *hid, unsigned int force)
1704 struct hid_driver *drv = hid->driver;
1705 struct hid_report *report;
1706 struct hid_input *next, *hidinput = NULL;
1707 unsigned int application;
1708 int i, k;
1710 INIT_LIST_HEAD(&hid->inputs);
1711 INIT_WORK(&hid->led_work, hidinput_led_worker);
1713 hid->status &= ~HID_STAT_DUP_DETECTED;
1715 if (!force) {
1716 for (i = 0; i < hid->maxcollection; i++) {
1717 struct hid_collection *col = &hid->collection[i];
1718 if (col->type == HID_COLLECTION_APPLICATION ||
1719 col->type == HID_COLLECTION_PHYSICAL)
1720 if (IS_INPUT_APPLICATION(col->usage))
1721 break;
1724 if (i == hid->maxcollection)
1725 return -1;
1728 report_features(hid);
1730 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1731 if (k == HID_OUTPUT_REPORT &&
1732 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1733 continue;
1735 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
1737 if (!report->maxfield)
1738 continue;
1740 application = report->application;
1743 * Find the previous hidinput report attached
1744 * to this report id.
1746 if (hid->quirks & HID_QUIRK_MULTI_INPUT)
1747 hidinput = hidinput_match(report);
1748 else if (hid->maxapplication > 1 &&
1749 (hid->quirks & HID_QUIRK_INPUT_PER_APP))
1750 hidinput = hidinput_match_application(report);
1752 if (!hidinput) {
1753 hidinput = hidinput_allocate(hid, application);
1754 if (!hidinput)
1755 goto out_unwind;
1758 hidinput_configure_usages(hidinput, report);
1760 if (hid->quirks & HID_QUIRK_MULTI_INPUT)
1761 hidinput->report = report;
1763 list_add_tail(&report->hidinput_list,
1764 &hidinput->reports);
1768 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1769 if (drv->input_configured &&
1770 drv->input_configured(hid, hidinput))
1771 goto out_unwind;
1773 if (!hidinput_has_been_populated(hidinput)) {
1774 /* no need to register an input device not populated */
1775 hidinput_cleanup_hidinput(hid, hidinput);
1776 continue;
1779 if (input_register_device(hidinput->input))
1780 goto out_unwind;
1781 hidinput->registered = true;
1784 if (list_empty(&hid->inputs)) {
1785 hid_err(hid, "No inputs registered, leaving\n");
1786 goto out_unwind;
1789 if (hid->status & HID_STAT_DUP_DETECTED)
1790 hid_dbg(hid,
1791 "Some usages could not be mapped, please use HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE if this is legitimate.\n");
1793 return 0;
1795 out_unwind:
1796 /* unwind the ones we already registered */
1797 hidinput_disconnect(hid);
1799 return -1;
1801 EXPORT_SYMBOL_GPL(hidinput_connect);
1803 void hidinput_disconnect(struct hid_device *hid)
1805 struct hid_input *hidinput, *next;
1807 hidinput_cleanup_battery(hid);
1809 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1810 list_del(&hidinput->list);
1811 if (hidinput->registered)
1812 input_unregister_device(hidinput->input);
1813 else
1814 input_free_device(hidinput->input);
1815 kfree(hidinput->name);
1816 kfree(hidinput);
1819 /* led_work is spawned by input_dev callbacks, but doesn't access the
1820 * parent input_dev at all. Once all input devices are removed, we
1821 * know that led_work will never get restarted, so we can cancel it
1822 * synchronously and are safe. */
1823 cancel_work_sync(&hid->led_work);
1825 EXPORT_SYMBOL_GPL(hidinput_disconnect);