HID: move logitech quirks
[linux-2.6.git] / include / linux / hid.h
1 #ifndef __HID_H
2 #define __HID_H
3
4 /*
5  *  Copyright (c) 1999 Andreas Gal
6  *  Copyright (c) 2000-2001 Vojtech Pavlik
7  *  Copyright (c) 2006-2007 Jiri Kosina
8  */
9
10 /*
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24  *
25  * Should you need to contact me, the author, you can do so either by
26  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
27  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
28  */
29
30 /*
31  * USB HID (Human Interface Device) interface class code
32  */
33
34 #define USB_INTERFACE_CLASS_HID         3
35
36 /*
37  * USB HID interface subclass and protocol codes
38  */
39
40 #define USB_INTERFACE_SUBCLASS_BOOT     1
41 #define USB_INTERFACE_PROTOCOL_KEYBOARD 1
42 #define USB_INTERFACE_PROTOCOL_MOUSE    2
43
44 /*
45  * HID class requests
46  */
47
48 #define HID_REQ_GET_REPORT              0x01
49 #define HID_REQ_GET_IDLE                0x02
50 #define HID_REQ_GET_PROTOCOL            0x03
51 #define HID_REQ_SET_REPORT              0x09
52 #define HID_REQ_SET_IDLE                0x0A
53 #define HID_REQ_SET_PROTOCOL            0x0B
54
55 /*
56  * HID class descriptor types
57  */
58
59 #define HID_DT_HID                      (USB_TYPE_CLASS | 0x01)
60 #define HID_DT_REPORT                   (USB_TYPE_CLASS | 0x02)
61 #define HID_DT_PHYSICAL                 (USB_TYPE_CLASS | 0x03)
62
63 #define HID_MAX_DESCRIPTOR_SIZE         4096
64
65 #ifdef __KERNEL__
66
67 #include <linux/types.h>
68 #include <linux/slab.h>
69 #include <linux/list.h>
70 #include <linux/mod_devicetable.h> /* hid_device_id */
71 #include <linux/timer.h>
72 #include <linux/workqueue.h>
73 #include <linux/input.h>
74
75 /*
76  * We parse each description item into this structure. Short items data
77  * values are expanded to 32-bit signed int, long items contain a pointer
78  * into the data area.
79  */
80
81 struct hid_item {
82         unsigned  format;
83         __u8      size;
84         __u8      type;
85         __u8      tag;
86         union {
87             __u8   u8;
88             __s8   s8;
89             __u16  u16;
90             __s16  s16;
91             __u32  u32;
92             __s32  s32;
93             __u8  *longdata;
94         } data;
95 };
96
97 /*
98  * HID report item format
99  */
100
101 #define HID_ITEM_FORMAT_SHORT   0
102 #define HID_ITEM_FORMAT_LONG    1
103
104 /*
105  * Special tag indicating long items
106  */
107
108 #define HID_ITEM_TAG_LONG       15
109
110 /*
111  * HID report descriptor item type (prefix bit 2,3)
112  */
113
114 #define HID_ITEM_TYPE_MAIN              0
115 #define HID_ITEM_TYPE_GLOBAL            1
116 #define HID_ITEM_TYPE_LOCAL             2
117 #define HID_ITEM_TYPE_RESERVED          3
118
119 /*
120  * HID report descriptor main item tags
121  */
122
123 #define HID_MAIN_ITEM_TAG_INPUT                 8
124 #define HID_MAIN_ITEM_TAG_OUTPUT                9
125 #define HID_MAIN_ITEM_TAG_FEATURE               11
126 #define HID_MAIN_ITEM_TAG_BEGIN_COLLECTION      10
127 #define HID_MAIN_ITEM_TAG_END_COLLECTION        12
128
129 /*
130  * HID report descriptor main item contents
131  */
132
133 #define HID_MAIN_ITEM_CONSTANT          0x001
134 #define HID_MAIN_ITEM_VARIABLE          0x002
135 #define HID_MAIN_ITEM_RELATIVE          0x004
136 #define HID_MAIN_ITEM_WRAP              0x008
137 #define HID_MAIN_ITEM_NONLINEAR         0x010
138 #define HID_MAIN_ITEM_NO_PREFERRED      0x020
139 #define HID_MAIN_ITEM_NULL_STATE        0x040
140 #define HID_MAIN_ITEM_VOLATILE          0x080
141 #define HID_MAIN_ITEM_BUFFERED_BYTE     0x100
142
143 /*
144  * HID report descriptor collection item types
145  */
146
147 #define HID_COLLECTION_PHYSICAL         0
148 #define HID_COLLECTION_APPLICATION      1
149 #define HID_COLLECTION_LOGICAL          2
150
151 /*
152  * HID report descriptor global item tags
153  */
154
155 #define HID_GLOBAL_ITEM_TAG_USAGE_PAGE          0
156 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MINIMUM     1
157 #define HID_GLOBAL_ITEM_TAG_LOGICAL_MAXIMUM     2
158 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MINIMUM    3
159 #define HID_GLOBAL_ITEM_TAG_PHYSICAL_MAXIMUM    4
160 #define HID_GLOBAL_ITEM_TAG_UNIT_EXPONENT       5
161 #define HID_GLOBAL_ITEM_TAG_UNIT                6
162 #define HID_GLOBAL_ITEM_TAG_REPORT_SIZE         7
163 #define HID_GLOBAL_ITEM_TAG_REPORT_ID           8
164 #define HID_GLOBAL_ITEM_TAG_REPORT_COUNT        9
165 #define HID_GLOBAL_ITEM_TAG_PUSH                10
166 #define HID_GLOBAL_ITEM_TAG_POP                 11
167
168 /*
169  * HID report descriptor local item tags
170  */
171
172 #define HID_LOCAL_ITEM_TAG_USAGE                0
173 #define HID_LOCAL_ITEM_TAG_USAGE_MINIMUM        1
174 #define HID_LOCAL_ITEM_TAG_USAGE_MAXIMUM        2
175 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_INDEX     3
176 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MINIMUM   4
177 #define HID_LOCAL_ITEM_TAG_DESIGNATOR_MAXIMUM   5
178 #define HID_LOCAL_ITEM_TAG_STRING_INDEX         7
179 #define HID_LOCAL_ITEM_TAG_STRING_MINIMUM       8
180 #define HID_LOCAL_ITEM_TAG_STRING_MAXIMUM       9
181 #define HID_LOCAL_ITEM_TAG_DELIMITER            10
182
183 /*
184  * HID usage tables
185  */
186
187 #define HID_USAGE_PAGE          0xffff0000
188
189 #define HID_UP_UNDEFINED        0x00000000
190 #define HID_UP_GENDESK          0x00010000
191 #define HID_UP_SIMULATION       0x00020000
192 #define HID_UP_KEYBOARD         0x00070000
193 #define HID_UP_LED              0x00080000
194 #define HID_UP_BUTTON           0x00090000
195 #define HID_UP_ORDINAL          0x000a0000
196 #define HID_UP_CONSUMER         0x000c0000
197 #define HID_UP_DIGITIZER        0x000d0000
198 #define HID_UP_PID              0x000f0000
199 #define HID_UP_HPVENDOR         0xff7f0000
200 #define HID_UP_MSVENDOR         0xff000000
201 #define HID_UP_CUSTOM           0x00ff0000
202 #define HID_UP_LOGIVENDOR       0xffbc0000
203
204 #define HID_USAGE               0x0000ffff
205
206 #define HID_GD_POINTER          0x00010001
207 #define HID_GD_MOUSE            0x00010002
208 #define HID_GD_JOYSTICK         0x00010004
209 #define HID_GD_GAMEPAD          0x00010005
210 #define HID_GD_KEYBOARD         0x00010006
211 #define HID_GD_KEYPAD           0x00010007
212 #define HID_GD_MULTIAXIS        0x00010008
213 #define HID_GD_X                0x00010030
214 #define HID_GD_Y                0x00010031
215 #define HID_GD_Z                0x00010032
216 #define HID_GD_RX               0x00010033
217 #define HID_GD_RY               0x00010034
218 #define HID_GD_RZ               0x00010035
219 #define HID_GD_SLIDER           0x00010036
220 #define HID_GD_DIAL             0x00010037
221 #define HID_GD_WHEEL            0x00010038
222 #define HID_GD_HATSWITCH        0x00010039
223 #define HID_GD_BUFFER           0x0001003a
224 #define HID_GD_BYTECOUNT        0x0001003b
225 #define HID_GD_MOTION           0x0001003c
226 #define HID_GD_START            0x0001003d
227 #define HID_GD_SELECT           0x0001003e
228 #define HID_GD_VX               0x00010040
229 #define HID_GD_VY               0x00010041
230 #define HID_GD_VZ               0x00010042
231 #define HID_GD_VBRX             0x00010043
232 #define HID_GD_VBRY             0x00010044
233 #define HID_GD_VBRZ             0x00010045
234 #define HID_GD_VNO              0x00010046
235 #define HID_GD_FEATURE          0x00010047
236 #define HID_GD_UP               0x00010090
237 #define HID_GD_DOWN             0x00010091
238 #define HID_GD_RIGHT            0x00010092
239 #define HID_GD_LEFT             0x00010093
240
241 /*
242  * HID report types --- Ouch! HID spec says 1 2 3!
243  */
244
245 #define HID_INPUT_REPORT        0
246 #define HID_OUTPUT_REPORT       1
247 #define HID_FEATURE_REPORT      2
248
249 /*
250  * HID device quirks.
251  */
252
253 /* 
254  * Increase this if you need to configure more HID quirks at module load time
255  */
256 #define MAX_USBHID_BOOT_QUIRKS 4
257
258 #define HID_QUIRK_INVERT                        0x00000001
259 #define HID_QUIRK_NOTOUCH                       0x00000002
260 #define HID_QUIRK_IGNORE                        0x00000004
261 #define HID_QUIRK_NOGET                         0x00000008
262 #define HID_QUIRK_HIDDEV                        0x00000010
263 #define HID_QUIRK_BADPAD                        0x00000020
264 #define HID_QUIRK_MULTI_INPUT                   0x00000040
265 #define HID_QUIRK_2WHEEL_MOUSE_HACK_7           0x00000080
266 #define HID_QUIRK_2WHEEL_MOUSE_HACK_5           0x00000100
267 #define HID_QUIRK_2WHEEL_MOUSE_HACK_ON          0x00000200
268 #define HID_QUIRK_MIGHTYMOUSE                   0x00000400
269 #define HID_QUIRK_APPLE_HAS_FN                  0x00000800
270 #define HID_QUIRK_APPLE_FN_ON                   0x00001000
271 #define HID_QUIRK_INVERT_HWHEEL                 0x00002000
272 #define HID_QUIRK_APPLE_ISO_KEYBOARD            0x00004000
273 #define HID_QUIRK_SKIP_OUTPUT_REPORTS           0x00010000
274 #define HID_QUIRK_IGNORE_MOUSE                  0x00020000
275 #define HID_QUIRK_SONY_PS3_CONTROLLER           0x00040000
276 #define HID_QUIRK_RESET_LEDS                    0x00100000
277 #define HID_QUIRK_HIDINPUT                      0x00200000
278 #define HID_QUIRK_IGNORE_HIDINPUT               0x01000000
279 #define HID_QUIRK_2WHEEL_MOUSE_HACK_B8          0x02000000
280 #define HID_QUIRK_HWHEEL_WHEEL_INVERT           0x04000000
281 #define HID_QUIRK_MICROSOFT_KEYS                0x08000000
282 #define HID_QUIRK_FULLSPEED_INTERVAL            0x10000000
283 #define HID_QUIRK_APPLE_NUMLOCK_EMULATION       0x20000000
284
285 /*
286  * Separate quirks for runtime report descriptor fixup
287  */
288
289 #define HID_QUIRK_RDESC_CYMOTION                0x00000001
290 #define HID_QUIRK_RDESC_SWAPPED_MIN_MAX         0x00000004
291 #define HID_QUIRK_RDESC_PETALYNX                0x00000008
292 #define HID_QUIRK_RDESC_MACBOOK_JIS             0x00000010
293 #define HID_QUIRK_RDESC_BUTTON_CONSUMER         0x00000020
294 #define HID_QUIRK_RDESC_SAMSUNG_REMOTE          0x00000040
295 #define HID_QUIRK_RDESC_MICROSOFT_RECV_1028     0x00000080
296 #define HID_QUIRK_RDESC_SUNPLUS_WDESKTOP        0x00000100
297
298 /*
299  * This is the global environment of the parser. This information is
300  * persistent for main-items. The global environment can be saved and
301  * restored with PUSH/POP statements.
302  */
303
304 struct hid_global {
305         unsigned usage_page;
306         __s32    logical_minimum;
307         __s32    logical_maximum;
308         __s32    physical_minimum;
309         __s32    physical_maximum;
310         __s32    unit_exponent;
311         unsigned unit;
312         unsigned report_id;
313         unsigned report_size;
314         unsigned report_count;
315 };
316
317 /*
318  * This is the local environment. It is persistent up the next main-item.
319  */
320
321 #define HID_MAX_USAGES                  12288
322 #define HID_DEFAULT_NUM_COLLECTIONS     16
323
324 struct hid_local {
325         unsigned usage[HID_MAX_USAGES]; /* usage array */
326         unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
327         unsigned usage_index;
328         unsigned usage_minimum;
329         unsigned delimiter_depth;
330         unsigned delimiter_branch;
331 };
332
333 /*
334  * This is the collection stack. We climb up the stack to determine
335  * application and function of each field.
336  */
337
338 struct hid_collection {
339         unsigned type;
340         unsigned usage;
341         unsigned level;
342 };
343
344 struct hid_usage {
345         unsigned  hid;                  /* hid usage code */
346         unsigned  collection_index;     /* index into collection array */
347         /* hidinput data */
348         __u16     code;                 /* input driver code */
349         __u8      type;                 /* input driver type */
350         __s8      hat_min;              /* hat switch fun */
351         __s8      hat_max;              /* ditto */
352         __s8      hat_dir;              /* ditto */
353 };
354
355 struct hid_input;
356
357 struct hid_field {
358         unsigned  physical;             /* physical usage for this field */
359         unsigned  logical;              /* logical usage for this field */
360         unsigned  application;          /* application usage for this field */
361         struct hid_usage *usage;        /* usage table for this function */
362         unsigned  maxusage;             /* maximum usage index */
363         unsigned  flags;                /* main-item flags (i.e. volatile,array,constant) */
364         unsigned  report_offset;        /* bit offset in the report */
365         unsigned  report_size;          /* size of this field in the report */
366         unsigned  report_count;         /* number of this field in the report */
367         unsigned  report_type;          /* (input,output,feature) */
368         __s32    *value;                /* last known value(s) */
369         __s32     logical_minimum;
370         __s32     logical_maximum;
371         __s32     physical_minimum;
372         __s32     physical_maximum;
373         __s32     unit_exponent;
374         unsigned  unit;
375         struct hid_report *report;      /* associated report */
376         unsigned index;                 /* index into report->field[] */
377         /* hidinput data */
378         struct hid_input *hidinput;     /* associated input structure */
379         __u16 dpad;                     /* dpad input code */
380 };
381
382 #define HID_MAX_FIELDS 64
383
384 struct hid_report {
385         struct list_head list;
386         unsigned id;                                    /* id of this report */
387         unsigned type;                                  /* report type */
388         struct hid_field *field[HID_MAX_FIELDS];        /* fields of the report */
389         unsigned maxfield;                              /* maximum valid field index */
390         unsigned size;                                  /* size of the report (bits) */
391         struct hid_device *device;                      /* associated device */
392 };
393
394 struct hid_report_enum {
395         unsigned numbered;
396         struct list_head report_list;
397         struct hid_report *report_id_hash[256];
398 };
399
400 #define HID_REPORT_TYPES 3
401
402 #define HID_MIN_BUFFER_SIZE     64              /* make sure there is at least a packet size of space */
403 #define HID_MAX_BUFFER_SIZE     4096            /* 4kb */
404 #define HID_CONTROL_FIFO_SIZE   256             /* to init devices with >100 reports */
405 #define HID_OUTPUT_FIFO_SIZE    64
406
407 struct hid_control_fifo {
408         unsigned char dir;
409         struct hid_report *report;
410 };
411
412 #define HID_CLAIMED_INPUT       1
413 #define HID_CLAIMED_HIDDEV      2
414 #define HID_CLAIMED_HIDRAW      4
415
416 #define HID_STAT_ADDED          1
417 #define HID_STAT_PARSED         2
418
419 #define HID_CTRL_RUNNING        1
420 #define HID_OUT_RUNNING         2
421 #define HID_IN_RUNNING          3
422 #define HID_RESET_PENDING       4
423 #define HID_SUSPENDED           5
424 #define HID_CLEAR_HALT          6
425 #define HID_DISCONNECTED        7
426
427 struct hid_input {
428         struct list_head list;
429         struct hid_report *report;
430         struct input_dev *input;
431 };
432
433 struct hid_driver;
434 struct hid_ll_driver;
435
436 struct hid_device {                                                     /* device report descriptor */
437         __u8 *rdesc;
438         unsigned rsize;
439         struct hid_collection *collection;                              /* List of HID collections */
440         unsigned collection_size;                                       /* Number of allocated hid_collections */
441         unsigned maxcollection;                                         /* Number of parsed collections */
442         unsigned maxapplication;                                        /* Number of applications */
443         __u16 bus;                                                      /* BUS ID */
444         __u32 vendor;                                                   /* Vendor ID */
445         __u32 product;                                                  /* Product ID */
446         __u32 version;                                                  /* HID version */
447         unsigned country;                                               /* HID country */
448         struct hid_report_enum report_enum[HID_REPORT_TYPES];
449
450         struct device dev;                                              /* device */
451         struct hid_driver *driver;
452         struct hid_ll_driver *ll_driver;
453
454         unsigned int status;                                            /* see STAT flags above */
455         unsigned claimed;                                               /* Claimed by hidinput, hiddev? */
456         unsigned quirks;                                                /* Various quirks the device can pull on us */
457
458         struct list_head inputs;                                        /* The list of inputs */
459         void *hiddev;                                                   /* The hiddev structure */
460         void *hidraw;
461         int minor;                                                      /* Hiddev minor number */
462
463         int open;                                                       /* is the device open by anyone? */
464         char name[128];                                                 /* Device name */
465         char phys[64];                                                  /* Device physical location */
466         char uniq[64];                                                  /* Device unique identifier (serial #) */
467
468         void *driver_data;
469
470         __s32 delayed_value;                                            /* For A4 Tech mice hwheel quirk */
471
472         /* hiddev event handler */
473         void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
474                                   struct hid_usage *, __s32);
475         void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
476
477         /* handler for raw output data, used by hidraw */
478         int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t);
479 #ifdef CONFIG_USB_HIDINPUT_POWERBOOK
480         unsigned long apple_pressed_fn[BITS_TO_LONGS(KEY_CNT)];
481         unsigned long pb_pressed_numlock[BITS_TO_LONGS(KEY_CNT)];
482 #endif
483 };
484
485 static inline void *hid_get_drvdata(struct hid_device *hdev)
486 {
487         return dev_get_drvdata(&hdev->dev);
488 }
489
490 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
491 {
492         dev_set_drvdata(&hdev->dev, data);
493 }
494
495 #define HID_GLOBAL_STACK_SIZE 4
496 #define HID_COLLECTION_STACK_SIZE 4
497
498 struct hid_parser {
499         struct hid_global     global;
500         struct hid_global     global_stack[HID_GLOBAL_STACK_SIZE];
501         unsigned              global_stack_ptr;
502         struct hid_local      local;
503         unsigned              collection_stack[HID_COLLECTION_STACK_SIZE];
504         unsigned              collection_stack_ptr;
505         struct hid_device    *device;
506 };
507
508 struct hid_class_descriptor {
509         __u8  bDescriptorType;
510         __le16 wDescriptorLength;
511 } __attribute__ ((packed));
512
513 struct hid_descriptor {
514         __u8  bLength;
515         __u8  bDescriptorType;
516         __le16 bcdHID;
517         __u8  bCountryCode;
518         __u8  bNumDescriptors;
519
520         struct hid_class_descriptor desc[1];
521 } __attribute__ ((packed));
522
523 #define HID_DEVICE(b, ven, prod) \
524         .bus = (b), \
525         .vendor = (ven), .product = (prod)
526
527 #define HID_USB_DEVICE(ven, prod)       HID_DEVICE(BUS_USB, ven, prod)
528 #define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
529
530 #define HID_REPORT_ID(rep) \
531         .report_type = (rep)
532 #define HID_USAGE_ID(uhid, utype, ucode) \
533         .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
534 /* we don't want to catch types and codes equal to 0 */
535 #define HID_TERMINATOR          (HID_ANY_ID - 1)
536
537 struct hid_report_id {
538         __u32 report_type;
539 };
540 struct hid_usage_id {
541         __u32 usage_hid;
542         __u32 usage_type;
543         __u32 usage_code;
544 };
545
546 /**
547  * struct hid_driver
548  * @name: driver name (e.g. "Footech_bar-wheel")
549  * @id_table: which devices is this driver for (must be non-NULL for probe
550  *            to be called)
551  * @probe: new device inserted
552  * @remove: device removed (NULL if not a hot-plug capable driver)
553  * @report_table: on which reports to call raw_event (NULL means all)
554  * @raw_event: if report in report_table, this hook is called (NULL means nop)
555  * @usage_table: on which events to call event (NULL means all)
556  * @event: if usage in usage_table, this hook is called (NULL means nop)
557  * @report_fixup: called before report descriptor parsing (NULL means nop)
558  * @input_mapping: invoked on input registering before mapping an usage
559  * @input_mapped: invoked on input registering after mapping an usage
560  *
561  * raw_event and event should return 0 on no action performed, 1 when no
562  * further processing should be done and negative on error
563  *
564  * input_mapping shall return a negative value to completely ignore this usage
565  * (e.g. doubled or invalid usage), zero to continue with parsing of this
566  * usage by generic code (no special handling needed) or positive to skip
567  * generic parsing (needed special handling which was done in the hook already)
568  * input_mapped shall return negative to inform the layer that this usage
569  * should not be considered for further processing or zero to notify that
570  * no processing was performed and should be done in a generic manner
571  * Both these functions may be NULL which means the same behavior as returning
572  * zero from them.
573  */
574 struct hid_driver {
575         char *name;
576         const struct hid_device_id *id_table;
577
578         int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
579         void (*remove)(struct hid_device *dev);
580
581         const struct hid_report_id *report_table;
582         int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
583                         u8 *data, int size);
584         const struct hid_usage_id *usage_table;
585         int (*event)(struct hid_device *hdev, struct hid_field *field,
586                         struct hid_usage *usage, __s32 value);
587
588         void (*report_fixup)(struct hid_device *hdev, __u8 *buf,
589                         unsigned int size);
590
591         int (*input_mapping)(struct hid_device *hdev,
592                         struct hid_input *hidinput, struct hid_field *field,
593                         struct hid_usage *usage, unsigned long **bit, int *max);
594         int (*input_mapped)(struct hid_device *hdev,
595                         struct hid_input *hidinput, struct hid_field *field,
596                         struct hid_usage *usage, unsigned long **bit, int *max);
597 /* private: */
598         struct device_driver driver;
599 };
600
601 /**
602  * hid_ll_driver - low level driver callbacks
603  * @start: called on probe to start the device
604  * @stop: called on remove
605  * @open: called by input layer on open
606  * @close: called by input layer on close
607  * @hidinput_input_event: event input event (e.g. ff or leds)
608  * @parse: this method is called only once to parse the device data,
609  *         shouldn't allocate anything to not leak memory
610  */
611 struct hid_ll_driver {
612         int (*start)(struct hid_device *hdev);
613         void (*stop)(struct hid_device *hdev);
614
615         int (*open)(struct hid_device *hdev);
616         void (*close)(struct hid_device *hdev);
617
618         int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
619                         unsigned int code, int value);
620
621         int (*parse)(struct hid_device *hdev);
622 };
623
624 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
625 /* We ignore a few input applications that are not widely used */
626 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || (a == 0x000d0002))
627
628 /* HID core API */
629
630 #ifdef CONFIG_HID_DEBUG
631 extern int hid_debug;
632 #endif
633
634 extern int hid_add_device(struct hid_device *);
635 extern void hid_destroy_device(struct hid_device *);
636
637 extern int __must_check __hid_register_driver(struct hid_driver *,
638                 struct module *, const char *mod_name);
639 static inline int __must_check hid_register_driver(struct hid_driver *driver)
640 {
641         return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
642 }
643 extern void hid_unregister_driver(struct hid_driver *);
644
645 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
646 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
647 extern int hidinput_connect(struct hid_device *);
648 extern void hidinput_disconnect(struct hid_device *);
649
650 int hid_set_field(struct hid_field *, unsigned, __s32);
651 int hid_input_report(struct hid_device *, int type, u8 *, int, int);
652 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
653 int hidinput_mapping_quirks(struct hid_usage *, struct hid_input *,
654                 unsigned long **, int *);
655 int hidinput_event_quirks(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
656 int hidinput_apple_event(struct hid_device *, struct input_dev *, struct hid_usage *, __s32);
657 void hid_output_report(struct hid_report *report, __u8 *data);
658 struct hid_device *hid_allocate_device(void);
659 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
660
661 /**
662  * hid_map_usage - map usage input bits
663  *
664  * @hidinput: hidinput which we are interested in
665  * @usage: usage to fill in
666  * @bit: pointer to input->{}bit (out parameter)
667  * @max: maximal valid usage->code to consider later (out parameter)
668  * @type: input event type (EV_KEY, EV_REL, ...)
669  * @c: code which corresponds to this usage and type
670  */
671 static inline void hid_map_usage(struct hid_input *hidinput,
672                 struct hid_usage *usage, unsigned long **bit, int *max,
673                 __u8 type, __u16 c)
674 {
675         struct input_dev *input = hidinput->input;
676
677         usage->type = type;
678         usage->code = c;
679
680         switch (type) {
681         case EV_ABS:
682                 *bit = input->absbit;
683                 *max = ABS_MAX;
684                 break;
685         case EV_REL:
686                 *bit = input->relbit;
687                 *max = REL_MAX;
688                 break;
689         case EV_KEY:
690                 *bit = input->keybit;
691                 *max = KEY_MAX;
692                 break;
693         case EV_LED:
694                 *bit = input->ledbit;
695                 *max = LED_MAX;
696                 break;
697         }
698 }
699
700 /**
701  * hid_map_usage_clear - map usage input bits and clear the input bit
702  *
703  * The same as hid_map_usage, except the @c bit is also cleared in supported
704  * bits (@bit).
705  */
706 static inline void hid_map_usage_clear(struct hid_input *hidinput,
707                 struct hid_usage *usage, unsigned long **bit, int *max,
708                 __u8 type, __u16 c)
709 {
710         hid_map_usage(hidinput, usage, bit, max, type, c);
711         clear_bit(c, *bit);
712 }
713
714 /**
715  * hid_parse - parse HW reports
716  *
717  * @hdev: hid device
718  *
719  * Call this from probe after you set up the device (if needed). Your
720  * report_fixup will be called (if non-NULL) after reading raw report from
721  * device before passing it to hid layer for real parsing.
722  */
723 static inline int __must_check hid_parse(struct hid_device *hdev)
724 {
725         int ret;
726
727         if (hdev->status & HID_STAT_PARSED)
728                 return 0;
729
730         ret = hdev->ll_driver->parse(hdev);
731         if (!ret)
732                 hdev->status |= HID_STAT_PARSED;
733
734         return ret;
735 }
736
737 /**
738  * hid_hw_start - start underlaying HW
739  *
740  * @hdev: hid device
741  *
742  * Call this in probe function *after* hid_parse. This will setup HW buffers
743  * and start the device (if not deffered to device open). hid_hw_stop must be
744  * called if this was successfull.
745  */
746 static inline int __must_check hid_hw_start(struct hid_device *hdev)
747 {
748         return hdev->ll_driver->start(hdev);
749 }
750
751 /**
752  * hid_hw_stop - stop underlaying HW
753  *
754  * @hdev: hid device
755  *
756  * This is usually called from remove function or from probe when something
757  * failed and hid_hw_start was called already.
758  */
759 static inline void hid_hw_stop(struct hid_device *hdev)
760 {
761         hdev->ll_driver->stop(hdev);
762 }
763
764 void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
765                 int interrupt);
766
767 extern int hid_generic_init(void);
768 extern void hid_generic_exit(void);
769
770 /* HID quirks API */
771 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
772 int usbhid_quirks_init(char **quirks_param);
773 void usbhid_quirks_exit(void);
774 void usbhid_fixup_report_descriptor(const u16, const u16, char *, unsigned, char **);
775
776 #ifdef CONFIG_HID_FF
777 int hid_ff_init(struct hid_device *hid);
778
779 int hid_lgff_init(struct hid_device *hid);
780 int hid_lg2ff_init(struct hid_device *hid);
781 int hid_plff_init(struct hid_device *hid);
782 int hid_tmff_init(struct hid_device *hid);
783 int hid_zpff_init(struct hid_device *hid);
784 #ifdef CONFIG_HID_PID
785 int hid_pidff_init(struct hid_device *hid);
786 #else
787 static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
788 #endif
789
790 #else
791 static inline int hid_ff_init(struct hid_device *hid) { return -1; }
792 #endif
793
794 #ifdef CONFIG_HID_DEBUG
795 #define dbg_hid(format, arg...) if (hid_debug) \
796                                 printk(KERN_DEBUG "%s: " format ,\
797                                 __FILE__ , ## arg)
798 #define dbg_hid_line(format, arg...) if (hid_debug) \
799                                 printk(format, ## arg)
800 #else
801 static inline int __attribute__((format(printf, 1, 2)))
802 dbg_hid(const char *fmt, ...)
803 {
804         return 0;
805 }
806 #define dbg_hid_line dbg_hid
807 #endif
808
809 #define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
810                 __FILE__ , ## arg)
811 #endif
812 #endif
813