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