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