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         {}
 328 };
 329
 330 static unsigned find_battery_quirk(struct hid_device *hdev)
 331 {
 332         unsigned quirks = 0;
 333         const struct hid_device_id *match;
 334
 335         match = hid_match_id(hdev, hid_battery_quirks);
 336         if (match != NULL)
 337                 quirks = match->driver_data;
 338
 339         return quirks;
 340 }
 341
 342 static int hidinput_get_battery_property(struct power_supply *psy,
 343                                          enum power_supply_property prop,
 344                                          union power_supply_propval *val)
 345 {
 346         struct hid_device *dev = power_supply_get_drvdata(psy);
 347         int ret = 0;
 348         __u8 *buf;
 349
 350         switch (prop) {
 351         case POWER_SUPPLY_PROP_PRESENT:
 352         case POWER_SUPPLY_PROP_ONLINE:
 353                 val->intval = 1;
 354                 break;
 355
 356         case POWER_SUPPLY_PROP_CAPACITY:
 357
 358                 buf = kmalloc(2 * sizeof(__u8), GFP_KERNEL);
 359                 if (!buf) {
 360                         ret = -ENOMEM;
 361                         break;
 362                 }
 363                 ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 2,
 364                                          dev->battery_report_type,
 365                                          HID_REQ_GET_REPORT);
 366
 367                 if (ret != 2) {
 368                         ret = -ENODATA;
 369                         kfree(buf);
 370                         break;
 371                 }
 372                 ret = 0;
 373
 374                 if (dev->battery_min < dev->battery_max &&
 375                     buf[1] >= dev->battery_min &&
 376                     buf[1] <= dev->battery_max)
 377                         val->intval = (100 * (buf[1] - dev->battery_min)) /
 378                                 (dev->battery_max - dev->battery_min);
 379                 kfree(buf);
 380                 break;
 381
 382         case POWER_SUPPLY_PROP_MODEL_NAME:
 383                 val->strval = dev->name;
 384                 break;
 385
 386         case POWER_SUPPLY_PROP_STATUS:
 387                 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
 388                 break;
 389
 390         case POWER_SUPPLY_PROP_SCOPE:
 391                 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
 392                 break;
 393
 394         default:
 395                 ret = -EINVAL;
 396                 break;
 397         }
 398
 399         return ret;
 400 }
 401
 402 static bool hidinput_setup_battery(struct hid_device *dev, unsigned report_type, struct hid_field *field)
 403 {
 404         struct power_supply_desc *psy_desc = NULL;
 405         struct power_supply_config psy_cfg = { .drv_data = dev, };
 406         unsigned quirks;
 407         s32 min, max;
 408
 409         if (field->usage->hid != HID_DC_BATTERYSTRENGTH)
 410                 return false;   /* no match */
 411
 412         if (dev->battery != NULL)
 413                 goto out;       /* already initialized? */
 414
 415         quirks = find_battery_quirk(dev);
 416
 417         hid_dbg(dev, "device %x:%x:%x %d quirks %d\n",
 418                 dev->bus, dev->vendor, dev->product, dev->version, quirks);
 419
 420         if (quirks & HID_BATTERY_QUIRK_IGNORE)
 421                 goto out;
 422
 423         psy_desc = kzalloc(sizeof(*psy_desc), GFP_KERNEL);
 424         if (psy_desc == NULL)
 425                 goto out;
 426
 427         psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery", dev->uniq);
 428         if (psy_desc->name == NULL) {
 429                 kfree(psy_desc);
 430                 goto out;
 431         }
 432
 433         psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
 434         psy_desc->properties = hidinput_battery_props;
 435         psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props);
 436         psy_desc->use_for_apm = 0;
 437         psy_desc->get_property = hidinput_get_battery_property;
 438
 439         min = field->logical_minimum;
 440         max = field->logical_maximum;
 441
 442         if (quirks & HID_BATTERY_QUIRK_PERCENT) {
 443                 min = 0;
 444                 max = 100;
 445         }
 446
 447         if (quirks & HID_BATTERY_QUIRK_FEATURE)
 448                 report_type = HID_FEATURE_REPORT;
 449
 450         dev->battery_min = min;
 451         dev->battery_max = max;
 452         dev->battery_report_type = report_type;
 453         dev->battery_report_id = field->report->id;
 454
 455         dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg);
 456         if (IS_ERR(dev->battery)) {
 457                 hid_warn(dev, "can't register power supply: %ld\n",
 458                                 PTR_ERR(dev->battery));
 459                 kfree(psy_desc->name);
 460                 kfree(psy_desc);
 461                 dev->battery = NULL;
 462         } else {
 463                 power_supply_powers(dev->battery, &dev->dev);
 464         }
 465
 466 out:
 467         return true;
 468 }
 469
 470 static void hidinput_cleanup_battery(struct hid_device *dev)
 471 {
 472         const struct power_supply_desc *psy_desc;
 473
 474         if (!dev->battery)
 475                 return;
 476
 477         psy_desc = dev->battery->desc;
 478         power_supply_unregister(dev->battery);
 479         kfree(psy_desc->name);
 480         kfree(psy_desc);
 481         dev->battery = NULL;
 482 }
 483 #else  /* !CONFIG_HID_BATTERY_STRENGTH */
 484 static bool hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
 485                                    struct hid_field *field)
 486 {
 487         return false;
 488 }
 489
 490 static void hidinput_cleanup_battery(struct hid_device *dev)
 491 {
 492 }
 493 #endif  /* CONFIG_HID_BATTERY_STRENGTH */
 494
 495 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
 496                                      struct hid_usage *usage)
 497 {
 498         struct input_dev *input = hidinput->input;
 499         struct hid_device *device = input_get_drvdata(input);
 500         int max = 0, code;
 501         unsigned long *bit = NULL;
 502
 503         field->hidinput = hidinput;
 504
 505         if ((field->flags & HID_MAIN_ITEM_CONSTANT) &&
 506                         (usage->hid & HID_USAGE_PAGE) != HID_UP_ASUSVENDOR)
 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         case HID_UP_ASUSVENDOR:
 995                 switch (usage->hid & HID_USAGE) {
 996                 case 0x06C: map_key_clear(KEY_SLEEP);           break; /* Fn+F1: Sleep */
 997                 case 0x088: map_key_clear(KEY_WLAN);            break; /* Fn+F2: Wifi & BT */
 998                 case 0x010: map_key_clear(KEY_BRIGHTNESSDOWN);  break; /* Fn+F5: Brightness down */
 999                 case 0x020: map_key_clear(KEY_BRIGHTNESSUP);    break; /* Fn+F6: Brightness up */
1000                 case 0x06B: map_key_clear(KEY_F24);             break; /* Fn+F9: Touchpad */
1001                 default: goto ignore;
1002                 }
1003                 break;
1004
1005         default:
1006         unknown:
1007                 if (field->report_size == 1) {
1008                         if (field->report->type == HID_OUTPUT_REPORT) {
1009                                 map_led(LED_MISC);
1010                                 break;
1011                         }
1012                         map_key(BTN_MISC);
1013                         break;
1014                 }
1015                 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
1016                         map_rel(REL_MISC);
1017                         break;
1018                 }
1019                 map_abs(ABS_MISC);
1020                 break;
1021         }
1022
1023 mapped:
1024         if (device->driver->input_mapped && device->driver->input_mapped(device,
1025                                 hidinput, field, usage, &bit, &max) < 0)
1026                 goto ignore;
1027
1028         set_bit(usage->type, input->evbit);
1029
1030         while (usage->code <= max && test_and_set_bit(usage->code, bit))
1031                 usage->code = find_next_zero_bit(bit, max + 1, usage->code);
1032
1033         if (usage->code > max)
1034                 goto ignore;
1035
1036
1037         if (usage->type == EV_ABS) {
1038
1039                 int a = field->logical_minimum;
1040                 int b = field->logical_maximum;
1041
1042                 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
1043                         a = field->logical_minimum = 0;
1044                         b = field->logical_maximum = 255;
1045                 }
1046
1047                 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
1048                         input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
1049                 else    input_set_abs_params(input, usage->code, a, b, 0, 0);
1050
1051                 input_abs_set_res(input, usage->code,
1052                                   hidinput_calc_abs_res(field, usage->code));
1053
1054                 /* use a larger default input buffer for MT devices */
1055                 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
1056                         input_set_events_per_packet(input, 60);
1057         }
1058
1059         if (usage->type == EV_ABS &&
1060             (usage->hat_min < usage->hat_max || usage->hat_dir)) {
1061                 int i;
1062                 for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
1063                         input_set_abs_params(input, i, -1, 1, 0, 0);
1064                         set_bit(i, input->absbit);
1065                 }
1066                 if (usage->hat_dir && !field->dpad)
1067                         field->dpad = usage->code;
1068         }
1069
1070         /* for those devices which produce Consumer volume usage as relative,
1071          * we emulate pressing volumeup/volumedown appropriate number of times
1072          * in hidinput_hid_event()
1073          */
1074         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1075                         (usage->code == ABS_VOLUME)) {
1076                 set_bit(KEY_VOLUMEUP, input->keybit);
1077                 set_bit(KEY_VOLUMEDOWN, input->keybit);
1078         }
1079
1080         if (usage->type == EV_KEY) {
1081                 set_bit(EV_MSC, input->evbit);
1082                 set_bit(MSC_SCAN, input->mscbit);
1083         }
1084
1085 ignore:
1086         return;
1087
1088 }
1089
1090 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
1091 {
1092         struct input_dev *input;
1093         unsigned *quirks = &hid->quirks;
1094
1095         if (!field->hidinput)
1096                 return;
1097
1098         input = field->hidinput->input;
1099
1100         if (!usage->type)
1101                 return;
1102
1103         if (usage->hat_min < usage->hat_max || usage->hat_dir) {
1104                 int hat_dir = usage->hat_dir;
1105                 if (!hat_dir)
1106                         hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
1107                 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
1108                 input_event(input, usage->type, usage->code    , hid_hat_to_axis[hat_dir].x);
1109                 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
1110                 return;
1111         }
1112
1113         if (usage->hid == (HID_UP_DIGITIZER | 0x003c)) { /* Invert */
1114                 *quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
1115                 return;
1116         }
1117
1118         if (usage->hid == (HID_UP_DIGITIZER | 0x0032)) { /* InRange */
1119                 if (value) {
1120                         input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
1121                         return;
1122                 }
1123                 input_event(input, usage->type, usage->code, 0);
1124                 input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
1125                 return;
1126         }
1127
1128         if (usage->hid == (HID_UP_DIGITIZER | 0x0030) && (*quirks & HID_QUIRK_NOTOUCH)) { /* Pressure */
1129                 int a = field->logical_minimum;
1130                 int b = field->logical_maximum;
1131                 input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
1132         }
1133
1134         if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
1135                 dbg_hid("Maximum Effects - %d\n",value);
1136                 return;
1137         }
1138
1139         if (usage->hid == (HID_UP_PID | 0x7fUL)) {
1140                 dbg_hid("PID Pool Report\n");
1141                 return;
1142         }
1143
1144         if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1145                 return;
1146
1147         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1148                         (usage->code == ABS_VOLUME)) {
1149                 int count = abs(value);
1150                 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
1151                 int i;
1152
1153                 for (i = 0; i < count; i++) {
1154                         input_event(input, EV_KEY, direction, 1);
1155                         input_sync(input);
1156                         input_event(input, EV_KEY, direction, 0);
1157                         input_sync(input);
1158                 }
1159                 return;
1160         }
1161
1162         /*
1163          * Ignore out-of-range values as per HID specification,
1164          * section 5.10 and 6.2.25, when NULL state bit is present.
1165          * When it's not, clamp the value to match Microsoft's input
1166          * driver as mentioned in "Required HID usages for digitizers":
1167          * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp
1168          *
1169          * The logical_minimum < logical_maximum check is done so that we
1170          * don't unintentionally discard values sent by devices which
1171          * don't specify logical min and max.
1172          */
1173         if ((field->flags & HID_MAIN_ITEM_VARIABLE) &&
1174             (field->logical_minimum < field->logical_maximum)) {
1175                 if (field->flags & HID_MAIN_ITEM_NULL_STATE &&
1176                     (value < field->logical_minimum ||
1177                      value > field->logical_maximum)) {
1178                         dbg_hid("Ignoring out-of-range value %x\n", value);
1179                         return;
1180                 }
1181                 value = clamp(value,
1182                               field->logical_minimum,
1183                               field->logical_maximum);
1184         }
1185
1186         /*
1187          * Ignore reports for absolute data if the data didn't change. This is
1188          * not only an optimization but also fixes 'dead' key reports. Some
1189          * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID
1190          * 0x31 and 0x32) report multiple keys, even though a localized keyboard
1191          * can only have one of them physically available. The 'dead' keys
1192          * report constant 0. As all map to the same keycode, they'd confuse
1193          * the input layer. If we filter the 'dead' keys on the HID level, we
1194          * skip the keycode translation and only forward real events.
1195          */
1196         if (!(field->flags & (HID_MAIN_ITEM_RELATIVE |
1197                               HID_MAIN_ITEM_BUFFERED_BYTE)) &&
1198                               (field->flags & HID_MAIN_ITEM_VARIABLE) &&
1199             usage->usage_index < field->maxusage &&
1200             value == field->value[usage->usage_index])
1201                 return;
1202
1203         /* report the usage code as scancode if the key status has changed */
1204         if (usage->type == EV_KEY &&
1205             (!test_bit(usage->code, input->key)) == value)
1206                 input_event(input, EV_MSC, MSC_SCAN, usage->hid);
1207
1208         input_event(input, usage->type, usage->code, value);
1209
1210         if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1211             usage->type == EV_KEY && value) {
1212                 input_sync(input);
1213                 input_event(input, usage->type, usage->code, 0);
1214         }
1215 }
1216
1217 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
1218 {
1219         struct hid_input *hidinput;
1220
1221         if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
1222                 return;
1223
1224         list_for_each_entry(hidinput, &hid->inputs, list)
1225                 input_sync(hidinput->input);
1226 }
1227 EXPORT_SYMBOL_GPL(hidinput_report_event);
1228
1229 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
1230 {
1231         struct hid_report *report;
1232         int i, j;
1233
1234         list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
1235                 for (i = 0; i < report->maxfield; i++) {
1236                         *field = report->field[i];
1237                         for (j = 0; j < (*field)->maxusage; j++)
1238                                 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1239                                         return j;
1240                 }
1241         }
1242         return -1;
1243 }
1244 EXPORT_SYMBOL_GPL(hidinput_find_field);
1245
1246 struct hid_field *hidinput_get_led_field(struct hid_device *hid)
1247 {
1248         struct hid_report *report;
1249         struct hid_field *field;
1250         int i, j;
1251
1252         list_for_each_entry(report,
1253                             &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1254                             list) {
1255                 for (i = 0; i < report->maxfield; i++) {
1256                         field = report->field[i];
1257                         for (j = 0; j < field->maxusage; j++)
1258                                 if (field->usage[j].type == EV_LED)
1259                                         return field;
1260                 }
1261         }
1262         return NULL;
1263 }
1264 EXPORT_SYMBOL_GPL(hidinput_get_led_field);
1265
1266 unsigned int hidinput_count_leds(struct hid_device *hid)
1267 {
1268         struct hid_report *report;
1269         struct hid_field *field;
1270         int i, j;
1271         unsigned int count = 0;
1272
1273         list_for_each_entry(report,
1274                             &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1275                             list) {
1276                 for (i = 0; i < report->maxfield; i++) {
1277                         field = report->field[i];
1278                         for (j = 0; j < field->maxusage; j++)
1279                                 if (field->usage[j].type == EV_LED &&
1280                                     field->value[j])
1281                                         count += 1;
1282                 }
1283         }
1284         return count;
1285 }
1286 EXPORT_SYMBOL_GPL(hidinput_count_leds);
1287
1288 static void hidinput_led_worker(struct work_struct *work)
1289 {
1290         struct hid_device *hid = container_of(work, struct hid_device,
1291                                               led_work);
1292         struct hid_field *field;
1293         struct hid_report *report;
1294         int len, ret;
1295         __u8 *buf;
1296
1297         field = hidinput_get_led_field(hid);
1298         if (!field)
1299                 return;
1300
1301         /*
1302          * field->report is accessed unlocked regarding HID core. So there might
1303          * be another incoming SET-LED request from user-space, which changes
1304          * the LED state while we assemble our outgoing buffer. However, this
1305          * doesn't matter as hid_output_report() correctly converts it into a
1306          * boolean value no matter what information is currently set on the LED
1307          * field (even garbage). So the remote device will always get a valid
1308          * request.
1309          * And in case we send a wrong value, a next led worker is spawned
1310          * for every SET-LED request so the following worker will send the
1311          * correct value, guaranteed!
1312          */
1313
1314         report = field->report;
1315
1316         /* use custom SET_REPORT request if possible (asynchronous) */
1317         if (hid->ll_driver->request)
1318                 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT);
1319
1320         /* fall back to generic raw-output-report */
1321         len = hid_report_len(report);
1322         buf = hid_alloc_report_buf(report, GFP_KERNEL);
1323         if (!buf)
1324                 return;
1325
1326         hid_output_report(report, buf);
1327         /* synchronous output report */
1328         ret = hid_hw_output_report(hid, buf, len);
1329         if (ret == -ENOSYS)
1330                 hid_hw_raw_request(hid, report->id, buf, len, HID_OUTPUT_REPORT,
1331                                 HID_REQ_SET_REPORT);
1332         kfree(buf);
1333 }
1334
1335 static int hidinput_input_event(struct input_dev *dev, unsigned int type,
1336                                 unsigned int code, int value)
1337 {
1338         struct hid_device *hid = input_get_drvdata(dev);
1339         struct hid_field *field;
1340         int offset;
1341
1342         if (type == EV_FF)
1343                 return input_ff_event(dev, type, code, value);
1344
1345         if (type != EV_LED)
1346                 return -1;
1347
1348         if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
1349                 hid_warn(dev, "event field not found\n");
1350                 return -1;
1351         }
1352
1353         hid_set_field(field, offset, value);
1354
1355         schedule_work(&hid->led_work);
1356         return 0;
1357 }
1358
1359 static int hidinput_open(struct input_dev *dev)
1360 {
1361         struct hid_device *hid = input_get_drvdata(dev);
1362
1363         return hid_hw_open(hid);
1364 }
1365
1366 static void hidinput_close(struct input_dev *dev)
1367 {
1368         struct hid_device *hid = input_get_drvdata(dev);
1369
1370         hid_hw_close(hid);
1371 }
1372
1373 static void report_features(struct hid_device *hid)
1374 {
1375         struct hid_driver *drv = hid->driver;
1376         struct hid_report_enum *rep_enum;
1377         struct hid_report *rep;
1378         int i, j;
1379
1380         rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1381         list_for_each_entry(rep, &rep_enum->report_list, list)
1382                 for (i = 0; i < rep->maxfield; i++) {
1383                         /* Ignore if report count is out of bounds. */
1384                         if (rep->field[i]->report_count < 1)
1385                                 continue;
1386
1387                         for (j = 0; j < rep->field[i]->maxusage; j++) {
1388                                 /* Verify if Battery Strength feature is available */
1389                                 hidinput_setup_battery(hid, HID_FEATURE_REPORT, rep->field[i]);
1390
1391                                 if (drv->feature_mapping)
1392                                         drv->feature_mapping(hid, rep->field[i],
1393                                                              rep->field[i]->usage + j);
1394                         }
1395                 }
1396 }
1397
1398 static struct hid_input *hidinput_allocate(struct hid_device *hid)
1399 {
1400         struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
1401         struct input_dev *input_dev = input_allocate_device();
1402         if (!hidinput || !input_dev) {
1403                 kfree(hidinput);
1404                 input_free_device(input_dev);
1405                 hid_err(hid, "Out of memory during hid input probe\n");
1406                 return NULL;
1407         }
1408
1409         input_set_drvdata(input_dev, hid);
1410         input_dev->event = hidinput_input_event;
1411         input_dev->open = hidinput_open;
1412         input_dev->close = hidinput_close;
1413         input_dev->setkeycode = hidinput_setkeycode;
1414         input_dev->getkeycode = hidinput_getkeycode;
1415
1416         input_dev->name = hid->name;
1417         input_dev->phys = hid->phys;
1418         input_dev->uniq = hid->uniq;
1419         input_dev->id.bustype = hid->bus;
1420         input_dev->id.vendor  = hid->vendor;
1421         input_dev->id.product = hid->product;
1422         input_dev->id.version = hid->version;
1423         input_dev->dev.parent = &hid->dev;
1424         hidinput->input = input_dev;
1425         list_add_tail(&hidinput->list, &hid->inputs);
1426
1427         return hidinput;
1428 }
1429
1430 static bool hidinput_has_been_populated(struct hid_input *hidinput)
1431 {
1432         int i;
1433         unsigned long r = 0;
1434
1435         for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++)
1436                 r |= hidinput->input->evbit[i];
1437
1438         for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++)
1439                 r |= hidinput->input->keybit[i];
1440
1441         for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++)
1442                 r |= hidinput->input->relbit[i];
1443
1444         for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++)
1445                 r |= hidinput->input->absbit[i];
1446
1447         for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++)
1448                 r |= hidinput->input->mscbit[i];
1449
1450         for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++)
1451                 r |= hidinput->input->ledbit[i];
1452
1453         for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++)
1454                 r |= hidinput->input->sndbit[i];
1455
1456         for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++)
1457                 r |= hidinput->input->ffbit[i];
1458
1459         for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++)
1460                 r |= hidinput->input->swbit[i];
1461
1462         return !!r;
1463 }
1464
1465 static void hidinput_cleanup_hidinput(struct hid_device *hid,
1466                 struct hid_input *hidinput)
1467 {
1468         struct hid_report *report;
1469         int i, k;
1470
1471         list_del(&hidinput->list);
1472         input_free_device(hidinput->input);
1473
1474         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1475                 if (k == HID_OUTPUT_REPORT &&
1476                         hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1477                         continue;
1478
1479                 list_for_each_entry(report, &hid->report_enum[k].report_list,
1480                                     list) {
1481
1482                         for (i = 0; i < report->maxfield; i++)
1483                                 if (report->field[i]->hidinput == hidinput)
1484                                         report->field[i]->hidinput = NULL;
1485                 }
1486         }
1487
1488         kfree(hidinput);
1489 }
1490
1491 static struct hid_input *hidinput_match(struct hid_report *report)
1492 {
1493         struct hid_device *hid = report->device;
1494         struct hid_input *hidinput;
1495
1496         list_for_each_entry(hidinput, &hid->inputs, list) {
1497                 if (hidinput->report &&
1498                     hidinput->report->id == report->id)
1499                         return hidinput;
1500         }
1501
1502         return NULL;
1503 }
1504
1505 static inline void hidinput_configure_usages(struct hid_input *hidinput,
1506                                              struct hid_report *report)
1507 {
1508         int i, j;
1509
1510         for (i = 0; i < report->maxfield; i++)
1511                 for (j = 0; j < report->field[i]->maxusage; j++)
1512                         hidinput_configure_usage(hidinput, report->field[i],
1513                                                  report->field[i]->usage + j);
1514 }
1515
1516 /*
1517  * Register the input device; print a message.
1518  * Configure the input layer interface
1519  * Read all reports and initialize the absolute field values.
1520  */
1521
1522 int hidinput_connect(struct hid_device *hid, unsigned int force)
1523 {
1524         struct hid_driver *drv = hid->driver;
1525         struct hid_report *report;
1526         struct hid_input *next, *hidinput = NULL;
1527         int i, k;
1528
1529         INIT_LIST_HEAD(&hid->inputs);
1530         INIT_WORK(&hid->led_work, hidinput_led_worker);
1531
1532         if (!force) {
1533                 for (i = 0; i < hid->maxcollection; i++) {
1534                         struct hid_collection *col = &hid->collection[i];
1535                         if (col->type == HID_COLLECTION_APPLICATION ||
1536                                         col->type == HID_COLLECTION_PHYSICAL)
1537                                 if (IS_INPUT_APPLICATION(col->usage))
1538                                         break;
1539                 }
1540
1541                 if (i == hid->maxcollection)
1542                         return -1;
1543         }
1544
1545         report_features(hid);
1546
1547         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1548                 if (k == HID_OUTPUT_REPORT &&
1549                         hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1550                         continue;
1551
1552                 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
1553
1554                         if (!report->maxfield)
1555                                 continue;
1556
1557                         /*
1558                          * Find the previous hidinput report attached
1559                          * to this report id.
1560                          */
1561                         if (hid->quirks & HID_QUIRK_MULTI_INPUT)
1562                                 hidinput = hidinput_match(report);
1563
1564                         if (!hidinput) {
1565                                 hidinput = hidinput_allocate(hid);
1566                                 if (!hidinput)
1567                                         goto out_unwind;
1568                         }
1569
1570                         hidinput_configure_usages(hidinput, report);
1571
1572                         if (hid->quirks & HID_QUIRK_MULTI_INPUT)
1573                                 hidinput->report = report;
1574                 }
1575         }
1576
1577         list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1578                 if ((hid->quirks & HID_QUIRK_NO_EMPTY_INPUT) &&
1579                     !hidinput_has_been_populated(hidinput)) {
1580                         /* no need to register an input device not populated */
1581                         hidinput_cleanup_hidinput(hid, hidinput);
1582                         continue;
1583                 }
1584
1585                 if (drv->input_configured &&
1586                     drv->input_configured(hid, hidinput))
1587                         goto out_unwind;
1588                 if (input_register_device(hidinput->input))
1589                         goto out_unwind;
1590                 hidinput->registered = true;
1591         }
1592
1593         if (list_empty(&hid->inputs)) {
1594                 hid_err(hid, "No inputs registered, leaving\n");
1595                 goto out_unwind;
1596         }
1597
1598         return 0;
1599
1600 out_unwind:
1601         /* unwind the ones we already registered */
1602         hidinput_disconnect(hid);
1603
1604         return -1;
1605 }
1606 EXPORT_SYMBOL_GPL(hidinput_connect);
1607
1608 void hidinput_disconnect(struct hid_device *hid)
1609 {
1610         struct hid_input *hidinput, *next;
1611
1612         hidinput_cleanup_battery(hid);
1613
1614         list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1615                 list_del(&hidinput->list);
1616                 if (hidinput->registered)
1617                         input_unregister_device(hidinput->input);
1618                 else
1619                         input_free_device(hidinput->input);
1620                 kfree(hidinput);
1621         }
1622
1623         /* led_work is spawned by input_dev callbacks, but doesn't access the
1624          * parent input_dev at all. Once all input devices are removed, we
1625          * know that led_work will never get restarted, so we can cancel it
1626          * synchronously and are safe. */
1627         cancel_work_sync(&hid->led_work);
1628 }
1629 EXPORT_SYMBOL_GPL(hidinput_disconnect);
1630