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