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