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