1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Copyright (c) 2000-2001 Vojtech Pavlik 4 * Copyright (c) 2006-2010 Jiri Kosina 5 * 6 * HID to Linux Input mapping 7 */ 8 9 /* 10 * 11 * Should you need to contact me, the author, you can do so either by 12 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail: 13 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic 14 */ 15 16 #include <linux/module.h> 17 #include <linux/slab.h> 18 #include <linux/kernel.h> 19 20 #include <linux/hid.h> 21 #include <linux/hid-debug.h> 22 23 #include "hid-ids.h" 24 25 #define unk KEY_UNKNOWN 26 27 static const unsigned char hid_keyboard[256] = { 28 0, 0, 0, 0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36, 37, 38, 29 50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45, 21, 44, 2, 3, 30 4, 5, 6, 7, 8, 9, 10, 11, 28, 1, 14, 15, 57, 12, 13, 26, 31 27, 43, 43, 39, 40, 41, 51, 52, 53, 58, 59, 60, 61, 62, 63, 64, 32 65, 66, 67, 68, 87, 88, 99, 70,119,110,102,104,111,107,109,106, 33 105,108,103, 69, 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71, 34 72, 73, 82, 83, 86,127,116,117,183,184,185,186,187,188,189,190, 35 191,192,193,194,134,138,130,132,128,129,131,137,133,135,136,113, 36 115,114,unk,unk,unk,121,unk, 89, 93,124, 92, 94, 95,unk,unk,unk, 37 122,123, 90, 91, 85,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk, 38 unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk, 39 unk,unk,unk,unk,unk,unk,179,180,unk,unk,unk,unk,unk,unk,unk,unk, 40 unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk, 41 unk,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,unk,unk,unk,unk, 42 29, 42, 56,125, 97, 54,100,126,164,166,165,163,161,115,114,113, 43 150,158,159,128,136,177,178,176,142,152,173,140,unk,unk,unk,unk 44 }; 45 46 static const struct { 47 __s32 x; 48 __s32 y; 49 } hid_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}}; 50 51 struct usage_priority { 52 __u32 usage; /* the HID usage associated */ 53 bool global; /* we assume all usages to be slotted, 54 * unless global 55 */ 56 unsigned int slot_overwrite; /* for globals: allows to set the usage 57 * before or after the slots 58 */ 59 }; 60 61 /* 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). 66 * 67 * hid-input will then shift the priority by 8 bits to leave some space 68 * in case drivers want to interleave other fields. 69 * 70 * To accommodate slotted devices, the slot priority is 71 * defined in the next 8 bits (defined by 0xff - slot). 72 * 73 * If drivers want to add fields before those, hid-input will 74 * leave out the first 8 bits of the priority value. 75 * 76 * This still leaves us 65535 individual priority values. 77 */ 78 static const struct usage_priority hidinput_usages_priorities[] = { 79 { /* Eraser (eraser touching) must always come before tipswitch */ 80 .usage = HID_DG_ERASER, 81 }, 82 { /* Invert must always come before In Range */ 83 .usage = HID_DG_INVERT, 84 }, 85 { /* Is the tip of the tool touching? */ 86 .usage = HID_DG_TIPSWITCH, 87 }, 88 { /* Tip Pressure might emulate tip switch */ 89 .usage = HID_DG_TIPPRESSURE, 90 }, 91 { /* In Range needs to come after the other tool states */ 92 .usage = HID_DG_INRANGE, 93 }, 94 }; 95 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)) 101 102 #define map_abs_clear(c) hid_map_usage_clear(hidinput, usage, &bit, \ 103 &max, EV_ABS, (c)) 104 #define map_key_clear(c) hid_map_usage_clear(hidinput, usage, &bit, \ 105 &max, EV_KEY, (c)) 106 107 static bool match_scancode(struct hid_usage *usage, 108 unsigned int cur_idx, unsigned int scancode) 109 { 110 return (usage->hid & (HID_USAGE_PAGE | HID_USAGE)) == scancode; 111 } 112 113 static bool match_keycode(struct hid_usage *usage, 114 unsigned int cur_idx, unsigned int keycode) 115 { 116 /* 117 * We should exclude unmapped usages when doing lookup by keycode. 118 */ 119 return (usage->type == EV_KEY && usage->code == keycode); 120 } 121 122 static bool match_index(struct hid_usage *usage, 123 unsigned int cur_idx, unsigned int idx) 124 { 125 return cur_idx == idx; 126 } 127 128 typedef bool (*hid_usage_cmp_t)(struct hid_usage *usage, 129 unsigned int cur_idx, unsigned int val); 130 131 static struct hid_usage *hidinput_find_key(struct hid_device *hid, 132 hid_usage_cmp_t match, 133 unsigned int value, 134 unsigned int *usage_idx) 135 { 136 unsigned int i, j, k, cur_idx = 0; 137 struct hid_report *report; 138 struct hid_usage *usage; 139 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)) { 147 if (usage_idx) 148 *usage_idx = cur_idx; 149 return usage; 150 } 151 cur_idx++; 152 } 153 } 154 } 155 } 156 } 157 return NULL; 158 } 159 160 static struct hid_usage *hidinput_locate_usage(struct hid_device *hid, 161 const struct input_keymap_entry *ke, 162 unsigned int *index) 163 { 164 struct hid_usage *usage; 165 unsigned int scancode; 166 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); 171 else 172 usage = NULL; 173 174 return usage; 175 } 176 177 static int hidinput_getkeycode(struct input_dev *dev, 178 struct input_keymap_entry *ke) 179 { 180 struct hid_device *hid = input_get_drvdata(dev); 181 struct hid_usage *usage; 182 unsigned int scancode, index; 183 184 usage = hidinput_locate_usage(hid, ke, &index); 185 if (usage) { 186 ke->keycode = usage->type == EV_KEY ? 187 usage->code : KEY_RESERVED; 188 ke->index = index; 189 scancode = usage->hid & (HID_USAGE_PAGE | HID_USAGE); 190 ke->len = sizeof(scancode); 191 memcpy(ke->scancode, &scancode, sizeof(scancode)); 192 return 0; 193 } 194 195 return -EINVAL; 196 } 197 198 static int hidinput_setkeycode(struct input_dev *dev, 199 const struct input_keymap_entry *ke, 200 unsigned int *old_keycode) 201 { 202 struct hid_device *hid = input_get_drvdata(dev); 203 struct hid_usage *usage; 204 205 usage = hidinput_locate_usage(hid, ke, NULL); 206 if (usage) { 207 *old_keycode = usage->type == EV_KEY ? 208 usage->code : KEY_RESERVED; 209 usage->type = EV_KEY; 210 usage->code = ke->keycode; 211 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); 216 217 /* 218 * Set the keybit for the old keycode if the old keycode is used 219 * by another key 220 */ 221 if (hidinput_find_key(hid, match_keycode, *old_keycode, NULL)) 222 set_bit(*old_keycode, dev->keybit); 223 224 return 0; 225 } 226 227 return -EINVAL; 228 } 229 230 231 /** 232 * hidinput_calc_abs_res - calculate an absolute axis resolution 233 * @field: the HID report field to calculate resolution for 234 * @code: axis code 235 * 236 * The formula is: 237 * (logical_maximum - logical_minimum) 238 * resolution = ---------------------------------------------------------- 239 * (physical_maximum - physical_minimum) * 10 ^ unit_exponent 240 * 241 * as seen in the HID specification v1.11 6.2.2.7 Global Items. 242 * 243 * Only exponent 1 length units are processed. Centimeters and inches are 244 * converted to millimeters. Degrees are converted to radians. 245 */ 246 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code) 247 { 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; 253 __s32 prev; 254 255 /* Check if the extents are sane */ 256 if (logical_extents <= 0 || physical_extents <= 0) 257 return 0; 258 259 /* 260 * Verify and convert units. 261 * See HID specification v1.11 6.2.2.7 Global Items for unit decoding 262 */ 263 switch (code) { 264 case ABS_X: 265 case ABS_Y: 266 case ABS_Z: 267 case ABS_MT_POSITION_X: 268 case ABS_MT_POSITION_Y: 269 case ABS_MT_TOOL_X: 270 case ABS_MT_TOOL_Y: 271 case ABS_MT_TOUCH_MAJOR: 272 case ABS_MT_TOUCH_MINOR: 273 if (field->unit == 0x11) { /* If centimeters */ 274 /* Convert to millimeters */ 275 unit_exponent += 1; 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) 281 return 0; 282 unit_exponent -= 1; 283 } else { 284 return 0; 285 } 286 break; 287 288 case ABS_RX: 289 case ABS_RY: 290 case ABS_RZ: 291 case ABS_WHEEL: 292 case ABS_TILT_X: 293 case ABS_TILT_Y: 294 if (field->unit == 0x14) { /* If degrees */ 295 /* Convert to radians */ 296 prev = logical_extents; 297 logical_extents *= 573; 298 if (logical_extents < prev) 299 return 0; 300 unit_exponent += 1; 301 } else if (field->unit != 0x12) { /* If not radians */ 302 return 0; 303 } 304 break; 305 306 default: 307 return 0; 308 } 309 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) 315 return 0; 316 } 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) 322 return 0; 323 } 324 325 /* Calculate resolution */ 326 return DIV_ROUND_CLOSEST(logical_extents, physical_extents); 327 } 328 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res); 329 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, 338 }; 339 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 344 static const struct hid_device_id hid_battery_quirks[] = { 345 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 346 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO), 347 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE }, 348 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 349 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI), 350 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE }, 351 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 352 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI), 353 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE }, 354 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 355 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO), 356 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE }, 357 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 358 USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI), 359 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE }, 360 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM, 361 USB_DEVICE_ID_ELECOM_BM084), 362 HID_BATTERY_QUIRK_IGNORE }, 363 { HID_USB_DEVICE(USB_VENDOR_ID_SYMBOL, 364 USB_DEVICE_ID_SYMBOL_SCANNER_3), 365 HID_BATTERY_QUIRK_IGNORE }, 366 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ASUSTEK, 367 USB_DEVICE_ID_ASUSTEK_T100CHI_KEYBOARD), 368 HID_BATTERY_QUIRK_IGNORE }, 369 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 370 USB_DEVICE_ID_LOGITECH_DINOVO_EDGE_KBD), 371 HID_BATTERY_QUIRK_IGNORE }, 372 { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_ASUS_UX550_TOUCHSCREEN), 373 HID_BATTERY_QUIRK_IGNORE }, 374 { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_ASUS_UX550VE_TOUCHSCREEN), 375 HID_BATTERY_QUIRK_IGNORE }, 376 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_ENVY_X360_15), 377 HID_BATTERY_QUIRK_IGNORE }, 378 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_ENVY_X360_15T_DR100), 379 HID_BATTERY_QUIRK_IGNORE }, 380 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_HP_SPECTRE_X360_15), 381 HID_BATTERY_QUIRK_IGNORE }, 382 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_SURFACE_GO_TOUCHSCREEN), 383 HID_BATTERY_QUIRK_IGNORE }, 384 {} 385 }; 386 387 static unsigned find_battery_quirk(struct hid_device *hdev) 388 { 389 unsigned quirks = 0; 390 const struct hid_device_id *match; 391 392 match = hid_match_id(hdev, hid_battery_quirks); 393 if (match != NULL) 394 quirks = match->driver_data; 395 396 return quirks; 397 } 398 399 static int hidinput_scale_battery_capacity(struct hid_device *dev, 400 int value) 401 { 402 if (dev->battery_min < dev->battery_max && 403 value >= dev->battery_min && value <= dev->battery_max) 404 value = ((value - dev->battery_min) * 100) / 405 (dev->battery_max - dev->battery_min); 406 407 return value; 408 } 409 410 static int hidinput_query_battery_capacity(struct hid_device *dev) 411 { 412 u8 *buf; 413 int ret; 414 415 buf = kmalloc(4, GFP_KERNEL); 416 if (!buf) 417 return -ENOMEM; 418 419 ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 4, 420 dev->battery_report_type, HID_REQ_GET_REPORT); 421 if (ret < 2) { 422 kfree(buf); 423 return -ENODATA; 424 } 425 426 ret = hidinput_scale_battery_capacity(dev, buf[1]); 427 kfree(buf); 428 return ret; 429 } 430 431 static int hidinput_get_battery_property(struct power_supply *psy, 432 enum power_supply_property prop, 433 union power_supply_propval *val) 434 { 435 struct hid_device *dev = power_supply_get_drvdata(psy); 436 int value; 437 int ret = 0; 438 439 switch (prop) { 440 case POWER_SUPPLY_PROP_PRESENT: 441 case POWER_SUPPLY_PROP_ONLINE: 442 val->intval = 1; 443 break; 444 445 case POWER_SUPPLY_PROP_CAPACITY: 446 if (dev->battery_status != HID_BATTERY_REPORTED && 447 !dev->battery_avoid_query) { 448 value = hidinput_query_battery_capacity(dev); 449 if (value < 0) 450 return value; 451 } else { 452 value = dev->battery_capacity; 453 } 454 455 val->intval = value; 456 break; 457 458 case POWER_SUPPLY_PROP_MODEL_NAME: 459 val->strval = dev->name; 460 break; 461 462 case POWER_SUPPLY_PROP_STATUS: 463 if (dev->battery_status != HID_BATTERY_REPORTED && 464 !dev->battery_avoid_query) { 465 value = hidinput_query_battery_capacity(dev); 466 if (value < 0) 467 return value; 468 469 dev->battery_capacity = value; 470 dev->battery_status = HID_BATTERY_QUERIED; 471 } 472 473 if (dev->battery_status == HID_BATTERY_UNKNOWN) 474 val->intval = POWER_SUPPLY_STATUS_UNKNOWN; 475 else 476 val->intval = POWER_SUPPLY_STATUS_DISCHARGING; 477 break; 478 479 case POWER_SUPPLY_PROP_SCOPE: 480 val->intval = POWER_SUPPLY_SCOPE_DEVICE; 481 break; 482 483 default: 484 ret = -EINVAL; 485 break; 486 } 487 488 return ret; 489 } 490 491 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type, 492 struct hid_field *field, bool is_percentage) 493 { 494 struct power_supply_desc *psy_desc; 495 struct power_supply_config psy_cfg = { .drv_data = dev, }; 496 unsigned quirks; 497 s32 min, max; 498 int error; 499 500 if (dev->battery) 501 return 0; /* already initialized? */ 502 503 quirks = find_battery_quirk(dev); 504 505 hid_dbg(dev, "device %x:%x:%x %d quirks %d\n", 506 dev->bus, dev->vendor, dev->product, dev->version, quirks); 507 508 if (quirks & HID_BATTERY_QUIRK_IGNORE) 509 return 0; 510 511 psy_desc = kzalloc(sizeof(*psy_desc), GFP_KERNEL); 512 if (!psy_desc) 513 return -ENOMEM; 514 515 psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery", 516 strlen(dev->uniq) ? 517 dev->uniq : dev_name(&dev->dev)); 518 if (!psy_desc->name) { 519 error = -ENOMEM; 520 goto err_free_mem; 521 } 522 523 psy_desc->type = POWER_SUPPLY_TYPE_BATTERY; 524 psy_desc->properties = hidinput_battery_props; 525 psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props); 526 psy_desc->use_for_apm = 0; 527 psy_desc->get_property = hidinput_get_battery_property; 528 529 min = field->logical_minimum; 530 max = field->logical_maximum; 531 532 if (is_percentage || (quirks & HID_BATTERY_QUIRK_PERCENT)) { 533 min = 0; 534 max = 100; 535 } 536 537 if (quirks & HID_BATTERY_QUIRK_FEATURE) 538 report_type = HID_FEATURE_REPORT; 539 540 dev->battery_min = min; 541 dev->battery_max = max; 542 dev->battery_report_type = report_type; 543 dev->battery_report_id = field->report->id; 544 545 /* 546 * Stylus is normally not connected to the device and thus we 547 * can't query the device and get meaningful battery strength. 548 * We have to wait for the device to report it on its own. 549 */ 550 dev->battery_avoid_query = report_type == HID_INPUT_REPORT && 551 field->physical == HID_DG_STYLUS; 552 553 dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg); 554 if (IS_ERR(dev->battery)) { 555 error = PTR_ERR(dev->battery); 556 hid_warn(dev, "can't register power supply: %d\n", error); 557 goto err_free_name; 558 } 559 560 power_supply_powers(dev->battery, &dev->dev); 561 return 0; 562 563 err_free_name: 564 kfree(psy_desc->name); 565 err_free_mem: 566 kfree(psy_desc); 567 dev->battery = NULL; 568 return error; 569 } 570 571 static void hidinput_cleanup_battery(struct hid_device *dev) 572 { 573 const struct power_supply_desc *psy_desc; 574 575 if (!dev->battery) 576 return; 577 578 psy_desc = dev->battery->desc; 579 power_supply_unregister(dev->battery); 580 kfree(psy_desc->name); 581 kfree(psy_desc); 582 dev->battery = NULL; 583 } 584 585 static void hidinput_update_battery(struct hid_device *dev, int value) 586 { 587 int capacity; 588 589 if (!dev->battery) 590 return; 591 592 if (value == 0 || value < dev->battery_min || value > dev->battery_max) 593 return; 594 595 capacity = hidinput_scale_battery_capacity(dev, value); 596 597 if (dev->battery_status != HID_BATTERY_REPORTED || 598 capacity != dev->battery_capacity || 599 ktime_after(ktime_get_coarse(), dev->battery_ratelimit_time)) { 600 dev->battery_capacity = capacity; 601 dev->battery_status = HID_BATTERY_REPORTED; 602 dev->battery_ratelimit_time = 603 ktime_add_ms(ktime_get_coarse(), 30 * 1000); 604 power_supply_changed(dev->battery); 605 } 606 } 607 #else /* !CONFIG_HID_BATTERY_STRENGTH */ 608 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type, 609 struct hid_field *field, bool is_percentage) 610 { 611 return 0; 612 } 613 614 static void hidinput_cleanup_battery(struct hid_device *dev) 615 { 616 } 617 618 static void hidinput_update_battery(struct hid_device *dev, int value) 619 { 620 } 621 #endif /* CONFIG_HID_BATTERY_STRENGTH */ 622 623 static bool hidinput_field_in_collection(struct hid_device *device, struct hid_field *field, 624 unsigned int type, unsigned int usage) 625 { 626 struct hid_collection *collection; 627 628 collection = &device->collection[field->usage->collection_index]; 629 630 return collection->type == type && collection->usage == usage; 631 } 632 633 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field, 634 struct hid_usage *usage, unsigned int usage_index) 635 { 636 struct input_dev *input = hidinput->input; 637 struct hid_device *device = input_get_drvdata(input); 638 const struct usage_priority *usage_priority = NULL; 639 int max = 0, code; 640 unsigned int i = 0; 641 unsigned long *bit = NULL; 642 643 field->hidinput = hidinput; 644 645 if (field->flags & HID_MAIN_ITEM_CONSTANT) 646 goto ignore; 647 648 /* Ignore if report count is out of bounds. */ 649 if (field->report_count < 1) 650 goto ignore; 651 652 /* only LED usages are supported in output fields */ 653 if (field->report_type == HID_OUTPUT_REPORT && 654 (usage->hid & HID_USAGE_PAGE) != HID_UP_LED) { 655 goto ignore; 656 } 657 658 /* assign a priority based on the static list declared here */ 659 for (i = 0; i < ARRAY_SIZE(hidinput_usages_priorities); i++) { 660 if (usage->hid == hidinput_usages_priorities[i].usage) { 661 usage_priority = &hidinput_usages_priorities[i]; 662 663 field->usages_priorities[usage_index] = 664 (ARRAY_SIZE(hidinput_usages_priorities) - i) << 8; 665 break; 666 } 667 } 668 669 /* 670 * For slotted devices, we need to also add the slot index 671 * in the priority. 672 */ 673 if (usage_priority && usage_priority->global) 674 field->usages_priorities[usage_index] |= 675 usage_priority->slot_overwrite; 676 else 677 field->usages_priorities[usage_index] |= 678 (0xff - field->slot_idx) << 16; 679 680 if (device->driver->input_mapping) { 681 int ret = device->driver->input_mapping(device, hidinput, field, 682 usage, &bit, &max); 683 if (ret > 0) 684 goto mapped; 685 if (ret < 0) 686 goto ignore; 687 } 688 689 switch (usage->hid & HID_USAGE_PAGE) { 690 case HID_UP_UNDEFINED: 691 goto ignore; 692 693 case HID_UP_KEYBOARD: 694 set_bit(EV_REP, input->evbit); 695 696 if ((usage->hid & HID_USAGE) < 256) { 697 if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore; 698 map_key_clear(hid_keyboard[usage->hid & HID_USAGE]); 699 } else 700 map_key(KEY_UNKNOWN); 701 702 break; 703 704 case HID_UP_BUTTON: 705 code = ((usage->hid - 1) & HID_USAGE); 706 707 switch (field->application) { 708 case HID_GD_MOUSE: 709 case HID_GD_POINTER: code += BTN_MOUSE; break; 710 case HID_GD_JOYSTICK: 711 if (code <= 0xf) 712 code += BTN_JOYSTICK; 713 else 714 code += BTN_TRIGGER_HAPPY - 0x10; 715 break; 716 case HID_GD_GAMEPAD: 717 if (code <= 0xf) 718 code += BTN_GAMEPAD; 719 else 720 code += BTN_TRIGGER_HAPPY - 0x10; 721 break; 722 case HID_CP_CONSUMER_CONTROL: 723 if (hidinput_field_in_collection(device, field, 724 HID_COLLECTION_NAMED_ARRAY, 725 HID_CP_PROGRAMMABLEBUTTONS)) { 726 if (code <= 0x1d) 727 code += KEY_MACRO1; 728 else 729 code += BTN_TRIGGER_HAPPY - 0x1e; 730 break; 731 } 732 fallthrough; 733 default: 734 switch (field->physical) { 735 case HID_GD_MOUSE: 736 case HID_GD_POINTER: code += BTN_MOUSE; break; 737 case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break; 738 case HID_GD_GAMEPAD: code += BTN_GAMEPAD; break; 739 default: code += BTN_MISC; 740 } 741 } 742 743 map_key(code); 744 break; 745 746 case HID_UP_SIMULATION: 747 switch (usage->hid & 0xffff) { 748 case 0xba: map_abs(ABS_RUDDER); break; 749 case 0xbb: map_abs(ABS_THROTTLE); break; 750 case 0xc4: map_abs(ABS_GAS); break; 751 case 0xc5: map_abs(ABS_BRAKE); break; 752 case 0xc8: map_abs(ABS_WHEEL); break; 753 default: goto ignore; 754 } 755 break; 756 757 case HID_UP_GENDESK: 758 if ((usage->hid & 0xf0) == 0x80) { /* SystemControl */ 759 switch (usage->hid & 0xf) { 760 case 0x1: map_key_clear(KEY_POWER); break; 761 case 0x2: map_key_clear(KEY_SLEEP); break; 762 case 0x3: map_key_clear(KEY_WAKEUP); break; 763 case 0x4: map_key_clear(KEY_CONTEXT_MENU); break; 764 case 0x5: map_key_clear(KEY_MENU); break; 765 case 0x6: map_key_clear(KEY_PROG1); break; 766 case 0x7: map_key_clear(KEY_HELP); break; 767 case 0x8: map_key_clear(KEY_EXIT); break; 768 case 0x9: map_key_clear(KEY_SELECT); break; 769 case 0xa: map_key_clear(KEY_RIGHT); break; 770 case 0xb: map_key_clear(KEY_LEFT); break; 771 case 0xc: map_key_clear(KEY_UP); break; 772 case 0xd: map_key_clear(KEY_DOWN); break; 773 case 0xe: map_key_clear(KEY_POWER2); break; 774 case 0xf: map_key_clear(KEY_RESTART); break; 775 default: goto unknown; 776 } 777 break; 778 } 779 780 if ((usage->hid & 0xf0) == 0xb0) { /* SC - Display */ 781 switch (usage->hid & 0xf) { 782 case 0x05: map_key_clear(KEY_SWITCHVIDEOMODE); break; 783 default: goto ignore; 784 } 785 break; 786 } 787 788 /* 789 * Some lazy vendors declare 255 usages for System Control, 790 * leading to the creation of ABS_X|Y axis and too many others. 791 * It wouldn't be a problem if joydev doesn't consider the 792 * device as a joystick then. 793 */ 794 if (field->application == HID_GD_SYSTEM_CONTROL) 795 goto ignore; 796 797 if ((usage->hid & 0xf0) == 0x90) { /* D-pad */ 798 switch (usage->hid) { 799 case HID_GD_UP: usage->hat_dir = 1; break; 800 case HID_GD_DOWN: usage->hat_dir = 5; break; 801 case HID_GD_RIGHT: usage->hat_dir = 3; break; 802 case HID_GD_LEFT: usage->hat_dir = 7; break; 803 default: goto unknown; 804 } 805 if (field->dpad) { 806 map_abs(field->dpad); 807 goto ignore; 808 } 809 map_abs(ABS_HAT0X); 810 break; 811 } 812 813 switch (usage->hid) { 814 /* These usage IDs map directly to the usage codes. */ 815 case HID_GD_X: case HID_GD_Y: case HID_GD_Z: 816 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ: 817 if (field->flags & HID_MAIN_ITEM_RELATIVE) 818 map_rel(usage->hid & 0xf); 819 else 820 map_abs_clear(usage->hid & 0xf); 821 break; 822 823 case HID_GD_WHEEL: 824 if (field->flags & HID_MAIN_ITEM_RELATIVE) { 825 set_bit(REL_WHEEL, input->relbit); 826 map_rel(REL_WHEEL_HI_RES); 827 } else { 828 map_abs(usage->hid & 0xf); 829 } 830 break; 831 case HID_GD_SLIDER: case HID_GD_DIAL: 832 if (field->flags & HID_MAIN_ITEM_RELATIVE) 833 map_rel(usage->hid & 0xf); 834 else 835 map_abs(usage->hid & 0xf); 836 break; 837 838 case HID_GD_HATSWITCH: 839 usage->hat_min = field->logical_minimum; 840 usage->hat_max = field->logical_maximum; 841 map_abs(ABS_HAT0X); 842 break; 843 844 case HID_GD_START: map_key_clear(BTN_START); break; 845 case HID_GD_SELECT: map_key_clear(BTN_SELECT); break; 846 847 case HID_GD_RFKILL_BTN: 848 /* MS wireless radio ctl extension, also check CA */ 849 if (field->application == HID_GD_WIRELESS_RADIO_CTLS) { 850 map_key_clear(KEY_RFKILL); 851 /* We need to simulate the btn release */ 852 field->flags |= HID_MAIN_ITEM_RELATIVE; 853 break; 854 } 855 goto unknown; 856 857 default: goto unknown; 858 } 859 860 break; 861 862 case HID_UP_LED: 863 switch (usage->hid & 0xffff) { /* HID-Value: */ 864 case 0x01: map_led (LED_NUML); break; /* "Num Lock" */ 865 case 0x02: map_led (LED_CAPSL); break; /* "Caps Lock" */ 866 case 0x03: map_led (LED_SCROLLL); break; /* "Scroll Lock" */ 867 case 0x04: map_led (LED_COMPOSE); break; /* "Compose" */ 868 case 0x05: map_led (LED_KANA); break; /* "Kana" */ 869 case 0x27: map_led (LED_SLEEP); break; /* "Stand-By" */ 870 case 0x4c: map_led (LED_SUSPEND); break; /* "System Suspend" */ 871 case 0x09: map_led (LED_MUTE); break; /* "Mute" */ 872 case 0x4b: map_led (LED_MISC); break; /* "Generic Indicator" */ 873 case 0x19: map_led (LED_MAIL); break; /* "Message Waiting" */ 874 case 0x4d: map_led (LED_CHARGING); break; /* "External Power Connected" */ 875 876 default: goto ignore; 877 } 878 break; 879 880 case HID_UP_DIGITIZER: 881 if ((field->application & 0xff) == 0x01) /* Digitizer */ 882 __set_bit(INPUT_PROP_POINTER, input->propbit); 883 else if ((field->application & 0xff) == 0x02) /* Pen */ 884 __set_bit(INPUT_PROP_DIRECT, input->propbit); 885 886 switch (usage->hid & 0xff) { 887 case 0x00: /* Undefined */ 888 goto ignore; 889 890 case 0x30: /* TipPressure */ 891 if (!test_bit(BTN_TOUCH, input->keybit)) { 892 device->quirks |= HID_QUIRK_NOTOUCH; 893 set_bit(EV_KEY, input->evbit); 894 set_bit(BTN_TOUCH, input->keybit); 895 } 896 map_abs_clear(ABS_PRESSURE); 897 break; 898 899 case 0x32: /* InRange */ 900 switch (field->physical) { 901 case HID_DG_PUCK: 902 map_key(BTN_TOOL_MOUSE); 903 break; 904 case HID_DG_FINGER: 905 map_key(BTN_TOOL_FINGER); 906 break; 907 default: 908 /* 909 * If the physical is not given, 910 * rely on the application. 911 */ 912 if (!field->physical) { 913 switch (field->application) { 914 case HID_DG_TOUCHSCREEN: 915 case HID_DG_TOUCHPAD: 916 map_key_clear(BTN_TOOL_FINGER); 917 break; 918 default: 919 map_key_clear(BTN_TOOL_PEN); 920 } 921 } else { 922 map_key(BTN_TOOL_PEN); 923 } 924 break; 925 } 926 break; 927 928 case 0x3b: /* Battery Strength */ 929 hidinput_setup_battery(device, HID_INPUT_REPORT, field, false); 930 usage->type = EV_PWR; 931 return; 932 933 case 0x3c: /* Invert */ 934 map_key_clear(BTN_TOOL_RUBBER); 935 break; 936 937 case 0x3d: /* X Tilt */ 938 map_abs_clear(ABS_TILT_X); 939 break; 940 941 case 0x3e: /* Y Tilt */ 942 map_abs_clear(ABS_TILT_Y); 943 break; 944 945 case 0x33: /* Touch */ 946 case 0x42: /* TipSwitch */ 947 case 0x43: /* TipSwitch2 */ 948 device->quirks &= ~HID_QUIRK_NOTOUCH; 949 map_key_clear(BTN_TOUCH); 950 break; 951 952 case 0x44: /* BarrelSwitch */ 953 map_key_clear(BTN_STYLUS); 954 break; 955 956 case 0x45: /* ERASER */ 957 /* 958 * This event is reported when eraser tip touches the surface. 959 * Actual eraser (BTN_TOOL_RUBBER) is set by Invert usage when 960 * tool gets in proximity. 961 */ 962 map_key_clear(BTN_TOUCH); 963 break; 964 965 case 0x46: /* TabletPick */ 966 case 0x5a: /* SecondaryBarrelSwitch */ 967 map_key_clear(BTN_STYLUS2); 968 break; 969 970 case 0x5b: /* TransducerSerialNumber */ 971 case 0x6e: /* TransducerSerialNumber2 */ 972 map_msc(MSC_SERIAL); 973 break; 974 975 default: goto unknown; 976 } 977 break; 978 979 case HID_UP_TELEPHONY: 980 switch (usage->hid & HID_USAGE) { 981 case 0x2f: map_key_clear(KEY_MICMUTE); break; 982 case 0xb0: map_key_clear(KEY_NUMERIC_0); break; 983 case 0xb1: map_key_clear(KEY_NUMERIC_1); break; 984 case 0xb2: map_key_clear(KEY_NUMERIC_2); break; 985 case 0xb3: map_key_clear(KEY_NUMERIC_3); break; 986 case 0xb4: map_key_clear(KEY_NUMERIC_4); break; 987 case 0xb5: map_key_clear(KEY_NUMERIC_5); break; 988 case 0xb6: map_key_clear(KEY_NUMERIC_6); break; 989 case 0xb7: map_key_clear(KEY_NUMERIC_7); break; 990 case 0xb8: map_key_clear(KEY_NUMERIC_8); break; 991 case 0xb9: map_key_clear(KEY_NUMERIC_9); break; 992 case 0xba: map_key_clear(KEY_NUMERIC_STAR); break; 993 case 0xbb: map_key_clear(KEY_NUMERIC_POUND); break; 994 case 0xbc: map_key_clear(KEY_NUMERIC_A); break; 995 case 0xbd: map_key_clear(KEY_NUMERIC_B); break; 996 case 0xbe: map_key_clear(KEY_NUMERIC_C); break; 997 case 0xbf: map_key_clear(KEY_NUMERIC_D); break; 998 default: goto ignore; 999 } 1000 break; 1001 1002 case HID_UP_CONSUMER: /* USB HUT v1.12, pages 75-84 */ 1003 switch (usage->hid & HID_USAGE) { 1004 case 0x000: goto ignore; 1005 case 0x030: map_key_clear(KEY_POWER); break; 1006 case 0x031: map_key_clear(KEY_RESTART); break; 1007 case 0x032: map_key_clear(KEY_SLEEP); break; 1008 case 0x034: map_key_clear(KEY_SLEEP); break; 1009 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE); break; 1010 case 0x036: map_key_clear(BTN_MISC); break; 1011 1012 case 0x040: map_key_clear(KEY_MENU); break; /* Menu */ 1013 case 0x041: map_key_clear(KEY_SELECT); break; /* Menu Pick */ 1014 case 0x042: map_key_clear(KEY_UP); break; /* Menu Up */ 1015 case 0x043: map_key_clear(KEY_DOWN); break; /* Menu Down */ 1016 case 0x044: map_key_clear(KEY_LEFT); break; /* Menu Left */ 1017 case 0x045: map_key_clear(KEY_RIGHT); break; /* Menu Right */ 1018 case 0x046: map_key_clear(KEY_ESC); break; /* Menu Escape */ 1019 case 0x047: map_key_clear(KEY_KPPLUS); break; /* Menu Value Increase */ 1020 case 0x048: map_key_clear(KEY_KPMINUS); break; /* Menu Value Decrease */ 1021 1022 case 0x060: map_key_clear(KEY_INFO); break; /* Data On Screen */ 1023 case 0x061: map_key_clear(KEY_SUBTITLE); break; /* Closed Caption */ 1024 case 0x063: map_key_clear(KEY_VCR); break; /* VCR/TV */ 1025 case 0x065: map_key_clear(KEY_CAMERA); break; /* Snapshot */ 1026 case 0x069: map_key_clear(KEY_RED); break; 1027 case 0x06a: map_key_clear(KEY_GREEN); break; 1028 case 0x06b: map_key_clear(KEY_BLUE); break; 1029 case 0x06c: map_key_clear(KEY_YELLOW); break; 1030 case 0x06d: map_key_clear(KEY_ASPECT_RATIO); break; 1031 1032 case 0x06f: map_key_clear(KEY_BRIGHTNESSUP); break; 1033 case 0x070: map_key_clear(KEY_BRIGHTNESSDOWN); break; 1034 case 0x072: map_key_clear(KEY_BRIGHTNESS_TOGGLE); break; 1035 case 0x073: map_key_clear(KEY_BRIGHTNESS_MIN); break; 1036 case 0x074: map_key_clear(KEY_BRIGHTNESS_MAX); break; 1037 case 0x075: map_key_clear(KEY_BRIGHTNESS_AUTO); break; 1038 1039 case 0x079: map_key_clear(KEY_KBDILLUMUP); break; 1040 case 0x07a: map_key_clear(KEY_KBDILLUMDOWN); break; 1041 case 0x07c: map_key_clear(KEY_KBDILLUMTOGGLE); break; 1042 1043 case 0x082: map_key_clear(KEY_VIDEO_NEXT); break; 1044 case 0x083: map_key_clear(KEY_LAST); break; 1045 case 0x084: map_key_clear(KEY_ENTER); break; 1046 case 0x088: map_key_clear(KEY_PC); break; 1047 case 0x089: map_key_clear(KEY_TV); break; 1048 case 0x08a: map_key_clear(KEY_WWW); break; 1049 case 0x08b: map_key_clear(KEY_DVD); break; 1050 case 0x08c: map_key_clear(KEY_PHONE); break; 1051 case 0x08d: map_key_clear(KEY_PROGRAM); break; 1052 case 0x08e: map_key_clear(KEY_VIDEOPHONE); break; 1053 case 0x08f: map_key_clear(KEY_GAMES); break; 1054 case 0x090: map_key_clear(KEY_MEMO); break; 1055 case 0x091: map_key_clear(KEY_CD); break; 1056 case 0x092: map_key_clear(KEY_VCR); break; 1057 case 0x093: map_key_clear(KEY_TUNER); break; 1058 case 0x094: map_key_clear(KEY_EXIT); break; 1059 case 0x095: map_key_clear(KEY_HELP); break; 1060 case 0x096: map_key_clear(KEY_TAPE); break; 1061 case 0x097: map_key_clear(KEY_TV2); break; 1062 case 0x098: map_key_clear(KEY_SAT); break; 1063 case 0x09a: map_key_clear(KEY_PVR); break; 1064 1065 case 0x09c: map_key_clear(KEY_CHANNELUP); break; 1066 case 0x09d: map_key_clear(KEY_CHANNELDOWN); break; 1067 case 0x0a0: map_key_clear(KEY_VCR2); break; 1068 1069 case 0x0b0: map_key_clear(KEY_PLAY); break; 1070 case 0x0b1: map_key_clear(KEY_PAUSE); break; 1071 case 0x0b2: map_key_clear(KEY_RECORD); break; 1072 case 0x0b3: map_key_clear(KEY_FASTFORWARD); break; 1073 case 0x0b4: map_key_clear(KEY_REWIND); break; 1074 case 0x0b5: map_key_clear(KEY_NEXTSONG); break; 1075 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG); break; 1076 case 0x0b7: map_key_clear(KEY_STOPCD); break; 1077 case 0x0b8: map_key_clear(KEY_EJECTCD); break; 1078 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT); break; 1079 case 0x0b9: map_key_clear(KEY_SHUFFLE); break; 1080 case 0x0bf: map_key_clear(KEY_SLOW); break; 1081 1082 case 0x0cd: map_key_clear(KEY_PLAYPAUSE); break; 1083 case 0x0cf: map_key_clear(KEY_VOICECOMMAND); break; 1084 1085 case 0x0d8: map_key_clear(KEY_DICTATE); break; 1086 case 0x0d9: map_key_clear(KEY_EMOJI_PICKER); break; 1087 1088 case 0x0e0: map_abs_clear(ABS_VOLUME); break; 1089 case 0x0e2: map_key_clear(KEY_MUTE); break; 1090 case 0x0e5: map_key_clear(KEY_BASSBOOST); break; 1091 case 0x0e9: map_key_clear(KEY_VOLUMEUP); break; 1092 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN); break; 1093 case 0x0f5: map_key_clear(KEY_SLOW); break; 1094 1095 case 0x181: map_key_clear(KEY_BUTTONCONFIG); break; 1096 case 0x182: map_key_clear(KEY_BOOKMARKS); break; 1097 case 0x183: map_key_clear(KEY_CONFIG); break; 1098 case 0x184: map_key_clear(KEY_WORDPROCESSOR); break; 1099 case 0x185: map_key_clear(KEY_EDITOR); break; 1100 case 0x186: map_key_clear(KEY_SPREADSHEET); break; 1101 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR); break; 1102 case 0x188: map_key_clear(KEY_PRESENTATION); break; 1103 case 0x189: map_key_clear(KEY_DATABASE); break; 1104 case 0x18a: map_key_clear(KEY_MAIL); break; 1105 case 0x18b: map_key_clear(KEY_NEWS); break; 1106 case 0x18c: map_key_clear(KEY_VOICEMAIL); break; 1107 case 0x18d: map_key_clear(KEY_ADDRESSBOOK); break; 1108 case 0x18e: map_key_clear(KEY_CALENDAR); break; 1109 case 0x18f: map_key_clear(KEY_TASKMANAGER); break; 1110 case 0x190: map_key_clear(KEY_JOURNAL); break; 1111 case 0x191: map_key_clear(KEY_FINANCE); break; 1112 case 0x192: map_key_clear(KEY_CALC); break; 1113 case 0x193: map_key_clear(KEY_PLAYER); break; 1114 case 0x194: map_key_clear(KEY_FILE); break; 1115 case 0x196: map_key_clear(KEY_WWW); break; 1116 case 0x199: map_key_clear(KEY_CHAT); break; 1117 case 0x19c: map_key_clear(KEY_LOGOFF); break; 1118 case 0x19e: map_key_clear(KEY_COFFEE); break; 1119 case 0x19f: map_key_clear(KEY_CONTROLPANEL); break; 1120 case 0x1a2: map_key_clear(KEY_APPSELECT); break; 1121 case 0x1a3: map_key_clear(KEY_NEXT); break; 1122 case 0x1a4: map_key_clear(KEY_PREVIOUS); break; 1123 case 0x1a6: map_key_clear(KEY_HELP); break; 1124 case 0x1a7: map_key_clear(KEY_DOCUMENTS); break; 1125 case 0x1ab: map_key_clear(KEY_SPELLCHECK); break; 1126 case 0x1ae: map_key_clear(KEY_KEYBOARD); break; 1127 case 0x1b1: map_key_clear(KEY_SCREENSAVER); break; 1128 case 0x1b4: map_key_clear(KEY_FILE); break; 1129 case 0x1b6: map_key_clear(KEY_IMAGES); break; 1130 case 0x1b7: map_key_clear(KEY_AUDIO); break; 1131 case 0x1b8: map_key_clear(KEY_VIDEO); break; 1132 case 0x1bc: map_key_clear(KEY_MESSENGER); break; 1133 case 0x1bd: map_key_clear(KEY_INFO); break; 1134 case 0x1cb: map_key_clear(KEY_ASSISTANT); break; 1135 case 0x201: map_key_clear(KEY_NEW); break; 1136 case 0x202: map_key_clear(KEY_OPEN); break; 1137 case 0x203: map_key_clear(KEY_CLOSE); break; 1138 case 0x204: map_key_clear(KEY_EXIT); break; 1139 case 0x207: map_key_clear(KEY_SAVE); break; 1140 case 0x208: map_key_clear(KEY_PRINT); break; 1141 case 0x209: map_key_clear(KEY_PROPS); break; 1142 case 0x21a: map_key_clear(KEY_UNDO); break; 1143 case 0x21b: map_key_clear(KEY_COPY); break; 1144 case 0x21c: map_key_clear(KEY_CUT); break; 1145 case 0x21d: map_key_clear(KEY_PASTE); break; 1146 case 0x21f: map_key_clear(KEY_FIND); break; 1147 case 0x221: map_key_clear(KEY_SEARCH); break; 1148 case 0x222: map_key_clear(KEY_GOTO); break; 1149 case 0x223: map_key_clear(KEY_HOMEPAGE); break; 1150 case 0x224: map_key_clear(KEY_BACK); break; 1151 case 0x225: map_key_clear(KEY_FORWARD); break; 1152 case 0x226: map_key_clear(KEY_STOP); break; 1153 case 0x227: map_key_clear(KEY_REFRESH); break; 1154 case 0x22a: map_key_clear(KEY_BOOKMARKS); break; 1155 case 0x22d: map_key_clear(KEY_ZOOMIN); break; 1156 case 0x22e: map_key_clear(KEY_ZOOMOUT); break; 1157 case 0x22f: map_key_clear(KEY_ZOOMRESET); break; 1158 case 0x232: map_key_clear(KEY_FULL_SCREEN); break; 1159 case 0x233: map_key_clear(KEY_SCROLLUP); break; 1160 case 0x234: map_key_clear(KEY_SCROLLDOWN); break; 1161 case 0x238: /* AC Pan */ 1162 set_bit(REL_HWHEEL, input->relbit); 1163 map_rel(REL_HWHEEL_HI_RES); 1164 break; 1165 case 0x23d: map_key_clear(KEY_EDIT); break; 1166 case 0x25f: map_key_clear(KEY_CANCEL); break; 1167 case 0x269: map_key_clear(KEY_INSERT); break; 1168 case 0x26a: map_key_clear(KEY_DELETE); break; 1169 case 0x279: map_key_clear(KEY_REDO); break; 1170 1171 case 0x289: map_key_clear(KEY_REPLY); break; 1172 case 0x28b: map_key_clear(KEY_FORWARDMAIL); break; 1173 case 0x28c: map_key_clear(KEY_SEND); break; 1174 1175 case 0x29d: map_key_clear(KEY_KBD_LAYOUT_NEXT); break; 1176 1177 case 0x2a2: map_key_clear(KEY_ALL_APPLICATIONS); break; 1178 1179 case 0x2c7: map_key_clear(KEY_KBDINPUTASSIST_PREV); break; 1180 case 0x2c8: map_key_clear(KEY_KBDINPUTASSIST_NEXT); break; 1181 case 0x2c9: map_key_clear(KEY_KBDINPUTASSIST_PREVGROUP); break; 1182 case 0x2ca: map_key_clear(KEY_KBDINPUTASSIST_NEXTGROUP); break; 1183 case 0x2cb: map_key_clear(KEY_KBDINPUTASSIST_ACCEPT); break; 1184 case 0x2cc: map_key_clear(KEY_KBDINPUTASSIST_CANCEL); break; 1185 1186 case 0x29f: map_key_clear(KEY_SCALE); break; 1187 1188 default: map_key_clear(KEY_UNKNOWN); 1189 } 1190 break; 1191 1192 case HID_UP_GENDEVCTRLS: 1193 switch (usage->hid) { 1194 case HID_DC_BATTERYSTRENGTH: 1195 hidinput_setup_battery(device, HID_INPUT_REPORT, field, false); 1196 usage->type = EV_PWR; 1197 return; 1198 } 1199 goto unknown; 1200 1201 case HID_UP_BATTERY: 1202 switch (usage->hid) { 1203 case HID_BAT_ABSOLUTESTATEOFCHARGE: 1204 hidinput_setup_battery(device, HID_INPUT_REPORT, field, true); 1205 usage->type = EV_PWR; 1206 return; 1207 } 1208 goto unknown; 1209 1210 case HID_UP_HPVENDOR: /* Reported on a Dutch layout HP5308 */ 1211 set_bit(EV_REP, input->evbit); 1212 switch (usage->hid & HID_USAGE) { 1213 case 0x021: map_key_clear(KEY_PRINT); break; 1214 case 0x070: map_key_clear(KEY_HP); break; 1215 case 0x071: map_key_clear(KEY_CAMERA); break; 1216 case 0x072: map_key_clear(KEY_SOUND); break; 1217 case 0x073: map_key_clear(KEY_QUESTION); break; 1218 case 0x080: map_key_clear(KEY_EMAIL); break; 1219 case 0x081: map_key_clear(KEY_CHAT); break; 1220 case 0x082: map_key_clear(KEY_SEARCH); break; 1221 case 0x083: map_key_clear(KEY_CONNECT); break; 1222 case 0x084: map_key_clear(KEY_FINANCE); break; 1223 case 0x085: map_key_clear(KEY_SPORT); break; 1224 case 0x086: map_key_clear(KEY_SHOP); break; 1225 default: goto ignore; 1226 } 1227 break; 1228 1229 case HID_UP_HPVENDOR2: 1230 set_bit(EV_REP, input->evbit); 1231 switch (usage->hid & HID_USAGE) { 1232 case 0x001: map_key_clear(KEY_MICMUTE); break; 1233 case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN); break; 1234 case 0x004: map_key_clear(KEY_BRIGHTNESSUP); break; 1235 default: goto ignore; 1236 } 1237 break; 1238 1239 case HID_UP_MSVENDOR: 1240 goto ignore; 1241 1242 case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */ 1243 set_bit(EV_REP, input->evbit); 1244 goto ignore; 1245 1246 case HID_UP_LOGIVENDOR: 1247 /* intentional fallback */ 1248 case HID_UP_LOGIVENDOR2: 1249 /* intentional fallback */ 1250 case HID_UP_LOGIVENDOR3: 1251 goto ignore; 1252 1253 case HID_UP_PID: 1254 switch (usage->hid & HID_USAGE) { 1255 case 0xa4: map_key_clear(BTN_DEAD); break; 1256 default: goto ignore; 1257 } 1258 break; 1259 1260 default: 1261 unknown: 1262 if (field->report_size == 1) { 1263 if (field->report->type == HID_OUTPUT_REPORT) { 1264 map_led(LED_MISC); 1265 break; 1266 } 1267 map_key(BTN_MISC); 1268 break; 1269 } 1270 if (field->flags & HID_MAIN_ITEM_RELATIVE) { 1271 map_rel(REL_MISC); 1272 break; 1273 } 1274 map_abs(ABS_MISC); 1275 break; 1276 } 1277 1278 mapped: 1279 /* Mapping failed, bail out */ 1280 if (!bit) 1281 return; 1282 1283 if (device->driver->input_mapped && 1284 device->driver->input_mapped(device, hidinput, field, usage, 1285 &bit, &max) < 0) { 1286 /* 1287 * The driver indicated that no further generic handling 1288 * of the usage is desired. 1289 */ 1290 return; 1291 } 1292 1293 set_bit(usage->type, input->evbit); 1294 1295 /* 1296 * This part is *really* controversial: 1297 * - HID aims at being generic so we should do our best to export 1298 * all incoming events 1299 * - HID describes what events are, so there is no reason for ABS_X 1300 * to be mapped to ABS_Y 1301 * - HID is using *_MISC+N as a default value, but nothing prevents 1302 * *_MISC+N to overwrite a legitimate even, which confuses userspace 1303 * (for instance ABS_MISC + 7 is ABS_MT_SLOT, which has a different 1304 * processing) 1305 * 1306 * If devices still want to use this (at their own risk), they will 1307 * have to use the quirk HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE, but 1308 * the default should be a reliable mapping. 1309 */ 1310 while (usage->code <= max && test_and_set_bit(usage->code, bit)) { 1311 if (device->quirks & HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE) { 1312 usage->code = find_next_zero_bit(bit, 1313 max + 1, 1314 usage->code); 1315 } else { 1316 device->status |= HID_STAT_DUP_DETECTED; 1317 goto ignore; 1318 } 1319 } 1320 1321 if (usage->code > max) 1322 goto ignore; 1323 1324 if (usage->type == EV_ABS) { 1325 1326 int a = field->logical_minimum; 1327 int b = field->logical_maximum; 1328 1329 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) { 1330 a = field->logical_minimum = 0; 1331 b = field->logical_maximum = 255; 1332 } 1333 1334 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK) 1335 input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4); 1336 else input_set_abs_params(input, usage->code, a, b, 0, 0); 1337 1338 input_abs_set_res(input, usage->code, 1339 hidinput_calc_abs_res(field, usage->code)); 1340 1341 /* use a larger default input buffer for MT devices */ 1342 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0) 1343 input_set_events_per_packet(input, 60); 1344 } 1345 1346 if (usage->type == EV_ABS && 1347 (usage->hat_min < usage->hat_max || usage->hat_dir)) { 1348 int i; 1349 for (i = usage->code; i < usage->code + 2 && i <= max; i++) { 1350 input_set_abs_params(input, i, -1, 1, 0, 0); 1351 set_bit(i, input->absbit); 1352 } 1353 if (usage->hat_dir && !field->dpad) 1354 field->dpad = usage->code; 1355 } 1356 1357 /* for those devices which produce Consumer volume usage as relative, 1358 * we emulate pressing volumeup/volumedown appropriate number of times 1359 * in hidinput_hid_event() 1360 */ 1361 if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) && 1362 (usage->code == ABS_VOLUME)) { 1363 set_bit(KEY_VOLUMEUP, input->keybit); 1364 set_bit(KEY_VOLUMEDOWN, input->keybit); 1365 } 1366 1367 if (usage->type == EV_KEY) { 1368 set_bit(EV_MSC, input->evbit); 1369 set_bit(MSC_SCAN, input->mscbit); 1370 } 1371 1372 return; 1373 1374 ignore: 1375 usage->type = 0; 1376 usage->code = 0; 1377 } 1378 1379 static void hidinput_handle_scroll(struct hid_usage *usage, 1380 struct input_dev *input, 1381 __s32 value) 1382 { 1383 int code; 1384 int hi_res, lo_res; 1385 1386 if (value == 0) 1387 return; 1388 1389 if (usage->code == REL_WHEEL_HI_RES) 1390 code = REL_WHEEL; 1391 else 1392 code = REL_HWHEEL; 1393 1394 /* 1395 * Windows reports one wheel click as value 120. Where a high-res 1396 * scroll wheel is present, a fraction of 120 is reported instead. 1397 * Our REL_WHEEL_HI_RES axis does the same because all HW must 1398 * adhere to the 120 expectation. 1399 */ 1400 hi_res = value * 120/usage->resolution_multiplier; 1401 1402 usage->wheel_accumulated += hi_res; 1403 lo_res = usage->wheel_accumulated/120; 1404 if (lo_res) 1405 usage->wheel_accumulated -= lo_res * 120; 1406 1407 input_event(input, EV_REL, code, lo_res); 1408 input_event(input, EV_REL, usage->code, hi_res); 1409 } 1410 1411 static void hid_report_release_tool(struct hid_report *report, struct input_dev *input, 1412 unsigned int tool) 1413 { 1414 /* if the given tool is not currently reported, ignore */ 1415 if (!test_bit(tool, input->key)) 1416 return; 1417 1418 /* 1419 * if the given tool was previously set, release it, 1420 * release any TOUCH and send an EV_SYN 1421 */ 1422 input_event(input, EV_KEY, BTN_TOUCH, 0); 1423 input_event(input, EV_KEY, tool, 0); 1424 input_event(input, EV_SYN, SYN_REPORT, 0); 1425 1426 report->tool = 0; 1427 } 1428 1429 static void hid_report_set_tool(struct hid_report *report, struct input_dev *input, 1430 unsigned int new_tool) 1431 { 1432 if (report->tool != new_tool) 1433 hid_report_release_tool(report, input, report->tool); 1434 1435 input_event(input, EV_KEY, new_tool, 1); 1436 report->tool = new_tool; 1437 } 1438 1439 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value) 1440 { 1441 struct input_dev *input; 1442 struct hid_report *report = field->report; 1443 unsigned *quirks = &hid->quirks; 1444 1445 if (!usage->type) 1446 return; 1447 1448 if (usage->type == EV_PWR) { 1449 hidinput_update_battery(hid, value); 1450 return; 1451 } 1452 1453 if (!field->hidinput) 1454 return; 1455 1456 input = field->hidinput->input; 1457 1458 if (usage->hat_min < usage->hat_max || usage->hat_dir) { 1459 int hat_dir = usage->hat_dir; 1460 if (!hat_dir) 1461 hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1; 1462 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0; 1463 input_event(input, usage->type, usage->code , hid_hat_to_axis[hat_dir].x); 1464 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y); 1465 return; 1466 } 1467 1468 /* 1469 * Ignore out-of-range values as per HID specification, 1470 * section 5.10 and 6.2.25, when NULL state bit is present. 1471 * When it's not, clamp the value to match Microsoft's input 1472 * driver as mentioned in "Required HID usages for digitizers": 1473 * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp 1474 * 1475 * The logical_minimum < logical_maximum check is done so that we 1476 * don't unintentionally discard values sent by devices which 1477 * don't specify logical min and max. 1478 */ 1479 if ((field->flags & HID_MAIN_ITEM_VARIABLE) && 1480 field->logical_minimum < field->logical_maximum) { 1481 if (field->flags & HID_MAIN_ITEM_NULL_STATE && 1482 (value < field->logical_minimum || 1483 value > field->logical_maximum)) { 1484 dbg_hid("Ignoring out-of-range value %x\n", value); 1485 return; 1486 } 1487 value = clamp(value, 1488 field->logical_minimum, 1489 field->logical_maximum); 1490 } 1491 1492 switch (usage->hid) { 1493 case HID_DG_ERASER: 1494 report->tool_active |= !!value; 1495 1496 /* 1497 * if eraser is set, we must enforce BTN_TOOL_RUBBER 1498 * to accommodate for devices not following the spec. 1499 */ 1500 if (value) 1501 hid_report_set_tool(report, input, BTN_TOOL_RUBBER); 1502 else if (report->tool != BTN_TOOL_RUBBER) 1503 /* value is off, tool is not rubber, ignore */ 1504 return; 1505 1506 /* let hid-input set BTN_TOUCH */ 1507 break; 1508 1509 case HID_DG_INVERT: 1510 report->tool_active |= !!value; 1511 1512 /* 1513 * If invert is set, we store BTN_TOOL_RUBBER. 1514 */ 1515 if (value) 1516 hid_report_set_tool(report, input, BTN_TOOL_RUBBER); 1517 else if (!report->tool_active) 1518 /* tool_active not set means Invert and Eraser are not set */ 1519 hid_report_release_tool(report, input, BTN_TOOL_RUBBER); 1520 1521 /* no further processing */ 1522 return; 1523 1524 case HID_DG_INRANGE: 1525 report->tool_active |= !!value; 1526 1527 if (report->tool_active) { 1528 /* 1529 * if tool is not set but is marked as active, 1530 * assume ours 1531 */ 1532 if (!report->tool) 1533 hid_report_set_tool(report, input, usage->code); 1534 } else { 1535 hid_report_release_tool(report, input, usage->code); 1536 } 1537 1538 /* reset tool_active for the next event */ 1539 report->tool_active = false; 1540 1541 /* no further processing */ 1542 return; 1543 1544 case HID_DG_TIPSWITCH: 1545 report->tool_active |= !!value; 1546 1547 /* if tool is set to RUBBER we should ignore the current value */ 1548 if (report->tool == BTN_TOOL_RUBBER) 1549 return; 1550 1551 break; 1552 1553 case HID_DG_TIPPRESSURE: 1554 if (*quirks & HID_QUIRK_NOTOUCH) { 1555 int a = field->logical_minimum; 1556 int b = field->logical_maximum; 1557 1558 if (value > a + ((b - a) >> 3)) { 1559 input_event(input, EV_KEY, BTN_TOUCH, 1); 1560 report->tool_active = true; 1561 } 1562 } 1563 break; 1564 1565 case HID_UP_PID | 0x83UL: /* Simultaneous Effects Max */ 1566 dbg_hid("Maximum Effects - %d\n",value); 1567 return; 1568 1569 case HID_UP_PID | 0x7fUL: 1570 dbg_hid("PID Pool Report\n"); 1571 return; 1572 } 1573 1574 switch (usage->type) { 1575 case EV_KEY: 1576 if (usage->code == 0) /* Key 0 is "unassigned", not KEY_UNKNOWN */ 1577 return; 1578 break; 1579 1580 case EV_REL: 1581 if (usage->code == REL_WHEEL_HI_RES || 1582 usage->code == REL_HWHEEL_HI_RES) { 1583 hidinput_handle_scroll(usage, input, value); 1584 return; 1585 } 1586 break; 1587 1588 case EV_ABS: 1589 if ((field->flags & HID_MAIN_ITEM_RELATIVE) && 1590 usage->code == ABS_VOLUME) { 1591 int count = abs(value); 1592 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN; 1593 int i; 1594 1595 for (i = 0; i < count; i++) { 1596 input_event(input, EV_KEY, direction, 1); 1597 input_sync(input); 1598 input_event(input, EV_KEY, direction, 0); 1599 input_sync(input); 1600 } 1601 return; 1602 1603 } else if (((*quirks & HID_QUIRK_X_INVERT) && usage->code == ABS_X) || 1604 ((*quirks & HID_QUIRK_Y_INVERT) && usage->code == ABS_Y)) 1605 value = field->logical_maximum - value; 1606 break; 1607 } 1608 1609 /* 1610 * Ignore reports for absolute data if the data didn't change. This is 1611 * not only an optimization but also fixes 'dead' key reports. Some 1612 * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID 1613 * 0x31 and 0x32) report multiple keys, even though a localized keyboard 1614 * can only have one of them physically available. The 'dead' keys 1615 * report constant 0. As all map to the same keycode, they'd confuse 1616 * the input layer. If we filter the 'dead' keys on the HID level, we 1617 * skip the keycode translation and only forward real events. 1618 */ 1619 if (!(field->flags & (HID_MAIN_ITEM_RELATIVE | 1620 HID_MAIN_ITEM_BUFFERED_BYTE)) && 1621 (field->flags & HID_MAIN_ITEM_VARIABLE) && 1622 usage->usage_index < field->maxusage && 1623 value == field->value[usage->usage_index]) 1624 return; 1625 1626 /* report the usage code as scancode if the key status has changed */ 1627 if (usage->type == EV_KEY && 1628 (!test_bit(usage->code, input->key)) == value) 1629 input_event(input, EV_MSC, MSC_SCAN, usage->hid); 1630 1631 input_event(input, usage->type, usage->code, value); 1632 1633 if ((field->flags & HID_MAIN_ITEM_RELATIVE) && 1634 usage->type == EV_KEY && value) { 1635 input_sync(input); 1636 input_event(input, usage->type, usage->code, 0); 1637 } 1638 } 1639 1640 void hidinput_report_event(struct hid_device *hid, struct hid_report *report) 1641 { 1642 struct hid_input *hidinput; 1643 1644 if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC) 1645 return; 1646 1647 list_for_each_entry(hidinput, &hid->inputs, list) 1648 input_sync(hidinput->input); 1649 } 1650 EXPORT_SYMBOL_GPL(hidinput_report_event); 1651 1652 static int hidinput_find_field(struct hid_device *hid, unsigned int type, 1653 unsigned int code, struct hid_field **field) 1654 { 1655 struct hid_report *report; 1656 int i, j; 1657 1658 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) { 1659 for (i = 0; i < report->maxfield; i++) { 1660 *field = report->field[i]; 1661 for (j = 0; j < (*field)->maxusage; j++) 1662 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code) 1663 return j; 1664 } 1665 } 1666 return -1; 1667 } 1668 1669 struct hid_field *hidinput_get_led_field(struct hid_device *hid) 1670 { 1671 struct hid_report *report; 1672 struct hid_field *field; 1673 int i, j; 1674 1675 list_for_each_entry(report, 1676 &hid->report_enum[HID_OUTPUT_REPORT].report_list, 1677 list) { 1678 for (i = 0; i < report->maxfield; i++) { 1679 field = report->field[i]; 1680 for (j = 0; j < field->maxusage; j++) 1681 if (field->usage[j].type == EV_LED) 1682 return field; 1683 } 1684 } 1685 return NULL; 1686 } 1687 EXPORT_SYMBOL_GPL(hidinput_get_led_field); 1688 1689 unsigned int hidinput_count_leds(struct hid_device *hid) 1690 { 1691 struct hid_report *report; 1692 struct hid_field *field; 1693 int i, j; 1694 unsigned int count = 0; 1695 1696 list_for_each_entry(report, 1697 &hid->report_enum[HID_OUTPUT_REPORT].report_list, 1698 list) { 1699 for (i = 0; i < report->maxfield; i++) { 1700 field = report->field[i]; 1701 for (j = 0; j < field->maxusage; j++) 1702 if (field->usage[j].type == EV_LED && 1703 field->value[j]) 1704 count += 1; 1705 } 1706 } 1707 return count; 1708 } 1709 EXPORT_SYMBOL_GPL(hidinput_count_leds); 1710 1711 static void hidinput_led_worker(struct work_struct *work) 1712 { 1713 struct hid_device *hid = container_of(work, struct hid_device, 1714 led_work); 1715 struct hid_field *field; 1716 struct hid_report *report; 1717 int ret; 1718 u32 len; 1719 __u8 *buf; 1720 1721 field = hidinput_get_led_field(hid); 1722 if (!field) 1723 return; 1724 1725 /* 1726 * field->report is accessed unlocked regarding HID core. So there might 1727 * be another incoming SET-LED request from user-space, which changes 1728 * the LED state while we assemble our outgoing buffer. However, this 1729 * doesn't matter as hid_output_report() correctly converts it into a 1730 * boolean value no matter what information is currently set on the LED 1731 * field (even garbage). So the remote device will always get a valid 1732 * request. 1733 * And in case we send a wrong value, a next led worker is spawned 1734 * for every SET-LED request so the following worker will send the 1735 * correct value, guaranteed! 1736 */ 1737 1738 report = field->report; 1739 1740 /* use custom SET_REPORT request if possible (asynchronous) */ 1741 if (hid->ll_driver->request) 1742 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT); 1743 1744 /* fall back to generic raw-output-report */ 1745 len = hid_report_len(report); 1746 buf = hid_alloc_report_buf(report, GFP_KERNEL); 1747 if (!buf) 1748 return; 1749 1750 hid_output_report(report, buf); 1751 /* synchronous output report */ 1752 ret = hid_hw_output_report(hid, buf, len); 1753 if (ret == -ENOSYS) 1754 hid_hw_raw_request(hid, report->id, buf, len, HID_OUTPUT_REPORT, 1755 HID_REQ_SET_REPORT); 1756 kfree(buf); 1757 } 1758 1759 static int hidinput_input_event(struct input_dev *dev, unsigned int type, 1760 unsigned int code, int value) 1761 { 1762 struct hid_device *hid = input_get_drvdata(dev); 1763 struct hid_field *field; 1764 int offset; 1765 1766 if (type == EV_FF) 1767 return input_ff_event(dev, type, code, value); 1768 1769 if (type != EV_LED) 1770 return -1; 1771 1772 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) { 1773 hid_warn(dev, "event field not found\n"); 1774 return -1; 1775 } 1776 1777 hid_set_field(field, offset, value); 1778 1779 schedule_work(&hid->led_work); 1780 return 0; 1781 } 1782 1783 static int hidinput_open(struct input_dev *dev) 1784 { 1785 struct hid_device *hid = input_get_drvdata(dev); 1786 1787 return hid_hw_open(hid); 1788 } 1789 1790 static void hidinput_close(struct input_dev *dev) 1791 { 1792 struct hid_device *hid = input_get_drvdata(dev); 1793 1794 hid_hw_close(hid); 1795 } 1796 1797 static bool __hidinput_change_resolution_multipliers(struct hid_device *hid, 1798 struct hid_report *report, bool use_logical_max) 1799 { 1800 struct hid_usage *usage; 1801 bool update_needed = false; 1802 bool get_report_completed = false; 1803 int i, j; 1804 1805 if (report->maxfield == 0) 1806 return false; 1807 1808 for (i = 0; i < report->maxfield; i++) { 1809 __s32 value = use_logical_max ? 1810 report->field[i]->logical_maximum : 1811 report->field[i]->logical_minimum; 1812 1813 /* There is no good reason for a Resolution 1814 * Multiplier to have a count other than 1. 1815 * Ignore that case. 1816 */ 1817 if (report->field[i]->report_count != 1) 1818 continue; 1819 1820 for (j = 0; j < report->field[i]->maxusage; j++) { 1821 usage = &report->field[i]->usage[j]; 1822 1823 if (usage->hid != HID_GD_RESOLUTION_MULTIPLIER) 1824 continue; 1825 1826 /* 1827 * If we have more than one feature within this 1828 * report we need to fill in the bits from the 1829 * others before we can overwrite the ones for the 1830 * Resolution Multiplier. 1831 * 1832 * But if we're not allowed to read from the device, 1833 * we just bail. Such a device should not exist 1834 * anyway. 1835 */ 1836 if (!get_report_completed && report->maxfield > 1) { 1837 if (hid->quirks & HID_QUIRK_NO_INIT_REPORTS) 1838 return update_needed; 1839 1840 hid_hw_request(hid, report, HID_REQ_GET_REPORT); 1841 hid_hw_wait(hid); 1842 get_report_completed = true; 1843 } 1844 1845 report->field[i]->value[j] = value; 1846 update_needed = true; 1847 } 1848 } 1849 1850 return update_needed; 1851 } 1852 1853 static void hidinput_change_resolution_multipliers(struct hid_device *hid) 1854 { 1855 struct hid_report_enum *rep_enum; 1856 struct hid_report *rep; 1857 int ret; 1858 1859 rep_enum = &hid->report_enum[HID_FEATURE_REPORT]; 1860 list_for_each_entry(rep, &rep_enum->report_list, list) { 1861 bool update_needed = __hidinput_change_resolution_multipliers(hid, 1862 rep, true); 1863 1864 if (update_needed) { 1865 ret = __hid_request(hid, rep, HID_REQ_SET_REPORT); 1866 if (ret) { 1867 __hidinput_change_resolution_multipliers(hid, 1868 rep, false); 1869 return; 1870 } 1871 } 1872 } 1873 1874 /* refresh our structs */ 1875 hid_setup_resolution_multiplier(hid); 1876 } 1877 1878 static void report_features(struct hid_device *hid) 1879 { 1880 struct hid_driver *drv = hid->driver; 1881 struct hid_report_enum *rep_enum; 1882 struct hid_report *rep; 1883 struct hid_usage *usage; 1884 int i, j; 1885 1886 rep_enum = &hid->report_enum[HID_FEATURE_REPORT]; 1887 list_for_each_entry(rep, &rep_enum->report_list, list) 1888 for (i = 0; i < rep->maxfield; i++) { 1889 /* Ignore if report count is out of bounds. */ 1890 if (rep->field[i]->report_count < 1) 1891 continue; 1892 1893 for (j = 0; j < rep->field[i]->maxusage; j++) { 1894 usage = &rep->field[i]->usage[j]; 1895 1896 /* Verify if Battery Strength feature is available */ 1897 if (usage->hid == HID_DC_BATTERYSTRENGTH) 1898 hidinput_setup_battery(hid, HID_FEATURE_REPORT, 1899 rep->field[i], false); 1900 1901 if (drv->feature_mapping) 1902 drv->feature_mapping(hid, rep->field[i], usage); 1903 } 1904 } 1905 } 1906 1907 static struct hid_input *hidinput_allocate(struct hid_device *hid, 1908 unsigned int application) 1909 { 1910 struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL); 1911 struct input_dev *input_dev = input_allocate_device(); 1912 const char *suffix = NULL; 1913 size_t suffix_len, name_len; 1914 1915 if (!hidinput || !input_dev) 1916 goto fail; 1917 1918 if ((hid->quirks & HID_QUIRK_INPUT_PER_APP) && 1919 hid->maxapplication > 1) { 1920 switch (application) { 1921 case HID_GD_KEYBOARD: 1922 suffix = "Keyboard"; 1923 break; 1924 case HID_GD_KEYPAD: 1925 suffix = "Keypad"; 1926 break; 1927 case HID_GD_MOUSE: 1928 suffix = "Mouse"; 1929 break; 1930 case HID_DG_PEN: 1931 /* 1932 * yes, there is an issue here: 1933 * DG_PEN -> "Stylus" 1934 * DG_STYLUS -> "Pen" 1935 * But changing this now means users with config snippets 1936 * will have to change it and the test suite will not be happy. 1937 */ 1938 suffix = "Stylus"; 1939 break; 1940 case HID_DG_STYLUS: 1941 suffix = "Pen"; 1942 break; 1943 case HID_DG_TOUCHSCREEN: 1944 suffix = "Touchscreen"; 1945 break; 1946 case HID_DG_TOUCHPAD: 1947 suffix = "Touchpad"; 1948 break; 1949 case HID_GD_SYSTEM_CONTROL: 1950 suffix = "System Control"; 1951 break; 1952 case HID_CP_CONSUMER_CONTROL: 1953 suffix = "Consumer Control"; 1954 break; 1955 case HID_GD_WIRELESS_RADIO_CTLS: 1956 suffix = "Wireless Radio Control"; 1957 break; 1958 case HID_GD_SYSTEM_MULTIAXIS: 1959 suffix = "System Multi Axis"; 1960 break; 1961 default: 1962 break; 1963 } 1964 } 1965 1966 if (suffix) { 1967 name_len = strlen(hid->name); 1968 suffix_len = strlen(suffix); 1969 if ((name_len < suffix_len) || 1970 strcmp(hid->name + name_len - suffix_len, suffix)) { 1971 hidinput->name = kasprintf(GFP_KERNEL, "%s %s", 1972 hid->name, suffix); 1973 if (!hidinput->name) 1974 goto fail; 1975 } 1976 } 1977 1978 input_set_drvdata(input_dev, hid); 1979 input_dev->event = hidinput_input_event; 1980 input_dev->open = hidinput_open; 1981 input_dev->close = hidinput_close; 1982 input_dev->setkeycode = hidinput_setkeycode; 1983 input_dev->getkeycode = hidinput_getkeycode; 1984 1985 input_dev->name = hidinput->name ? hidinput->name : hid->name; 1986 input_dev->phys = hid->phys; 1987 input_dev->uniq = hid->uniq; 1988 input_dev->id.bustype = hid->bus; 1989 input_dev->id.vendor = hid->vendor; 1990 input_dev->id.product = hid->product; 1991 input_dev->id.version = hid->version; 1992 input_dev->dev.parent = &hid->dev; 1993 1994 hidinput->input = input_dev; 1995 hidinput->application = application; 1996 list_add_tail(&hidinput->list, &hid->inputs); 1997 1998 INIT_LIST_HEAD(&hidinput->reports); 1999 2000 return hidinput; 2001 2002 fail: 2003 kfree(hidinput); 2004 input_free_device(input_dev); 2005 hid_err(hid, "Out of memory during hid input probe\n"); 2006 return NULL; 2007 } 2008 2009 static bool hidinput_has_been_populated(struct hid_input *hidinput) 2010 { 2011 int i; 2012 unsigned long r = 0; 2013 2014 for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++) 2015 r |= hidinput->input->evbit[i]; 2016 2017 for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++) 2018 r |= hidinput->input->keybit[i]; 2019 2020 for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++) 2021 r |= hidinput->input->relbit[i]; 2022 2023 for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++) 2024 r |= hidinput->input->absbit[i]; 2025 2026 for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++) 2027 r |= hidinput->input->mscbit[i]; 2028 2029 for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++) 2030 r |= hidinput->input->ledbit[i]; 2031 2032 for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++) 2033 r |= hidinput->input->sndbit[i]; 2034 2035 for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++) 2036 r |= hidinput->input->ffbit[i]; 2037 2038 for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++) 2039 r |= hidinput->input->swbit[i]; 2040 2041 return !!r; 2042 } 2043 2044 static void hidinput_cleanup_hidinput(struct hid_device *hid, 2045 struct hid_input *hidinput) 2046 { 2047 struct hid_report *report; 2048 int i, k; 2049 2050 list_del(&hidinput->list); 2051 input_free_device(hidinput->input); 2052 kfree(hidinput->name); 2053 2054 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) { 2055 if (k == HID_OUTPUT_REPORT && 2056 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS) 2057 continue; 2058 2059 list_for_each_entry(report, &hid->report_enum[k].report_list, 2060 list) { 2061 2062 for (i = 0; i < report->maxfield; i++) 2063 if (report->field[i]->hidinput == hidinput) 2064 report->field[i]->hidinput = NULL; 2065 } 2066 } 2067 2068 kfree(hidinput); 2069 } 2070 2071 static struct hid_input *hidinput_match(struct hid_report *report) 2072 { 2073 struct hid_device *hid = report->device; 2074 struct hid_input *hidinput; 2075 2076 list_for_each_entry(hidinput, &hid->inputs, list) { 2077 if (hidinput->report && 2078 hidinput->report->id == report->id) 2079 return hidinput; 2080 } 2081 2082 return NULL; 2083 } 2084 2085 static struct hid_input *hidinput_match_application(struct hid_report *report) 2086 { 2087 struct hid_device *hid = report->device; 2088 struct hid_input *hidinput; 2089 2090 list_for_each_entry(hidinput, &hid->inputs, list) { 2091 if (hidinput->application == report->application) 2092 return hidinput; 2093 2094 /* 2095 * Keep SystemControl and ConsumerControl applications together 2096 * with the main keyboard, if present. 2097 */ 2098 if ((report->application == HID_GD_SYSTEM_CONTROL || 2099 report->application == HID_CP_CONSUMER_CONTROL) && 2100 hidinput->application == HID_GD_KEYBOARD) { 2101 return hidinput; 2102 } 2103 } 2104 2105 return NULL; 2106 } 2107 2108 static inline void hidinput_configure_usages(struct hid_input *hidinput, 2109 struct hid_report *report) 2110 { 2111 int i, j, k; 2112 int first_field_index = 0; 2113 int slot_collection_index = -1; 2114 int prev_collection_index = -1; 2115 unsigned int slot_idx = 0; 2116 struct hid_field *field; 2117 2118 /* 2119 * First tag all the fields that are part of a slot, 2120 * a slot needs to have one Contact ID in the collection 2121 */ 2122 for (i = 0; i < report->maxfield; i++) { 2123 field = report->field[i]; 2124 2125 /* ignore fields without usage */ 2126 if (field->maxusage < 1) 2127 continue; 2128 2129 /* 2130 * janitoring when collection_index changes 2131 */ 2132 if (prev_collection_index != field->usage->collection_index) { 2133 prev_collection_index = field->usage->collection_index; 2134 first_field_index = i; 2135 } 2136 2137 /* 2138 * if we already found a Contact ID in the collection, 2139 * tag and continue to the next. 2140 */ 2141 if (slot_collection_index == field->usage->collection_index) { 2142 field->slot_idx = slot_idx; 2143 continue; 2144 } 2145 2146 /* check if the current field has Contact ID */ 2147 for (j = 0; j < field->maxusage; j++) { 2148 if (field->usage[j].hid == HID_DG_CONTACTID) { 2149 slot_collection_index = field->usage->collection_index; 2150 slot_idx++; 2151 2152 /* 2153 * mark all previous fields and this one in the 2154 * current collection to be slotted. 2155 */ 2156 for (k = first_field_index; k <= i; k++) 2157 report->field[k]->slot_idx = slot_idx; 2158 break; 2159 } 2160 } 2161 } 2162 2163 for (i = 0; i < report->maxfield; i++) 2164 for (j = 0; j < report->field[i]->maxusage; j++) 2165 hidinput_configure_usage(hidinput, report->field[i], 2166 report->field[i]->usage + j, 2167 j); 2168 } 2169 2170 /* 2171 * Register the input device; print a message. 2172 * Configure the input layer interface 2173 * Read all reports and initialize the absolute field values. 2174 */ 2175 2176 int hidinput_connect(struct hid_device *hid, unsigned int force) 2177 { 2178 struct hid_driver *drv = hid->driver; 2179 struct hid_report *report; 2180 struct hid_input *next, *hidinput = NULL; 2181 unsigned int application; 2182 int i, k; 2183 2184 INIT_LIST_HEAD(&hid->inputs); 2185 INIT_WORK(&hid->led_work, hidinput_led_worker); 2186 2187 hid->status &= ~HID_STAT_DUP_DETECTED; 2188 2189 if (!force) { 2190 for (i = 0; i < hid->maxcollection; i++) { 2191 struct hid_collection *col = &hid->collection[i]; 2192 if (col->type == HID_COLLECTION_APPLICATION || 2193 col->type == HID_COLLECTION_PHYSICAL) 2194 if (IS_INPUT_APPLICATION(col->usage)) 2195 break; 2196 } 2197 2198 if (i == hid->maxcollection) 2199 return -1; 2200 } 2201 2202 report_features(hid); 2203 2204 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) { 2205 if (k == HID_OUTPUT_REPORT && 2206 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS) 2207 continue; 2208 2209 list_for_each_entry(report, &hid->report_enum[k].report_list, list) { 2210 2211 if (!report->maxfield) 2212 continue; 2213 2214 application = report->application; 2215 2216 /* 2217 * Find the previous hidinput report attached 2218 * to this report id. 2219 */ 2220 if (hid->quirks & HID_QUIRK_MULTI_INPUT) 2221 hidinput = hidinput_match(report); 2222 else if (hid->maxapplication > 1 && 2223 (hid->quirks & HID_QUIRK_INPUT_PER_APP)) 2224 hidinput = hidinput_match_application(report); 2225 2226 if (!hidinput) { 2227 hidinput = hidinput_allocate(hid, application); 2228 if (!hidinput) 2229 goto out_unwind; 2230 } 2231 2232 hidinput_configure_usages(hidinput, report); 2233 2234 if (hid->quirks & HID_QUIRK_MULTI_INPUT) 2235 hidinput->report = report; 2236 2237 list_add_tail(&report->hidinput_list, 2238 &hidinput->reports); 2239 } 2240 } 2241 2242 hidinput_change_resolution_multipliers(hid); 2243 2244 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) { 2245 if (drv->input_configured && 2246 drv->input_configured(hid, hidinput)) 2247 goto out_unwind; 2248 2249 if (!hidinput_has_been_populated(hidinput)) { 2250 /* no need to register an input device not populated */ 2251 hidinput_cleanup_hidinput(hid, hidinput); 2252 continue; 2253 } 2254 2255 if (input_register_device(hidinput->input)) 2256 goto out_unwind; 2257 hidinput->registered = true; 2258 } 2259 2260 if (list_empty(&hid->inputs)) { 2261 hid_err(hid, "No inputs registered, leaving\n"); 2262 goto out_unwind; 2263 } 2264 2265 if (hid->status & HID_STAT_DUP_DETECTED) 2266 hid_dbg(hid, 2267 "Some usages could not be mapped, please use HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE if this is legitimate.\n"); 2268 2269 return 0; 2270 2271 out_unwind: 2272 /* unwind the ones we already registered */ 2273 hidinput_disconnect(hid); 2274 2275 return -1; 2276 } 2277 EXPORT_SYMBOL_GPL(hidinput_connect); 2278 2279 void hidinput_disconnect(struct hid_device *hid) 2280 { 2281 struct hid_input *hidinput, *next; 2282 2283 hidinput_cleanup_battery(hid); 2284 2285 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) { 2286 list_del(&hidinput->list); 2287 if (hidinput->registered) 2288 input_unregister_device(hidinput->input); 2289 else 2290 input_free_device(hidinput->input); 2291 kfree(hidinput->name); 2292 kfree(hidinput); 2293 } 2294 2295 /* led_work is spawned by input_dev callbacks, but doesn't access the 2296 * parent input_dev at all. Once all input devices are removed, we 2297 * know that led_work will never get restarted, so we can cancel it 2298 * synchronously and are safe. */ 2299 cancel_work_sync(&hid->led_work); 2300 } 2301 EXPORT_SYMBOL_GPL(hidinput_disconnect); 2302