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