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