drivers/hid/hid-input.c

   1 /*
   2  *  Copyright (c) 2000-2001 Vojtech Pavlik
   3  *  Copyright (c) 2006-2010 Jiri Kosina
   4  *
   5  *  HID to Linux Input mapping
   6  */
   7
   8 /*
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  22  *
  23  * Should you need to contact me, the author, you can do so either by
  24  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  25  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  26  */
  27
  28 #include <linux/module.h>
  29 #include <linux/slab.h>
  30 #include <linux/kernel.h>
  31
  32 #include <linux/hid.h>
  33 #include <linux/hid-debug.h>
  34
  35 #include "hid-ids.h"
  36
  37 #define unk     KEY_UNKNOWN
  38
  39 static const unsigned char hid_keyboard[256] = {
  40           0,  0,  0,  0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36, 37, 38,
  41          50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45, 21, 44,  2,  3,
  42           4,  5,  6,  7,  8,  9, 10, 11, 28,  1, 14, 15, 57, 12, 13, 26,
  43          27, 43, 43, 39, 40, 41, 51, 52, 53, 58, 59, 60, 61, 62, 63, 64,
  44          65, 66, 67, 68, 87, 88, 99, 70,119,110,102,104,111,107,109,106,
  45         105,108,103, 69, 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71,
  46          72, 73, 82, 83, 86,127,116,117,183,184,185,186,187,188,189,190,
  47         191,192,193,194,134,138,130,132,128,129,131,137,133,135,136,113,
  48         115,114,unk,unk,unk,121,unk, 89, 93,124, 92, 94, 95,unk,unk,unk,
  49         122,123, 90, 91, 85,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,
  50         unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
  51         unk,unk,unk,unk,unk,unk,179,180,unk,unk,unk,unk,unk,unk,unk,unk,
  52         unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
  53         unk,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,unk,unk,unk,unk,
  54          29, 42, 56,125, 97, 54,100,126,164,166,165,163,161,115,114,113,
  55         150,158,159,128,136,177,178,176,142,152,173,140,unk,unk,unk,unk
  56 };
  57
  58 static const struct {
  59         __s32 x;
  60         __s32 y;
  61 }  hid_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
  62
  63 #define map_abs(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_ABS, (c))
  64 #define map_rel(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_REL, (c))
  65 #define map_key(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_KEY, (c))
  66 #define map_led(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_LED, (c))
  67
  68 #define map_abs_clear(c)        hid_map_usage_clear(hidinput, usage, &bit, \
  69                 &max, EV_ABS, (c))
  70 #define map_key_clear(c)        hid_map_usage_clear(hidinput, usage, &bit, \
  71                 &max, EV_KEY, (c))
  72
  73 static bool match_scancode(struct hid_usage *usage,
  74                            unsigned int cur_idx, unsigned int scancode)
  75 {
  76         return (usage->hid & (HID_USAGE_PAGE | HID_USAGE)) == scancode;
  77 }
  78
  79 static bool match_keycode(struct hid_usage *usage,
  80                           unsigned int cur_idx, unsigned int keycode)
  81 {
  82         /*
  83          * We should exclude unmapped usages when doing lookup by keycode.
  84          */
  85         return (usage->type == EV_KEY && usage->code == keycode);
  86 }
  87
  88 static bool match_index(struct hid_usage *usage,
  89                         unsigned int cur_idx, unsigned int idx)
  90 {
  91         return cur_idx == idx;
  92 }
  93
  94 typedef bool (*hid_usage_cmp_t)(struct hid_usage *usage,
  95                                 unsigned int cur_idx, unsigned int val);
  96
  97 static struct hid_usage *hidinput_find_key(struct hid_device *hid,
  98                                            hid_usage_cmp_t match,
  99                                            unsigned int value,
 100                                            unsigned int *usage_idx)
 101 {
 102         unsigned int i, j, k, cur_idx = 0;
 103         struct hid_report *report;
 104         struct hid_usage *usage;
 105
 106         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
 107                 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
 108                         for (i = 0; i < report->maxfield; i++) {
 109                                 for (j = 0; j < report->field[i]->maxusage; j++) {
 110                                         usage = report->field[i]->usage + j;
 111                                         if (usage->type == EV_KEY || usage->type == 0) {
 112                                                 if (match(usage, cur_idx, value)) {
 113                                                         if (usage_idx)
 114                                                                 *usage_idx = cur_idx;
 115                                                         return usage;
 116                                                 }
 117                                                 cur_idx++;
 118                                         }
 119                                 }
 120                         }
 121                 }
 122         }
 123         return NULL;
 124 }
 125
 126 static struct hid_usage *hidinput_locate_usage(struct hid_device *hid,
 127                                         const struct input_keymap_entry *ke,
 128                                         unsigned int *index)
 129 {
 130         struct hid_usage *usage;
 131         unsigned int scancode;
 132
 133         if (ke->flags & INPUT_KEYMAP_BY_INDEX)
 134                 usage = hidinput_find_key(hid, match_index, ke->index, index);
 135         else if (input_scancode_to_scalar(ke, &scancode) == 0)
 136                 usage = hidinput_find_key(hid, match_scancode, scancode, index);
 137         else
 138                 usage = NULL;
 139
 140         return usage;
 141 }
 142
 143 static int hidinput_getkeycode(struct input_dev *dev,
 144                                struct input_keymap_entry *ke)
 145 {
 146         struct hid_device *hid = input_get_drvdata(dev);
 147         struct hid_usage *usage;
 148         unsigned int scancode, index;
 149
 150         usage = hidinput_locate_usage(hid, ke, &index);
 151         if (usage) {
 152                 ke->keycode = usage->type == EV_KEY ?
 153                                 usage->code : KEY_RESERVED;
 154                 ke->index = index;
 155                 scancode = usage->hid & (HID_USAGE_PAGE | HID_USAGE);
 156                 ke->len = sizeof(scancode);
 157                 memcpy(ke->scancode, &scancode, sizeof(scancode));
 158                 return 0;
 159         }
 160
 161         return -EINVAL;
 162 }
 163
 164 static int hidinput_setkeycode(struct input_dev *dev,
 165                                const struct input_keymap_entry *ke,
 166                                unsigned int *old_keycode)
 167 {
 168         struct hid_device *hid = input_get_drvdata(dev);
 169         struct hid_usage *usage;
 170
 171         usage = hidinput_locate_usage(hid, ke, NULL);
 172         if (usage) {
 173                 *old_keycode = usage->type == EV_KEY ?
 174                                 usage->code : KEY_RESERVED;
 175                 usage->code = ke->keycode;
 176
 177                 clear_bit(*old_keycode, dev->keybit);
 178                 set_bit(usage->code, dev->keybit);
 179                 dbg_hid("Assigned keycode %d to HID usage code %x\n",
 180                         usage->code, usage->hid);
 181
 182                 /*
 183                  * Set the keybit for the old keycode if the old keycode is used
 184                  * by another key
 185                  */
 186                 if (hidinput_find_key(hid, match_keycode, *old_keycode, NULL))
 187                         set_bit(*old_keycode, dev->keybit);
 188
 189                 return 0;
 190         }
 191
 192         return -EINVAL;
 193 }
 194
 195
 196 /**
 197  * hidinput_calc_abs_res - calculate an absolute axis resolution
 198  * @field: the HID report field to calculate resolution for
 199  * @code: axis code
 200  *
 201  * The formula is:
 202  *                         (logical_maximum - logical_minimum)
 203  * resolution = ----------------------------------------------------------
 204  *              (physical_maximum - physical_minimum) * 10 ^ unit_exponent
 205  *
 206  * as seen in the HID specification v1.11 6.2.2.7 Global Items.
 207  *
 208  * Only exponent 1 length units are processed. Centimeters and inches are
 209  * converted to millimeters. Degrees are converted to radians.
 210  */
 211 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code)
 212 {
 213         __s32 unit_exponent = field->unit_exponent;
 214         __s32 logical_extents = field->logical_maximum -
 215                                         field->logical_minimum;
 216         __s32 physical_extents = field->physical_maximum -
 217                                         field->physical_minimum;
 218         __s32 prev;
 219
 220         /* Check if the extents are sane */
 221         if (logical_extents <= 0 || physical_extents <= 0)
 222                 return 0;
 223
 224         /*
 225          * Verify and convert units.
 226          * See HID specification v1.11 6.2.2.7 Global Items for unit decoding
 227          */
 228         switch (code) {
 229         case ABS_X:
 230         case ABS_Y:
 231         case ABS_Z:
 232         case ABS_MT_POSITION_X:
 233         case ABS_MT_POSITION_Y:
 234         case ABS_MT_TOOL_X:
 235         case ABS_MT_TOOL_Y:
 236         case ABS_MT_TOUCH_MAJOR:
 237         case ABS_MT_TOUCH_MINOR:
 238                 if (field->unit == 0x11) {              /* If centimeters */
 239                         /* Convert to millimeters */
 240                         unit_exponent += 1;
 241                 } else if (field->unit == 0x13) {       /* If inches */
 242                         /* Convert to millimeters */
 243                         prev = physical_extents;
 244                         physical_extents *= 254;
 245                         if (physical_extents < prev)
 246                                 return 0;
 247                         unit_exponent -= 1;
 248                 } else {
 249                         return 0;
 250                 }
 251                 break;
 252
 253         case ABS_RX:
 254         case ABS_RY:
 255         case ABS_RZ:
 256         case ABS_TILT_X:
 257         case ABS_TILT_Y:
 258                 if (field->unit == 0x14) {              /* If degrees */
 259                         /* Convert to radians */
 260                         prev = logical_extents;
 261                         logical_extents *= 573;
 262                         if (logical_extents < prev)
 263                                 return 0;
 264                         unit_exponent += 1;
 265                 } else if (field->unit != 0x12) {       /* If not radians */
 266                         return 0;
 267                 }
 268                 break;
 269
 270         default:
 271                 return 0;
 272         }
 273
 274         /* Apply negative unit exponent */
 275         for (; unit_exponent < 0; unit_exponent++) {
 276                 prev = logical_extents;
 277                 logical_extents *= 10;
 278                 if (logical_extents < prev)
 279                         return 0;
 280         }
 281         /* Apply positive unit exponent */
 282         for (; unit_exponent > 0; unit_exponent--) {
 283                 prev = physical_extents;
 284                 physical_extents *= 10;
 285                 if (physical_extents < prev)
 286                         return 0;
 287         }
 288
 289         /* Calculate resolution */
 290         return DIV_ROUND_CLOSEST(logical_extents, physical_extents);
 291 }
 292 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res);
 293
 294 #ifdef CONFIG_HID_BATTERY_STRENGTH
 295 static enum power_supply_property hidinput_battery_props[] = {
 296         POWER_SUPPLY_PROP_PRESENT,
 297         POWER_SUPPLY_PROP_ONLINE,
 298         POWER_SUPPLY_PROP_CAPACITY,
 299         POWER_SUPPLY_PROP_MODEL_NAME,
 300         POWER_SUPPLY_PROP_STATUS,
 301         POWER_SUPPLY_PROP_SCOPE,
 302 };
 303
 304 #define HID_BATTERY_QUIRK_PERCENT       (1 << 0) /* always reports percent */
 305 #define HID_BATTERY_QUIRK_FEATURE       (1 << 1) /* ask for feature report */
 306 #define HID_BATTERY_QUIRK_IGNORE        (1 << 2) /* completely ignore the battery */
 307
 308 static const struct hid_device_id hid_battery_quirks[] = {
 309         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 310                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
 311           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
 312         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 313                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
 314           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
 315         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 316                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
 317           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
 318         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 319                                USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
 320           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
 321         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
 322                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
 323           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
 324         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM,
 325                 USB_DEVICE_ID_ELECOM_BM084),
 326           HID_BATTERY_QUIRK_IGNORE },
 327         { HID_USB_DEVICE(USB_VENDOR_ID_SYMBOL,
 328                 USB_DEVICE_ID_SYMBOL_SCANNER_3),
 329           HID_BATTERY_QUIRK_IGNORE },
 330         {}
 331 };
 332
 333 static unsigned find_battery_quirk(struct hid_device *hdev)
 334 {
 335         unsigned quirks = 0;
 336         const struct hid_device_id *match;
 337
 338         match = hid_match_id(hdev, hid_battery_quirks);
 339         if (match != NULL)
 340                 quirks = match->driver_data;
 341
 342         return quirks;
 343 }
 344
 345 static int hidinput_get_battery_property(struct power_supply *psy,
 346                                          enum power_supply_property prop,
 347                                          union power_supply_propval *val)
 348 {
 349         struct hid_device *dev = power_supply_get_drvdata(psy);
 350         int ret = 0;
 351         __u8 *buf;
 352
 353         switch (prop) {
 354         case POWER_SUPPLY_PROP_PRESENT:
 355         case POWER_SUPPLY_PROP_ONLINE:
 356                 val->intval = 1;
 357                 break;
 358
 359         case POWER_SUPPLY_PROP_CAPACITY:
 360
 361                 buf = kmalloc(2 * sizeof(__u8), GFP_KERNEL);
 362                 if (!buf) {
 363                         ret = -ENOMEM;
 364                         break;
 365                 }
 366                 ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 2,
 367                                          dev->battery_report_type,
 368                                          HID_REQ_GET_REPORT);
 369
 370                 if (ret != 2) {
 371                         ret = -ENODATA;
 372                         kfree(buf);
 373                         break;
 374                 }
 375                 ret = 0;
 376
 377                 if (dev->battery_min < dev->battery_max &&
 378                     buf[1] >= dev->battery_min &&
 379                     buf[1] <= dev->battery_max)
 380                         val->intval = (100 * (buf[1] - dev->battery_min)) /
 381                                 (dev->battery_max - dev->battery_min);
 382                 kfree(buf);
 383                 break;
 384
 385         case POWER_SUPPLY_PROP_MODEL_NAME:
 386                 val->strval = dev->name;
 387                 break;
 388
 389         case POWER_SUPPLY_PROP_STATUS:
 390                 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
 391                 break;
 392
 393         case POWER_SUPPLY_PROP_SCOPE:
 394                 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
 395                 break;
 396
 397         default:
 398                 ret = -EINVAL;
 399                 break;
 400         }
 401
 402         return ret;
 403 }
 404
 405 static bool hidinput_setup_battery(struct hid_device *dev, unsigned report_type, struct hid_field *field)
 406 {
 407         struct power_supply_desc *psy_desc = NULL;
 408         struct power_supply_config psy_cfg = { .drv_data = dev, };
 409         unsigned quirks;
 410         s32 min, max;
 411
 412         if (field->usage->hid != HID_DC_BATTERYSTRENGTH)
 413                 return false;   /* no match */
 414
 415         if (dev->battery != NULL)
 416                 goto out;       /* already initialized? */
 417
 418         quirks = find_battery_quirk(dev);
 419
 420         hid_dbg(dev, "device %x:%x:%x %d quirks %d\n",
 421                 dev->bus, dev->vendor, dev->product, dev->version, quirks);
 422
 423         if (quirks & HID_BATTERY_QUIRK_IGNORE)
 424                 goto out;
 425
 426         psy_desc = kzalloc(sizeof(*psy_desc), GFP_KERNEL);
 427         if (psy_desc == NULL)
 428                 goto out;
 429
 430         psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery", dev->uniq);
 431         if (psy_desc->name == NULL) {
 432                 kfree(psy_desc);
 433                 goto out;
 434         }
 435
 436         psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
 437         psy_desc->properties = hidinput_battery_props;
 438         psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props);
 439         psy_desc->use_for_apm = 0;
 440         psy_desc->get_property = hidinput_get_battery_property;
 441
 442         min = field->logical_minimum;
 443         max = field->logical_maximum;
 444
 445         if (quirks & HID_BATTERY_QUIRK_PERCENT) {
 446                 min = 0;
 447                 max = 100;
 448         }
 449
 450         if (quirks & HID_BATTERY_QUIRK_FEATURE)
 451                 report_type = HID_FEATURE_REPORT;
 452
 453         dev->battery_min = min;
 454         dev->battery_max = max;
 455         dev->battery_report_type = report_type;
 456         dev->battery_report_id = field->report->id;
 457
 458         dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg);
 459         if (IS_ERR(dev->battery)) {
 460                 hid_warn(dev, "can't register power supply: %ld\n",
 461                                 PTR_ERR(dev->battery));
 462                 kfree(psy_desc->name);
 463                 kfree(psy_desc);
 464                 dev->battery = NULL;
 465         } else {
 466                 power_supply_powers(dev->battery, &dev->dev);
 467         }
 468
 469 out:
 470         return true;
 471 }
 472
 473 static void hidinput_cleanup_battery(struct hid_device *dev)
 474 {
 475         const struct power_supply_desc *psy_desc;
 476
 477         if (!dev->battery)
 478                 return;
 479
 480         psy_desc = dev->battery->desc;
 481         power_supply_unregister(dev->battery);
 482         kfree(psy_desc->name);
 483         kfree(psy_desc);
 484         dev->battery = NULL;
 485 }
 486 #else  /* !CONFIG_HID_BATTERY_STRENGTH */
 487 static bool hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
 488                                    struct hid_field *field)
 489 {
 490         return false;
 491 }
 492
 493 static void hidinput_cleanup_battery(struct hid_device *dev)
 494 {
 495 }
 496 #endif  /* CONFIG_HID_BATTERY_STRENGTH */
 497
 498 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
 499                                      struct hid_usage *usage)
 500 {
 501         struct input_dev *input = hidinput->input;
 502         struct hid_device *device = input_get_drvdata(input);
 503         int max = 0, code;
 504         unsigned long *bit = NULL;
 505
 506         field->hidinput = hidinput;
 507
 508         if (field->flags & HID_MAIN_ITEM_CONSTANT)
 509                 goto ignore;
 510
 511         /* Ignore if report count is out of bounds. */
 512         if (field->report_count < 1)
 513                 goto ignore;
 514
 515         /* only LED usages are supported in output fields */
 516         if (field->report_type == HID_OUTPUT_REPORT &&
 517                         (usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
 518                 goto ignore;
 519         }
 520
 521         if (device->driver->input_mapping) {
 522                 int ret = device->driver->input_mapping(device, hidinput, field,
 523                                 usage, &bit, &max);
 524                 if (ret > 0)
 525                         goto mapped;
 526                 if (ret < 0)
 527                         goto ignore;
 528         }
 529
 530         switch (usage->hid & HID_USAGE_PAGE) {
 531         case HID_UP_UNDEFINED:
 532                 goto ignore;
 533
 534         case HID_UP_KEYBOARD:
 535                 set_bit(EV_REP, input->evbit);
 536
 537                 if ((usage->hid & HID_USAGE) < 256) {
 538                         if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
 539                         map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
 540                 } else
 541                         map_key(KEY_UNKNOWN);
 542
 543                 break;
 544
 545         case HID_UP_BUTTON:
 546                 code = ((usage->hid - 1) & HID_USAGE);
 547
 548                 switch (field->application) {
 549                 case HID_GD_MOUSE:
 550                 case HID_GD_POINTER:  code += BTN_MOUSE; break;
 551                 case HID_GD_JOYSTICK:
 552                                 if (code <= 0xf)
 553                                         code += BTN_JOYSTICK;
 554                                 else
 555                                         code += BTN_TRIGGER_HAPPY - 0x10;
 556                                 break;
 557                 case HID_GD_GAMEPAD:
 558                                 if (code <= 0xf)
 559                                         code += BTN_GAMEPAD;
 560                                 else
 561                                         code += BTN_TRIGGER_HAPPY - 0x10;
 562                                 break;
 563                 default:
 564                         switch (field->physical) {
 565                         case HID_GD_MOUSE:
 566                         case HID_GD_POINTER:  code += BTN_MOUSE; break;
 567                         case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break;
 568                         case HID_GD_GAMEPAD:  code += BTN_GAMEPAD; break;
 569                         default:              code += BTN_MISC;
 570                         }
 571                 }
 572
 573                 map_key(code);
 574                 break;
 575
 576         case HID_UP_SIMULATION:
 577                 switch (usage->hid & 0xffff) {
 578                 case 0xba: map_abs(ABS_RUDDER);   break;
 579                 case 0xbb: map_abs(ABS_THROTTLE); break;
 580                 case 0xc4: map_abs(ABS_GAS);      break;
 581                 case 0xc5: map_abs(ABS_BRAKE);    break;
 582                 case 0xc8: map_abs(ABS_WHEEL);    break;
 583                 default:   goto ignore;
 584                 }
 585                 break;
 586
 587         case HID_UP_GENDESK:
 588                 if ((usage->hid & 0xf0) == 0x80) {      /* SystemControl */
 589                         switch (usage->hid & 0xf) {
 590                         case 0x1: map_key_clear(KEY_POWER);  break;
 591                         case 0x2: map_key_clear(KEY_SLEEP);  break;
 592                         case 0x3: map_key_clear(KEY_WAKEUP); break;
 593                         case 0x4: map_key_clear(KEY_CONTEXT_MENU); break;
 594                         case 0x5: map_key_clear(KEY_MENU); break;
 595                         case 0x6: map_key_clear(KEY_PROG1); break;
 596                         case 0x7: map_key_clear(KEY_HELP); break;
 597                         case 0x8: map_key_clear(KEY_EXIT); break;
 598                         case 0x9: map_key_clear(KEY_SELECT); break;
 599                         case 0xa: map_key_clear(KEY_RIGHT); break;
 600                         case 0xb: map_key_clear(KEY_LEFT); break;
 601                         case 0xc: map_key_clear(KEY_UP); break;
 602                         case 0xd: map_key_clear(KEY_DOWN); break;
 603                         case 0xe: map_key_clear(KEY_POWER2); break;
 604                         case 0xf: map_key_clear(KEY_RESTART); break;
 605                         default: goto unknown;
 606                         }
 607                         break;
 608                 }
 609
 610                 if ((usage->hid & 0xf0) == 0xb0) {      /* SC - Display */
 611                         switch (usage->hid & 0xf) {
 612                         case 0x05: map_key_clear(KEY_SWITCHVIDEOMODE); break;
 613                         default: goto ignore;
 614                         }
 615                         break;
 616                 }
 617
 618                 /*
 619                  * Some lazy vendors declare 255 usages for System Control,
 620                  * leading to the creation of ABS_X|Y axis and too many others.
 621                  * It wouldn't be a problem if joydev doesn't consider the
 622                  * device as a joystick then.
 623                  */
 624                 if (field->application == HID_GD_SYSTEM_CONTROL)
 625                         goto ignore;
 626
 627                 if ((usage->hid & 0xf0) == 0x90) {      /* D-pad */
 628                         switch (usage->hid) {
 629                         case HID_GD_UP:    usage->hat_dir = 1; break;
 630                         case HID_GD_DOWN:  usage->hat_dir = 5; break;
 631                         case HID_GD_RIGHT: usage->hat_dir = 3; break;
 632                         case HID_GD_LEFT:  usage->hat_dir = 7; break;
 633                         default: goto unknown;
 634                         }
 635                         if (field->dpad) {
 636                                 map_abs(field->dpad);
 637                                 goto ignore;
 638                         }
 639                         map_abs(ABS_HAT0X);
 640                         break;
 641                 }
 642
 643                 switch (usage->hid) {
 644                 /* These usage IDs map directly to the usage codes. */
 645                 case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
 646                 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
 647                         if (field->flags & HID_MAIN_ITEM_RELATIVE)
 648                                 map_rel(usage->hid & 0xf);
 649                         else
 650                                 map_abs_clear(usage->hid & 0xf);
 651                         break;
 652
 653                 case HID_GD_SLIDER: case HID_GD_DIAL: case HID_GD_WHEEL:
 654                         if (field->flags & HID_MAIN_ITEM_RELATIVE)
 655                                 map_rel(usage->hid & 0xf);
 656                         else
 657                                 map_abs(usage->hid & 0xf);
 658                         break;
 659
 660                 case HID_GD_HATSWITCH:
 661                         usage->hat_min = field->logical_minimum;
 662                         usage->hat_max = field->logical_maximum;
 663                         map_abs(ABS_HAT0X);
 664                         break;
 665
 666                 case HID_GD_START:      map_key_clear(BTN_START);       break;
 667                 case HID_GD_SELECT:     map_key_clear(BTN_SELECT);      break;
 668
 669                 default: goto unknown;
 670                 }
 671
 672                 break;
 673
 674         case HID_UP_LED:
 675                 switch (usage->hid & 0xffff) {                /* HID-Value:                   */
 676                 case 0x01:  map_led (LED_NUML);     break;    /*   "Num Lock"                 */
 677                 case 0x02:  map_led (LED_CAPSL);    break;    /*   "Caps Lock"                */
 678                 case 0x03:  map_led (LED_SCROLLL);  break;    /*   "Scroll Lock"              */
 679                 case 0x04:  map_led (LED_COMPOSE);  break;    /*   "Compose"                  */
 680                 case 0x05:  map_led (LED_KANA);     break;    /*   "Kana"                     */
 681                 case 0x27:  map_led (LED_SLEEP);    break;    /*   "Stand-By"                 */
 682                 case 0x4c:  map_led (LED_SUSPEND);  break;    /*   "System Suspend"           */
 683                 case 0x09:  map_led (LED_MUTE);     break;    /*   "Mute"                     */
 684                 case 0x4b:  map_led (LED_MISC);     break;    /*   "Generic Indicator"        */
 685                 case 0x19:  map_led (LED_MAIL);     break;    /*   "Message Waiting"          */
 686                 case 0x4d:  map_led (LED_CHARGING); break;    /*   "External Power Connected" */
 687
 688                 default: goto ignore;
 689                 }
 690                 break;
 691
 692         case HID_UP_DIGITIZER:
 693                 switch (usage->hid & 0xff) {
 694                 case 0x00: /* Undefined */
 695                         goto ignore;
 696
 697                 case 0x30: /* TipPressure */
 698                         if (!test_bit(BTN_TOUCH, input->keybit)) {
 699                                 device->quirks |= HID_QUIRK_NOTOUCH;
 700                                 set_bit(EV_KEY, input->evbit);
 701                                 set_bit(BTN_TOUCH, input->keybit);
 702                         }
 703                         map_abs_clear(ABS_PRESSURE);
 704                         break;
 705
 706                 case 0x32: /* InRange */
 707                         switch (field->physical & 0xff) {
 708                         case 0x21: map_key(BTN_TOOL_MOUSE); break;
 709                         case 0x22: map_key(BTN_TOOL_FINGER); break;
 710                         default: map_key(BTN_TOOL_PEN); break;
 711                         }
 712                         break;
 713
 714                 case 0x3c: /* Invert */
 715                         map_key_clear(BTN_TOOL_RUBBER);
 716                         break;
 717
 718                 case 0x3d: /* X Tilt */
 719                         map_abs_clear(ABS_TILT_X);
 720                         break;
 721
 722                 case 0x3e: /* Y Tilt */
 723                         map_abs_clear(ABS_TILT_Y);
 724                         break;
 725
 726                 case 0x33: /* Touch */
 727                 case 0x42: /* TipSwitch */
 728                 case 0x43: /* TipSwitch2 */
 729                         device->quirks &= ~HID_QUIRK_NOTOUCH;
 730                         map_key_clear(BTN_TOUCH);
 731                         break;
 732
 733                 case 0x44: /* BarrelSwitch */
 734                         map_key_clear(BTN_STYLUS);
 735                         break;
 736
 737                 case 0x46: /* TabletPick */
 738                 case 0x5a: /* SecondaryBarrelSwitch */
 739                         map_key_clear(BTN_STYLUS2);
 740                         break;
 741
 742                 case 0x5b: /* TransducerSerialNumber */
 743                         usage->type = EV_MSC;
 744                         usage->code = MSC_SERIAL;
 745                         bit = input->mscbit;
 746                         max = MSC_MAX;
 747                         break;
 748
 749                 default:  goto unknown;
 750                 }
 751                 break;
 752
 753         case HID_UP_TELEPHONY:
 754                 switch (usage->hid & HID_USAGE) {
 755                 case 0x2f: map_key_clear(KEY_MICMUTE);          break;
 756                 case 0xb0: map_key_clear(KEY_NUMERIC_0);        break;
 757                 case 0xb1: map_key_clear(KEY_NUMERIC_1);        break;
 758                 case 0xb2: map_key_clear(KEY_NUMERIC_2);        break;
 759                 case 0xb3: map_key_clear(KEY_NUMERIC_3);        break;
 760                 case 0xb4: map_key_clear(KEY_NUMERIC_4);        break;
 761                 case 0xb5: map_key_clear(KEY_NUMERIC_5);        break;
 762                 case 0xb6: map_key_clear(KEY_NUMERIC_6);        break;
 763                 case 0xb7: map_key_clear(KEY_NUMERIC_7);        break;
 764                 case 0xb8: map_key_clear(KEY_NUMERIC_8);        break;
 765                 case 0xb9: map_key_clear(KEY_NUMERIC_9);        break;
 766                 case 0xba: map_key_clear(KEY_NUMERIC_STAR);     break;
 767                 case 0xbb: map_key_clear(KEY_NUMERIC_POUND);    break;
 768                 case 0xbc: map_key_clear(KEY_NUMERIC_A);        break;
 769                 case 0xbd: map_key_clear(KEY_NUMERIC_B);        break;
 770                 case 0xbe: map_key_clear(KEY_NUMERIC_C);        break;
 771                 case 0xbf: map_key_clear(KEY_NUMERIC_D);        break;
 772                 default: goto ignore;
 773                 }
 774                 break;
 775
 776         case HID_UP_CONSUMER:   /* USB HUT v1.12, pages 75-84 */
 777                 switch (usage->hid & HID_USAGE) {
 778                 case 0x000: goto ignore;
 779                 case 0x030: map_key_clear(KEY_POWER);           break;
 780                 case 0x031: map_key_clear(KEY_RESTART);         break;
 781                 case 0x032: map_key_clear(KEY_SLEEP);           break;
 782                 case 0x034: map_key_clear(KEY_SLEEP);           break;
 783                 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE);  break;
 784                 case 0x036: map_key_clear(BTN_MISC);            break;
 785
 786                 case 0x040: map_key_clear(KEY_MENU);            break; /* Menu */
 787                 case 0x041: map_key_clear(KEY_SELECT);          break; /* Menu Pick */
 788                 case 0x042: map_key_clear(KEY_UP);              break; /* Menu Up */
 789                 case 0x043: map_key_clear(KEY_DOWN);            break; /* Menu Down */
 790                 case 0x044: map_key_clear(KEY_LEFT);            break; /* Menu Left */
 791                 case 0x045: map_key_clear(KEY_RIGHT);           break; /* Menu Right */
 792                 case 0x046: map_key_clear(KEY_ESC);             break; /* Menu Escape */
 793                 case 0x047: map_key_clear(KEY_KPPLUS);          break; /* Menu Value Increase */
 794                 case 0x048: map_key_clear(KEY_KPMINUS);         break; /* Menu Value Decrease */
 795
 796                 case 0x060: map_key_clear(KEY_INFO);            break; /* Data On Screen */
 797                 case 0x061: map_key_clear(KEY_SUBTITLE);        break; /* Closed Caption */
 798                 case 0x063: map_key_clear(KEY_VCR);             break; /* VCR/TV */
 799                 case 0x065: map_key_clear(KEY_CAMERA);          break; /* Snapshot */
 800                 case 0x069: map_key_clear(KEY_RED);             break;
 801                 case 0x06a: map_key_clear(KEY_GREEN);           break;
 802                 case 0x06b: map_key_clear(KEY_BLUE);            break;
 803                 case 0x06c: map_key_clear(KEY_YELLOW);          break;
 804                 case 0x06d: map_key_clear(KEY_ZOOM);            break;
 805
 806                 case 0x06f: map_key_clear(KEY_BRIGHTNESSUP);            break;
 807                 case 0x070: map_key_clear(KEY_BRIGHTNESSDOWN);          break;
 808                 case 0x072: map_key_clear(KEY_BRIGHTNESS_TOGGLE);       break;
 809                 case 0x073: map_key_clear(KEY_BRIGHTNESS_MIN);          break;
 810                 case 0x074: map_key_clear(KEY_BRIGHTNESS_MAX);          break;
 811                 case 0x075: map_key_clear(KEY_BRIGHTNESS_AUTO);         break;
 812
 813                 case 0x079: map_key_clear(KEY_KBDILLUMUP);      break;
 814                 case 0x07a: map_key_clear(KEY_KBDILLUMDOWN);    break;
 815                 case 0x07c: map_key_clear(KEY_KBDILLUMTOGGLE);  break;
 816
 817                 case 0x082: map_key_clear(KEY_VIDEO_NEXT);      break;
 818                 case 0x083: map_key_clear(KEY_LAST);            break;
 819                 case 0x084: map_key_clear(KEY_ENTER);           break;
 820                 case 0x088: map_key_clear(KEY_PC);              break;
 821                 case 0x089: map_key_clear(KEY_TV);              break;
 822                 case 0x08a: map_key_clear(KEY_WWW);             break;
 823                 case 0x08b: map_key_clear(KEY_DVD);             break;
 824                 case 0x08c: map_key_clear(KEY_PHONE);           break;
 825                 case 0x08d: map_key_clear(KEY_PROGRAM);         break;
 826                 case 0x08e: map_key_clear(KEY_VIDEOPHONE);      break;
 827                 case 0x08f: map_key_clear(KEY_GAMES);           break;
 828                 case 0x090: map_key_clear(KEY_MEMO);            break;
 829                 case 0x091: map_key_clear(KEY_CD);              break;
 830                 case 0x092: map_key_clear(KEY_VCR);             break;
 831                 case 0x093: map_key_clear(KEY_TUNER);           break;
 832                 case 0x094: map_key_clear(KEY_EXIT);            break;
 833                 case 0x095: map_key_clear(KEY_HELP);            break;
 834                 case 0x096: map_key_clear(KEY_TAPE);            break;
 835                 case 0x097: map_key_clear(KEY_TV2);             break;
 836                 case 0x098: map_key_clear(KEY_SAT);             break;
 837                 case 0x09a: map_key_clear(KEY_PVR);             break;
 838
 839                 case 0x09c: map_key_clear(KEY_CHANNELUP);       break;
 840                 case 0x09d: map_key_clear(KEY_CHANNELDOWN);     break;
 841                 case 0x0a0: map_key_clear(KEY_VCR2);            break;
 842
 843                 case 0x0b0: map_key_clear(KEY_PLAY);            break;
 844                 case 0x0b1: map_key_clear(KEY_PAUSE);           break;
 845                 case 0x0b2: map_key_clear(KEY_RECORD);          break;
 846                 case 0x0b3: map_key_clear(KEY_FASTFORWARD);     break;
 847                 case 0x0b4: map_key_clear(KEY_REWIND);          break;
 848                 case 0x0b5: map_key_clear(KEY_NEXTSONG);        break;
 849                 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG);    break;
 850                 case 0x0b7: map_key_clear(KEY_STOPCD);          break;
 851                 case 0x0b8: map_key_clear(KEY_EJECTCD);         break;
 852                 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT);    break;
 853                 case 0x0b9: map_key_clear(KEY_SHUFFLE);         break;
 854                 case 0x0bf: map_key_clear(KEY_SLOW);            break;
 855
 856                 case 0x0cd: map_key_clear(KEY_PLAYPAUSE);       break;
 857                 case 0x0cf: map_key_clear(KEY_VOICECOMMAND);    break;
 858                 case 0x0e0: map_abs_clear(ABS_VOLUME);          break;
 859                 case 0x0e2: map_key_clear(KEY_MUTE);            break;
 860                 case 0x0e5: map_key_clear(KEY_BASSBOOST);       break;
 861                 case 0x0e9: map_key_clear(KEY_VOLUMEUP);        break;
 862                 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN);      break;
 863                 case 0x0f5: map_key_clear(KEY_SLOW);            break;
 864
 865                 case 0x181: map_key_clear(KEY_BUTTONCONFIG);    break;
 866                 case 0x182: map_key_clear(KEY_BOOKMARKS);       break;
 867                 case 0x183: map_key_clear(KEY_CONFIG);          break;
 868                 case 0x184: map_key_clear(KEY_WORDPROCESSOR);   break;
 869                 case 0x185: map_key_clear(KEY_EDITOR);          break;
 870                 case 0x186: map_key_clear(KEY_SPREADSHEET);     break;
 871                 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR);  break;
 872                 case 0x188: map_key_clear(KEY_PRESENTATION);    break;
 873                 case 0x189: map_key_clear(KEY_DATABASE);        break;
 874                 case 0x18a: map_key_clear(KEY_MAIL);            break;
 875                 case 0x18b: map_key_clear(KEY_NEWS);            break;
 876                 case 0x18c: map_key_clear(KEY_VOICEMAIL);       break;
 877                 case 0x18d: map_key_clear(KEY_ADDRESSBOOK);     break;
 878                 case 0x18e: map_key_clear(KEY_CALENDAR);        break;
 879                 case 0x18f: map_key_clear(KEY_TASKMANAGER);     break;
 880                 case 0x190: map_key_clear(KEY_JOURNAL);         break;
 881                 case 0x191: map_key_clear(KEY_FINANCE);         break;
 882                 case 0x192: map_key_clear(KEY_CALC);            break;
 883                 case 0x193: map_key_clear(KEY_PLAYER);          break;
 884                 case 0x194: map_key_clear(KEY_FILE);            break;
 885                 case 0x196: map_key_clear(KEY_WWW);             break;
 886                 case 0x199: map_key_clear(KEY_CHAT);            break;
 887                 case 0x19c: map_key_clear(KEY_LOGOFF);          break;
 888                 case 0x19e: map_key_clear(KEY_COFFEE);          break;
 889                 case 0x19f: map_key_clear(KEY_CONTROLPANEL);            break;
 890                 case 0x1a2: map_key_clear(KEY_APPSELECT);               break;
 891                 case 0x1a3: map_key_clear(KEY_NEXT);            break;
 892                 case 0x1a4: map_key_clear(KEY_PREVIOUS);        break;
 893                 case 0x1a6: map_key_clear(KEY_HELP);            break;
 894                 case 0x1a7: map_key_clear(KEY_DOCUMENTS);       break;
 895                 case 0x1ab: map_key_clear(KEY_SPELLCHECK);      break;
 896                 case 0x1ae: map_key_clear(KEY_KEYBOARD);        break;
 897                 case 0x1b1: map_key_clear(KEY_SCREENSAVER);             break;
 898                 case 0x1b4: map_key_clear(KEY_FILE);            break;
 899                 case 0x1b6: map_key_clear(KEY_IMAGES);          break;
 900                 case 0x1b7: map_key_clear(KEY_AUDIO);           break;
 901                 case 0x1b8: map_key_clear(KEY_VIDEO);           break;
 902                 case 0x1bc: map_key_clear(KEY_MESSENGER);       break;
 903                 case 0x1bd: map_key_clear(KEY_INFO);            break;
 904                 case 0x201: map_key_clear(KEY_NEW);             break;
 905                 case 0x202: map_key_clear(KEY_OPEN);            break;
 906                 case 0x203: map_key_clear(KEY_CLOSE);           break;
 907                 case 0x204: map_key_clear(KEY_EXIT);            break;
 908                 case 0x207: map_key_clear(KEY_SAVE);            break;
 909                 case 0x208: map_key_clear(KEY_PRINT);           break;
 910                 case 0x209: map_key_clear(KEY_PROPS);           break;
 911                 case 0x21a: map_key_clear(KEY_UNDO);            break;
 912                 case 0x21b: map_key_clear(KEY_COPY);            break;
 913                 case 0x21c: map_key_clear(KEY_CUT);             break;
 914                 case 0x21d: map_key_clear(KEY_PASTE);           break;
 915                 case 0x21f: map_key_clear(KEY_FIND);            break;
 916                 case 0x221: map_key_clear(KEY_SEARCH);          break;
 917                 case 0x222: map_key_clear(KEY_GOTO);            break;
 918                 case 0x223: map_key_clear(KEY_HOMEPAGE);        break;
 919                 case 0x224: map_key_clear(KEY_BACK);            break;
 920                 case 0x225: map_key_clear(KEY_FORWARD);         break;
 921                 case 0x226: map_key_clear(KEY_STOP);            break;
 922                 case 0x227: map_key_clear(KEY_REFRESH);         break;
 923                 case 0x22a: map_key_clear(KEY_BOOKMARKS);       break;
 924                 case 0x22d: map_key_clear(KEY_ZOOMIN);          break;
 925                 case 0x22e: map_key_clear(KEY_ZOOMOUT);         break;
 926                 case 0x22f: map_key_clear(KEY_ZOOMRESET);       break;
 927                 case 0x233: map_key_clear(KEY_SCROLLUP);        break;
 928                 case 0x234: map_key_clear(KEY_SCROLLDOWN);      break;
 929                 case 0x238: map_rel(REL_HWHEEL);                break;
 930                 case 0x23d: map_key_clear(KEY_EDIT);            break;
 931                 case 0x25f: map_key_clear(KEY_CANCEL);          break;
 932                 case 0x269: map_key_clear(KEY_INSERT);          break;
 933                 case 0x26a: map_key_clear(KEY_DELETE);          break;
 934                 case 0x279: map_key_clear(KEY_REDO);            break;
 935
 936                 case 0x289: map_key_clear(KEY_REPLY);           break;
 937                 case 0x28b: map_key_clear(KEY_FORWARDMAIL);     break;
 938                 case 0x28c: map_key_clear(KEY_SEND);            break;
 939
 940                 case 0x2c7: map_key_clear(KEY_KBDINPUTASSIST_PREV);             break;
 941                 case 0x2c8: map_key_clear(KEY_KBDINPUTASSIST_NEXT);             break;
 942                 case 0x2c9: map_key_clear(KEY_KBDINPUTASSIST_PREVGROUP);                break;
 943                 case 0x2ca: map_key_clear(KEY_KBDINPUTASSIST_NEXTGROUP);                break;
 944                 case 0x2cb: map_key_clear(KEY_KBDINPUTASSIST_ACCEPT);   break;
 945                 case 0x2cc: map_key_clear(KEY_KBDINPUTASSIST_CANCEL);   break;
 946
 947                 case 0x29f: map_key_clear(KEY_SCALE);           break;
 948
 949                 default: map_key_clear(KEY_UNKNOWN);
 950                 }
 951                 break;
 952
 953         case HID_UP_GENDEVCTRLS:
 954                 if (hidinput_setup_battery(device, HID_INPUT_REPORT, field))
 955                         goto ignore;
 956                 else
 957                         goto unknown;
 958                 break;
 959
 960         case HID_UP_HPVENDOR:   /* Reported on a Dutch layout HP5308 */
 961                 set_bit(EV_REP, input->evbit);
 962                 switch (usage->hid & HID_USAGE) {
 963                 case 0x021: map_key_clear(KEY_PRINT);           break;
 964                 case 0x070: map_key_clear(KEY_HP);              break;
 965                 case 0x071: map_key_clear(KEY_CAMERA);          break;
 966                 case 0x072: map_key_clear(KEY_SOUND);           break;
 967                 case 0x073: map_key_clear(KEY_QUESTION);        break;
 968                 case 0x080: map_key_clear(KEY_EMAIL);           break;
 969                 case 0x081: map_key_clear(KEY_CHAT);            break;
 970                 case 0x082: map_key_clear(KEY_SEARCH);          break;
 971                 case 0x083: map_key_clear(KEY_CONNECT);         break;
 972                 case 0x084: map_key_clear(KEY_FINANCE);         break;
 973                 case 0x085: map_key_clear(KEY_SPORT);           break;
 974                 case 0x086: map_key_clear(KEY_SHOP);            break;
 975                 default:    goto ignore;
 976                 }
 977                 break;
 978
 979         case HID_UP_HPVENDOR2:
 980                 set_bit(EV_REP, input->evbit);
 981                 switch (usage->hid & HID_USAGE) {
 982                 case 0x001: map_key_clear(KEY_MICMUTE);         break;
 983                 case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN);  break;
 984                 case 0x004: map_key_clear(KEY_BRIGHTNESSUP);    break;
 985                 default:    goto ignore;
 986                 }
 987                 break;
 988
 989         case HID_UP_MSVENDOR:
 990                 goto ignore;
 991
 992         case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
 993                 set_bit(EV_REP, input->evbit);
 994                 goto ignore;
 995
 996         case HID_UP_LOGIVENDOR:
 997                 /* intentional fallback */
 998         case HID_UP_LOGIVENDOR2:
 999                 /* intentional fallback */
1000         case HID_UP_LOGIVENDOR3:
1001                 goto ignore;
1002
1003         case HID_UP_PID:
1004                 switch (usage->hid & HID_USAGE) {
1005                 case 0xa4: map_key_clear(BTN_DEAD);     break;
1006                 default: goto ignore;
1007                 }
1008                 break;
1009
1010         default:
1011         unknown:
1012                 if (field->report_size == 1) {
1013                         if (field->report->type == HID_OUTPUT_REPORT) {
1014                                 map_led(LED_MISC);
1015                                 break;
1016                         }
1017                         map_key(BTN_MISC);
1018                         break;
1019                 }
1020                 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
1021                         map_rel(REL_MISC);
1022                         break;
1023                 }
1024                 map_abs(ABS_MISC);
1025                 break;
1026         }
1027
1028 mapped:
1029         /* Mapping failed, bail out */
1030         if (!bit)
1031                 return;
1032
1033         if (device->driver->input_mapped &&
1034             device->driver->input_mapped(device, hidinput, field, usage,
1035                                          &bit, &max) < 0) {
1036                 /*
1037                  * The driver indicated that no further generic handling
1038                  * of the usage is desired.
1039                  */
1040                 return;
1041         }
1042
1043         set_bit(usage->type, input->evbit);
1044
1045         while (usage->code <= max && test_and_set_bit(usage->code, bit))
1046                 usage->code = find_next_zero_bit(bit, max + 1, usage->code);
1047
1048         if (usage->code > max)
1049                 goto ignore;
1050
1051
1052         if (usage->type == EV_ABS) {
1053
1054                 int a = field->logical_minimum;
1055                 int b = field->logical_maximum;
1056
1057                 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
1058                         a = field->logical_minimum = 0;
1059                         b = field->logical_maximum = 255;
1060                 }
1061
1062                 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
1063                         input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
1064                 else    input_set_abs_params(input, usage->code, a, b, 0, 0);
1065
1066                 input_abs_set_res(input, usage->code,
1067                                   hidinput_calc_abs_res(field, usage->code));
1068
1069                 /* use a larger default input buffer for MT devices */
1070                 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
1071                         input_set_events_per_packet(input, 60);
1072         }
1073
1074         if (usage->type == EV_ABS &&
1075             (usage->hat_min < usage->hat_max || usage->hat_dir)) {
1076                 int i;
1077                 for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
1078                         input_set_abs_params(input, i, -1, 1, 0, 0);
1079                         set_bit(i, input->absbit);
1080                 }
1081                 if (usage->hat_dir && !field->dpad)
1082                         field->dpad = usage->code;
1083         }
1084
1085         /* for those devices which produce Consumer volume usage as relative,
1086          * we emulate pressing volumeup/volumedown appropriate number of times
1087          * in hidinput_hid_event()
1088          */
1089         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1090                         (usage->code == ABS_VOLUME)) {
1091                 set_bit(KEY_VOLUMEUP, input->keybit);
1092                 set_bit(KEY_VOLUMEDOWN, input->keybit);
1093         }
1094
1095         if (usage->type == EV_KEY) {
1096                 set_bit(EV_MSC, input->evbit);
1097                 set_bit(MSC_SCAN, input->mscbit);
1098         }
1099
1100         return;
1101
1102 ignore:
1103         usage->type = 0;
1104         usage->code = 0;
1105 }
1106
1107 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
1108 {
1109         struct input_dev *input;
1110         unsigned *quirks = &hid->quirks;
1111
1112         if (!field->hidinput)
1113                 return;
1114
1115         input = field->hidinput->input;
1116
1117         if (!usage->type)
1118                 return;
1119
1120         if (usage->hat_min < usage->hat_max || usage->hat_dir) {
1121                 int hat_dir = usage->hat_dir;
1122                 if (!hat_dir)
1123                         hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
1124                 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
1125                 input_event(input, usage->type, usage->code    , hid_hat_to_axis[hat_dir].x);
1126                 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
1127                 return;
1128         }
1129
1130         if (usage->hid == (HID_UP_DIGITIZER | 0x003c)) { /* Invert */
1131                 *quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
1132                 return;
1133         }
1134
1135         if (usage->hid == (HID_UP_DIGITIZER | 0x0032)) { /* InRange */
1136                 if (value) {
1137                         input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
1138                         return;
1139                 }
1140                 input_event(input, usage->type, usage->code, 0);
1141                 input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
1142                 return;
1143         }
1144
1145         if (usage->hid == (HID_UP_DIGITIZER | 0x0030) && (*quirks & HID_QUIRK_NOTOUCH)) { /* Pressure */
1146                 int a = field->logical_minimum;
1147                 int b = field->logical_maximum;
1148                 input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
1149         }
1150
1151         if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
1152                 dbg_hid("Maximum Effects - %d\n",value);
1153                 return;
1154         }
1155
1156         if (usage->hid == (HID_UP_PID | 0x7fUL)) {
1157                 dbg_hid("PID Pool Report\n");
1158                 return;
1159         }
1160
1161         if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1162                 return;
1163
1164         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1165                         (usage->code == ABS_VOLUME)) {
1166                 int count = abs(value);
1167                 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
1168                 int i;
1169
1170                 for (i = 0; i < count; i++) {
1171                         input_event(input, EV_KEY, direction, 1);
1172                         input_sync(input);
1173                         input_event(input, EV_KEY, direction, 0);
1174                         input_sync(input);
1175                 }
1176                 return;
1177         }
1178
1179         /*
1180          * Ignore out-of-range values as per HID specification,
1181          * section 5.10 and 6.2.25, when NULL state bit is present.
1182          * When it's not, clamp the value to match Microsoft's input
1183          * driver as mentioned in "Required HID usages for digitizers":
1184          * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp
1185          *
1186          * The logical_minimum < logical_maximum check is done so that we
1187          * don't unintentionally discard values sent by devices which
1188          * don't specify logical min and max.
1189          */
1190         if ((field->flags & HID_MAIN_ITEM_VARIABLE) &&
1191             (field->logical_minimum < field->logical_maximum)) {
1192                 if (field->flags & HID_MAIN_ITEM_NULL_STATE &&
1193                     (value < field->logical_minimum ||
1194                      value > field->logical_maximum)) {
1195                         dbg_hid("Ignoring out-of-range value %x\n", value);
1196                         return;
1197                 }
1198                 value = clamp(value,
1199                               field->logical_minimum,
1200                               field->logical_maximum);
1201         }
1202
1203         /*
1204          * Ignore reports for absolute data if the data didn't change. This is
1205          * not only an optimization but also fixes 'dead' key reports. Some
1206          * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID
1207          * 0x31 and 0x32) report multiple keys, even though a localized keyboard
1208          * can only have one of them physically available. The 'dead' keys
1209          * report constant 0. As all map to the same keycode, they'd confuse
1210          * the input layer. If we filter the 'dead' keys on the HID level, we
1211          * skip the keycode translation and only forward real events.
1212          */
1213         if (!(field->flags & (HID_MAIN_ITEM_RELATIVE |
1214                               HID_MAIN_ITEM_BUFFERED_BYTE)) &&
1215                               (field->flags & HID_MAIN_ITEM_VARIABLE) &&
1216             usage->usage_index < field->maxusage &&
1217             value == field->value[usage->usage_index])
1218                 return;
1219
1220         /* report the usage code as scancode if the key status has changed */
1221         if (usage->type == EV_KEY &&
1222             (!test_bit(usage->code, input->key)) == value)
1223                 input_event(input, EV_MSC, MSC_SCAN, usage->hid);
1224
1225         input_event(input, usage->type, usage->code, value);
1226
1227         if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1228             usage->type == EV_KEY && value) {
1229                 input_sync(input);
1230                 input_event(input, usage->type, usage->code, 0);
1231         }
1232 }
1233
1234 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
1235 {
1236         struct hid_input *hidinput;
1237
1238         if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
1239                 return;
1240
1241         list_for_each_entry(hidinput, &hid->inputs, list)
1242                 input_sync(hidinput->input);
1243 }
1244 EXPORT_SYMBOL_GPL(hidinput_report_event);
1245
1246 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
1247 {
1248         struct hid_report *report;
1249         int i, j;
1250
1251         list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
1252                 for (i = 0; i < report->maxfield; i++) {
1253                         *field = report->field[i];
1254                         for (j = 0; j < (*field)->maxusage; j++)
1255                                 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1256                                         return j;
1257                 }
1258         }
1259         return -1;
1260 }
1261 EXPORT_SYMBOL_GPL(hidinput_find_field);
1262
1263 struct hid_field *hidinput_get_led_field(struct hid_device *hid)
1264 {
1265         struct hid_report *report;
1266         struct hid_field *field;
1267         int i, j;
1268
1269         list_for_each_entry(report,
1270                             &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1271                             list) {
1272                 for (i = 0; i < report->maxfield; i++) {
1273                         field = report->field[i];
1274                         for (j = 0; j < field->maxusage; j++)
1275                                 if (field->usage[j].type == EV_LED)
1276                                         return field;
1277                 }
1278         }
1279         return NULL;
1280 }
1281 EXPORT_SYMBOL_GPL(hidinput_get_led_field);
1282
1283 unsigned int hidinput_count_leds(struct hid_device *hid)
1284 {
1285         struct hid_report *report;
1286         struct hid_field *field;
1287         int i, j;
1288         unsigned int count = 0;
1289
1290         list_for_each_entry(report,
1291                             &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1292                             list) {
1293                 for (i = 0; i < report->maxfield; i++) {
1294                         field = report->field[i];
1295                         for (j = 0; j < field->maxusage; j++)
1296                                 if (field->usage[j].type == EV_LED &&
1297                                     field->value[j])
1298                                         count += 1;
1299                 }
1300         }
1301         return count;
1302 }
1303 EXPORT_SYMBOL_GPL(hidinput_count_leds);
1304
1305 static void hidinput_led_worker(struct work_struct *work)
1306 {
1307         struct hid_device *hid = container_of(work, struct hid_device,
1308                                               led_work);
1309         struct hid_field *field;
1310         struct hid_report *report;
1311         int ret;
1312         u32 len;
1313         __u8 *buf;
1314
1315         field = hidinput_get_led_field(hid);
1316         if (!field)
1317                 return;
1318
1319         /*
1320          * field->report is accessed unlocked regarding HID core. So there might
1321          * be another incoming SET-LED request from user-space, which changes
1322          * the LED state while we assemble our outgoing buffer. However, this
1323          * doesn't matter as hid_output_report() correctly converts it into a
1324          * boolean value no matter what information is currently set on the LED
1325          * field (even garbage). So the remote device will always get a valid
1326          * request.
1327          * And in case we send a wrong value, a next led worker is spawned
1328          * for every SET-LED request so the following worker will send the
1329          * correct value, guaranteed!
1330          */
1331
1332         report = field->report;
1333
1334         /* use custom SET_REPORT request if possible (asynchronous) */
1335         if (hid->ll_driver->request)
1336                 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT);
1337
1338         /* fall back to generic raw-output-report */
1339         len = hid_report_len(report);
1340         buf = hid_alloc_report_buf(report, GFP_KERNEL);
1341         if (!buf)
1342                 return;
1343
1344         hid_output_report(report, buf);
1345         /* synchronous output report */
1346         ret = hid_hw_output_report(hid, buf, len);
1347         if (ret == -ENOSYS)
1348                 hid_hw_raw_request(hid, report->id, buf, len, HID_OUTPUT_REPORT,
1349                                 HID_REQ_SET_REPORT);
1350         kfree(buf);
1351 }
1352
1353 static int hidinput_input_event(struct input_dev *dev, unsigned int type,
1354                                 unsigned int code, int value)
1355 {
1356         struct hid_device *hid = input_get_drvdata(dev);
1357         struct hid_field *field;
1358         int offset;
1359
1360         if (type == EV_FF)
1361                 return input_ff_event(dev, type, code, value);
1362
1363         if (type != EV_LED)
1364                 return -1;
1365
1366         if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
1367                 hid_warn(dev, "event field not found\n");
1368                 return -1;
1369         }
1370
1371         hid_set_field(field, offset, value);
1372
1373         schedule_work(&hid->led_work);
1374         return 0;
1375 }
1376
1377 static int hidinput_open(struct input_dev *dev)
1378 {
1379         struct hid_device *hid = input_get_drvdata(dev);
1380
1381         return hid_hw_open(hid);
1382 }
1383
1384 static void hidinput_close(struct input_dev *dev)
1385 {
1386         struct hid_device *hid = input_get_drvdata(dev);
1387
1388         hid_hw_close(hid);
1389 }
1390
1391 static void report_features(struct hid_device *hid)
1392 {
1393         struct hid_driver *drv = hid->driver;
1394         struct hid_report_enum *rep_enum;
1395         struct hid_report *rep;
1396         int i, j;
1397
1398         rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1399         list_for_each_entry(rep, &rep_enum->report_list, list)
1400                 for (i = 0; i < rep->maxfield; i++) {
1401                         /* Ignore if report count is out of bounds. */
1402                         if (rep->field[i]->report_count < 1)
1403                                 continue;
1404
1405                         for (j = 0; j < rep->field[i]->maxusage; j++) {
1406                                 /* Verify if Battery Strength feature is available */
1407                                 hidinput_setup_battery(hid, HID_FEATURE_REPORT, rep->field[i]);
1408
1409                                 if (drv->feature_mapping)
1410                                         drv->feature_mapping(hid, rep->field[i],
1411                                                              rep->field[i]->usage + j);
1412                         }
1413                 }
1414 }
1415
1416 static struct hid_input *hidinput_allocate(struct hid_device *hid)
1417 {
1418         struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
1419         struct input_dev *input_dev = input_allocate_device();
1420         if (!hidinput || !input_dev) {
1421                 kfree(hidinput);
1422                 input_free_device(input_dev);
1423                 hid_err(hid, "Out of memory during hid input probe\n");
1424                 return NULL;
1425         }
1426
1427         input_set_drvdata(input_dev, hid);
1428         input_dev->event = hidinput_input_event;
1429         input_dev->open = hidinput_open;
1430         input_dev->close = hidinput_close;
1431         input_dev->setkeycode = hidinput_setkeycode;
1432         input_dev->getkeycode = hidinput_getkeycode;
1433
1434         input_dev->name = hid->name;
1435         input_dev->phys = hid->phys;
1436         input_dev->uniq = hid->uniq;
1437         input_dev->id.bustype = hid->bus;
1438         input_dev->id.vendor  = hid->vendor;
1439         input_dev->id.product = hid->product;
1440         input_dev->id.version = hid->version;
1441         input_dev->dev.parent = &hid->dev;
1442         hidinput->input = input_dev;
1443         list_add_tail(&hidinput->list, &hid->inputs);
1444
1445         return hidinput;
1446 }
1447
1448 static bool hidinput_has_been_populated(struct hid_input *hidinput)
1449 {
1450         int i;
1451         unsigned long r = 0;
1452
1453         for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++)
1454                 r |= hidinput->input->evbit[i];
1455
1456         for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++)
1457                 r |= hidinput->input->keybit[i];
1458
1459         for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++)
1460                 r |= hidinput->input->relbit[i];
1461
1462         for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++)
1463                 r |= hidinput->input->absbit[i];
1464
1465         for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++)
1466                 r |= hidinput->input->mscbit[i];
1467
1468         for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++)
1469                 r |= hidinput->input->ledbit[i];
1470
1471         for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++)
1472                 r |= hidinput->input->sndbit[i];
1473
1474         for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++)
1475                 r |= hidinput->input->ffbit[i];
1476
1477         for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++)
1478                 r |= hidinput->input->swbit[i];
1479
1480         return !!r;
1481 }
1482
1483 static void hidinput_cleanup_hidinput(struct hid_device *hid,
1484                 struct hid_input *hidinput)
1485 {
1486         struct hid_report *report;
1487         int i, k;
1488
1489         list_del(&hidinput->list);
1490         input_free_device(hidinput->input);
1491
1492         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1493                 if (k == HID_OUTPUT_REPORT &&
1494                         hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1495                         continue;
1496
1497                 list_for_each_entry(report, &hid->report_enum[k].report_list,
1498                                     list) {
1499
1500                         for (i = 0; i < report->maxfield; i++)
1501                                 if (report->field[i]->hidinput == hidinput)
1502                                         report->field[i]->hidinput = NULL;
1503                 }
1504         }
1505
1506         kfree(hidinput);
1507 }
1508
1509 /*
1510  * Register the input device; print a message.
1511  * Configure the input layer interface
1512  * Read all reports and initialize the absolute field values.
1513  */
1514
1515 int hidinput_connect(struct hid_device *hid, unsigned int force)
1516 {
1517         struct hid_driver *drv = hid->driver;
1518         struct hid_report *report;
1519         struct hid_input *hidinput = NULL;
1520         int i, j, k;
1521
1522         INIT_LIST_HEAD(&hid->inputs);
1523         INIT_WORK(&hid->led_work, hidinput_led_worker);
1524
1525         if (!force) {
1526                 for (i = 0; i < hid->maxcollection; i++) {
1527                         struct hid_collection *col = &hid->collection[i];
1528                         if (col->type == HID_COLLECTION_APPLICATION ||
1529                                         col->type == HID_COLLECTION_PHYSICAL)
1530                                 if (IS_INPUT_APPLICATION(col->usage))
1531                                         break;
1532                 }
1533
1534                 if (i == hid->maxcollection)
1535                         return -1;
1536         }
1537
1538         report_features(hid);
1539
1540         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1541                 if (k == HID_OUTPUT_REPORT &&
1542                         hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1543                         continue;
1544
1545                 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
1546
1547                         if (!report->maxfield)
1548                                 continue;
1549
1550                         if (!hidinput) {
1551                                 hidinput = hidinput_allocate(hid);
1552                                 if (!hidinput)
1553                                         goto out_unwind;
1554                         }
1555
1556                         for (i = 0; i < report->maxfield; i++)
1557                                 for (j = 0; j < report->field[i]->maxusage; j++)
1558                                         hidinput_configure_usage(hidinput, report->field[i],
1559                                                                  report->field[i]->usage + j);
1560
1561                         if ((hid->quirks & HID_QUIRK_NO_EMPTY_INPUT) &&
1562                             !hidinput_has_been_populated(hidinput))
1563                                 continue;
1564
1565                         if (hid->quirks & HID_QUIRK_MULTI_INPUT) {
1566                                 /* This will leave hidinput NULL, so that it
1567                                  * allocates another one if we have more inputs on
1568                                  * the same interface. Some devices (e.g. Happ's
1569                                  * UGCI) cram a lot of unrelated inputs into the
1570                                  * same interface. */
1571                                 hidinput->report = report;
1572                                 if (drv->input_configured &&
1573                                     drv->input_configured(hid, hidinput))
1574                                         goto out_cleanup;
1575                                 if (input_register_device(hidinput->input))
1576                                         goto out_cleanup;
1577                                 hidinput = NULL;
1578                         }
1579                 }
1580         }
1581
1582         if (hidinput && (hid->quirks & HID_QUIRK_NO_EMPTY_INPUT) &&
1583             !hidinput_has_been_populated(hidinput)) {
1584                 /* no need to register an input device not populated */
1585                 hidinput_cleanup_hidinput(hid, hidinput);
1586                 hidinput = NULL;
1587         }
1588
1589         if (list_empty(&hid->inputs)) {
1590                 hid_err(hid, "No inputs registered, leaving\n");
1591                 goto out_unwind;
1592         }
1593
1594         if (hidinput) {
1595                 if (drv->input_configured &&
1596                     drv->input_configured(hid, hidinput))
1597                         goto out_cleanup;
1598                 if (input_register_device(hidinput->input))
1599                         goto out_cleanup;
1600         }
1601
1602         return 0;
1603
1604 out_cleanup:
1605         list_del(&hidinput->list);
1606         input_free_device(hidinput->input);
1607         kfree(hidinput);
1608 out_unwind:
1609         /* unwind the ones we already registered */
1610         hidinput_disconnect(hid);
1611
1612         return -1;
1613 }
1614 EXPORT_SYMBOL_GPL(hidinput_connect);
1615
1616 void hidinput_disconnect(struct hid_device *hid)
1617 {
1618         struct hid_input *hidinput, *next;
1619
1620         hidinput_cleanup_battery(hid);
1621
1622         list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1623                 list_del(&hidinput->list);
1624                 input_unregister_device(hidinput->input);
1625                 kfree(hidinput);
1626         }
1627
1628         /* led_work is spawned by input_dev callbacks, but doesn't access the
1629          * parent input_dev at all. Once all input devices are removed, we
1630          * know that led_work will never get restarted, so we can cancel it
1631          * synchronously and are safe. */
1632         cancel_work_sync(&hid->led_work);
1633 }
1634 EXPORT_SYMBOL_GPL(hidinput_disconnect);
1635