drivers/usb/input/hid.h

   1 #ifndef __HID_H
   2 #define __HID_H
   3
   4 /*
   5  * $Id: hid.h,v 1.24 2001/12/27 10:37:41 vojtech Exp $
   6  *
   7  *  Copyright (c) 1999 Andreas Gal
   8  *  Copyright (c) 2000-2001 Vojtech Pavlik
   9  */
  10
  11 /*
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  25  *
  26  * Should you need to contact me, the author, you can do so either by
  27  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  28  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  29  */
  30
  31 #include <linux/types.h>
  32 #include <linux/slab.h>
  33 #include <linux/list.h>
  34
  35 /*
  36  * USB HID (Human Interface Device) interface class code
  37  */
  38
  39 #define USB_INTERFACE_CLASS_HID         3
  40
  41 /*
  42  * HID class requests
  43  */
  44
  45 #define HID_REQ_GET_REPORT              0x01
  46 #define HID_REQ_GET_IDLE                0x02
  47 #define HID_REQ_GET_PROTOCOL            0x03
  48 #define HID_REQ_SET_REPORT              0x09
  49 #define HID_REQ_SET_IDLE                0x0A
  50 #define HID_REQ_SET_PROTOCOL            0x0B
  51
  52 /*
  53  * HID class descriptor types
  54  */
  55
  56 #define HID_DT_HID                      (USB_TYPE_CLASS | 0x01)
  57 #define HID_DT_REPORT                   (USB_TYPE_CLASS | 0x02)
  58 #define HID_DT_PHYSICAL                 (USB_TYPE_CLASS | 0x03)
  59
  60 /*
  61  * We parse each description item into this structure. Short items data
  62  * values are expanded to 32-bit signed int, long items contain a pointer
  63  * into the data area.
  64  */
  65
  66 struct hid_item {
  67         unsigned  format;
  68         __u8      size;
  69         __u8      type;
  70         __u8      tag;
  71         union {
  72             __u8   u8;
  73             __s8   s8;
  74             __u16  u16;
  75             __s16  s16;
  76             __u32  u32;
  77             __s32  s32;
  78             __u8  *longdata;
  79         } data;
  80 };
  81
  82 /*
  83  * HID report item format
  84  */
  85
  86 #define HID_ITEM_FORMAT_SHORT   0
  87 #define HID_ITEM_FORMAT_LONG    1
  88
  89 /*
  90  * Special tag indicating long items
  91  */
  92
  93 #define HID_ITEM_TAG_LONG       15
  94
  95 /*
  96  * HID report descriptor item type (prefix bit 2,3)
  97  */
  98
  99 #define HID_ITEM_TYPE_MAIN              0
 100 #define HID_ITEM_TYPE_GLOBAL            1
 101 #define HID_ITEM_TYPE_LOCAL             2
 102 #define HID_ITEM_TYPE_RESERVED          3
 103
 104 /*
 105  * HID report descriptor main item tags
 106  */
 107
 108 #define HID_MAIN_ITEM_TAG_INPUT                 8
 109 #define HID_MAIN_ITEM_TAG_OUTPUT                9
 110 #define HID_MAIN_ITEM_TAG_FEATURE               11
 111 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION      10
 112 #define HID_MAIN_ITEM_TAG_END_COLLECTION        12
 113
 114 /*
 115  * HID report descriptor main item contents
 116  */
 117
 118 #define HID_MAIN_ITEM_CONSTANT          0x001
 119 #define HID_MAIN_ITEM_VARIABLE          0x002
 120 #define HID_MAIN_ITEM_RELATIVE          0x004
 121 #define HID_MAIN_ITEM_WRAP              0x008
 122 #define HID_MAIN_ITEM_NONLINEAR         0x010
 123 #define HID_MAIN_ITEM_NO_PREFERRED      0x020
 124 #define HID_MAIN_ITEM_NULL_STATE        0x040
 125 #define HID_MAIN_ITEM_VOLATILE          0x080
 126 #define HID_MAIN_ITEM_BUFFERED_BYTE     0x100
 127
 128 /*
 129  * HID report descriptor collection item types
 130  */
 131
 132 #define HID_COLLECTION_PHYSICAL         0
 133 #define HID_COLLECTION_APPLICATION      1
 134 #define HID_COLLECTION_LOGICAL          2
 135
 136 /*
 137  * HID report descriptor global item tags
 138  */
 139
 140 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE          0
 141 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM     1
 142 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM     2
 143 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM    3
 144 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM    4
 145 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT       5
 146 #define HID_GLOBAL_ITEM_TAG_UNIT                6
 147 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE         7
 148 #define HID_GLOBAL_ITEM_TAG_REPORT_ID           8
 149 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT        9
 150 #define HID_GLOBAL_ITEM_TAG_PUSH                10
 151 #define HID_GLOBAL_ITEM_TAG_POP                 11
 152
 153 /*
 154  * HID report descriptor local item tags
 155  */
 156
 157 #define HID_LOCAL_ITEM_TAG_USAGE                0
 158 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM        1
 159 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM        2
 160 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX     3
 161 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM   4
 162 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM   5
 163 #define HID_LOCAL_ITEM_TAG_STRING_INDEX         7
 164 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM       8
 165 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM       9
 166 #define HID_LOCAL_ITEM_TAG_DELIMITER            10
 167
 168 /*
 169  * HID usage tables
 170  */
 171
 172 #define HID_USAGE_PAGE          0xffff0000
 173
 174 #define HID_UP_UNDEFINED        0x00000000
 175 #define HID_UP_GENDESK          0x00010000
 176 #define HID_UP_KEYBOARD         0x00070000
 177 #define HID_UP_LED              0x00080000
 178 #define HID_UP_BUTTON           0x00090000
 179 #define HID_UP_ORDINAL          0x000a0000
 180 #define HID_UP_CONSUMER         0x000c0000
 181 #define HID_UP_DIGITIZER        0x000d0000
 182 #define HID_UP_PID              0x000f0000
 183 #define HID_UP_HPVENDOR         0xff7f0000
 184 #define HID_UP_MSVENDOR         0xff000000
 185
 186 #define HID_USAGE               0x0000ffff
 187
 188 #define HID_GD_POINTER          0x00010001
 189 #define HID_GD_MOUSE            0x00010002
 190 #define HID_GD_JOYSTICK         0x00010004
 191 #define HID_GD_GAMEPAD          0x00010005
 192 #define HID_GD_KEYBOARD         0x00010006
 193 #define HID_GD_KEYPAD           0x00010007
 194 #define HID_GD_MULTIAXIS        0x00010008
 195 #define HID_GD_X                0x00010030
 196 #define HID_GD_Y                0x00010031
 197 #define HID_GD_Z                0x00010032
 198 #define HID_GD_RX               0x00010033
 199 #define HID_GD_RY               0x00010034
 200 #define HID_GD_RZ               0x00010035
 201 #define HID_GD_SLIDER           0x00010036
 202 #define HID_GD_DIAL             0x00010037
 203 #define HID_GD_WHEEL            0x00010038
 204 #define HID_GD_HATSWITCH        0x00010039
 205 #define HID_GD_BUFFER           0x0001003a
 206 #define HID_GD_BYTECOUNT        0x0001003b
 207 #define HID_GD_MOTION           0x0001003c
 208 #define HID_GD_START            0x0001003d
 209 #define HID_GD_SELECT           0x0001003e
 210 #define HID_GD_VX               0x00010040
 211 #define HID_GD_VY               0x00010041
 212 #define HID_GD_VZ               0x00010042
 213 #define HID_GD_VBRX             0x00010043
 214 #define HID_GD_VBRY             0x00010044
 215 #define HID_GD_VBRZ             0x00010045
 216 #define HID_GD_VNO              0x00010046
 217 #define HID_GD_FEATURE          0x00010047
 218 #define HID_GD_UP               0x00010090
 219 #define HID_GD_DOWN             0x00010091
 220 #define HID_GD_RIGHT            0x00010092
 221 #define HID_GD_LEFT             0x00010093
 222
 223 /*
 224  * HID report types --- Ouch! HID spec says 1 2 3!
 225  */
 226
 227 #define HID_INPUT_REPORT        0
 228 #define HID_OUTPUT_REPORT       1
 229 #define HID_FEATURE_REPORT      2
 230
 231 /*
 232  * HID device quirks.
 233  */
 234
 235 #define HID_QUIRK_INVERT                        0x001
 236 #define HID_QUIRK_NOTOUCH                       0x002
 237 #define HID_QUIRK_IGNORE                        0x004
 238 #define HID_QUIRK_NOGET                         0x008
 239 #define HID_QUIRK_HIDDEV                        0x010
 240 #define HID_QUIRK_BADPAD                        0x020
 241 #define HID_QUIRK_MULTI_INPUT                   0x040
 242 #define HID_QUIRK_2WHEEL_MOUSE_HACK_7           0x080
 243 #define HID_QUIRK_2WHEEL_MOUSE_HACK_5           0x100
 244 #define HID_QUIRK_2WHEEL_MOUSE_HACK_ON          0x200
 245
 246 /*
 247  * This is the global environment of the parser. This information is
 248  * persistent for main-items. The global environment can be saved and
 249  * restored with PUSH/POP statements.
 250  */
 251
 252 struct hid_global {
 253         unsigned usage_page;
 254         __s32    logical_minimum;
 255         __s32    logical_maximum;
 256         __s32    physical_minimum;
 257         __s32    physical_maximum;
 258         __s32    unit_exponent;
 259         unsigned unit;
 260         unsigned report_id;
 261         unsigned report_size;
 262         unsigned report_count;
 263 };
 264
 265 /*
 266  * This is the local environment. It is persistent up the next main-item.
 267  */
 268
 269 #define HID_MAX_DESCRIPTOR_SIZE         4096
 270 #define HID_MAX_USAGES                  1024
 271 #define HID_DEFAULT_NUM_COLLECTIONS     16
 272
 273 struct hid_local {
 274         unsigned usage[HID_MAX_USAGES]; /* usage array */
 275         unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
 276         unsigned usage_index;
 277         unsigned usage_minimum;
 278         unsigned delimiter_depth;
 279         unsigned delimiter_branch;
 280 };
 281
 282 /*
 283  * This is the collection stack. We climb up the stack to determine
 284  * application and function of each field.
 285  */
 286
 287 struct hid_collection {
 288         unsigned type;
 289         unsigned usage;
 290         unsigned level;
 291 };
 292
 293 struct hid_usage {
 294         unsigned  hid;                  /* hid usage code */
 295         unsigned  collection_index;     /* index into collection array */
 296         /* hidinput data */
 297         __u16     code;                 /* input driver code */
 298         __u8      type;                 /* input driver type */
 299         __s8      hat_min;              /* hat switch fun */
 300         __s8      hat_max;              /* ditto */
 301         __s8      hat_dir;              /* ditto */
 302 };
 303
 304 struct hid_input;
 305
 306 struct hid_field {
 307         unsigned  physical;             /* physical usage for this field */
 308         unsigned  logical;              /* logical usage for this field */
 309         unsigned  application;          /* application usage for this field */
 310         struct hid_usage *usage;        /* usage table for this function */
 311         unsigned  maxusage;             /* maximum usage index */
 312         unsigned  flags;                /* main-item flags (i.e. volatile,array,constant) */
 313         unsigned  report_offset;        /* bit offset in the report */
 314         unsigned  report_size;          /* size of this field in the report */
 315         unsigned  report_count;         /* number of this field in the report */
 316         unsigned  report_type;          /* (input,output,feature) */
 317         __s32    *value;                /* last known value(s) */
 318         __s32     logical_minimum;
 319         __s32     logical_maximum;
 320         __s32     physical_minimum;
 321         __s32     physical_maximum;
 322         __s32     unit_exponent;
 323         unsigned  unit;
 324         struct hid_report *report;      /* associated report */
 325         unsigned index;                 /* index into report->field[] */
 326         /* hidinput data */
 327         struct hid_input *hidinput;     /* associated input structure */
 328         __u16 dpad;                     /* dpad input code */
 329 };
 330
 331 #define HID_MAX_FIELDS 64
 332
 333 struct hid_report {
 334         struct list_head list;
 335         unsigned id;                                    /* id of this report */
 336         unsigned type;                                  /* report type */
 337         struct hid_field *field[HID_MAX_FIELDS];        /* fields of the report */
 338         unsigned maxfield;                              /* maximum valid field index */
 339         unsigned size;                                  /* size of the report (bits) */
 340         struct hid_device *device;                      /* associated device */
 341 };
 342
 343 struct hid_report_enum {
 344         unsigned numbered;
 345         struct list_head report_list;
 346         struct hid_report *report_id_hash[256];
 347 };
 348
 349 #define HID_REPORT_TYPES 3
 350
 351 #define HID_BUFFER_SIZE         64              /* use 64 for compatibility with all possible packetlen */
 352 #define HID_CONTROL_FIFO_SIZE   256             /* to init devices with >100 reports */
 353 #define HID_OUTPUT_FIFO_SIZE    64
 354
 355 struct hid_control_fifo {
 356         unsigned char dir;
 357         struct hid_report *report;
 358 };
 359
 360 #define HID_CLAIMED_INPUT       1
 361 #define HID_CLAIMED_HIDDEV      2
 362
 363 #define HID_CTRL_RUNNING        1
 364 #define HID_OUT_RUNNING         2
 365
 366 struct hid_input {
 367         struct list_head list;
 368         struct hid_report *report;
 369         struct input_dev input;
 370 };
 371
 372 struct hid_device {                                                     /* device report descriptor */
 373          __u8 *rdesc;
 374         unsigned rsize;
 375         struct hid_collection *collection;                              /* List of HID collections */
 376         unsigned collection_size;                                       /* Number of allocated hid_collections */
 377         unsigned maxcollection;                                         /* Number of parsed collections */
 378         unsigned maxapplication;                                        /* Number of applications */
 379         unsigned version;                                               /* HID version */
 380         unsigned country;                                               /* HID country */
 381         struct hid_report_enum report_enum[HID_REPORT_TYPES];
 382
 383         struct usb_device *dev;                                         /* USB device */
 384         struct usb_interface *intf;                                     /* USB interface */
 385         int ifnum;                                                      /* USB interface number */
 386
 387         unsigned long iofl;                                             /* I/O flags (CTRL_RUNNING, OUT_RUNNING) */
 388
 389         struct urb *urbin;                                              /* Input URB */
 390         char *inbuf;                                                    /* Input buffer */
 391         dma_addr_t inbuf_dma;                                           /* Input buffer dma */
 392
 393         struct urb *urbctrl;                                            /* Control URB */
 394         struct usb_ctrlrequest *cr;                                     /* Control request struct */
 395         dma_addr_t cr_dma;                                              /* Control request struct dma */
 396         struct hid_control_fifo ctrl[HID_CONTROL_FIFO_SIZE];            /* Control fifo */
 397         unsigned char ctrlhead, ctrltail;                               /* Control fifo head & tail */
 398         char *ctrlbuf;                                                  /* Control buffer */
 399         dma_addr_t ctrlbuf_dma;                                         /* Control buffer dma */
 400         spinlock_t ctrllock;                                            /* Control fifo spinlock */
 401
 402         struct urb *urbout;                                             /* Output URB */
 403         struct hid_report *out[HID_CONTROL_FIFO_SIZE];                  /* Output pipe fifo */
 404         unsigned char outhead, outtail;                                 /* Output pipe fifo head & tail */
 405         char *outbuf;                                                   /* Output buffer */
 406         dma_addr_t outbuf_dma;                                          /* Output buffer dma */
 407         spinlock_t outlock;                                             /* Output fifo spinlock */
 408
 409         unsigned claimed;                                               /* Claimed by hidinput, hiddev? */
 410         unsigned quirks;                                                /* Various quirks the device can pull on us */
 411
 412         struct list_head inputs;                                        /* The list of inputs */
 413         void *hiddev;                                                   /* The hiddev structure */
 414         int minor;                                                      /* Hiddev minor number */
 415
 416         wait_queue_head_t wait;                                         /* For sleeping */
 417
 418         int open;                                                       /* is the device open by anyone? */
 419         char name[128];                                                 /* Device name */
 420         char phys[64];                                                  /* Device physical location */
 421         char uniq[64];                                                  /* Device unique identifier (serial #) */
 422
 423         void *ff_private;                                               /* Private data for the force-feedback driver */
 424         void (*ff_exit)(struct hid_device*);                            /* Called by hid_exit_ff(hid) */
 425         int (*ff_event)(struct hid_device *hid, struct input_dev *input,
 426                         unsigned int type, unsigned int code, int value);
 427 };
 428
 429 #define HID_GLOBAL_STACK_SIZE 4
 430 #define HID_COLLECTION_STACK_SIZE 4
 431
 432 struct hid_parser {
 433         struct hid_global     global;
 434         struct hid_global     global_stack[HID_GLOBAL_STACK_SIZE];
 435         unsigned              global_stack_ptr;
 436         struct hid_local      local;
 437         unsigned              collection_stack[HID_COLLECTION_STACK_SIZE];
 438         unsigned              collection_stack_ptr;
 439         struct hid_device    *device;
 440 };
 441
 442 struct hid_class_descriptor {
 443         __u8  bDescriptorType;
 444         __u16 wDescriptorLength;
 445 } __attribute__ ((packed));
 446
 447 struct hid_descriptor {
 448         __u8  bLength;
 449         __u8  bDescriptorType;
 450         __u16 bcdHID;
 451         __u8  bCountryCode;
 452         __u8  bNumDescriptors;
 453
 454         struct hid_class_descriptor desc[1];
 455 } __attribute__ ((packed));
 456
 457 #ifdef DEBUG
 458 #include "hid-debug.h"
 459 #else
 460 #define hid_dump_input(a,b)     do { } while (0)
 461 #define hid_dump_device(c)      do { } while (0)
 462 #define hid_dump_field(a,b)     do { } while (0)
 463 #define resolv_usage(a)         do { } while (0)
 464 #define resolv_event(a,b)       do { } while (0)
 465 #endif
 466
 467 #endif
 468
 469 #ifdef CONFIG_USB_HIDINPUT
 470 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
 471 /* We ignore a few input applications that are not widely used */
 472 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001))
 473 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32, struct pt_regs *regs);
 474 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
 475 extern int hidinput_connect(struct hid_device *);
 476 extern void hidinput_disconnect(struct hid_device *);
 477 #else
 478 #define IS_INPUT_APPLICATION(a) (0)
 479 static inline void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value, struct pt_regs *regs) { }
 480 static inline void hidinput_report_event(struct hid_device *hid, struct hid_report *report) { }
 481 static inline int hidinput_connect(struct hid_device *hid) { return -ENODEV; }
 482 static inline void hidinput_disconnect(struct hid_device *hid) { }
 483 #endif
 484
 485 int hid_open(struct hid_device *);
 486 void hid_close(struct hid_device *);
 487 int hid_set_field(struct hid_field *, unsigned, __s32);
 488 void hid_submit_report(struct hid_device *, struct hid_report *, unsigned char dir);
 489 void hid_init_reports(struct hid_device *hid);
 490 struct hid_field *hid_find_field_by_usage(struct hid_device *hid, __u32 wanted_usage, int type);
 491 int hid_wait_io(struct hid_device* hid);
 492
 493
 494 #ifdef CONFIG_HID_FF
 495 int hid_ff_init(struct hid_device *hid);
 496 #else
 497 static inline int hid_ff_init(struct hid_device *hid) { return -1; }
 498 #endif
 499 static inline void hid_ff_exit(struct hid_device *hid)
 500 {
 501         if (hid->ff_exit)
 502                 hid->ff_exit(hid);
 503 }
 504 static inline int hid_ff_event(struct hid_device *hid, struct input_dev *input,
 505                         unsigned int type, unsigned int code, int value)
 506 {
 507         if (hid->ff_event)
 508                 return hid->ff_event(hid, input, type, code, value);
 509         return -ENOSYS;
 510 }