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 #define unk     KEY_UNKNOWN
  36
  37 static const unsigned char hid_keyboard[256] = {
  38           0,  0,  0,  0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36, 37, 38,
  39          50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45, 21, 44,  2,  3,
  40           4,  5,  6,  7,  8,  9, 10, 11, 28,  1, 14, 15, 57, 12, 13, 26,
  41          27, 43, 43, 39, 40, 41, 51, 52, 53, 58, 59, 60, 61, 62, 63, 64,
  42          65, 66, 67, 68, 87, 88, 99, 70,119,110,102,104,111,107,109,106,
  43         105,108,103, 69, 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71,
  44          72, 73, 82, 83, 86,127,116,117,183,184,185,186,187,188,189,190,
  45         191,192,193,194,134,138,130,132,128,129,131,137,133,135,136,113,
  46         115,114,unk,unk,unk,121,unk, 89, 93,124, 92, 94, 95,unk,unk,unk,
  47         122,123, 90, 91, 85,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
  48         unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
  49         unk,unk,unk,unk,unk,unk,179,180,unk,unk,unk,unk,unk,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,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
  52          29, 42, 56,125, 97, 54,100,126,164,166,165,163,161,115,114,113,
  53         150,158,159,128,136,177,178,176,142,152,173,140,unk,unk,unk,unk
  54 };
  55
  56 static const struct {
  57         __s32 x;
  58         __s32 y;
  59 }  hid_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
  60
  61 #define map_abs(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_ABS, (c))
  62 #define map_rel(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_REL, (c))
  63 #define map_key(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_KEY, (c))
  64 #define map_led(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_LED, (c))
  65
  66 #define map_abs_clear(c)        hid_map_usage_clear(hidinput, usage, &bit, \
  67                 &max, EV_ABS, (c))
  68 #define map_key_clear(c)        hid_map_usage_clear(hidinput, usage, &bit, \
  69                 &max, EV_KEY, (c))
  70
  71 static bool match_scancode(struct hid_usage *usage,
  72                            unsigned int cur_idx, unsigned int scancode)
  73 {
  74         return (usage->hid & (HID_USAGE_PAGE | HID_USAGE)) == scancode;
  75 }
  76
  77 static bool match_keycode(struct hid_usage *usage,
  78                           unsigned int cur_idx, unsigned int keycode)
  79 {
  80         /*
  81          * We should exclude unmapped usages when doing lookup by keycode.
  82          */
  83         return (usage->type == EV_KEY && usage->code == keycode);
  84 }
  85
  86 static bool match_index(struct hid_usage *usage,
  87                         unsigned int cur_idx, unsigned int idx)
  88 {
  89         return cur_idx == idx;
  90 }
  91
  92 typedef bool (*hid_usage_cmp_t)(struct hid_usage *usage,
  93                                 unsigned int cur_idx, unsigned int val);
  94
  95 static struct hid_usage *hidinput_find_key(struct hid_device *hid,
  96                                            hid_usage_cmp_t match,
  97                                            unsigned int value,
  98                                            unsigned int *usage_idx)
  99 {
 100         unsigned int i, j, k, cur_idx = 0;
 101         struct hid_report *report;
 102         struct hid_usage *usage;
 103
 104         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
 105                 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
 106                         for (i = 0; i < report->maxfield; i++) {
 107                                 for (j = 0; j < report->field[i]->maxusage; j++) {
 108                                         usage = report->field[i]->usage + j;
 109                                         if (usage->type == EV_KEY || usage->type == 0) {
 110                                                 if (match(usage, cur_idx, value)) {
 111                                                         if (usage_idx)
 112                                                                 *usage_idx = cur_idx;
 113                                                         return usage;
 114                                                 }
 115                                                 cur_idx++;
 116                                         }
 117                                 }
 118                         }
 119                 }
 120         }
 121         return NULL;
 122 }
 123
 124 static struct hid_usage *hidinput_locate_usage(struct hid_device *hid,
 125                                         const struct input_keymap_entry *ke,
 126                                         unsigned int *index)
 127 {
 128         struct hid_usage *usage;
 129         unsigned int scancode;
 130
 131         if (ke->flags & INPUT_KEYMAP_BY_INDEX)
 132                 usage = hidinput_find_key(hid, match_index, ke->index, index);
 133         else if (input_scancode_to_scalar(ke, &scancode) == 0)
 134                 usage = hidinput_find_key(hid, match_scancode, scancode, index);
 135         else
 136                 usage = NULL;
 137
 138         return usage;
 139 }
 140
 141 static int hidinput_getkeycode(struct input_dev *dev,
 142                                struct input_keymap_entry *ke)
 143 {
 144         struct hid_device *hid = input_get_drvdata(dev);
 145         struct hid_usage *usage;
 146         unsigned int scancode, index;
 147
 148         usage = hidinput_locate_usage(hid, ke, &index);
 149         if (usage) {
 150                 ke->keycode = usage->type == EV_KEY ?
 151                                 usage->code : KEY_RESERVED;
 152                 ke->index = index;
 153                 scancode = usage->hid & (HID_USAGE_PAGE | HID_USAGE);
 154                 ke->len = sizeof(scancode);
 155                 memcpy(ke->scancode, &scancode, sizeof(scancode));
 156                 return 0;
 157         }
 158
 159         return -EINVAL;
 160 }
 161
 162 static int hidinput_setkeycode(struct input_dev *dev,
 163                                const struct input_keymap_entry *ke,
 164                                unsigned int *old_keycode)
 165 {
 166         struct hid_device *hid = input_get_drvdata(dev);
 167         struct hid_usage *usage;
 168
 169         usage = hidinput_locate_usage(hid, ke, NULL);
 170         if (usage) {
 171                 *old_keycode = usage->type == EV_KEY ?
 172                                 usage->code : KEY_RESERVED;
 173                 usage->code = ke->keycode;
 174
 175                 clear_bit(*old_keycode, dev->keybit);
 176                 set_bit(usage->code, dev->keybit);
 177                 dbg_hid(KERN_DEBUG "Assigned keycode %d to HID usage code %x\n",
 178                         usage->code, usage->hid);
 179
 180                 /*
 181                  * Set the keybit for the old keycode if the old keycode is used
 182                  * by another key
 183                  */
 184                 if (hidinput_find_key(hid, match_keycode, *old_keycode, NULL))
 185                         set_bit(*old_keycode, dev->keybit);
 186
 187                 return 0;
 188         }
 189
 190         return -EINVAL;
 191 }
 192
 193
 194 /**
 195  * hidinput_calc_abs_res - calculate an absolute axis resolution
 196  * @field: the HID report field to calculate resolution for
 197  * @code: axis code
 198  *
 199  * The formula is:
 200  *                         (logical_maximum - logical_minimum)
 201  * resolution = ----------------------------------------------------------
 202  *              (physical_maximum - physical_minimum) * 10 ^ unit_exponent
 203  *
 204  * as seen in the HID specification v1.11 6.2.2.7 Global Items.
 205  *
 206  * Only exponent 1 length units are processed. Centimeters are converted to
 207  * inches. Degrees are converted to radians.
 208  */
 209 static __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code)
 210 {
 211         __s32 unit_exponent = field->unit_exponent;
 212         __s32 logical_extents = field->logical_maximum -
 213                                         field->logical_minimum;
 214         __s32 physical_extents = field->physical_maximum -
 215                                         field->physical_minimum;
 216         __s32 prev;
 217
 218         /* Check if the extents are sane */
 219         if (logical_extents <= 0 || physical_extents <= 0)
 220                 return 0;
 221
 222         /*
 223          * Verify and convert units.
 224          * See HID specification v1.11 6.2.2.7 Global Items for unit decoding
 225          */
 226         if (code == ABS_X || code == ABS_Y || code == ABS_Z) {
 227                 if (field->unit == 0x11) {              /* If centimeters */
 228                         /* Convert to inches */
 229                         prev = logical_extents;
 230                         logical_extents *= 254;
 231                         if (logical_extents < prev)
 232                                 return 0;
 233                         unit_exponent += 2;
 234                 } else if (field->unit != 0x13) {       /* If not inches */
 235                         return 0;
 236                 }
 237         } else if (code == ABS_RX || code == ABS_RY || code == ABS_RZ) {
 238                 if (field->unit == 0x14) {              /* If degrees */
 239                         /* Convert to radians */
 240                         prev = logical_extents;
 241                         logical_extents *= 573;
 242                         if (logical_extents < prev)
 243                                 return 0;
 244                         unit_exponent += 1;
 245                 } else if (field->unit != 0x12) {       /* If not radians */
 246                         return 0;
 247                 }
 248         } else {
 249                 return 0;
 250         }
 251
 252         /* Apply negative unit exponent */
 253         for (; unit_exponent < 0; unit_exponent++) {
 254                 prev = logical_extents;
 255                 logical_extents *= 10;
 256                 if (logical_extents < prev)
 257                         return 0;
 258         }
 259         /* Apply positive unit exponent */
 260         for (; unit_exponent > 0; unit_exponent--) {
 261                 prev = physical_extents;
 262                 physical_extents *= 10;
 263                 if (physical_extents < prev)
 264                         return 0;
 265         }
 266
 267         /* Calculate resolution */
 268         return logical_extents / physical_extents;
 269 }
 270
 271 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
 272                                      struct hid_usage *usage)
 273 {
 274         struct input_dev *input = hidinput->input;
 275         struct hid_device *device = input_get_drvdata(input);
 276         int max = 0, code;
 277         unsigned long *bit = NULL;
 278
 279         field->hidinput = hidinput;
 280
 281         if (field->flags & HID_MAIN_ITEM_CONSTANT)
 282                 goto ignore;
 283
 284         /* only LED usages are supported in output fields */
 285         if (field->report_type == HID_OUTPUT_REPORT &&
 286                         (usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
 287                 goto ignore;
 288         }
 289
 290         if (device->driver->input_mapping) {
 291                 int ret = device->driver->input_mapping(device, hidinput, field,
 292                                 usage, &bit, &max);
 293                 if (ret > 0)
 294                         goto mapped;
 295                 if (ret < 0)
 296                         goto ignore;
 297         }
 298
 299         switch (usage->hid & HID_USAGE_PAGE) {
 300         case HID_UP_UNDEFINED:
 301                 goto ignore;
 302
 303         case HID_UP_KEYBOARD:
 304                 set_bit(EV_REP, input->evbit);
 305
 306                 if ((usage->hid & HID_USAGE) < 256) {
 307                         if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
 308                         map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
 309                 } else
 310                         map_key(KEY_UNKNOWN);
 311
 312                 break;
 313
 314         case HID_UP_BUTTON:
 315                 code = ((usage->hid - 1) & HID_USAGE);
 316
 317                 switch (field->application) {
 318                 case HID_GD_MOUSE:
 319                 case HID_GD_POINTER:  code += 0x110; break;
 320                 case HID_GD_JOYSTICK:
 321                                 if (code <= 0xf)
 322                                         code += BTN_JOYSTICK;
 323                                 else
 324                                         code += BTN_TRIGGER_HAPPY;
 325                                 break;
 326                 case HID_GD_GAMEPAD:  code += 0x130; break;
 327                 default:
 328                         switch (field->physical) {
 329                         case HID_GD_MOUSE:
 330                         case HID_GD_POINTER:  code += 0x110; break;
 331                         case HID_GD_JOYSTICK: code += 0x120; break;
 332                         case HID_GD_GAMEPAD:  code += 0x130; break;
 333                         default:              code += 0x100;
 334                         }
 335                 }
 336
 337                 map_key(code);
 338                 break;
 339
 340         case HID_UP_SIMULATION:
 341                 switch (usage->hid & 0xffff) {
 342                 case 0xba: map_abs(ABS_RUDDER);   break;
 343                 case 0xbb: map_abs(ABS_THROTTLE); break;
 344                 case 0xc4: map_abs(ABS_GAS);      break;
 345                 case 0xc5: map_abs(ABS_BRAKE);    break;
 346                 case 0xc8: map_abs(ABS_WHEEL);    break;
 347                 default:   goto ignore;
 348                 }
 349                 break;
 350
 351         case HID_UP_GENDESK:
 352                 if ((usage->hid & 0xf0) == 0x80) {      /* SystemControl */
 353                         switch (usage->hid & 0xf) {
 354                         case 0x1: map_key_clear(KEY_POWER);  break;
 355                         case 0x2: map_key_clear(KEY_SLEEP);  break;
 356                         case 0x3: map_key_clear(KEY_WAKEUP); break;
 357                         default: goto unknown;
 358                         }
 359                         break;
 360                 }
 361
 362                 if ((usage->hid & 0xf0) == 0x90) {      /* D-pad */
 363                         switch (usage->hid) {
 364                         case HID_GD_UP:    usage->hat_dir = 1; break;
 365                         case HID_GD_DOWN:  usage->hat_dir = 5; break;
 366                         case HID_GD_RIGHT: usage->hat_dir = 3; break;
 367                         case HID_GD_LEFT:  usage->hat_dir = 7; break;
 368                         default: goto unknown;
 369                         }
 370                         if (field->dpad) {
 371                                 map_abs(field->dpad);
 372                                 goto ignore;
 373                         }
 374                         map_abs(ABS_HAT0X);
 375                         break;
 376                 }
 377
 378                 switch (usage->hid) {
 379                 /* These usage IDs map directly to the usage codes. */
 380                 case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
 381                 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
 382                 case HID_GD_SLIDER: case HID_GD_DIAL: case HID_GD_WHEEL:
 383                         if (field->flags & HID_MAIN_ITEM_RELATIVE)
 384                                 map_rel(usage->hid & 0xf);
 385                         else
 386                                 map_abs(usage->hid & 0xf);
 387                         break;
 388
 389                 case HID_GD_HATSWITCH:
 390                         usage->hat_min = field->logical_minimum;
 391                         usage->hat_max = field->logical_maximum;
 392                         map_abs(ABS_HAT0X);
 393                         break;
 394
 395                 case HID_GD_START:      map_key_clear(BTN_START);       break;
 396                 case HID_GD_SELECT:     map_key_clear(BTN_SELECT);      break;
 397
 398                 default: goto unknown;
 399                 }
 400
 401                 break;
 402
 403         case HID_UP_LED:
 404                 switch (usage->hid & 0xffff) {                /* HID-Value:                   */
 405                 case 0x01:  map_led (LED_NUML);     break;    /*   "Num Lock"                 */
 406                 case 0x02:  map_led (LED_CAPSL);    break;    /*   "Caps Lock"                */
 407                 case 0x03:  map_led (LED_SCROLLL);  break;    /*   "Scroll Lock"              */
 408                 case 0x04:  map_led (LED_COMPOSE);  break;    /*   "Compose"                  */
 409                 case 0x05:  map_led (LED_KANA);     break;    /*   "Kana"                     */
 410                 case 0x27:  map_led (LED_SLEEP);    break;    /*   "Stand-By"                 */
 411                 case 0x4c:  map_led (LED_SUSPEND);  break;    /*   "System Suspend"           */
 412                 case 0x09:  map_led (LED_MUTE);     break;    /*   "Mute"                     */
 413                 case 0x4b:  map_led (LED_MISC);     break;    /*   "Generic Indicator"        */
 414                 case 0x19:  map_led (LED_MAIL);     break;    /*   "Message Waiting"          */
 415                 case 0x4d:  map_led (LED_CHARGING); break;    /*   "External Power Connected" */
 416
 417                 default: goto ignore;
 418                 }
 419                 break;
 420
 421         case HID_UP_DIGITIZER:
 422                 switch (usage->hid & 0xff) {
 423                 case 0x00: /* Undefined */
 424                         goto ignore;
 425
 426                 case 0x30: /* TipPressure */
 427                         if (!test_bit(BTN_TOUCH, input->keybit)) {
 428                                 device->quirks |= HID_QUIRK_NOTOUCH;
 429                                 set_bit(EV_KEY, input->evbit);
 430                                 set_bit(BTN_TOUCH, input->keybit);
 431                         }
 432                         map_abs_clear(ABS_PRESSURE);
 433                         break;
 434
 435                 case 0x32: /* InRange */
 436                         switch (field->physical & 0xff) {
 437                         case 0x21: map_key(BTN_TOOL_MOUSE); break;
 438                         case 0x22: map_key(BTN_TOOL_FINGER); break;
 439                         default: map_key(BTN_TOOL_PEN); break;
 440                         }
 441                         break;
 442
 443                 case 0x3c: /* Invert */
 444                         map_key_clear(BTN_TOOL_RUBBER);
 445                         break;
 446
 447                 case 0x33: /* Touch */
 448                 case 0x42: /* TipSwitch */
 449                 case 0x43: /* TipSwitch2 */
 450                         device->quirks &= ~HID_QUIRK_NOTOUCH;
 451                         map_key_clear(BTN_TOUCH);
 452                         break;
 453
 454                 case 0x44: /* BarrelSwitch */
 455                         map_key_clear(BTN_STYLUS);
 456                         break;
 457
 458                 case 0x46: /* TabletPick */
 459                         map_key_clear(BTN_STYLUS2);
 460                         break;
 461
 462                 default:  goto unknown;
 463                 }
 464                 break;
 465
 466         case HID_UP_CONSUMER:   /* USB HUT v1.1, pages 56-62 */
 467                 switch (usage->hid & HID_USAGE) {
 468                 case 0x000: goto ignore;
 469                 case 0x034: map_key_clear(KEY_SLEEP);           break;
 470                 case 0x036: map_key_clear(BTN_MISC);            break;
 471
 472                 case 0x040: map_key_clear(KEY_MENU);            break;
 473                 case 0x045: map_key_clear(KEY_RADIO);           break;
 474
 475                 case 0x083: map_key_clear(KEY_LAST);            break;
 476                 case 0x088: map_key_clear(KEY_PC);              break;
 477                 case 0x089: map_key_clear(KEY_TV);              break;
 478                 case 0x08a: map_key_clear(KEY_WWW);             break;
 479                 case 0x08b: map_key_clear(KEY_DVD);             break;
 480                 case 0x08c: map_key_clear(KEY_PHONE);           break;
 481                 case 0x08d: map_key_clear(KEY_PROGRAM);         break;
 482                 case 0x08e: map_key_clear(KEY_VIDEOPHONE);      break;
 483                 case 0x08f: map_key_clear(KEY_GAMES);           break;
 484                 case 0x090: map_key_clear(KEY_MEMO);            break;
 485                 case 0x091: map_key_clear(KEY_CD);              break;
 486                 case 0x092: map_key_clear(KEY_VCR);             break;
 487                 case 0x093: map_key_clear(KEY_TUNER);           break;
 488                 case 0x094: map_key_clear(KEY_EXIT);            break;
 489                 case 0x095: map_key_clear(KEY_HELP);            break;
 490                 case 0x096: map_key_clear(KEY_TAPE);            break;
 491                 case 0x097: map_key_clear(KEY_TV2);             break;
 492                 case 0x098: map_key_clear(KEY_SAT);             break;
 493                 case 0x09a: map_key_clear(KEY_PVR);             break;
 494
 495                 case 0x09c: map_key_clear(KEY_CHANNELUP);       break;
 496                 case 0x09d: map_key_clear(KEY_CHANNELDOWN);     break;
 497                 case 0x0a0: map_key_clear(KEY_VCR2);            break;
 498
 499                 case 0x0b0: map_key_clear(KEY_PLAY);            break;
 500                 case 0x0b1: map_key_clear(KEY_PAUSE);           break;
 501                 case 0x0b2: map_key_clear(KEY_RECORD);          break;
 502                 case 0x0b3: map_key_clear(KEY_FASTFORWARD);     break;
 503                 case 0x0b4: map_key_clear(KEY_REWIND);          break;
 504                 case 0x0b5: map_key_clear(KEY_NEXTSONG);        break;
 505                 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG);    break;
 506                 case 0x0b7: map_key_clear(KEY_STOPCD);          break;
 507                 case 0x0b8: map_key_clear(KEY_EJECTCD);         break;
 508                 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT);    break;
 509
 510                 case 0x0cd: map_key_clear(KEY_PLAYPAUSE);       break;
 511                 case 0x0e0: map_abs_clear(ABS_VOLUME);          break;
 512                 case 0x0e2: map_key_clear(KEY_MUTE);            break;
 513                 case 0x0e5: map_key_clear(KEY_BASSBOOST);       break;
 514                 case 0x0e9: map_key_clear(KEY_VOLUMEUP);        break;
 515                 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN);      break;
 516
 517                 case 0x182: map_key_clear(KEY_BOOKMARKS);       break;
 518                 case 0x183: map_key_clear(KEY_CONFIG);          break;
 519                 case 0x184: map_key_clear(KEY_WORDPROCESSOR);   break;
 520                 case 0x185: map_key_clear(KEY_EDITOR);          break;
 521                 case 0x186: map_key_clear(KEY_SPREADSHEET);     break;
 522                 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR);  break;
 523                 case 0x188: map_key_clear(KEY_PRESENTATION);    break;
 524                 case 0x189: map_key_clear(KEY_DATABASE);        break;
 525                 case 0x18a: map_key_clear(KEY_MAIL);            break;
 526                 case 0x18b: map_key_clear(KEY_NEWS);            break;
 527                 case 0x18c: map_key_clear(KEY_VOICEMAIL);       break;
 528                 case 0x18d: map_key_clear(KEY_ADDRESSBOOK);     break;
 529                 case 0x18e: map_key_clear(KEY_CALENDAR);        break;
 530                 case 0x191: map_key_clear(KEY_FINANCE);         break;
 531                 case 0x192: map_key_clear(KEY_CALC);            break;
 532                 case 0x194: map_key_clear(KEY_FILE);            break;
 533                 case 0x196: map_key_clear(KEY_WWW);             break;
 534                 case 0x199: map_key_clear(KEY_CHAT);            break;
 535                 case 0x19c: map_key_clear(KEY_LOGOFF);          break;
 536                 case 0x19e: map_key_clear(KEY_COFFEE);          break;
 537                 case 0x1a6: map_key_clear(KEY_HELP);            break;
 538                 case 0x1a7: map_key_clear(KEY_DOCUMENTS);       break;
 539                 case 0x1ab: map_key_clear(KEY_SPELLCHECK);      break;
 540                 case 0x1b6: map_key_clear(KEY_MEDIA);           break;
 541                 case 0x1b7: map_key_clear(KEY_SOUND);           break;
 542                 case 0x1bc: map_key_clear(KEY_MESSENGER);       break;
 543                 case 0x1bd: map_key_clear(KEY_INFO);            break;
 544                 case 0x201: map_key_clear(KEY_NEW);             break;
 545                 case 0x202: map_key_clear(KEY_OPEN);            break;
 546                 case 0x203: map_key_clear(KEY_CLOSE);           break;
 547                 case 0x204: map_key_clear(KEY_EXIT);            break;
 548                 case 0x207: map_key_clear(KEY_SAVE);            break;
 549                 case 0x208: map_key_clear(KEY_PRINT);           break;
 550                 case 0x209: map_key_clear(KEY_PROPS);           break;
 551                 case 0x21a: map_key_clear(KEY_UNDO);            break;
 552                 case 0x21b: map_key_clear(KEY_COPY);            break;
 553                 case 0x21c: map_key_clear(KEY_CUT);             break;
 554                 case 0x21d: map_key_clear(KEY_PASTE);           break;
 555                 case 0x21f: map_key_clear(KEY_FIND);            break;
 556                 case 0x221: map_key_clear(KEY_SEARCH);          break;
 557                 case 0x222: map_key_clear(KEY_GOTO);            break;
 558                 case 0x223: map_key_clear(KEY_HOMEPAGE);        break;
 559                 case 0x224: map_key_clear(KEY_BACK);            break;
 560                 case 0x225: map_key_clear(KEY_FORWARD);         break;
 561                 case 0x226: map_key_clear(KEY_STOP);            break;
 562                 case 0x227: map_key_clear(KEY_REFRESH);         break;
 563                 case 0x22a: map_key_clear(KEY_BOOKMARKS);       break;
 564                 case 0x22d: map_key_clear(KEY_ZOOMIN);          break;
 565                 case 0x22e: map_key_clear(KEY_ZOOMOUT);         break;
 566                 case 0x22f: map_key_clear(KEY_ZOOMRESET);       break;
 567                 case 0x233: map_key_clear(KEY_SCROLLUP);        break;
 568                 case 0x234: map_key_clear(KEY_SCROLLDOWN);      break;
 569                 case 0x238: map_rel(REL_HWHEEL);                break;
 570                 case 0x25f: map_key_clear(KEY_CANCEL);          break;
 571                 case 0x279: map_key_clear(KEY_REDO);            break;
 572
 573                 case 0x289: map_key_clear(KEY_REPLY);           break;
 574                 case 0x28b: map_key_clear(KEY_FORWARDMAIL);     break;
 575                 case 0x28c: map_key_clear(KEY_SEND);            break;
 576
 577                 default:    goto ignore;
 578                 }
 579                 break;
 580
 581         case HID_UP_HPVENDOR:   /* Reported on a Dutch layout HP5308 */
 582                 set_bit(EV_REP, input->evbit);
 583                 switch (usage->hid & HID_USAGE) {
 584                 case 0x021: map_key_clear(KEY_PRINT);           break;
 585                 case 0x070: map_key_clear(KEY_HP);              break;
 586                 case 0x071: map_key_clear(KEY_CAMERA);          break;
 587                 case 0x072: map_key_clear(KEY_SOUND);           break;
 588                 case 0x073: map_key_clear(KEY_QUESTION);        break;
 589                 case 0x080: map_key_clear(KEY_EMAIL);           break;
 590                 case 0x081: map_key_clear(KEY_CHAT);            break;
 591                 case 0x082: map_key_clear(KEY_SEARCH);          break;
 592                 case 0x083: map_key_clear(KEY_CONNECT);         break;
 593                 case 0x084: map_key_clear(KEY_FINANCE);         break;
 594                 case 0x085: map_key_clear(KEY_SPORT);           break;
 595                 case 0x086: map_key_clear(KEY_SHOP);            break;
 596                 default:    goto ignore;
 597                 }
 598                 break;
 599
 600         case HID_UP_MSVENDOR:
 601                 goto ignore;
 602
 603         case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
 604                 set_bit(EV_REP, input->evbit);
 605                 goto ignore;
 606
 607         case HID_UP_LOGIVENDOR:
 608                 goto ignore;
 609
 610         case HID_UP_PID:
 611                 switch (usage->hid & HID_USAGE) {
 612                 case 0xa4: map_key_clear(BTN_DEAD);     break;
 613                 default: goto ignore;
 614                 }
 615                 break;
 616
 617         default:
 618         unknown:
 619                 if (field->report_size == 1) {
 620                         if (field->report->type == HID_OUTPUT_REPORT) {
 621                                 map_led(LED_MISC);
 622                                 break;
 623                         }
 624                         map_key(BTN_MISC);
 625                         break;
 626                 }
 627                 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
 628                         map_rel(REL_MISC);
 629                         break;
 630                 }
 631                 map_abs(ABS_MISC);
 632                 break;
 633         }
 634
 635 mapped:
 636         if (device->driver->input_mapped && device->driver->input_mapped(device,
 637                                 hidinput, field, usage, &bit, &max) < 0)
 638                 goto ignore;
 639
 640         set_bit(usage->type, input->evbit);
 641
 642         while (usage->code <= max && test_and_set_bit(usage->code, bit))
 643                 usage->code = find_next_zero_bit(bit, max + 1, usage->code);
 644
 645         if (usage->code > max)
 646                 goto ignore;
 647
 648
 649         if (usage->type == EV_ABS) {
 650
 651                 int a = field->logical_minimum;
 652                 int b = field->logical_maximum;
 653
 654                 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
 655                         a = field->logical_minimum = 0;
 656                         b = field->logical_maximum = 255;
 657                 }
 658
 659                 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
 660                         input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
 661                 else    input_set_abs_params(input, usage->code, a, b, 0, 0);
 662
 663                 input_abs_set_res(input, usage->code,
 664                                   hidinput_calc_abs_res(field, usage->code));
 665
 666                 /* use a larger default input buffer for MT devices */
 667                 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
 668                         input_set_events_per_packet(input, 60);
 669         }
 670
 671         if (usage->type == EV_ABS &&
 672             (usage->hat_min < usage->hat_max || usage->hat_dir)) {
 673                 int i;
 674                 for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
 675                         input_set_abs_params(input, i, -1, 1, 0, 0);
 676                         set_bit(i, input->absbit);
 677                 }
 678                 if (usage->hat_dir && !field->dpad)
 679                         field->dpad = usage->code;
 680         }
 681
 682         /* for those devices which produce Consumer volume usage as relative,
 683          * we emulate pressing volumeup/volumedown appropriate number of times
 684          * in hidinput_hid_event()
 685          */
 686         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
 687                         (usage->code == ABS_VOLUME)) {
 688                 set_bit(KEY_VOLUMEUP, input->keybit);
 689                 set_bit(KEY_VOLUMEDOWN, input->keybit);
 690         }
 691
 692         if (usage->type == EV_KEY) {
 693                 set_bit(EV_MSC, input->evbit);
 694                 set_bit(MSC_SCAN, input->mscbit);
 695         }
 696
 697 ignore:
 698         return;
 699
 700 }
 701
 702 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
 703 {
 704         struct input_dev *input;
 705         unsigned *quirks = &hid->quirks;
 706
 707         if (!field->hidinput)
 708                 return;
 709
 710         input = field->hidinput->input;
 711
 712         if (!usage->type)
 713                 return;
 714
 715         if (usage->hat_min < usage->hat_max || usage->hat_dir) {
 716                 int hat_dir = usage->hat_dir;
 717                 if (!hat_dir)
 718                         hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
 719                 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
 720                 input_event(input, usage->type, usage->code    , hid_hat_to_axis[hat_dir].x);
 721                 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
 722                 return;
 723         }
 724
 725         if (usage->hid == (HID_UP_DIGITIZER | 0x003c)) { /* Invert */
 726                 *quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
 727                 return;
 728         }
 729
 730         if (usage->hid == (HID_UP_DIGITIZER | 0x0032)) { /* InRange */
 731                 if (value) {
 732                         input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
 733                         return;
 734                 }
 735                 input_event(input, usage->type, usage->code, 0);
 736                 input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
 737                 return;
 738         }
 739
 740         if (usage->hid == (HID_UP_DIGITIZER | 0x0030) && (*quirks & HID_QUIRK_NOTOUCH)) { /* Pressure */
 741                 int a = field->logical_minimum;
 742                 int b = field->logical_maximum;
 743                 input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
 744         }
 745
 746         if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
 747                 dbg_hid("Maximum Effects - %d\n",value);
 748                 return;
 749         }
 750
 751         if (usage->hid == (HID_UP_PID | 0x7fUL)) {
 752                 dbg_hid("PID Pool Report\n");
 753                 return;
 754         }
 755
 756         if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
 757                 return;
 758
 759         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
 760                         (usage->code == ABS_VOLUME)) {
 761                 int count = abs(value);
 762                 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
 763                 int i;
 764
 765                 for (i = 0; i < count; i++) {
 766                         input_event(input, EV_KEY, direction, 1);
 767                         input_sync(input);
 768                         input_event(input, EV_KEY, direction, 0);
 769                         input_sync(input);
 770                 }
 771                 return;
 772         }
 773
 774         /* report the usage code as scancode if the key status has changed */
 775         if (usage->type == EV_KEY && !!test_bit(usage->code, input->key) != value)
 776                 input_event(input, EV_MSC, MSC_SCAN, usage->hid);
 777
 778         input_event(input, usage->type, usage->code, value);
 779
 780         if ((field->flags & HID_MAIN_ITEM_RELATIVE) && (usage->type == EV_KEY))
 781                 input_event(input, usage->type, usage->code, 0);
 782 }
 783
 784 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
 785 {
 786         struct hid_input *hidinput;
 787
 788         if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
 789                 return;
 790
 791         list_for_each_entry(hidinput, &hid->inputs, list)
 792                 input_sync(hidinput->input);
 793 }
 794 EXPORT_SYMBOL_GPL(hidinput_report_event);
 795
 796 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
 797 {
 798         struct hid_report *report;
 799         int i, j;
 800
 801         list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
 802                 for (i = 0; i < report->maxfield; i++) {
 803                         *field = report->field[i];
 804                         for (j = 0; j < (*field)->maxusage; j++)
 805                                 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
 806                                         return j;
 807                 }
 808         }
 809         return -1;
 810 }
 811 EXPORT_SYMBOL_GPL(hidinput_find_field);
 812
 813 static int hidinput_open(struct input_dev *dev)
 814 {
 815         struct hid_device *hid = input_get_drvdata(dev);
 816
 817         return hid->ll_driver->open(hid);
 818 }
 819
 820 static void hidinput_close(struct input_dev *dev)
 821 {
 822         struct hid_device *hid = input_get_drvdata(dev);
 823
 824         hid->ll_driver->close(hid);
 825 }
 826
 827 /*
 828  * Register the input device; print a message.
 829  * Configure the input layer interface
 830  * Read all reports and initialize the absolute field values.
 831  */
 832
 833 int hidinput_connect(struct hid_device *hid, unsigned int force)
 834 {
 835         struct hid_report *report;
 836         struct hid_input *hidinput = NULL;
 837         struct input_dev *input_dev;
 838         int i, j, k;
 839         int max_report_type = HID_OUTPUT_REPORT;
 840
 841         INIT_LIST_HEAD(&hid->inputs);
 842
 843         if (!force) {
 844                 for (i = 0; i < hid->maxcollection; i++) {
 845                         struct hid_collection *col = &hid->collection[i];
 846                         if (col->type == HID_COLLECTION_APPLICATION ||
 847                                         col->type == HID_COLLECTION_PHYSICAL)
 848                                 if (IS_INPUT_APPLICATION(col->usage))
 849                                         break;
 850                 }
 851
 852                 if (i == hid->maxcollection)
 853                         return -1;
 854         }
 855
 856         if (hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
 857                 max_report_type = HID_INPUT_REPORT;
 858
 859         for (k = HID_INPUT_REPORT; k <= max_report_type; k++)
 860                 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
 861
 862                         if (!report->maxfield)
 863                                 continue;
 864
 865                         if (!hidinput) {
 866                                 hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
 867                                 input_dev = input_allocate_device();
 868                                 if (!hidinput || !input_dev) {
 869                                         kfree(hidinput);
 870                                         input_free_device(input_dev);
 871                                         err_hid("Out of memory during hid input probe");
 872                                         goto out_unwind;
 873                                 }
 874
 875                                 input_set_drvdata(input_dev, hid);
 876                                 input_dev->event =
 877                                         hid->ll_driver->hidinput_input_event;
 878                                 input_dev->open = hidinput_open;
 879                                 input_dev->close = hidinput_close;
 880                                 input_dev->setkeycode_new = hidinput_setkeycode;
 881                                 input_dev->getkeycode_new = hidinput_getkeycode;
 882
 883                                 input_dev->name = hid->name;
 884                                 input_dev->phys = hid->phys;
 885                                 input_dev->uniq = hid->uniq;
 886                                 input_dev->id.bustype = hid->bus;
 887                                 input_dev->id.vendor  = hid->vendor;
 888                                 input_dev->id.product = hid->product;
 889                                 input_dev->id.version = hid->version;
 890                                 input_dev->dev.parent = hid->dev.parent;
 891                                 hidinput->input = input_dev;
 892                                 list_add_tail(&hidinput->list, &hid->inputs);
 893                         }
 894
 895                         for (i = 0; i < report->maxfield; i++)
 896                                 for (j = 0; j < report->field[i]->maxusage; j++)
 897                                         hidinput_configure_usage(hidinput, report->field[i],
 898                                                                  report->field[i]->usage + j);
 899
 900                         if (hid->quirks & HID_QUIRK_MULTI_INPUT) {
 901                                 /* This will leave hidinput NULL, so that it
 902                                  * allocates another one if we have more inputs on
 903                                  * the same interface. Some devices (e.g. Happ's
 904                                  * UGCI) cram a lot of unrelated inputs into the
 905                                  * same interface. */
 906                                 hidinput->report = report;
 907                                 if (input_register_device(hidinput->input))
 908                                         goto out_cleanup;
 909                                 hidinput = NULL;
 910                         }
 911                 }
 912
 913         if (hidinput && input_register_device(hidinput->input))
 914                 goto out_cleanup;
 915
 916         return 0;
 917
 918 out_cleanup:
 919         input_free_device(hidinput->input);
 920         kfree(hidinput);
 921 out_unwind:
 922         /* unwind the ones we already registered */
 923         hidinput_disconnect(hid);
 924
 925         return -1;
 926 }
 927 EXPORT_SYMBOL_GPL(hidinput_connect);
 928
 929 void hidinput_disconnect(struct hid_device *hid)
 930 {
 931         struct hid_input *hidinput, *next;
 932
 933         list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
 934                 list_del(&hidinput->list);
 935                 input_unregister_device(hidinput->input);
 936                 kfree(hidinput);
 937         }
 938 }
 939 EXPORT_SYMBOL_GPL(hidinput_disconnect);
 940