include/linux/hid.h

   1 /*
   2  *  Copyright (c) 1999 Andreas Gal
   3  *  Copyright (c) 2000-2001 Vojtech Pavlik
   4  *  Copyright (c) 2006-2007 Jiri Kosina
   5  */
   6 /*
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  20  *
  21  * Should you need to contact me, the author, you can do so either by
  22  * e-mail - mail your message to <[email protected]>, or by paper mail:
  23  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  24  */
  25 #ifndef __HID_H
  26 #define __HID_H
  27
  28
  29 #include <linux/types.h>
  30 #include <linux/slab.h>
  31 #include <linux/list.h>
  32 #include <linux/mod_devicetable.h> /* hid_device_id */
  33 #include <linux/timer.h>
  34 #include <linux/workqueue.h>
  35 #include <linux/input.h>
  36 #include <linux/semaphore.h>
  37 #include <linux/power_supply.h>
  38 #include <uapi/linux/hid.h>
  39
  40 /*
  41  * We parse each description item into this structure. Short items data
  42  * values are expanded to 32-bit signed int, long items contain a pointer
  43  * into the data area.
  44  */
  45
  46 struct hid_item {
  47         unsigned  format;
  48         __u8      size;
  49         __u8      type;
  50         __u8      tag;
  51         union {
  52             __u8   u8;
  53             __s8   s8;
  54             __u16  u16;
  55             __s16  s16;
  56             __u32  u32;
  57             __s32  s32;
  58             __u8  *longdata;
  59         } data;
  60 };
  61
  62 /*
  63  * HID report item format
  64  */
  65
  66 #define HID_ITEM_FORMAT_SHORT   0
  67 #define HID_ITEM_FORMAT_LONG    1
  68
  69 /*
  70  * Special tag indicating long items
  71  */
  72
  73 #define HID_ITEM_TAG_LONG       15
  74
  75 /*
  76  * HID report descriptor item type (prefix bit 2,3)
  77  */
  78
  79 #define HID_ITEM_TYPE_MAIN              0
  80 #define HID_ITEM_TYPE_GLOBAL            1
  81 #define HID_ITEM_TYPE_LOCAL             2
  82 #define HID_ITEM_TYPE_RESERVED          3
  83
  84 /*
  85  * HID report descriptor main item tags
  86  */
  87
  88 #define HID_MAIN_ITEM_TAG_INPUT                 8
  89 #define HID_MAIN_ITEM_TAG_OUTPUT                9
  90 #define HID_MAIN_ITEM_TAG_FEATURE               11
  91 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION      10
  92 #define HID_MAIN_ITEM_TAG_END_COLLECTION        12
  93
  94 /*
  95  * HID report descriptor main item contents
  96  */
  97
  98 #define HID_MAIN_ITEM_CONSTANT          0x001
  99 #define HID_MAIN_ITEM_VARIABLE          0x002
 100 #define HID_MAIN_ITEM_RELATIVE          0x004
 101 #define HID_MAIN_ITEM_WRAP              0x008
 102 #define HID_MAIN_ITEM_NONLINEAR         0x010
 103 #define HID_MAIN_ITEM_NO_PREFERRED      0x020
 104 #define HID_MAIN_ITEM_NULL_STATE        0x040
 105 #define HID_MAIN_ITEM_VOLATILE          0x080
 106 #define HID_MAIN_ITEM_BUFFERED_BYTE     0x100
 107
 108 /*
 109  * HID report descriptor collection item types
 110  */
 111
 112 #define HID_COLLECTION_PHYSICAL         0
 113 #define HID_COLLECTION_APPLICATION      1
 114 #define HID_COLLECTION_LOGICAL          2
 115
 116 /*
 117  * HID report descriptor global item tags
 118  */
 119
 120 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE          0
 121 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM     1
 122 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM     2
 123 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM    3
 124 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM    4
 125 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT       5
 126 #define HID_GLOBAL_ITEM_TAG_UNIT                6
 127 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE         7
 128 #define HID_GLOBAL_ITEM_TAG_REPORT_ID           8
 129 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT        9
 130 #define HID_GLOBAL_ITEM_TAG_PUSH                10
 131 #define HID_GLOBAL_ITEM_TAG_POP                 11
 132
 133 /*
 134  * HID report descriptor local item tags
 135  */
 136
 137 #define HID_LOCAL_ITEM_TAG_USAGE                0
 138 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM        1
 139 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM        2
 140 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX     3
 141 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM   4
 142 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM   5
 143 #define HID_LOCAL_ITEM_TAG_STRING_INDEX         7
 144 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM       8
 145 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM       9
 146 #define HID_LOCAL_ITEM_TAG_DELIMITER            10
 147
 148 /*
 149  * HID usage tables
 150  */
 151
 152 #define HID_USAGE_PAGE          0xffff0000
 153
 154 #define HID_UP_UNDEFINED        0x00000000
 155 #define HID_UP_GENDESK          0x00010000
 156 #define HID_UP_SIMULATION       0x00020000
 157 #define HID_UP_GENDEVCTRLS      0x00060000
 158 #define HID_UP_KEYBOARD         0x00070000
 159 #define HID_UP_LED              0x00080000
 160 #define HID_UP_BUTTON           0x00090000
 161 #define HID_UP_ORDINAL          0x000a0000
 162 #define HID_UP_CONSUMER         0x000c0000
 163 #define HID_UP_DIGITIZER        0x000d0000
 164 #define HID_UP_PID              0x000f0000
 165 #define HID_UP_HPVENDOR         0xff7f0000
 166 #define HID_UP_HPVENDOR2        0xff010000
 167 #define HID_UP_MSVENDOR         0xff000000
 168 #define HID_UP_CUSTOM           0x00ff0000
 169 #define HID_UP_LOGIVENDOR       0xffbc0000
 170 #define HID_UP_LNVENDOR         0xffa00000
 171 #define HID_UP_SENSOR           0x00200000
 172
 173 #define HID_USAGE               0x0000ffff
 174
 175 #define HID_GD_POINTER          0x00010001
 176 #define HID_GD_MOUSE            0x00010002
 177 #define HID_GD_JOYSTICK         0x00010004
 178 #define HID_GD_GAMEPAD          0x00010005
 179 #define HID_GD_KEYBOARD         0x00010006
 180 #define HID_GD_KEYPAD           0x00010007
 181 #define HID_GD_MULTIAXIS        0x00010008
 182 #define HID_GD_X                0x00010030
 183 #define HID_GD_Y                0x00010031
 184 #define HID_GD_Z                0x00010032
 185 #define HID_GD_RX               0x00010033
 186 #define HID_GD_RY               0x00010034
 187 #define HID_GD_RZ               0x00010035
 188 #define HID_GD_SLIDER           0x00010036
 189 #define HID_GD_DIAL             0x00010037
 190 #define HID_GD_WHEEL            0x00010038
 191 #define HID_GD_HATSWITCH        0x00010039
 192 #define HID_GD_BUFFER           0x0001003a
 193 #define HID_GD_BYTECOUNT        0x0001003b
 194 #define HID_GD_MOTION           0x0001003c
 195 #define HID_GD_START            0x0001003d
 196 #define HID_GD_SELECT           0x0001003e
 197 #define HID_GD_VX               0x00010040
 198 #define HID_GD_VY               0x00010041
 199 #define HID_GD_VZ               0x00010042
 200 #define HID_GD_VBRX             0x00010043
 201 #define HID_GD_VBRY             0x00010044
 202 #define HID_GD_VBRZ             0x00010045
 203 #define HID_GD_VNO              0x00010046
 204 #define HID_GD_FEATURE          0x00010047
 205 #define HID_GD_SYSTEM_CONTROL   0x00010080
 206 #define HID_GD_UP               0x00010090
 207 #define HID_GD_DOWN             0x00010091
 208 #define HID_GD_RIGHT            0x00010092
 209 #define HID_GD_LEFT             0x00010093
 210
 211 #define HID_DC_BATTERYSTRENGTH  0x00060020
 212
 213 #define HID_CP_CONSUMER_CONTROL 0x000c0001
 214
 215 #define HID_DG_DIGITIZER        0x000d0001
 216 #define HID_DG_PEN              0x000d0002
 217 #define HID_DG_LIGHTPEN         0x000d0003
 218 #define HID_DG_TOUCHSCREEN      0x000d0004
 219 #define HID_DG_TOUCHPAD         0x000d0005
 220 #define HID_DG_STYLUS           0x000d0020
 221 #define HID_DG_PUCK             0x000d0021
 222 #define HID_DG_FINGER           0x000d0022
 223 #define HID_DG_TIPPRESSURE      0x000d0030
 224 #define HID_DG_BARRELPRESSURE   0x000d0031
 225 #define HID_DG_INRANGE          0x000d0032
 226 #define HID_DG_TOUCH            0x000d0033
 227 #define HID_DG_UNTOUCH          0x000d0034
 228 #define HID_DG_TAP              0x000d0035
 229 #define HID_DG_TABLETFUNCTIONKEY        0x000d0039
 230 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a
 231 #define HID_DG_INVERT           0x000d003c
 232 #define HID_DG_TIPSWITCH        0x000d0042
 233 #define HID_DG_TIPSWITCH2       0x000d0043
 234 #define HID_DG_BARRELSWITCH     0x000d0044
 235 #define HID_DG_ERASER           0x000d0045
 236 #define HID_DG_TABLETPICK       0x000d0046
 237
 238 #define HID_CP_CONSUMERCONTROL  0x000c0001
 239 #define HID_CP_NUMERICKEYPAD    0x000c0002
 240 #define HID_CP_PROGRAMMABLEBUTTONS      0x000c0003
 241 #define HID_CP_MICROPHONE       0x000c0004
 242 #define HID_CP_HEADPHONE        0x000c0005
 243 #define HID_CP_GRAPHICEQUALIZER 0x000c0006
 244 #define HID_CP_FUNCTIONBUTTONS  0x000c0036
 245 #define HID_CP_SELECTION        0x000c0080
 246 #define HID_CP_MEDIASELECTION   0x000c0087
 247 #define HID_CP_SELECTDISC       0x000c00ba
 248 #define HID_CP_PLAYBACKSPEED    0x000c00f1
 249 #define HID_CP_PROXIMITY        0x000c0109
 250 #define HID_CP_SPEAKERSYSTEM    0x000c0160
 251 #define HID_CP_CHANNELLEFT      0x000c0161
 252 #define HID_CP_CHANNELRIGHT     0x000c0162
 253 #define HID_CP_CHANNELCENTER    0x000c0163
 254 #define HID_CP_CHANNELFRONT     0x000c0164
 255 #define HID_CP_CHANNELCENTERFRONT       0x000c0165
 256 #define HID_CP_CHANNELSIDE      0x000c0166
 257 #define HID_CP_CHANNELSURROUND  0x000c0167
 258 #define HID_CP_CHANNELLOWFREQUENCYENHANCEMENT   0x000c0168
 259 #define HID_CP_CHANNELTOP       0x000c0169
 260 #define HID_CP_CHANNELUNKNOWN   0x000c016a
 261 #define HID_CP_APPLICATIONLAUNCHBUTTONS 0x000c0180
 262 #define HID_CP_GENERICGUIAPPLICATIONCONTROLS    0x000c0200
 263
 264 #define HID_DG_CONFIDENCE       0x000d0047
 265 #define HID_DG_WIDTH            0x000d0048
 266 #define HID_DG_HEIGHT           0x000d0049
 267 #define HID_DG_CONTACTID        0x000d0051
 268 #define HID_DG_INPUTMODE        0x000d0052
 269 #define HID_DG_DEVICEINDEX      0x000d0053
 270 #define HID_DG_CONTACTCOUNT     0x000d0054
 271 #define HID_DG_CONTACTMAX       0x000d0055
 272 #define HID_DG_BARRELSWITCH2    0x000d005a
 273 #define HID_DG_TOOLSERIALNUMBER 0x000d005b
 274
 275 /*
 276  * HID report types --- Ouch! HID spec says 1 2 3!
 277  */
 278
 279 #define HID_INPUT_REPORT        0
 280 #define HID_OUTPUT_REPORT       1
 281 #define HID_FEATURE_REPORT      2
 282
 283 #define HID_REPORT_TYPES        3
 284
 285 /*
 286  * HID connect requests
 287  */
 288
 289 #define HID_CONNECT_HIDINPUT            0x01
 290 #define HID_CONNECT_HIDINPUT_FORCE      0x02
 291 #define HID_CONNECT_HIDRAW              0x04
 292 #define HID_CONNECT_HIDDEV              0x08
 293 #define HID_CONNECT_HIDDEV_FORCE        0x10
 294 #define HID_CONNECT_FF                  0x20
 295 #define HID_CONNECT_DRIVER              0x40
 296 #define HID_CONNECT_DEFAULT     (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
 297                 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
 298
 299 /*
 300  * HID device quirks.
 301  */
 302
 303 /*
 304  * Increase this if you need to configure more HID quirks at module load time
 305  */
 306 #define MAX_USBHID_BOOT_QUIRKS 4
 307
 308 #define HID_QUIRK_INVERT                        0x00000001
 309 #define HID_QUIRK_NOTOUCH                       0x00000002
 310 #define HID_QUIRK_IGNORE                        0x00000004
 311 #define HID_QUIRK_NOGET                         0x00000008
 312 #define HID_QUIRK_HIDDEV_FORCE                  0x00000010
 313 #define HID_QUIRK_BADPAD                        0x00000020
 314 #define HID_QUIRK_MULTI_INPUT                   0x00000040
 315 #define HID_QUIRK_HIDINPUT_FORCE                0x00000080
 316 #define HID_QUIRK_NO_EMPTY_INPUT                0x00000100
 317 #define HID_QUIRK_NO_INIT_INPUT_REPORTS         0x00000200
 318 #define HID_QUIRK_ALWAYS_POLL                   0x00000400
 319 #define HID_QUIRK_SKIP_OUTPUT_REPORTS           0x00010000
 320 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID         0x00020000
 321 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP  0x00040000
 322 #define HID_QUIRK_FULLSPEED_INTERVAL            0x10000000
 323 #define HID_QUIRK_NO_INIT_REPORTS               0x20000000
 324 #define HID_QUIRK_NO_IGNORE                     0x40000000
 325 #define HID_QUIRK_NO_INPUT_SYNC                 0x80000000
 326
 327 /*
 328  * HID device groups
 329  *
 330  * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
 331  * and has a value of 0x0000
 332  */
 333 #define HID_GROUP_GENERIC                       0x0001
 334 #define HID_GROUP_MULTITOUCH                    0x0002
 335 #define HID_GROUP_SENSOR_HUB                    0x0003
 336 #define HID_GROUP_MULTITOUCH_WIN_8              0x0004
 337
 338 /*
 339  * Vendor specific HID device groups
 340  */
 341 #define HID_GROUP_RMI                           0x0100
 342
 343 /*
 344  * Vendor specific HID device groups
 345  */
 346 #define HID_GROUP_WACOM                         0x0101
 347
 348 /*
 349  * This is the global environment of the parser. This information is
 350  * persistent for main-items. The global environment can be saved and
 351  * restored with PUSH/POP statements.
 352  */
 353
 354 struct hid_global {
 355         unsigned usage_page;
 356         __s32    logical_minimum;
 357         __s32    logical_maximum;
 358         __s32    physical_minimum;
 359         __s32    physical_maximum;
 360         __s32    unit_exponent;
 361         unsigned unit;
 362         unsigned report_id;
 363         unsigned report_size;
 364         unsigned report_count;
 365 };
 366
 367 /*
 368  * This is the local environment. It is persistent up the next main-item.
 369  */
 370
 371 #define HID_MAX_USAGES                  12288
 372 #define HID_DEFAULT_NUM_COLLECTIONS     16
 373
 374 struct hid_local {
 375         unsigned usage[HID_MAX_USAGES]; /* usage array */
 376         unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
 377         unsigned usage_index;
 378         unsigned usage_minimum;
 379         unsigned delimiter_depth;
 380         unsigned delimiter_branch;
 381 };
 382
 383 /*
 384  * This is the collection stack. We climb up the stack to determine
 385  * application and function of each field.
 386  */
 387
 388 struct hid_collection {
 389         unsigned type;
 390         unsigned usage;
 391         unsigned level;
 392 };
 393
 394 struct hid_usage {
 395         unsigned  hid;                  /* hid usage code */
 396         unsigned  collection_index;     /* index into collection array */
 397         unsigned  usage_index;          /* index into usage array */
 398         /* hidinput data */
 399         __u16     code;                 /* input driver code */
 400         __u8      type;                 /* input driver type */
 401         __s8      hat_min;              /* hat switch fun */
 402         __s8      hat_max;              /* ditto */
 403         __s8      hat_dir;              /* ditto */
 404 };
 405
 406 struct hid_input;
 407
 408 struct hid_field {
 409         unsigned  physical;             /* physical usage for this field */
 410         unsigned  logical;              /* logical usage for this field */
 411         unsigned  application;          /* application usage for this field */
 412         struct hid_usage *usage;        /* usage table for this function */
 413         unsigned  maxusage;             /* maximum usage index */
 414         unsigned  flags;                /* main-item flags (i.e. volatile,array,constant) */
 415         unsigned  report_offset;        /* bit offset in the report */
 416         unsigned  report_size;          /* size of this field in the report */
 417         unsigned  report_count;         /* number of this field in the report */
 418         unsigned  report_type;          /* (input,output,feature) */
 419         __s32    *value;                /* last known value(s) */
 420         __s32     logical_minimum;
 421         __s32     logical_maximum;
 422         __s32     physical_minimum;
 423         __s32     physical_maximum;
 424         __s32     unit_exponent;
 425         unsigned  unit;
 426         struct hid_report *report;      /* associated report */
 427         unsigned index;                 /* index into report->field[] */
 428         /* hidinput data */
 429         struct hid_input *hidinput;     /* associated input structure */
 430         __u16 dpad;                     /* dpad input code */
 431 };
 432
 433 #define HID_MAX_FIELDS 256
 434
 435 struct hid_report {
 436         struct list_head list;
 437         unsigned id;                                    /* id of this report */
 438         unsigned type;                                  /* report type */
 439         struct hid_field *field[HID_MAX_FIELDS];        /* fields of the report */
 440         unsigned maxfield;                              /* maximum valid field index */
 441         unsigned size;                                  /* size of the report (bits) */
 442         struct hid_device *device;                      /* associated device */
 443 };
 444
 445 #define HID_MAX_IDS 256
 446
 447 struct hid_report_enum {
 448         unsigned numbered;
 449         struct list_head report_list;
 450         struct hid_report *report_id_hash[HID_MAX_IDS];
 451 };
 452
 453 #define HID_MIN_BUFFER_SIZE     64              /* make sure there is at least a packet size of space */
 454 #define HID_MAX_BUFFER_SIZE     4096            /* 4kb */
 455 #define HID_CONTROL_FIFO_SIZE   256             /* to init devices with >100 reports */
 456 #define HID_OUTPUT_FIFO_SIZE    64
 457
 458 struct hid_control_fifo {
 459         unsigned char dir;
 460         struct hid_report *report;
 461         char *raw_report;
 462 };
 463
 464 struct hid_output_fifo {
 465         struct hid_report *report;
 466         char *raw_report;
 467 };
 468
 469 #define HID_CLAIMED_INPUT       1
 470 #define HID_CLAIMED_HIDDEV      2
 471 #define HID_CLAIMED_HIDRAW      4
 472 #define HID_CLAIMED_DRIVER      8
 473
 474 #define HID_STAT_ADDED          1
 475 #define HID_STAT_PARSED         2
 476
 477 struct hid_input {
 478         struct list_head list;
 479         struct hid_report *report;
 480         struct input_dev *input;
 481 };
 482
 483 enum hid_type {
 484         HID_TYPE_OTHER = 0,
 485         HID_TYPE_USBMOUSE,
 486         HID_TYPE_USBNONE
 487 };
 488
 489 struct hid_driver;
 490 struct hid_ll_driver;
 491
 492 struct hid_device {                                                     /* device report descriptor */
 493         __u8 *dev_rdesc;
 494         unsigned dev_rsize;
 495         __u8 *rdesc;
 496         unsigned rsize;
 497         struct hid_collection *collection;                              /* List of HID collections */
 498         unsigned collection_size;                                       /* Number of allocated hid_collections */
 499         unsigned maxcollection;                                         /* Number of parsed collections */
 500         unsigned maxapplication;                                        /* Number of applications */
 501         __u16 bus;                                                      /* BUS ID */
 502         __u16 group;                                                    /* Report group */
 503         __u32 vendor;                                                   /* Vendor ID */
 504         __u32 product;                                                  /* Product ID */
 505         __u32 version;                                                  /* HID version */
 506         enum hid_type type;                                             /* device type (mouse, kbd, ...) */
 507         unsigned country;                                               /* HID country */
 508         struct hid_report_enum report_enum[HID_REPORT_TYPES];
 509         struct work_struct led_work;                                    /* delayed LED worker */
 510
 511         struct semaphore driver_lock;                                   /* protects the current driver, except during input */
 512         struct semaphore driver_input_lock;                             /* protects the current driver */
 513         struct device dev;                                              /* device */
 514         struct hid_driver *driver;
 515         struct hid_ll_driver *ll_driver;
 516
 517 #ifdef CONFIG_HID_BATTERY_STRENGTH
 518         /*
 519          * Power supply information for HID devices which report
 520          * battery strength. power_supply is registered iff
 521          * battery.name is non-NULL.
 522          */
 523         struct power_supply battery;
 524         __s32 battery_min;
 525         __s32 battery_max;
 526         __s32 battery_report_type;
 527         __s32 battery_report_id;
 528 #endif
 529
 530         unsigned int status;                                            /* see STAT flags above */
 531         unsigned claimed;                                               /* Claimed by hidinput, hiddev? */
 532         unsigned quirks;                                                /* Various quirks the device can pull on us */
 533         bool io_started;                                                /* Protected by driver_lock. If IO has started */
 534
 535         struct list_head inputs;                                        /* The list of inputs */
 536         void *hiddev;                                                   /* The hiddev structure */
 537         void *hidraw;
 538         int minor;                                                      /* Hiddev minor number */
 539
 540         int open;                                                       /* is the device open by anyone? */
 541         char name[128];                                                 /* Device name */
 542         char phys[64];                                                  /* Device physical location */
 543         char uniq[64];                                                  /* Device unique identifier (serial #) */
 544
 545         void *driver_data;
 546
 547         /* temporary hid_ff handling (until moved to the drivers) */
 548         int (*ff_init)(struct hid_device *);
 549
 550         /* hiddev event handler */
 551         int (*hiddev_connect)(struct hid_device *, unsigned int);
 552         void (*hiddev_disconnect)(struct hid_device *);
 553         void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
 554                                   struct hid_usage *, __s32);
 555         void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
 556
 557         /* debugging support via debugfs */
 558         unsigned short debug;
 559         struct dentry *debug_dir;
 560         struct dentry *debug_rdesc;
 561         struct dentry *debug_events;
 562         struct list_head debug_list;
 563         spinlock_t  debug_list_lock;
 564         wait_queue_head_t debug_wait;
 565 };
 566
 567 static inline void *hid_get_drvdata(struct hid_device *hdev)
 568 {
 569         return dev_get_drvdata(&hdev->dev);
 570 }
 571
 572 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
 573 {
 574         dev_set_drvdata(&hdev->dev, data);
 575 }
 576
 577 #define HID_GLOBAL_STACK_SIZE 4
 578 #define HID_COLLECTION_STACK_SIZE 4
 579
 580 #define HID_SCAN_FLAG_MT_WIN_8                  0x00000001
 581
 582 struct hid_parser {
 583         struct hid_global     global;
 584         struct hid_global     global_stack[HID_GLOBAL_STACK_SIZE];
 585         unsigned              global_stack_ptr;
 586         struct hid_local      local;
 587         unsigned              collection_stack[HID_COLLECTION_STACK_SIZE];
 588         unsigned              collection_stack_ptr;
 589         struct hid_device    *device;
 590         unsigned              scan_flags;
 591 };
 592
 593 struct hid_class_descriptor {
 594         __u8  bDescriptorType;
 595         __le16 wDescriptorLength;
 596 } __attribute__ ((packed));
 597
 598 struct hid_descriptor {
 599         __u8  bLength;
 600         __u8  bDescriptorType;
 601         __le16 bcdHID;
 602         __u8  bCountryCode;
 603         __u8  bNumDescriptors;
 604
 605         struct hid_class_descriptor desc[1];
 606 } __attribute__ ((packed));
 607
 608 #define HID_DEVICE(b, g, ven, prod)                                     \
 609         .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
 610 #define HID_USB_DEVICE(ven, prod)                               \
 611         .bus = BUS_USB, .vendor = (ven), .product = (prod)
 612 #define HID_BLUETOOTH_DEVICE(ven, prod)                                 \
 613         .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
 614 #define HID_I2C_DEVICE(ven, prod)                               \
 615         .bus = BUS_I2C, .vendor = (ven), .product = (prod)
 616
 617 #define HID_REPORT_ID(rep) \
 618         .report_type = (rep)
 619 #define HID_USAGE_ID(uhid, utype, ucode) \
 620         .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
 621 /* we don't want to catch types and codes equal to 0 */
 622 #define HID_TERMINATOR          (HID_ANY_ID - 1)
 623
 624 struct hid_report_id {
 625         __u32 report_type;
 626 };
 627 struct hid_usage_id {
 628         __u32 usage_hid;
 629         __u32 usage_type;
 630         __u32 usage_code;
 631 };
 632
 633 /**
 634  * struct hid_driver
 635  * @name: driver name (e.g. "Footech_bar-wheel")
 636  * @id_table: which devices is this driver for (must be non-NULL for probe
 637  *            to be called)
 638  * @dyn_list: list of dynamically added device ids
 639  * @dyn_lock: lock protecting @dyn_list
 640  * @probe: new device inserted
 641  * @remove: device removed (NULL if not a hot-plug capable driver)
 642  * @report_table: on which reports to call raw_event (NULL means all)
 643  * @raw_event: if report in report_table, this hook is called (NULL means nop)
 644  * @usage_table: on which events to call event (NULL means all)
 645  * @event: if usage in usage_table, this hook is called (NULL means nop)
 646  * @report: this hook is called after parsing a report (NULL means nop)
 647  * @report_fixup: called before report descriptor parsing (NULL means nop)
 648  * @input_mapping: invoked on input registering before mapping an usage
 649  * @input_mapped: invoked on input registering after mapping an usage
 650  * @input_configured: invoked just before the device is registered
 651  * @feature_mapping: invoked on feature registering
 652  * @suspend: invoked on suspend (NULL means nop)
 653  * @resume: invoked on resume if device was not reset (NULL means nop)
 654  * @reset_resume: invoked on resume if device was reset (NULL means nop)
 655  *
 656  * probe should return -errno on error, or 0 on success. During probe,
 657  * input will not be passed to raw_event unless hid_device_io_start is
 658  * called.
 659  *
 660  * raw_event and event should return 0 on no action performed, 1 when no
 661  * further processing should be done and negative on error
 662  *
 663  * input_mapping shall return a negative value to completely ignore this usage
 664  * (e.g. doubled or invalid usage), zero to continue with parsing of this
 665  * usage by generic code (no special handling needed) or positive to skip
 666  * generic parsing (needed special handling which was done in the hook already)
 667  * input_mapped shall return negative to inform the layer that this usage
 668  * should not be considered for further processing or zero to notify that
 669  * no processing was performed and should be done in a generic manner
 670  * Both these functions may be NULL which means the same behavior as returning
 671  * zero from them.
 672  */
 673 struct hid_driver {
 674         char *name;
 675         const struct hid_device_id *id_table;
 676
 677         struct list_head dyn_list;
 678         spinlock_t dyn_lock;
 679
 680         int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
 681         void (*remove)(struct hid_device *dev);
 682
 683         const struct hid_report_id *report_table;
 684         int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
 685                         u8 *data, int size);
 686         const struct hid_usage_id *usage_table;
 687         int (*event)(struct hid_device *hdev, struct hid_field *field,
 688                         struct hid_usage *usage, __s32 value);
 689         void (*report)(struct hid_device *hdev, struct hid_report *report);
 690
 691         __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
 692                         unsigned int *size);
 693
 694         int (*input_mapping)(struct hid_device *hdev,
 695                         struct hid_input *hidinput, struct hid_field *field,
 696                         struct hid_usage *usage, unsigned long **bit, int *max);
 697         int (*input_mapped)(struct hid_device *hdev,
 698                         struct hid_input *hidinput, struct hid_field *field,
 699                         struct hid_usage *usage, unsigned long **bit, int *max);
 700         void (*input_configured)(struct hid_device *hdev,
 701                                  struct hid_input *hidinput);
 702         void (*feature_mapping)(struct hid_device *hdev,
 703                         struct hid_field *field,
 704                         struct hid_usage *usage);
 705 #ifdef CONFIG_PM
 706         int (*suspend)(struct hid_device *hdev, pm_message_t message);
 707         int (*resume)(struct hid_device *hdev);
 708         int (*reset_resume)(struct hid_device *hdev);
 709 #endif
 710 /* private: */
 711         struct device_driver driver;
 712 };
 713
 714 /**
 715  * hid_ll_driver - low level driver callbacks
 716  * @start: called on probe to start the device
 717  * @stop: called on remove
 718  * @open: called by input layer on open
 719  * @close: called by input layer on close
 720  * @parse: this method is called only once to parse the device data,
 721  *         shouldn't allocate anything to not leak memory
 722  * @request: send report request to device (e.g. feature report)
 723  * @wait: wait for buffered io to complete (send/recv reports)
 724  * @raw_request: send raw report request to device (e.g. feature report)
 725  * @output_report: send output report to device
 726  * @idle: send idle request to device
 727  */
 728 struct hid_ll_driver {
 729         int (*start)(struct hid_device *hdev);
 730         void (*stop)(struct hid_device *hdev);
 731
 732         int (*open)(struct hid_device *hdev);
 733         void (*close)(struct hid_device *hdev);
 734
 735         int (*power)(struct hid_device *hdev, int level);
 736
 737         int (*parse)(struct hid_device *hdev);
 738
 739         void (*request)(struct hid_device *hdev,
 740                         struct hid_report *report, int reqtype);
 741
 742         int (*wait)(struct hid_device *hdev);
 743
 744         int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
 745                             __u8 *buf, size_t len, unsigned char rtype,
 746                             int reqtype);
 747
 748         int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
 749
 750         int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
 751 };
 752
 753 #define PM_HINT_FULLON  1<<5
 754 #define PM_HINT_NORMAL  1<<1
 755
 756 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
 757 /* We ignore a few input applications that are not widely used */
 758 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
 759
 760 /* HID core API */
 761
 762 extern int hid_debug;
 763
 764 extern bool hid_ignore(struct hid_device *);
 765 extern int hid_add_device(struct hid_device *);
 766 extern void hid_destroy_device(struct hid_device *);
 767
 768 extern int __must_check __hid_register_driver(struct hid_driver *,
 769                 struct module *, const char *mod_name);
 770
 771 /* use a define to avoid include chaining to get THIS_MODULE & friends */
 772 #define hid_register_driver(driver) \
 773         __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
 774
 775 extern void hid_unregister_driver(struct hid_driver *);
 776
 777 /**
 778  * module_hid_driver() - Helper macro for registering a HID driver
 779  * @__hid_driver: hid_driver struct
 780  *
 781  * Helper macro for HID drivers which do not do anything special in module
 782  * init/exit. This eliminates a lot of boilerplate. Each module may only
 783  * use this macro once, and calling it replaces module_init() and module_exit()
 784  */
 785 #define module_hid_driver(__hid_driver) \
 786         module_driver(__hid_driver, hid_register_driver, \
 787                       hid_unregister_driver)
 788
 789 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
 790 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
 791 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
 792 extern void hidinput_disconnect(struct hid_device *);
 793
 794 int hid_set_field(struct hid_field *, unsigned, __s32);
 795 int hid_input_report(struct hid_device *, int type, u8 *, int, int);
 796 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
 797 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
 798 unsigned int hidinput_count_leds(struct hid_device *hid);
 799 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
 800 void hid_output_report(struct hid_report *report, __u8 *data);
 801 void __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
 802 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
 803 struct hid_device *hid_allocate_device(void);
 804 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id);
 805 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
 806 struct hid_report *hid_validate_values(struct hid_device *hid,
 807                                        unsigned int type, unsigned int id,
 808                                        unsigned int field_index,
 809                                        unsigned int report_counts);
 810 int hid_open_report(struct hid_device *device);
 811 int hid_check_keys_pressed(struct hid_device *hid);
 812 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
 813 void hid_disconnect(struct hid_device *hid);
 814 const struct hid_device_id *hid_match_id(struct hid_device *hdev,
 815                                          const struct hid_device_id *id);
 816 s32 hid_snto32(__u32 value, unsigned n);
 817
 818 /**
 819  * hid_device_io_start - enable HID input during probe, remove
 820  *
 821  * @hid - the device
 822  *
 823  * This should only be called during probe or remove and only be
 824  * called by the thread calling probe or remove. It will allow
 825  * incoming packets to be delivered to the driver.
 826  */
 827 static inline void hid_device_io_start(struct hid_device *hid) {
 828         if (hid->io_started) {
 829                 dev_warn(&hid->dev, "io already started");
 830                 return;
 831         }
 832         hid->io_started = true;
 833         up(&hid->driver_input_lock);
 834 }
 835
 836 /**
 837  * hid_device_io_stop - disable HID input during probe, remove
 838  *
 839  * @hid - the device
 840  *
 841  * Should only be called after hid_device_io_start. It will prevent
 842  * incoming packets from going to the driver for the duration of
 843  * probe, remove. If called during probe, packets will still go to the
 844  * driver after probe is complete. This function should only be called
 845  * by the thread calling probe or remove.
 846  */
 847 static inline void hid_device_io_stop(struct hid_device *hid) {
 848         if (!hid->io_started) {
 849                 dev_warn(&hid->dev, "io already stopped");
 850                 return;
 851         }
 852         hid->io_started = false;
 853         down(&hid->driver_input_lock);
 854 }
 855
 856 /**
 857  * hid_map_usage - map usage input bits
 858  *
 859  * @hidinput: hidinput which we are interested in
 860  * @usage: usage to fill in
 861  * @bit: pointer to input->{}bit (out parameter)
 862  * @max: maximal valid usage->code to consider later (out parameter)
 863  * @type: input event type (EV_KEY, EV_REL, ...)
 864  * @c: code which corresponds to this usage and type
 865  */
 866 static inline void hid_map_usage(struct hid_input *hidinput,
 867                 struct hid_usage *usage, unsigned long **bit, int *max,
 868                 __u8 type, __u16 c)
 869 {
 870         struct input_dev *input = hidinput->input;
 871
 872         usage->type = type;
 873         usage->code = c;
 874
 875         switch (type) {
 876         case EV_ABS:
 877                 *bit = input->absbit;
 878                 *max = ABS_MAX;
 879                 break;
 880         case EV_REL:
 881                 *bit = input->relbit;
 882                 *max = REL_MAX;
 883                 break;
 884         case EV_KEY:
 885                 *bit = input->keybit;
 886                 *max = KEY_MAX;
 887                 break;
 888         case EV_LED:
 889                 *bit = input->ledbit;
 890                 *max = LED_MAX;
 891                 break;
 892         }
 893 }
 894
 895 /**
 896  * hid_map_usage_clear - map usage input bits and clear the input bit
 897  *
 898  * The same as hid_map_usage, except the @c bit is also cleared in supported
 899  * bits (@bit).
 900  */
 901 static inline void hid_map_usage_clear(struct hid_input *hidinput,
 902                 struct hid_usage *usage, unsigned long **bit, int *max,
 903                 __u8 type, __u16 c)
 904 {
 905         hid_map_usage(hidinput, usage, bit, max, type, c);
 906         clear_bit(c, *bit);
 907 }
 908
 909 /**
 910  * hid_parse - parse HW reports
 911  *
 912  * @hdev: hid device
 913  *
 914  * Call this from probe after you set up the device (if needed). Your
 915  * report_fixup will be called (if non-NULL) after reading raw report from
 916  * device before passing it to hid layer for real parsing.
 917  */
 918 static inline int __must_check hid_parse(struct hid_device *hdev)
 919 {
 920         return hid_open_report(hdev);
 921 }
 922
 923 /**
 924  * hid_hw_start - start underlaying HW
 925  *
 926  * @hdev: hid device
 927  * @connect_mask: which outputs to connect, see HID_CONNECT_*
 928  *
 929  * Call this in probe function *after* hid_parse. This will setup HW buffers
 930  * and start the device (if not deffered to device open). hid_hw_stop must be
 931  * called if this was successful.
 932  */
 933 static inline int __must_check hid_hw_start(struct hid_device *hdev,
 934                 unsigned int connect_mask)
 935 {
 936         int ret = hdev->ll_driver->start(hdev);
 937         if (ret || !connect_mask)
 938                 return ret;
 939         ret = hid_connect(hdev, connect_mask);
 940         if (ret)
 941                 hdev->ll_driver->stop(hdev);
 942         return ret;
 943 }
 944
 945 /**
 946  * hid_hw_stop - stop underlaying HW
 947  *
 948  * @hdev: hid device
 949  *
 950  * This is usually called from remove function or from probe when something
 951  * failed and hid_hw_start was called already.
 952  */
 953 static inline void hid_hw_stop(struct hid_device *hdev)
 954 {
 955         hid_disconnect(hdev);
 956         hdev->ll_driver->stop(hdev);
 957 }
 958
 959 /**
 960  * hid_hw_open - signal underlaying HW to start delivering events
 961  *
 962  * @hdev: hid device
 963  *
 964  * Tell underlying HW to start delivering events from the device.
 965  * This function should be called sometime after successful call
 966  * to hid_hiw_start().
 967  */
 968 static inline int __must_check hid_hw_open(struct hid_device *hdev)
 969 {
 970         return hdev->ll_driver->open(hdev);
 971 }
 972
 973 /**
 974  * hid_hw_close - signal underlaying HW to stop delivering events
 975  *
 976  * @hdev: hid device
 977  *
 978  * This function indicates that we are not interested in the events
 979  * from this device anymore. Delivery of events may or may not stop,
 980  * depending on the number of users still outstanding.
 981  */
 982 static inline void hid_hw_close(struct hid_device *hdev)
 983 {
 984         hdev->ll_driver->close(hdev);
 985 }
 986
 987 /**
 988  * hid_hw_power - requests underlying HW to go into given power mode
 989  *
 990  * @hdev: hid device
 991  * @level: requested power level (one of %PM_HINT_* defines)
 992  *
 993  * This function requests underlying hardware to enter requested power
 994  * mode.
 995  */
 996
 997 static inline int hid_hw_power(struct hid_device *hdev, int level)
 998 {
 999         return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
1000 }
1001
1002
1003 /**
1004  * hid_hw_request - send report request to device
1005  *
1006  * @hdev: hid device
1007  * @report: report to send
1008  * @reqtype: hid request type
1009  */
1010 static inline void hid_hw_request(struct hid_device *hdev,
1011                                   struct hid_report *report, int reqtype)
1012 {
1013         if (hdev->ll_driver->request)
1014                 return hdev->ll_driver->request(hdev, report, reqtype);
1015
1016         __hid_request(hdev, report, reqtype);
1017 }
1018
1019 /**
1020  * hid_hw_raw_request - send report request to device
1021  *
1022  * @hdev: hid device
1023  * @reportnum: report ID
1024  * @buf: in/out data to transfer
1025  * @len: length of buf
1026  * @rtype: HID report type
1027  * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
1028  *
1029  * @return: count of data transfered, negative if error
1030  *
1031  * Same behavior as hid_hw_request, but with raw buffers instead.
1032  */
1033 static inline int hid_hw_raw_request(struct hid_device *hdev,
1034                                   unsigned char reportnum, __u8 *buf,
1035                                   size_t len, unsigned char rtype, int reqtype)
1036 {
1037         if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1038                 return -EINVAL;
1039
1040         return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1041                                                     rtype, reqtype);
1042 }
1043
1044 /**
1045  * hid_hw_output_report - send output report to device
1046  *
1047  * @hdev: hid device
1048  * @buf: raw data to transfer
1049  * @len: length of buf
1050  *
1051  * @return: count of data transfered, negative if error
1052  */
1053 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1054                                         size_t len)
1055 {
1056         if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1057                 return -EINVAL;
1058
1059         if (hdev->ll_driver->output_report)
1060                 return hdev->ll_driver->output_report(hdev, buf, len);
1061
1062         return -ENOSYS;
1063 }
1064
1065 /**
1066  * hid_hw_idle - send idle request to device
1067  *
1068  * @hdev: hid device
1069  * @report: report to control
1070  * @idle: idle state
1071  * @reqtype: hid request type
1072  */
1073 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1074                 int reqtype)
1075 {
1076         if (hdev->ll_driver->idle)
1077                 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1078
1079         return 0;
1080 }
1081
1082 /**
1083  * hid_hw_wait - wait for buffered io to complete
1084  *
1085  * @hdev: hid device
1086  */
1087 static inline void hid_hw_wait(struct hid_device *hdev)
1088 {
1089         if (hdev->ll_driver->wait)
1090                 hdev->ll_driver->wait(hdev);
1091 }
1092
1093 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
1094                 int interrupt);
1095
1096 /* HID quirks API */
1097 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
1098 int usbhid_quirks_init(char **quirks_param);
1099 void usbhid_quirks_exit(void);
1100
1101 #ifdef CONFIG_HID_PID
1102 int hid_pidff_init(struct hid_device *hid);
1103 #else
1104 #define hid_pidff_init NULL
1105 #endif
1106
1107 #define dbg_hid(format, arg...)                                         \
1108 do {                                                                    \
1109         if (hid_debug)                                                  \
1110                 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg);      \
1111 } while (0)
1112
1113 #define hid_printk(level, hid, fmt, arg...)             \
1114         dev_printk(level, &(hid)->dev, fmt, ##arg)
1115 #define hid_emerg(hid, fmt, arg...)                     \
1116         dev_emerg(&(hid)->dev, fmt, ##arg)
1117 #define hid_crit(hid, fmt, arg...)                      \
1118         dev_crit(&(hid)->dev, fmt, ##arg)
1119 #define hid_alert(hid, fmt, arg...)                     \
1120         dev_alert(&(hid)->dev, fmt, ##arg)
1121 #define hid_err(hid, fmt, arg...)                       \
1122         dev_err(&(hid)->dev, fmt, ##arg)
1123 #define hid_notice(hid, fmt, arg...)                    \
1124         dev_notice(&(hid)->dev, fmt, ##arg)
1125 #define hid_warn(hid, fmt, arg...)                      \
1126         dev_warn(&(hid)->dev, fmt, ##arg)
1127 #define hid_info(hid, fmt, arg...)                      \
1128         dev_info(&(hid)->dev, fmt, ##arg)
1129 #define hid_dbg(hid, fmt, arg...)                       \
1130         dev_dbg(&(hid)->dev, fmt, ##arg)
1131
1132 #endif