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_DEFAULT     (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
 269                 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
 270
 271 /*
 272  * HID device quirks.
 273  */
 274
 275 /*
 276  * Increase this if you need to configure more HID quirks at module load time
 277  */
 278 #define MAX_USBHID_BOOT_QUIRKS 4
 279
 280 #define HID_QUIRK_INVERT                        0x00000001
 281 #define HID_QUIRK_NOTOUCH                       0x00000002
 282 #define HID_QUIRK_IGNORE                        0x00000004
 283 #define HID_QUIRK_NOGET                         0x00000008
 284 #define HID_QUIRK_HIDDEV_FORCE                  0x00000010
 285 #define HID_QUIRK_BADPAD                        0x00000020
 286 #define HID_QUIRK_MULTI_INPUT                   0x00000040
 287 #define HID_QUIRK_HIDINPUT_FORCE                0x00000080
 288 #define HID_QUIRK_NO_EMPTY_INPUT                0x00000100
 289 #define HID_QUIRK_NO_INIT_INPUT_REPORTS         0x00000200
 290 #define HID_QUIRK_SKIP_OUTPUT_REPORTS           0x00010000
 291 #define HID_QUIRK_SKIP_OUTPUT_REPORT_ID         0x00020000
 292 #define HID_QUIRK_NO_OUTPUT_REPORTS_ON_INTR_EP  0x00040000
 293 #define HID_QUIRK_FULLSPEED_INTERVAL            0x10000000
 294 #define HID_QUIRK_NO_INIT_REPORTS               0x20000000
 295 #define HID_QUIRK_NO_IGNORE                     0x40000000
 296 #define HID_QUIRK_NO_INPUT_SYNC                 0x80000000
 297
 298 /*
 299  * HID device groups
 300  *
 301  * Note: HID_GROUP_ANY is declared in linux/mod_devicetable.h
 302  * and has a value of 0x0000
 303  */
 304 #define HID_GROUP_GENERIC                       0x0001
 305 #define HID_GROUP_MULTITOUCH                    0x0002
 306 #define HID_GROUP_SENSOR_HUB                    0x0003
 307 #define HID_GROUP_MULTITOUCH_WIN_8              0x0004
 308
 309 /*
 310  * Vendor specific HID device groups
 311  */
 312 #define HID_GROUP_RMI                           0x0100
 313
 314 /*
 315  * Vendor specific HID device groups
 316  */
 317 #define HID_GROUP_WACOM                         0x0101
 318
 319 /*
 320  * This is the global environment of the parser. This information is
 321  * persistent for main-items. The global environment can be saved and
 322  * restored with PUSH/POP statements.
 323  */
 324
 325 struct hid_global {
 326         unsigned usage_page;
 327         __s32    logical_minimum;
 328         __s32    logical_maximum;
 329         __s32    physical_minimum;
 330         __s32    physical_maximum;
 331         __s32    unit_exponent;
 332         unsigned unit;
 333         unsigned report_id;
 334         unsigned report_size;
 335         unsigned report_count;
 336 };
 337
 338 /*
 339  * This is the local environment. It is persistent up the next main-item.
 340  */
 341
 342 #define HID_MAX_USAGES                  12288
 343 #define HID_DEFAULT_NUM_COLLECTIONS     16
 344
 345 struct hid_local {
 346         unsigned usage[HID_MAX_USAGES]; /* usage array */
 347         unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
 348         unsigned usage_index;
 349         unsigned usage_minimum;
 350         unsigned delimiter_depth;
 351         unsigned delimiter_branch;
 352 };
 353
 354 /*
 355  * This is the collection stack. We climb up the stack to determine
 356  * application and function of each field.
 357  */
 358
 359 struct hid_collection {
 360         unsigned type;
 361         unsigned usage;
 362         unsigned level;
 363 };
 364
 365 struct hid_usage {
 366         unsigned  hid;                  /* hid usage code */
 367         unsigned  collection_index;     /* index into collection array */
 368         unsigned  usage_index;          /* index into usage array */
 369         /* hidinput data */
 370         __u16     code;                 /* input driver code */
 371         __u8      type;                 /* input driver type */
 372         __s8      hat_min;              /* hat switch fun */
 373         __s8      hat_max;              /* ditto */
 374         __s8      hat_dir;              /* ditto */
 375 };
 376
 377 struct hid_input;
 378
 379 struct hid_field {
 380         unsigned  physical;             /* physical usage for this field */
 381         unsigned  logical;              /* logical usage for this field */
 382         unsigned  application;          /* application usage for this field */
 383         struct hid_usage *usage;        /* usage table for this function */
 384         unsigned  maxusage;             /* maximum usage index */
 385         unsigned  flags;                /* main-item flags (i.e. volatile,array,constant) */
 386         unsigned  report_offset;        /* bit offset in the report */
 387         unsigned  report_size;          /* size of this field in the report */
 388         unsigned  report_count;         /* number of this field in the report */
 389         unsigned  report_type;          /* (input,output,feature) */
 390         __s32    *value;                /* last known value(s) */
 391         __s32     logical_minimum;
 392         __s32     logical_maximum;
 393         __s32     physical_minimum;
 394         __s32     physical_maximum;
 395         __s32     unit_exponent;
 396         unsigned  unit;
 397         struct hid_report *report;      /* associated report */
 398         unsigned index;                 /* index into report->field[] */
 399         /* hidinput data */
 400         struct hid_input *hidinput;     /* associated input structure */
 401         __u16 dpad;                     /* dpad input code */
 402 };
 403
 404 #define HID_MAX_FIELDS 256
 405
 406 struct hid_report {
 407         struct list_head list;
 408         unsigned id;                                    /* id of this report */
 409         unsigned type;                                  /* report type */
 410         struct hid_field *field[HID_MAX_FIELDS];        /* fields of the report */
 411         unsigned maxfield;                              /* maximum valid field index */
 412         unsigned size;                                  /* size of the report (bits) */
 413         struct hid_device *device;                      /* associated device */
 414 };
 415
 416 #define HID_MAX_IDS 256
 417
 418 struct hid_report_enum {
 419         unsigned numbered;
 420         struct list_head report_list;
 421         struct hid_report *report_id_hash[HID_MAX_IDS];
 422 };
 423
 424 #define HID_MIN_BUFFER_SIZE     64              /* make sure there is at least a packet size of space */
 425 #define HID_MAX_BUFFER_SIZE     4096            /* 4kb */
 426 #define HID_CONTROL_FIFO_SIZE   256             /* to init devices with >100 reports */
 427 #define HID_OUTPUT_FIFO_SIZE    64
 428
 429 struct hid_control_fifo {
 430         unsigned char dir;
 431         struct hid_report *report;
 432         char *raw_report;
 433 };
 434
 435 struct hid_output_fifo {
 436         struct hid_report *report;
 437         char *raw_report;
 438 };
 439
 440 #define HID_CLAIMED_INPUT       1
 441 #define HID_CLAIMED_HIDDEV      2
 442 #define HID_CLAIMED_HIDRAW      4
 443
 444 #define HID_STAT_ADDED          1
 445 #define HID_STAT_PARSED         2
 446
 447 struct hid_input {
 448         struct list_head list;
 449         struct hid_report *report;
 450         struct input_dev *input;
 451 };
 452
 453 enum hid_type {
 454         HID_TYPE_OTHER = 0,
 455         HID_TYPE_USBMOUSE,
 456         HID_TYPE_USBNONE
 457 };
 458
 459 struct hid_driver;
 460 struct hid_ll_driver;
 461
 462 struct hid_device {                                                     /* device report descriptor */
 463         __u8 *dev_rdesc;
 464         unsigned dev_rsize;
 465         __u8 *rdesc;
 466         unsigned rsize;
 467         struct hid_collection *collection;                              /* List of HID collections */
 468         unsigned collection_size;                                       /* Number of allocated hid_collections */
 469         unsigned maxcollection;                                         /* Number of parsed collections */
 470         unsigned maxapplication;                                        /* Number of applications */
 471         __u16 bus;                                                      /* BUS ID */
 472         __u16 group;                                                    /* Report group */
 473         __u32 vendor;                                                   /* Vendor ID */
 474         __u32 product;                                                  /* Product ID */
 475         __u32 version;                                                  /* HID version */
 476         enum hid_type type;                                             /* device type (mouse, kbd, ...) */
 477         unsigned country;                                               /* HID country */
 478         struct hid_report_enum report_enum[HID_REPORT_TYPES];
 479         struct work_struct led_work;                                    /* delayed LED worker */
 480
 481         struct semaphore driver_lock;                                   /* protects the current driver, except during input */
 482         struct semaphore driver_input_lock;                             /* protects the current driver */
 483         struct device dev;                                              /* device */
 484         struct hid_driver *driver;
 485         struct hid_ll_driver *ll_driver;
 486
 487 #ifdef CONFIG_HID_BATTERY_STRENGTH
 488         /*
 489          * Power supply information for HID devices which report
 490          * battery strength. power_supply is registered iff
 491          * battery.name is non-NULL.
 492          */
 493         struct power_supply battery;
 494         __s32 battery_min;
 495         __s32 battery_max;
 496         __s32 battery_report_type;
 497         __s32 battery_report_id;
 498 #endif
 499
 500         unsigned int status;                                            /* see STAT flags above */
 501         unsigned claimed;                                               /* Claimed by hidinput, hiddev? */
 502         unsigned quirks;                                                /* Various quirks the device can pull on us */
 503         bool io_started;                                                /* Protected by driver_lock. If IO has started */
 504
 505         struct list_head inputs;                                        /* The list of inputs */
 506         void *hiddev;                                                   /* The hiddev structure */
 507         void *hidraw;
 508         int minor;                                                      /* Hiddev minor number */
 509
 510         int open;                                                       /* is the device open by anyone? */
 511         char name[128];                                                 /* Device name */
 512         char phys[64];                                                  /* Device physical location */
 513         char uniq[64];                                                  /* Device unique identifier (serial #) */
 514
 515         void *driver_data;
 516
 517         /* temporary hid_ff handling (until moved to the drivers) */
 518         int (*ff_init)(struct hid_device *);
 519
 520         /* hiddev event handler */
 521         int (*hiddev_connect)(struct hid_device *, unsigned int);
 522         void (*hiddev_disconnect)(struct hid_device *);
 523         void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
 524                                   struct hid_usage *, __s32);
 525         void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
 526
 527         /* debugging support via debugfs */
 528         unsigned short debug;
 529         struct dentry *debug_dir;
 530         struct dentry *debug_rdesc;
 531         struct dentry *debug_events;
 532         struct list_head debug_list;
 533         spinlock_t  debug_list_lock;
 534         wait_queue_head_t debug_wait;
 535 };
 536
 537 static inline void *hid_get_drvdata(struct hid_device *hdev)
 538 {
 539         return dev_get_drvdata(&hdev->dev);
 540 }
 541
 542 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
 543 {
 544         dev_set_drvdata(&hdev->dev, data);
 545 }
 546
 547 #define HID_GLOBAL_STACK_SIZE 4
 548 #define HID_COLLECTION_STACK_SIZE 4
 549
 550 #define HID_SCAN_FLAG_MT_WIN_8                  0x00000001
 551
 552 struct hid_parser {
 553         struct hid_global     global;
 554         struct hid_global     global_stack[HID_GLOBAL_STACK_SIZE];
 555         unsigned              global_stack_ptr;
 556         struct hid_local      local;
 557         unsigned              collection_stack[HID_COLLECTION_STACK_SIZE];
 558         unsigned              collection_stack_ptr;
 559         struct hid_device    *device;
 560         unsigned              scan_flags;
 561 };
 562
 563 struct hid_class_descriptor {
 564         __u8  bDescriptorType;
 565         __le16 wDescriptorLength;
 566 } __attribute__ ((packed));
 567
 568 struct hid_descriptor {
 569         __u8  bLength;
 570         __u8  bDescriptorType;
 571         __le16 bcdHID;
 572         __u8  bCountryCode;
 573         __u8  bNumDescriptors;
 574
 575         struct hid_class_descriptor desc[1];
 576 } __attribute__ ((packed));
 577
 578 #define HID_DEVICE(b, g, ven, prod)                                     \
 579         .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
 580 #define HID_USB_DEVICE(ven, prod)                               \
 581         .bus = BUS_USB, .vendor = (ven), .product = (prod)
 582 #define HID_BLUETOOTH_DEVICE(ven, prod)                                 \
 583         .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (prod)
 584 #define HID_I2C_DEVICE(ven, prod)                               \
 585         .bus = BUS_I2C, .vendor = (ven), .product = (prod)
 586
 587 #define HID_REPORT_ID(rep) \
 588         .report_type = (rep)
 589 #define HID_USAGE_ID(uhid, utype, ucode) \
 590         .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
 591 /* we don't want to catch types and codes equal to 0 */
 592 #define HID_TERMINATOR          (HID_ANY_ID - 1)
 593
 594 struct hid_report_id {
 595         __u32 report_type;
 596 };
 597 struct hid_usage_id {
 598         __u32 usage_hid;
 599         __u32 usage_type;
 600         __u32 usage_code;
 601 };
 602
 603 /**
 604  * struct hid_driver
 605  * @name: driver name (e.g. "Footech_bar-wheel")
 606  * @id_table: which devices is this driver for (must be non-NULL for probe
 607  *            to be called)
 608  * @dyn_list: list of dynamically added device ids
 609  * @dyn_lock: lock protecting @dyn_list
 610  * @probe: new device inserted
 611  * @remove: device removed (NULL if not a hot-plug capable driver)
 612  * @report_table: on which reports to call raw_event (NULL means all)
 613  * @raw_event: if report in report_table, this hook is called (NULL means nop)
 614  * @usage_table: on which events to call event (NULL means all)
 615  * @event: if usage in usage_table, this hook is called (NULL means nop)
 616  * @report: this hook is called after parsing a report (NULL means nop)
 617  * @report_fixup: called before report descriptor parsing (NULL means nop)
 618  * @input_mapping: invoked on input registering before mapping an usage
 619  * @input_mapped: invoked on input registering after mapping an usage
 620  * @input_configured: invoked just before the device is registered
 621  * @feature_mapping: invoked on feature registering
 622  * @suspend: invoked on suspend (NULL means nop)
 623  * @resume: invoked on resume if device was not reset (NULL means nop)
 624  * @reset_resume: invoked on resume if device was reset (NULL means nop)
 625  *
 626  * probe should return -errno on error, or 0 on success. During probe,
 627  * input will not be passed to raw_event unless hid_device_io_start is
 628  * called.
 629  *
 630  * raw_event and event should return 0 on no action performed, 1 when no
 631  * further processing should be done and negative on error
 632  *
 633  * input_mapping shall return a negative value to completely ignore this usage
 634  * (e.g. doubled or invalid usage), zero to continue with parsing of this
 635  * usage by generic code (no special handling needed) or positive to skip
 636  * generic parsing (needed special handling which was done in the hook already)
 637  * input_mapped shall return negative to inform the layer that this usage
 638  * should not be considered for further processing or zero to notify that
 639  * no processing was performed and should be done in a generic manner
 640  * Both these functions may be NULL which means the same behavior as returning
 641  * zero from them.
 642  */
 643 struct hid_driver {
 644         char *name;
 645         const struct hid_device_id *id_table;
 646
 647         struct list_head dyn_list;
 648         spinlock_t dyn_lock;
 649
 650         int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
 651         void (*remove)(struct hid_device *dev);
 652
 653         const struct hid_report_id *report_table;
 654         int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
 655                         u8 *data, int size);
 656         const struct hid_usage_id *usage_table;
 657         int (*event)(struct hid_device *hdev, struct hid_field *field,
 658                         struct hid_usage *usage, __s32 value);
 659         void (*report)(struct hid_device *hdev, struct hid_report *report);
 660
 661         __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
 662                         unsigned int *size);
 663
 664         int (*input_mapping)(struct hid_device *hdev,
 665                         struct hid_input *hidinput, struct hid_field *field,
 666                         struct hid_usage *usage, unsigned long **bit, int *max);
 667         int (*input_mapped)(struct hid_device *hdev,
 668                         struct hid_input *hidinput, struct hid_field *field,
 669                         struct hid_usage *usage, unsigned long **bit, int *max);
 670         void (*input_configured)(struct hid_device *hdev,
 671                                  struct hid_input *hidinput);
 672         void (*feature_mapping)(struct hid_device *hdev,
 673                         struct hid_field *field,
 674                         struct hid_usage *usage);
 675 #ifdef CONFIG_PM
 676         int (*suspend)(struct hid_device *hdev, pm_message_t message);
 677         int (*resume)(struct hid_device *hdev);
 678         int (*reset_resume)(struct hid_device *hdev);
 679 #endif
 680 /* private: */
 681         struct device_driver driver;
 682 };
 683
 684 /**
 685  * hid_ll_driver - low level driver callbacks
 686  * @start: called on probe to start the device
 687  * @stop: called on remove
 688  * @open: called by input layer on open
 689  * @close: called by input layer on close
 690  * @parse: this method is called only once to parse the device data,
 691  *         shouldn't allocate anything to not leak memory
 692  * @request: send report request to device (e.g. feature report)
 693  * @wait: wait for buffered io to complete (send/recv reports)
 694  * @raw_request: send raw report request to device (e.g. feature report)
 695  * @output_report: send output report to device
 696  * @idle: send idle request to device
 697  */
 698 struct hid_ll_driver {
 699         int (*start)(struct hid_device *hdev);
 700         void (*stop)(struct hid_device *hdev);
 701
 702         int (*open)(struct hid_device *hdev);
 703         void (*close)(struct hid_device *hdev);
 704
 705         int (*power)(struct hid_device *hdev, int level);
 706
 707         int (*parse)(struct hid_device *hdev);
 708
 709         void (*request)(struct hid_device *hdev,
 710                         struct hid_report *report, int reqtype);
 711
 712         int (*wait)(struct hid_device *hdev);
 713
 714         int (*raw_request) (struct hid_device *hdev, unsigned char reportnum,
 715                             __u8 *buf, size_t len, unsigned char rtype,
 716                             int reqtype);
 717
 718         int (*output_report) (struct hid_device *hdev, __u8 *buf, size_t len);
 719
 720         int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
 721 };
 722
 723 #define PM_HINT_FULLON  1<<5
 724 #define PM_HINT_NORMAL  1<<1
 725
 726 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
 727 /* We ignore a few input applications that are not widely used */
 728 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
 729
 730 /* HID core API */
 731
 732 extern int hid_debug;
 733
 734 extern bool hid_ignore(struct hid_device *);
 735 extern int hid_add_device(struct hid_device *);
 736 extern void hid_destroy_device(struct hid_device *);
 737
 738 extern int __must_check __hid_register_driver(struct hid_driver *,
 739                 struct module *, const char *mod_name);
 740
 741 /* use a define to avoid include chaining to get THIS_MODULE & friends */
 742 #define hid_register_driver(driver) \
 743         __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
 744
 745 extern void hid_unregister_driver(struct hid_driver *);
 746
 747 /**
 748  * module_hid_driver() - Helper macro for registering a HID driver
 749  * @__hid_driver: hid_driver struct
 750  *
 751  * Helper macro for HID drivers which do not do anything special in module
 752  * init/exit. This eliminates a lot of boilerplate. Each module may only
 753  * use this macro once, and calling it replaces module_init() and module_exit()
 754  */
 755 #define module_hid_driver(__hid_driver) \
 756         module_driver(__hid_driver, hid_register_driver, \
 757                       hid_unregister_driver)
 758
 759 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
 760 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
 761 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
 762 extern void hidinput_disconnect(struct hid_device *);
 763
 764 int hid_set_field(struct hid_field *, unsigned, __s32);
 765 int hid_input_report(struct hid_device *, int type, u8 *, int, int);
 766 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
 767 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
 768 unsigned int hidinput_count_leds(struct hid_device *hid);
 769 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
 770 void hid_output_report(struct hid_report *report, __u8 *data);
 771 void __hid_request(struct hid_device *hid, struct hid_report *rep, int reqtype);
 772 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
 773 struct hid_device *hid_allocate_device(void);
 774 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id);
 775 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
 776 struct hid_report *hid_validate_values(struct hid_device *hid,
 777                                        unsigned int type, unsigned int id,
 778                                        unsigned int field_index,
 779                                        unsigned int report_counts);
 780 int hid_open_report(struct hid_device *device);
 781 int hid_check_keys_pressed(struct hid_device *hid);
 782 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
 783 void hid_disconnect(struct hid_device *hid);
 784 const struct hid_device_id *hid_match_id(struct hid_device *hdev,
 785                                          const struct hid_device_id *id);
 786 s32 hid_snto32(__u32 value, unsigned n);
 787
 788 /**
 789  * hid_device_io_start - enable HID input during probe, remove
 790  *
 791  * @hid - the device
 792  *
 793  * This should only be called during probe or remove and only be
 794  * called by the thread calling probe or remove. It will allow
 795  * incoming packets to be delivered to the driver.
 796  */
 797 static inline void hid_device_io_start(struct hid_device *hid) {
 798         if (hid->io_started) {
 799                 dev_warn(&hid->dev, "io already started");
 800                 return;
 801         }
 802         hid->io_started = true;
 803         up(&hid->driver_input_lock);
 804 }
 805
 806 /**
 807  * hid_device_io_stop - disable HID input during probe, remove
 808  *
 809  * @hid - the device
 810  *
 811  * Should only be called after hid_device_io_start. It will prevent
 812  * incoming packets from going to the driver for the duration of
 813  * probe, remove. If called during probe, packets will still go to the
 814  * driver after probe is complete. This function should only be called
 815  * by the thread calling probe or remove.
 816  */
 817 static inline void hid_device_io_stop(struct hid_device *hid) {
 818         if (!hid->io_started) {
 819                 dev_warn(&hid->dev, "io already stopped");
 820                 return;
 821         }
 822         hid->io_started = false;
 823         down(&hid->driver_input_lock);
 824 }
 825
 826 /**
 827  * hid_map_usage - map usage input bits
 828  *
 829  * @hidinput: hidinput which we are interested in
 830  * @usage: usage to fill in
 831  * @bit: pointer to input->{}bit (out parameter)
 832  * @max: maximal valid usage->code to consider later (out parameter)
 833  * @type: input event type (EV_KEY, EV_REL, ...)
 834  * @c: code which corresponds to this usage and type
 835  */
 836 static inline void hid_map_usage(struct hid_input *hidinput,
 837                 struct hid_usage *usage, unsigned long **bit, int *max,
 838                 __u8 type, __u16 c)
 839 {
 840         struct input_dev *input = hidinput->input;
 841
 842         usage->type = type;
 843         usage->code = c;
 844
 845         switch (type) {
 846         case EV_ABS:
 847                 *bit = input->absbit;
 848                 *max = ABS_MAX;
 849                 break;
 850         case EV_REL:
 851                 *bit = input->relbit;
 852                 *max = REL_MAX;
 853                 break;
 854         case EV_KEY:
 855                 *bit = input->keybit;
 856                 *max = KEY_MAX;
 857                 break;
 858         case EV_LED:
 859                 *bit = input->ledbit;
 860                 *max = LED_MAX;
 861                 break;
 862         }
 863 }
 864
 865 /**
 866  * hid_map_usage_clear - map usage input bits and clear the input bit
 867  *
 868  * The same as hid_map_usage, except the @c bit is also cleared in supported
 869  * bits (@bit).
 870  */
 871 static inline void hid_map_usage_clear(struct hid_input *hidinput,
 872                 struct hid_usage *usage, unsigned long **bit, int *max,
 873                 __u8 type, __u16 c)
 874 {
 875         hid_map_usage(hidinput, usage, bit, max, type, c);
 876         clear_bit(c, *bit);
 877 }
 878
 879 /**
 880  * hid_parse - parse HW reports
 881  *
 882  * @hdev: hid device
 883  *
 884  * Call this from probe after you set up the device (if needed). Your
 885  * report_fixup will be called (if non-NULL) after reading raw report from
 886  * device before passing it to hid layer for real parsing.
 887  */
 888 static inline int __must_check hid_parse(struct hid_device *hdev)
 889 {
 890         return hid_open_report(hdev);
 891 }
 892
 893 /**
 894  * hid_hw_start - start underlaying HW
 895  *
 896  * @hdev: hid device
 897  * @connect_mask: which outputs to connect, see HID_CONNECT_*
 898  *
 899  * Call this in probe function *after* hid_parse. This will setup HW buffers
 900  * and start the device (if not deffered to device open). hid_hw_stop must be
 901  * called if this was successful.
 902  */
 903 static inline int __must_check hid_hw_start(struct hid_device *hdev,
 904                 unsigned int connect_mask)
 905 {
 906         int ret = hdev->ll_driver->start(hdev);
 907         if (ret || !connect_mask)
 908                 return ret;
 909         ret = hid_connect(hdev, connect_mask);
 910         if (ret)
 911                 hdev->ll_driver->stop(hdev);
 912         return ret;
 913 }
 914
 915 /**
 916  * hid_hw_stop - stop underlaying HW
 917  *
 918  * @hdev: hid device
 919  *
 920  * This is usually called from remove function or from probe when something
 921  * failed and hid_hw_start was called already.
 922  */
 923 static inline void hid_hw_stop(struct hid_device *hdev)
 924 {
 925         hid_disconnect(hdev);
 926         hdev->ll_driver->stop(hdev);
 927 }
 928
 929 /**
 930  * hid_hw_open - signal underlaying HW to start delivering events
 931  *
 932  * @hdev: hid device
 933  *
 934  * Tell underlying HW to start delivering events from the device.
 935  * This function should be called sometime after successful call
 936  * to hid_hiw_start().
 937  */
 938 static inline int __must_check hid_hw_open(struct hid_device *hdev)
 939 {
 940         return hdev->ll_driver->open(hdev);
 941 }
 942
 943 /**
 944  * hid_hw_close - signal underlaying HW to stop delivering events
 945  *
 946  * @hdev: hid device
 947  *
 948  * This function indicates that we are not interested in the events
 949  * from this device anymore. Delivery of events may or may not stop,
 950  * depending on the number of users still outstanding.
 951  */
 952 static inline void hid_hw_close(struct hid_device *hdev)
 953 {
 954         hdev->ll_driver->close(hdev);
 955 }
 956
 957 /**
 958  * hid_hw_power - requests underlying HW to go into given power mode
 959  *
 960  * @hdev: hid device
 961  * @level: requested power level (one of %PM_HINT_* defines)
 962  *
 963  * This function requests underlying hardware to enter requested power
 964  * mode.
 965  */
 966
 967 static inline int hid_hw_power(struct hid_device *hdev, int level)
 968 {
 969         return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
 970 }
 971
 972
 973 /**
 974  * hid_hw_request - send report request to device
 975  *
 976  * @hdev: hid device
 977  * @report: report to send
 978  * @reqtype: hid request type
 979  */
 980 static inline void hid_hw_request(struct hid_device *hdev,
 981                                   struct hid_report *report, int reqtype)
 982 {
 983         if (hdev->ll_driver->request)
 984                 return hdev->ll_driver->request(hdev, report, reqtype);
 985
 986         __hid_request(hdev, report, reqtype);
 987 }
 988
 989 /**
 990  * hid_hw_raw_request - send report request to device
 991  *
 992  * @hdev: hid device
 993  * @reportnum: report ID
 994  * @buf: in/out data to transfer
 995  * @len: length of buf
 996  * @rtype: HID report type
 997  * @reqtype: HID_REQ_GET_REPORT or HID_REQ_SET_REPORT
 998  *
 999  * @return: count of data transfered, negative if error
1000  *
1001  * Same behavior as hid_hw_request, but with raw buffers instead.
1002  */
1003 static inline int hid_hw_raw_request(struct hid_device *hdev,
1004                                   unsigned char reportnum, __u8 *buf,
1005                                   size_t len, unsigned char rtype, int reqtype)
1006 {
1007         if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1008                 return -EINVAL;
1009
1010         return hdev->ll_driver->raw_request(hdev, reportnum, buf, len,
1011                                                     rtype, reqtype);
1012 }
1013
1014 /**
1015  * hid_hw_output_report - send output report to device
1016  *
1017  * @hdev: hid device
1018  * @buf: raw data to transfer
1019  * @len: length of buf
1020  *
1021  * @return: count of data transfered, negative if error
1022  */
1023 static inline int hid_hw_output_report(struct hid_device *hdev, __u8 *buf,
1024                                         size_t len)
1025 {
1026         if (len < 1 || len > HID_MAX_BUFFER_SIZE || !buf)
1027                 return -EINVAL;
1028
1029         if (hdev->ll_driver->output_report)
1030                 return hdev->ll_driver->output_report(hdev, buf, len);
1031
1032         return -ENOSYS;
1033 }
1034
1035 /**
1036  * hid_hw_idle - send idle request to device
1037  *
1038  * @hdev: hid device
1039  * @report: report to control
1040  * @idle: idle state
1041  * @reqtype: hid request type
1042  */
1043 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
1044                 int reqtype)
1045 {
1046         if (hdev->ll_driver->idle)
1047                 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
1048
1049         return 0;
1050 }
1051
1052 /**
1053  * hid_hw_wait - wait for buffered io to complete
1054  *
1055  * @hdev: hid device
1056  */
1057 static inline void hid_hw_wait(struct hid_device *hdev)
1058 {
1059         if (hdev->ll_driver->wait)
1060                 hdev->ll_driver->wait(hdev);
1061 }
1062
1063 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
1064                 int interrupt);
1065
1066 /* HID quirks API */
1067 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
1068 int usbhid_quirks_init(char **quirks_param);
1069 void usbhid_quirks_exit(void);
1070
1071 #ifdef CONFIG_HID_PID
1072 int hid_pidff_init(struct hid_device *hid);
1073 #else
1074 #define hid_pidff_init NULL
1075 #endif
1076
1077 #define dbg_hid(format, arg...)                                         \
1078 do {                                                                    \
1079         if (hid_debug)                                                  \
1080                 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg);      \
1081 } while (0)
1082
1083 #define hid_printk(level, hid, fmt, arg...)             \
1084         dev_printk(level, &(hid)->dev, fmt, ##arg)
1085 #define hid_emerg(hid, fmt, arg...)                     \
1086         dev_emerg(&(hid)->dev, fmt, ##arg)
1087 #define hid_crit(hid, fmt, arg...)                      \
1088         dev_crit(&(hid)->dev, fmt, ##arg)
1089 #define hid_alert(hid, fmt, arg...)                     \
1090         dev_alert(&(hid)->dev, fmt, ##arg)
1091 #define hid_err(hid, fmt, arg...)                       \
1092         dev_err(&(hid)->dev, fmt, ##arg)
1093 #define hid_notice(hid, fmt, arg...)                    \
1094         dev_notice(&(hid)->dev, fmt, ##arg)
1095 #define hid_warn(hid, fmt, arg...)                      \
1096         dev_warn(&(hid)->dev, fmt, ##arg)
1097 #define hid_info(hid, fmt, arg...)                      \
1098         dev_info(&(hid)->dev, fmt, ##arg)
1099 #define hid_dbg(hid, fmt, arg...)                       \
1100         dev_dbg(&(hid)->dev, fmt, ##arg)
1101
1102 #endif