include/linux/hid.h

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