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 #define HID_MAX_IDS 256
 397
 398 struct hid_report_enum {
 399         unsigned numbered;
 400         struct list_head report_list;
 401         struct hid_report *report_id_hash[HID_MAX_IDS];
 402 };
 403
 404 #define HID_REPORT_TYPES 3
 405
 406 #define HID_MIN_BUFFER_SIZE     64              /* make sure there is at least a packet size of space */
 407 #define HID_MAX_BUFFER_SIZE     4096            /* 4kb */
 408 #define HID_CONTROL_FIFO_SIZE   256             /* to init devices with >100 reports */
 409 #define HID_OUTPUT_FIFO_SIZE    64
 410
 411 struct hid_control_fifo {
 412         unsigned char dir;
 413         struct hid_report *report;
 414         char *raw_report;
 415 };
 416
 417 struct hid_output_fifo {
 418         struct hid_report *report;
 419         char *raw_report;
 420 };
 421
 422 #define HID_CLAIMED_INPUT       1
 423 #define HID_CLAIMED_HIDDEV      2
 424 #define HID_CLAIMED_HIDRAW      4
 425
 426 #define HID_STAT_ADDED          1
 427 #define HID_STAT_PARSED         2
 428
 429 struct hid_input {
 430         struct list_head list;
 431         struct hid_report *report;
 432         struct input_dev *input;
 433 };
 434
 435 enum hid_type {
 436         HID_TYPE_OTHER = 0,
 437         HID_TYPE_USBMOUSE,
 438         HID_TYPE_USBNONE
 439 };
 440
 441 struct hid_driver;
 442 struct hid_ll_driver;
 443
 444 struct hid_device {                                                     /* device report descriptor */
 445         __u8 *dev_rdesc;
 446         unsigned dev_rsize;
 447         __u8 *rdesc;
 448         unsigned rsize;
 449         struct hid_collection *collection;                              /* List of HID collections */
 450         unsigned collection_size;                                       /* Number of allocated hid_collections */
 451         unsigned maxcollection;                                         /* Number of parsed collections */
 452         unsigned maxapplication;                                        /* Number of applications */
 453         __u16 bus;                                                      /* BUS ID */
 454         __u16 group;                                                    /* Report group */
 455         __u32 vendor;                                                   /* Vendor ID */
 456         __u32 product;                                                  /* Product ID */
 457         __u32 version;                                                  /* HID version */
 458         enum hid_type type;                                             /* device type (mouse, kbd, ...) */
 459         unsigned country;                                               /* HID country */
 460         struct hid_report_enum report_enum[HID_REPORT_TYPES];
 461
 462         struct semaphore driver_lock;                                   /* protects the current driver, except during input */
 463         struct semaphore driver_input_lock;                             /* protects the current driver */
 464         struct device dev;                                              /* device */
 465         struct hid_driver *driver;
 466         struct hid_ll_driver *ll_driver;
 467
 468 #ifdef CONFIG_HID_BATTERY_STRENGTH
 469         /*
 470          * Power supply information for HID devices which report
 471          * battery strength. power_supply is registered iff
 472          * battery.name is non-NULL.
 473          */
 474         struct power_supply battery;
 475         __s32 battery_min;
 476         __s32 battery_max;
 477         __s32 battery_report_type;
 478         __s32 battery_report_id;
 479 #endif
 480
 481         unsigned int status;                                            /* see STAT flags above */
 482         unsigned claimed;                                               /* Claimed by hidinput, hiddev? */
 483         unsigned quirks;                                                /* Various quirks the device can pull on us */
 484         bool io_started;                                                /* Protected by driver_lock. If IO has started */
 485
 486         struct list_head inputs;                                        /* The list of inputs */
 487         void *hiddev;                                                   /* The hiddev structure */
 488         void *hidraw;
 489         int minor;                                                      /* Hiddev minor number */
 490
 491         int open;                                                       /* is the device open by anyone? */
 492         char name[128];                                                 /* Device name */
 493         char phys[64];                                                  /* Device physical location */
 494         char uniq[64];                                                  /* Device unique identifier (serial #) */
 495
 496         void *driver_data;
 497
 498         /* temporary hid_ff handling (until moved to the drivers) */
 499         int (*ff_init)(struct hid_device *);
 500
 501         /* hiddev event handler */
 502         int (*hiddev_connect)(struct hid_device *, unsigned int);
 503         void (*hiddev_disconnect)(struct hid_device *);
 504         void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
 505                                   struct hid_usage *, __s32);
 506         void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
 507
 508         /* handler for raw input (Get_Report) data, used by hidraw */
 509         int (*hid_get_raw_report) (struct hid_device *, unsigned char, __u8 *, size_t, unsigned char);
 510
 511         /* handler for raw output data, used by hidraw */
 512         int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t, unsigned char);
 513
 514         /* debugging support via debugfs */
 515         unsigned short debug;
 516         struct dentry *debug_dir;
 517         struct dentry *debug_rdesc;
 518         struct dentry *debug_events;
 519         struct list_head debug_list;
 520         spinlock_t  debug_list_lock;
 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, g, ven, prod)                                     \
 563         .bus = (b), .group = (g), .vendor = (ven), .product = (prod)
 564 #define HID_USB_DEVICE(ven, prod)                               \
 565         .bus = BUS_USB, .vendor = (ven), .product = (prod)
 566 #define HID_BLUETOOTH_DEVICE(ven, prod)                                 \
 567         .bus = BUS_BLUETOOTH, .vendor = (ven), .product = (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: this hook is called after parsing a report (NULL means nop)
 599  * @report_fixup: called before report descriptor parsing (NULL means nop)
 600  * @input_mapping: invoked on input registering before mapping an usage
 601  * @input_mapped: invoked on input registering after mapping an usage
 602  * @input_configured: invoked just before the device is registered
 603  * @feature_mapping: invoked on feature registering
 604  * @suspend: invoked on suspend (NULL means nop)
 605  * @resume: invoked on resume if device was not reset (NULL means nop)
 606  * @reset_resume: invoked on resume if device was reset (NULL means nop)
 607  *
 608  * probe should return -errno on error, or 0 on success. During probe,
 609  * input will not be passed to raw_event unless hid_device_io_start is
 610  * called.
 611  *
 612  * raw_event and event should return 0 on no action performed, 1 when no
 613  * further processing should be done and negative on error
 614  *
 615  * input_mapping shall return a negative value to completely ignore this usage
 616  * (e.g. doubled or invalid usage), zero to continue with parsing of this
 617  * usage by generic code (no special handling needed) or positive to skip
 618  * generic parsing (needed special handling which was done in the hook already)
 619  * input_mapped shall return negative to inform the layer that this usage
 620  * should not be considered for further processing or zero to notify that
 621  * no processing was performed and should be done in a generic manner
 622  * Both these functions may be NULL which means the same behavior as returning
 623  * zero from them.
 624  */
 625 struct hid_driver {
 626         char *name;
 627         const struct hid_device_id *id_table;
 628
 629         struct list_head dyn_list;
 630         spinlock_t dyn_lock;
 631
 632         int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
 633         void (*remove)(struct hid_device *dev);
 634
 635         const struct hid_report_id *report_table;
 636         int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
 637                         u8 *data, int size);
 638         const struct hid_usage_id *usage_table;
 639         int (*event)(struct hid_device *hdev, struct hid_field *field,
 640                         struct hid_usage *usage, __s32 value);
 641         void (*report)(struct hid_device *hdev, struct hid_report *report);
 642
 643         __u8 *(*report_fixup)(struct hid_device *hdev, __u8 *buf,
 644                         unsigned int *size);
 645
 646         int (*input_mapping)(struct hid_device *hdev,
 647                         struct hid_input *hidinput, struct hid_field *field,
 648                         struct hid_usage *usage, unsigned long **bit, int *max);
 649         int (*input_mapped)(struct hid_device *hdev,
 650                         struct hid_input *hidinput, struct hid_field *field,
 651                         struct hid_usage *usage, unsigned long **bit, int *max);
 652         void (*input_configured)(struct hid_device *hdev,
 653                                  struct hid_input *hidinput);
 654         void (*feature_mapping)(struct hid_device *hdev,
 655                         struct hid_field *field,
 656                         struct hid_usage *usage);
 657 #ifdef CONFIG_PM
 658         int (*suspend)(struct hid_device *hdev, pm_message_t message);
 659         int (*resume)(struct hid_device *hdev);
 660         int (*reset_resume)(struct hid_device *hdev);
 661 #endif
 662 /* private: */
 663         struct device_driver driver;
 664 };
 665
 666 /**
 667  * hid_ll_driver - low level driver callbacks
 668  * @start: called on probe to start the device
 669  * @stop: called on remove
 670  * @open: called by input layer on open
 671  * @close: called by input layer on close
 672  * @hidinput_input_event: event input event (e.g. ff or leds)
 673  * @parse: this method is called only once to parse the device data,
 674  *         shouldn't allocate anything to not leak memory
 675  * @request: send report request to device (e.g. feature report)
 676  * @wait: wait for buffered io to complete (send/recv reports)
 677  * @idle: send idle request to device
 678  */
 679 struct hid_ll_driver {
 680         int (*start)(struct hid_device *hdev);
 681         void (*stop)(struct hid_device *hdev);
 682
 683         int (*open)(struct hid_device *hdev);
 684         void (*close)(struct hid_device *hdev);
 685
 686         int (*power)(struct hid_device *hdev, int level);
 687
 688         int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
 689                         unsigned int code, int value);
 690
 691         int (*parse)(struct hid_device *hdev);
 692
 693         void (*request)(struct hid_device *hdev,
 694                         struct hid_report *report, int reqtype);
 695
 696         int (*wait)(struct hid_device *hdev);
 697         int (*idle)(struct hid_device *hdev, int report, int idle, int reqtype);
 698
 699 };
 700
 701 #define PM_HINT_FULLON  1<<5
 702 #define PM_HINT_NORMAL  1<<1
 703
 704 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
 705 /* We ignore a few input applications that are not widely used */
 706 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || ((a >= 0x000d0002) && (a <= 0x000d0006)))
 707
 708 /* HID core API */
 709
 710 extern int hid_debug;
 711
 712 extern bool hid_ignore(struct hid_device *);
 713 extern int hid_add_device(struct hid_device *);
 714 extern void hid_destroy_device(struct hid_device *);
 715
 716 extern int __must_check __hid_register_driver(struct hid_driver *,
 717                 struct module *, const char *mod_name);
 718
 719 /* use a define to avoid include chaining to get THIS_MODULE & friends */
 720 #define hid_register_driver(driver) \
 721         __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
 722
 723 extern void hid_unregister_driver(struct hid_driver *);
 724
 725 /**
 726  * module_hid_driver() - Helper macro for registering a HID driver
 727  * @__hid_driver: hid_driver struct
 728  *
 729  * Helper macro for HID drivers which do not do anything special in module
 730  * init/exit. This eliminates a lot of boilerplate. Each module may only
 731  * use this macro once, and calling it replaces module_init() and module_exit()
 732  */
 733 #define module_hid_driver(__hid_driver) \
 734         module_driver(__hid_driver, hid_register_driver, \
 735                       hid_unregister_driver)
 736
 737 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
 738 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
 739 extern int hidinput_connect(struct hid_device *hid, unsigned int force);
 740 extern void hidinput_disconnect(struct hid_device *);
 741
 742 int hid_set_field(struct hid_field *, unsigned, __s32);
 743 int hid_input_report(struct hid_device *, int type, u8 *, int, int);
 744 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
 745 struct hid_field *hidinput_get_led_field(struct hid_device *hid);
 746 unsigned int hidinput_count_leds(struct hid_device *hid);
 747 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code);
 748 void hid_output_report(struct hid_report *report, __u8 *data);
 749 u8 *hid_alloc_report_buf(struct hid_report *report, gfp_t flags);
 750 struct hid_device *hid_allocate_device(void);
 751 struct hid_report *hid_register_report(struct hid_device *device, unsigned type, unsigned id);
 752 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
 753 struct hid_report *hid_validate_values(struct hid_device *hid,
 754                                        unsigned int type, unsigned int id,
 755                                        unsigned int field_index,
 756                                        unsigned int report_counts);
 757 int hid_open_report(struct hid_device *device);
 758 int hid_check_keys_pressed(struct hid_device *hid);
 759 int hid_connect(struct hid_device *hid, unsigned int connect_mask);
 760 void hid_disconnect(struct hid_device *hid);
 761 const struct hid_device_id *hid_match_id(struct hid_device *hdev,
 762                                          const struct hid_device_id *id);
 763 s32 hid_snto32(__u32 value, unsigned n);
 764
 765 /**
 766  * hid_device_io_start - enable HID input during probe, remove
 767  *
 768  * @hid - the device
 769  *
 770  * This should only be called during probe or remove and only be
 771  * called by the thread calling probe or remove. It will allow
 772  * incoming packets to be delivered to the driver.
 773  */
 774 static inline void hid_device_io_start(struct hid_device *hid) {
 775         if (hid->io_started) {
 776                 dev_warn(&hid->dev, "io already started");
 777                 return;
 778         }
 779         hid->io_started = true;
 780         up(&hid->driver_input_lock);
 781 }
 782
 783 /**
 784  * hid_device_io_stop - disable HID input during probe, remove
 785  *
 786  * @hid - the device
 787  *
 788  * Should only be called after hid_device_io_start. It will prevent
 789  * incoming packets from going to the driver for the duration of
 790  * probe, remove. If called during probe, packets will still go to the
 791  * driver after probe is complete. This function should only be called
 792  * by the thread calling probe or remove.
 793  */
 794 static inline void hid_device_io_stop(struct hid_device *hid) {
 795         if (!hid->io_started) {
 796                 dev_warn(&hid->dev, "io already stopped");
 797                 return;
 798         }
 799         hid->io_started = false;
 800         down(&hid->driver_input_lock);
 801 }
 802
 803 /**
 804  * hid_map_usage - map usage input bits
 805  *
 806  * @hidinput: hidinput which we are interested in
 807  * @usage: usage to fill in
 808  * @bit: pointer to input->{}bit (out parameter)
 809  * @max: maximal valid usage->code to consider later (out parameter)
 810  * @type: input event type (EV_KEY, EV_REL, ...)
 811  * @c: code which corresponds to this usage and type
 812  */
 813 static inline void hid_map_usage(struct hid_input *hidinput,
 814                 struct hid_usage *usage, unsigned long **bit, int *max,
 815                 __u8 type, __u16 c)
 816 {
 817         struct input_dev *input = hidinput->input;
 818
 819         usage->type = type;
 820         usage->code = c;
 821
 822         switch (type) {
 823         case EV_ABS:
 824                 *bit = input->absbit;
 825                 *max = ABS_MAX;
 826                 break;
 827         case EV_REL:
 828                 *bit = input->relbit;
 829                 *max = REL_MAX;
 830                 break;
 831         case EV_KEY:
 832                 *bit = input->keybit;
 833                 *max = KEY_MAX;
 834                 break;
 835         case EV_LED:
 836                 *bit = input->ledbit;
 837                 *max = LED_MAX;
 838                 break;
 839         }
 840 }
 841
 842 /**
 843  * hid_map_usage_clear - map usage input bits and clear the input bit
 844  *
 845  * The same as hid_map_usage, except the @c bit is also cleared in supported
 846  * bits (@bit).
 847  */
 848 static inline void hid_map_usage_clear(struct hid_input *hidinput,
 849                 struct hid_usage *usage, unsigned long **bit, int *max,
 850                 __u8 type, __u16 c)
 851 {
 852         hid_map_usage(hidinput, usage, bit, max, type, c);
 853         clear_bit(c, *bit);
 854 }
 855
 856 /**
 857  * hid_parse - parse HW reports
 858  *
 859  * @hdev: hid device
 860  *
 861  * Call this from probe after you set up the device (if needed). Your
 862  * report_fixup will be called (if non-NULL) after reading raw report from
 863  * device before passing it to hid layer for real parsing.
 864  */
 865 static inline int __must_check hid_parse(struct hid_device *hdev)
 866 {
 867         return hid_open_report(hdev);
 868 }
 869
 870 /**
 871  * hid_hw_start - start underlaying HW
 872  *
 873  * @hdev: hid device
 874  * @connect_mask: which outputs to connect, see HID_CONNECT_*
 875  *
 876  * Call this in probe function *after* hid_parse. This will setup HW buffers
 877  * and start the device (if not deffered to device open). hid_hw_stop must be
 878  * called if this was successful.
 879  */
 880 static inline int __must_check hid_hw_start(struct hid_device *hdev,
 881                 unsigned int connect_mask)
 882 {
 883         int ret = hdev->ll_driver->start(hdev);
 884         if (ret || !connect_mask)
 885                 return ret;
 886         ret = hid_connect(hdev, connect_mask);
 887         if (ret)
 888                 hdev->ll_driver->stop(hdev);
 889         return ret;
 890 }
 891
 892 /**
 893  * hid_hw_stop - stop underlaying HW
 894  *
 895  * @hdev: hid device
 896  *
 897  * This is usually called from remove function or from probe when something
 898  * failed and hid_hw_start was called already.
 899  */
 900 static inline void hid_hw_stop(struct hid_device *hdev)
 901 {
 902         hid_disconnect(hdev);
 903         hdev->ll_driver->stop(hdev);
 904 }
 905
 906 /**
 907  * hid_hw_open - signal underlaying HW to start delivering events
 908  *
 909  * @hdev: hid device
 910  *
 911  * Tell underlying HW to start delivering events from the device.
 912  * This function should be called sometime after successful call
 913  * to hid_hiw_start().
 914  */
 915 static inline int __must_check hid_hw_open(struct hid_device *hdev)
 916 {
 917         return hdev->ll_driver->open(hdev);
 918 }
 919
 920 /**
 921  * hid_hw_close - signal underlaying HW to stop delivering events
 922  *
 923  * @hdev: hid device
 924  *
 925  * This function indicates that we are not interested in the events
 926  * from this device anymore. Delivery of events may or may not stop,
 927  * depending on the number of users still outstanding.
 928  */
 929 static inline void hid_hw_close(struct hid_device *hdev)
 930 {
 931         hdev->ll_driver->close(hdev);
 932 }
 933
 934 /**
 935  * hid_hw_power - requests underlying HW to go into given power mode
 936  *
 937  * @hdev: hid device
 938  * @level: requested power level (one of %PM_HINT_* defines)
 939  *
 940  * This function requests underlying hardware to enter requested power
 941  * mode.
 942  */
 943
 944 static inline int hid_hw_power(struct hid_device *hdev, int level)
 945 {
 946         return hdev->ll_driver->power ? hdev->ll_driver->power(hdev, level) : 0;
 947 }
 948
 949
 950 /**
 951  * hid_hw_request - send report request to device
 952  *
 953  * @hdev: hid device
 954  * @report: report to send
 955  * @reqtype: hid request type
 956  */
 957 static inline void hid_hw_request(struct hid_device *hdev,
 958                                   struct hid_report *report, int reqtype)
 959 {
 960         if (hdev->ll_driver->request)
 961                 hdev->ll_driver->request(hdev, report, reqtype);
 962 }
 963
 964 /**
 965  * hid_hw_idle - send idle request to device
 966  *
 967  * @hdev: hid device
 968  * @report: report to control
 969  * @idle: idle state
 970  * @reqtype: hid request type
 971  */
 972 static inline int hid_hw_idle(struct hid_device *hdev, int report, int idle,
 973                 int reqtype)
 974 {
 975         if (hdev->ll_driver->idle)
 976                 return hdev->ll_driver->idle(hdev, report, idle, reqtype);
 977
 978         return 0;
 979 }
 980
 981 /**
 982  * hid_hw_wait - wait for buffered io to complete
 983  *
 984  * @hdev: hid device
 985  */
 986 static inline void hid_hw_wait(struct hid_device *hdev)
 987 {
 988         if (hdev->ll_driver->wait)
 989                 hdev->ll_driver->wait(hdev);
 990 }
 991
 992 int hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
 993                 int interrupt);
 994
 995 /* HID quirks API */
 996 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
 997 int usbhid_quirks_init(char **quirks_param);
 998 void usbhid_quirks_exit(void);
 999 void usbhid_set_leds(struct hid_device *hid);
1000
1001 #ifdef CONFIG_HID_PID
1002 int hid_pidff_init(struct hid_device *hid);
1003 #else
1004 #define hid_pidff_init NULL
1005 #endif
1006
1007 #define dbg_hid(format, arg...)                                         \
1008 do {                                                                    \
1009         if (hid_debug)                                                  \
1010                 printk(KERN_DEBUG "%s: " format, __FILE__, ##arg);      \
1011 } while (0)
1012
1013 #define hid_printk(level, hid, fmt, arg...)             \
1014         dev_printk(level, &(hid)->dev, fmt, ##arg)
1015 #define hid_emerg(hid, fmt, arg...)                     \
1016         dev_emerg(&(hid)->dev, fmt, ##arg)
1017 #define hid_crit(hid, fmt, arg...)                      \
1018         dev_crit(&(hid)->dev, fmt, ##arg)
1019 #define hid_alert(hid, fmt, arg...)                     \
1020         dev_alert(&(hid)->dev, fmt, ##arg)
1021 #define hid_err(hid, fmt, arg...)                       \
1022         dev_err(&(hid)->dev, fmt, ##arg)
1023 #define hid_notice(hid, fmt, arg...)                    \
1024         dev_notice(&(hid)->dev, fmt, ##arg)
1025 #define hid_warn(hid, fmt, arg...)                      \
1026         dev_warn(&(hid)->dev, fmt, ##arg)
1027 #define hid_info(hid, fmt, arg...)                      \
1028         dev_info(&(hid)->dev, fmt, ##arg)
1029 #define hid_dbg(hid, fmt, arg...)                       \
1030         dev_dbg(&(hid)->dev, fmt, ##arg)
1031
1032 #endif