include/linux/hid.h

   1 #ifndef __HID_H
   2 #define __HID_H
   3
   4 /*
   5  *  Copyright (c) 1999 Andreas Gal
   6  *  Copyright (c) 2000-2001 Vojtech Pavlik
   7  *  Copyright (c) 2006-2007 Jiri Kosina
   8  */
   9
  10 /*
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  24  *
  25  * Should you need to contact me, the author, you can do so either by
  26  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  27  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  28  */
  29
  30 /*
  31  * USB HID (Human Interface Device) interface class code
  32  */
  33
  34 #define USB_INTERFACE_CLASS_HID         3
  35
  36 /*
  37  * USB HID interface subclass and protocol codes
  38  */
  39
  40 #define USB_INTERFACE_SUBCLASS_BOOT     1
  41 #define USB_INTERFACE_PROTOCOL_KEYBOARD 1
  42 #define USB_INTERFACE_PROTOCOL_MOUSE    2
  43
  44 /*
  45  * HID class requests
  46  */
  47
  48 #define HID_REQ_GET_REPORT              0x01
  49 #define HID_REQ_GET_IDLE                0x02
  50 #define HID_REQ_GET_PROTOCOL            0x03
  51 #define HID_REQ_SET_REPORT              0x09
  52 #define HID_REQ_SET_IDLE                0x0A
  53 #define HID_REQ_SET_PROTOCOL            0x0B
  54
  55 /*
  56  * HID class descriptor types
  57  */
  58
  59 #define HID_DT_HID                      (USB_TYPE_CLASS | 0x01)
  60 #define HID_DT_REPORT                   (USB_TYPE_CLASS | 0x02)
  61 #define HID_DT_PHYSICAL                 (USB_TYPE_CLASS | 0x03)
  62
  63 #define HID_MAX_DESCRIPTOR_SIZE         4096
  64
  65 #ifdef __KERNEL__
  66
  67 #include <linux/types.h>
  68 #include <linux/slab.h>
  69 #include <linux/list.h>
  70 #include <linux/mod_devicetable.h> /* hid_device_id */
  71 #include <linux/timer.h>
  72 #include <linux/workqueue.h>
  73 #include <linux/input.h>
  74
  75 /*
  76  * We parse each description item into this structure. Short items data
  77  * values are expanded to 32-bit signed int, long items contain a pointer
  78  * into the data area.
  79  */
  80
  81 struct hid_item {
  82         unsigned  format;
  83         __u8      size;
  84         __u8      type;
  85         __u8      tag;
  86         union {
  87             __u8   u8;
  88             __s8   s8;
  89             __u16  u16;
  90             __s16  s16;
  91             __u32  u32;
  92             __s32  s32;
  93             __u8  *longdata;
  94         } data;
  95 };
  96
  97 /*
  98  * HID report item format
  99  */
 100
 101 #define HID_ITEM_FORMAT_SHORT   0
 102 #define HID_ITEM_FORMAT_LONG    1
 103
 104 /*
 105  * Special tag indicating long items
 106  */
 107
 108 #define HID_ITEM_TAG_LONG       15
 109
 110 /*
 111  * HID report descriptor item type (prefix bit 2,3)
 112  */
 113
 114 #define HID_ITEM_TYPE_MAIN              0
 115 #define HID_ITEM_TYPE_GLOBAL            1
 116 #define HID_ITEM_TYPE_LOCAL             2
 117 #define HID_ITEM_TYPE_RESERVED          3
 118
 119 /*
 120  * HID report descriptor main item tags
 121  */
 122
 123 #define HID_MAIN_ITEM_TAG_INPUT                 8
 124 #define HID_MAIN_ITEM_TAG_OUTPUT                9
 125 #define HID_MAIN_ITEM_TAG_FEATURE               11
 126 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION      10
 127 #define HID_MAIN_ITEM_TAG_END_COLLECTION        12
 128
 129 /*
 130  * HID report descriptor main item contents
 131  */
 132
 133 #define HID_MAIN_ITEM_CONSTANT          0x001
 134 #define HID_MAIN_ITEM_VARIABLE          0x002
 135 #define HID_MAIN_ITEM_RELATIVE          0x004
 136 #define HID_MAIN_ITEM_WRAP              0x008
 137 #define HID_MAIN_ITEM_NONLINEAR         0x010
 138 #define HID_MAIN_ITEM_NO_PREFERRED      0x020
 139 #define HID_MAIN_ITEM_NULL_STATE        0x040
 140 #define HID_MAIN_ITEM_VOLATILE          0x080
 141 #define HID_MAIN_ITEM_BUFFERED_BYTE     0x100
 142
 143 /*
 144  * HID report descriptor collection item types
 145  */
 146
 147 #define HID_COLLECTION_PHYSICAL         0
 148 #define HID_COLLECTION_APPLICATION      1
 149 #define HID_COLLECTION_LOGICAL          2
 150
 151 /*
 152  * HID report descriptor global item tags
 153  */
 154
 155 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE          0
 156 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM     1
 157 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM     2
 158 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM    3
 159 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM    4
 160 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT       5
 161 #define HID_GLOBAL_ITEM_TAG_UNIT                6
 162 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE         7
 163 #define HID_GLOBAL_ITEM_TAG_REPORT_ID           8
 164 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT        9
 165 #define HID_GLOBAL_ITEM_TAG_PUSH                10
 166 #define HID_GLOBAL_ITEM_TAG_POP                 11
 167
 168 /*
 169  * HID report descriptor local item tags
 170  */
 171
 172 #define HID_LOCAL_ITEM_TAG_USAGE                0
 173 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM        1
 174 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM        2
 175 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX     3
 176 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM   4
 177 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM   5
 178 #define HID_LOCAL_ITEM_TAG_STRING_INDEX         7
 179 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM       8
 180 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM       9
 181 #define HID_LOCAL_ITEM_TAG_DELIMITER            10
 182
 183 /*
 184  * HID usage tables
 185  */
 186
 187 #define HID_USAGE_PAGE          0xffff0000
 188
 189 #define HID_UP_UNDEFINED        0x00000000
 190 #define HID_UP_GENDESK          0x00010000
 191 #define HID_UP_SIMULATION       0x00020000
 192 #define HID_UP_KEYBOARD         0x00070000
 193 #define HID_UP_LED              0x00080000
 194 #define HID_UP_BUTTON           0x00090000
 195 #define HID_UP_ORDINAL          0x000a0000
 196 #define HID_UP_CONSUMER         0x000c0000
 197 #define HID_UP_DIGITIZER        0x000d0000
 198 #define HID_UP_PID              0x000f0000
 199 #define HID_UP_HPVENDOR         0xff7f0000
 200 #define HID_UP_MSVENDOR         0xff000000
 201 #define HID_UP_CUSTOM           0x00ff0000
 202 #define HID_UP_LOGIVENDOR       0xffbc0000
 203
 204 #define HID_USAGE               0x0000ffff
 205
 206 #define HID_GD_POINTER          0x00010001
 207 #define HID_GD_MOUSE            0x00010002
 208 #define HID_GD_JOYSTICK         0x00010004
 209 #define HID_GD_GAMEPAD          0x00010005
 210 #define HID_GD_KEYBOARD         0x00010006
 211 #define HID_GD_KEYPAD           0x00010007
 212 #define HID_GD_MULTIAXIS        0x00010008
 213 #define HID_GD_X                0x00010030
 214 #define HID_GD_Y                0x00010031
 215 #define HID_GD_Z                0x00010032
 216 #define HID_GD_RX               0x00010033
 217 #define HID_GD_RY               0x00010034
 218 #define HID_GD_RZ               0x00010035
 219 #define HID_GD_SLIDER           0x00010036
 220 #define HID_GD_DIAL             0x00010037
 221 #define HID_GD_WHEEL            0x00010038
 222 #define HID_GD_HATSWITCH        0x00010039
 223 #define HID_GD_BUFFER           0x0001003a
 224 #define HID_GD_BYTECOUNT        0x0001003b
 225 #define HID_GD_MOTION           0x0001003c
 226 #define HID_GD_START            0x0001003d
 227 #define HID_GD_SELECT           0x0001003e
 228 #define HID_GD_VX               0x00010040
 229 #define HID_GD_VY               0x00010041
 230 #define HID_GD_VZ               0x00010042
 231 #define HID_GD_VBRX             0x00010043
 232 #define HID_GD_VBRY             0x00010044
 233 #define HID_GD_VBRZ             0x00010045
 234 #define HID_GD_VNO              0x00010046
 235 #define HID_GD_FEATURE          0x00010047
 236 #define HID_GD_UP               0x00010090
 237 #define HID_GD_DOWN             0x00010091
 238 #define HID_GD_RIGHT            0x00010092
 239 #define HID_GD_LEFT             0x00010093
 240
 241 #define HID_DG_DIGITIZER        0x000d0001
 242 #define HID_DG_PEN              0x000d0002
 243 #define HID_DG_LIGHTPEN         0x000d0003
 244 #define HID_DG_TOUCHSCREEN      0x000d0004
 245 #define HID_DG_TOUCHPAD         0x000d0005
 246 #define HID_DG_STYLUS           0x000d0020
 247 #define HID_DG_PUCK             0x000d0021
 248 #define HID_DG_FINGER           0x000d0022
 249 #define HID_DG_TIPPRESSURE      0x000d0030
 250 #define HID_DG_BARRELPRESSURE   0x000d0031
 251 #define HID_DG_INRANGE          0x000d0032
 252 #define HID_DG_TOUCH            0x000d0033
 253 #define HID_DG_UNTOUCH          0x000d0034
 254 #define HID_DG_TAP              0x000d0035
 255 #define HID_DG_TABLETFUNCTIONKEY        0x000d0039
 256 #define HID_DG_PROGRAMCHANGEKEY 0x000d003a
 257 #define HID_DG_INVERT           0x000d003c
 258 #define HID_DG_TIPSWITCH        0x000d0042
 259 #define HID_DG_TIPSWITCH2       0x000d0043
 260 #define HID_DG_BARRELSWITCH     0x000d0044
 261 #define HID_DG_ERASER           0x000d0045
 262 #define HID_DG_TABLETPICK       0x000d0046
 263 /*
 264  * as of May 20, 2009 the usages below are not yet in the official USB spec
 265  * but are being pushed by Microsft as described in their paper "Digitizer
 266  * Drivers for Windows Touch and Pen-Based Computers"
 267  */
 268 #define HID_DG_CONFIDENCE       0x000d0047
 269 #define HID_DG_WIDTH            0x000d0048
 270 #define HID_DG_HEIGHT           0x000d0049
 271 #define HID_DG_CONTACTID        0x000d0051
 272 #define HID_DG_INPUTMODE        0x000d0052
 273 #define HID_DG_DEVICEINDEX      0x000d0053
 274 #define HID_DG_CONTACTCOUNT     0x000d0054
 275 #define HID_DG_CONTACTMAX       0x000d0055
 276
 277 /*
 278  * HID report types --- Ouch! HID spec says 1 2 3!
 279  */
 280
 281 #define HID_INPUT_REPORT        0
 282 #define HID_OUTPUT_REPORT       1
 283 #define HID_FEATURE_REPORT      2
 284
 285 /*
 286  * HID connect requests
 287  */
 288
 289 #define HID_CONNECT_HIDINPUT            0x01
 290 #define HID_CONNECT_HIDINPUT_FORCE      0x02
 291 #define HID_CONNECT_HIDRAW              0x04
 292 #define HID_CONNECT_HIDDEV              0x08
 293 #define HID_CONNECT_HIDDEV_FORCE        0x10
 294 #define HID_CONNECT_FF                  0x20
 295 #define HID_CONNECT_DEFAULT     (HID_CONNECT_HIDINPUT|HID_CONNECT_HIDRAW| \
 296                 HID_CONNECT_HIDDEV|HID_CONNECT_FF)
 297
 298 /*
 299  * HID device quirks.
 300  */
 301
 302 /*
 303  * Increase this if you need to configure more HID quirks at module load time
 304  */
 305 #define MAX_USBHID_BOOT_QUIRKS 4
 306
 307 #define HID_QUIRK_INVERT                        0x00000001
 308 #define HID_QUIRK_NOTOUCH                       0x00000002
 309 #define HID_QUIRK_IGNORE                        0x00000004
 310 #define HID_QUIRK_NOGET                         0x00000008
 311 #define HID_QUIRK_HIDDEV_FORCE                  0x00000010
 312 #define HID_QUIRK_BADPAD                        0x00000020
 313 #define HID_QUIRK_MULTI_INPUT                   0x00000040
 314 #define HID_QUIRK_HIDINPUT_FORCE                0x00000080
 315 #define HID_QUIRK_MULTITOUCH                    0x00000100
 316 #define HID_QUIRK_SKIP_OUTPUT_REPORTS           0x00010000
 317 #define HID_QUIRK_FULLSPEED_INTERVAL            0x10000000
 318 #define HID_QUIRK_NO_INIT_REPORTS               0x20000000
 319 #define HID_QUIRK_NO_IGNORE                     0x40000000
 320 #define HID_QUIRK_NO_INPUT_SYNC                 0x80000000
 321
 322 /*
 323  * This is the global environment of the parser. This information is
 324  * persistent for main-items. The global environment can be saved and
 325  * restored with PUSH/POP statements.
 326  */
 327
 328 struct hid_global {
 329         unsigned usage_page;
 330         __s32    logical_minimum;
 331         __s32    logical_maximum;
 332         __s32    physical_minimum;
 333         __s32    physical_maximum;
 334         __s32    unit_exponent;
 335         unsigned unit;
 336         unsigned report_id;
 337         unsigned report_size;
 338         unsigned report_count;
 339 };
 340
 341 /*
 342  * This is the local environment. It is persistent up the next main-item.
 343  */
 344
 345 #define HID_MAX_USAGES                  12288
 346 #define HID_DEFAULT_NUM_COLLECTIONS     16
 347
 348 struct hid_local {
 349         unsigned usage[HID_MAX_USAGES]; /* usage array */
 350         unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
 351         unsigned usage_index;
 352         unsigned usage_minimum;
 353         unsigned delimiter_depth;
 354         unsigned delimiter_branch;
 355 };
 356
 357 /*
 358  * This is the collection stack. We climb up the stack to determine
 359  * application and function of each field.
 360  */
 361
 362 struct hid_collection {
 363         unsigned type;
 364         unsigned usage;
 365         unsigned level;
 366 };
 367
 368 struct hid_usage {
 369         unsigned  hid;                  /* hid usage code */
 370         unsigned  collection_index;     /* index into collection array */
 371         /* hidinput data */
 372         __u16     code;                 /* input driver code */
 373         __u8      type;                 /* input driver type */
 374         __s8      hat_min;              /* hat switch fun */
 375         __s8      hat_max;              /* ditto */
 376         __s8      hat_dir;              /* ditto */
 377 };
 378
 379 struct hid_input;
 380
 381 struct hid_field {
 382         unsigned  physical;             /* physical usage for this field */
 383         unsigned  logical;              /* logical usage for this field */
 384         unsigned  application;          /* application usage for this field */
 385         struct hid_usage *usage;        /* usage table for this function */
 386         unsigned  maxusage;             /* maximum usage index */
 387         unsigned  flags;                /* main-item flags (i.e. volatile,array,constant) */
 388         unsigned  report_offset;        /* bit offset in the report */
 389         unsigned  report_size;          /* size of this field in the report */
 390         unsigned  report_count;         /* number of this field in the report */
 391         unsigned  report_type;          /* (input,output,feature) */
 392         __s32    *value;                /* last known value(s) */
 393         __s32     logical_minimum;
 394         __s32     logical_maximum;
 395         __s32     physical_minimum;
 396         __s32     physical_maximum;
 397         __s32     unit_exponent;
 398         unsigned  unit;
 399         struct hid_report *report;      /* associated report */
 400         unsigned index;                 /* index into report->field[] */
 401         /* hidinput data */
 402         struct hid_input *hidinput;     /* associated input structure */
 403         __u16 dpad;                     /* dpad input code */
 404 };
 405
 406 #define HID_MAX_FIELDS 128
 407
 408 struct hid_report {
 409         struct list_head list;
 410         unsigned id;                                    /* id of this report */
 411         unsigned type;                                  /* report type */
 412         struct hid_field *field[HID_MAX_FIELDS];        /* fields of the report */
 413         unsigned maxfield;                              /* maximum valid field index */
 414         unsigned size;                                  /* size of the report (bits) */
 415         struct hid_device *device;                      /* associated device */
 416 };
 417
 418 struct hid_report_enum {
 419         unsigned numbered;
 420         struct list_head report_list;
 421         struct hid_report *report_id_hash[256];
 422 };
 423
 424 #define HID_REPORT_TYPES 3
 425
 426 #define HID_MIN_BUFFER_SIZE     64              /* make sure there is at least a packet size of space */
 427 #define HID_MAX_BUFFER_SIZE     4096            /* 4kb */
 428 #define HID_CONTROL_FIFO_SIZE   256             /* to init devices with >100 reports */
 429 #define HID_OUTPUT_FIFO_SIZE    64
 430
 431 struct hid_control_fifo {
 432         unsigned char dir;
 433         struct hid_report *report;
 434         char *raw_report;
 435 };
 436
 437 struct hid_output_fifo {
 438         struct hid_report *report;
 439         char *raw_report;
 440 };
 441
 442 #define HID_CLAIMED_INPUT       1
 443 #define HID_CLAIMED_HIDDEV      2
 444 #define HID_CLAIMED_HIDRAW      4
 445
 446 #define HID_STAT_ADDED          1
 447 #define HID_STAT_PARSED         2
 448
 449 struct hid_input {
 450         struct list_head list;
 451         struct hid_report *report;
 452         struct input_dev *input;
 453 };
 454
 455 enum hid_type {
 456         HID_TYPE_OTHER = 0,
 457         HID_TYPE_USBMOUSE,
 458         HID_TYPE_USBNONE
 459 };
 460
 461 struct hid_driver;
 462 struct hid_ll_driver;
 463
 464 struct hid_device {                                                     /* device report descriptor */
 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         __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
 479         struct device dev;                                              /* device */
 480         struct hid_driver *driver;
 481         struct hid_ll_driver *ll_driver;
 482
 483         unsigned int status;                                            /* see STAT flags above */
 484         unsigned claimed;                                               /* Claimed by hidinput, hiddev? */
 485         unsigned quirks;                                                /* Various quirks the device can pull on us */
 486
 487         struct list_head inputs;                                        /* The list of inputs */
 488         void *hiddev;                                                   /* The hiddev structure */
 489         void *hidraw;
 490         int minor;                                                      /* Hiddev minor number */
 491
 492         int open;                                                       /* is the device open by anyone? */
 493         char name[128];                                                 /* Device name */
 494         char phys[64];                                                  /* Device physical location */
 495         char uniq[64];                                                  /* Device unique identifier (serial #) */
 496
 497         void *driver_data;
 498
 499         /* temporary hid_ff handling (until moved to the drivers) */
 500         int (*ff_init)(struct hid_device *);
 501
 502         /* hiddev event handler */
 503         int (*hiddev_connect)(struct hid_device *, unsigned int);
 504         void (*hiddev_disconnect)(struct hid_device *);
 505         void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
 506                                   struct hid_usage *, __s32);
 507         void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
 508
 509         /* handler for raw input (Get_Report) data, used by hidraw */
 510         int (*hid_get_raw_report) (struct hid_device *, unsigned char, __u8 *, size_t, unsigned char);
 511
 512         /* handler for raw output data, used by hidraw */
 513         int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t, unsigned char);
 514
 515         /* debugging support via debugfs */
 516         unsigned short debug;
 517         struct dentry *debug_dir;
 518         struct dentry *debug_rdesc;
 519         struct dentry *debug_events;
 520         struct list_head debug_list;
 521         wait_queue_head_t debug_wait;
 522 };
 523
 524 static inline void *hid_get_drvdata(struct hid_device *hdev)
 525 {
 526         return dev_get_drvdata(&hdev->dev);
 527 }
 528
 529 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
 530 {
 531         dev_set_drvdata(&hdev->dev, data);
 532 }
 533
 534 #define HID_GLOBAL_STACK_SIZE 4
 535 #define HID_COLLECTION_STACK_SIZE 4
 536
 537 struct hid_parser {
 538         struct hid_global     global;
 539         struct hid_global     global_stack[HID_GLOBAL_STACK_SIZE];
 540         unsigned              global_stack_ptr;
 541         struct hid_local      local;
 542         unsigned              collection_stack[HID_COLLECTION_STACK_SIZE];
 543         unsigned              collection_stack_ptr;
 544         struct hid_device    *device;
 545 };
 546
 547 struct hid_class_descriptor {
 548         __u8  bDescriptorType;
 549         __le16 wDescriptorLength;
 550 } __attribute__ ((packed));
 551
 552 struct hid_descriptor {
 553         __u8  bLength;
 554         __u8  bDescriptorType;
 555         __le16 bcdHID;
 556         __u8  bCountryCode;
 557         __u8  bNumDescriptors;
 558
 559         struct hid_class_descriptor desc[1];
 560 } __attribute__ ((packed));
 561
 562 #define HID_DEVICE(b, ven, prod) \
 563         .bus = (b), \
 564         .vendor = (ven), .product = (prod)
 565
 566 #define HID_USB_DEVICE(ven, prod)       HID_DEVICE(BUS_USB, ven, prod)
 567 #define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
 568
 569 #define HID_REPORT_ID(rep) \
 570         .report_type = (rep)
 571 #define HID_USAGE_ID(uhid, utype, ucode) \
 572         .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
 573 /* we don't want to catch types and codes equal to 0 */
 574 #define HID_TERMINATOR          (HID_ANY_ID - 1)
 575
 576 struct hid_report_id {
 577         __u32 report_type;
 578 };
 579 struct hid_usage_id {
 580         __u32 usage_hid;
 581         __u32 usage_type;
 582         __u32 usage_code;
 583 };
 584
 585 /**
 586  * struct hid_driver
 587  * @name: driver name (e.g. "Footech_bar-wheel")
 588  * @id_table: which devices is this driver for (must be non-NULL for probe
 589  *            to be called)
 590  * @dyn_list: list of dynamically added device ids
 591  * @dyn_lock: lock protecting @dyn_list
 592  * @probe: new device inserted
 593  * @remove: device removed (NULL if not a hot-plug capable driver)
 594  * @report_table: on which reports to call raw_event (NULL means all)
 595  * @raw_event: if report in report_table, this hook is called (NULL means nop)
 596  * @usage_table: on which events to call event (NULL means all)
 597  * @event: if usage in usage_table, this hook is called (NULL means nop)
 598  * @report_fixup: called before report descriptor parsing (NULL means nop)
 599  * @input_mapping: invoked on input registering before mapping an usage
 600  * @input_mapped: invoked on input registering after mapping an usage
 601  * @feature_mapping: invoked on feature registering
 602  * @suspend: invoked on suspend (NULL means nop)
 603  * @resume: invoked on resume if device was not reset (NULL means nop)
 604  * @reset_resume: invoked on resume if device was reset (NULL means nop)
 605  *
 606  * raw_event and event should return 0 on no action performed, 1 when no
 607  * further processing should be done and negative on error
 608  *
 609  * input_mapping shall return a negative value to completely ignore this usage
 610  * (e.g. doubled or invalid usage), zero to continue with parsing of this
 611  * usage by generic code (no special handling needed) or positive to skip
 612  * generic parsing (needed special handling which was done in the hook already)
 613  * input_mapped shall return negative to inform the layer that this usage
 614  * should not be considered for further processing or zero to notify that
 615  * no processing was performed and should be done in a generic manner
 616  * Both these functions may be NULL which means the same behavior as returning
 617  * zero from them.
 618  */
 619 struct hid_driver {
 620         char *name;
 621         const struct hid_device_id *id_table;
 622
 623         struct list_head dyn_list;
 624         spinlock_t dyn_lock;
 625
 626         int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
 627         void (*remove)(struct hid_device *dev);
 628
 629         const struct hid_report_id *report_table;
 630         int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
 631                         u8 *data, int size);
 632         const struct hid_usage_id *usage_table;
 633         int (*event)(struct hid_device *hdev, struct hid_field *field,
 634                         struct hid_usage *usage, __s32 value);
 635
 636         __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
 637                         unsigned int *size);
 638
 639         int (*input_mapping)(struct hid_device *hdev,
 640                         struct hid_input *hidinput, struct hid_field *field,
 641                         struct hid_usage *usage, unsigned long **bit, int *max);
 642         int (*input_mapped)(struct hid_device *hdev,
 643                         struct hid_input *hidinput, struct hid_field *field,
 644                         struct hid_usage *usage, unsigned long **bit, int *max);
 645         void (*feature_mapping)(struct hid_device *hdev,
 646                         struct hid_field *field,
 647                         struct hid_usage *usage);
 648 #ifdef CONFIG_PM
 649         int (*suspend)(struct hid_device *hdev, pm_message_t message);
 650         int (*resume)(struct hid_device *hdev);
 651         int (*reset_resume)(struct hid_device *hdev);
 652 #endif
 653 /* private: */
 654         struct device_driver driver;
 655 };
 656
 657 /**
 658  * hid_ll_driver - low level driver callbacks
 659  * @start: called on probe to start the device
 660  * @stop: called on remove
 661  * @open: called by input layer on open
 662  * @close: called by input layer on close
 663  * @hidinput_input_event: event input event (e.g. ff or leds)
 664  * @parse: this method is called only once to parse the device data,
 665  *         shouldn't allocate anything to not leak memory
 666  */
 667 struct hid_ll_driver {
 668         int (*start)(struct hid_device *hdev);
 669         void (*stop)(struct hid_device *hdev);
 670
 671         int (*open)(struct hid_device *hdev);
 672         void (*close)(struct hid_device *hdev);
 673
 674         int (*power)(struct hid_device *hdev, int level);
 675
 676         int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
 677                         unsigned int code, int value);
 678
 679         int (*parse)(struct hid_device *hdev);
 680 };
 681
 682 #define PM_HINT_FULLON  1<<5
 683 #define PM_HINT_NORMAL  1<<1
 684
 685 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
 686 /* We ignore a few input applications that are not widely used */
 687 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
 688
 689 /* HID core API */
 690
 691 extern int hid_debug;
 692
 693 extern int hid_add_device(struct hid_device *);
 694 extern void hid_destroy_device(struct hid_device *);
 695
 696 extern int __must_check __hid_register_driver(struct hid_driver *,
 697                 struct module *, const char *mod_name);
 698 static inline int __must_check hid_register_driver(struct hid_driver *driver)
 699 {
 700         return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
 701 }
 702 extern void hid_unregister_driver(struct hid_driver *);
 703
 704 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
 705 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
 706 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
 707 extern void hidinput_disconnect(struct hid_device *);
 708
 709 int hid_set_field(struct hid_field *, unsigned, __s32);
 710 int hid_input_report(struct hid_device *, int type, u8 *, int, int);
 711 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
 712 void hid_output_report(struct hid_report *report, __u8 *data);
 713 struct hid_device *hid_allocate_device(void);
 714 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id);
 715 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
 716 int hid_check_keys_pressed(struct hid_device *hid);
 717 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
 718 void hid_disconnect(struct hid_device *hid);
 719
 720 /**
 721  * hid_map_usage - map usage input bits
 722  *
 723  * @hidinput: hidinput which we are interested in
 724  * @usage: usage to fill in
 725  * @bit: pointer to input->{}bit (out parameter)
 726  * @max: maximal valid usage->code to consider later (out parameter)
 727  * @type: input event type (EV_KEY, EV_REL, ...)
 728  * @c: code which corresponds to this usage and type
 729  */
 730 static inline void hid_map_usage(struct hid_input *hidinput,
 731                 struct hid_usage *usage, unsigned long **bit, int *max,
 732                 __u8 type, __u16 c)
 733 {
 734         struct input_dev *input = hidinput->input;
 735
 736         usage->type = type;
 737         usage->code = c;
 738
 739         switch (type) {
 740         case EV_ABS:
 741                 *bit = input->absbit;
 742                 *max = ABS_MAX;
 743                 break;
 744         case EV_REL:
 745                 *bit = input->relbit;
 746                 *max = REL_MAX;
 747                 break;
 748         case EV_KEY:
 749                 *bit = input->keybit;
 750                 *max = KEY_MAX;
 751                 break;
 752         case EV_LED:
 753                 *bit = input->ledbit;
 754                 *max = LED_MAX;
 755                 break;
 756         }
 757 }
 758
 759 /**
 760  * hid_map_usage_clear - map usage input bits and clear the input bit
 761  *
 762  * The same as hid_map_usage, except the @c bit is also cleared in supported
 763  * bits (@bit).
 764  */
 765 static inline void hid_map_usage_clear(struct hid_input *hidinput,
 766                 struct hid_usage *usage, unsigned long **bit, int *max,
 767                 __u8 type, __u16 c)
 768 {
 769         hid_map_usage(hidinput, usage, bit, max, type, c);
 770         clear_bit(c, *bit);
 771 }
 772
 773 /**
 774  * hid_parse - parse HW reports
 775  *
 776  * @hdev: hid device
 777  *
 778  * Call this from probe after you set up the device (if needed). Your
 779  * report_fixup will be called (if non-NULL) after reading raw report from
 780  * device before passing it to hid layer for real parsing.
 781  */
 782 static inline int __must_check hid_parse(struct hid_device *hdev)
 783 {
 784         int ret;
 785
 786         if (hdev->status & HID_STAT_PARSED)
 787                 return 0;
 788
 789         ret = hdev->ll_driver->parse(hdev);
 790         if (!ret)
 791                 hdev->status |= HID_STAT_PARSED;
 792
 793         return ret;
 794 }
 795
 796 /**
 797  * hid_hw_start - start underlaying HW
 798  *
 799  * @hdev: hid device
 800  * @connect_mask: which outputs to connect, see HID_CONNECT_*
 801  *
 802  * Call this in probe function *after* hid_parse. This will setup HW buffers
 803  * and start the device (if not deffered to device open). hid_hw_stop must be
 804  * called if this was successful.
 805  */
 806 static inline int __must_check hid_hw_start(struct hid_device *hdev,
 807                 unsigned int connect_mask)
 808 {
 809         int ret = hdev->ll_driver->start(hdev);
 810         if (ret || !connect_mask)
 811                 return ret;
 812         ret = hid_connect(hdev, connect_mask);
 813         if (ret)
 814                 hdev->ll_driver->stop(hdev);
 815         return ret;
 816 }
 817
 818 /**
 819  * hid_hw_stop - stop underlaying HW
 820  *
 821  * @hdev: hid device
 822  *
 823  * This is usually called from remove function or from probe when something
 824  * failed and hid_hw_start was called already.
 825  */
 826 static inline void hid_hw_stop(struct hid_device *hdev)
 827 {
 828         hid_disconnect(hdev);
 829         hdev->ll_driver->stop(hdev);
 830 }
 831
 832 /**
 833  * hid_hw_open - signal underlaying HW to start delivering events
 834  *
 835  * @hdev: hid device
 836  *
 837  * Tell underlying HW to start delivering events from the device.
 838  * This function should be called sometime after successful call
 839  * to hid_hiw_start().
 840  */
 841 static inline int __must_check hid_hw_open(struct hid_device *hdev)
 842 {
 843         return hdev->ll_driver->open(hdev);
 844 }
 845
 846 /**
 847  * hid_hw_close - signal underlaying HW to stop delivering events
 848  *
 849  * @hdev: hid device
 850  *
 851  * This function indicates that we are not interested in the events
 852  * from this device anymore. Delivery of events may or may not stop,
 853  * depending on the number of users still outstanding.
 854  */
 855 static inline void hid_hw_close(struct hid_device *hdev)
 856 {
 857         hdev->ll_driver->close(hdev);
 858 }
 859
 860 /**
 861  * hid_hw_power - requests underlying HW to go into given power mode
 862  *
 863  * @hdev: hid device
 864  * @level: requested power level (one of %PM_HINT_* defines)
 865  *
 866  * This function requests underlying hardware to enter requested power
 867  * mode.
 868  */
 869
 870 static inline int hid_hw_power(struct hid_device *hdev, int level)
 871 {
 872         return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
 873 }
 874
 875 void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
 876                 int interrupt);
 877
 878 extern int hid_generic_init(void);
 879 extern void hid_generic_exit(void);
 880
 881 /* HID quirks API */
 882 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
 883 int usbhid_quirks_init(char **quirks_param);
 884 void usbhid_quirks_exit(void);
 885 void usbhid_set_leds(struct hid_device *hid);
 886
 887 #ifdef CONFIG_HID_PID
 888 int hid_pidff_init(struct hid_device *hid);
 889 #else
 890 #define hid_pidff_init NULL
 891 #endif
 892
 893 #define dbg_hid(format, arg...)                                         \
 894 do {                                                                    \
 895         if (hid_debug)                                                  \
 896                 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg);      \
 897 } while (0)
 898
 899 #define hid_printk(level, hid, fmt, arg...)             \
 900         dev_printk(level, &(hid)->dev, fmt, ##arg)
 901 #define hid_emerg(hid, fmt, arg...)                     \
 902         dev_emerg(&(hid)->dev, fmt, ##arg)
 903 #define hid_crit(hid, fmt, arg...)                      \
 904         dev_crit(&(hid)->dev, fmt, ##arg)
 905 #define hid_alert(hid, fmt, arg...)                     \
 906         dev_alert(&(hid)->dev, fmt, ##arg)
 907 #define hid_err(hid, fmt, arg...)                       \
 908         dev_err(&(hid)->dev, fmt, ##arg)
 909 #define hid_notice(hid, fmt, arg...)                    \
 910         dev_notice(&(hid)->dev, fmt, ##arg)
 911 #define hid_warn(hid, fmt, arg...)                      \
 912         dev_warn(&(hid)->dev, fmt, ##arg)
 913 #define hid_info(hid, fmt, arg...)                      \
 914         dev_info(&(hid)->dev, fmt, ##arg)
 915 #define hid_dbg(hid, fmt, arg...)                       \
 916         dev_dbg(&(hid)->dev, fmt, ##arg)
 917
 918 #endif /* __KERNEL__ */
 919
 920 #endif
 921