1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (c) 2000-2001 Vojtech Pavlik
4 * Copyright (c) 2006-2010 Jiri Kosina
6 * HID to Linux Input mapping
11 * Should you need to contact me, the author, you can do so either by
12 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
13 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
16 #include <linux/module.h>
17 #include <linux/slab.h>
18 #include <linux/kernel.h>
20 #include <linux/hid.h>
21 #include <linux/hid-debug.h>
25 #define unk KEY_UNKNOWN
27 static const unsigned char hid_keyboard[256] = {
28 0, 0, 0, 0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36, 37, 38,
29 50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45, 21, 44, 2, 3,
30 4, 5, 6, 7, 8, 9, 10, 11, 28, 1, 14, 15, 57, 12, 13, 26,
31 27, 43, 43, 39, 40, 41, 51, 52, 53, 58, 59, 60, 61, 62, 63, 64,
32 65, 66, 67, 68, 87, 88, 99, 70,119,110,102,104,111,107,109,106,
33 105,108,103, 69, 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71,
34 72, 73, 82, 83, 86,127,116,117,183,184,185,186,187,188,189,190,
35 191,192,193,194,134,138,130,132,128,129,131,137,133,135,136,113,
36 115,114,unk,unk,unk,121,unk, 89, 93,124, 92, 94, 95,unk,unk,unk,
37 122,123, 90, 91, 85,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,
38 unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
39 unk,unk,unk,unk,unk,unk,179,180,unk,unk,unk,unk,unk,unk,unk,unk,
40 unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
41 unk,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,unk,unk,unk,unk,
42 29, 42, 56,125, 97, 54,100,126,164,166,165,163,161,115,114,113,
43 150,158,159,128,136,177,178,176,142,152,173,140,unk,unk,unk,unk
49 } hid_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
51 struct usage_priority {
52 __u32 usage; /* the HID usage associated */
53 bool global; /* we assume all usages to be slotted,
56 unsigned int slot_overwrite; /* for globals: allows to set the usage
57 * before or after the slots
62 * hid-input will convert this list into priorities:
63 * the first element will have the highest priority
64 * (the length of the following array) and the last
65 * element the lowest (1).
67 * hid-input will then shift the priority by 8 bits to leave some space
68 * in case drivers want to interleave other fields.
70 * To accommodate slotted devices, the slot priority is
71 * defined in the next 8 bits (defined by 0xff - slot).
73 * If drivers want to add fields before those, hid-input will
74 * leave out the first 8 bits of the priority value.
76 * This still leaves us 65535 individual priority values.
78 static const struct usage_priority hidinput_usages_priorities[] = {
79 { /* Eraser (eraser touching) must always come before tipswitch */
80 .usage = HID_DG_ERASER,
82 { /* Invert must always come before In Range */
83 .usage = HID_DG_INVERT,
85 { /* Is the tip of the tool touching? */
86 .usage = HID_DG_TIPSWITCH,
88 { /* Tip Pressure might emulate tip switch */
89 .usage = HID_DG_TIPPRESSURE,
91 { /* In Range needs to come after the other tool states */
92 .usage = HID_DG_INRANGE,
96 #define map_abs(c) hid_map_usage(hidinput, usage, &bit, &max, EV_ABS, (c))
97 #define map_rel(c) hid_map_usage(hidinput, usage, &bit, &max, EV_REL, (c))
98 #define map_key(c) hid_map_usage(hidinput, usage, &bit, &max, EV_KEY, (c))
99 #define map_led(c) hid_map_usage(hidinput, usage, &bit, &max, EV_LED, (c))
100 #define map_msc(c) hid_map_usage(hidinput, usage, &bit, &max, EV_MSC, (c))
102 #define map_abs_clear(c) hid_map_usage_clear(hidinput, usage, &bit, \
104 #define map_key_clear(c) hid_map_usage_clear(hidinput, usage, &bit, \
107 static bool match_scancode(struct hid_usage *usage,
108 unsigned int cur_idx, unsigned int scancode)
110 return (usage->hid & (HID_USAGE_PAGE | HID_USAGE)) == scancode;
113 static bool match_keycode(struct hid_usage *usage,
114 unsigned int cur_idx, unsigned int keycode)
117 * We should exclude unmapped usages when doing lookup by keycode.
119 return (usage->type == EV_KEY && usage->code == keycode);
122 static bool match_index(struct hid_usage *usage,
123 unsigned int cur_idx, unsigned int idx)
125 return cur_idx == idx;
128 typedef bool (*hid_usage_cmp_t)(struct hid_usage *usage,
129 unsigned int cur_idx, unsigned int val);
131 static struct hid_usage *hidinput_find_key(struct hid_device *hid,
132 hid_usage_cmp_t match,
134 unsigned int *usage_idx)
136 unsigned int i, j, k, cur_idx = 0;
137 struct hid_report *report;
138 struct hid_usage *usage;
140 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
141 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
142 for (i = 0; i < report->maxfield; i++) {
143 for (j = 0; j < report->field[i]->maxusage; j++) {
144 usage = report->field[i]->usage + j;
145 if (usage->type == EV_KEY || usage->type == 0) {
146 if (match(usage, cur_idx, value)) {
148 *usage_idx = cur_idx;
160 static struct hid_usage *hidinput_locate_usage(struct hid_device *hid,
161 const struct input_keymap_entry *ke,
164 struct hid_usage *usage;
165 unsigned int scancode;
167 if (ke->flags & INPUT_KEYMAP_BY_INDEX)
168 usage = hidinput_find_key(hid, match_index, ke->index, index);
169 else if (input_scancode_to_scalar(ke, &scancode) == 0)
170 usage = hidinput_find_key(hid, match_scancode, scancode, index);
177 static int hidinput_getkeycode(struct input_dev *dev,
178 struct input_keymap_entry *ke)
180 struct hid_device *hid = input_get_drvdata(dev);
181 struct hid_usage *usage;
182 unsigned int scancode, index;
184 usage = hidinput_locate_usage(hid, ke, &index);
186 ke->keycode = usage->type == EV_KEY ?
187 usage->code : KEY_RESERVED;
189 scancode = usage->hid & (HID_USAGE_PAGE | HID_USAGE);
190 ke->len = sizeof(scancode);
191 memcpy(ke->scancode, &scancode, sizeof(scancode));
198 static int hidinput_setkeycode(struct input_dev *dev,
199 const struct input_keymap_entry *ke,
200 unsigned int *old_keycode)
202 struct hid_device *hid = input_get_drvdata(dev);
203 struct hid_usage *usage;
205 usage = hidinput_locate_usage(hid, ke, NULL);
207 *old_keycode = usage->type == EV_KEY ?
208 usage->code : KEY_RESERVED;
209 usage->type = EV_KEY;
210 usage->code = ke->keycode;
212 clear_bit(*old_keycode, dev->keybit);
213 set_bit(usage->code, dev->keybit);
214 dbg_hid("Assigned keycode %d to HID usage code %x\n",
215 usage->code, usage->hid);
218 * Set the keybit for the old keycode if the old keycode is used
221 if (hidinput_find_key(hid, match_keycode, *old_keycode, NULL))
222 set_bit(*old_keycode, dev->keybit);
232 * hidinput_calc_abs_res - calculate an absolute axis resolution
233 * @field: the HID report field to calculate resolution for
237 * (logical_maximum - logical_minimum)
238 * resolution = ----------------------------------------------------------
239 * (physical_maximum - physical_minimum) * 10 ^ unit_exponent
241 * as seen in the HID specification v1.11 6.2.2.7 Global Items.
243 * Only exponent 1 length units are processed. Centimeters and inches are
244 * converted to millimeters. Degrees are converted to radians.
246 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code)
248 __s32 unit_exponent = field->unit_exponent;
249 __s32 logical_extents = field->logical_maximum -
250 field->logical_minimum;
251 __s32 physical_extents = field->physical_maximum -
252 field->physical_minimum;
255 /* Check if the extents are sane */
256 if (logical_extents <= 0 || physical_extents <= 0)
260 * Verify and convert units.
261 * See HID specification v1.11 6.2.2.7 Global Items for unit decoding
267 case ABS_MT_POSITION_X:
268 case ABS_MT_POSITION_Y:
271 case ABS_MT_TOUCH_MAJOR:
272 case ABS_MT_TOUCH_MINOR:
273 if (field->unit == 0x11) { /* If centimeters */
274 /* Convert to millimeters */
276 } else if (field->unit == 0x13) { /* If inches */
277 /* Convert to millimeters */
278 prev = physical_extents;
279 physical_extents *= 254;
280 if (physical_extents < prev)
294 if (field->unit == 0x14) { /* If degrees */
295 /* Convert to radians */
296 prev = logical_extents;
297 logical_extents *= 573;
298 if (logical_extents < prev)
301 } else if (field->unit != 0x12) { /* If not radians */
310 /* Apply negative unit exponent */
311 for (; unit_exponent < 0; unit_exponent++) {
312 prev = logical_extents;
313 logical_extents *= 10;
314 if (logical_extents < prev)
317 /* Apply positive unit exponent */
318 for (; unit_exponent > 0; unit_exponent--) {
319 prev = physical_extents;
320 physical_extents *= 10;
321 if (physical_extents < prev)
325 /* Calculate resolution */
326 return DIV_ROUND_CLOSEST(logical_extents, physical_extents);
328 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res);
330 #ifdef CONFIG_HID_BATTERY_STRENGTH
331 static enum power_supply_property hidinput_battery_props[] = {
332 POWER_SUPPLY_PROP_PRESENT,
333 POWER_SUPPLY_PROP_ONLINE,
334 POWER_SUPPLY_PROP_CAPACITY,
335 POWER_SUPPLY_PROP_MODEL_NAME,
336 POWER_SUPPLY_PROP_STATUS,
337 POWER_SUPPLY_PROP_SCOPE,
340 #define HID_BATTERY_QUIRK_PERCENT (1 << 0) /* always reports percent */
341 #define HID_BATTERY_QUIRK_FEATURE (1 << 1) /* ask for feature report */
342 #define HID_BATTERY_QUIRK_IGNORE (1 << 2) /* completely ignore the battery */
343 #define HID_BATTERY_QUIRK_AVOID_QUERY (1 << 3) /* do not query the battery */
345 static const struct hid_device_id hid_battery_quirks[] = {
346 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
347 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
348 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
349 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
350 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
351 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
352 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
353 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
354 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
355 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
356 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
357 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
358 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
359 USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
360 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
361 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
362 USB_DEVICE_ID_APPLE_MAGICTRACKPAD),
363 HID_BATTERY_QUIRK_IGNORE },
364 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM,
365 USB_DEVICE_ID_ELECOM_BM084),
366 HID_BATTERY_QUIRK_IGNORE },
367 { HID_USB_DEVICE(USB_VENDOR_ID_SYMBOL,
368 USB_DEVICE_ID_SYMBOL_SCANNER_3),
369 HID_BATTERY_QUIRK_IGNORE },
370 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ASUSTEK,
371 USB_DEVICE_ID_ASUSTEK_T100CHI_KEYBOARD),
372 HID_BATTERY_QUIRK_IGNORE },
373 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH,
374 USB_DEVICE_ID_LOGITECH_DINOVO_EDGE_KBD),
375 HID_BATTERY_QUIRK_IGNORE },
376 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_ASUS_TP420IA_TOUCHSCREEN),
377 HID_BATTERY_QUIRK_IGNORE },
378 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_ASUS_GV301RA_TOUCHSCREEN),
379 HID_BATTERY_QUIRK_IGNORE },
380 { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_ASUS_UX550_TOUCHSCREEN),
381 HID_BATTERY_QUIRK_IGNORE },
382 { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_ASUS_UX550VE_TOUCHSCREEN),
383 HID_BATTERY_QUIRK_IGNORE },
384 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_L),
385 HID_BATTERY_QUIRK_AVOID_QUERY },
386 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_PRO_MW),
387 HID_BATTERY_QUIRK_AVOID_QUERY },
388 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_PRO_SW),
389 HID_BATTERY_QUIRK_AVOID_QUERY },
390 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_ENVY_X360_15),
391 HID_BATTERY_QUIRK_IGNORE },
392 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_ENVY_X360_15T_DR100),
393 HID_BATTERY_QUIRK_IGNORE },
394 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_ENVY_X360_EU0009NV),
395 HID_BATTERY_QUIRK_IGNORE },
396 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_SPECTRE_X360_15),
397 HID_BATTERY_QUIRK_IGNORE },
398 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_SPECTRE_X360_13_AW0020NG),
399 HID_BATTERY_QUIRK_IGNORE },
400 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_SURFACE_GO_TOUCHSCREEN),
401 HID_BATTERY_QUIRK_IGNORE },
402 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_SURFACE_GO2_TOUCHSCREEN),
403 HID_BATTERY_QUIRK_IGNORE },
404 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_LENOVO_YOGA_C630_TOUCHSCREEN),
405 HID_BATTERY_QUIRK_IGNORE },
406 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_SPECTRE_X360_13T_AW100),
407 HID_BATTERY_QUIRK_IGNORE },
408 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_SPECTRE_X360_14T_EA100_V1),
409 HID_BATTERY_QUIRK_IGNORE },
410 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_SPECTRE_X360_14T_EA100_V2),
411 HID_BATTERY_QUIRK_IGNORE },
415 static unsigned find_battery_quirk(struct hid_device *hdev)
418 const struct hid_device_id *match;
420 match = hid_match_id(hdev, hid_battery_quirks);
422 quirks = match->driver_data;
427 static int hidinput_scale_battery_capacity(struct hid_device *dev,
430 if (dev->battery_min < dev->battery_max &&
431 value >= dev->battery_min && value <= dev->battery_max)
432 value = ((value - dev->battery_min) * 100) /
433 (dev->battery_max - dev->battery_min);
438 static int hidinput_query_battery_capacity(struct hid_device *dev)
443 buf = kmalloc(4, GFP_KERNEL);
447 ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 4,
448 dev->battery_report_type, HID_REQ_GET_REPORT);
454 ret = hidinput_scale_battery_capacity(dev, buf[1]);
459 static int hidinput_get_battery_property(struct power_supply *psy,
460 enum power_supply_property prop,
461 union power_supply_propval *val)
463 struct hid_device *dev = power_supply_get_drvdata(psy);
468 case POWER_SUPPLY_PROP_PRESENT:
469 case POWER_SUPPLY_PROP_ONLINE:
473 case POWER_SUPPLY_PROP_CAPACITY:
474 if (dev->battery_status != HID_BATTERY_REPORTED &&
475 !dev->battery_avoid_query) {
476 value = hidinput_query_battery_capacity(dev);
480 value = dev->battery_capacity;
486 case POWER_SUPPLY_PROP_MODEL_NAME:
487 val->strval = dev->name;
490 case POWER_SUPPLY_PROP_STATUS:
491 if (dev->battery_status != HID_BATTERY_REPORTED &&
492 !dev->battery_avoid_query) {
493 value = hidinput_query_battery_capacity(dev);
497 dev->battery_capacity = value;
498 dev->battery_status = HID_BATTERY_QUERIED;
501 if (dev->battery_status == HID_BATTERY_UNKNOWN)
502 val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
504 val->intval = dev->battery_charge_status;
507 case POWER_SUPPLY_PROP_SCOPE:
508 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
519 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
520 struct hid_field *field, bool is_percentage)
522 struct power_supply_desc *psy_desc;
523 struct power_supply_config psy_cfg = { .drv_data = dev, };
529 return 0; /* already initialized? */
531 quirks = find_battery_quirk(dev);
533 hid_dbg(dev, "device %x:%x:%x %d quirks %d\n",
534 dev->bus, dev->vendor, dev->product, dev->version, quirks);
536 if (quirks & HID_BATTERY_QUIRK_IGNORE)
539 psy_desc = kzalloc(sizeof(*psy_desc), GFP_KERNEL);
543 psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery",
545 dev->uniq : dev_name(&dev->dev));
546 if (!psy_desc->name) {
551 psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
552 psy_desc->properties = hidinput_battery_props;
553 psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props);
554 psy_desc->use_for_apm = 0;
555 psy_desc->get_property = hidinput_get_battery_property;
557 min = field->logical_minimum;
558 max = field->logical_maximum;
560 if (is_percentage || (quirks & HID_BATTERY_QUIRK_PERCENT)) {
565 if (quirks & HID_BATTERY_QUIRK_FEATURE)
566 report_type = HID_FEATURE_REPORT;
568 dev->battery_min = min;
569 dev->battery_max = max;
570 dev->battery_report_type = report_type;
571 dev->battery_report_id = field->report->id;
572 dev->battery_charge_status = POWER_SUPPLY_STATUS_DISCHARGING;
575 * Stylus is normally not connected to the device and thus we
576 * can't query the device and get meaningful battery strength.
577 * We have to wait for the device to report it on its own.
579 dev->battery_avoid_query = report_type == HID_INPUT_REPORT &&
580 field->physical == HID_DG_STYLUS;
582 if (quirks & HID_BATTERY_QUIRK_AVOID_QUERY)
583 dev->battery_avoid_query = true;
585 dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg);
586 if (IS_ERR(dev->battery)) {
587 error = PTR_ERR(dev->battery);
588 hid_warn(dev, "can't register power supply: %d\n", error);
592 power_supply_powers(dev->battery, &dev->dev);
596 kfree(psy_desc->name);
603 static void hidinput_cleanup_battery(struct hid_device *dev)
605 const struct power_supply_desc *psy_desc;
610 psy_desc = dev->battery->desc;
611 power_supply_unregister(dev->battery);
612 kfree(psy_desc->name);
617 static void hidinput_update_battery(struct hid_device *dev, int value)
624 if (value == 0 || value < dev->battery_min || value > dev->battery_max)
627 capacity = hidinput_scale_battery_capacity(dev, value);
629 if (dev->battery_status != HID_BATTERY_REPORTED ||
630 capacity != dev->battery_capacity ||
631 ktime_after(ktime_get_coarse(), dev->battery_ratelimit_time)) {
632 dev->battery_capacity = capacity;
633 dev->battery_status = HID_BATTERY_REPORTED;
634 dev->battery_ratelimit_time =
635 ktime_add_ms(ktime_get_coarse(), 30 * 1000);
636 power_supply_changed(dev->battery);
640 static bool hidinput_set_battery_charge_status(struct hid_device *dev,
641 unsigned int usage, int value)
644 case HID_BAT_CHARGING:
645 dev->battery_charge_status = value ?
646 POWER_SUPPLY_STATUS_CHARGING :
647 POWER_SUPPLY_STATUS_DISCHARGING;
653 #else /* !CONFIG_HID_BATTERY_STRENGTH */
654 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
655 struct hid_field *field, bool is_percentage)
660 static void hidinput_cleanup_battery(struct hid_device *dev)
664 static void hidinput_update_battery(struct hid_device *dev, int value)
668 static bool hidinput_set_battery_charge_status(struct hid_device *dev,
669 unsigned int usage, int value)
673 #endif /* CONFIG_HID_BATTERY_STRENGTH */
675 static bool hidinput_field_in_collection(struct hid_device *device, struct hid_field *field,
676 unsigned int type, unsigned int usage)
678 struct hid_collection *collection;
680 collection = &device->collection[field->usage->collection_index];
682 return collection->type == type && collection->usage == usage;
685 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
686 struct hid_usage *usage, unsigned int usage_index)
688 struct input_dev *input = hidinput->input;
689 struct hid_device *device = input_get_drvdata(input);
690 const struct usage_priority *usage_priority = NULL;
693 unsigned long *bit = NULL;
695 field->hidinput = hidinput;
697 if (field->flags & HID_MAIN_ITEM_CONSTANT)
700 /* Ignore if report count is out of bounds. */
701 if (field->report_count < 1)
704 /* only LED usages are supported in output fields */
705 if (field->report_type == HID_OUTPUT_REPORT &&
706 (usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
710 /* assign a priority based on the static list declared here */
711 for (i = 0; i < ARRAY_SIZE(hidinput_usages_priorities); i++) {
712 if (usage->hid == hidinput_usages_priorities[i].usage) {
713 usage_priority = &hidinput_usages_priorities[i];
715 field->usages_priorities[usage_index] =
716 (ARRAY_SIZE(hidinput_usages_priorities) - i) << 8;
722 * For slotted devices, we need to also add the slot index
725 if (usage_priority && usage_priority->global)
726 field->usages_priorities[usage_index] |=
727 usage_priority->slot_overwrite;
729 field->usages_priorities[usage_index] |=
730 (0xff - field->slot_idx) << 16;
732 if (device->driver->input_mapping) {
733 int ret = device->driver->input_mapping(device, hidinput, field,
741 switch (usage->hid & HID_USAGE_PAGE) {
742 case HID_UP_UNDEFINED:
745 case HID_UP_KEYBOARD:
746 set_bit(EV_REP, input->evbit);
748 if ((usage->hid & HID_USAGE) < 256) {
749 if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
750 map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
752 map_key(KEY_UNKNOWN);
757 code = ((usage->hid - 1) & HID_USAGE);
759 switch (field->application) {
761 case HID_GD_POINTER: code += BTN_MOUSE; break;
762 case HID_GD_JOYSTICK:
764 code += BTN_JOYSTICK;
766 code += BTN_TRIGGER_HAPPY - 0x10;
772 code += BTN_TRIGGER_HAPPY - 0x10;
774 case HID_CP_CONSUMER_CONTROL:
775 if (hidinput_field_in_collection(device, field,
776 HID_COLLECTION_NAMED_ARRAY,
777 HID_CP_PROGRAMMABLEBUTTONS)) {
781 code += BTN_TRIGGER_HAPPY - 0x1e;
786 switch (field->physical) {
788 case HID_GD_POINTER: code += BTN_MOUSE; break;
789 case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break;
790 case HID_GD_GAMEPAD: code += BTN_GAMEPAD; break;
791 default: code += BTN_MISC;
798 case HID_UP_SIMULATION:
799 switch (usage->hid & 0xffff) {
800 case 0xba: map_abs(ABS_RUDDER); break;
801 case 0xbb: map_abs(ABS_THROTTLE); break;
802 case 0xc4: map_abs(ABS_GAS); break;
803 case 0xc5: map_abs(ABS_BRAKE); break;
804 case 0xc8: map_abs(ABS_WHEEL); break;
805 default: goto ignore;
810 if ((usage->hid & 0xf0) == 0x80) { /* SystemControl */
811 switch (usage->hid & 0xf) {
812 case 0x1: map_key_clear(KEY_POWER); break;
813 case 0x2: map_key_clear(KEY_SLEEP); break;
814 case 0x3: map_key_clear(KEY_WAKEUP); break;
815 case 0x4: map_key_clear(KEY_CONTEXT_MENU); break;
816 case 0x5: map_key_clear(KEY_MENU); break;
817 case 0x6: map_key_clear(KEY_PROG1); break;
818 case 0x7: map_key_clear(KEY_HELP); break;
819 case 0x8: map_key_clear(KEY_EXIT); break;
820 case 0x9: map_key_clear(KEY_SELECT); break;
821 case 0xa: map_key_clear(KEY_RIGHT); break;
822 case 0xb: map_key_clear(KEY_LEFT); break;
823 case 0xc: map_key_clear(KEY_UP); break;
824 case 0xd: map_key_clear(KEY_DOWN); break;
825 case 0xe: map_key_clear(KEY_POWER2); break;
826 case 0xf: map_key_clear(KEY_RESTART); break;
827 default: goto unknown;
832 if ((usage->hid & 0xf0) == 0xa0) { /* SystemControl */
833 switch (usage->hid & 0xf) {
834 case 0x9: map_key_clear(KEY_MICMUTE); break;
835 default: goto ignore;
840 if ((usage->hid & 0xf0) == 0xb0) { /* SC - Display */
841 switch (usage->hid & 0xf) {
842 case 0x05: map_key_clear(KEY_SWITCHVIDEOMODE); break;
843 default: goto ignore;
849 * Some lazy vendors declare 255 usages for System Control,
850 * leading to the creation of ABS_X|Y axis and too many others.
851 * It wouldn't be a problem if joydev doesn't consider the
852 * device as a joystick then.
854 if (field->application == HID_GD_SYSTEM_CONTROL)
857 if ((usage->hid & 0xf0) == 0x90) { /* D-pad */
858 switch (usage->hid) {
859 case HID_GD_UP: usage->hat_dir = 1; break;
860 case HID_GD_DOWN: usage->hat_dir = 5; break;
861 case HID_GD_RIGHT: usage->hat_dir = 3; break;
862 case HID_GD_LEFT: usage->hat_dir = 7; break;
863 default: goto unknown;
866 map_abs(field->dpad);
873 switch (usage->hid) {
874 /* These usage IDs map directly to the usage codes. */
875 case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
876 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
877 if (field->flags & HID_MAIN_ITEM_RELATIVE)
878 map_rel(usage->hid & 0xf);
880 map_abs_clear(usage->hid & 0xf);
884 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
885 set_bit(REL_WHEEL, input->relbit);
886 map_rel(REL_WHEEL_HI_RES);
888 map_abs(usage->hid & 0xf);
891 case HID_GD_SLIDER: case HID_GD_DIAL:
892 if (field->flags & HID_MAIN_ITEM_RELATIVE)
893 map_rel(usage->hid & 0xf);
895 map_abs(usage->hid & 0xf);
898 case HID_GD_HATSWITCH:
899 usage->hat_min = field->logical_minimum;
900 usage->hat_max = field->logical_maximum;
904 case HID_GD_START: map_key_clear(BTN_START); break;
905 case HID_GD_SELECT: map_key_clear(BTN_SELECT); break;
907 case HID_GD_RFKILL_BTN:
908 /* MS wireless radio ctl extension, also check CA */
909 if (field->application == HID_GD_WIRELESS_RADIO_CTLS) {
910 map_key_clear(KEY_RFKILL);
911 /* We need to simulate the btn release */
912 field->flags |= HID_MAIN_ITEM_RELATIVE;
917 default: goto unknown;
923 switch (usage->hid & 0xffff) { /* HID-Value: */
924 case 0x01: map_led (LED_NUML); break; /* "Num Lock" */
925 case 0x02: map_led (LED_CAPSL); break; /* "Caps Lock" */
926 case 0x03: map_led (LED_SCROLLL); break; /* "Scroll Lock" */
927 case 0x04: map_led (LED_COMPOSE); break; /* "Compose" */
928 case 0x05: map_led (LED_KANA); break; /* "Kana" */
929 case 0x27: map_led (LED_SLEEP); break; /* "Stand-By" */
930 case 0x4c: map_led (LED_SUSPEND); break; /* "System Suspend" */
931 case 0x09: map_led (LED_MUTE); break; /* "Mute" */
932 case 0x4b: map_led (LED_MISC); break; /* "Generic Indicator" */
933 case 0x19: map_led (LED_MAIL); break; /* "Message Waiting" */
934 case 0x4d: map_led (LED_CHARGING); break; /* "External Power Connected" */
936 default: goto ignore;
940 case HID_UP_DIGITIZER:
941 if ((field->application & 0xff) == 0x01) /* Digitizer */
942 __set_bit(INPUT_PROP_POINTER, input->propbit);
943 else if ((field->application & 0xff) == 0x02) /* Pen */
944 __set_bit(INPUT_PROP_DIRECT, input->propbit);
946 switch (usage->hid & 0xff) {
947 case 0x00: /* Undefined */
950 case 0x30: /* TipPressure */
951 if (!test_bit(BTN_TOUCH, input->keybit)) {
952 device->quirks |= HID_QUIRK_NOTOUCH;
953 set_bit(EV_KEY, input->evbit);
954 set_bit(BTN_TOUCH, input->keybit);
956 map_abs_clear(ABS_PRESSURE);
959 case 0x32: /* InRange */
960 switch (field->physical) {
962 map_key(BTN_TOOL_MOUSE);
965 map_key(BTN_TOOL_FINGER);
969 * If the physical is not given,
970 * rely on the application.
972 if (!field->physical) {
973 switch (field->application) {
974 case HID_DG_TOUCHSCREEN:
975 case HID_DG_TOUCHPAD:
976 map_key_clear(BTN_TOOL_FINGER);
979 map_key_clear(BTN_TOOL_PEN);
982 map_key(BTN_TOOL_PEN);
988 case 0x3b: /* Battery Strength */
989 hidinput_setup_battery(device, HID_INPUT_REPORT, field, false);
990 usage->type = EV_PWR;
993 case 0x3c: /* Invert */
994 device->quirks &= ~HID_QUIRK_NOINVERT;
995 map_key_clear(BTN_TOOL_RUBBER);
998 case 0x3d: /* X Tilt */
999 map_abs_clear(ABS_TILT_X);
1002 case 0x3e: /* Y Tilt */
1003 map_abs_clear(ABS_TILT_Y);
1006 case 0x33: /* Touch */
1007 case 0x42: /* TipSwitch */
1008 case 0x43: /* TipSwitch2 */
1009 device->quirks &= ~HID_QUIRK_NOTOUCH;
1010 map_key_clear(BTN_TOUCH);
1013 case 0x44: /* BarrelSwitch */
1014 map_key_clear(BTN_STYLUS);
1017 case 0x45: /* ERASER */
1019 * This event is reported when eraser tip touches the surface.
1020 * Actual eraser (BTN_TOOL_RUBBER) is set and released either
1021 * by Invert if tool reports proximity or by Eraser directly.
1023 if (!test_bit(BTN_TOOL_RUBBER, input->keybit)) {
1024 device->quirks |= HID_QUIRK_NOINVERT;
1025 set_bit(BTN_TOOL_RUBBER, input->keybit);
1027 map_key_clear(BTN_TOUCH);
1030 case 0x46: /* TabletPick */
1031 case 0x5a: /* SecondaryBarrelSwitch */
1032 map_key_clear(BTN_STYLUS2);
1035 case 0x5b: /* TransducerSerialNumber */
1036 case 0x6e: /* TransducerSerialNumber2 */
1037 map_msc(MSC_SERIAL);
1040 default: goto unknown;
1044 case HID_UP_TELEPHONY:
1045 switch (usage->hid & HID_USAGE) {
1046 case 0x2f: map_key_clear(KEY_MICMUTE); break;
1047 case 0xb0: map_key_clear(KEY_NUMERIC_0); break;
1048 case 0xb1: map_key_clear(KEY_NUMERIC_1); break;
1049 case 0xb2: map_key_clear(KEY_NUMERIC_2); break;
1050 case 0xb3: map_key_clear(KEY_NUMERIC_3); break;
1051 case 0xb4: map_key_clear(KEY_NUMERIC_4); break;
1052 case 0xb5: map_key_clear(KEY_NUMERIC_5); break;
1053 case 0xb6: map_key_clear(KEY_NUMERIC_6); break;
1054 case 0xb7: map_key_clear(KEY_NUMERIC_7); break;
1055 case 0xb8: map_key_clear(KEY_NUMERIC_8); break;
1056 case 0xb9: map_key_clear(KEY_NUMERIC_9); break;
1057 case 0xba: map_key_clear(KEY_NUMERIC_STAR); break;
1058 case 0xbb: map_key_clear(KEY_NUMERIC_POUND); break;
1059 case 0xbc: map_key_clear(KEY_NUMERIC_A); break;
1060 case 0xbd: map_key_clear(KEY_NUMERIC_B); break;
1061 case 0xbe: map_key_clear(KEY_NUMERIC_C); break;
1062 case 0xbf: map_key_clear(KEY_NUMERIC_D); break;
1063 default: goto ignore;
1067 case HID_UP_CONSUMER: /* USB HUT v1.12, pages 75-84 */
1068 switch (usage->hid & HID_USAGE) {
1069 case 0x000: goto ignore;
1070 case 0x030: map_key_clear(KEY_POWER); break;
1071 case 0x031: map_key_clear(KEY_RESTART); break;
1072 case 0x032: map_key_clear(KEY_SLEEP); break;
1073 case 0x034: map_key_clear(KEY_SLEEP); break;
1074 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE); break;
1075 case 0x036: map_key_clear(BTN_MISC); break;
1077 case 0x040: map_key_clear(KEY_MENU); break; /* Menu */
1078 case 0x041: map_key_clear(KEY_SELECT); break; /* Menu Pick */
1079 case 0x042: map_key_clear(KEY_UP); break; /* Menu Up */
1080 case 0x043: map_key_clear(KEY_DOWN); break; /* Menu Down */
1081 case 0x044: map_key_clear(KEY_LEFT); break; /* Menu Left */
1082 case 0x045: map_key_clear(KEY_RIGHT); break; /* Menu Right */
1083 case 0x046: map_key_clear(KEY_ESC); break; /* Menu Escape */
1084 case 0x047: map_key_clear(KEY_KPPLUS); break; /* Menu Value Increase */
1085 case 0x048: map_key_clear(KEY_KPMINUS); break; /* Menu Value Decrease */
1087 case 0x060: map_key_clear(KEY_INFO); break; /* Data On Screen */
1088 case 0x061: map_key_clear(KEY_SUBTITLE); break; /* Closed Caption */
1089 case 0x063: map_key_clear(KEY_VCR); break; /* VCR/TV */
1090 case 0x065: map_key_clear(KEY_CAMERA); break; /* Snapshot */
1091 case 0x069: map_key_clear(KEY_RED); break;
1092 case 0x06a: map_key_clear(KEY_GREEN); break;
1093 case 0x06b: map_key_clear(KEY_BLUE); break;
1094 case 0x06c: map_key_clear(KEY_YELLOW); break;
1095 case 0x06d: map_key_clear(KEY_ASPECT_RATIO); break;
1097 case 0x06f: map_key_clear(KEY_BRIGHTNESSUP); break;
1098 case 0x070: map_key_clear(KEY_BRIGHTNESSDOWN); break;
1099 case 0x072: map_key_clear(KEY_BRIGHTNESS_TOGGLE); break;
1100 case 0x073: map_key_clear(KEY_BRIGHTNESS_MIN); break;
1101 case 0x074: map_key_clear(KEY_BRIGHTNESS_MAX); break;
1102 case 0x075: map_key_clear(KEY_BRIGHTNESS_AUTO); break;
1104 case 0x076: map_key_clear(KEY_CAMERA_ACCESS_ENABLE); break;
1105 case 0x077: map_key_clear(KEY_CAMERA_ACCESS_DISABLE); break;
1106 case 0x078: map_key_clear(KEY_CAMERA_ACCESS_TOGGLE); break;
1108 case 0x079: map_key_clear(KEY_KBDILLUMUP); break;
1109 case 0x07a: map_key_clear(KEY_KBDILLUMDOWN); break;
1110 case 0x07c: map_key_clear(KEY_KBDILLUMTOGGLE); break;
1112 case 0x082: map_key_clear(KEY_VIDEO_NEXT); break;
1113 case 0x083: map_key_clear(KEY_LAST); break;
1114 case 0x084: map_key_clear(KEY_ENTER); break;
1115 case 0x088: map_key_clear(KEY_PC); break;
1116 case 0x089: map_key_clear(KEY_TV); break;
1117 case 0x08a: map_key_clear(KEY_WWW); break;
1118 case 0x08b: map_key_clear(KEY_DVD); break;
1119 case 0x08c: map_key_clear(KEY_PHONE); break;
1120 case 0x08d: map_key_clear(KEY_PROGRAM); break;
1121 case 0x08e: map_key_clear(KEY_VIDEOPHONE); break;
1122 case 0x08f: map_key_clear(KEY_GAMES); break;
1123 case 0x090: map_key_clear(KEY_MEMO); break;
1124 case 0x091: map_key_clear(KEY_CD); break;
1125 case 0x092: map_key_clear(KEY_VCR); break;
1126 case 0x093: map_key_clear(KEY_TUNER); break;
1127 case 0x094: map_key_clear(KEY_EXIT); break;
1128 case 0x095: map_key_clear(KEY_HELP); break;
1129 case 0x096: map_key_clear(KEY_TAPE); break;
1130 case 0x097: map_key_clear(KEY_TV2); break;
1131 case 0x098: map_key_clear(KEY_SAT); break;
1132 case 0x09a: map_key_clear(KEY_PVR); break;
1134 case 0x09c: map_key_clear(KEY_CHANNELUP); break;
1135 case 0x09d: map_key_clear(KEY_CHANNELDOWN); break;
1136 case 0x0a0: map_key_clear(KEY_VCR2); break;
1138 case 0x0b0: map_key_clear(KEY_PLAY); break;
1139 case 0x0b1: map_key_clear(KEY_PAUSE); break;
1140 case 0x0b2: map_key_clear(KEY_RECORD); break;
1141 case 0x0b3: map_key_clear(KEY_FASTFORWARD); break;
1142 case 0x0b4: map_key_clear(KEY_REWIND); break;
1143 case 0x0b5: map_key_clear(KEY_NEXTSONG); break;
1144 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG); break;
1145 case 0x0b7: map_key_clear(KEY_STOPCD); break;
1146 case 0x0b8: map_key_clear(KEY_EJECTCD); break;
1147 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT); break;
1148 case 0x0b9: map_key_clear(KEY_SHUFFLE); break;
1149 case 0x0bf: map_key_clear(KEY_SLOW); break;
1151 case 0x0cd: map_key_clear(KEY_PLAYPAUSE); break;
1152 case 0x0cf: map_key_clear(KEY_VOICECOMMAND); break;
1154 case 0x0d8: map_key_clear(KEY_DICTATE); break;
1155 case 0x0d9: map_key_clear(KEY_EMOJI_PICKER); break;
1157 case 0x0e0: map_abs_clear(ABS_VOLUME); break;
1158 case 0x0e2: map_key_clear(KEY_MUTE); break;
1159 case 0x0e5: map_key_clear(KEY_BASSBOOST); break;
1160 case 0x0e9: map_key_clear(KEY_VOLUMEUP); break;
1161 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN); break;
1162 case 0x0f5: map_key_clear(KEY_SLOW); break;
1164 case 0x181: map_key_clear(KEY_BUTTONCONFIG); break;
1165 case 0x182: map_key_clear(KEY_BOOKMARKS); break;
1166 case 0x183: map_key_clear(KEY_CONFIG); break;
1167 case 0x184: map_key_clear(KEY_WORDPROCESSOR); break;
1168 case 0x185: map_key_clear(KEY_EDITOR); break;
1169 case 0x186: map_key_clear(KEY_SPREADSHEET); break;
1170 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR); break;
1171 case 0x188: map_key_clear(KEY_PRESENTATION); break;
1172 case 0x189: map_key_clear(KEY_DATABASE); break;
1173 case 0x18a: map_key_clear(KEY_MAIL); break;
1174 case 0x18b: map_key_clear(KEY_NEWS); break;
1175 case 0x18c: map_key_clear(KEY_VOICEMAIL); break;
1176 case 0x18d: map_key_clear(KEY_ADDRESSBOOK); break;
1177 case 0x18e: map_key_clear(KEY_CALENDAR); break;
1178 case 0x18f: map_key_clear(KEY_TASKMANAGER); break;
1179 case 0x190: map_key_clear(KEY_JOURNAL); break;
1180 case 0x191: map_key_clear(KEY_FINANCE); break;
1181 case 0x192: map_key_clear(KEY_CALC); break;
1182 case 0x193: map_key_clear(KEY_PLAYER); break;
1183 case 0x194: map_key_clear(KEY_FILE); break;
1184 case 0x196: map_key_clear(KEY_WWW); break;
1185 case 0x199: map_key_clear(KEY_CHAT); break;
1186 case 0x19c: map_key_clear(KEY_LOGOFF); break;
1187 case 0x19e: map_key_clear(KEY_COFFEE); break;
1188 case 0x19f: map_key_clear(KEY_CONTROLPANEL); break;
1189 case 0x1a2: map_key_clear(KEY_APPSELECT); break;
1190 case 0x1a3: map_key_clear(KEY_NEXT); break;
1191 case 0x1a4: map_key_clear(KEY_PREVIOUS); break;
1192 case 0x1a6: map_key_clear(KEY_HELP); break;
1193 case 0x1a7: map_key_clear(KEY_DOCUMENTS); break;
1194 case 0x1ab: map_key_clear(KEY_SPELLCHECK); break;
1195 case 0x1ae: map_key_clear(KEY_KEYBOARD); break;
1196 case 0x1b1: map_key_clear(KEY_SCREENSAVER); break;
1197 case 0x1b4: map_key_clear(KEY_FILE); break;
1198 case 0x1b6: map_key_clear(KEY_IMAGES); break;
1199 case 0x1b7: map_key_clear(KEY_AUDIO); break;
1200 case 0x1b8: map_key_clear(KEY_VIDEO); break;
1201 case 0x1bc: map_key_clear(KEY_MESSENGER); break;
1202 case 0x1bd: map_key_clear(KEY_INFO); break;
1203 case 0x1cb: map_key_clear(KEY_ASSISTANT); break;
1204 case 0x201: map_key_clear(KEY_NEW); break;
1205 case 0x202: map_key_clear(KEY_OPEN); break;
1206 case 0x203: map_key_clear(KEY_CLOSE); break;
1207 case 0x204: map_key_clear(KEY_EXIT); break;
1208 case 0x207: map_key_clear(KEY_SAVE); break;
1209 case 0x208: map_key_clear(KEY_PRINT); break;
1210 case 0x209: map_key_clear(KEY_PROPS); break;
1211 case 0x21a: map_key_clear(KEY_UNDO); break;
1212 case 0x21b: map_key_clear(KEY_COPY); break;
1213 case 0x21c: map_key_clear(KEY_CUT); break;
1214 case 0x21d: map_key_clear(KEY_PASTE); break;
1215 case 0x21f: map_key_clear(KEY_FIND); break;
1216 case 0x221: map_key_clear(KEY_SEARCH); break;
1217 case 0x222: map_key_clear(KEY_GOTO); break;
1218 case 0x223: map_key_clear(KEY_HOMEPAGE); break;
1219 case 0x224: map_key_clear(KEY_BACK); break;
1220 case 0x225: map_key_clear(KEY_FORWARD); break;
1221 case 0x226: map_key_clear(KEY_STOP); break;
1222 case 0x227: map_key_clear(KEY_REFRESH); break;
1223 case 0x22a: map_key_clear(KEY_BOOKMARKS); break;
1224 case 0x22d: map_key_clear(KEY_ZOOMIN); break;
1225 case 0x22e: map_key_clear(KEY_ZOOMOUT); break;
1226 case 0x22f: map_key_clear(KEY_ZOOMRESET); break;
1227 case 0x232: map_key_clear(KEY_FULL_SCREEN); break;
1228 case 0x233: map_key_clear(KEY_SCROLLUP); break;
1229 case 0x234: map_key_clear(KEY_SCROLLDOWN); break;
1230 case 0x238: /* AC Pan */
1231 set_bit(REL_HWHEEL, input->relbit);
1232 map_rel(REL_HWHEEL_HI_RES);
1234 case 0x23d: map_key_clear(KEY_EDIT); break;
1235 case 0x25f: map_key_clear(KEY_CANCEL); break;
1236 case 0x269: map_key_clear(KEY_INSERT); break;
1237 case 0x26a: map_key_clear(KEY_DELETE); break;
1238 case 0x279: map_key_clear(KEY_REDO); break;
1240 case 0x289: map_key_clear(KEY_REPLY); break;
1241 case 0x28b: map_key_clear(KEY_FORWARDMAIL); break;
1242 case 0x28c: map_key_clear(KEY_SEND); break;
1244 case 0x29d: map_key_clear(KEY_KBD_LAYOUT_NEXT); break;
1246 case 0x2a2: map_key_clear(KEY_ALL_APPLICATIONS); break;
1248 case 0x2c7: map_key_clear(KEY_KBDINPUTASSIST_PREV); break;
1249 case 0x2c8: map_key_clear(KEY_KBDINPUTASSIST_NEXT); break;
1250 case 0x2c9: map_key_clear(KEY_KBDINPUTASSIST_PREVGROUP); break;
1251 case 0x2ca: map_key_clear(KEY_KBDINPUTASSIST_NEXTGROUP); break;
1252 case 0x2cb: map_key_clear(KEY_KBDINPUTASSIST_ACCEPT); break;
1253 case 0x2cc: map_key_clear(KEY_KBDINPUTASSIST_CANCEL); break;
1255 case 0x29f: map_key_clear(KEY_SCALE); break;
1257 default: map_key_clear(KEY_UNKNOWN);
1261 case HID_UP_GENDEVCTRLS:
1262 switch (usage->hid) {
1263 case HID_DC_BATTERYSTRENGTH:
1264 hidinput_setup_battery(device, HID_INPUT_REPORT, field, false);
1265 usage->type = EV_PWR;
1270 case HID_UP_BATTERY:
1271 switch (usage->hid) {
1272 case HID_BAT_ABSOLUTESTATEOFCHARGE:
1273 hidinput_setup_battery(device, HID_INPUT_REPORT, field, true);
1274 usage->type = EV_PWR;
1276 case HID_BAT_CHARGING:
1277 usage->type = EV_PWR;
1282 switch (usage->hid & HID_USAGE) {
1284 map_key_clear(KEY_CAMERA_FOCUS); break;
1286 map_key_clear(KEY_CAMERA); break;
1292 case HID_UP_HPVENDOR: /* Reported on a Dutch layout HP5308 */
1293 set_bit(EV_REP, input->evbit);
1294 switch (usage->hid & HID_USAGE) {
1295 case 0x021: map_key_clear(KEY_PRINT); break;
1296 case 0x070: map_key_clear(KEY_HP); break;
1297 case 0x071: map_key_clear(KEY_CAMERA); break;
1298 case 0x072: map_key_clear(KEY_SOUND); break;
1299 case 0x073: map_key_clear(KEY_QUESTION); break;
1300 case 0x080: map_key_clear(KEY_EMAIL); break;
1301 case 0x081: map_key_clear(KEY_CHAT); break;
1302 case 0x082: map_key_clear(KEY_SEARCH); break;
1303 case 0x083: map_key_clear(KEY_CONNECT); break;
1304 case 0x084: map_key_clear(KEY_FINANCE); break;
1305 case 0x085: map_key_clear(KEY_SPORT); break;
1306 case 0x086: map_key_clear(KEY_SHOP); break;
1307 default: goto ignore;
1311 case HID_UP_HPVENDOR2:
1312 set_bit(EV_REP, input->evbit);
1313 switch (usage->hid & HID_USAGE) {
1314 case 0x001: map_key_clear(KEY_MICMUTE); break;
1315 case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN); break;
1316 case 0x004: map_key_clear(KEY_BRIGHTNESSUP); break;
1317 default: goto ignore;
1321 case HID_UP_MSVENDOR:
1324 case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
1325 set_bit(EV_REP, input->evbit);
1328 case HID_UP_LOGIVENDOR:
1329 /* intentional fallback */
1330 case HID_UP_LOGIVENDOR2:
1331 /* intentional fallback */
1332 case HID_UP_LOGIVENDOR3:
1336 switch (usage->hid & HID_USAGE) {
1337 case 0xa4: map_key_clear(BTN_DEAD); break;
1338 default: goto ignore;
1344 if (field->report_size == 1) {
1345 if (field->report->type == HID_OUTPUT_REPORT) {
1352 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
1361 /* Mapping failed, bail out */
1365 if (device->driver->input_mapped &&
1366 device->driver->input_mapped(device, hidinput, field, usage,
1369 * The driver indicated that no further generic handling
1370 * of the usage is desired.
1375 set_bit(usage->type, input->evbit);
1378 * This part is *really* controversial:
1379 * - HID aims at being generic so we should do our best to export
1380 * all incoming events
1381 * - HID describes what events are, so there is no reason for ABS_X
1382 * to be mapped to ABS_Y
1383 * - HID is using *_MISC+N as a default value, but nothing prevents
1384 * *_MISC+N to overwrite a legitimate even, which confuses userspace
1385 * (for instance ABS_MISC + 7 is ABS_MT_SLOT, which has a different
1388 * If devices still want to use this (at their own risk), they will
1389 * have to use the quirk HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE, but
1390 * the default should be a reliable mapping.
1392 while (usage->code <= max && test_and_set_bit(usage->code, bit)) {
1393 if (device->quirks & HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE) {
1394 usage->code = find_next_zero_bit(bit,
1398 device->status |= HID_STAT_DUP_DETECTED;
1403 if (usage->code > max)
1406 if (usage->type == EV_ABS) {
1408 int a = field->logical_minimum;
1409 int b = field->logical_maximum;
1411 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
1412 a = field->logical_minimum = 0;
1413 b = field->logical_maximum = 255;
1416 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
1417 input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
1418 else input_set_abs_params(input, usage->code, a, b, 0, 0);
1420 input_abs_set_res(input, usage->code,
1421 hidinput_calc_abs_res(field, usage->code));
1423 /* use a larger default input buffer for MT devices */
1424 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
1425 input_set_events_per_packet(input, 60);
1428 if (usage->type == EV_ABS &&
1429 (usage->hat_min < usage->hat_max || usage->hat_dir)) {
1431 for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
1432 input_set_abs_params(input, i, -1, 1, 0, 0);
1433 set_bit(i, input->absbit);
1435 if (usage->hat_dir && !field->dpad)
1436 field->dpad = usage->code;
1439 /* for those devices which produce Consumer volume usage as relative,
1440 * we emulate pressing volumeup/volumedown appropriate number of times
1441 * in hidinput_hid_event()
1443 if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1444 (usage->code == ABS_VOLUME)) {
1445 set_bit(KEY_VOLUMEUP, input->keybit);
1446 set_bit(KEY_VOLUMEDOWN, input->keybit);
1449 if (usage->type == EV_KEY) {
1450 set_bit(EV_MSC, input->evbit);
1451 set_bit(MSC_SCAN, input->mscbit);
1461 static void hidinput_handle_scroll(struct hid_usage *usage,
1462 struct input_dev *input,
1471 if (usage->code == REL_WHEEL_HI_RES)
1477 * Windows reports one wheel click as value 120. Where a high-res
1478 * scroll wheel is present, a fraction of 120 is reported instead.
1479 * Our REL_WHEEL_HI_RES axis does the same because all HW must
1480 * adhere to the 120 expectation.
1482 hi_res = value * 120/usage->resolution_multiplier;
1484 usage->wheel_accumulated += hi_res;
1485 lo_res = usage->wheel_accumulated/120;
1487 usage->wheel_accumulated -= lo_res * 120;
1489 input_event(input, EV_REL, code, lo_res);
1490 input_event(input, EV_REL, usage->code, hi_res);
1493 static void hid_report_release_tool(struct hid_report *report, struct input_dev *input,
1496 /* if the given tool is not currently reported, ignore */
1497 if (!test_bit(tool, input->key))
1501 * if the given tool was previously set, release it,
1502 * release any TOUCH and send an EV_SYN
1504 input_event(input, EV_KEY, BTN_TOUCH, 0);
1505 input_event(input, EV_KEY, tool, 0);
1506 input_event(input, EV_SYN, SYN_REPORT, 0);
1511 static void hid_report_set_tool(struct hid_report *report, struct input_dev *input,
1512 unsigned int new_tool)
1514 if (report->tool != new_tool)
1515 hid_report_release_tool(report, input, report->tool);
1517 input_event(input, EV_KEY, new_tool, 1);
1518 report->tool = new_tool;
1521 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
1523 struct input_dev *input;
1524 struct hid_report *report = field->report;
1525 unsigned *quirks = &hid->quirks;
1530 if (usage->type == EV_PWR) {
1531 bool handled = hidinput_set_battery_charge_status(hid, usage->hid, value);
1534 hidinput_update_battery(hid, value);
1539 if (!field->hidinput)
1542 input = field->hidinput->input;
1544 if (usage->hat_min < usage->hat_max || usage->hat_dir) {
1545 int hat_dir = usage->hat_dir;
1547 hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
1548 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
1549 input_event(input, usage->type, usage->code , hid_hat_to_axis[hat_dir].x);
1550 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
1555 * Ignore out-of-range values as per HID specification,
1556 * section 5.10 and 6.2.25, when NULL state bit is present.
1557 * When it's not, clamp the value to match Microsoft's input
1558 * driver as mentioned in "Required HID usages for digitizers":
1559 * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp
1561 * The logical_minimum < logical_maximum check is done so that we
1562 * don't unintentionally discard values sent by devices which
1563 * don't specify logical min and max.
1565 if ((field->flags & HID_MAIN_ITEM_VARIABLE) &&
1566 field->logical_minimum < field->logical_maximum) {
1567 if (field->flags & HID_MAIN_ITEM_NULL_STATE &&
1568 (value < field->logical_minimum ||
1569 value > field->logical_maximum)) {
1570 dbg_hid("Ignoring out-of-range value %x\n", value);
1573 value = clamp(value,
1574 field->logical_minimum,
1575 field->logical_maximum);
1578 switch (usage->hid) {
1580 report->tool_active |= !!value;
1583 * if eraser is set, we must enforce BTN_TOOL_RUBBER
1584 * to accommodate for devices not following the spec.
1587 hid_report_set_tool(report, input, BTN_TOOL_RUBBER);
1588 else if (report->tool != BTN_TOOL_RUBBER)
1589 /* value is off, tool is not rubber, ignore */
1591 else if (*quirks & HID_QUIRK_NOINVERT &&
1592 !test_bit(BTN_TOUCH, input->key)) {
1594 * There is no invert to release the tool, let hid_input
1595 * send BTN_TOUCH with scancode and release the tool after.
1597 hid_report_release_tool(report, input, BTN_TOOL_RUBBER);
1601 /* let hid-input set BTN_TOUCH */
1605 report->tool_active |= !!value;
1608 * If invert is set, we store BTN_TOOL_RUBBER.
1611 hid_report_set_tool(report, input, BTN_TOOL_RUBBER);
1612 else if (!report->tool_active)
1613 /* tool_active not set means Invert and Eraser are not set */
1614 hid_report_release_tool(report, input, BTN_TOOL_RUBBER);
1616 /* no further processing */
1619 case HID_DG_INRANGE:
1620 report->tool_active |= !!value;
1622 if (report->tool_active) {
1624 * if tool is not set but is marked as active,
1628 report->tool = usage->code;
1630 /* drivers may have changed the value behind our back, resend it */
1631 hid_report_set_tool(report, input, report->tool);
1633 hid_report_release_tool(report, input, usage->code);
1636 /* reset tool_active for the next event */
1637 report->tool_active = false;
1639 /* no further processing */
1642 case HID_DG_TIPSWITCH:
1643 report->tool_active |= !!value;
1645 /* if tool is set to RUBBER we should ignore the current value */
1646 if (report->tool == BTN_TOOL_RUBBER)
1651 case HID_DG_TIPPRESSURE:
1652 if (*quirks & HID_QUIRK_NOTOUCH) {
1653 int a = field->logical_minimum;
1654 int b = field->logical_maximum;
1656 if (value > a + ((b - a) >> 3)) {
1657 input_event(input, EV_KEY, BTN_TOUCH, 1);
1658 report->tool_active = true;
1663 case HID_UP_PID | 0x83UL: /* Simultaneous Effects Max */
1664 dbg_hid("Maximum Effects - %d\n",value);
1667 case HID_UP_PID | 0x7fUL:
1668 dbg_hid("PID Pool Report\n");
1672 switch (usage->type) {
1674 if (usage->code == 0) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1679 if (usage->code == REL_WHEEL_HI_RES ||
1680 usage->code == REL_HWHEEL_HI_RES) {
1681 hidinput_handle_scroll(usage, input, value);
1687 if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1688 usage->code == ABS_VOLUME) {
1689 int count = abs(value);
1690 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
1693 for (i = 0; i < count; i++) {
1694 input_event(input, EV_KEY, direction, 1);
1696 input_event(input, EV_KEY, direction, 0);
1701 } else if (((*quirks & HID_QUIRK_X_INVERT) && usage->code == ABS_X) ||
1702 ((*quirks & HID_QUIRK_Y_INVERT) && usage->code == ABS_Y))
1703 value = field->logical_maximum - value;
1708 * Ignore reports for absolute data if the data didn't change. This is
1709 * not only an optimization but also fixes 'dead' key reports. Some
1710 * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID
1711 * 0x31 and 0x32) report multiple keys, even though a localized keyboard
1712 * can only have one of them physically available. The 'dead' keys
1713 * report constant 0. As all map to the same keycode, they'd confuse
1714 * the input layer. If we filter the 'dead' keys on the HID level, we
1715 * skip the keycode translation and only forward real events.
1717 if (!(field->flags & (HID_MAIN_ITEM_RELATIVE |
1718 HID_MAIN_ITEM_BUFFERED_BYTE)) &&
1719 (field->flags & HID_MAIN_ITEM_VARIABLE) &&
1720 usage->usage_index < field->maxusage &&
1721 value == field->value[usage->usage_index])
1724 /* report the usage code as scancode if the key status has changed */
1725 if (usage->type == EV_KEY &&
1726 (!test_bit(usage->code, input->key)) == value)
1727 input_event(input, EV_MSC, MSC_SCAN, usage->hid);
1729 input_event(input, usage->type, usage->code, value);
1731 if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1732 usage->type == EV_KEY && value) {
1734 input_event(input, usage->type, usage->code, 0);
1738 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
1740 struct hid_input *hidinput;
1742 if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
1745 list_for_each_entry(hidinput, &hid->inputs, list)
1746 input_sync(hidinput->input);
1748 EXPORT_SYMBOL_GPL(hidinput_report_event);
1750 static int hidinput_find_field(struct hid_device *hid, unsigned int type,
1751 unsigned int code, struct hid_field **field)
1753 struct hid_report *report;
1756 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
1757 for (i = 0; i < report->maxfield; i++) {
1758 *field = report->field[i];
1759 for (j = 0; j < (*field)->maxusage; j++)
1760 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1767 struct hid_field *hidinput_get_led_field(struct hid_device *hid)
1769 struct hid_report *report;
1770 struct hid_field *field;
1773 list_for_each_entry(report,
1774 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1776 for (i = 0; i < report->maxfield; i++) {
1777 field = report->field[i];
1778 for (j = 0; j < field->maxusage; j++)
1779 if (field->usage[j].type == EV_LED)
1785 EXPORT_SYMBOL_GPL(hidinput_get_led_field);
1787 unsigned int hidinput_count_leds(struct hid_device *hid)
1789 struct hid_report *report;
1790 struct hid_field *field;
1792 unsigned int count = 0;
1794 list_for_each_entry(report,
1795 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1797 for (i = 0; i < report->maxfield; i++) {
1798 field = report->field[i];
1799 for (j = 0; j < field->maxusage; j++)
1800 if (field->usage[j].type == EV_LED &&
1807 EXPORT_SYMBOL_GPL(hidinput_count_leds);
1809 static void hidinput_led_worker(struct work_struct *work)
1811 struct hid_device *hid = container_of(work, struct hid_device,
1813 struct hid_field *field;
1814 struct hid_report *report;
1819 field = hidinput_get_led_field(hid);
1824 * field->report is accessed unlocked regarding HID core. So there might
1825 * be another incoming SET-LED request from user-space, which changes
1826 * the LED state while we assemble our outgoing buffer. However, this
1827 * doesn't matter as hid_output_report() correctly converts it into a
1828 * boolean value no matter what information is currently set on the LED
1829 * field (even garbage). So the remote device will always get a valid
1831 * And in case we send a wrong value, a next led worker is spawned
1832 * for every SET-LED request so the following worker will send the
1833 * correct value, guaranteed!
1836 report = field->report;
1838 /* use custom SET_REPORT request if possible (asynchronous) */
1839 if (hid->ll_driver->request)
1840 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT);
1842 /* fall back to generic raw-output-report */
1843 len = hid_report_len(report);
1844 buf = hid_alloc_report_buf(report, GFP_KERNEL);
1848 hid_output_report(report, buf);
1849 /* synchronous output report */
1850 ret = hid_hw_output_report(hid, buf, len);
1852 hid_hw_raw_request(hid, report->id, buf, len, HID_OUTPUT_REPORT,
1853 HID_REQ_SET_REPORT);
1857 static int hidinput_input_event(struct input_dev *dev, unsigned int type,
1858 unsigned int code, int value)
1860 struct hid_device *hid = input_get_drvdata(dev);
1861 struct hid_field *field;
1865 return input_ff_event(dev, type, code, value);
1870 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
1871 hid_warn(dev, "event field not found\n");
1875 hid_set_field(field, offset, value);
1877 schedule_work(&hid->led_work);
1881 static int hidinput_open(struct input_dev *dev)
1883 struct hid_device *hid = input_get_drvdata(dev);
1885 return hid_hw_open(hid);
1888 static void hidinput_close(struct input_dev *dev)
1890 struct hid_device *hid = input_get_drvdata(dev);
1895 static bool __hidinput_change_resolution_multipliers(struct hid_device *hid,
1896 struct hid_report *report, bool use_logical_max)
1898 struct hid_usage *usage;
1899 bool update_needed = false;
1900 bool get_report_completed = false;
1903 if (report->maxfield == 0)
1906 for (i = 0; i < report->maxfield; i++) {
1907 __s32 value = use_logical_max ?
1908 report->field[i]->logical_maximum :
1909 report->field[i]->logical_minimum;
1911 /* There is no good reason for a Resolution
1912 * Multiplier to have a count other than 1.
1915 if (report->field[i]->report_count != 1)
1918 for (j = 0; j < report->field[i]->maxusage; j++) {
1919 usage = &report->field[i]->usage[j];
1921 if (usage->hid != HID_GD_RESOLUTION_MULTIPLIER)
1925 * If we have more than one feature within this
1926 * report we need to fill in the bits from the
1927 * others before we can overwrite the ones for the
1928 * Resolution Multiplier.
1930 * But if we're not allowed to read from the device,
1931 * we just bail. Such a device should not exist
1934 if (!get_report_completed && report->maxfield > 1) {
1935 if (hid->quirks & HID_QUIRK_NO_INIT_REPORTS)
1936 return update_needed;
1938 hid_hw_request(hid, report, HID_REQ_GET_REPORT);
1940 get_report_completed = true;
1943 report->field[i]->value[j] = value;
1944 update_needed = true;
1948 return update_needed;
1951 static void hidinput_change_resolution_multipliers(struct hid_device *hid)
1953 struct hid_report_enum *rep_enum;
1954 struct hid_report *rep;
1957 rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1958 list_for_each_entry(rep, &rep_enum->report_list, list) {
1959 bool update_needed = __hidinput_change_resolution_multipliers(hid,
1962 if (update_needed) {
1963 ret = __hid_request(hid, rep, HID_REQ_SET_REPORT);
1965 __hidinput_change_resolution_multipliers(hid,
1972 /* refresh our structs */
1973 hid_setup_resolution_multiplier(hid);
1976 static void report_features(struct hid_device *hid)
1978 struct hid_driver *drv = hid->driver;
1979 struct hid_report_enum *rep_enum;
1980 struct hid_report *rep;
1981 struct hid_usage *usage;
1984 rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1985 list_for_each_entry(rep, &rep_enum->report_list, list)
1986 for (i = 0; i < rep->maxfield; i++) {
1987 /* Ignore if report count is out of bounds. */
1988 if (rep->field[i]->report_count < 1)
1991 for (j = 0; j < rep->field[i]->maxusage; j++) {
1992 usage = &rep->field[i]->usage[j];
1994 /* Verify if Battery Strength feature is available */
1995 if (usage->hid == HID_DC_BATTERYSTRENGTH)
1996 hidinput_setup_battery(hid, HID_FEATURE_REPORT,
1997 rep->field[i], false);
1999 if (drv->feature_mapping)
2000 drv->feature_mapping(hid, rep->field[i], usage);
2005 static struct hid_input *hidinput_allocate(struct hid_device *hid,
2006 unsigned int application)
2008 struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
2009 struct input_dev *input_dev = input_allocate_device();
2010 const char *suffix = NULL;
2011 size_t suffix_len, name_len;
2013 if (!hidinput || !input_dev)
2016 if ((hid->quirks & HID_QUIRK_INPUT_PER_APP) &&
2017 hid->maxapplication > 1) {
2018 switch (application) {
2019 case HID_GD_KEYBOARD:
2020 suffix = "Keyboard";
2030 * yes, there is an issue here:
2031 * DG_PEN -> "Stylus"
2032 * DG_STYLUS -> "Pen"
2033 * But changing this now means users with config snippets
2034 * will have to change it and the test suite will not be happy.
2041 case HID_DG_TOUCHSCREEN:
2042 suffix = "Touchscreen";
2044 case HID_DG_TOUCHPAD:
2045 suffix = "Touchpad";
2047 case HID_GD_SYSTEM_CONTROL:
2048 suffix = "System Control";
2050 case HID_CP_CONSUMER_CONTROL:
2051 suffix = "Consumer Control";
2053 case HID_GD_WIRELESS_RADIO_CTLS:
2054 suffix = "Wireless Radio Control";
2056 case HID_GD_SYSTEM_MULTIAXIS:
2057 suffix = "System Multi Axis";
2065 name_len = strlen(hid->name);
2066 suffix_len = strlen(suffix);
2067 if ((name_len < suffix_len) ||
2068 strcmp(hid->name + name_len - suffix_len, suffix)) {
2069 hidinput->name = kasprintf(GFP_KERNEL, "%s %s",
2071 if (!hidinput->name)
2076 input_set_drvdata(input_dev, hid);
2077 input_dev->event = hidinput_input_event;
2078 input_dev->open = hidinput_open;
2079 input_dev->close = hidinput_close;
2080 input_dev->setkeycode = hidinput_setkeycode;
2081 input_dev->getkeycode = hidinput_getkeycode;
2083 input_dev->name = hidinput->name ? hidinput->name : hid->name;
2084 input_dev->phys = hid->phys;
2085 input_dev->uniq = hid->uniq;
2086 input_dev->id.bustype = hid->bus;
2087 input_dev->id.vendor = hid->vendor;
2088 input_dev->id.product = hid->product;
2089 input_dev->id.version = hid->version;
2090 input_dev->dev.parent = &hid->dev;
2092 hidinput->input = input_dev;
2093 hidinput->application = application;
2094 list_add_tail(&hidinput->list, &hid->inputs);
2096 INIT_LIST_HEAD(&hidinput->reports);
2102 input_free_device(input_dev);
2103 hid_err(hid, "Out of memory during hid input probe\n");
2107 static bool hidinput_has_been_populated(struct hid_input *hidinput)
2110 unsigned long r = 0;
2112 for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++)
2113 r |= hidinput->input->evbit[i];
2115 for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++)
2116 r |= hidinput->input->keybit[i];
2118 for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++)
2119 r |= hidinput->input->relbit[i];
2121 for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++)
2122 r |= hidinput->input->absbit[i];
2124 for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++)
2125 r |= hidinput->input->mscbit[i];
2127 for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++)
2128 r |= hidinput->input->ledbit[i];
2130 for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++)
2131 r |= hidinput->input->sndbit[i];
2133 for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++)
2134 r |= hidinput->input->ffbit[i];
2136 for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++)
2137 r |= hidinput->input->swbit[i];
2142 static void hidinput_cleanup_hidinput(struct hid_device *hid,
2143 struct hid_input *hidinput)
2145 struct hid_report *report;
2148 list_del(&hidinput->list);
2149 input_free_device(hidinput->input);
2150 kfree(hidinput->name);
2152 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
2153 if (k == HID_OUTPUT_REPORT &&
2154 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
2157 list_for_each_entry(report, &hid->report_enum[k].report_list,
2160 for (i = 0; i < report->maxfield; i++)
2161 if (report->field[i]->hidinput == hidinput)
2162 report->field[i]->hidinput = NULL;
2169 static struct hid_input *hidinput_match(struct hid_report *report)
2171 struct hid_device *hid = report->device;
2172 struct hid_input *hidinput;
2174 list_for_each_entry(hidinput, &hid->inputs, list) {
2175 if (hidinput->report &&
2176 hidinput->report->id == report->id)
2183 static struct hid_input *hidinput_match_application(struct hid_report *report)
2185 struct hid_device *hid = report->device;
2186 struct hid_input *hidinput;
2188 list_for_each_entry(hidinput, &hid->inputs, list) {
2189 if (hidinput->application == report->application)
2193 * Keep SystemControl and ConsumerControl applications together
2194 * with the main keyboard, if present.
2196 if ((report->application == HID_GD_SYSTEM_CONTROL ||
2197 report->application == HID_CP_CONSUMER_CONTROL) &&
2198 hidinput->application == HID_GD_KEYBOARD) {
2206 static inline void hidinput_configure_usages(struct hid_input *hidinput,
2207 struct hid_report *report)
2210 int first_field_index = 0;
2211 int slot_collection_index = -1;
2212 int prev_collection_index = -1;
2213 unsigned int slot_idx = 0;
2214 struct hid_field *field;
2217 * First tag all the fields that are part of a slot,
2218 * a slot needs to have one Contact ID in the collection
2220 for (i = 0; i < report->maxfield; i++) {
2221 field = report->field[i];
2223 /* ignore fields without usage */
2224 if (field->maxusage < 1)
2228 * janitoring when collection_index changes
2230 if (prev_collection_index != field->usage->collection_index) {
2231 prev_collection_index = field->usage->collection_index;
2232 first_field_index = i;
2236 * if we already found a Contact ID in the collection,
2237 * tag and continue to the next.
2239 if (slot_collection_index == field->usage->collection_index) {
2240 field->slot_idx = slot_idx;
2244 /* check if the current field has Contact ID */
2245 for (j = 0; j < field->maxusage; j++) {
2246 if (field->usage[j].hid == HID_DG_CONTACTID) {
2247 slot_collection_index = field->usage->collection_index;
2251 * mark all previous fields and this one in the
2252 * current collection to be slotted.
2254 for (k = first_field_index; k <= i; k++)
2255 report->field[k]->slot_idx = slot_idx;
2261 for (i = 0; i < report->maxfield; i++)
2262 for (j = 0; j < report->field[i]->maxusage; j++)
2263 hidinput_configure_usage(hidinput, report->field[i],
2264 report->field[i]->usage + j,
2269 * Register the input device; print a message.
2270 * Configure the input layer interface
2271 * Read all reports and initialize the absolute field values.
2274 int hidinput_connect(struct hid_device *hid, unsigned int force)
2276 struct hid_driver *drv = hid->driver;
2277 struct hid_report *report;
2278 struct hid_input *next, *hidinput = NULL;
2279 unsigned int application;
2282 INIT_LIST_HEAD(&hid->inputs);
2283 INIT_WORK(&hid->led_work, hidinput_led_worker);
2285 hid->status &= ~HID_STAT_DUP_DETECTED;
2288 for (i = 0; i < hid->maxcollection; i++) {
2289 struct hid_collection *col = &hid->collection[i];
2290 if (col->type == HID_COLLECTION_APPLICATION ||
2291 col->type == HID_COLLECTION_PHYSICAL)
2292 if (IS_INPUT_APPLICATION(col->usage))
2296 if (i == hid->maxcollection)
2300 report_features(hid);
2302 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
2303 if (k == HID_OUTPUT_REPORT &&
2304 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
2307 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
2309 if (!report->maxfield)
2312 application = report->application;
2315 * Find the previous hidinput report attached
2316 * to this report id.
2318 if (hid->quirks & HID_QUIRK_MULTI_INPUT)
2319 hidinput = hidinput_match(report);
2320 else if (hid->maxapplication > 1 &&
2321 (hid->quirks & HID_QUIRK_INPUT_PER_APP))
2322 hidinput = hidinput_match_application(report);
2325 hidinput = hidinput_allocate(hid, application);
2330 hidinput_configure_usages(hidinput, report);
2332 if (hid->quirks & HID_QUIRK_MULTI_INPUT)
2333 hidinput->report = report;
2335 list_add_tail(&report->hidinput_list,
2336 &hidinput->reports);
2340 hidinput_change_resolution_multipliers(hid);
2342 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
2343 if (drv->input_configured &&
2344 drv->input_configured(hid, hidinput))
2347 if (!hidinput_has_been_populated(hidinput)) {
2348 /* no need to register an input device not populated */
2349 hidinput_cleanup_hidinput(hid, hidinput);
2353 if (input_register_device(hidinput->input))
2355 hidinput->registered = true;
2358 if (list_empty(&hid->inputs)) {
2359 hid_err(hid, "No inputs registered, leaving\n");
2363 if (hid->status & HID_STAT_DUP_DETECTED)
2365 "Some usages could not be mapped, please use HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE if this is legitimate.\n");
2370 /* unwind the ones we already registered */
2371 hidinput_disconnect(hid);
2375 EXPORT_SYMBOL_GPL(hidinput_connect);
2377 void hidinput_disconnect(struct hid_device *hid)
2379 struct hid_input *hidinput, *next;
2381 hidinput_cleanup_battery(hid);
2383 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
2384 list_del(&hidinput->list);
2385 if (hidinput->registered)
2386 input_unregister_device(hidinput->input);
2388 input_free_device(hidinput->input);
2389 kfree(hidinput->name);
2393 /* led_work is spawned by input_dev callbacks, but doesn't access the
2394 * parent input_dev at all. Once all input devices are removed, we
2395 * know that led_work will never get restarted, so we can cancel it
2396 * synchronously and are safe. */
2397 cancel_work_sync(&hid->led_work);
2399 EXPORT_SYMBOL_GPL(hidinput_disconnect);
2401 #ifdef CONFIG_HID_KUNIT_TEST
2402 #include "hid-input-test.c"