include/linux/hid.h

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