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