75cc1531dd84f8f0673b3c5d20c5a8169325e310
[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_NOGET                         0x00000008
261 #define HID_QUIRK_HIDDEV                        0x00000010
262 #define HID_QUIRK_BADPAD                        0x00000020
263 #define HID_QUIRK_MULTI_INPUT                   0x00000040
264 #define HID_QUIRK_2WHEEL_MOUSE_HACK_7           0x00000080
265 #define HID_QUIRK_2WHEEL_MOUSE_HACK_5           0x00000100
266 #define HID_QUIRK_2WHEEL_MOUSE_HACK_ON          0x00000200
267 #define HID_QUIRK_SKIP_OUTPUT_REPORTS           0x00010000
268 #define HID_QUIRK_SONY_PS3_CONTROLLER           0x00040000
269 #define HID_QUIRK_RESET_LEDS                    0x00100000
270 #define HID_QUIRK_HIDINPUT                      0x00200000
271 #define HID_QUIRK_IGNORE_HIDINPUT               0x01000000
272 #define HID_QUIRK_2WHEEL_MOUSE_HACK_B8          0x02000000
273 #define HID_QUIRK_HWHEEL_WHEEL_INVERT           0x04000000
274 #define HID_QUIRK_MICROSOFT_KEYS                0x08000000
275 #define HID_QUIRK_FULLSPEED_INTERVAL            0x10000000
276
277 /*
278  * Separate quirks for runtime report descriptor fixup
279  */
280
281 #define HID_QUIRK_RDESC_CYMOTION                0x00000001
282 #define HID_QUIRK_RDESC_SWAPPED_MIN_MAX         0x00000004
283 #define HID_QUIRK_RDESC_PETALYNX                0x00000008
284 #define HID_QUIRK_RDESC_BUTTON_CONSUMER         0x00000020
285 #define HID_QUIRK_RDESC_SAMSUNG_REMOTE          0x00000040
286 #define HID_QUIRK_RDESC_MICROSOFT_RECV_1028     0x00000080
287 #define HID_QUIRK_RDESC_SUNPLUS_WDESKTOP        0x00000100
288
289 /*
290  * This is the global environment of the parser. This information is
291  * persistent for main-items. The global environment can be saved and
292  * restored with PUSH/POP statements.
293  */
294
295 struct hid_global {
296         unsigned usage_page;
297         __s32    logical_minimum;
298         __s32    logical_maximum;
299         __s32    physical_minimum;
300         __s32    physical_maximum;
301         __s32    unit_exponent;
302         unsigned unit;
303         unsigned report_id;
304         unsigned report_size;
305         unsigned report_count;
306 };
307
308 /*
309  * This is the local environment. It is persistent up the next main-item.
310  */
311
312 #define HID_MAX_USAGES                  12288
313 #define HID_DEFAULT_NUM_COLLECTIONS     16
314
315 struct hid_local {
316         unsigned usage[HID_MAX_USAGES]; /* usage array */
317         unsigned collection_index[HID_MAX_USAGES]; /* collection index array */
318         unsigned usage_index;
319         unsigned usage_minimum;
320         unsigned delimiter_depth;
321         unsigned delimiter_branch;
322 };
323
324 /*
325  * This is the collection stack. We climb up the stack to determine
326  * application and function of each field.
327  */
328
329 struct hid_collection {
330         unsigned type;
331         unsigned usage;
332         unsigned level;
333 };
334
335 struct hid_usage {
336         unsigned  hid;                  /* hid usage code */
337         unsigned  collection_index;     /* index into collection array */
338         /* hidinput data */
339         __u16     code;                 /* input driver code */
340         __u8      type;                 /* input driver type */
341         __s8      hat_min;              /* hat switch fun */
342         __s8      hat_max;              /* ditto */
343         __s8      hat_dir;              /* ditto */
344 };
345
346 struct hid_input;
347
348 struct hid_field {
349         unsigned  physical;             /* physical usage for this field */
350         unsigned  logical;              /* logical usage for this field */
351         unsigned  application;          /* application usage for this field */
352         struct hid_usage *usage;        /* usage table for this function */
353         unsigned  maxusage;             /* maximum usage index */
354         unsigned  flags;                /* main-item flags (i.e. volatile,array,constant) */
355         unsigned  report_offset;        /* bit offset in the report */
356         unsigned  report_size;          /* size of this field in the report */
357         unsigned  report_count;         /* number of this field in the report */
358         unsigned  report_type;          /* (input,output,feature) */
359         __s32    *value;                /* last known value(s) */
360         __s32     logical_minimum;
361         __s32     logical_maximum;
362         __s32     physical_minimum;
363         __s32     physical_maximum;
364         __s32     unit_exponent;
365         unsigned  unit;
366         struct hid_report *report;      /* associated report */
367         unsigned index;                 /* index into report->field[] */
368         /* hidinput data */
369         struct hid_input *hidinput;     /* associated input structure */
370         __u16 dpad;                     /* dpad input code */
371 };
372
373 #define HID_MAX_FIELDS 64
374
375 struct hid_report {
376         struct list_head list;
377         unsigned id;                                    /* id of this report */
378         unsigned type;                                  /* report type */
379         struct hid_field *field[HID_MAX_FIELDS];        /* fields of the report */
380         unsigned maxfield;                              /* maximum valid field index */
381         unsigned size;                                  /* size of the report (bits) */
382         struct hid_device *device;                      /* associated device */
383 };
384
385 struct hid_report_enum {
386         unsigned numbered;
387         struct list_head report_list;
388         struct hid_report *report_id_hash[256];
389 };
390
391 #define HID_REPORT_TYPES 3
392
393 #define HID_MIN_BUFFER_SIZE     64              /* make sure there is at least a packet size of space */
394 #define HID_MAX_BUFFER_SIZE     4096            /* 4kb */
395 #define HID_CONTROL_FIFO_SIZE   256             /* to init devices with >100 reports */
396 #define HID_OUTPUT_FIFO_SIZE    64
397
398 struct hid_control_fifo {
399         unsigned char dir;
400         struct hid_report *report;
401 };
402
403 #define HID_CLAIMED_INPUT       1
404 #define HID_CLAIMED_HIDDEV      2
405 #define HID_CLAIMED_HIDRAW      4
406
407 #define HID_STAT_ADDED          1
408 #define HID_STAT_PARSED         2
409
410 #define HID_CTRL_RUNNING        1
411 #define HID_OUT_RUNNING         2
412 #define HID_IN_RUNNING          3
413 #define HID_RESET_PENDING       4
414 #define HID_SUSPENDED           5
415 #define HID_CLEAR_HALT          6
416 #define HID_DISCONNECTED        7
417
418 struct hid_input {
419         struct list_head list;
420         struct hid_report *report;
421         struct input_dev *input;
422 };
423
424 struct hid_driver;
425 struct hid_ll_driver;
426
427 struct hid_device {                                                     /* device report descriptor */
428         __u8 *rdesc;
429         unsigned rsize;
430         struct hid_collection *collection;                              /* List of HID collections */
431         unsigned collection_size;                                       /* Number of allocated hid_collections */
432         unsigned maxcollection;                                         /* Number of parsed collections */
433         unsigned maxapplication;                                        /* Number of applications */
434         __u16 bus;                                                      /* BUS ID */
435         __u32 vendor;                                                   /* Vendor ID */
436         __u32 product;                                                  /* Product ID */
437         __u32 version;                                                  /* HID version */
438         unsigned country;                                               /* HID country */
439         struct hid_report_enum report_enum[HID_REPORT_TYPES];
440
441         struct device dev;                                              /* device */
442         struct hid_driver *driver;
443         struct hid_ll_driver *ll_driver;
444
445         unsigned int status;                                            /* see STAT flags above */
446         unsigned claimed;                                               /* Claimed by hidinput, hiddev? */
447         unsigned quirks;                                                /* Various quirks the device can pull on us */
448
449         struct list_head inputs;                                        /* The list of inputs */
450         void *hiddev;                                                   /* The hiddev structure */
451         void *hidraw;
452         int minor;                                                      /* Hiddev minor number */
453
454         int open;                                                       /* is the device open by anyone? */
455         char name[128];                                                 /* Device name */
456         char phys[64];                                                  /* Device physical location */
457         char uniq[64];                                                  /* Device unique identifier (serial #) */
458
459         void *driver_data;
460
461         __s32 delayed_value;                                            /* For A4 Tech mice hwheel quirk */
462
463         /* hiddev event handler */
464         void (*hiddev_hid_event) (struct hid_device *, struct hid_field *field,
465                                   struct hid_usage *, __s32);
466         void (*hiddev_report_event) (struct hid_device *, struct hid_report *);
467
468         /* handler for raw output data, used by hidraw */
469         int (*hid_output_raw_report) (struct hid_device *, __u8 *, size_t);
470 };
471
472 static inline void *hid_get_drvdata(struct hid_device *hdev)
473 {
474         return dev_get_drvdata(&hdev->dev);
475 }
476
477 static inline void hid_set_drvdata(struct hid_device *hdev, void *data)
478 {
479         dev_set_drvdata(&hdev->dev, data);
480 }
481
482 #define HID_GLOBAL_STACK_SIZE 4
483 #define HID_COLLECTION_STACK_SIZE 4
484
485 struct hid_parser {
486         struct hid_global     global;
487         struct hid_global     global_stack[HID_GLOBAL_STACK_SIZE];
488         unsigned              global_stack_ptr;
489         struct hid_local      local;
490         unsigned              collection_stack[HID_COLLECTION_STACK_SIZE];
491         unsigned              collection_stack_ptr;
492         struct hid_device    *device;
493 };
494
495 struct hid_class_descriptor {
496         __u8  bDescriptorType;
497         __le16 wDescriptorLength;
498 } __attribute__ ((packed));
499
500 struct hid_descriptor {
501         __u8  bLength;
502         __u8  bDescriptorType;
503         __le16 bcdHID;
504         __u8  bCountryCode;
505         __u8  bNumDescriptors;
506
507         struct hid_class_descriptor desc[1];
508 } __attribute__ ((packed));
509
510 #define HID_DEVICE(b, ven, prod) \
511         .bus = (b), \
512         .vendor = (ven), .product = (prod)
513
514 #define HID_USB_DEVICE(ven, prod)       HID_DEVICE(BUS_USB, ven, prod)
515 #define HID_BLUETOOTH_DEVICE(ven, prod) HID_DEVICE(BUS_BLUETOOTH, ven, prod)
516
517 #define HID_REPORT_ID(rep) \
518         .report_type = (rep)
519 #define HID_USAGE_ID(uhid, utype, ucode) \
520         .usage_hid = (uhid), .usage_type = (utype), .usage_code = (ucode)
521 /* we don't want to catch types and codes equal to 0 */
522 #define HID_TERMINATOR          (HID_ANY_ID - 1)
523
524 struct hid_report_id {
525         __u32 report_type;
526 };
527 struct hid_usage_id {
528         __u32 usage_hid;
529         __u32 usage_type;
530         __u32 usage_code;
531 };
532
533 /**
534  * struct hid_driver
535  * @name: driver name (e.g. "Footech_bar-wheel")
536  * @id_table: which devices is this driver for (must be non-NULL for probe
537  *            to be called)
538  * @probe: new device inserted
539  * @remove: device removed (NULL if not a hot-plug capable driver)
540  * @report_table: on which reports to call raw_event (NULL means all)
541  * @raw_event: if report in report_table, this hook is called (NULL means nop)
542  * @usage_table: on which events to call event (NULL means all)
543  * @event: if usage in usage_table, this hook is called (NULL means nop)
544  * @report_fixup: called before report descriptor parsing (NULL means nop)
545  * @input_mapping: invoked on input registering before mapping an usage
546  * @input_mapped: invoked on input registering after mapping an usage
547  *
548  * raw_event and event should return 0 on no action performed, 1 when no
549  * further processing should be done and negative on error
550  *
551  * input_mapping shall return a negative value to completely ignore this usage
552  * (e.g. doubled or invalid usage), zero to continue with parsing of this
553  * usage by generic code (no special handling needed) or positive to skip
554  * generic parsing (needed special handling which was done in the hook already)
555  * input_mapped shall return negative to inform the layer that this usage
556  * should not be considered for further processing or zero to notify that
557  * no processing was performed and should be done in a generic manner
558  * Both these functions may be NULL which means the same behavior as returning
559  * zero from them.
560  */
561 struct hid_driver {
562         char *name;
563         const struct hid_device_id *id_table;
564
565         int (*probe)(struct hid_device *dev, const struct hid_device_id *id);
566         void (*remove)(struct hid_device *dev);
567
568         const struct hid_report_id *report_table;
569         int (*raw_event)(struct hid_device *hdev, struct hid_report *report,
570                         u8 *data, int size);
571         const struct hid_usage_id *usage_table;
572         int (*event)(struct hid_device *hdev, struct hid_field *field,
573                         struct hid_usage *usage, __s32 value);
574
575         void (*report_fixup)(struct hid_device *hdev, __u8 *buf,
576                         unsigned int size);
577
578         int (*input_mapping)(struct hid_device *hdev,
579                         struct hid_input *hidinput, struct hid_field *field,
580                         struct hid_usage *usage, unsigned long **bit, int *max);
581         int (*input_mapped)(struct hid_device *hdev,
582                         struct hid_input *hidinput, struct hid_field *field,
583                         struct hid_usage *usage, unsigned long **bit, int *max);
584 /* private: */
585         struct device_driver driver;
586 };
587
588 /**
589  * hid_ll_driver - low level driver callbacks
590  * @start: called on probe to start the device
591  * @stop: called on remove
592  * @open: called by input layer on open
593  * @close: called by input layer on close
594  * @hidinput_input_event: event input event (e.g. ff or leds)
595  * @parse: this method is called only once to parse the device data,
596  *         shouldn't allocate anything to not leak memory
597  */
598 struct hid_ll_driver {
599         int (*start)(struct hid_device *hdev);
600         void (*stop)(struct hid_device *hdev);
601
602         int (*open)(struct hid_device *hdev);
603         void (*close)(struct hid_device *hdev);
604
605         int (*hidinput_input_event) (struct input_dev *idev, unsigned int type,
606                         unsigned int code, int value);
607
608         int (*parse)(struct hid_device *hdev);
609 };
610
611 /* Applications from HID Usage Tables 4/8/99 Version 1.1 */
612 /* We ignore a few input applications that are not widely used */
613 #define IS_INPUT_APPLICATION(a) (((a >= 0x00010000) && (a <= 0x00010008)) || (a == 0x00010080) || (a == 0x000c0001) || (a == 0x000d0002))
614
615 /* HID core API */
616
617 #ifdef CONFIG_HID_DEBUG
618 extern int hid_debug;
619 #endif
620
621 extern int hid_add_device(struct hid_device *);
622 extern void hid_destroy_device(struct hid_device *);
623
624 extern int __must_check __hid_register_driver(struct hid_driver *,
625                 struct module *, const char *mod_name);
626 static inline int __must_check hid_register_driver(struct hid_driver *driver)
627 {
628         return __hid_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
629 }
630 extern void hid_unregister_driver(struct hid_driver *);
631
632 extern void hidinput_hid_event(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
633 extern void hidinput_report_event(struct hid_device *hid, struct hid_report *report);
634 extern int hidinput_connect(struct hid_device *);
635 extern void hidinput_disconnect(struct hid_device *);
636
637 int hid_set_field(struct hid_field *, unsigned, __s32);
638 int hid_input_report(struct hid_device *, int type, u8 *, int, int);
639 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field);
640 int hidinput_mapping_quirks(struct hid_usage *, struct hid_input *,
641                 unsigned long **, int *);
642 int hidinput_event_quirks(struct hid_device *, struct hid_field *, struct hid_usage *, __s32);
643 void hid_output_report(struct hid_report *report, __u8 *data);
644 struct hid_device *hid_allocate_device(void);
645 int hid_parse_report(struct hid_device *hid, __u8 *start, unsigned size);
646
647 /**
648  * hid_map_usage - map usage input bits
649  *
650  * @hidinput: hidinput which we are interested in
651  * @usage: usage to fill in
652  * @bit: pointer to input->{}bit (out parameter)
653  * @max: maximal valid usage->code to consider later (out parameter)
654  * @type: input event type (EV_KEY, EV_REL, ...)
655  * @c: code which corresponds to this usage and type
656  */
657 static inline void hid_map_usage(struct hid_input *hidinput,
658                 struct hid_usage *usage, unsigned long **bit, int *max,
659                 __u8 type, __u16 c)
660 {
661         struct input_dev *input = hidinput->input;
662
663         usage->type = type;
664         usage->code = c;
665
666         switch (type) {
667         case EV_ABS:
668                 *bit = input->absbit;
669                 *max = ABS_MAX;
670                 break;
671         case EV_REL:
672                 *bit = input->relbit;
673                 *max = REL_MAX;
674                 break;
675         case EV_KEY:
676                 *bit = input->keybit;
677                 *max = KEY_MAX;
678                 break;
679         case EV_LED:
680                 *bit = input->ledbit;
681                 *max = LED_MAX;
682                 break;
683         }
684 }
685
686 /**
687  * hid_map_usage_clear - map usage input bits and clear the input bit
688  *
689  * The same as hid_map_usage, except the @c bit is also cleared in supported
690  * bits (@bit).
691  */
692 static inline void hid_map_usage_clear(struct hid_input *hidinput,
693                 struct hid_usage *usage, unsigned long **bit, int *max,
694                 __u8 type, __u16 c)
695 {
696         hid_map_usage(hidinput, usage, bit, max, type, c);
697         clear_bit(c, *bit);
698 }
699
700 /**
701  * hid_parse - parse HW reports
702  *
703  * @hdev: hid device
704  *
705  * Call this from probe after you set up the device (if needed). Your
706  * report_fixup will be called (if non-NULL) after reading raw report from
707  * device before passing it to hid layer for real parsing.
708  */
709 static inline int __must_check hid_parse(struct hid_device *hdev)
710 {
711         int ret;
712
713         if (hdev->status & HID_STAT_PARSED)
714                 return 0;
715
716         ret = hdev->ll_driver->parse(hdev);
717         if (!ret)
718                 hdev->status |= HID_STAT_PARSED;
719
720         return ret;
721 }
722
723 /**
724  * hid_hw_start - start underlaying HW
725  *
726  * @hdev: hid device
727  *
728  * Call this in probe function *after* hid_parse. This will setup HW buffers
729  * and start the device (if not deffered to device open). hid_hw_stop must be
730  * called if this was successfull.
731  */
732 static inline int __must_check hid_hw_start(struct hid_device *hdev)
733 {
734         return hdev->ll_driver->start(hdev);
735 }
736
737 /**
738  * hid_hw_stop - stop underlaying HW
739  *
740  * @hdev: hid device
741  *
742  * This is usually called from remove function or from probe when something
743  * failed and hid_hw_start was called already.
744  */
745 static inline void hid_hw_stop(struct hid_device *hdev)
746 {
747         hdev->ll_driver->stop(hdev);
748 }
749
750 void hid_report_raw_event(struct hid_device *hid, int type, u8 *data, int size,
751                 int interrupt);
752
753 extern int hid_generic_init(void);
754 extern void hid_generic_exit(void);
755
756 /* HID quirks API */
757 u32 usbhid_lookup_quirk(const u16 idVendor, const u16 idProduct);
758 int usbhid_quirks_init(char **quirks_param);
759 void usbhid_quirks_exit(void);
760 void usbhid_fixup_report_descriptor(const u16, const u16, char *, unsigned, char **);
761
762 #ifdef CONFIG_HID_FF
763 int hid_ff_init(struct hid_device *hid);
764
765 int hid_lgff_init(struct hid_device *hid);
766 int hid_lg2ff_init(struct hid_device *hid);
767 int hid_plff_init(struct hid_device *hid);
768 int hid_tmff_init(struct hid_device *hid);
769 int hid_zpff_init(struct hid_device *hid);
770 #ifdef CONFIG_HID_PID
771 int hid_pidff_init(struct hid_device *hid);
772 #else
773 static inline int hid_pidff_init(struct hid_device *hid) { return -ENODEV; }
774 #endif
775
776 #else
777 static inline int hid_ff_init(struct hid_device *hid) { return -1; }
778 #endif
779
780 #ifdef CONFIG_HID_DEBUG
781 #define dbg_hid(format, arg...) if (hid_debug) \
782                                 printk(KERN_DEBUG "%s: " format ,\
783                                 __FILE__ , ## arg)
784 #define dbg_hid_line(format, arg...) if (hid_debug) \
785                                 printk(format, ## arg)
786 #else
787 static inline int __attribute__((format(printf, 1, 2)))
788 dbg_hid(const char *fmt, ...)
789 {
790         return 0;
791 }
792 #define dbg_hid_line dbg_hid
793 #endif
794
795 #define err_hid(format, arg...) printk(KERN_ERR "%s: " format "\n" , \
796                 __FILE__ , ## arg)
797 #endif
798 #endif
799