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