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