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