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