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