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,111,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,111,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("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 and inches are
 207  * converted to millimeters. 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 millimeters */
 229                         unit_exponent += 1;
 230                 } else if (field->unit == 0x13) {       /* If inches */
 231                         /* Convert to millimeters */
 232                         prev = physical_extents;
 233                         physical_extents *= 254;
 234                         if (physical_extents < prev)
 235                                 return 0;
 236                         unit_exponent -= 1;
 237                 } else {
 238                         return 0;
 239                 }
 240         } else if (code == ABS_RX || code == ABS_RY || code == ABS_RZ) {
 241                 if (field->unit == 0x14) {              /* If degrees */
 242                         /* Convert to radians */
 243                         prev = logical_extents;
 244                         logical_extents *= 573;
 245                         if (logical_extents < prev)
 246                                 return 0;
 247                         unit_exponent += 1;
 248                 } else if (field->unit != 0x12) {       /* If not radians */
 249                         return 0;
 250                 }
 251         } else {
 252                 return 0;
 253         }
 254
 255         /* Apply negative unit exponent */
 256         for (; unit_exponent < 0; unit_exponent++) {
 257                 prev = logical_extents;
 258                 logical_extents *= 10;
 259                 if (logical_extents < prev)
 260                         return 0;
 261         }
 262         /* Apply positive unit exponent */
 263         for (; unit_exponent > 0; unit_exponent--) {
 264                 prev = physical_extents;
 265                 physical_extents *= 10;
 266                 if (physical_extents < prev)
 267                         return 0;
 268         }
 269
 270         /* Calculate resolution */
 271         return logical_extents / physical_extents;
 272 }
 273
 274 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
 275                                      struct hid_usage *usage)
 276 {
 277         struct input_dev *input = hidinput->input;
 278         struct hid_device *device = input_get_drvdata(input);
 279         int max = 0, code;
 280         unsigned long *bit = NULL;
 281
 282         field->hidinput = hidinput;
 283
 284         if (field->flags & HID_MAIN_ITEM_CONSTANT)
 285                 goto ignore;
 286
 287         /* only LED usages are supported in output fields */
 288         if (field->report_type == HID_OUTPUT_REPORT &&
 289                         (usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
 290                 goto ignore;
 291         }
 292
 293         if (device->driver->input_mapping) {
 294                 int ret = device->driver->input_mapping(device, hidinput, field,
 295                                 usage, &bit, &max);
 296                 if (ret > 0)
 297                         goto mapped;
 298                 if (ret < 0)
 299                         goto ignore;
 300         }
 301
 302         switch (usage->hid & HID_USAGE_PAGE) {
 303         case HID_UP_UNDEFINED:
 304                 goto ignore;
 305
 306         case HID_UP_KEYBOARD:
 307                 set_bit(EV_REP, input->evbit);
 308
 309                 if ((usage->hid & HID_USAGE) < 256) {
 310                         if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
 311                         map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
 312                 } else
 313                         map_key(KEY_UNKNOWN);
 314
 315                 break;
 316
 317         case HID_UP_BUTTON:
 318                 code = ((usage->hid - 1) & HID_USAGE);
 319
 320                 switch (field->application) {
 321                 case HID_GD_MOUSE:
 322                 case HID_GD_POINTER:  code += BTN_MOUSE; break;
 323                 case HID_GD_JOYSTICK:
 324                                 if (code <= 0xf)
 325                                         code += BTN_JOYSTICK;
 326                                 else
 327                                         code += BTN_TRIGGER_HAPPY;
 328                                 break;
 329                 case HID_GD_GAMEPAD:  code += BTN_GAMEPAD; break;
 330                 default:
 331                         switch (field->physical) {
 332                         case HID_GD_MOUSE:
 333                         case HID_GD_POINTER:  code += BTN_MOUSE; break;
 334                         case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break;
 335                         case HID_GD_GAMEPAD:  code += BTN_GAMEPAD; break;
 336                         default:              code += BTN_MISC;
 337                         }
 338                 }
 339
 340                 map_key(code);
 341                 break;
 342
 343         case HID_UP_SIMULATION:
 344                 switch (usage->hid & 0xffff) {
 345                 case 0xba: map_abs(ABS_RUDDER);   break;
 346                 case 0xbb: map_abs(ABS_THROTTLE); break;
 347                 case 0xc4: map_abs(ABS_GAS);      break;
 348                 case 0xc5: map_abs(ABS_BRAKE);    break;
 349                 case 0xc8: map_abs(ABS_WHEEL);    break;
 350                 default:   goto ignore;
 351                 }
 352                 break;
 353
 354         case HID_UP_GENDESK:
 355                 if ((usage->hid & 0xf0) == 0x80) {      /* SystemControl */
 356                         switch (usage->hid & 0xf) {
 357                         case 0x1: map_key_clear(KEY_POWER);  break;
 358                         case 0x2: map_key_clear(KEY_SLEEP);  break;
 359                         case 0x3: map_key_clear(KEY_WAKEUP); break;
 360                         case 0x4: map_key_clear(KEY_CONTEXT_MENU); break;
 361                         case 0x5: map_key_clear(KEY_MENU); break;
 362                         case 0x6: map_key_clear(KEY_PROG1); break;
 363                         case 0x7: map_key_clear(KEY_HELP); break;
 364                         case 0x8: map_key_clear(KEY_EXIT); break;
 365                         case 0x9: map_key_clear(KEY_SELECT); break;
 366                         case 0xa: map_key_clear(KEY_RIGHT); break;
 367                         case 0xb: map_key_clear(KEY_LEFT); break;
 368                         case 0xc: map_key_clear(KEY_UP); break;
 369                         case 0xd: map_key_clear(KEY_DOWN); break;
 370                         case 0xe: map_key_clear(KEY_POWER2); break;
 371                         case 0xf: map_key_clear(KEY_RESTART); break;
 372                         default: goto unknown;
 373                         }
 374                         break;
 375                 }
 376
 377                 if ((usage->hid & 0xf0) == 0x90) {      /* D-pad */
 378                         switch (usage->hid) {
 379                         case HID_GD_UP:    usage->hat_dir = 1; break;
 380                         case HID_GD_DOWN:  usage->hat_dir = 5; break;
 381                         case HID_GD_RIGHT: usage->hat_dir = 3; break;
 382                         case HID_GD_LEFT:  usage->hat_dir = 7; break;
 383                         default: goto unknown;
 384                         }
 385                         if (field->dpad) {
 386                                 map_abs(field->dpad);
 387                                 goto ignore;
 388                         }
 389                         map_abs(ABS_HAT0X);
 390                         break;
 391                 }
 392
 393                 switch (usage->hid) {
 394                 /* These usage IDs map directly to the usage codes. */
 395                 case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
 396                 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
 397                 case HID_GD_SLIDER: case HID_GD_DIAL: case HID_GD_WHEEL:
 398                         if (field->flags & HID_MAIN_ITEM_RELATIVE)
 399                                 map_rel(usage->hid & 0xf);
 400                         else
 401                                 map_abs(usage->hid & 0xf);
 402                         break;
 403
 404                 case HID_GD_HATSWITCH:
 405                         usage->hat_min = field->logical_minimum;
 406                         usage->hat_max = field->logical_maximum;
 407                         map_abs(ABS_HAT0X);
 408                         break;
 409
 410                 case HID_GD_START:      map_key_clear(BTN_START);       break;
 411                 case HID_GD_SELECT:     map_key_clear(BTN_SELECT);      break;
 412
 413                 default: goto unknown;
 414                 }
 415
 416                 break;
 417
 418         case HID_UP_LED:
 419                 switch (usage->hid & 0xffff) {                /* HID-Value:                   */
 420                 case 0x01:  map_led (LED_NUML);     break;    /*   "Num Lock"                 */
 421                 case 0x02:  map_led (LED_CAPSL);    break;    /*   "Caps Lock"                */
 422                 case 0x03:  map_led (LED_SCROLLL);  break;    /*   "Scroll Lock"              */
 423                 case 0x04:  map_led (LED_COMPOSE);  break;    /*   "Compose"                  */
 424                 case 0x05:  map_led (LED_KANA);     break;    /*   "Kana"                     */
 425                 case 0x27:  map_led (LED_SLEEP);    break;    /*   "Stand-By"                 */
 426                 case 0x4c:  map_led (LED_SUSPEND);  break;    /*   "System Suspend"           */
 427                 case 0x09:  map_led (LED_MUTE);     break;    /*   "Mute"                     */
 428                 case 0x4b:  map_led (LED_MISC);     break;    /*   "Generic Indicator"        */
 429                 case 0x19:  map_led (LED_MAIL);     break;    /*   "Message Waiting"          */
 430                 case 0x4d:  map_led (LED_CHARGING); break;    /*   "External Power Connected" */
 431
 432                 default: goto ignore;
 433                 }
 434                 break;
 435
 436         case HID_UP_DIGITIZER:
 437                 switch (usage->hid & 0xff) {
 438                 case 0x00: /* Undefined */
 439                         goto ignore;
 440
 441                 case 0x30: /* TipPressure */
 442                         if (!test_bit(BTN_TOUCH, input->keybit)) {
 443                                 device->quirks |= HID_QUIRK_NOTOUCH;
 444                                 set_bit(EV_KEY, input->evbit);
 445                                 set_bit(BTN_TOUCH, input->keybit);
 446                         }
 447                         map_abs_clear(ABS_PRESSURE);
 448                         break;
 449
 450                 case 0x32: /* InRange */
 451                         switch (field->physical & 0xff) {
 452                         case 0x21: map_key(BTN_TOOL_MOUSE); break;
 453                         case 0x22: map_key(BTN_TOOL_FINGER); break;
 454                         default: map_key(BTN_TOOL_PEN); break;
 455                         }
 456                         break;
 457
 458                 case 0x3c: /* Invert */
 459                         map_key_clear(BTN_TOOL_RUBBER);
 460                         break;
 461
 462                 case 0x33: /* Touch */
 463                 case 0x42: /* TipSwitch */
 464                 case 0x43: /* TipSwitch2 */
 465                         device->quirks &= ~HID_QUIRK_NOTOUCH;
 466                         map_key_clear(BTN_TOUCH);
 467                         break;
 468
 469                 case 0x44: /* BarrelSwitch */
 470                         map_key_clear(BTN_STYLUS);
 471                         break;
 472
 473                 case 0x46: /* TabletPick */
 474                         map_key_clear(BTN_STYLUS2);
 475                         break;
 476
 477                 case 0x51: /* ContactID */
 478                         device->quirks |= HID_QUIRK_MULTITOUCH;
 479                         goto unknown;
 480
 481                 default:  goto unknown;
 482                 }
 483                 break;
 484
 485         case HID_UP_CONSUMER:   /* USB HUT v1.12, pages 75-84 */
 486                 switch (usage->hid & HID_USAGE) {
 487                 case 0x000: goto ignore;
 488                 case 0x030: map_key_clear(KEY_POWER);           break;
 489                 case 0x031: map_key_clear(KEY_RESTART);         break;
 490                 case 0x032: map_key_clear(KEY_SLEEP);           break;
 491                 case 0x034: map_key_clear(KEY_SLEEP);           break;
 492                 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE);  break;
 493                 case 0x036: map_key_clear(BTN_MISC);            break;
 494
 495                 case 0x040: map_key_clear(KEY_MENU);            break; /* Menu */
 496                 case 0x041: map_key_clear(KEY_SELECT);          break; /* Menu Pick */
 497                 case 0x042: map_key_clear(KEY_UP);              break; /* Menu Up */
 498                 case 0x043: map_key_clear(KEY_DOWN);            break; /* Menu Down */
 499                 case 0x044: map_key_clear(KEY_LEFT);            break; /* Menu Left */
 500                 case 0x045: map_key_clear(KEY_RIGHT);           break; /* Menu Right */
 501                 case 0x046: map_key_clear(KEY_ESC);             break; /* Menu Escape */
 502                 case 0x047: map_key_clear(KEY_KPPLUS);          break; /* Menu Value Increase */
 503                 case 0x048: map_key_clear(KEY_KPMINUS);         break; /* Menu Value Decrease */
 504
 505                 case 0x060: map_key_clear(KEY_INFO);            break; /* Data On Screen */
 506                 case 0x061: map_key_clear(KEY_SUBTITLE);        break; /* Closed Caption */
 507                 case 0x063: map_key_clear(KEY_VCR);             break; /* VCR/TV */
 508                 case 0x065: map_key_clear(KEY_CAMERA);          break; /* Snapshot */
 509                 case 0x069: map_key_clear(KEY_RED);             break;
 510                 case 0x06a: map_key_clear(KEY_GREEN);           break;
 511                 case 0x06b: map_key_clear(KEY_BLUE);            break;
 512                 case 0x06c: map_key_clear(KEY_YELLOW);          break;
 513                 case 0x06d: map_key_clear(KEY_ZOOM);            break;
 514
 515                 case 0x082: map_key_clear(KEY_VIDEO_NEXT);      break;
 516                 case 0x083: map_key_clear(KEY_LAST);            break;
 517                 case 0x084: map_key_clear(KEY_ENTER);           break;
 518                 case 0x088: map_key_clear(KEY_PC);              break;
 519                 case 0x089: map_key_clear(KEY_TV);              break;
 520                 case 0x08a: map_key_clear(KEY_WWW);             break;
 521                 case 0x08b: map_key_clear(KEY_DVD);             break;
 522                 case 0x08c: map_key_clear(KEY_PHONE);           break;
 523                 case 0x08d: map_key_clear(KEY_PROGRAM);         break;
 524                 case 0x08e: map_key_clear(KEY_VIDEOPHONE);      break;
 525                 case 0x08f: map_key_clear(KEY_GAMES);           break;
 526                 case 0x090: map_key_clear(KEY_MEMO);            break;
 527                 case 0x091: map_key_clear(KEY_CD);              break;
 528                 case 0x092: map_key_clear(KEY_VCR);             break;
 529                 case 0x093: map_key_clear(KEY_TUNER);           break;
 530                 case 0x094: map_key_clear(KEY_EXIT);            break;
 531                 case 0x095: map_key_clear(KEY_HELP);            break;
 532                 case 0x096: map_key_clear(KEY_TAPE);            break;
 533                 case 0x097: map_key_clear(KEY_TV2);             break;
 534                 case 0x098: map_key_clear(KEY_SAT);             break;
 535                 case 0x09a: map_key_clear(KEY_PVR);             break;
 536
 537                 case 0x09c: map_key_clear(KEY_CHANNELUP);       break;
 538                 case 0x09d: map_key_clear(KEY_CHANNELDOWN);     break;
 539                 case 0x0a0: map_key_clear(KEY_VCR2);            break;
 540
 541                 case 0x0b0: map_key_clear(KEY_PLAY);            break;
 542                 case 0x0b1: map_key_clear(KEY_PAUSE);           break;
 543                 case 0x0b2: map_key_clear(KEY_RECORD);          break;
 544                 case 0x0b3: map_key_clear(KEY_FASTFORWARD);     break;
 545                 case 0x0b4: map_key_clear(KEY_REWIND);          break;
 546                 case 0x0b5: map_key_clear(KEY_NEXTSONG);        break;
 547                 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG);    break;
 548                 case 0x0b7: map_key_clear(KEY_STOPCD);          break;
 549                 case 0x0b8: map_key_clear(KEY_EJECTCD);         break;
 550                 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT);    break;
 551                 case 0x0b9: map_key_clear(KEY_SHUFFLE);         break;
 552                 case 0x0bf: map_key_clear(KEY_SLOW);            break;
 553
 554                 case 0x0cd: map_key_clear(KEY_PLAYPAUSE);       break;
 555                 case 0x0e0: map_abs_clear(ABS_VOLUME);          break;
 556                 case 0x0e2: map_key_clear(KEY_MUTE);            break;
 557                 case 0x0e5: map_key_clear(KEY_BASSBOOST);       break;
 558                 case 0x0e9: map_key_clear(KEY_VOLUMEUP);        break;
 559                 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN);      break;
 560                 case 0x0f5: map_key_clear(KEY_SLOW);            break;
 561
 562                 case 0x182: map_key_clear(KEY_BOOKMARKS);       break;
 563                 case 0x183: map_key_clear(KEY_CONFIG);          break;
 564                 case 0x184: map_key_clear(KEY_WORDPROCESSOR);   break;
 565                 case 0x185: map_key_clear(KEY_EDITOR);          break;
 566                 case 0x186: map_key_clear(KEY_SPREADSHEET);     break;
 567                 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR);  break;
 568                 case 0x188: map_key_clear(KEY_PRESENTATION);    break;
 569                 case 0x189: map_key_clear(KEY_DATABASE);        break;
 570                 case 0x18a: map_key_clear(KEY_MAIL);            break;
 571                 case 0x18b: map_key_clear(KEY_NEWS);            break;
 572                 case 0x18c: map_key_clear(KEY_VOICEMAIL);       break;
 573                 case 0x18d: map_key_clear(KEY_ADDRESSBOOK);     break;
 574                 case 0x18e: map_key_clear(KEY_CALENDAR);        break;
 575                 case 0x191: map_key_clear(KEY_FINANCE);         break;
 576                 case 0x192: map_key_clear(KEY_CALC);            break;
 577                 case 0x193: map_key_clear(KEY_PLAYER);          break;
 578                 case 0x194: map_key_clear(KEY_FILE);            break;
 579                 case 0x196: map_key_clear(KEY_WWW);             break;
 580                 case 0x199: map_key_clear(KEY_CHAT);            break;
 581                 case 0x19c: map_key_clear(KEY_LOGOFF);          break;
 582                 case 0x19e: map_key_clear(KEY_COFFEE);          break;
 583                 case 0x1a6: map_key_clear(KEY_HELP);            break;
 584                 case 0x1a7: map_key_clear(KEY_DOCUMENTS);       break;
 585                 case 0x1ab: map_key_clear(KEY_SPELLCHECK);      break;
 586                 case 0x1ae: map_key_clear(KEY_KEYBOARD);        break;
 587                 case 0x1b6: map_key_clear(KEY_IMAGES);          break;
 588                 case 0x1b7: map_key_clear(KEY_AUDIO);           break;
 589                 case 0x1b8: map_key_clear(KEY_VIDEO);           break;
 590                 case 0x1bc: map_key_clear(KEY_MESSENGER);       break;
 591                 case 0x1bd: map_key_clear(KEY_INFO);            break;
 592                 case 0x201: map_key_clear(KEY_NEW);             break;
 593                 case 0x202: map_key_clear(KEY_OPEN);            break;
 594                 case 0x203: map_key_clear(KEY_CLOSE);           break;
 595                 case 0x204: map_key_clear(KEY_EXIT);            break;
 596                 case 0x207: map_key_clear(KEY_SAVE);            break;
 597                 case 0x208: map_key_clear(KEY_PRINT);           break;
 598                 case 0x209: map_key_clear(KEY_PROPS);           break;
 599                 case 0x21a: map_key_clear(KEY_UNDO);            break;
 600                 case 0x21b: map_key_clear(KEY_COPY);            break;
 601                 case 0x21c: map_key_clear(KEY_CUT);             break;
 602                 case 0x21d: map_key_clear(KEY_PASTE);           break;
 603                 case 0x21f: map_key_clear(KEY_FIND);            break;
 604                 case 0x221: map_key_clear(KEY_SEARCH);          break;
 605                 case 0x222: map_key_clear(KEY_GOTO);            break;
 606                 case 0x223: map_key_clear(KEY_HOMEPAGE);        break;
 607                 case 0x224: map_key_clear(KEY_BACK);            break;
 608                 case 0x225: map_key_clear(KEY_FORWARD);         break;
 609                 case 0x226: map_key_clear(KEY_STOP);            break;
 610                 case 0x227: map_key_clear(KEY_REFRESH);         break;
 611                 case 0x22a: map_key_clear(KEY_BOOKMARKS);       break;
 612                 case 0x22d: map_key_clear(KEY_ZOOMIN);          break;
 613                 case 0x22e: map_key_clear(KEY_ZOOMOUT);         break;
 614                 case 0x22f: map_key_clear(KEY_ZOOMRESET);       break;
 615                 case 0x233: map_key_clear(KEY_SCROLLUP);        break;
 616                 case 0x234: map_key_clear(KEY_SCROLLDOWN);      break;
 617                 case 0x238: map_rel(REL_HWHEEL);                break;
 618                 case 0x23d: map_key_clear(KEY_EDIT);            break;
 619                 case 0x25f: map_key_clear(KEY_CANCEL);          break;
 620                 case 0x269: map_key_clear(KEY_INSERT);          break;
 621                 case 0x26a: map_key_clear(KEY_DELETE);          break;
 622                 case 0x279: map_key_clear(KEY_REDO);            break;
 623
 624                 case 0x289: map_key_clear(KEY_REPLY);           break;
 625                 case 0x28b: map_key_clear(KEY_FORWARDMAIL);     break;
 626                 case 0x28c: map_key_clear(KEY_SEND);            break;
 627
 628                 default:    goto ignore;
 629                 }
 630                 break;
 631
 632         case HID_UP_HPVENDOR:   /* Reported on a Dutch layout HP5308 */
 633                 set_bit(EV_REP, input->evbit);
 634                 switch (usage->hid & HID_USAGE) {
 635                 case 0x021: map_key_clear(KEY_PRINT);           break;
 636                 case 0x070: map_key_clear(KEY_HP);              break;
 637                 case 0x071: map_key_clear(KEY_CAMERA);          break;
 638                 case 0x072: map_key_clear(KEY_SOUND);           break;
 639                 case 0x073: map_key_clear(KEY_QUESTION);        break;
 640                 case 0x080: map_key_clear(KEY_EMAIL);           break;
 641                 case 0x081: map_key_clear(KEY_CHAT);            break;
 642                 case 0x082: map_key_clear(KEY_SEARCH);          break;
 643                 case 0x083: map_key_clear(KEY_CONNECT);         break;
 644                 case 0x084: map_key_clear(KEY_FINANCE);         break;
 645                 case 0x085: map_key_clear(KEY_SPORT);           break;
 646                 case 0x086: map_key_clear(KEY_SHOP);            break;
 647                 default:    goto ignore;
 648                 }
 649                 break;
 650
 651         case HID_UP_MSVENDOR:
 652                 goto ignore;
 653
 654         case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
 655                 set_bit(EV_REP, input->evbit);
 656                 goto ignore;
 657
 658         case HID_UP_LOGIVENDOR:
 659                 goto ignore;
 660
 661         case HID_UP_PID:
 662                 switch (usage->hid & HID_USAGE) {
 663                 case 0xa4: map_key_clear(BTN_DEAD);     break;
 664                 default: goto ignore;
 665                 }
 666                 break;
 667
 668         default:
 669         unknown:
 670                 if (field->report_size == 1) {
 671                         if (field->report->type == HID_OUTPUT_REPORT) {
 672                                 map_led(LED_MISC);
 673                                 break;
 674                         }
 675                         map_key(BTN_MISC);
 676                         break;
 677                 }
 678                 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
 679                         map_rel(REL_MISC);
 680                         break;
 681                 }
 682                 map_abs(ABS_MISC);
 683                 break;
 684         }
 685
 686 mapped:
 687         if (device->driver->input_mapped && device->driver->input_mapped(device,
 688                                 hidinput, field, usage, &bit, &max) < 0)
 689                 goto ignore;
 690
 691         set_bit(usage->type, input->evbit);
 692
 693         while (usage->code <= max && test_and_set_bit(usage->code, bit))
 694                 usage->code = find_next_zero_bit(bit, max + 1, usage->code);
 695
 696         if (usage->code > max)
 697                 goto ignore;
 698
 699
 700         if (usage->type == EV_ABS) {
 701
 702                 int a = field->logical_minimum;
 703                 int b = field->logical_maximum;
 704
 705                 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
 706                         a = field->logical_minimum = 0;
 707                         b = field->logical_maximum = 255;
 708                 }
 709
 710                 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
 711                         input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
 712                 else    input_set_abs_params(input, usage->code, a, b, 0, 0);
 713
 714                 input_abs_set_res(input, usage->code,
 715                                   hidinput_calc_abs_res(field, usage->code));
 716
 717                 /* use a larger default input buffer for MT devices */
 718                 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
 719                         input_set_events_per_packet(input, 60);
 720         }
 721
 722         if (usage->type == EV_ABS &&
 723             (usage->hat_min < usage->hat_max || usage->hat_dir)) {
 724                 int i;
 725                 for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
 726                         input_set_abs_params(input, i, -1, 1, 0, 0);
 727                         set_bit(i, input->absbit);
 728                 }
 729                 if (usage->hat_dir && !field->dpad)
 730                         field->dpad = usage->code;
 731         }
 732
 733         /* for those devices which produce Consumer volume usage as relative,
 734          * we emulate pressing volumeup/volumedown appropriate number of times
 735          * in hidinput_hid_event()
 736          */
 737         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
 738                         (usage->code == ABS_VOLUME)) {
 739                 set_bit(KEY_VOLUMEUP, input->keybit);
 740                 set_bit(KEY_VOLUMEDOWN, input->keybit);
 741         }
 742
 743         if (usage->type == EV_KEY) {
 744                 set_bit(EV_MSC, input->evbit);
 745                 set_bit(MSC_SCAN, input->mscbit);
 746         }
 747
 748 ignore:
 749         return;
 750
 751 }
 752
 753 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
 754 {
 755         struct input_dev *input;
 756         unsigned *quirks = &hid->quirks;
 757
 758         if (!field->hidinput)
 759                 return;
 760
 761         input = field->hidinput->input;
 762
 763         if (!usage->type)
 764                 return;
 765
 766         if (usage->hat_min < usage->hat_max || usage->hat_dir) {
 767                 int hat_dir = usage->hat_dir;
 768                 if (!hat_dir)
 769                         hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
 770                 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
 771                 input_event(input, usage->type, usage->code    , hid_hat_to_axis[hat_dir].x);
 772                 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
 773                 return;
 774         }
 775
 776         if (usage->hid == (HID_UP_DIGITIZER | 0x003c)) { /* Invert */
 777                 *quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
 778                 return;
 779         }
 780
 781         if (usage->hid == (HID_UP_DIGITIZER | 0x0032)) { /* InRange */
 782                 if (value) {
 783                         input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
 784                         return;
 785                 }
 786                 input_event(input, usage->type, usage->code, 0);
 787                 input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
 788                 return;
 789         }
 790
 791         if (usage->hid == (HID_UP_DIGITIZER | 0x0030) && (*quirks & HID_QUIRK_NOTOUCH)) { /* Pressure */
 792                 int a = field->logical_minimum;
 793                 int b = field->logical_maximum;
 794                 input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
 795         }
 796
 797         if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
 798                 dbg_hid("Maximum Effects - %d\n",value);
 799                 return;
 800         }
 801
 802         if (usage->hid == (HID_UP_PID | 0x7fUL)) {
 803                 dbg_hid("PID Pool Report\n");
 804                 return;
 805         }
 806
 807         if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
 808                 return;
 809
 810         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
 811                         (usage->code == ABS_VOLUME)) {
 812                 int count = abs(value);
 813                 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
 814                 int i;
 815
 816                 for (i = 0; i < count; i++) {
 817                         input_event(input, EV_KEY, direction, 1);
 818                         input_sync(input);
 819                         input_event(input, EV_KEY, direction, 0);
 820                         input_sync(input);
 821                 }
 822                 return;
 823         }
 824
 825         /* report the usage code as scancode if the key status has changed */
 826         if (usage->type == EV_KEY && !!test_bit(usage->code, input->key) != value)
 827                 input_event(input, EV_MSC, MSC_SCAN, usage->hid);
 828
 829         input_event(input, usage->type, usage->code, value);
 830
 831         if ((field->flags & HID_MAIN_ITEM_RELATIVE) && (usage->type == EV_KEY))
 832                 input_event(input, usage->type, usage->code, 0);
 833 }
 834
 835 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
 836 {
 837         struct hid_input *hidinput;
 838
 839         if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
 840                 return;
 841
 842         list_for_each_entry(hidinput, &hid->inputs, list)
 843                 input_sync(hidinput->input);
 844 }
 845 EXPORT_SYMBOL_GPL(hidinput_report_event);
 846
 847 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
 848 {
 849         struct hid_report *report;
 850         int i, j;
 851
 852         list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
 853                 for (i = 0; i < report->maxfield; i++) {
 854                         *field = report->field[i];
 855                         for (j = 0; j < (*field)->maxusage; j++)
 856                                 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
 857                                         return j;
 858                 }
 859         }
 860         return -1;
 861 }
 862 EXPORT_SYMBOL_GPL(hidinput_find_field);
 863
 864 static int hidinput_open(struct input_dev *dev)
 865 {
 866         struct hid_device *hid = input_get_drvdata(dev);
 867
 868         return hid_hw_open(hid);
 869 }
 870
 871 static void hidinput_close(struct input_dev *dev)
 872 {
 873         struct hid_device *hid = input_get_drvdata(dev);
 874
 875         hid_hw_close(hid);
 876 }
 877
 878 static void report_features(struct hid_device *hid)
 879 {
 880         struct hid_driver *drv = hid->driver;
 881         struct hid_report_enum *rep_enum;
 882         struct hid_report *rep;
 883         int i, j;
 884
 885         if (!drv->feature_mapping)
 886                 return;
 887
 888         rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
 889         list_for_each_entry(rep, &rep_enum->report_list, list)
 890                 for (i = 0; i < rep->maxfield; i++)
 891                         for (j = 0; j < rep->field[i]->maxusage; j++)
 892                                 drv->feature_mapping(hid, rep->field[i],
 893                                                      rep->field[i]->usage + j);
 894 }
 895
 896 /*
 897  * Register the input device; print a message.
 898  * Configure the input layer interface
 899  * Read all reports and initialize the absolute field values.
 900  */
 901
 902 int hidinput_connect(struct hid_device *hid, unsigned int force)
 903 {
 904         struct hid_report *report;
 905         struct hid_input *hidinput = NULL;
 906         struct input_dev *input_dev;
 907         int i, j, k;
 908
 909         INIT_LIST_HEAD(&hid->inputs);
 910
 911         if (!force) {
 912                 for (i = 0; i < hid->maxcollection; i++) {
 913                         struct hid_collection *col = &hid->collection[i];
 914                         if (col->type == HID_COLLECTION_APPLICATION ||
 915                                         col->type == HID_COLLECTION_PHYSICAL)
 916                                 if (IS_INPUT_APPLICATION(col->usage))
 917                                         break;
 918                 }
 919
 920                 if (i == hid->maxcollection)
 921                         return -1;
 922         }
 923
 924         report_features(hid);
 925
 926         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
 927                 if (k == HID_OUTPUT_REPORT &&
 928                         hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
 929                         continue;
 930
 931                 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
 932
 933                         if (!report->maxfield)
 934                                 continue;
 935
 936                         if (!hidinput) {
 937                                 hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
 938                                 input_dev = input_allocate_device();
 939                                 if (!hidinput || !input_dev) {
 940                                         kfree(hidinput);
 941                                         input_free_device(input_dev);
 942                                         hid_err(hid, "Out of memory during hid input probe\n");
 943                                         goto out_unwind;
 944                                 }
 945
 946                                 input_set_drvdata(input_dev, hid);
 947                                 input_dev->event =
 948                                         hid->ll_driver->hidinput_input_event;
 949                                 input_dev->open = hidinput_open;
 950                                 input_dev->close = hidinput_close;
 951                                 input_dev->setkeycode = hidinput_setkeycode;
 952                                 input_dev->getkeycode = hidinput_getkeycode;
 953
 954                                 input_dev->name = hid->name;
 955                                 input_dev->phys = hid->phys;
 956                                 input_dev->uniq = hid->uniq;
 957                                 input_dev->id.bustype = hid->bus;
 958                                 input_dev->id.vendor  = hid->vendor;
 959                                 input_dev->id.product = hid->product;
 960                                 input_dev->id.version = hid->version;
 961                                 input_dev->dev.parent = hid->dev.parent;
 962                                 hidinput->input = input_dev;
 963                                 list_add_tail(&hidinput->list, &hid->inputs);
 964                         }
 965
 966                         for (i = 0; i < report->maxfield; i++)
 967                                 for (j = 0; j < report->field[i]->maxusage; j++)
 968                                         hidinput_configure_usage(hidinput, report->field[i],
 969                                                                  report->field[i]->usage + j);
 970
 971                         if (hid->quirks & HID_QUIRK_MULTI_INPUT) {
 972                                 /* This will leave hidinput NULL, so that it
 973                                  * allocates another one if we have more inputs on
 974                                  * the same interface. Some devices (e.g. Happ's
 975                                  * UGCI) cram a lot of unrelated inputs into the
 976                                  * same interface. */
 977                                 hidinput->report = report;
 978                                 if (input_register_device(hidinput->input))
 979                                         goto out_cleanup;
 980                                 hidinput = NULL;
 981                         }
 982                 }
 983         }
 984
 985         if (hid->quirks & HID_QUIRK_MULTITOUCH) {
 986                 /* generic hid does not know how to handle multitouch devices */
 987                 if (hidinput)
 988                         goto out_cleanup;
 989                 goto out_unwind;
 990         }
 991
 992         if (hidinput && input_register_device(hidinput->input))
 993                 goto out_cleanup;
 994
 995         return 0;
 996
 997 out_cleanup:
 998         list_del(&hidinput->list);
 999         input_free_device(hidinput->input);
1000         kfree(hidinput);
1001 out_unwind:
1002         /* unwind the ones we already registered */
1003         hidinput_disconnect(hid);
1004
1005         return -1;
1006 }
1007 EXPORT_SYMBOL_GPL(hidinput_connect);
1008
1009 void hidinput_disconnect(struct hid_device *hid)
1010 {
1011         struct hid_input *hidinput, *next;
1012
1013         list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1014                 list_del(&hidinput->list);
1015                 input_unregister_device(hidinput->input);
1016                 kfree(hidinput);
1017         }
1018 }
1019 EXPORT_SYMBOL_GPL(hidinput_disconnect);
1020