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