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 /*
 242  * HID report types --- Ouch! HID spec says 1 2 3!
 243  */
 244
 245 #define HID_INPUT_REPORT        0
 246 #define HID_OUTPUT_REPORT       1
 247 #define HID_FEATURE_REPORT      2
 248
 249 /*
 250  * HID device quirks.
 251  */
 252
 253 /*
 254  * Increase this if you need to configure more HID quirks at module load time
 255  */
 256 #define MAX_USBHID_BOOT_QUIRKS 4
 257
 258 #define HID_QUIRK_INVERT                        0x00000001
 259 #define HID_QUIRK_NOTOUCH                       0x00000002
 260 #define HID_QUIRK_NOGET                         0x00000008
 261 #define HID_QUIRK_HIDDEV                        0x00000010
 262 #define HID_QUIRK_BADPAD                        0x00000020
 263 #define HID_QUIRK_MULTI_INPUT                   0x00000040
 264 #define HID_QUIRK_SKIP_OUTPUT_REPORTS           0x00010000
 265 #define HID_QUIRK_SONY_PS3_CONTROLLER           0x00040000
 266 #define HID_QUIRK_RESET_LEDS                    0x00100000
 267 #define HID_QUIRK_HIDINPUT                      0x00200000
 268 #define HID_QUIRK_IGNORE_HIDINPUT               0x01000000
 269 #define HID_QUIRK_FULLSPEED_INTERVAL            0x10000000
 270
 271 /*
 272  * Separate quirks for runtime report descriptor fixup
 273  */
 274
 275 #define HID_QUIRK_RDESC_SAMSUNG_REMOTE          0x00000040
 276
 277 /*
 278  * This is the global environment of the parser. This information is
 279  * persistent for main-items. The global environment can be saved and
 280  * restored with PUSH/POP statements.
 281  */
 282
 283 struct hid_global {
 284         unsigned usage_page;
 285         __s32    logical_minimum;
 286         __s32    logical_maximum;
 287         __s32    physical_minimum;
 288         __s32    physical_maximum;
 289         __s32    unit_exponent;
 290         unsigned unit;
 291         unsigned report_id;
 292         unsigned report_size;
 293         unsigned report_count;
 294 };
 295
 296 /*
 297  * This is the local environment. It is persistent up the next main-item.
 298  */
 299
 300 #define HID_MAX_USAGES                  12288
 301 #define HID_DEFAULT_NUM_COLLECTIONS     16
 302
 303 struct hid_local {
 304         unsigned usage[HID_MAX_USAGES]; /* usage array */
 305         unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
 306         unsigned usage_index;
 307         unsigned usage_minimum;
 308         unsigned delimiter_depth;
 309         unsigned delimiter_branch;
 310 };
 311
 312 /*
 313  * This is the collection stack. We climb up the stack to determine
 314  * application and function of each field.
 315  */
 316
 317 struct hid_collection {
 318         unsigned type;
 319         unsigned usage;
 320         unsigned level;
 321 };
 322
 323 struct hid_usage {
 324         unsigned  hid;                  /* hid usage code */
 325         unsigned  collection_index;     /* index into collection array */
 326         /* hidinput data */
 327         __u16     code;                 /* input driver code */
 328         __u8      type;                 /* input driver type */
 329         __s8      hat_min;              /* hat switch fun */
 330         __s8      hat_max;              /* ditto */
 331         __s8      hat_dir;              /* ditto */
 332 };
 333
 334 struct hid_input;
 335
 336 struct hid_field {
 337         unsigned  physical;             /* physical usage for this field */
 338         unsigned  logical;              /* logical usage for this field */
 339         unsigned  application;          /* application usage for this field */
 340         struct hid_usage *usage;        /* usage table for this function */
 341         unsigned  maxusage;             /* maximum usage index */
 342         unsigned  flags;                /* main-item flags (i.e. volatile,array,constant) */
 343         unsigned  report_offset;        /* bit offset in the report */
 344         unsigned  report_size;          /* size of this field in the report */
 345         unsigned  report_count;         /* number of this field in the report */
 346         unsigned  report_type;          /* (input,output,feature) */
 347         __s32    *value;                /* last known value(s) */
 348         __s32     logical_minimum;
 349         __s32     logical_maximum;
 350         __s32     physical_minimum;
 351         __s32     physical_maximum;
 352         __s32     unit_exponent;
 353         unsigned  unit;
 354         struct hid_report *report;      /* associated report */
 355         unsigned index;                 /* index into report->field[] */
 356         /* hidinput data */
 357         struct hid_input *hidinput;     /* associated input structure */
 358         __u16 dpad;                     /* dpad input code */
 359 };
 360
 361 #define HID_MAX_FIELDS 64
 362
 363 struct hid_report {
 364         struct list_head list;
 365         unsigned id;                                    /* id of this report */
 366         unsigned type;                                  /* report type */
 367         struct hid_field *field[HID_MAX_FIELDS];        /* fields of the report */
 368         unsigned maxfield;                              /* maximum valid field index */
 369         unsigned size;                                  /* size of the report (bits) */
 370         struct hid_device *device;                      /* associated device */
 371 };
 372
 373 struct hid_report_enum {
 374         unsigned numbered;
 375         struct list_head report_list;
 376         struct hid_report *report_id_hash[256];
 377 };
 378
 379 #define HID_REPORT_TYPES 3
 380
 381 #define HID_MIN_BUFFER_SIZE     64              /* make sure there is at least a packet size of space */
 382 #define HID_MAX_BUFFER_SIZE     4096            /* 4kb */
 383 #define HID_CONTROL_FIFO_SIZE   256             /* to init devices with >100 reports */
 384 #define HID_OUTPUT_FIFO_SIZE    64
 385
 386 struct hid_control_fifo {
 387         unsigned char dir;
 388         struct hid_report *report;
 389 };
 390
 391 #define HID_CLAIMED_INPUT       1
 392 #define HID_CLAIMED_HIDDEV      2
 393 #define HID_CLAIMED_HIDRAW      4
 394
 395 #define HID_STAT_ADDED          1
 396 #define HID_STAT_PARSED         2
 397
 398 #define HID_CTRL_RUNNING        1
 399 #define HID_OUT_RUNNING         2
 400 #define HID_IN_RUNNING          3
 401 #define HID_RESET_PENDING       4
 402 #define HID_SUSPENDED           5
 403 #define HID_CLEAR_HALT          6
 404 #define HID_DISCONNECTED        7
 405
 406 struct hid_input {
 407         struct list_head list;
 408         struct hid_report *report;
 409         struct input_dev *input;
 410 };
 411
 412 struct hid_driver;
 413 struct hid_ll_driver;
 414
 415 struct hid_device {                                                     /* device report descriptor */
 416         __u8 *rdesc;
 417         unsigned rsize;
 418         struct hid_collection *collection;                              /* List of HID collections */
 419         unsigned collection_size;                                       /* Number of allocated hid_collections */
 420         unsigned maxcollection;                                         /* Number of parsed collections */
 421         unsigned maxapplication;                                        /* Number of applications */
 422         __u16 bus;                                                      /* BUS ID */
 423         __u32 vendor;                                                   /* Vendor ID */
 424         __u32 product;                                                  /* Product ID */
 425         __u32 version;                                                  /* HID version */
 426         unsigned country;                                               /* HID country */
 427         struct hid_report_enum report_enum[HID_REPORT_TYPES];
 428
 429         struct device dev;                                              /* device */
 430         struct hid_driver *driver;
 431         struct hid_ll_driver *ll_driver;
 432
 433         unsigned int status;                                            /* see STAT flags above */
 434         unsigned claimed;                                               /* Claimed by hidinput, hiddev? */
 435         unsigned quirks;                                                /* Various quirks the device can pull on us */
 436
 437         struct list_head inputs;                                        /* The list of inputs */
 438         void *hiddev;                                                   /* The hiddev structure */
 439         void *hidraw;
 440         int minor;                                                      /* Hiddev minor number */
 441
 442         int open;                                                       /* is the device open by anyone? */
 443         char name[128];                                                 /* Device name */
 444         char phys[64];                                                  /* Device physical location */
 445         char uniq[64];                                                  /* Device unique identifier (serial #) */
 446
 447         void *driver_data;
 448
 449         /* hiddev event handler */
 450         void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
 451                                   struct hid_usage *, __s32);
 452         void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
 453
 454         /* handler for raw output data, used by hidraw */
 455         int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t);
 456 };
 457
 458 static inline void *hid_get_drvdata(struct hid_device *hdev)
 459 {
 460         return dev_get_drvdata(&hdev->dev);
 461 }
 462
 463 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
 464 {
 465         dev_set_drvdata(&hdev->dev, data);
 466 }
 467
 468 #define HID_GLOBAL_STACK_SIZE 4
 469 #define HID_COLLECTION_STACK_SIZE 4
 470
 471 struct hid_parser {
 472         struct hid_global     global;
 473         struct hid_global     global_stack[HID_GLOBAL_STACK_SIZE];
 474         unsigned              global_stack_ptr;
 475         struct hid_local      local;
 476         unsigned              collection_stack[HID_COLLECTION_STACK_SIZE];
 477         unsigned              collection_stack_ptr;
 478         struct hid_device    *device;
 479 };
 480
 481 struct hid_class_descriptor {
 482         __u8  bDescriptorType;
 483         __le16 wDescriptorLength;
 484 } __attribute__ ((packed));
 485
 486 struct hid_descriptor {
 487         __u8  bLength;
 488         __u8  bDescriptorType;
 489         __le16 bcdHID;
 490         __u8  bCountryCode;
 491         __u8  bNumDescriptors;
 492
 493         struct hid_class_descriptor desc[1];
 494 } __attribute__ ((packed));
 495
 496 #define HID_DEVICE(b, ven, prod) \
 497         .bus = (b), \
 498         .vendor = (ven), .product = (prod)
 499
 500 #define HID_USB_DEVICE(ven, prod)       HID_DEVICE(BUS_USB, ven, prod)
 501 #define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
 502
 503 #define HID_REPORT_ID(rep) \
 504         .report_type = (rep)
 505 #define HID_USAGE_ID(uhid, utype, ucode) \
 506         .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
 507 /* we don't want to catch types and codes equal to 0 */
 508 #define HID_TERMINATOR          (HID_ANY_ID - 1)
 509
 510 struct hid_report_id {
 511         __u32 report_type;
 512 };
 513 struct hid_usage_id {
 514         __u32 usage_hid;
 515         __u32 usage_type;
 516         __u32 usage_code;
 517 };
 518
 519 /**
 520  * struct hid_driver
 521  * @name: driver name (e.g. "Footech_bar-wheel")
 522  * @id_table: which devices is this driver for (must be non-NULL for probe
 523  *            to be called)
 524  * @probe: new device inserted
 525  * @remove: device removed (NULL if not a hot-plug capable driver)
 526  * @report_table: on which reports to call raw_event (NULL means all)
 527  * @raw_event: if report in report_table, this hook is called (NULL means nop)
 528  * @usage_table: on which events to call event (NULL means all)
 529  * @event: if usage in usage_table, this hook is called (NULL means nop)
 530  * @report_fixup: called before report descriptor parsing (NULL means nop)
 531  * @input_mapping: invoked on input registering before mapping an usage
 532  * @input_mapped: invoked on input registering after mapping an usage
 533  *
 534  * raw_event and event should return 0 on no action performed, 1 when no
 535  * further processing should be done and negative on error
 536  *
 537  * input_mapping shall return a negative value to completely ignore this usage
 538  * (e.g. doubled or invalid usage), zero to continue with parsing of this
 539  * usage by generic code (no special handling needed) or positive to skip
 540  * generic parsing (needed special handling which was done in the hook already)
 541  * input_mapped shall return negative to inform the layer that this usage
 542  * should not be considered for further processing or zero to notify that
 543  * no processing was performed and should be done in a generic manner
 544  * Both these functions may be NULL which means the same behavior as returning
 545  * zero from them.
 546  */
 547 struct hid_driver {
 548         char *name;
 549         const struct hid_device_id *id_table;
 550
 551         int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
 552         void (*remove)(struct hid_device *dev);
 553
 554         const struct hid_report_id *report_table;
 555         int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
 556                         u8 *data, int size);
 557         const struct hid_usage_id *usage_table;
 558         int (*event)(struct hid_device *hdev, struct hid_field *field,
 559                         struct hid_usage *usage, __s32 value);
 560
 561         void (*report_fixup)(struct hid_device *hdev, __u8 *buf,
 562                         unsigned int size);
 563
 564         int (*input_mapping)(struct hid_device *hdev,
 565                         struct hid_input *hidinput, struct hid_field *field,
 566                         struct hid_usage *usage, unsigned long **bit, int *max);
 567         int (*input_mapped)(struct hid_device *hdev,
 568                         struct hid_input *hidinput, struct hid_field *field,
 569                         struct hid_usage *usage, unsigned long **bit, int *max);
 570 /* private: */
 571         struct device_driver driver;
 572 };
 573
 574 /**
 575  * hid_ll_driver - low level driver callbacks
 576  * @start: called on probe to start the device
 577  * @stop: called on remove
 578  * @open: called by input layer on open
 579  * @close: called by input layer on close
 580  * @hidinput_input_event: event input event (e.g. ff or leds)
 581  * @parse: this method is called only once to parse the device data,
 582  *         shouldn't allocate anything to not leak memory
 583  */
 584 struct hid_ll_driver {
 585         int (*start)(struct hid_device *hdev);
 586         void (*stop)(struct hid_device *hdev);
 587
 588         int (*open)(struct hid_device *hdev);
 589         void (*close)(struct hid_device *hdev);
 590
 591         int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
 592                         unsigned int code, int value);
 593
 594         int (*parse)(struct hid_device *hdev);
 595 };
 596
 597 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
 598 /* We ignore a few input applications that are not widely used */
 599 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || (a == 0x000d0002))
 600
 601 /* HID core API */
 602
 603 #ifdef CONFIG_HID_DEBUG
 604 extern int hid_debug;
 605 #endif
 606
 607 extern int hid_add_device(struct hid_device *);
 608 extern void hid_destroy_device(struct hid_device *);
 609
 610 extern int __must_check __hid_register_driver(struct hid_driver *,
 611                 struct module *, const char *mod_name);
 612 static inline int __must_check hid_register_driver(struct hid_driver *driver)
 613 {
 614         return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
 615 }
 616 extern void hid_unregister_driver(struct hid_driver *);
 617
 618 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
 619 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
 620 extern int hidinput_connect(struct hid_device *);
 621 extern void hidinput_disconnect(struct hid_device *);
 622
 623 int hid_set_field(struct hid_field *, unsigned, __s32);
 624 int hid_input_report(struct hid_device *, int type, u8 *, int, int);
 625 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
 626 int hidinput_mapping_quirks(struct hid_usage *, struct hid_input *,
 627                 unsigned long **, int *);
 628 int hidinput_event_quirks(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
 629 void hid_output_report(struct hid_report *report, __u8 *data);
 630 struct hid_device *hid_allocate_device(void);
 631 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
 632
 633 /**
 634  * hid_map_usage - map usage input bits
 635  *
 636  * @hidinput: hidinput which we are interested in
 637  * @usage: usage to fill in
 638  * @bit: pointer to input->{}bit (out parameter)
 639  * @max: maximal valid usage->code to consider later (out parameter)
 640  * @type: input event type (EV_KEY, EV_REL, ...)
 641  * @c: code which corresponds to this usage and type
 642  */
 643 static inline void hid_map_usage(struct hid_input *hidinput,
 644                 struct hid_usage *usage, unsigned long **bit, int *max,
 645                 __u8 type, __u16 c)
 646 {
 647         struct input_dev *input = hidinput->input;
 648
 649         usage->type = type;
 650         usage->code = c;
 651
 652         switch (type) {
 653         case EV_ABS:
 654                 *bit = input->absbit;
 655                 *max = ABS_MAX;
 656                 break;
 657         case EV_REL:
 658                 *bit = input->relbit;
 659                 *max = REL_MAX;
 660                 break;
 661         case EV_KEY:
 662                 *bit = input->keybit;
 663                 *max = KEY_MAX;
 664                 break;
 665         case EV_LED:
 666                 *bit = input->ledbit;
 667                 *max = LED_MAX;
 668                 break;
 669         }
 670 }
 671
 672 /**
 673  * hid_map_usage_clear - map usage input bits and clear the input bit
 674  *
 675  * The same as hid_map_usage, except the @c bit is also cleared in supported
 676  * bits (@bit).
 677  */
 678 static inline void hid_map_usage_clear(struct hid_input *hidinput,
 679                 struct hid_usage *usage, unsigned long **bit, int *max,
 680                 __u8 type, __u16 c)
 681 {
 682         hid_map_usage(hidinput, usage, bit, max, type, c);
 683         clear_bit(c, *bit);
 684 }
 685
 686 /**
 687  * hid_parse - parse HW reports
 688  *
 689  * @hdev: hid device
 690  *
 691  * Call this from probe after you set up the device (if needed). Your
 692  * report_fixup will be called (if non-NULL) after reading raw report from
 693  * device before passing it to hid layer for real parsing.
 694  */
 695 static inline int __must_check hid_parse(struct hid_device *hdev)
 696 {
 697         int ret;
 698
 699         if (hdev->status & HID_STAT_PARSED)
 700                 return 0;
 701
 702         ret = hdev->ll_driver->parse(hdev);
 703         if (!ret)
 704                 hdev->status |= HID_STAT_PARSED;
 705
 706         return ret;
 707 }
 708
 709 /**
 710  * hid_hw_start - start underlaying HW
 711  *
 712  * @hdev: hid device
 713  *
 714  * Call this in probe function *after* hid_parse. This will setup HW buffers
 715  * and start the device (if not deffered to device open). hid_hw_stop must be
 716  * called if this was successfull.
 717  */
 718 static inline int __must_check hid_hw_start(struct hid_device *hdev)
 719 {
 720         return hdev->ll_driver->start(hdev);
 721 }
 722
 723 /**
 724  * hid_hw_stop - stop underlaying HW
 725  *
 726  * @hdev: hid device
 727  *
 728  * This is usually called from remove function or from probe when something
 729  * failed and hid_hw_start was called already.
 730  */
 731 static inline void hid_hw_stop(struct hid_device *hdev)
 732 {
 733         hdev->ll_driver->stop(hdev);
 734 }
 735
 736 void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
 737                 int interrupt);
 738
 739 extern int hid_generic_init(void);
 740 extern void hid_generic_exit(void);
 741
 742 /* HID quirks API */
 743 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
 744 int usbhid_quirks_init(char **quirks_param);
 745 void usbhid_quirks_exit(void);
 746 void usbhid_fixup_report_descriptor(const u16, const u16, char *, unsigned, char **);
 747
 748 #ifdef CONFIG_HID_FF
 749 int hid_ff_init(struct hid_device *hid);
 750
 751 int hid_lgff_init(struct hid_device *hid);
 752 int hid_lg2ff_init(struct hid_device *hid);
 753 int hid_plff_init(struct hid_device *hid);
 754 int hid_tmff_init(struct hid_device *hid);
 755 int hid_zpff_init(struct hid_device *hid);
 756 #ifdef CONFIG_HID_PID
 757 int hid_pidff_init(struct hid_device *hid);
 758 #else
 759 static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
 760 #endif
 761
 762 #else
 763 static inline int hid_ff_init(struct hid_device *hid) { return -1; }
 764 #endif
 765
 766 #ifdef CONFIG_HID_DEBUG
 767 #define dbg_hid(format, arg...) if (hid_debug) \
 768                                 printk(KERN_DEBUG "%s: " format ,\
 769                                 __FILE__ , ## arg)
 770 #define dbg_hid_line(format, arg...) if (hid_debug) \
 771                                 printk(format, ## arg)
 772 #else
 773 static inline int __attribute__((format(printf, 1, 2)))
 774 dbg_hid(const char *fmt, ...)
 775 {
 776         return 0;
 777 }
 778 #define dbg_hid_line dbg_hid
 779 #endif /* HID_DEBUG */
 780
 781 #define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
 782                 __FILE__ , ## arg)
 783 #endif /* HID_FF */
 784
 785 #ifdef CONFIG_HID_COMPAT
 786 #define HID_COMPAT_LOAD_DRIVER(name)    \
 787 void hid_compat_##name(void) { }        \
 788 EXPORT_SYMBOL(hid_compat_##name)
 789 #else
 790 #define HID_COMPAT_LOAD_DRIVER(name)
 791 #endif /* HID_COMPAT */
 792 #define HID_COMPAT_CALL_DRIVER(name)    do {    \
 793         extern void hid_compat_##name(void);    \
 794         hid_compat_##name();                    \
 795 } while (0)
 796
 797 #endif
 798